You can not select more than 25 topics
			Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
		
		
		
		
		
			
		
			
				
					241 lines
				
				7.5 KiB
			
		
		
			
		
	
	
					241 lines
				
				7.5 KiB
			| 
								 
											3 years ago
										 
									 | 
							
								# mysql/mysqlconnector.py
							 | 
						||
| 
								 | 
							
								# Copyright (C) 2005-2022 the SQLAlchemy authors and contributors
							 | 
						||
| 
								 | 
							
								# <see AUTHORS file>
							 | 
						||
| 
								 | 
							
								#
							 | 
						||
| 
								 | 
							
								# This module is part of SQLAlchemy and is released under
							 | 
						||
| 
								 | 
							
								# the MIT License: https://www.opensource.org/licenses/mit-license.php
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								r"""
							 | 
						||
| 
								 | 
							
								.. dialect:: mysql+mysqlconnector
							 | 
						||
| 
								 | 
							
								    :name: MySQL Connector/Python
							 | 
						||
| 
								 | 
							
								    :dbapi: myconnpy
							 | 
						||
| 
								 | 
							
								    :connectstring: mysql+mysqlconnector://<user>:<password>@<host>[:<port>]/<dbname>
							 | 
						||
| 
								 | 
							
								    :url: https://pypi.org/project/mysql-connector-python/
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								.. note::
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								    The MySQL Connector/Python DBAPI has had many issues since its release,
							 | 
						||
| 
								 | 
							
								    some of which may remain unresolved, and the mysqlconnector dialect is
							 | 
						||
| 
								 | 
							
								    **not tested as part of SQLAlchemy's continuous integration**.
							 | 
						||
| 
								 | 
							
								    The recommended MySQL dialects are mysqlclient and PyMySQL.
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								"""  # noqa
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								import re
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								from .base import BIT
							 | 
						||
| 
								 | 
							
								from .base import MySQLCompiler
							 | 
						||
| 
								 | 
							
								from .base import MySQLDialect
							 | 
						||
| 
								 | 
							
								from .base import MySQLIdentifierPreparer
							 | 
						||
| 
								 | 
							
								from ... import processors
							 | 
						||
| 
								 | 
							
								from ... import util
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								class MySQLCompiler_mysqlconnector(MySQLCompiler):
							 | 
						||
| 
								 | 
							
								    def visit_mod_binary(self, binary, operator, **kw):
							 | 
						||
| 
								 | 
							
								        if self.dialect._mysqlconnector_double_percents:
							 | 
						||
| 
								 | 
							
								            return (
							 | 
						||
| 
								 | 
							
								                self.process(binary.left, **kw)
							 | 
						||
| 
								 | 
							
								                + " %% "
							 | 
						||
| 
								 | 
							
								                + self.process(binary.right, **kw)
							 | 
						||
| 
								 | 
							
								            )
							 | 
						||
| 
								 | 
							
								        else:
							 | 
						||
| 
								 | 
							
								            return (
							 | 
						||
| 
								 | 
							
								                self.process(binary.left, **kw)
							 | 
						||
| 
								 | 
							
								                + " % "
							 | 
						||
| 
								 | 
							
								                + self.process(binary.right, **kw)
							 | 
						||
| 
								 | 
							
								            )
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								    def post_process_text(self, text):
							 | 
						||
| 
								 | 
							
								        if self.dialect._mysqlconnector_double_percents:
							 | 
						||
| 
								 | 
							
								            return text.replace("%", "%%")
							 | 
						||
| 
								 | 
							
								        else:
							 | 
						||
| 
								 | 
							
								            return text
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								    def escape_literal_column(self, text):
							 | 
						||
| 
								 | 
							
								        if self.dialect._mysqlconnector_double_percents:
							 | 
						||
| 
								 | 
							
								            return text.replace("%", "%%")
							 | 
						||
| 
								 | 
							
								        else:
							 | 
						||
| 
								 | 
							
								            return text
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								class MySQLIdentifierPreparer_mysqlconnector(MySQLIdentifierPreparer):
							 | 
						||
| 
								 | 
							
								    @property
							 | 
						||
| 
								 | 
							
								    def _double_percents(self):
							 | 
						||
| 
								 | 
							
								        return self.dialect._mysqlconnector_double_percents
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								    @_double_percents.setter
							 | 
						||
| 
								 | 
							
								    def _double_percents(self, value):
							 | 
						||
| 
								 | 
							
								        pass
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								    def _escape_identifier(self, value):
							 | 
						||
| 
								 | 
							
								        value = value.replace(self.escape_quote, self.escape_to_quote)
							 | 
						||
| 
								 | 
							
								        if self.dialect._mysqlconnector_double_percents:
							 | 
						||
| 
								 | 
							
								            return value.replace("%", "%%")
							 | 
						||
| 
								 | 
							
								        else:
							 | 
						||
| 
								 | 
							
								            return value
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								class _myconnpyBIT(BIT):
							 | 
						||
| 
								 | 
							
								    def result_processor(self, dialect, coltype):
							 | 
						||
| 
								 | 
							
								        """MySQL-connector already converts mysql bits, so."""
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								        return None
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								class MySQLDialect_mysqlconnector(MySQLDialect):
							 | 
						||
| 
								 | 
							
								    driver = "mysqlconnector"
							 | 
						||
| 
								 | 
							
								    supports_statement_cache = True
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								    supports_unicode_binds = True
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								    supports_sane_rowcount = True
							 | 
						||
| 
								 | 
							
								    supports_sane_multi_rowcount = True
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								    supports_native_decimal = True
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								    default_paramstyle = "format"
							 | 
						||
| 
								 | 
							
								    statement_compiler = MySQLCompiler_mysqlconnector
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								    preparer = MySQLIdentifierPreparer_mysqlconnector
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								    colspecs = util.update_copy(MySQLDialect.colspecs, {BIT: _myconnpyBIT})
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								    def __init__(self, *arg, **kw):
							 | 
						||
| 
								 | 
							
								        super(MySQLDialect_mysqlconnector, self).__init__(*arg, **kw)
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								        # hack description encoding since mysqlconnector randomly
							 | 
						||
| 
								 | 
							
								        # returns bytes or not
							 | 
						||
| 
								 | 
							
								        self._description_decoder = (
							 | 
						||
| 
								 | 
							
								            processors.to_conditional_unicode_processor_factory
							 | 
						||
| 
								 | 
							
								        )(self.description_encoding)
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								    def _check_unicode_description(self, connection):
							 | 
						||
| 
								 | 
							
								        # hack description encoding since mysqlconnector randomly
							 | 
						||
| 
								 | 
							
								        # returns bytes or not
							 | 
						||
| 
								 | 
							
								        return False
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								    @property
							 | 
						||
| 
								 | 
							
								    def description_encoding(self):
							 | 
						||
| 
								 | 
							
								        # total guess
							 | 
						||
| 
								 | 
							
								        return "latin-1"
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								    @util.memoized_property
							 | 
						||
| 
								 | 
							
								    def supports_unicode_statements(self):
							 | 
						||
| 
								 | 
							
								        return util.py3k or self._mysqlconnector_version_info > (2, 0)
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								    @classmethod
							 | 
						||
| 
								 | 
							
								    def dbapi(cls):
							 | 
						||
| 
								 | 
							
								        from mysql import connector
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								        return connector
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								    def do_ping(self, dbapi_connection):
							 | 
						||
| 
								 | 
							
								        try:
							 | 
						||
| 
								 | 
							
								            dbapi_connection.ping(False)
							 | 
						||
| 
								 | 
							
								        except self.dbapi.Error as err:
							 | 
						||
| 
								 | 
							
								            if self.is_disconnect(err, dbapi_connection, None):
							 | 
						||
| 
								 | 
							
								                return False
							 | 
						||
| 
								 | 
							
								            else:
							 | 
						||
| 
								 | 
							
								                raise
							 | 
						||
| 
								 | 
							
								        else:
							 | 
						||
| 
								 | 
							
								            return True
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								    def create_connect_args(self, url):
							 | 
						||
| 
								 | 
							
								        opts = url.translate_connect_args(username="user")
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								        opts.update(url.query)
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								        util.coerce_kw_type(opts, "allow_local_infile", bool)
							 | 
						||
| 
								 | 
							
								        util.coerce_kw_type(opts, "autocommit", bool)
							 | 
						||
| 
								 | 
							
								        util.coerce_kw_type(opts, "buffered", bool)
							 | 
						||
| 
								 | 
							
								        util.coerce_kw_type(opts, "compress", bool)
							 | 
						||
| 
								 | 
							
								        util.coerce_kw_type(opts, "connection_timeout", int)
							 | 
						||
| 
								 | 
							
								        util.coerce_kw_type(opts, "connect_timeout", int)
							 | 
						||
| 
								 | 
							
								        util.coerce_kw_type(opts, "consume_results", bool)
							 | 
						||
| 
								 | 
							
								        util.coerce_kw_type(opts, "force_ipv6", bool)
							 | 
						||
| 
								 | 
							
								        util.coerce_kw_type(opts, "get_warnings", bool)
							 | 
						||
| 
								 | 
							
								        util.coerce_kw_type(opts, "pool_reset_session", bool)
							 | 
						||
| 
								 | 
							
								        util.coerce_kw_type(opts, "pool_size", int)
							 | 
						||
| 
								 | 
							
								        util.coerce_kw_type(opts, "raise_on_warnings", bool)
							 | 
						||
| 
								 | 
							
								        util.coerce_kw_type(opts, "raw", bool)
							 | 
						||
| 
								 | 
							
								        util.coerce_kw_type(opts, "ssl_verify_cert", bool)
							 | 
						||
| 
								 | 
							
								        util.coerce_kw_type(opts, "use_pure", bool)
							 | 
						||
| 
								 | 
							
								        util.coerce_kw_type(opts, "use_unicode", bool)
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								        # unfortunately, MySQL/connector python refuses to release a
							 | 
						||
| 
								 | 
							
								        # cursor without reading fully, so non-buffered isn't an option
							 | 
						||
| 
								 | 
							
								        opts.setdefault("buffered", True)
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								        # FOUND_ROWS must be set in ClientFlag to enable
							 | 
						||
| 
								 | 
							
								        # supports_sane_rowcount.
							 | 
						||
| 
								 | 
							
								        if self.dbapi is not None:
							 | 
						||
| 
								 | 
							
								            try:
							 | 
						||
| 
								 | 
							
								                from mysql.connector.constants import ClientFlag
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								                client_flags = opts.get(
							 | 
						||
| 
								 | 
							
								                    "client_flags", ClientFlag.get_default()
							 | 
						||
| 
								 | 
							
								                )
							 | 
						||
| 
								 | 
							
								                client_flags |= ClientFlag.FOUND_ROWS
							 | 
						||
| 
								 | 
							
								                opts["client_flags"] = client_flags
							 | 
						||
| 
								 | 
							
								            except Exception:
							 | 
						||
| 
								 | 
							
								                pass
							 | 
						||
| 
								 | 
							
								        return [[], opts]
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								    @util.memoized_property
							 | 
						||
| 
								 | 
							
								    def _mysqlconnector_version_info(self):
							 | 
						||
| 
								 | 
							
								        if self.dbapi and hasattr(self.dbapi, "__version__"):
							 | 
						||
| 
								 | 
							
								            m = re.match(r"(\d+)\.(\d+)(?:\.(\d+))?", self.dbapi.__version__)
							 | 
						||
| 
								 | 
							
								            if m:
							 | 
						||
| 
								 | 
							
								                return tuple(int(x) for x in m.group(1, 2, 3) if x is not None)
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								    @util.memoized_property
							 | 
						||
| 
								 | 
							
								    def _mysqlconnector_double_percents(self):
							 | 
						||
| 
								 | 
							
								        return not util.py3k and self._mysqlconnector_version_info < (2, 0)
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								    def _detect_charset(self, connection):
							 | 
						||
| 
								 | 
							
								        return connection.connection.charset
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								    def _extract_error_code(self, exception):
							 | 
						||
| 
								 | 
							
								        return exception.errno
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								    def is_disconnect(self, e, connection, cursor):
							 | 
						||
| 
								 | 
							
								        errnos = (2006, 2013, 2014, 2045, 2055, 2048)
							 | 
						||
| 
								 | 
							
								        exceptions = (self.dbapi.OperationalError, self.dbapi.InterfaceError)
							 | 
						||
| 
								 | 
							
								        if isinstance(e, exceptions):
							 | 
						||
| 
								 | 
							
								            return (
							 | 
						||
| 
								 | 
							
								                e.errno in errnos
							 | 
						||
| 
								 | 
							
								                or "MySQL Connection not available." in str(e)
							 | 
						||
| 
								 | 
							
								                or "Connection to MySQL is not available" in str(e)
							 | 
						||
| 
								 | 
							
								            )
							 | 
						||
| 
								 | 
							
								        else:
							 | 
						||
| 
								 | 
							
								            return False
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								    def _compat_fetchall(self, rp, charset=None):
							 | 
						||
| 
								 | 
							
								        return rp.fetchall()
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								    def _compat_fetchone(self, rp, charset=None):
							 | 
						||
| 
								 | 
							
								        return rp.fetchone()
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								    _isolation_lookup = set(
							 | 
						||
| 
								 | 
							
								        [
							 | 
						||
| 
								 | 
							
								            "SERIALIZABLE",
							 | 
						||
| 
								 | 
							
								            "READ UNCOMMITTED",
							 | 
						||
| 
								 | 
							
								            "READ COMMITTED",
							 | 
						||
| 
								 | 
							
								            "REPEATABLE READ",
							 | 
						||
| 
								 | 
							
								            "AUTOCOMMIT",
							 | 
						||
| 
								 | 
							
								        ]
							 | 
						||
| 
								 | 
							
								    )
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								    def _set_isolation_level(self, connection, level):
							 | 
						||
| 
								 | 
							
								        if level == "AUTOCOMMIT":
							 | 
						||
| 
								 | 
							
								            connection.autocommit = True
							 | 
						||
| 
								 | 
							
								        else:
							 | 
						||
| 
								 | 
							
								            connection.autocommit = False
							 | 
						||
| 
								 | 
							
								            super(MySQLDialect_mysqlconnector, self)._set_isolation_level(
							 | 
						||
| 
								 | 
							
								                connection, level
							 | 
						||
| 
								 | 
							
								            )
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								dialect = MySQLDialect_mysqlconnector
							 |