bpo-45612: Add sqlite3 module docstring (GH-29224) (GH-29288)

(cherry picked from commit 4dd1e84789)

Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@innova.no>
This commit is contained in:
Miss Islington (bot) 2021-10-28 13:24:52 -07:00 committed by GitHub
parent fef54abf5f
commit 823b3e39ae
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -20,6 +20,40 @@
# misrepresented as being the original software.
# 3. This notice may not be removed or altered from any source distribution.
"""
The sqlite3 extension module provides a DB-API 2.0 (PEP 249) compilant
interface to the SQLite library, and requires SQLite 3.7.15 or newer.
To use the module, you must first create a database Connection object:
import sqlite3
cx = sqlite3.connect("test.db") # test.db will be created or opened
You can also use the special database name ":memory:" to connect to a transient
in-memory database:
cx = sqlite3.connect(":memory:") # connect to a database in RAM
Once you have a Connection object, you can create a Cursor object and call its
execute() method to perform SQL queries:
cu = cx.cursor()
# create a table
cu.execute("create table lang(name, first_appeared)")
# insert values into a table
cu.execute("insert into lang values (?, ?)", ("C", 1972))
# execute a query and iterate over the result
for row in cu.execute("select * from lang"):
print(row)
cx.close()
The sqlite3 module is written by Gerhard Häring <gh@ghaering.de>.
"""
from sqlite3.dbapi2 import *