From 0834043f6f5cac73add58081b8cc50821c3e7a1d Mon Sep 17 00:00:00 2001 From: Erlend Egeberg Aasland Date: Thu, 28 Oct 2021 21:55:27 +0200 Subject: [PATCH] bpo-45612: Add sqlite3 module docstring (GH-29224) (cherry picked from commit 4dd1e84789f0bd2da83ad06d23c569bf03713a50) Co-authored-by: Erlend Egeberg Aasland --- Lib/sqlite3/__init__.py | 34 ++++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) diff --git a/Lib/sqlite3/__init__.py b/Lib/sqlite3/__init__.py index f001c0678e195f..edc58f15b25cee 100644 --- a/Lib/sqlite3/__init__.py +++ b/Lib/sqlite3/__init__.py @@ -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 . +""" + from sqlite3.dbapi2 import *