核心内部结构¶

这里列出了一些关键的内部结构。

对象名称	描述
AdaptedConnection （自适应连接）	用于支持 DBAPI 协议的已调整连接对象的接口。
绑定类型	定义将语句中绑定参数的类型信息传递给数据库驱动程序的不同方法。
编译	表示已编译的 SQL 或 DDL 表达式。
DBAPIConnection	协议，表示 PEP 249 数据库连接。
DBAPICurs或	协议表示 PEP 249 数据库游标。
DBAPIType	协议表示 PEP 249 数据库类型。
DDLCompiler
默认方言	Dialect 的默认实现
DefaultExecutionContext （默认执行上下文）
方言	定义特定数据库和 DB-API 组合的行为。
ExecutionContext	对应于单个执行的 Dialect 的 messenger 对象。
展开状态	表示在为语句生成 “expanded” 和 “post compile” 绑定参数时使用的状态。
GenericType编译器
确定
标识符准备器	根据选项处理标识符的引用和大小写折叠。
SQLCompiler	`Compiled` 的默认实现。
StrSQLCompiler	`一个 SQLCompiler` 子类，它允许将一小部分非标准 SQL 功能渲染为字符串值。

类 sqlalchemy.engine 中。BindTyping（绑定类型化）¶

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

2.0 版的新Function。

成员

无、RENDER_CASTS、SETINPUTSIZES

类签名

class sqlalchemy.engine.BindTyping （enum.枚举）

属性 sqlalchemy.engine.BindTyping。无 = 1¶

不执行任何步骤将键入信息传递给数据库驱动程序。

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

属性 sqlalchemy.engine.BindTyping。 RENDER_CASTS = 3¶

在 SQL 字符串中呈现强制转换或其他指令。

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

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

该 SQLCompiler.render_bind_cast() 还用于渲染强制转换对于一种形式的 “insertmanyvalues” 查询，当 InsertmanyvaluesSentinelOpts.USE_INSERT_FROM_SELECT 和 InsertmanyvaluesSentinelOpts.RENDER_SELECT_COL_CASTS ，其中强制转换应用于中间列，例如 “INSERT INTO t （a， b， c） SELECT p0：：TYP， p1：：TYP， p2：：TYP ” “FROM （values （?, ?），（?, ?）， ...）”。

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

属性 sqlalchemy.engine.BindTyping。SETINPUTSIZES = 2¶

使用 pep-249 setinputsizes 方法。

这仅针对支持此方法的 DBAPI 实现，并且 SQLAlchemy 方言具有适用于该方言设置的基础结构。当前的方言包括 python-oracledb、cx_Oracle 以及对使用 pyodbc 的 SQL Server 的可选支持。

当使用 setinputsizes 时，方言还可以只使用包含/排除列表对某些数据类型使用该方法。

使用 SETINPUTSIZES 时，将为执行的每个具有绑定参数的语句调用 Dialect.do_set_input_sizes（） 方法。

类 sqlalchemy.engine 中。编译¶

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

成员

__init__（）、cache_key、compile_state、construct_params（）、dml_compile_state、execution_options、参数、sql_compiler、状态、语句、字符串

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

方法 sqlalchemy.engine.Compiled。__init__（dialect：方言， statement：ClauseElementNone， schema_translate_map：SchemaTranslateMapTypeNone=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。

属性 sqlalchemy.engine.Compiled。cache_key：CacheKeyNone = 无¶

在创建此 Compiled 对象。

这用于需要访问原始 CacheKey 实例实例，通常是为了协调 BindParameter 对象的原始列表，其中包含在每次调用时生成的每个语句列表。

属性 sqlalchemy.engine.Compiled。compile_state：CompileStateNone = 无¶

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

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

在 1.4 版本加入.

方法 sqlalchemy.engine.Compiled。construct_params（params：_CoreSingleExecuteParamsNone=None， extracted_parameters：Sequence[BindParameter[Any]]None=None， escape_names： bool = True）→_MutableCoreSingleExecuteParamsNone¶

返回此编译对象的 bind params。

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

属性 sqlalchemy.engine.Compiled。dml_compile_state：CompileStateNone = 无¶

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

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

在 1.4.40 版本加入.

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

属性 sqlalchemy.engine.Compiled。参数¶: 返回此编译对象的 bind params。

属性 sqlalchemy.engine.Compiled。sql_compiler¶

返回能够处理 SQL 表达式的 Compiled。

如果此编译器是一个，它可能只返回 'self'。

属性 sqlalchemy.engine.Compiled。state： CompilerState¶: 编译器状态的描述

属性 sqlalchemy.engine.Compiled。statement：ClauseElementNone = None¶: 要编译的语句。

属性 sqlalchemy.engine.Compiled。字符串： str = ''¶: 语句的字符串表示形式

类 sqlalchemy.engine.interfaces 中。DBAPIConnection¶

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

2.0 版的新Function。

另请参阅

连接对象 - 在 PEP 249 中

成员

自动提交、close（）、commit（）、cursor（）、rollback（）

类签名

类 sqlalchemy.engine.interfaces.DBAPIConnection （typing_extensions.协议）

属性 sqlalchemy.engine.interfaces.DBAPIConnection. autocommit： bool¶

方法 sqlalchemy.engine.interfaces.DBAPIConnection. close（）→ None¶

方法 sqlalchemy.engine.interfaces.DBAPIConnection. commit（）→ 无¶

方法 sqlalchemy.engine.interfaces.DBAPIConnection. cursor（）→ DBAPICursor¶

方法 sqlalchemy.engine.interfaces.DBAPIConnection. rollback（）→ None¶

类 sqlalchemy.engine.interfaces 中。DBAPICursor¶

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

2.0 版的新Function。

另请参阅

光标对象 - 在 PEP 249 中

成员

arraysize， callproc（）， close（）， description， execute（）， executemany（）， fetchall（）， fetchmany（）， fetchone（）， lastrowid， nextset（）， rowcount， setinputsizes（）， setoutputsize（）

类签名

类 sqlalchemy.engine.interfaces.DBAPICursor （typing_extensions.协议）

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

method sqlalchemy.engine.interfaces.DBAPICursor. callproc（procname： str， parameters： Sequence[Any] = Ellipsis）→ Any¶

方法 sqlalchemy.engine.interfaces.DBAPICursor. close（）→ None¶

属性 sqlalchemy.engine.interfaces.DBAPICursor. 说明¶: 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（）→ 序列[Any]¶

method sqlalchemy.engine.interfaces.DBAPICursor. fetchmany（size： int = Ellipsis）→ 序列[Any]¶

method sqlalchemy.engine.interfaces.DBAPICursor. fetchone（）→AnyNone¶

属性 sqlalchemy.engine.interfaces.DBAPICursor. lastrowid： int¶

方法 sqlalchemy.engine.interfaces.DBAPICursor. nextset（）→boolNone¶

attribute rowcount（属性 sqlalchemy.engine.interfaces.DBAPICursor. rowcount）¶

方法 sqlalchemy.engine.interfaces.DBAPICursor. setinputsizes（sizes： Sequence[Any]）→ None¶

方法 sqlalchemy.engine.interfaces.DBAPICursor. setoutputsize（size： Any， column： Any）→ None¶

类 sqlalchemy.engine.interfaces 中。DBAPIType 语言¶: 协议表示 PEP 249 数据库类型。

2.0 版的新Function。

另请参阅

类型对象 - 在 PEP 249 中

类签名

类 sqlalchemy.engine.interfaces.DBAPIType （typing_extensions.协议）

类 sqlalchemy.sql.compiler。DDLCompiler¶

成员

__init__（）， cache_key， compile_state， construct_params（）， define_constraint_remote_table（）， dml_compile_state， execution_options，参数， sql_compiler，状态，语句，字符串

类签名

类 sqlalchemy.sql.compiler.DDLCompiler （ sqlalchemy.sql.compiler.Compiled ）

method sqlalchemy.sql.compiler.DDLCompiler. __init__（dialect：方言， statement：ClauseElementNone， schema_translate_map：SchemaTranslateMapTypeNone=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。

属性 sqlalchemy.sql.compiler.DDLCompiler. cache_key：CacheKeyNone = None¶

继承自Compiled 的 Compiled.cache_key属性

在创建此 Compiled 对象。

这用于需要访问原始 CacheKey 实例实例，通常是为了协调 BindParameter 对象的原始列表，其中包含在每次调用时生成的每个语句列表。

属性 sqlalchemy.sql.compiler.DDLCompiler. compile_state：CompileStateNone = None¶

继承自Compiled 的 Compiled.compile_state属性

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

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

在 1.4 版本加入.

方法 sqlalchemy.sql.compiler.DDLCompiler. construct_params（params：_CoreSingleExecuteParamsNone=None， extracted_parameters：Sequence[BindParameter[Any]]None=None， escape_names： bool = True）→_MutableCoreSingleExecuteParamsNone¶

返回此编译对象的 bind params。

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

方法 sqlalchemy.sql.compiler.DDLCompiler. define_constraint_remote_table（constraint， table， preparer）¶: 格式化 CREATE CONSTRAINT 子句的远程表子句。

属性 sqlalchemy.sql.compiler.DDLCompiler. dml_compile_state：CompileStateNone = None¶

继承自Compiled 的 Compiled.dml_compile_state属性

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

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

在 1.4.40 版本加入.

属性 sqlalchemy.sql.compiler.DDLCompiler. execution_options： _ExecuteOptions = {}¶: 继承自Compiled 的 Compiled.execution_options属性

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

属性 sqlalchemy.sql.compiler.DDLCompiler. 参数¶: 继承自Compiled 的 Compiled.params属性

返回此编译对象的 bind params。

属性 sqlalchemy.sql.compiler.DDLCompiler. sql_compiler¶

属性 sqlalchemy.sql.compiler.DDLCompiler. 状态：CompilerState¶: 编译器状态的描述

attribute sqlalchemy.sql.compiler.DDLCompiler. statement：ClauseElementNone = None¶: 继承自Compiled 的 Compiled.statement属性

要编译的语句。

属性 sqlalchemy.sql.compiler.DDLCompiler. 字符串： str = ''¶: 继承自Compiled 的 Compiled.string属性

语句的字符串表示形式

类 sqlalchemy.engine.default。默认方言¶

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（）、驱动程序、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、名称、 normalize_name（）， on_connect（）， on_connect_url（）， paramstyle，位置， 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

类签名

类 sqlalchemy.engine.default.DefaultDialect （ sqlalchemy.engine.interfaces.Dialect ）

属性 sqlalchemy.engine.default.DefaultDialect. bind_typing = 1¶

定义一种将类型信息传递给 Bound 参数的数据库和/或 driver 的方法。

有关值，请参阅 BindTyping 。

2.0 版的新Function。

属性 sqlalchemy.engine.default.DefaultDialect. colspecs： MutableMapping[Type[TypeEngine[Any]]， Type[TypeEngine[Any]]] = {}¶: 来自 sqlalchemy.types 的 TypeEngine 类的字典，映射到特定于 dialect 类的子类。此字典只是类级别的，不能从 dialect 实例本身访问。

方法 sqlalchemy.engine.default.DefaultDialect. connect（*cargs， **cparams）¶

使用此方言的 DBAPI 建立连接。

此方法的默认实现为：

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

*cargs， **cparams 参数是直接从这个方言的 Dialect.create_connect_args（） 方法生成的。

此方法可用于在从 DBAPI 获取新连接时需要执行每个连接编程步骤的方言。

参数

cargs¶ —— 从 Dialect.create_connect_args（） 方法
**cparams¶ – 从 Dialect.create_connect_args（） 方法。

结果

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

另请参阅

Dialect.create_connect_args（）

Dialect.on_connect（）

属性 sqlalchemy.engine.default.DefaultDialect. construct_arguments：List[Tuple[Type[SchemaItemClauseElement]，Mapping[str，Any]]]None = None¶

继承自Dialect 的 Dialect.construct_arguments属性

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

要实现，请建立为一系列 Tuples，如下所示：

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

如果上述构造是在 PostgreSQL 方言上建立的，则 Index 构造现在将接受关键字参数 postgresql_using， postgresql_where， nad postgresql_ops.指定给 Index 的构造函数的任何其他参数前缀为 postgresql_ 将引发 ArgumentError。

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

另请参阅

DialectKWArgs - 实现使用 DefaultDialect.construct_arguments

方法 sqlalchemy.engine.default.DefaultDialect. create_connect_args（url）¶

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

给定一个 URL 对象，返回一个由适合直接发送的 （*args， **kwargs） 组成的元组添加到 dbapi 的 connect 函数中。参数将发送到 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（）

方法 sqlalchemy.engine.default.DefaultDialect. create_xid（）¶

创建一个随机的两阶段交易 ID。

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

属性 sqlalchemy.engine.default.DefaultDialect. cte_follows_insert： bool = False¶: 目标数据库，当给定带有 INSERT 语句的 CTE 时，CTE 需要低于 INSERT

属性 sqlalchemy.engine.default.DefaultDialect. dbapi：ModuleTypeNone¶

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

SQLAlchemy dialects 使用 classmethod 导入 DBAPI 模块 Dialect.import_dbapi（） 中。基本原理是，任何方言模块可以导入并用于生成 SQL 语句，而无需需要安装实际的 DBAPI 驱动程序。仅当 Engine 是使用 create_engine（） 构建的，才会导入 DBAPI;此时，创建过程会将 DBAPI 模块分配给此属性。

因此，方言应该实现 Dialect.import_dbapi（） 它将导入必要的模块并返回它，然后引用到方言代码中的 self.dbapi 中引用 DBAPI 模块内容。

版本更改： Dialect.dbapi 属性专门用作对 DBAPI 模块的每个 Dialect 实例的引用。上一个未完全记录的 .Dialect.dbapi（） classmethod 已弃用，取而代之的是 Dialect.import_dbapi（）。

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

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

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

属性 sqlalchemy.engine.default.DefaultDialect. default_isolation_level：IsolationLevelNone¶: 隐式存在于新连接上的隔离

属性 sqlalchemy.engine.default.DefaultDialect. default_metavalue_token： str = 'DEFAULT'¶: 对于 INSERT...VALUES （DEFAULT）语法，要放在括号中的标记。

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

属性 sqlalchemy.engine.default.DefaultDialect. default_sequence_base： int = 1¶: 将呈现为 CREATE SEQUENCE DDL 语句的 “START WITH” 部分的默认值。

属性 sqlalchemy.engine.default.DefaultDialect. delete_executemany_returning： bool = False¶: dialect 支持 DELETE..使用 executemany 返回。

属性 sqlalchemy.engine.default.DefaultDialect. delete_returning： bool = False¶: 如果方言支持使用 DELETE 返回

2.0 版的新Function。

属性 sqlalchemy.engine.default.DefaultDialect. delete_returning_multifrom： bool = False¶: 如果方言支持使用 DELETE 返回..从

2.0 版的新Function。

方法 sqlalchemy.engine.default.DefaultDialect. denormalize_name（name）¶

如果 given name 是全小写名称，则将 given name 转换为后端的不区分大小写的标识符。

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

属性 sqlalchemy.engine.default.DefaultDialect. div_is_floordiv： bool = True¶: Target 数据库将 / Division 运算符视为“楼层划分”

方法 sqlalchemy.engine.default.DefaultDialect. do_begin（dbapi_connection）¶

给定 DB-API 连接，提供 connection.begin（） 的实现。

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

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

方法 sqlalchemy.engine.default.DefaultDialect. do_begin_twophase（connection： Connection， xid： Any）→ 无¶

继承自Dialect 的 Dialect.do_begin_twophase（） 方法

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

参数

connection¶—— 一个 Connection。
xid¶ – xid

方法 sqlalchemy.engine.default.DefaultDialect. do_close（dbapi_connection）¶

给定 DBAPI 连接，提供 connection.close（） 的实现。

这个钩子被 Pool 调用当连接已已从池中分离，或正在超出正常范围返回池的容量。

方法 sqlalchemy.engine.default.DefaultDialect. do_commit（dbapi_connection）¶

给定 DB-API 连接，提供 connection.commit（） 的实现。

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

method sqlalchemy.engine.default.DefaultDialect. do_commit_twophase（connection： Connection， xid： Any， is_prepared： bool = True， recover： bool = False）→ 无¶

继承自Dialect 的 Dialect.do_commit_twophase（） 方法

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

参数

connection¶—— 一个 Connection。
xid¶ – xid
is_prepared¶ – 无论 TwoPhaseTransaction.prepare（） 被调用。
recover¶——如果传递了 recover 标志。

方法 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） 的实现。

不应发送 parameter collection。

方法 sqlalchemy.engine.default.DefaultDialect. do_executemany（cursor， statement， parameters， context=None）¶: 提供 cursor.executemany(statement, parameters) .

方法 sqlalchemy.engine.default.DefaultDialect. do_ping（dbapi_connection： DBAPIConnection）→ bool¶: ping DBAPI 连接，如果连接可用，则返回 True。

方法 sqlalchemy.engine.default.DefaultDialect. do_prepare_twophase（connection： Connection， xid： Any）→ 无¶

继承自Dialect 的 Dialect.do_prepare_twophase（） 方法

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

参数

connection¶—— 一个 Connection。
xid¶ – xid

方法 sqlalchemy.engine.default.DefaultDialect. do_recover_twophase（connection： Connection）→ List[Any]¶

继承自Dialect 的 Dialect.do_recover_twophase（） 方法

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

参数: connection¶—— 一个 Connection。

方法 sqlalchemy.engine.default.DefaultDialect. do_release_savepoint（connection， name）¶

在连接上释放命名的 Savepoint。

参数

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

方法 sqlalchemy.engine.default.DefaultDialect. do_rollback（dbapi_connection）¶

给定 DB-API 连接，提供 connection.rollback（） 的实现。

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

方法 sqlalchemy.engine.default.DefaultDialect. do_rollback_to_savepoint（connection， name）¶

回滚到命名 Savepoint 的连接。

参数

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

方法 sqlalchemy.engine.default.DefaultDialect. do_rollback_twophase（connection： Connection， xid： Any， is_prepared： bool = True， recover： bool = False）→ 无¶

继承自 Dialect.do_rollback_twophase() Dialect 的方法

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

参数

connection¶—— 一个 Connection。
xid¶ – xid
is_prepared¶ – 无论 TwoPhaseTransaction.prepare（） 被调用。
recover¶——如果传递了 recover 标志。

方法 sqlalchemy.engine.default.DefaultDialect. do_savepoint（connection， name）¶

创建具有给定名称的 Savepoint。

参数

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

method sqlalchemy.engine.default.DefaultDialect. do_set_input_sizes（游标：DBAPICursor，list_of_tuples：_GenericSetInputSizesType，上下文：ExecutionContext）→ Any¶

继承自Dialect 的 Dialect.do_set_input_sizes（） 方法

使用适当的参数调用 cursor.setInputSizes（）方法

如果 Dialect.bind_typing 属性为设置为 BindTyping.SETINPUTSIZES 值。参数数据以元组列表（paramname、dbtype、sqltype）的形式传递，其中 paramname 是语句中参数的键，dbtype 是 DBAPI 数据类型，sqltype 是 SQLAlchemy 类型。元组的顺序是正确的参数顺序。

在 1.4 版本加入.

在 2.0 版更改： - 现在通过将 Dialect.bind_typing 设置为接受 use_setinputsizes 参数的方言应适当地设置此值。

方法 sqlalchemy.engine.default.DefaultDialect. do_terminate（dbapi_connection）¶

提供 connection.close（） 的实现，在给定 DBAPI 连接的情况下，该实现会尽可能地不阻塞。

在绝大多数情况下，这只是调用 .close（），但是对于某些 asyncio dialects 可能会调用不同的 API 功能。

这个钩子被 Pool 调用当连接正在回收或已失效时。

在 1.4.41 版本加入.

属性 sqlalchemy.engine.default.DefaultDialect. 驱动：str¶: 方言的 DBAPI 的标识名称

属性 sqlalchemy.engine.default.DefaultDialect. engine_config_types： Mapping[str， Any] = {'echo'： <函数 bool_or_str.<locals>.bool_or_value>， 'echo_pool'： <函数 bool_or_str.<本地变量>.bool_or_value>， 'future'： <函数别名>， 'max_overflow'： <函数别名>， 'pool_recycle'： <函数别名>， 'pool_size'： <函数别名>， 'pool_timeout'： <函数别名>}¶: 字符串键的映射，可以位于链接到类型转换函数的引擎配置中。

类方法 sqlalchemy.engine.default.DefaultDialect. engine_created（engine： Engine）→ 无¶

继承自Dialect 的 Dialect.engine_created（） 方法

在返回最终的 发动机。

如果 dialect 返回的类与 get_dialect_cls（） 方法，则钩子会在两个类上调用，首先在 get_dialect_cls（） 方法返回的 dialect 类，然后是调用该方法的类。

方言和/或包装器应使用 hook 将特殊事件应用于引擎或其组件。特别是，它允许 dialect-wrapping 类应用 dialect 级别的事件。

属性 sqlalchemy.engine.default.DefaultDialect. exclude_set_input_sizes：Set[Any]None = None¶

应在自动 cursor.setinputsizes（）调用中排除的 DBAPI 类型对象集。

仅当 bind_typing 为 BindTyping.SET_INPUT_SIZES 时，才使用此方法

属性 sqlalchemy.engine.default.DefaultDialect. execute_sequence_format¶: 元组的别名

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

属性 sqlalchemy.engine.default.DefaultDialect. favor_returning_over_lastrowid： bool = False¶

对于同时支持 lastrowid 和 RETURNING 插入策略的后端，对于简单的单整数 pk 插入，首选 RETURNING。

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

属性 sqlalchemy.engine.default.DefaultDialect. full_returning¶: 2.0 版后已废弃： full_returning 已废弃，请使用 insert_returning、update_returning delete_returning

类方法 sqlalchemy.engine.default.DefaultDialect. get_async_dialect_cls（url： url）→ Type[方言]¶

继承自 Dialect.get_async_dialect_cls() Dialect 的方法

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

默认情况下，这是 Dialect.get_dialect_cls（） 和只返回 CLS。如果方言提供同步版本和异步版本，如 psycopg 驱动程序。

版本 2 的新Function。

另请参阅

Dialect.get_dialect_cls（）

方法 sqlalchemy.engine.default.DefaultDialect. get_check_constraints（connection： Connection， table_name： str， schema：strNone=None， **kw： Any）→ List[ReflectedCheckConstraint]¶

继承自 Dialect.get_check_constraints() Dialect 的方法

返回有关 table_name 中的 check 约束的信息。

给定一个字符串table_name和一个可选的字符串架构，将 check 约束信息作为对应于 ReflectedCheckConstraint 字典的字典列表返回。

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

方法 sqlalchemy.engine.default.DefaultDialect. get_columns（connection： Connection， table_name： str， schema：strNone=None， **kw： Any）→ List[ReflectedColumn]¶

继承自Dialect 的 Dialect.get_columns（） 方法。

返回有关 table_name 中的列的信息。

给定一个 Connection，一个字符串 table_name和可选的字符串架构，将列信息作为对应于 ReflectedColumn 字典的字典列表返回。

这是一种内部方言方法。应用程序应使用 Inspector.get_columns（） 中。

方法 sqlalchemy.engine.default.DefaultDialect. get_default_isolation_level（dbapi_conn）¶

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

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

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

在 1.3.22 版本加入.

类方法 sqlalchemy.engine.default.DefaultDialect. get_dialect_cls（url： url）→ Type[Dialect]¶

继承自Dialect 的 Dialect.get_dialect_cls（） 方法

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

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

默认情况下，这只返回 cls.

方法 sqlalchemy.engine.default.DefaultDialect. get_dialect_pool_class（url： URL）→ Type[Pool]¶: 返回要用于给定 URL 的 Pool 类

方法 sqlalchemy.engine.default.DefaultDialect. get_driver_connection（连接）¶

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

对于使用符合 DBAPI 的驱动程序的普通方言，此调用将仅返回作为参数传递的连接。对于改为改编不符合 DBAPI 的驱动程序的方言，例如改编 asyncio 驱动程序时，此调用将返回驱动程序返回的类似连接的对象。

在 1.4.24 版本加入.

方法 sqlalchemy.engine.default.DefaultDialect. get_foreign_keys（connection： Connection， table_name： str， schema：strNone=None， **kw： Any）→ List[ReflectedForeignKeyConstraint]¶

继承自Dialect 的 Dialect.get_foreign_keys（） 方法

在 table_name 中返回有关 foreign_keys 的信息。

给定一个 Connection，一个字符串 table_name 和可选的字符串架构返回 foreign key information 作为对应于 ReflectedForeignKeyConstraint 字典。

这是一种内部方言方法。应用程序应使用 Inspector.get_foreign_keys（） 中。

方法 sqlalchemy.engine.default.DefaultDialect. get_indexes（connection： Connection， table_name： str， schema：strNone=None， **kw： Any）→ List[ReflectedIndex]¶

继承自Dialect 的 Dialect.get_indexes（） 方法

返回有关 table_name 中的索引的信息。

给定一个 Connection，一个字符串 table_name 和可选的字符串架构，则返回 index information 作为对应于 ReflectedIndex 字典。

这是一种内部方言方法。应用程序应使用 Inspector.get_indexes（） 中。

方法 sqlalchemy.engine.default.DefaultDialect. get_isolation_level（dbapi_connection： DBAPIConnection）→ Literal['SERIALIZABLE'， 'REPEATABLE READ'， 'READ COMMITTED'， 'READ UNCOMMITTED'， 'AUTOCOMMIT']¶

继承自Dialect 的 Dialect.get_isolation_level（） 方法。

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

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

请注意，这是一个 dialect 级别的方法，用作 Connection 和 发动机隔离级设施;对于大多数典型用例，应首选这些 API。

另请参阅

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

Connection.default_isolation_level - 查看默认级别

Connection.execution_options.isolation_level - 按连接隔离级别设置

create_engine.isolation_level - 根据引擎隔离级别设置

方法 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。
单独的单词应该用空格分隔，而不是下划线，例如 可重复读取。隔离级别名称在传递给方言之前会将下划线转换为空格。
在后端支持的范围内，四个标准隔离名称的名称应为 READ UNCOMMITTED， READ COMMITTED， REPEATABLE READ， SERIALIZABLE
如果 dialect 支持 autocommit 选项，则应使用隔离级别名称 AUTOCOMMIT 提供该选项。
也可能存在其他隔离模式，前提是它们以 UPPERCASE 命名并使用空格而不是下划线。

使用此功能是为了让默认方言可以检查给定的隔离级别参数有效，否则会引发 ArgumentError 的 Argument 错误。

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

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

2.0 版的新Function。

方法 sqlalchemy.engine.default.DefaultDialect. get_materialized_view_names（connection： Connection， schema：strNone=None， **kw： Any）→ List[str]¶

继承自 Dialect.get_materialized_view_names() Dialect 的方法

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

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

参数

架构¶ –

要查询的 Schema Name（如果不是默认 Schema）。

2.0 版的新Function。

方法 sqlalchemy.engine.default.DefaultDialect. get_multi_check_constraints（connection， **kw）¶

返回有关给定架构中所有表中的 check 约束的信息。

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

注意