changeset:   101647:af1752e51a89
branch:      3.5
parent:      101644:f53a0566a290
user:        Senthil Kumaran <senthil@uthcode.com>
date:        Fri Jun 03 00:03:48 2016 -0700
files:       Doc/library/sqlite3.rst
description:
issue27113 - Document "check_same_thread" parameter in sqlite3.connect api.

Patch contributed by Dave Sawyer.


diff -r f53a0566a290 -r af1752e51a89 Doc/library/sqlite3.rst
--- a/Doc/library/sqlite3.rst	Thu Jun 02 23:49:05 2016 -0700
+++ b/Doc/library/sqlite3.rst	Fri Jun 03 00:03:48 2016 -0700
@@ -190,6 +190,11 @@
    any combination of :const:`PARSE_DECLTYPES` and :const:`PARSE_COLNAMES` to turn
    type detection on.
 
+   By default, *check_same_thread* is :const:`True` and only the creating thread may
+   use the connection. If set :const:`False`, the returned connection may be shared
+   across multiple threads. When using multiple threads with the same connection
+   writing operations should be serialized by the user to avoid data corruption.
+
    By default, the :mod:`sqlite3` module uses its :class:`Connection` class for the
    connect call.  You can, however, subclass the :class:`Connection` class and make
    :func:`connect` use your class instead by providing your class for the *factory*