sqlalchemy.dialects.mysql.pyodbc.MySQLDialect_pyodbc

class documentation

class MySQLDialect_pyodbc(PyODBCConnector, MySQLDialect): (source)

View In Hierarchy

Undocumented

Method on_connect return a callable which sets up a newly created DBAPI connection.
Class Variable colspecs A dictionary of TypeEngine classes from sqlalchemy.types mapped to subclasses that are specific to the dialect class. This dictionary is class-level only and is not accessed from the dialect instance itself.
Class Variable pyodbc_driver_name Undocumented
Class Variable supports_statement_cache indicates if this dialect supports caching.
Class Variable supports_unicode_statements Undocumented
Method _detect_charset Sniff out the character set in use for connection results.
Method _extract_error_code Undocumented
Method _get_server_version_info Retrieve the server version info from the given connection.
Instance Variable _connection_charset Undocumented

Inherited from PyODBCConnector:

Class Method import_dbapi Import the DBAPI module that is used by this dialect.
Method __init__ Undocumented
Method create_connect_args Build DB-API compatible connection arguments.
Method do_set_input_sizes invoke the cursor.setinputsizes() method with appropriate arguments
Method get_isolation_level_values return a sequence of string isolation level names that are accepted by this dialect.
Method is_disconnect Return True if the given DB-API error indicates an invalid connection
Method set_isolation_level Given a DBAPI connection, set its isolation level.
Class Variable dbapi A reference to the DBAPI module object itself.
Class Variable default_paramstyle Undocumented
Class Variable driver identifying name for the dialect's DBAPI
Class Variable fast_executemany Undocumented
Class Variable supports_native_decimal indicates if Decimal objects are handled and returned for precision numeric types, or if floats are returned
Class Variable supports_sane_multi_rowcount Indicate whether the dialect properly implements rowcount for ``UPDATE`` and ``DELETE`` statements when executed via executemany.
Class Variable supports_sane_rowcount_returning Undocumented
Instance Variable bind_typing Undocumented
Method _dbapi_version Undocumented
Method _parse_dbapi_version Undocumented

Inherited from MySQLDialect (via PyODBCConnector, Connector):

Method do_begin_twophase Begin a two phase transaction on the given connection.
Method do_commit_twophase Commit a two phase transaction on the given connection.
Method do_prepare_twophase Prepare a two phase transaction on the given connection.
Method do_recover_twophase Recover list of uncommitted prepared two phase transaction identifiers on the given connection.
Method do_rollback_twophase Rollback a two phase transaction on the given connection.
Method get_check_constraints Return information about check constraints in ``table_name``.
Method get_columns Return information about columns in ``table_name``.
Method get_foreign_keys Return information about foreign_keys in ``table_name``.
Method get_indexes Return information about indexes in ``table_name``.
Method get_isolation_level Given a DBAPI connection, return its isolation level.
Method get_pk_constraint Return information about the primary key constraint on table_name`.
Method get_schema_names Return a list of all schema names available in the database.
Method get_sequence_names Return a list of all sequence names available in the database.
Method get_table_comment Return the "comment" for the table identified by ``table_name``.
Method get_table_names Return a Unicode SHOW TABLES from a given schema.
Method get_table_options Return a dictionary of options specified when ``table_name`` was created.
Method get_unique_constraints Return information about unique constraints in ``table_name``.
Method get_view_definition Return plain or materialized view definition.
Method get_view_names Return a list of all non-materialized view names available in the database.
Method has_sequence Check the existence of a particular sequence in the database.
Method has_table For internal dialect use, check the existence of a particular table or view in the database.
Method initialize Called during strategized creation of the dialect with a connection.
Class Variable construct_arguments Optional set of argument specifiers for various SQLAlchemy constructs, typically schema items.
Class Variable cte_follows_insert target database, when given a CTE with an INSERT statement, needs the CTE to be below the INSERT
Class Variable div_is_floordiv target database treats the / division operator as "floor division"
Class Variable inline_comments Indicates the dialect supports comment DDL that's inline with the definition of a Table or Column. If False, this implies that ALTER must be used to set table and column comments.
Class Variable insert_null_pk_still_autoincrements Undocumented
Class Variable max_constraint_name_length Undocumented
Class Variable max_identifier_length The maximum length of identifier names.
Class Variable max_index_name_length Undocumented
Class Variable name identifying name for the dialect from a DBAPI-neutral point of view (i.e. 'sqlite')
Class Variable sequences_optional If True, indicates if the :paramref:`_schema.Sequence.optional` parameter on the :class:`_schema.Sequence` construct should signal to not generate a CREATE SEQUENCE. Applies only to dialects that support sequences...
Class Variable supports_alter ``True`` if the database supports ``ALTER TABLE`` - used only for generating foreign key constraints in certain circumstances
Class Variable supports_comments Indicates the dialect supports comment DDL on tables and columns.
Class Variable supports_default_metavalue dialect supports INSERT... VALUES (DEFAULT) syntax
Class Variable supports_default_values dialect supports INSERT... DEFAULT VALUES syntax
Class Variable supports_multivalues_insert Target database supports INSERT...VALUES with multiple value sets, i.e. INSERT INTO table (cols) VALUES (...), (...), (...), ...
Class Variable supports_native_boolean Indicates if the dialect supports a native boolean construct. This will prevent :class:`_types.Boolean` from generating a CHECK constraint when that type is used.
Class Variable supports_native_enum Indicates if the dialect supports a native ENUM construct. This will prevent :class:`_types.Enum` from generating a CHECK constraint when that type is used in "native" mode.
Class Variable supports_sane_rowcount Indicate whether the dialect properly implements rowcount for ``UPDATE`` and ``DELETE`` statements.
Class Variable use_insertmanyvalues if True, indicates "insertmanyvalues" functionality should be used to allow for ``insert_executemany_returning`` behavior, if possible.
Instance Variable delete_returning if the dialect supports RETURNING with DELETE
Instance Variable identifier_preparer This element will refer to an instance of :class:`.IdentifierPreparer` once a :class:`.DefaultDialect` has been constructed.
Instance Variable insert_returning if the dialect supports RETURNING with INSERT
Instance Variable is_mariadb Undocumented
Instance Variable preparer a :class:`.IdentifierPreparer` class used to quote identifiers.
Instance Variable server_version_info a tuple containing a version number for the DB backend in use.
Instance Variable supports_for_update_of Undocumented
Instance Variable supports_sequences Indicates if the dialect supports CREATE SEQUENCE or similar.
Class Method _is_mariadb_from_url Undocumented
Method _compat_fetchall Proxy result rows to smooth over MySQL-Python driver inconsistencies.
Method _compat_fetchone Proxy a result row to smooth over MySQL-Python driver inconsistencies.
Method _compat_first Proxy a result row to smooth over MySQL-Python driver inconsistencies.
Method _correct_for_mysql_bugs_88718_96365 Undocumented
Method _describe_table Run DESCRIBE for a ``Table`` and return processed rows.
Method _detect_ansiquotes Detect and adjust for the ANSI_QUOTES sql mode.
Method _detect_casing Sniff out identifier case sensitivity.
Method _detect_collations Pull the active COLLATIONS list from the server.
Method _detect_sql_mode Undocumented
Method _fetch_setting Undocumented
Method _get_default_schema_name Return the string name of the currently selected schema from the given connection.
Method _parse_server_version Undocumented
Method _parsed_state_or_create Undocumented
Method _sequences_not_supported Undocumented
Method _set_mariadb Undocumented
Method _setup_parser Undocumented
Method _show_create_table Run SHOW CREATE TABLE for a ``Table``.
Method _warn_for_known_db_issues Undocumented
Instance Variable _backslash_escapes Undocumented
Instance Variable _casing Undocumented
Instance Variable _json_deserializer Undocumented
Instance Variable _json_serializer Undocumented
Instance Variable _mariadb_normalized_version_info Undocumented
Instance Variable _needs_correct_for_88718_96365 Undocumented
Instance Variable _requires_alias_for_on_duplicate_key Undocumented
Instance Variable _server_ansiquotes Undocumented
Instance Variable _sql_mode Undocumented
Property _is_mariadb Undocumented
Property _is_mariadb_102 Undocumented
Property _is_mysql Undocumented
Property _support_float_cast Undocumented
Property _tabledef_parser return the MySQLTableDefinitionParser, generate if needed.

Inherited from DefaultDialect (via PyODBCConnector, Connector, MySQLDialect):

Class Method get_pool_class Undocumented
Class Method load_provisioning set up the provision.py module for this dialect.
Method connect Establish a connection using this dialect's DBAPI.
Method create_xid Create a random two-phase transaction ID.
Method denormalize_name convert the given name to a case insensitive identifier for the backend if it is an all-lowercase name.
Method do_begin Provide an implementation of ``connection.begin()``, given a DB-API connection.
Method do_close Provide an implementation of ``connection.close()``, given a DBAPI connection.
Method do_commit Provide an implementation of ``connection.commit()``, given a DB-API connection.
Method do_execute Provide an implementation of ``cursor.execute(statement, parameters)``.
Method do_execute_no_params Provide an implementation of ``cursor.execute(statement)``.
Method do_executemany Provide an implementation of ``cursor.executemany(statement, parameters)``.
Method do_ping ping the DBAPI connection and return True if the connection is usable.
Method do_release_savepoint Release the named savepoint on a connection.
Method do_rollback Provide an implementation of ``connection.rollback()``, given a DB-API connection.
Method do_rollback_to_savepoint Rollback a connection to the named savepoint.
Method do_savepoint Create a savepoint with the given name.
Method do_terminate Provide an implementation of ``connection.close()`` that tries as much as possible to not block, given a DBAPI connection.
Method get_default_isolation_level Given a DBAPI connection, return its isolation level, or a default isolation level if one cannot be retrieved.
Method get_dialect_pool_class return a Pool class to use for a given URL
Method get_driver_connection Returns the connection object as returned by the external driver package.
Method get_multi_check_constraints Return information about check constraints in all tables in the given ``schema``.
Method get_multi_columns Return information about columns in all tables in the given ``schema``.
Method get_multi_foreign_keys Return information about foreign_keys in all tables in the given ``schema``.
Method get_multi_indexes Return information about indexes in in all tables in the given ``schema``.
Method get_multi_pk_constraint Return information about primary key constraints in all tables in the given ``schema``.
Method get_multi_table_comment Return information about the table comment in all tables in the given ``schema``.
Method get_multi_table_options Return a dictionary of options specified when the tables in the given schema were created.
Method get_multi_unique_constraints Return information about unique constraints in all tables in the given ``schema``.
Method has_index Check the existence of a particular index name in the database.
Method has_schema Check the existence of a particular schema name in the database.
Method normalize_name convert the given name to lowercase if it is detected as case insensitive.
Method reset_isolation_level Given a DBAPI connection, revert its isolation to the default.
Method set_connection_execution_options Establish execution options for a given connection.
Method set_engine_execution_options Establish execution options for a given engine.
Method type_descriptor Provide a database-specific :class:`.TypeEngine` object, given the generic object which comes from the types module.
Method validate_identifier Undocumented
Class Variable connection_characteristics Undocumented
Class Variable default_metavalue_token for INSERT... VALUES (DEFAULT) syntax, the token to put in the parenthesis.
Class Variable default_sequence_base the default value that will be rendered as the "START WITH" portion of a CREATE SEQUENCE DDL statement.
Class Variable delete_executemany_returning dialect supports DELETE..RETURNING with executemany.
Class Variable delete_returning_multifrom if the dialect supports RETURNING with DELETE..FROM
Class Variable engine_config_types a mapping of string keys that can be in an engine config linked to type conversion functions.
Class Variable exclude_set_input_sizes set of DBAPI type objects that should be excluded in automatic cursor.setinputsizes() calls.
Class Variable favor_returning_over_lastrowid for backends that support both a lastrowid and a RETURNING insert strategy, favor RETURNING for simple single-int pk inserts.
Class Variable has_terminate Whether or not this dialect has a separate "terminate" implementation that does not block or require awaiting.
Class Variable include_set_input_sizes set of DBAPI type objects that should be included in automatic cursor.setinputsizes() calls.
Class Variable insertmanyvalues_max_parameters Alternate to insertmanyvalues_page_size, will additionally limit page size based on number of parameters total in the statement.
Class Variable is_async Whether or not this dialect is intended for asyncio use.
Class Variable isolation_level Undocumented
Class Variable non_native_boolean_check_constraint Undocumented
Class Variable postfetch_lastrowid Undocumented
Class Variable preexecute_autoincrement_sequences True if 'implicit' primary key functions must be executed separately in order to get their value, if RETURNING is not used.
Class Variable requires_name_normalize Undocumented
Class Variable server_side_cursors deprecated; indicates if the dialect should attempt to use server side cursors by default
Class Variable supports_constraint_comments Indicates if the dialect supports comment DDL on constraints.
Class Variable supports_empty_insert dialect supports INSERT () VALUES ()
Class Variable supports_identity_columns target database supports IDENTITY
Class Variable supports_is_distinct_from Undocumented
Class Variable supports_native_uuid indicates if Python UUID() objects are handled natively by the driver for SQL UUID datatypes.
Class Variable supports_schemas Undocumented
Class Variable supports_server_side_cursors indicates if the dialect supports server side cursors
Class Variable supports_simple_order_by_label target database supports ORDER BY <labelname>, where <labelname> refers to a label in the columns clause of the SELECT
Class Variable supports_views Undocumented
Class Variable tuple_in_values target database supports tuple IN, i.e. (x, y) IN ((q, p), (r, z))
Class Variable update_executemany_returning dialect supports UPDATE..RETURNING with executemany.
Class Variable update_returning if the dialect supports RETURNING with UPDATE
Class Variable update_returning_multifrom if the dialect supports RETURNING with UPDATE..FROM
Class Variable use_insertmanyvalues_wo_returning if True, and use_insertmanyvalues is also True, INSERT statements that don't include RETURNING will also use "insertmanyvalues".
Instance Variable compiler_linting Undocumented
Instance Variable default_isolation_level the isolation that is implicitly present on new connections
Instance Variable default_schema_name the name of the default schema. This value is only available for supporting dialects, and is typically populated during the initial connection to the database.
Instance Variable insertmanyvalues_page_size Number of rows to render into an individual INSERT..VALUES() statement for :attr:`.ExecuteStyle.INSERTMANYVALUES` executions.
Instance Variable label_length optional user-defined max length for SQL labels
Instance Variable paramstyle the paramstyle to be used (some DB-APIs support multiple paramstyles).
Instance Variable positional True if the paramstyle for this Dialect is positional.
Instance Variable type_compiler legacy; this is a TypeCompiler class at the class level, a TypeCompiler instance at the instance level.
Instance Variable type_compiler_instance instance of a :class:`.Compiled` class used to compile SQL type objects
Property dialect_description Undocumented
Property full_returning Undocumented
Property insert_executemany_returning dialect / driver / database supports some means of providing INSERT...RETURNING support when dialect.do_executemany() is used.
Property loaded_dbapi same as .dbapi, but is never None; will raise an error if no DBAPI was set up.
Method _assert_and_set_isolation_level Undocumented
Method _builtin_onconnect Undocumented
Method _check_max_identifier_length Perform a connection / server version specific check to determine the max_identifier_length.
Method _default_multi_reflect Undocumented
Method _deliver_insertmanyvalues_batches convert executemany parameters for an INSERT into an iterator of statement/single execute values, used by the insertmanyvalues feature.
Method _do_ping_w_event Undocumented
Method _ensure_has_table_connection Undocumented
Method _gen_allowed_isolation_levels Undocumented
Method _overrides_default Undocumented
Method _reset_characteristics Undocumented
Method _set_connection_characteristics Undocumented
Class Variable _legacy_binary_type_literal_encoding Undocumented
Instance Variable _ischema Undocumented
Instance Variable _on_connect_isolation_level Undocumented
Instance Variable _user_defined_max_identifier_length Undocumented
Property _bind_typing_render_casts Undocumented
Property _dialect_specific_select_one Undocumented
Property _supports_statement_cache internal evaluation for supports_statement_cache
Property _type_memos Undocumented

Inherited from Dialect (via PyODBCConnector, Connector, MySQLDialect, DefaultDialect):

Class Method engine_created A convenience hook called before returning the final :class:`_engine.Engine`.
Class Method get_async_dialect_cls Given a URL, return the :class:`.Dialect` that will be used by an async engine.
Class Method get_dialect_cls Given a URL, return the :class:`.Dialect` that will be used.
Method get_materialized_view_names Return a list of all materialized view names available in the database.
Method get_temp_table_names Return a list of temporary table names on the given connection, if supported by the underlying backend.
Method get_temp_view_names Return a list of temporary view names on the given connection, if supported by the underlying backend.
Method on_connect_url return a callable which sets up a newly created DBAPI connection.
Class Variable ddl_compiler a :class:`.Compiled` class used to compile DDL statements
Class Variable dispatch Undocumented
Class Variable execute_sequence_format either the 'tuple' or 'list' type, depending on what cursor.execute() accepts for the second argument (they vary).
Class Variable execution_ctx_cls a :class:`.ExecutionContext` class used to handle statement execution
Class Variable reflection_options Sequence of string names indicating keyword arguments that can be established on a :class:`.Table` object which will be passed as "reflection options" when using :paramref:`.Table.autoload_with`.
Class Variable statement_compiler a :class:`.Compiled` class used to compile SQL statements
Class Variable type_compiler_cls a :class:`.Compiled` class used to compile SQL type objects
Class Variable _has_events Undocumented
def on_connect(self): (source)
overrides sqlalchemy.engine.default.DefaultDialect.on_connect

return a callable which sets up a newly created DBAPI connection. The callable should accept a single argument "conn" which is the DBAPI connection itself. The inner callable has no return value. E.g.:: class MyDialect(default.DefaultDialect): # ... def on_connect(self): def do_on_connect(connection): connection.execute("SET SPECIAL FLAGS etc") return do_on_connect This is used to set dialect-wide per-connection options such as isolation modes, Unicode modes, etc. The "do_on_connect" callable is invoked by using the :meth:`_events.PoolEvents.connect` event hook, then unwrapping the DBAPI connection and passing it into the callable. .. versionchanged:: 1.4 the on_connect hook is no longer called twice for the first connection of a dialect. The on_connect hook is still called before the :meth:`_engine.Dialect.initialize` method however. .. versionchanged:: 1.4.3 the on_connect hook is invoked from a new method on_connect_url that passes the URL that was used to create the connect args. Dialects can implement on_connect_url instead of on_connect if they need the URL object that was used for the connection in order to get additional context. If None is returned, no event listener is generated. :return: a callable that accepts a single DBAPI connection as an argument, or None. .. seealso:: :meth:`.Dialect.connect` - allows the DBAPI ``connect()`` sequence itself to be controlled. :meth:`.Dialect.on_connect_url` - supersedes :meth:`.Dialect.on_connect` to also receive the :class:`_engine.URL` object in context.

colspecs = (source)
overrides sqlalchemy.engine.default.DefaultDialect.colspecs

A dictionary of TypeEngine classes from sqlalchemy.types mapped to subclasses that are specific to the dialect class. This dictionary is class-level only and is not accessed from the dialect instance itself.

pyodbc_driver_name: str = (source)
overrides sqlalchemy.connectors.pyodbc.PyODBCConnector.pyodbc_driver_name

Undocumented

supports_statement_cache: bool = (source)
overrides sqlalchemy.dialects.mysql.base.MySQLDialect.supports_statement_cache

indicates if this dialect supports caching. All dialects that are compatible with statement caching should set this flag to True directly on each dialect class and subclass that supports it. SQLAlchemy tests that this flag is locally present on each dialect subclass before it will use statement caching. This is to provide safety for legacy or new dialects that are not yet fully tested to be compliant with SQL statement caching. .. versionadded:: 1.4.5 .. seealso:: :ref:`engine_thirdparty_caching`

supports_unicode_statements: bool = (source)

Undocumented

def _detect_charset(self, connection): (source)
overrides sqlalchemy.dialects.mysql.base.MySQLDialect._detect_charset

Sniff out the character set in use for connection results.

def _extract_error_code(self, exception): (source)
overrides sqlalchemy.dialects.mysql.base.MySQLDialect._extract_error_code

Undocumented

def _get_server_version_info(self, connection): (source)
overrides sqlalchemy.connectors.pyodbc.PyODBCConnector._get_server_version_info

Retrieve the server version info from the given connection. This is used by the default implementation to populate the "server_version_info" attribute and is called exactly once upon first connect.

_connection_charset = (source)
overrides sqlalchemy.dialects.mysql.base.MySQLDialect._connection_charset

Undocumented