sqlalchemy.dialects.mysql.oursql.MySQLDialect

class documentation

class MySQLDialect_oursql(MySQLDialect):

Undocumented

Class Method	`dbapi`	Undocumented
Method	`_compat_fetchall`	oursql isn't super-broken like MySQLdb, yaaay.
Method	`_compat_fetchone`	oursql isn't super-broken like MySQLdb, yaaay.
Method	`_compat_first`	Proxy a result row to smooth over MySQL-Python driver inconsistencies.
Method	`_detect_charset`	Sniff out the character set in use for connection results.
Method	`_extract_error_code`	Undocumented
Method	`_show_create_table`	Run SHOW CREATE TABLE for a `Table`.
Method	`_xa_query`	Undocumented
Method	`create_connect_args`	Build DB-API compatible connection arguments.
Method	`do_begin`	Provide an implementation of `connection.begin()`, given a DB-API connection.
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_execute`	Provide an implementation of cursor.execute(statement, parameters).
Method	`do_prepare_twophase`	Prepare a two phase transaction on the given connection.
Method	`do_rollback_twophase`	Rollback a two phase transaction on the given connection.
Method	`get_columns`	Return information about columns in `table_name`.
Method	`get_schema_names`	Undocumented
Method	`get_table_names`	Return a Unicode SHOW TABLES from a given schema.
Method	`get_table_options`	Undocumented
Method	`get_view_names`	Return a list of all view names available in the database.
Method	`has_table`	For internal dialect use, check the existence of a particular table in the database.
Method	`initialize`	Called during strategized creation of the dialect with a connection.
Method	`is_disconnect`	Return True if the given DB-API error indicates an invalid connection
Class Variable	`colspecs`	Undocumented
Class Variable	`driver`	Undocumented
Class Variable	`supports_native_decimal`	Undocumented
Class Variable	`supports_sane_multi_rowcount`	Undocumented
Class Variable	`supports_sane_rowcount`	Undocumented
Class Variable	`supports_statement_cache`	indicates if this dialect supports caching.
Class Variable	`supports_unicode_binds`	Undocumented
Class Variable	`supports_unicode_statements`	Undocumented

Inherited from MySQLDialect:

Class Method	`_is_mariadb_from_url`	Undocumented
Method	`__init__`	Undocumented
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	`_get_default_schema_name`	Return the string name of the currently selected schema from the given connection.
Method	`_get_server_version_info`	Retrieve the server version info from the given connection.
Method	`_parse_server_version`	Undocumented
Method	`_parsed_state_or_create`	Undocumented
Method	`_sequences_not_supported`	Undocumented
Method	`_set_isolation_level`	Undocumented
Method	`_set_mariadb`	Undocumented
Method	`_setup_parser`	Undocumented
Method	`_warn_for_known_db_issues`	Undocumented
Method	`do_recover_twophase`	Recover list of uncommitted prepared two phase transaction identifiers on the given connection.
Method	`get_check_constraints`	Return information about check constraints 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_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_unique_constraints`	Return information about unique constraints in `table_name`.
Method	`get_view_definition`	Return view definition.
Method	`has_sequence`	Check the existence of a particular sequence in the database.
Method	`on_connect`	return a callable which sets up a newly created DBAPI connection.
Method	`set_isolation_level`	Given a DBAPI connection, set its isolation level.
Class Variable	`_isolation_lookup`	Undocumented
Class Variable	`construct_arguments`	Optional set of argument specifiers for various SQLAlchemy constructs, typically schema items.
Class Variable	`cte_follows_insert`	Undocumented
Class Variable	`default_paramstyle`	Undocumented
Class Variable	`inline_comments`	Undocumented
Class Variable	`max_constraint_name_length`	Undocumented
Class Variable	`max_identifier_length`	Undocumented
Class Variable	`max_index_name_length`	Undocumented
Class Variable	`name`	Undocumented
Class Variable	`sequences_optional`	Undocumented
Class Variable	`supports_alter`	Undocumented
Class Variable	`supports_comments`	Undocumented
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`	Undocumented
Class Variable	`supports_native_boolean`	Undocumented
Class Variable	`supports_native_enum`	Undocumented
Instance Variable	`_backslash_escapes`	Undocumented
Instance Variable	`_casing`	Undocumented
Instance Variable	`_connection_charset`	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	`_server_ansiquotes`	Undocumented
Instance Variable	`_sql_mode`	Undocumented
Instance Variable	`identifier_preparer`	Undocumented
Instance Variable	`is_mariadb`	Undocumented
Instance Variable	`isolation_level`	Undocumented
Instance Variable	`preparer`	Undocumented
Instance Variable	`server_version_info`	Undocumented
Instance Variable	`supports_for_update_of`	Undocumented
Instance Variable	`supports_sequences`	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 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_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_no_params`	Provide an implementation of `cursor.execute(statement)`.
Method	`do_executemany`	Provide an implementation of `cursor.executemany(statement, parameters)`.
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	`get_default_isolation_level`	Given a DBAPI connection, return its isolation level, or a default isolation level if one cannot be retrieved.
Method	`get_driver_connection`	Returns the connection object as returned by the external driver package.
Method	`has_index`	Check the existence of a particular index 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	`type_descriptor`	Provide a database-specific `.TypeEngine` object, given the generic object which comes from the types module.
Class Variable	`dbapi_exception_translation_map`	mapping used in the extremely unusual case that a DBAPI's published exceptions don't actually have the __name__ that they are linked towards.
Class Variable	`supports_empty_insert`	dialect supports INSERT () VALUES ()
Instance Variable	`returns_unicode_strings`	Undocumented
Instance Variable	`type_compiler`	Undocumented
Method	`_check_max_identifier_length`	Perform a connection / server version specific check to determine the max_identifier_length.
Method	`_check_unicode_description`	Undocumented
Method	`_check_unicode_returns`	Undocumented
Method	`_ensure_has_table_connection`	Undocumented
Method	`_reset_characteristics`	Undocumented
Method	`_set_connection_characteristics`	Undocumented
Method	`do_ping`	Undocumented
Method	`get_dialect_pool_class`	Undocumented
Method	`set_connection_execution_options`	Undocumented
Method	`set_engine_execution_options`	Undocumented
Method	`validate_identifier`	Undocumented
Class Variable	`connection_characteristics`	Undocumented
Class Variable	`default_sequence_base`	Undocumented
Class Variable	`engine_config_types`	Undocumented
Class Variable	`full_returning`	Undocumented
Class Variable	`insert_executemany_returning`	Undocumented
Class Variable	`is_async`	Undocumented
Class Variable	`non_native_boolean_check_constraint`	Undocumented
Class Variable	`postfetch_lastrowid`	Undocumented
Class Variable	`preexecute_autoincrement_sequences`	Undocumented
Class Variable	`reflection_options`	Undocumented
Class Variable	`requires_name_normalize`	Undocumented
Class Variable	`server_side_cursors`	Undocumented
Class Variable	`supports_identity_columns`	Undocumented
Class Variable	`supports_is_distinct_from`	Undocumented
Class Variable	`supports_schemas`	Undocumented
Class Variable	`supports_server_side_cursors`	Undocumented
Class Variable	`supports_simple_order_by_label`	Undocumented
Class Variable	`supports_views`	Undocumented
Class Variable	`tuple_in_values`	Undocumented
Class Variable	`use_setinputsizes`	Undocumented
Instance Variable	`_decoder`	Undocumented
Instance Variable	`_description_decoder`	Undocumented
Instance Variable	`_encoder`	Undocumented
Instance Variable	`_ischema`	Undocumented
Instance Variable	`_user_defined_max_identifier_length`	Undocumented
Instance Variable	`case_sensitive`	Undocumented
Instance Variable	`compiler_linting`	Undocumented
Instance Variable	`convert_unicode`	Undocumented
Instance Variable	`default_isolation_level`	Undocumented
Instance Variable	`default_schema_name`	Undocumented
Instance Variable	`description_encoding`	Undocumented
Instance Variable	`encoding`	Undocumented
Instance Variable	`implicit_returning`	Undocumented
Instance Variable	`label_length`	Undocumented
Instance Variable	`paramstyle`	Undocumented
Instance Variable	`positional`	Undocumented
Property	`_dialect_specific_select_one`	Undocumented
Property	`_supports_statement_cache`	Undocumented
Property	`_type_memos`	Undocumented
Property	`dialect_description`	Undocumented
Property	`supports_sane_rowcount_returning`	True if this dialect supports sane rowcount even if RETURNING is in use.

Inherited from Dialect (via MySQLDialect, DefaultDialect):

Class Method	`engine_created`	A convenience hook called before returning the final `_engine.Engine`.
Class Method	`get_dialect_cls`	Given a URL, return the `.Dialect` that will be used.
Method	`do_set_input_sizes`	invoke the cursor.setinputsizes() method with appropriate arguments
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	`_has_events`	Undocumented

@classmethod
def dbapi(cls):

overrides sqlalchemy.engine.default.DefaultDialect.dbapi

Undocumented

def _compat_fetchall(self, rp, charset=None):

overrides sqlalchemy.databases.mysql.MySQLDialect._compat_fetchall

oursql isn't super-broken like MySQLdb, yaaay.

def _compat_fetchone(self, rp, charset=None):

overrides sqlalchemy.databases.mysql.MySQLDialect._compat_fetchone

oursql isn't super-broken like MySQLdb, yaaay.

def _compat_first(self, rp, charset=None):

overrides sqlalchemy.databases.mysql.MySQLDialect._compat_first

Proxy a result row to smooth over MySQL-Python driver inconsistencies.

def _detect_charset(self, connection):

overrides sqlalchemy.databases.mysql.MySQLDialect._detect_charset

Sniff out the character set in use for connection results.

def _extract_error_code(self, exception):

overrides sqlalchemy.databases.mysql.MySQLDialect._extract_error_code

Undocumented

def _show_create_table(self, connection, table, charset=None, full_name=None):

overrides sqlalchemy.databases.mysql.MySQLDialect._show_create_table

Run SHOW CREATE TABLE for a Table.

def _xa_query(self, connection, query, xid):

Undocumented

def create_connect_args(self, url):

overrides sqlalchemy.engine.default.DefaultDialect.create_connect_args

Build DB-API compatible connection arguments.

Given a .URL object, returns a tuple consisting of a (*args, **kwargs) suitable to send directly to the dbapi's connect function. The arguments are sent to the .Dialect.connect method which then runs the DBAPI-level connect() function.

The method typically makes use of the .URL.translate_connect_args method in order to generate a dictionary of options.

The default implementation is:

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

See Also

.URL.translate_connect_args

Parameters
url	a `.URL` object
Returns
a tuple of `(args, *kwargs)` which will be passed to the `.Dialect.connect` method.

def do_begin(self, connection):

overrides sqlalchemy.engine.default.DefaultDialect.do_begin

Provide an implementation of connection.begin(), given a DB-API connection.

The DBAPI has no dedicated "begin" method and it is expected that transactions are implicit. This hook is provided for those DBAPIs that might need additional help in this area.

Note that .Dialect.do_begin is not called unless a .Transaction object is in use. The .Dialect.do_autocommit hook is provided for DBAPIs that need some extra commands emitted after a commit in order to enter the next transaction, when the SQLAlchemy _engine.Connection is used in its default "autocommit" mode.

Parameters
connection	Undocumented
dbapi_connection	a DBAPI connection, typically proxied within a `.ConnectionFairy`.

def do_begin_twophase(self, connection, xid):

overrides sqlalchemy.databases.mysql.MySQLDialect.do_begin_twophase

Begin a two phase transaction on the given connection.

Parameters
connection	a `_engine.Connection`.
xid	xid

def do_commit_twophase(self, connection, xid, is_prepared=True, recover=False):

overrides sqlalchemy.databases.mysql.MySQLDialect.do_commit_twophase

Commit a two phase transaction on the given connection.

Parameters
connection	a `_engine.Connection`.
xid	xid
is_prepared	whether or not `.TwoPhaseTransaction.prepare` was called.
recover	if the recover flag was passed.

def do_execute(self, cursor, statement, parameters, context=None):

overrides sqlalchemy.engine.default.DefaultDialect.do_execute

Provide an implementation of cursor.execute(statement, parameters).

def do_prepare_twophase(self, connection, xid):

overrides sqlalchemy.databases.mysql.MySQLDialect.do_prepare_twophase

Prepare a two phase transaction on the given connection.

Parameters
connection	a `_engine.Connection`.
xid	xid

def do_rollback_twophase(self, connection, xid, is_prepared=True, recover=False):

overrides sqlalchemy.databases.mysql.MySQLDialect.do_rollback_twophase

Rollback a two phase transaction on the given connection.

Parameters
connection	a `_engine.Connection`.
xid	xid
is_prepared	whether or not `.TwoPhaseTransaction.prepare` was called.
recover	if the recover flag was passed.

def get_columns(self, connection, table_name, schema=None, **kw):

overrides sqlalchemy.databases.mysql.MySQLDialect.get_columns

Return information about columns in table_name.

Given a _engine.Connection, a string table_name, and an optional string schema, return column information as a list of dictionaries with these keys:

name

the column's name

type

[sqlalchemy.types#TypeEngine]

nullable

boolean

default

the column's default value

autoincrement

boolean

sequence

a dictionary of the form

{'name' : str, 'start' :int, 'increment': int, 'minvalue': int,: 'maxvalue': int, 'nominvalue': bool, 'nomaxvalue': bool, 'cycle': bool, 'cache': int, 'order': bool}

Additional column attributes may be present.

def get_schema_names(self, connection, **kw):

overrides sqlalchemy.databases.mysql.MySQLDialect.get_schema_names

Undocumented

def get_table_names(self, connection, schema=None, **kw):

overrides sqlalchemy.databases.mysql.MySQLDialect.get_table_names

Return a Unicode SHOW TABLES from a given schema.

def get_table_options(self, connection, table_name, schema=None, **kw):

overrides sqlalchemy.databases.mysql.MySQLDialect.get_table_options

Undocumented

def get_view_names(self, connection, schema=None, **kw):

overrides sqlalchemy.databases.mysql.MySQLDialect.get_view_names

Return a list of all view names available in the database.

Parameters
connection	Undocumented
schema	schema name to query, if not the default schema.
**kw	Undocumented

def has_table(self, connection, table_name, schema=None):

overrides sqlalchemy.databases.mysql.MySQLDialect.has_table

For internal dialect use, check the existence of a particular table in the database.

Given a _engine.Connection object, a string table_name and optional schema name, return True if the given table exists in the database, False otherwise.

This method serves as the underlying implementation of the public facing .Inspector.has_table method, and is also used internally to implement the "checkfirst" behavior for methods like _schema.Table.create and _schema.MetaData.create_all.

Note

This method is used internally by SQLAlchemy, and is published so that third-party dialects may provide an implementation. It is not the public API for checking for table presence. Please use the .Inspector.has_table method. Alternatively, for legacy cross-compatibility, the _engine.Engine.has_table method may be used.

def initialize(self, connection):

overrides sqlalchemy.databases.mysql.MySQLDialect.initialize

Called during strategized creation of the dialect with a connection.

Allows dialects to configure options based on server version info or other properties.

The connection passed here is a SQLAlchemy Connection object, with full capabilities.

The initialize() method of the base dialect should be called via super().

Note

as of SQLAlchemy 1.4, this method is called before any _engine.Dialect.on_connect hooks are called.

def is_disconnect(self, e, connection, cursor):

overrides sqlalchemy.databases.mysql.MySQLDialect.is_disconnect

Return True if the given DB-API error indicates an invalid connection

colspecs =

overrides sqlalchemy.engine.default.DefaultDialect.colspecs

Undocumented

driver: str =

Undocumented

supports_native_decimal: bool =

overrides sqlalchemy.engine.default.DefaultDialect.supports_native_decimal

Undocumented

supports_sane_multi_rowcount: bool =

overrides sqlalchemy.databases.mysql.MySQLDialect.supports_sane_multi_rowcount

Undocumented

supports_sane_rowcount: bool =

overrides sqlalchemy.databases.mysql.MySQLDialect.supports_sane_rowcount

Undocumented

supports_statement_cache: bool =

overrides sqlalchemy.databases.mysql.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.

New in version 1.4.5.

sqlalchemy.dialects.mysql.oursql.MySQLDialect_oursql

`sqlalchemy.dialects.mysql.oursql.MySQLDialect_oursql`