pydoc > _sqlite3

man perldoc info pydoc3 ri search

📛 NAME

_sqlite3

🚀 Quick Reference

Use Case	Command	Description
🔌 Open database	connect(database)	Open a connection to SQLite database file or :memory:
📝 Execute SQL	cursor.execute(sql)	Execute a single SQL statement
📊 Fetch all rows	cursor.fetchall()	Fetch all rows from resultset
🔁 Use context manager	with connect(...) as con:	Auto-commit or rollback on exit
💾 Commit transaction	con.commit()	Commit pending transaction
↩️ Rollback transaction	con.rollback()	Rollback to start of transaction
📦 Backup database	con.backup(target)	Make a backup of the database
🧪 Execute script	con.executescript(sql_script)	Execute multiple SQL statements at once

📚 MODULE REFERENCE

https://docs.python.org/3.10/library/_sqlite3.html

The following documentation is automatically generated from the Python source files. It may be incomplete, incorrect or include features that are considered implementation detail and may vary between Python implementations. When in doubt, consult the module reference at the location listed above.

🏷️ CLASSES

• builtins.Exception
  • sqlite3.Error
    • sqlite3.DatabaseError
      • sqlite3.DataError
      • sqlite3.IntegrityError
      • sqlite3.InternalError
      • sqlite3.NotSupportedError
      • sqlite3.OperationalError
      • sqlite3.ProgrammingError
    • sqlite3.InterfaceError
  • sqlite3.Warning

• builtins.object
  • sqlite3.Connection
  • sqlite3.Cursor
  • sqlite3.PrepareProtocol
  • sqlite3.Row

🗃️ Connection

SQLite database connection object.

Methods defined here:

• __call__(self, /, *args, **kwargs) — Call self as a function.
• __enter__(self, /) — Called when the connection is used as a context manager. Returns itself as a convenience to the caller.
• __exit__(self, type, value, traceback, /) — Called when the connection is used as a context manager. If there was any exception, a rollback takes place; otherwise we commit.
• __init__(self, /, *args, **kwargs) — Initialize self. See help(type(self)) for accurate signature.
• backup(self, /, target, *, pages=-1, progress=None, name='main', sleep=0.25) — Makes a backup of the database.
• close(self, /) — Close the database connection. Any pending transaction is not committed implicitly.
• commit(self, /) — Commit any pending transaction to the database. If there is no open transaction, this method is a no-op.
• create_aggregate(self, /, name, n_arg, aggregate_class) — Creates a new aggregate.
• create_collation(self, name, callback, /) — Creates a collation function.
• create_function(self, /, name, narg, func, *, deterministic=False) — Creates a new function.
• cursor(...) — Return a cursor for the connection.
• enable_load_extension(self, enable, /) — Enable dynamic loading of SQLite extension modules.
• execute(...) — Executes an SQL statement.
• executemany(self, sql, parameters, /) — Repeatedly executes an SQL statement.
• executescript(self, sql_script, /) — Executes multiple SQL statements at once.
• interrupt(self, /) — Abort any pending database operation.
• iterdump(self, /) — Returns iterator to the dump of the database in an SQL text format.
• load_extension(self, name, /) — Load SQLite extension module.
• rollback(self, /) — Roll back to the start of any pending transaction. If there is no open transaction, this method is a no-op.
• set_authorizer(self, /, authorizer_callback) — Sets authorizer callback.
• set_progress_handler(self, /, progress_handler, n) — Sets progress handler callback.
• set_trace_callback(self, /, trace_callback) — Sets a trace callback called for each SQL statement (passed as unicode).

Data descriptors defined here:

• DataError
• DatabaseError
• Error
• IntegrityError
• InterfaceError
• InternalError
• NotSupportedError
• OperationalError
• ProgrammingError
• Warning
• in_transaction
• isolation_level
• row_factory
• text_factory
• total_changes

🖇️ Cursor

SQLite database cursor class.

Methods defined here:

• __init__(self, /, *args, **kwargs) — Initialize self. See help(type(self)) for accurate signature.
• __iter__(self, /) — Implement iter(self).
• __next__(self, /) — Implement next(self).
• close(self, /) — Closes the cursor.
• execute(self, sql, parameters=(), /) — Executes an SQL statement.
• executemany(self, sql, seq_of_parameters, /) — Repeatedly executes an SQL statement.
• executescript(self, sql_script, /) — Executes multiple SQL statements at once.
• fetchall(self, /) — Fetches all rows from the resultset.
• fetchmany(self, /, size=1) — Fetches several rows from the resultset. The default value is set by the Cursor.arraysize attribute.
• fetchone(self, /) — Fetches one row from the resultset.
• setinputsizes(self, sizes, /) — Required by DB-API. Does nothing in sqlite3.
• setoutputsize(self, size, column=None, /) — Required by DB-API. Does nothing in sqlite3.

Data descriptors defined here:

• arraysize
• connection
• description
• lastrowid
• row_factory
• rowcount

⚠️ Exception Classes

All exception classes inherit from builtins.Exception. The hierarchy is shown above in the class tree. Each exception class inherits the following methods and data descriptors from builtins.Exception:

• Methods: __init__, __new__, __delattr__, __getattribute__, __reduce__, __repr__, __setattr__, __setstate__, __str__, with_traceback
• Data descriptors: __cause__, __context__, __dict__, __suppress_context__, __traceback__, args

Additionally, sqlite3.Error defines a data descriptor __weakref__ which is inherited by all its subclasses (DatabaseError, InterfaceError, and their subclasses). sqlite3.Warning directly inherits from builtins.Exception and also has __weakref__ defined.

📄 PrepareProtocol

PEP 246 style object adaption protocol type.

Methods defined here:

• __init__(self, /, *args, **kwargs) — Initialize self. See help(type(self)) for accurate signature.

📊 Row

Methods defined here:

• __eq__(self, value, /) — Return self==value.
• __ge__(self, value, /) — Return self>=value.
• __getitem__(self, key, /) — Return self[key].
• __gt__(self, value, /) — Return self>value.
• __hash__(self, /) — Return hash(self).
• __iter__(self, /) — Implement iter(self).
• __le__(self, value, /) — Return self<=value.
• __len__(self, /) — Return len(self).
• __lt__(self, value, /) — Return self<value.
• __ne__(self, value, /) — Return self!=value.
• keys(self, /) — Returns the keys of the row.

Static methods defined here:

• __new__(*args, **kwargs) from builtins.type — Create and return a new object. See help(type) for accurate signature.

🔧 FUNCTIONS

🔗 adapt(...)

Adapt given object to given protocol.

✅ complete_statement(statement)

Checks if a string contains a complete SQL statement.

🔌 connect(...)

connect(database[, timeout, detect_types, isolation_level,
        check_same_thread, factory, cached_statements, uri])

Opens a connection to the SQLite database file database. You can use :memory: to open a database connection to a database that resides in RAM instead of on disk.

🔁 enable_callback_tracebacks(enable, /)

Enable or disable callback functions throwing errors to stderr.

🔀 enable_shared_cache(do_enable)

Enable or disable shared cache mode for the calling thread.

This method is deprecated and will be removed in Python 3.12. Shared cache is strongly discouraged by the SQLite 3 documentation. If shared cache must be used, open the database in URI mode using the cache=shared query parameter.

📦 register_adapter(type, adapter, /)

Register a function to adapt Python objects to SQLite values.

📦 register_converter(typename, converter, /)

Register a function to convert SQLite values to Python objects.

📊 DATA

• PARSE_COLNAMES = 2
• PARSE_DECLTYPES = 1
• SQLITE_ALTER_TABLE = 26
• SQLITE_ANALYZE = 28
• SQLITE_ATTACH = 24
• SQLITE_CREATE_INDEX = 1
• SQLITE_CREATE_TABLE = 2
• SQLITE_CREATE_TEMP_INDEX = 3
• SQLITE_CREATE_TEMP_TABLE = 4
• SQLITE_CREATE_TEMP_TRIGGER = 5
• SQLITE_CREATE_TEMP_VIEW = 6
• SQLITE_CREATE_TRIGGER = 7
• SQLITE_CREATE_VIEW = 8
• SQLITE_CREATE_VTABLE = 29
• SQLITE_DELETE = 9
• SQLITE_DENY = 1
• SQLITE_DETACH = 25
• SQLITE_DONE = 101
• SQLITE_DROP_INDEX = 10
• SQLITE_DROP_TABLE = 11
• SQLITE_DROP_TEMP_INDEX = 12
• SQLITE_DROP_TEMP_TABLE = 13
• SQLITE_DROP_TEMP_TRIGGER = 14
• SQLITE_DROP_TEMP_VIEW = 15
• SQLITE_DROP_TRIGGER = 16
• SQLITE_DROP_VIEW = 17
• SQLITE_DROP_VTABLE = 30
• SQLITE_FUNCTION = 31
• SQLITE_IGNORE = 2
• SQLITE_INSERT = 18
• SQLITE_OK = 0
• SQLITE_PRAGMA = 19
• SQLITE_READ = 20
• SQLITE_RECURSIVE = 33
• SQLITE_REINDEX = 27
• SQLITE_SAVEPOINT = 32
• SQLITE_SELECT = 21
• SQLITE_TRANSACTION = 22
• SQLITE_UPDATE = 23
• adapters = {}
• converters = {}
• sqlite_version = '3.37.2'
• version = '2.6.0'

📁 FILE

/usr/lib/python3.10/lib-dynload/_sqlite3.cpython-310-x86_64-linux-gnu.so

📛 NAME 🚀 Quick Reference 📚 MODULE REFERENCE 🏷️ CLASSES 🔧 FUNCTIONS 📊 DATA 📁 FILE