Skip to content

gh-94628: Add explicit parameter list to sqlite3.connect docs #94629

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
erlend-aasland merged 4 commits into from
Jul 7, 2022
Merged

gh-94628: Add explicit parameter list to sqlite3.connect docs #94629

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
faa1085
gh-94628: Add explicit parameter list to sqlite3.connect docs
erlend-aasland Jul 6, 2022
af12252
Merge branch 'main' into sqlite-doc-connect
erlend-aasland Jul 7, 2022
ef3d3eb
Address CAM's review
erlend-aasland Jul 7, 2022
9bc1c97
Trailing whitespace
erlend-aasland Jul 7, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Address CAM's review
  • Loading branch information
@erlend-aasland
erlend-aasland committed Jul 7, 2022
commit ef3d3eb7a99ea59c9e14de353e6ca6e87d6a90cd
35 changes: 19 additions & 16 deletions Doc/library/sqlite3.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -312,11 +312,11 @@ Module functions and constants
and an optional query string.
The scheme part *must* be ``"file:"``,
and the path can be relative or absolute.
The query string allows passing parameters to SQLite.
See :ref:`sqlite3-uri-tricks`.
The query string allows passing parameters to SQLite,
enabling various :ref:`sqlite3-uri-tricks`.
:type uri: bool

:rtype: typing.Any
:rtype: sqlite3.Connection

.. audit-event:: sqlite3.connect database sqlite3.connect
.. audit-event:: sqlite3.connect/handle connection_handle sqlite3.connect
Expand Down Expand Up @@ -1484,22 +1484,25 @@ regardless of the value of :attr:`~Connection.isolation_level`.
SQLite URI tricks
-----------------

Some useful URI tricks include::
Some useful URI tricks include:

# Open a database in read-only mode.
con = sqlite3.connect("file:template.db?mode=ro", uri=True)
* Open a database in read-only mode::

# Don't implicitly create a new database file if it does not already exist.
# Will raise sqlite3.OperationalError if unable to open a database file.
con = sqlite3.connect("file:nosuchdb.db?mode=rw", uri=True)
con = sqlite3.connect("file:template.db?mode=ro", uri=True)

# Create a shared named in-memory database.
con1 = sqlite3.connect("file:mem1?mode=memory&cache=shared", uri=True)
con2 = sqlite3.connect("file:mem1?mode=memory&cache=shared", uri=True)
con1.execute("create table t(t)")
con1.execute("insert into t values(28)")
con1.commit()
rows = con2.execute("select * from t").fetchall()
* Do not implicitly create a new database file if it does not already exist;
will raise :exc:`~sqlite3.OperationalError` if unable to create a new file::

con = sqlite3.connect("file:nosuchdb.db?mode=rw", uri=True)

* Create a shared named in-memory database::

con1 = sqlite3.connect("file:mem1?mode=memory&cache=shared", uri=True)
con2 = sqlite3.connect("file:mem1?mode=memory&cache=shared", uri=True)
con1.execute("create table t(t)")
con1.execute("insert into t values(28)")
con1.commit()
rows = con2.execute("select * from t").fetchall()

More information about this feature, including a list of parameters,
can be found in the `SQLite URI documentation`_.
Expand Down