Core 内部¶

此处列出了一些关键的内部构造。

对象名称	描述
AdaptedConnection	用于支持 DBAPI 协议的适配连接对象的接口。
BindTyping	定义在语句中传递绑定参数的类型信息的不同方法到数据库驱动程序。
Compiled	表示编译后的 SQL 或 DDL 表达式。
DBAPIConnection	表示 PEP 249 数据库连接的协议。
DBAPICursor	表示 PEP 249 数据库游标的协议。
DBAPIType	表示 PEP 249 数据库类型的协议。
DDLCompiler
DefaultDialect	Dialect 的默认实现
DefaultExecutionContext
Dialect	定义特定数据库和 DB-API 组合的行为。
ExecutionContext	Dialect 的消息传递对象，对应于单个执行。
ExpandedState	表示在为语句生成“扩展”和“后编译”绑定参数时要使用的状态。
GenericTypeCompiler
Identified
IdentifierPreparer	处理基于选项的标识符的引用和大小写折叠。
SQLCompiler	`Compiled` 的默认实现。
StrSQLCompiler	`SQLCompiler` 子类，允许将少量非标准 SQL 特性渲染为字符串值。

class sqlalchemy.engine.BindTyping¶

定义在语句中传递绑定参数的类型信息的不同方法到数据库驱动程序。

2.0 版本新增。

成员

NONE, RENDER_CASTS, SETINPUTSIZES

类签名

class sqlalchemy.engine.BindTyping (enum.Enum)

attribute sqlalchemy.engine.BindTyping.NONE = 1¶

不采取任何步骤将类型信息传递给数据库驱动程序。

这是 SQLite、MySQL / MariaDB、SQL Server 等数据库的默认行为。

attribute sqlalchemy.engine.BindTyping.RENDER_CASTS = 3¶

在 SQL 字符串中渲染 cast 或其他指令。

此方法用于所有 PostgreSQL 方言，包括 asyncpg、pg8000、psycopg、psycopg2。实现此功能的方言可以选择哪些类型的数据类型在 SQL 语句中显式转换，哪些不转换。

当使用 RENDER_CASTS 时，编译器将为每个方言级别类型设置 TypeEngine.render_bind_cast 属性的 BindParameter 对象调用 SQLCompiler.render_bind_cast() 方法，以渲染字符串表示形式。

SQLCompiler.render_bind_cast() 也用于渲染一种 “insertmanyvalues” 查询形式的 cast，当 InsertmanyvaluesSentinelOpts.USE_INSERT_FROM_SELECT 和 InsertmanyvaluesSentinelOpts.RENDER_SELECT_COL_CASTS 都设置时，其中 cast 应用于中间列，例如 “INSERT INTO t (a, b, c) SELECT p0::TYP, p1::TYP, p2::TYP ” “FROM (VALUES (?, ?), (?, ?), …)”。

2.0.10 版本新增: - SQLCompiler.render_bind_cast() 现在在 “insertmanyvalues” 实现的某些元素中使用。

attribute sqlalchemy.engine.BindTyping.SETINPUTSIZES = 2¶

使用 pep-249 setinputsizes 方法。

这仅针对支持此方法且 SQLAlchemy 方言为此方言设置了适当基础设施的 DBAPI 实现。当前方言包括 python-oracledb、cx_Oracle 以及使用 pyodbc 的 SQL Server 的可选支持。

当使用 setinputsizes 时，方言还具有仅对某些数据类型使用该方法的方式，即使用 include/exclude 列表。

当使用 SETINPUTSIZES 时，对于每个执行的具有绑定参数的语句，都会调用 Dialect.do_set_input_sizes() 方法。

class sqlalchemy.engine.Compiled¶

表示编译后的 SQL 或 DDL 表达式。

成员

__init__(), cache_key, compile_state, construct_params(), dml_compile_state, execution_options, params, sql_compiler, state, statement, string

Compiled 对象的 __str__ 方法应生成语句的实际文本。Compiled 对象特定于其底层数据库方言，并且也可能或可能不特定于特定绑定参数集中引用的列。在任何情况下，Compiled 对象都不应依赖于这些绑定参数的实际值，即使它可能将这些值作为默认值引用。

method sqlalchemy.engine.Compiled.__init__(dialect: Dialect, statement: ClauseElement | None, schema_translate_map: SchemaTranslateMapType | None = None, render_schema_translate: bool = False, compile_kwargs: Mapping[str, Any] = {})¶

构造一个新的 Compiled 对象。

参数:

dialect¶ – 要针对其编译的 Dialect。
statement¶ – 要编译的 ClauseElement。
schema_translate_map¶ –
用于在形成结果 SQL 时翻译的模式名称字典

参见

模式名称的翻译
compile_kwargs¶ – 将传递给 Compiled.process() 的初始调用的附加 kwargs。

attribute sqlalchemy.engine.Compiled.cache_key: CacheKey | None = None¶

在创建此 Compiled 对象之前生成的 CacheKey。

这用于需要访问原始 CacheKey 实例的例程，该实例在首次缓存 Compiled 实例时生成，通常是为了协调原始 BindParameter 对象列表与在每次调用时生成的每个语句列表。

attribute sqlalchemy.engine.Compiled.compile_state: CompileState | None = None¶

可选的 CompileState 对象，用于维护编译器使用的其他状态。

主要的执行对象（例如 Insert、Update、Delete、Select）将在编译时生成此状态，以便计算有关对象的其他信息。对于要执行的顶层对象，状态可以存储在此处，它也可以适用于结果集处理。

1.4 版本新增。

method sqlalchemy.engine.Compiled.construct_params(params: _CoreSingleExecuteParams | None = None, extracted_parameters: Sequence[BindParameter[Any]] | None = None, escape_names: bool = True) → _MutableCoreSingleExecuteParams | None¶

返回此编译对象的绑定参数。

参数:: params¶ – 字符串/对象对的字典，其值将覆盖编译到语句中的绑定值。

attribute sqlalchemy.engine.Compiled.dml_compile_state: CompileState | None = None¶

在分配 .isinsert、.isupdate 或 .isdelete 的同一点分配的可选 CompileState。

这通常与 .compile_state 对象相同，但 ORMFromStatementCompileState 对象等情况除外。

1.4.40 版本新增。

attribute sqlalchemy.engine.Compiled.execution_options: _ExecuteOptions = {}¶: 从语句传播的执行选项。在某些情况下，语句的子元素可以修改这些选项。

attribute sqlalchemy.engine.Compiled.params¶: 返回此编译对象的绑定参数。

attribute sqlalchemy.engine.Compiled.sql_compiler¶

返回一个能够处理 SQL 表达式的 Compiled 对象。

如果此编译器是其中之一，它可能会直接返回 ‘self’。

attribute sqlalchemy.engine.Compiled.state: CompilerState¶: 编译器状态的描述

attribute sqlalchemy.engine.Compiled.statement: ClauseElement | None = None¶: 要编译的语句。

attribute sqlalchemy.engine.Compiled.string: str = ''¶: statement 的字符串表示形式

class sqlalchemy.engine.interfaces.DBAPIConnection¶

表示 PEP 249 数据库连接的协议。

2.0 版本新增。

参见

Connection Objects - 在 PEP 249 中

成员

autocommit, close(), commit(), cursor(), rollback()

类签名

class sqlalchemy.engine.interfaces.DBAPIConnection (typing_extensions.Protocol)

attribute sqlalchemy.engine.interfaces.DBAPIConnection.autocommit: bool¶

method sqlalchemy.engine.interfaces.DBAPIConnection.close() → None¶

method sqlalchemy.engine.interfaces.DBAPIConnection.commit() → None¶

method sqlalchemy.engine.interfaces.DBAPIConnection.cursor() → DBAPICursor¶

method sqlalchemy.engine.interfaces.DBAPIConnection.rollback() → None¶

class sqlalchemy.engine.interfaces.DBAPICursor¶

表示 PEP 249 数据库游标的协议。

2.0 版本新增。

参见

Cursor Objects - 在 PEP 249 中

成员

arraysize, callproc(), close(), description, execute(), executemany(), fetchall(), fetchmany(), fetchone(), lastrowid, nextset(), rowcount, setinputsizes(), setoutputsize()

类签名

class sqlalchemy.engine.interfaces.DBAPICursor (typing_extensions.Protocol)

attribute sqlalchemy.engine.interfaces.DBAPICursor.arraysize: int¶

method sqlalchemy.engine.interfaces.DBAPICursor.callproc(procname: str, parameters: Sequence[Any] = Ellipsis) → Any¶

method sqlalchemy.engine.interfaces.DBAPICursor.close() → None¶

attribute sqlalchemy.engine.interfaces.DBAPICursor.description¶: Cursor 的 description 属性。

参见

cursor.description - 在 PEP 249 中

method sqlalchemy.engine.interfaces.DBAPICursor.execute(operation: Any, parameters: Sequence[Any] | Mapping[str, Any] | None = None) → Any¶

method sqlalchemy.engine.interfaces.DBAPICursor.executemany(operation: Any, parameters: Sequence[Sequence[Any]] | Sequence[Mapping[str, Any]]) → Any¶

method sqlalchemy.engine.interfaces.DBAPICursor.fetchall() → Sequence[Any]¶

method sqlalchemy.engine.interfaces.DBAPICursor.fetchmany(size: int = Ellipsis) → Sequence[Any]¶

method sqlalchemy.engine.interfaces.DBAPICursor.fetchone() → Any | None¶

attribute sqlalchemy.engine.interfaces.DBAPICursor.lastrowid: int¶

method sqlalchemy.engine.interfaces.DBAPICursor.nextset() → bool | None¶

attribute sqlalchemy.engine.interfaces.DBAPICursor.rowcount¶

method sqlalchemy.engine.interfaces.DBAPICursor.setinputsizes(sizes: Sequence[Any]) → None¶

method sqlalchemy.engine.interfaces.DBAPICursor.setoutputsize(size: Any, column: Any) → None¶

class sqlalchemy.engine.interfaces.DBAPIType¶: 表示 PEP 249 数据库类型的协议。

2.0 版本新增。

参见

Type Objects - 在 PEP 249 中

类签名

class sqlalchemy.engine.interfaces.DBAPIType (typing_extensions.Protocol)

class sqlalchemy.sql.compiler.DDLCompiler¶

成员

__init__(), cache_key, compile_state, construct_params(), define_constraint_remote_table(), dml_compile_state, execution_options, params, sql_compiler, state, statement, string

类签名

class sqlalchemy.sql.compiler.DDLCompiler (sqlalchemy.sql.compiler.Compiled)

method sqlalchemy.sql.compiler.DDLCompiler.__init__(dialect: Dialect, statement: ClauseElement | None, schema_translate_map: SchemaTranslateMapType | None = None, render_schema_translate: bool = False, compile_kwargs: Mapping[str, Any] = {})¶

继承自 sqlalchemy.sql.compiler.Compiled.__init__ 方法，源自 Compiled

构造一个新的 Compiled 对象。

参数:

dialect¶ – 要编译的目标 Dialect。
statement¶ – 要编译的 ClauseElement。
schema_translate_map¶ –
用于在形成结果 SQL 时翻译的模式名称字典

参见

模式名称的翻译
compile_kwargs¶ – 将传递给 Compiled.process() 的初始调用的附加 kwargs。

attribute sqlalchemy.sql.compiler.DDLCompiler.cache_key: CacheKey | None = None¶

继承自 Compiled.cache_key 属性，源自 Compiled

在创建此 Compiled 对象之前生成的 CacheKey。

这用于需要访问原始 CacheKey 实例的例程，该实例在首次缓存 Compiled 实例时生成，通常是为了协调原始的 BindParameter 对象列表与每次调用时生成的每个语句的列表。

attribute sqlalchemy.sql.compiler.DDLCompiler.compile_state: CompileState | None = None¶

继承自 Compiled.compile_state 属性，源自 Compiled

可选的 CompileState 对象，用于维护编译器使用的其他状态。

主要的执行对象（例如 Insert、Update、Delete、Select）将在编译时生成此状态，以便计算有关对象的其他信息。对于要执行的顶层对象，状态可以存储在此处，它也可以适用于结果集处理。

1.4 版本新增。

method sqlalchemy.sql.compiler.DDLCompiler.construct_params(params: _CoreSingleExecuteParams | None = None, extracted_parameters: Sequence[BindParameter[Any]] | None = None, escape_names: bool = True) → _MutableCoreSingleExecuteParams | None¶

返回此编译对象的绑定参数。

参数:: params¶ – 字符串/对象对的字典，其值将覆盖编译到语句中的绑定值。

method sqlalchemy.sql.compiler.DDLCompiler.define_constraint_remote_table(constraint, table, preparer)¶: 格式化 CREATE CONSTRAINT 子句的远程表子句。

attribute sqlalchemy.sql.compiler.DDLCompiler.dml_compile_state: CompileState | None = None¶

继承自 Compiled.dml_compile_state 属性，源自 Compiled

在分配 .isinsert、.isupdate 或 .isdelete 的同一点分配的可选 CompileState。

这通常与 .compile_state 对象相同，但 ORMFromStatementCompileState 对象等情况除外。

1.4.40 版本新增。

attribute sqlalchemy.sql.compiler.DDLCompiler.execution_options: _ExecuteOptions = {}¶: 继承自 Compiled.execution_options 属性，源自 Compiled

从语句传播的执行选项。在某些情况下，语句的子元素可以修改这些选项。

attribute sqlalchemy.sql.compiler.DDLCompiler.params¶: 继承自 Compiled.params 属性，源自 Compiled

返回此编译对象的绑定参数。

attribute sqlalchemy.sql.compiler.DDLCompiler.sql_compiler¶

attribute sqlalchemy.sql.compiler.DDLCompiler.state: CompilerState¶: 编译器状态的描述

attribute sqlalchemy.sql.compiler.DDLCompiler.statement: ClauseElement | None = None¶: 继承自 Compiled.statement 属性，源自 Compiled

要编译的语句。

attribute sqlalchemy.sql.compiler.DDLCompiler.string: str = ''¶: 继承自 Compiled.string 属性，源自 Compiled

statement 的字符串表示形式

class sqlalchemy.engine.default.DefaultDialect¶

Dialect 的默认实现

成员

bind_typing, colspecs, connect(), construct_arguments, create_connect_args(), create_xid(), cte_follows_insert, dbapi, dbapi_exception_translation_map, ddl_compiler, default_isolation_level, default_metavalue_token, default_schema_name, default_sequence_base, delete_executemany_returning, delete_returning, delete_returning_multifrom, denormalize_name(), div_is_floordiv, do_begin(), do_begin_twophase(), do_close(), do_commit(), do_commit_twophase(), do_execute(), do_execute_no_params(), do_executemany(), do_ping(), do_prepare_twophase(), do_recover_twophase(), do_release_savepoint(), do_rollback(), do_rollback_to_savepoint(), do_rollback_twophase(), do_savepoint(), do_set_input_sizes(), do_terminate(), driver, engine_config_types, engine_created(), exclude_set_input_sizes, execute_sequence_format, execution_ctx_cls, favor_returning_over_lastrowid, full_returning, get_async_dialect_cls(), get_check_constraints(), get_columns(), get_default_isolation_level(), get_dialect_cls(), get_dialect_pool_class(), get_driver_connection(), get_foreign_keys(), get_indexes(), get_isolation_level(), get_isolation_level_values(), get_materialized_view_names(), get_multi_check_constraints(), get_multi_columns(), get_multi_foreign_keys(), get_multi_indexes(), get_multi_pk_constraint(), get_multi_table_comment(), get_multi_table_options(), get_multi_unique_constraints(), get_pk_constraint(), get_schema_names(), get_sequence_names(), get_table_comment(), get_table_names(), get_table_options(), get_temp_table_names(), get_temp_view_names(), get_unique_constraints(), get_view_definition(), get_view_names(), has_index(), has_schema(), has_sequence(), has_table(), has_terminate, identifier_preparer, import_dbapi(), include_set_input_sizes, initialize(), inline_comments, insert_executemany_returning, insert_executemany_returning_sort_by_parameter_order, insert_returning, insertmanyvalues_implicit_sentinel, insertmanyvalues_max_parameters, insertmanyvalues_page_size, is_async, is_disconnect(), label_length, load_provisioning(), loaded_dbapi, max_identifier_length, name, normalize_name(), on_connect(), on_connect_url(), paramstyle, positional, preexecute_autoincrement_sequences, preparer, reflection_options, reset_isolation_level(), returns_native_bytes, sequences_optional, server_side_cursors, server_version_info, set_connection_execution_options(), set_engine_execution_options(), set_isolation_level(), statement_compiler, supports_alter, supports_comments, supports_constraint_comments, supports_default_metavalue, supports_default_values, supports_empty_insert, supports_identity_columns, supports_multivalues_insert, supports_native_boolean, supports_native_decimal, supports_native_enum, supports_native_uuid, supports_sane_multi_rowcount, supports_sane_rowcount, supports_sane_rowcount_returning, supports_sequences, supports_server_side_cursors, supports_simple_order_by_label, supports_statement_cache, tuple_in_values, type_compiler, type_compiler_cls, type_compiler_instance, type_descriptor(), update_executemany_returning, update_returning, update_returning_multifrom, use_insertmanyvalues, use_insertmanyvalues_wo_returning

类签名

class sqlalchemy.engine.default.DefaultDialect (sqlalchemy.engine.interfaces.Dialect)

attribute sqlalchemy.engine.default.DefaultDialect.bind_typing = 1¶

定义一种将类型信息传递到数据库和/或驱动程序以用于绑定参数的方法。

有关值，请参阅 BindTyping。

2.0 版本新增。

attribute sqlalchemy.engine.default.DefaultDialect.colspecs: MutableMapping[Type[TypeEngine[Any]], Type[TypeEngine[Any]]] = {}¶: sqlalchemy.types 中的 TypeEngine 类字典，映射到特定于 dialect 类的子类。此字典仅为类级别，不能从 dialect 实例本身访问。

method sqlalchemy.engine.default.DefaultDialect.connect(*cargs, **cparams)¶

使用此 dialect 的 DBAPI 建立连接。

此方法的默认实现是

def connect(self, *cargs, **cparams):
    return self.dbapi.connect(*cargs, **cparams)

*cargs, **cparams 参数直接从此 dialect 的 Dialect.create_connect_args() 方法生成。

对于需要在从 DBAPI 获取新连接时执行程序化的按连接步骤的 dialect，可以使用此方法。

参数:

*cargs¶ – 从 Dialect.create_connect_args() 方法返回的位置参数
**cparams¶ – 从 Dialect.create_connect_args() 方法返回的关键字参数。

返回:

DBAPI 连接，通常来自 PEP 249 模块级别的 .connect() 函数。

参见

Dialect.create_connect_args()

Dialect.on_connect()

attribute sqlalchemy.engine.default.DefaultDialect.construct_arguments: List[Tuple[Type[SchemaItem | ClauseElement], Mapping[str, Any]]] | None = None¶

继承自 Dialect.construct_arguments 属性，源自 Dialect

各种 SQLAlchemy 构造（通常是 schema 项）的可选参数说明符集。

要实现，请建立为一系列元组，如下所示

construct_arguments = [
    (schema.Index, {"using": False, "where": None, "ops": None}),
]

如果在 PostgreSQL dialect 上建立上述构造，则 Index 构造现在将接受关键字参数 postgresql_using、postgresql_where 和 postgresql_ops。Index 构造函数的任何其他以 postgresql_ 为前缀的参数都将引发 ArgumentError。

不包含 construct_arguments 成员的 dialect 将不参与参数验证系统。对于此类 dialect，所有参与构造函数都接受任何参数名称，在该 dialect 名称前缀的参数命名空间内。此处的理由是为了尚未实现此功能的第三方 dialect 继续以旧方式运行。

参见

DialectKWArgs - 实现使用 DefaultDialect.construct_arguments 的基类

method sqlalchemy.engine.default.DefaultDialect.create_connect_args(url)¶

构建 DB-API 兼容的连接参数。

给定 URL 对象，返回一个元组，其中包含适合直接发送到 dbapi 的 connect 函数的 (*args, **kwargs)。参数将发送到 Dialect.connect() 方法，然后该方法运行 DBAPI 级别的 connect() 函数。

该方法通常使用 URL.translate_connect_args() 方法来生成选项字典。

默认实现是

def create_connect_args(self, url):
    opts = url.translate_connect_args()
    opts.update(url.query)
    return ([], opts)

参数:: url¶ – URL 对象
返回:: 一个 (*args, **kwargs) 元组，它将被传递给 Dialect.connect() 方法。

参见

URL.translate_connect_args()

method sqlalchemy.engine.default.DefaultDialect.create_xid()¶

创建随机的两阶段事务 ID。

此 ID 将传递给 do_begin_twophase()、do_rollback_twophase()、do_commit_twophase()。其格式未指定。

attribute sqlalchemy.engine.default.DefaultDialect.cte_follows_insert: bool = False¶: 目标数据库，当给定带有 INSERT 语句的 CTE 时，需要 CTE 位于 INSERT 语句之下

attribute sqlalchemy.engine.default.DefaultDialect.dbapi: ModuleType | None¶

对 DBAPI 模块对象本身的引用。

SQLAlchemy dialect 使用类方法 Dialect.import_dbapi() 导入 DBAPI 模块。理由是，任何 dialect 模块都可以被导入并用于生成 SQL 语句，而无需安装实际的 DBAPI 驱动程序。只有在使用 create_engine() 构造 Engine 时，DBAPI 才会被导入；届时，创建过程会将 DBAPI 模块分配给此属性。

因此，Dialect 应该实现 Dialect.import_dbapi()，它将导入必要的模块并返回它，然后在 dialect 代码中引用 self.dbapi 以引用 DBAPI 模块内容。

在版本 The 中更改：Dialect.dbapi 属性专门用作每个 Dialect 实例对 DBAPI 模块的引用。先前未完全文档化的 .Dialect.dbapi() 类方法已被弃用，并由 Dialect.import_dbapi() 替换。

attribute sqlalchemy.engine.default.DefaultDialect.dbapi_exception_translation_map: Mapping[str, str] = {}¶: 继承自 Dialect.dbapi_exception_translation_map 属性，源自 Dialect

一个名称字典，其中将包含 pep-249 异常（“IntegrityError”、“OperationalError”等）的名称作为值，并以备用类名称为键，以支持 DBAPI 具有未按引用方式命名的异常类的情况（例如 IntegrityError = MyException）。在绝大多数情况下，此字典为空。

attribute sqlalchemy.engine.default.DefaultDialect.ddl_compiler¶: DDLCompiler 的别名

attribute sqlalchemy.engine.default.DefaultDialect.default_isolation_level: IsolationLevel | None¶: 新连接上隐式存在的隔离级别

attribute sqlalchemy.engine.default.DefaultDialect.default_metavalue_token: str = 'DEFAULT'¶: 对于 INSERT… VALUES (DEFAULT) 语法，放在括号中的标记。

attribute sqlalchemy.engine.default.DefaultDialect.default_schema_name: str | None = None¶: 默认模式的名称。此值仅适用于支持的方言，并且通常在与数据库的初始连接期间填充。

attribute sqlalchemy.engine.default.DefaultDialect.default_sequence_base: int = 1¶: 将渲染为 CREATE SEQUENCE DDL 语句的 “START WITH” 部分的默认值。

attribute sqlalchemy.engine.default.DefaultDialect.delete_executemany_returning: bool = False¶: 方言是否支持使用 executemany 的 DELETE..RETURNING。

attribute sqlalchemy.engine.default.DefaultDialect.delete_returning: bool = False¶: 方言是否支持使用 DELETE 的 RETURNING

2.0 版本新增。

attribute sqlalchemy.engine.default.DefaultDialect.delete_returning_multifrom: bool = False¶: 方言是否支持使用 DELETE..FROM 的 RETURNING

2.0 版本新增。

method sqlalchemy.engine.default.DefaultDialect.denormalize_name(name)¶

如果给定的名称是全小写名称，则将其转换为后端的大小写不敏感标识符。

仅当方言定义了 requires_name_normalize=True 时才使用此方法。

attribute sqlalchemy.engine.default.DefaultDialect.div_is_floordiv: bool = True¶: 目标数据库是否将 / 除法运算符视为 “向下取整除法”

method sqlalchemy.engine.default.DefaultDialect.do_begin(dbapi_connection)¶

提供 connection.begin() 的实现，给定一个 DB-API 连接。

DBAPI 没有专用的 “begin” 方法，并且期望事务是隐式的。为那些可能需要在此领域提供额外帮助的 DBAPI 提供了此钩子。

参数:: dbapi_connection¶ – 一个 DBAPI 连接，通常在 ConnectionFairy 中代理。

method sqlalchemy.engine.default.DefaultDialect.do_begin_twophase(connection: Connection, xid: Any) → None¶

继承自 Dialect.do_begin_twophase() 方法，该方法属于 Dialect

在给定的连接上开始两阶段事务。

参数:

connection¶ – 一个 Connection。
xid¶ – xid

method sqlalchemy.engine.default.DefaultDialect.do_close(dbapi_connection)¶

提供 connection.close() 的实现，给定一个 DB-API 连接。

当连接已从池中分离，或正在返回到超出池的正常容量时，Pool 会调用此钩子。

method sqlalchemy.engine.default.DefaultDialect.do_commit(dbapi_connection)¶

提供 connection.commit() 的实现，给定一个 DB-API 连接。

参数:: dbapi_connection¶ – 一个 DBAPI 连接，通常在 ConnectionFairy 中代理。

method sqlalchemy.engine.default.DefaultDialect.do_commit_twophase(connection: Connection, xid: Any, is_prepared: bool = True, recover: bool = False) → None¶

继承自 Dialect.do_commit_twophase() 方法，该方法属于 Dialect

在给定的连接上提交两阶段事务。

参数:

connection¶ – 一个 Connection。
xid¶ – xid
is_prepared¶ – 是否调用了 TwoPhaseTransaction.prepare()。
recover¶ – 是否传递了 recover 标志。

method sqlalchemy.engine.default.DefaultDialect.do_execute(cursor, statement, parameters, context=None)¶: 提供 cursor.execute(statement, parameters) 的实现。

method sqlalchemy.engine.default.DefaultDialect.do_execute_no_params(cursor, statement, context=None)¶

提供 cursor.execute(statement) 的实现。

不应发送参数集合。

method sqlalchemy.engine.default.DefaultDialect.do_executemany(cursor, statement, parameters, context=None)¶: 提供 cursor.executemany(statement, parameters) 的实现。

method sqlalchemy.engine.default.DefaultDialect.do_ping(dbapi_connection: DBAPIConnection) → bool¶: ping DBAPI 连接，如果连接可用，则返回 True。

method sqlalchemy.engine.default.DefaultDialect.do_prepare_twophase(connection: Connection, xid: Any) → None¶

继承自 Dialect.do_prepare_twophase() 方法，该方法属于 Dialect

在给定的连接上准备两阶段事务。

参数:

connection¶ – 一个 Connection。
xid¶ – xid

method sqlalchemy.engine.default.DefaultDialect.do_recover_twophase(connection: Connection) → List[Any]¶

继承自 Dialect.do_recover_twophase() 方法，该方法属于 Dialect

恢复给定连接上未提交的已准备的两阶段事务标识符列表。

参数:: connection¶ – 一个 Connection。

method sqlalchemy.engine.default.DefaultDialect.do_release_savepoint(connection, name)¶

释放连接上命名的保存点。

参数:

connection¶ – 一个 Connection。
name¶ – 保存点名称。

method sqlalchemy.engine.default.DefaultDialect.do_rollback(dbapi_connection)¶

提供 connection.rollback() 的实现，给定一个 DB-API 连接。

参数:: dbapi_connection¶ – 一个 DBAPI 连接，通常在 ConnectionFairy 中代理。

method sqlalchemy.engine.default.DefaultDialect.do_rollback_to_savepoint(connection, name)¶

将连接回滚到命名的保存点。

参数:

connection¶ – 一个 Connection。
name¶ – 保存点名称。

method sqlalchemy.engine.default.DefaultDialect.do_rollback_twophase(connection: Connection, xid: Any, is_prepared: bool = True, recover: bool = False) → None¶

继承自 Dialect.do_rollback_twophase() 方法，该方法属于 Dialect

在给定的连接上回滚两阶段事务。

参数:

connection¶ – 一个 Connection。
xid¶ – xid
is_prepared¶ – 是否调用了 TwoPhaseTransaction.prepare()。
recover¶ – 是否传递了 recover 标志。

method sqlalchemy.engine.default.DefaultDialect.do_savepoint(connection, name)¶

使用给定的名称创建一个保存点。

参数:

connection¶ – 一个 Connection。
name¶ – 保存点名称。

method sqlalchemy.engine.default.DefaultDialect.do_set_input_sizes(cursor: DBAPICursor, list_of_tuples: _GenericSetInputSizesType, context: ExecutionContext) → Any¶

继承自 Dialect.do_set_input_sizes() 方法，该方法属于 Dialect

使用适当的参数调用 cursor.setinputsizes() 方法

如果 Dialect.bind_typing 属性设置为 BindTyping.SETINPUTSIZES 值，则会调用此钩子。参数数据在元组列表 (paramname, dbtype, sqltype) 中传递，其中 paramname 是语句中参数的键，dbtype 是 DBAPI 数据类型，sqltype 是 SQLAlchemy 类型。元组的顺序是正确的参数顺序。

1.4 版本新增。

Changed in version 2.0: - 现在通过将 Dialect.bind_typing 设置为 BindTyping.SETINPUTSIZES 来启用 setinputsizes 模式。接受 use_setinputsizes 参数的方言应适当地设置此值。

method sqlalchemy.engine.default.DefaultDialect.do_terminate(dbapi_connection)¶

提供 connection.close() 的实现，该实现尽可能尝试不阻塞，给定一个 DBAPI 连接。

在绝大多数情况下，这只是调用 .close()，然而，对于某些 asyncio 方言，可能会调用不同的 API 功能。

当连接正在被回收或已失效时，Pool 会调用此钩子。

New in version 1.4.41.

attribute sqlalchemy.engine.default.DefaultDialect.driver: str¶: 方言的 DBAPI 的标识名称

attribute sqlalchemy.engine.default.DefaultDialect.engine_config_types: Mapping[str, Any] = {'echo': <function bool_or_str.<locals>.bool_or_value>, 'echo_pool': <function bool_or_str.<locals>.bool_or_value>, 'future': <function asbool>, 'max_overflow': <function asint>, 'pool_recycle': <function asint>, 'pool_size': <function asint>, 'pool_timeout': <function asint>}¶: 一个字符串键的映射，这些字符串键可以在链接到类型转换函数的引擎配置中。

classmethod sqlalchemy.engine.default.DefaultDialect.engine_created(engine: Engine) → None¶

继承自 Dialect.engine_created() 方法，该方法属于 Dialect

在返回最终的 Engine 之前调用的便捷钩子。

如果方言从 get_dialect_cls() 方法返回了不同的类，则会在两个类上调用该钩子，首先在 get_dialect_cls() 方法返回的方言类上调用，然后在调用该方法的类上调用。

方言和/或包装器应使用此钩子将特殊事件应用于引擎或其组件。特别是，它允许方言包装类应用方言级事件。

attribute sqlalchemy.engine.default.DefaultDialect.exclude_set_input_sizes: Set[Any] | None = None¶

DBAPI 类型对象的集合，这些对象应在自动 cursor.setinputsizes() 调用中排除。

仅当 bind_typing 为 BindTyping.SET_INPUT_SIZES 时才使用此项

attribute sqlalchemy.engine.default.DefaultDialect.execute_sequence_format¶: tuple 的别名

attribute sqlalchemy.engine.default.DefaultDialect.execution_ctx_cls¶: DefaultExecutionContext 的别名

attribute sqlalchemy.engine.default.DefaultDialect.favor_returning_over_lastrowid: bool = False¶

对于同时支持 `lastrowid` 和 `RETURNING` 插入策略的后端，对于简单的单整数主键插入，倾向于使用 `RETURNING`。

`cursor.lastrowid` 在大多数后端上往往性能更高。

attribute sqlalchemy.engine.default.DefaultDialect.full_returning¶: Deprecated since version 2.0: `full_returning` 已弃用，请使用 `insert_returning`、`update_returning` 和 `delete_returning`

classmethod sqlalchemy.engine.default.DefaultDialect.get_async_dialect_cls(url: URL) → Type[Dialect]¶

继承自 Dialect.get_async_dialect_cls() 方法，来自 Dialect

给定一个 URL，返回异步引擎将使用的 Dialect。

默认情况下，这是 Dialect.get_dialect_cls() 的别名，并且仅返回 cls。如果方言在同一名称下提供同步和异步版本（如 `psycopg` 驱动程序），则可以使用它。

2.0 版本新增。

参见

Dialect.get_dialect_cls()

method sqlalchemy.engine.default.DefaultDialect.get_check_constraints(connection: Connection, table_name: str, schema: str | None = None, **kw: Any) → List[ReflectedCheckConstraint]¶

继承自 Dialect.get_check_constraints() 方法，来自 Dialect

返回关于 `table_name` 中的检查约束的信息。

给定一个字符串 `table_name` 和一个可选的字符串 `schema`，返回检查约束信息，作为与 ReflectedCheckConstraint 字典对应的字典列表。

这是一个内部方言方法。应用程序应使用 Inspector.get_check_constraints()。

method sqlalchemy.engine.default.DefaultDialect.get_columns(connection: Connection, table_name: str, schema: str | None = None, **kw: Any) → List[ReflectedColumn]¶

继承自 Dialect.get_columns() 方法，来自 Dialect

返回关于 `table_name` 中的列的信息。

给定一个 Connection，一个字符串 `table_name` 和一个可选的字符串 `schema`，返回列信息，作为与 ReflectedColumn 字典对应的字典列表。

这是一个内部方言方法。应用程序应使用 Inspector.get_columns()。

method sqlalchemy.engine.default.DefaultDialect.get_default_isolation_level(dbapi_conn)¶

给定一个 DBAPI 连接，返回其隔离级别，如果无法检索到隔离级别，则返回默认隔离级别。

子类可以覆盖此方法，以便为无法可靠检索实际隔离级别的数据库提供“回退”隔离级别。

默认情况下，调用 Interfaces.get_isolation_level() 方法，传播引发的任何异常。

1.3.22 版本新增。

classmethod sqlalchemy.engine.default.DefaultDialect.get_dialect_cls(url: URL) → Type[Dialect]¶

继承自 Dialect.get_dialect_cls() 方法，来自 Dialect

给定一个 URL，返回将要使用的 Dialect。

这是一个钩子，允许外部插件通过允许从基于入口点的 URL 加载插件来提供围绕现有方言的功能，然后插件返回要使用的实际方言。

默认情况下，这仅返回 cls。

method sqlalchemy.engine.default.DefaultDialect.get_dialect_pool_class(url: URL) → Type[Pool]¶: 返回用于给定 URL 的 Pool 类

method sqlalchemy.engine.default.DefaultDialect.get_driver_connection(connection)¶

返回外部驱动程序包返回的连接对象。

对于使用符合 DBAPI 驱动程序的普通方言，此调用将仅返回作为参数传递的 `connection`。对于相反地适配非 DBAPI 兼容驱动程序的方言，例如在适配 asyncio 驱动程序时，此调用将返回驱动程序返回的类连接对象。

1.4.24 版本新增。

method sqlalchemy.engine.default.DefaultDialect.get_foreign_keys(connection: Connection, table_name: str, schema: str | None = None, **kw: Any) → List[ReflectedForeignKeyConstraint]¶

继承自 Dialect.get_foreign_keys() 方法，来自 Dialect

返回关于 `table_name` 中的外键的信息。

给定一个 Connection，一个字符串 `table_name` 和一个可选的字符串 `schema`，返回外键信息，作为与 ReflectedForeignKeyConstraint 字典对应的字典列表。

这是一个内部方言方法。应用程序应使用 Inspector.get_foreign_keys()。

method sqlalchemy.engine.default.DefaultDialect.get_indexes(connection: Connection, table_name: str, schema: str | None = None, **kw: Any) → List[ReflectedIndex]¶

继承自 Dialect.get_indexes() 方法，来自 Dialect

返回关于 `table_name` 中的索引的信息。

给定一个 Connection，一个字符串 `table_name` 和一个可选的字符串 `schema`，返回索引信息，作为与 ReflectedIndex 字典对应的字典列表。

这是一个内部方言方法。应用程序应使用 Inspector.get_indexes()。

method sqlalchemy.engine.default.DefaultDialect.get_isolation_level(dbapi_connection: DBAPIConnection) → Literal['SERIALIZABLE', 'REPEATABLE READ', 'READ COMMITTED', 'READ UNCOMMITTED', 'AUTOCOMMIT']¶

继承自 Dialect.get_isolation_level() 方法，来自 Dialect

给定一个 DBAPI 连接，返回其隔离级别。

当使用 Connection 对象时，可以使用 Connection.connection 访问器获取相应的 DBAPI 连接。

请注意，这是一个方言级别的方法，用作 Connection 和 Engine 隔离级别设施的实现的一部分；对于大多数典型用例，应首选这些 API。

参见

Connection.get_isolation_level() - 查看当前级别

Connection.default_isolation_level - 查看默认级别

Connection.execution_options.isolation_level - 设置每个 Connection 隔离级别

create_engine.isolation_level - 设置每个 Engine 隔离级别

method sqlalchemy.engine.default.DefaultDialect.get_isolation_level_values(dbapi_conn: DBAPIConnection) → List[Literal['SERIALIZABLE', 'REPEATABLE READ', 'READ COMMITTED', 'READ UNCOMMITTED', 'AUTOCOMMIT']]¶

继承自 Dialect.get_isolation_level_values() 方法，来自 Dialect

返回此方言接受的字符串隔离级别名称序列。

可用名称应使用以下约定

使用 UPPERCASE 名称。隔离级别方法将接受小写名称，但这些名称在传递给方言之前会被标准化为 UPPERCASE。
单词之间应使用空格分隔，而不是下划线，例如 `REPEATABLE READ`。隔离级别名称在传递给方言之前，下划线将被转换为空格。
后端支持的四个标准隔离名称应为 `READ UNCOMMITTED`、`READ COMMITTED`、`REPEATABLE READ`、`SERIALIZABLE`
如果方言支持自动提交选项，则应使用隔离级别名称 `AUTOCOMMIT` 提供。
还可以存在其他隔离模式，前提是它们以 UPPERCASE 命名并使用空格而不是下划线。

此函数用于使默认方言可以检查给定的隔离级别参数是否有效，否则会引发 ArgumentError。

DBAPI 连接被传递给该方法，以防万一方言需要询问连接本身以确定此列表，但预期大多数后端将返回硬编码的值列表。如果方言支持“AUTOCOMMIT”，则该值也应存在于返回的序列中。

默认情况下，该方法引发 `NotImplementedError`。如果方言未实现此方法，则默认方言将不会对给定的隔离级别值执行任何检查，然后再将其传递给 Dialect.set_isolation_level() 方法。这是为了允许与可能尚未实现此方法的第三方方言向后兼容。

2.0 版本新增。

method sqlalchemy.engine.default.DefaultDialect.get_materialized_view_names(connection: Connection, schema: str | None = None, **kw: Any) → List[str]¶

继承自 Dialect.get_materialized_view_names() 方法，来自 Dialect

返回数据库中所有可用的物化视图名称的列表。

这是一个内部方言方法。应用程序应使用 Inspector.get_materialized_view_names()。

参数:

schema¶ –

要查询的模式名称，如果不是默认模式。

2.0 版本新增。

method sqlalchemy.engine.default.DefaultDialect.get_multi_check_constraints(connection, **kw)¶

返回关于给定 `schema` 中所有表中的检查约束的信息。

这是一个内部方言方法。应用程序应使用 Inspector.get_multi_check_constraints()。

注意