SQLite: View Ticket

Ticket Hash:	f9af981dd2a202009ae250c48bca968eb8d1c7d0
Title:	sqlite3_shutdown documentation needs to mention danger
Status:	Fixed	Type:	Documentation
Severity:	Important	Priority:	Immediate
Subsystem:	Documentation	Resolution:	Fixed
Last Modified:	2009-10-20 15:28:27
Version Found In:	3.6.18
Description:
The documentation for sqlite3_shutdown doesn't actually mention what bad things will happen if you call it while statements are executing. The following changes are suggested to the documentation: A first paragraph saying that if you are using a conventional operating system directly supported by SQLite (eg Mac, Linux/Unix, Windows) without any SQLite customizations then there is no need to call these functions. A second paragraph explaining that sqlite3_shutdown must not be called unless all connections have been closed. No SQLite object must be in use in any way. This report is because someone was wondering about calling sqlite3_shutdown in order to abort execution if there is an error in collation callback (ie a possible workaround for [1a1790ca1a9f1438f0c2e2dce57a68139efbdcf2]). Unless you are familiar with SQLite internals on reading the documentation it didn't seem like that bad an idea... drh added on 2009-10-20 15:28:27: Check-in [b2aa48b52f1]