Databases¶

Return a developer-friendly string representation of this connection.

Disable autocommit mode, grouping subsequent statements into a transaction.

Enable autocommit mode so each statement is committed immediately.

Close the database connection, logging a warning if autocommit is off.

Return True if column_name exists in table_name (optionally in schema_name).

Commit the current transaction if autocommit is enabled.

Return a new cursor, opening the connection first if it has not been opened yet.

Drop tablename if it exists; tablename must already be schema-qualified and quoted.

Execute a stored procedure or function by name.

Execute sql (optionally with paramlist), updating $LAST_ROWCOUNT.

Rolls back the current transaction and re-raises on any driver error.

Insert the raw binary content of file_name as a single row into column_name of table_name.

Import a CSV/tabular file into table_name; column names must be compatible.

Return a human-readable description of this connection (DBMS + server/file).

Return True if this adapter's driver does NOT auto-commit DDL.

Firebird is the notable case: a CREATE TABLE issued via the driver remains pending until commit, so callers that issue DDL followed by DML on a fresh table must commit in between. Most other adapters either auto-commit on DDL or run DDL inside the current transaction with no special handling required.

Open the underlying database connection.

Return a comma-separated string of paramcount parameter placeholders.

Bulk-insert rows from rowsource into table_name using the columns in column_list.

rowsource must be a generator yielding lists of values in column order. tablespec_src is a zero-argument callable that returns the table's type specification.

Return identifier wrapped in double-quotes with any embedded double-quotes escaped (standard SQL identifier quoting).

Override in subclasses for adapters whose native identifier quote differs (MySQL uses backticks, SQL Server uses square brackets).

Return value as a SQL string literal, safely escaped.

Default ANSI/Postgres behaviour: wrap in single quotes, double embedded apostrophes, escape backslashes (so a value containing \' cannot terminate the literal on MySQL default mode or PostgreSQL E-strings), and reject embedded NUL bytes (most wire protocols truncate or reject them).

Override per-DBMS only when the wire protocol requires a different literal form.

Quote each non-empty part of a possibly-multi-segment identifier and join them with . (e.g. "schema"."table").

Skips None or empty parts so callers don't need to special-case schemaless databases (SQLite, Firebird).

Return True if rolename exists in this database.

The default implementation raises :class:~execsql.exceptions.DatabaseNotImplementedError; adapters for DBMSes that have a concept of roles (PostgreSQL, SQL Server, etc.) override this to query the appropriate catalog. Calling ROLE_EXISTS() from a script against a DBMS without role support will surface the raised error.

Roll back the current transaction; swallows errors (best-effort).

Return True if schema_name exists in this database.

Return the quoted, optionally schema-qualified form of table_name.

Execute sql and return (column_names, rows) with all rows fetched into memory.

Execute sql and return (column_names, row_iterator) where each row is a dict.

Execute sql and return (column_names, row_generator) for streaming large result sets.

Return the ordered list of column names for table_name.

Return True if table_name (optionally in schema_name) exists.

Return True if view_name (optionally in schema_name) exists.

Return a string representation of the pool.

Register db_obj under db_alias, setting it as initial/current if this is the first connection.

Return the Database registered under db_alias.

Return a list of all currently registered database aliases.

Roll back and close every connection in the pool, then reset the pool to empty.

Return the currently active Database object.

Return the alias string for the currently active database.

Close and remove the connection registered under alias from the pool.

Return the first Database that was added to the pool.

Set the active database to db_alias; raises ErrInfo if the alias is unknown.

Execute a stored function by name.

Import an entire binary file into a single column of a table.

Import a delimited file into a PostgreSQL table, using COPY when possible.

Open a connection to the PostgreSQL database.

Return True if the named role exists in the PostgreSQL cluster.

Return True if the named table exists in the PostgreSQL database.

Run VACUUM with the given arguments in autocommit mode.

Note: argstring is interpolated directly into SQL because VACUUM is DDL and does not accept parameterized arguments. This is safe in execsql's trust model (the script author already has full SQL access), but should not be exposed to untrusted input.

Return True if the named view exists in the PostgreSQL database.

Return True if the named column exists in the given SQLite table.

Drop the named table from the SQLite database if it exists.

Execute a query command as a view selection, since SQLite lacks stored procedures.

Import an entire binary file into a single column of a table.

Open a connection to the SQLite database file.

Populate a SQLite table from a row source generator.

Return False; SQLite does not support schemas.

Return a list of column names for the given SQLite table.

Return True if the named table exists in the SQLite database.

Return True if the named view exists in the SQLite database.

Execute a query command as a view selection, since DuckDB lacks stored procedures.

Open a connection to the DuckDB database file.

Return True if the named schema exists in the current DuckDB catalog.

Return True if the named view exists in the DuckDB database.

Drop the named table from the SQL Server database.

Execute a stored procedure by name.

Import an entire binary file into a single column of a table.

Open a connection to the SQL Server database via pyodbc.

SQL Server native identifier quoting uses square brackets.

Override of :meth:Database.quote_identifier for B07a/F021: the base ANSI "…" form only works while QUOTED_IDENTIFIER is ON (the adapter sets this at open_db, but user SQL that toggles the session setting would silently break execsql-generated DDL). ] inside an identifier is escaped to ]].

Return True if the named role or principal exists in the SQL Server database.

Return True if the named schema exists in the SQL Server database.

Execute a stored procedure by name.

Import a delimited file into a MySQL table.

Open a connection to the MySQL or MariaDB server.

MySQL / MariaDB native identifier quoting uses backticks.

Override of :meth:Database.quote_identifier for B07a/F021: the base ANSI "…" form only works after the connection sets sql_mode=ANSI / ANSI_QUOTES (the adapter does this at open_db, but user SQL that resets the mode would silently break execsql-generated DDL).

Return True if the named role or user exists in the MySQL server.

Return False; MySQL does not support schemas in the execsql sense.

Return True if the named column exists in the given Oracle table.

Drop the named table with cascade constraints.

Execute a stored function by name.

Execute a SQL command, stripping any trailing semicolon for Oracle.

Open a connection to the Oracle database.

Return Oracle-style positional parameter placeholders (:1, :2, ...).

Return True if the named role or user exists in the Oracle database.

dba_roles is restricted to DBA accounts and would raise ORA-00942: table or view does not exist for non-DBA users; we try it first and fall back to session_roles (always readable for the current session) if the catalog isn't accessible.

Raise DatabaseNotImplementedError; schema_exists is not supported for Oracle.

Return column names and all rows from a SELECT statement.

Return column names and an iterable that yields rows as dictionaries.

Return column names and an iterable that yields rows one at a time.

Return a list of column names for the given Oracle table.

Return True if the named table exists in the Oracle database.

Return True if the named view exists in the Oracle database.

Return True if the named column exists in the given Firebird table.

Drop the named table from the Firebird database.

Execute a stored procedure by name.

Firebird leaves DDL pending until commit — callers issuing CREATE TABLE then INSERT on a fresh table must commit in between.

Open a connection to the Firebird database.

Return True if the named role or user exists in the Firebird database.

Return False; Firebird does not support schemas.

Return a list of column names for the given Firebird table.

Return True if the named table exists in the Firebird database.

Return True if the named view exists in the Firebird database.

Convert a value to a datetime object suitable for Access.

Close both the DAO and ODBC connections.

Return True if the named column exists in the given Access table.

Wait if needed for Jet's read buffer to flush after a DAO command.

Drop the named table from the Access database.

Execute a stored query command via DAO.

Execute a query using the DAO connection.

Execute a SQL command, handling encoding, DAO flush, and temporary queries.

Import an entire binary file into a single column of a table.

Convert a value to an integer, recognizing Access boolean values.

Open a DAO connection to the Access database.

Open an ODBC connection to the Access database.

Return False; Access does not support schemas.

Return column names and all rows from a SELECT statement.

Return column names and an iterable that yields rows as dictionaries.

Return column names and an iterable that yields rows one at a time.

Return a list of column names for the given Access table.

Return True if the named table exists in the Access database.

Uses ODBC's catalog function (cursor.tables()) instead of querying MSysObjects directly. Access 2016+ refuses ad-hoc queries on the system catalog with the error Record(s) cannot be read; no read permission on 'MSysObjects'; the ODBC catalog path is permission-clean and matches the table view that CREATE TABLE modifies, unlike DAO TableDefs which caches independently.

Return True if the named view or query exists in the Access database.

Uses DAO QueryDefs (Access's saved queries play the role of views) rather than querying MSysObjects directly — see :meth:table_exists for the permission rationale.

Execute a stored procedure by name.

Import an entire binary file into a single column of a table.

Open an ODBC connection using the configured DSN.