File: //var/opt/nydus/ops/mysql/connector/__pycache__/abstracts.cpython-39.pyc
a
�,�h�v � @ sF U d Z ddlmZ ddlZddlZddlZddlmZmZ ddl m
Z
m Z m Z m Z ddl
mZ ddlmZ ddl mZ dd lmZ dd
lmZmZmZmZmZmZmZm Z m Z m Z m Z m Z m!Z!m"Z" d Z#z ddl$Z$e%e$d �r�e$j&r�d
Z#W n e'y� Y n0 ddl(m)Z)m*Z*m+Z+m,Z,m-Z-m.Z.m/Z/ ddl0m1Z1m2Z2 ddl3m4Z4m5Z5m6Z6m7Z7m8Z8m9Z9 ddl:m;Z;m<Z<m=Z=m>Z> e>�r�ddl?m@Z@mAZAmBZBmCZC ddlDmEZE ddlFmGZGmHZH ddlmIZImJZJmKZKmLZLmMZMmNZNmOZOmPZP ddlQmRZRmSZS e�T� ZUdeVd< dZWdZXd ZYd ZZd Z[ee\e
e e]e^e_e e f Z`G d d � d eR�ZaG d!d"� d"e�ZbG d#d$� d$e�ZcdS )%z+Module gathering all abstract base classes.� )� annotationsN)�ABC�abstractmethod)�date�datetime�time� timedelta)�Decimal)� signature)�sleep)�
TracebackType)�Any�BinaryIO�Callable�Dict� Generator�Iterator�List�Mapping�NoReturn�Optional�Sequence�Tuple�Type�UnionF� HAS_TLSv1_3T� )�
CONN_ATTRS_DN�DEFAULT_CONFIGURATION�OPENSSL_CS_NAMES�TLS_CIPHER_SUITES� TLS_VERSIONS� CharacterSet�
ClientFlag)�MySQLConverter�MySQLConverterBase)�
DatabaseError�Error�InterfaceError�NotSupportedError�OperationalError�ProgrammingError)�CONNECTION_SPAN_NAME�OPTION_CNX_SPAN�OPTION_CNX_TRACER� OTEL_ENABLED)�end_span�record_exception_event�set_connection_span_attrs�trace)�read_option_files)� UNACCEPTABLE_TLS_CIPHERSUITES�UNACCEPTABLE_TLS_VERSIONS)�BinaryProtocolType�DescriptionType�
HandShakeType�MySQLConvertibleType� RowItemType�RowType�
StrOrBytes� WarningType)�GenericWrapper�
import_objectz%weakref.WeakValueDictionary[Any, Any]�NAMED_TUPLE_CACHEzVThe '{list}' list must not contain repeated values, the value '{value}' is duplicated.zdThe given tls_version: '{}' is not recognized as a valid TLS protocol version (should be one of {}).zHThe given tls_version: '{}' are no longer allowed (should be one of {}).zINo supported TLS protocol version found in the 'tls-versions' list '{}'. a Option "krb_service_principal" {error}, must be a string in the form "primary/instance@realm" e.g "ldap/ldapauth@MYSQL.COM" where "@realm" is optional and if it is not given will be assumed to belong to the default realm, as configured in the krb5.conf file.c @ s e Zd ZdZdS )�CMySQLPrepStmtaP Structure to represent a result from `CMySQLConnection.cmd_stmt_prepare`.
It can be used consistently as a type hint.
`_mysql_connector.MySQLPrepStmt` isn't available when the C-ext isn't built.
In this regard, `CmdStmtPrepareResult` acts as a proxy/wrapper entity for a
`_mysql_connector.MySQLPrepStmt` instance.
N)�__name__�
__module__� __qualname__�__doc__� rG rG �L/opt/nydus/tmp/pip-target-wkfpz8uv/lib64/python/mysql/connector/abstracts.pyrB � s rB c
@ s� e Zd ZU dZdd�dd�Zd d�dd�Zdd d
dd �d d
�Zd d�dd�Zedd�dd��Z edd�dd��Z
edd�dd��Z ddd�dd�Z d d d �d d �Z
dd�d!d"�Zdd�d#d$�Zdd�d%d&�Zed d�d'd(��Zed d�d)d*��Zed+d�d,d-��Zed.d�d/d0��Zeed d�d1d2���Zejd dd�d3d2��Zedd�d4d5��Zejddd�d6d5��Zed7d�d8d9��Zejd7dd�d:d9��Zd7dd;�d<d=�Zdd�d>d?�Ze d�d dAd+ddB�dCdD��Z e dEdFdG�dHdI��Z dJd�dKdL�Z d.d�dMdN�Z eedd�dOdP���Z!dQd+dR�dSdT�Z"dUd�dVdW�Z#d+ddX�dYdZ�Z$ed d�d[d\��Z%e%jd dd�d]d\��Z%ed d�d^d_��Z&e&jd`dd�dad_��Z&ed dbdc�ddde��Z'd�d.d.ddg�dhdi�Z(d�ddd�dkdl�Z)edd�dmdn��Z*e*jddd�dodn��Z*edd�dpdq��Z+e+jddd�drdq��Z+edd�dsdt��Z,e,jddd�dudt��Z,edd�dvdw��Z-e-jddd�dxdw��Z-ed d�dydz��Z.ed d�d{d|��Z/d�d}d.dd~�dd��Z0ed d�d�d���Z1eed�d�d�d����Z2edd�d�d���Z3edd�d�d���Z4dd�d�d��Z5edd�d�d���Z6e6Z7d�e8d�< d7dd;�d�d��Z9d�d+d+dd��d�d��Z:edd�d�d���Z;ed�dd+d+dd��d�d���Z<edd�d�d���Z=ed�d�d�d�d�d�d�d�d��d�d���Z>ed ddc�d�d���Z?edd�d�d���Z@d�dd.d�dd��d�d��ZA�d d�d�dd��d�d��ZBd�dd��d�d��ZCe�ddd�d�d�d�d��d�d���ZDe�dd�dd�d�d�d�d��d�d���ZEed d�d��d�d���ZFe�dd d�ddd�d��d�d�ZGed d�dĜd�dƄ�ZHed+d�dǜd�dɄ�ZIed�d�d�d̄�ZJe�dd�dd͜d�dτ�ZKed�d�d�dф�ZLe dUd�d�dӄ�ZMed+d�dԜd�dք�ZNed�d�d�d�ZOed�d�d�dڄ�ZPe�dd d d d+d d d d d d�dݜ
d�d߄�ZQed�d�d�d�d��ZRe�dd�d�d�d+d�d�d�d��ZSed�dd�d�d��ZTed�d+d�d+d�d�d��ZUed�dd�d�d���ZVedd�d�d���ZWdfS ( �MySQLConnectionAbstractz8Abstract class for classes connecting to a MySQL server.�None��returnc C sX d| _ d| _d| _t�� | _d| _d| _d| _d| _ d| _
d| _ i | _ d| _
d| _d| _d| _d| _d| _d| _d| _d| _d| _d| _i | _td | _d| _d| _ d| _ d| _ d| _ d| _ d| _!d| _"td
| _#d| _$d| _%d| _&d| _'d| _(td | _)td | _*d| _+i | _,d| _-d| _.d| _/d| _0d| _1d| _2d| _3d| _4d| _5d| _6t7� | _8dS )
Z
InitializeNT�- F� z 127.0.0.1i� r � ssl_disabled�connect_timeout�allow_local_infile�allow_local_infile_in_path)9�_tracer�_spanZotel_context_propagationr# � get_default�
_client_flags� _charset_id� _sql_mode�
_time_zone� _autocommit�_server_version�
_handshake� _conn_attrs�_user� _password�
_password1Z
_password2Z
_password3� _database�_host�_port� _unix_socketZ _client_hostZ _client_port�_sslr �
_ssl_disabledZ _force_ipv6Z_oci_config_fileZ_oci_config_profile�_webauthn_callback�_krb_service_principal� _use_unicode�
_get_warnings�_raise_on_warningsZ_connection_timeoutZ _buffered�_unread_result�_have_next_result�_rawZ_in_transaction�_allow_local_infile�_allow_local_infile_in_pathZ_prepared_statements� _query_attrs� _ssl_active� _auth_plugin�_auth_plugin_class�_pool_config_version� converter�_converter_class�_converter_str_fallback� _compress�_consume_results�
_init_commandr" �_character_set��selfrG rG rH �__init__� sr
�
�z MySQLConnectionAbstract.__init__c C s | S �NrG r} rG rG rH � __enter__� s z!MySQLConnectionAbstract.__enter__�Type[BaseException]�
BaseExceptionr ��exc_type� exc_value� tracebackrL c C s | � � d S r� ��close�r~ r� r� r� rG rG rH �__exit__� s z MySQLConnectionAbstract.__exit__c C s | S )z�Returns self for `weakref.proxy`.
This method is used when the original object is needed when using
`weakref.proxy`.
rG r} rG rG rH �get_self� s z MySQLConnectionAbstract.get_self�boolc C s | j p| jduotjdkS )z)Returns `True` if is a secure connection.N�posix)rr rd �os�namer} rG rG rH � is_secure s �z!MySQLConnectionAbstract.is_securec C s | j S )z Returns If have next result.)rm r} rG rG rH �have_next_result
s z(MySQLConnectionAbstract.have_next_resultz$List[Tuple[str, BinaryProtocolType]]c C s t | j�� �S )z Returns query attributes list.)�listrq �itemsr} rG rG rH � query_attrs s z#MySQLConnectionAbstract.query_attrsz Tuple[str, BinaryProtocolType])�valuerL c C s |\}}|| j vr || j |< dS )a Adds element to the query attributes list on the connector's side.
If an element in the query attributes list already matches
the attribute name provided, the new element will NOT be added.
Args:
value: key-value as a 2-tuple.
N�rq )r~ r� � attr_name�
attr_valuerG rG rH �query_attrs_append s
z*MySQLConnectionAbstract.query_attrs_append�strr7 �r� rL c C s | j �|d�S )z�Removes element by name from the query attributes list on the connector's side.
If no match, `None` is returned, else the corresponding value is returned.
Args:
name: key name.
N)rq �pop�r~ r� rG rG rH �query_attrs_remove! s z*MySQLConnectionAbstract.query_attrs_removec C s
i | _ dS )z5Clears query attributes list on the connector's side.Nr� r} rG rG rH �query_attrs_clear+ s z)MySQLConnectionAbstract.query_attrs_clearc C s� g }| j d }t|t�r�|�d�r,|�d�s<td|� d���|dd� �d�}|sZtd ��|D ] }|�� �� }|r^|� |� q^n.t|t
t f�r�d
d � |D �}ntd |� d���| j � d
d�du r�t
dd� n| j d
dd� }|jdd� |d }g g g}i }g } t
dt
�|�d � D ]"}
|�t|
� | �t|
� �q|D ]�} d| v �r�| | v �r�| td v �rv|d � | � n|d � | � nt| |v �r�|| } | |v �r�ttjd| d���| td v �r�|d � || � n|d � || � ntd| � d����q@|d �s|d �std��|d D ](}
|
td �� v �r"td|
� d����q"|d D ](}
|
td �� v �rTtd|
� d����qTd �|d �d �|d �g| j d< dS ) z&Validates the tls_ciphersuites option.�tls_ciphersuites�[�]z)tls_ciphersuites must be a list, found: '�'r ����,z6No valid cipher suite found in 'tls_ciphersuites' listc S s g | ] }|r|�qS rG rG )�.0�tls_csrG rG rH �
<listcomp>D � zFMySQLConnectionAbstract._validate_tls_ciphersuites.<locals>.<listcomp>zItls_ciphersuites should be a list with one or more ciphersuites. Found: '� tls_versionsNT)�reverser �-�TLSv1.3�r� r� z The value 'z1' in tls_ciphersuites is not a valid cipher suitez:No valid cipher suite found in the 'tls_ciphersuites' listzTLSv1.2zCipher z( when used with TLSv1.2 is unacceptable.z( when used with TLSv1.3 is unacceptable.�:)re �
isinstancer� �
startswith�endswith�AttributeError�split�strip�upper�appendr� �set�getr! �sort�index�updater �extendr �DUPLICATED_IN_LIST_ERROR�formatr5 �valuesr) �join)r~ r� r� Ztls_cssZ_tls_csr� Z
newer_tls_verZtranslated_namesZiani_cipher_suites_namesZossl_cipher_suites_names�tls_verr� Ztranslated_nameZcipher_as_osslrG rG rH �_validate_tls_ciphersuites/ s�
�� ����
��
��
�
� �z2MySQLConnectionAbstract._validate_tls_ciphersuitesc C s� g }| j d }t|t�r�|�d�r,|�d�s<td|� d���|dd� �d�}|D ]:}|�� }|d krhqR||v r�ttj d|d
���|�
|� qR|d gkr�t s�tt � |t
���n�t|t�r�|s�td ��|D ](}||v r�ttj d|d
���|�
|� q�n@t|t��r|D ]}|�
|� �qn td
d�t
�� d|� d���|�sBtd��g }g }g }|D ]:}|t
v �rj|�
|� |tv �r�|�
|� n
|�
|� �qR|�r�|d gk�r�t �s�tt � |t
���|| j d< n.|�r�tt� |t
���n|�r�tt� |t
���dS )z"Validates the tls_versions option.r� r� r� z%tls_versions must be a list, found: 'r� r r� r� rN r� r� zJAt least one TLS protocol version must be specified in 'tls_versions' listz>tls_versions should be a list with one or more of versions in z, z
. found: 'zdAt least one TLS protocol version must be specified in 'tls_versions' list when this option is givenN)re r� r� r� r� r� r� r� r� r� r� �TLS_V1_3_SUPPORTED�TLS_VER_NO_SUPPORTEDr! r� r� r� r6 r) � TLS_VERSION_UNACCEPTABLE_ERROR�TLS_VERSION_ERROR)r~ r� Z tls_versionZtls_versr� Zuse_tls_versionsZunacceptable_tls_versionsZinvalid_tls_versionsrG rG rH �_validate_tls_versions� s�
���
�
��� ����
� ��z.MySQLConnectionAbstract._validate_tls_versionsc C s | j S )z6The user name used for connecting to the MySQL server.)r^ r} rG rG rH �user� s z MySQLConnectionAbstract.userc C s | j S )z MySQL server IP address or name.)rb r} rG rG rH � server_host� s z#MySQLConnectionAbstract.server_host�intc C s | j S )zMySQL server TCP/IP port.)rc r} rG rG rH � server_port� s z#MySQLConnectionAbstract.server_portz
Optional[str]c C s | j S )z8The Unix socket file for connecting to the MySQL server.)rd r} rG rG rH � unix_socket� s z#MySQLConnectionAbstract.unix_socketc C s dS )zThe current database.NrG r} rG rG rH �database� s z MySQLConnectionAbstract.databasec C s | � d|� �� dS )zSets the current database.zUSE N)� cmd_query�r~ r� rG rG rH r� � s c C s | j S )z#Returns whether to consume results.)rz r} rG rG rH �can_consume_results� s z+MySQLConnectionAbstract.can_consume_resultsc C s t |t�sJ �|| _dS )z Sets if can consume results.N)r� r� rz r� rG rG rH r� s r
c C s | j S )z'Returns the pool configuration version.�ru r} rG rG rH �pool_config_version s z+MySQLConnectionAbstract.pool_config_versionc C s
|| _ dS )z#Sets the pool configuration versionNr� r� rG rG rH r�
s )�kwargsrL c
K s |� td�| _|� td�| _|�� }d|v r4td��tf i |��}z|d | _|d= W n t yh Y n0 z|d | _
|d= W n t y� Y n0 z$t � � }| �
|d p�|� |d= W n t y� Y n0 z |d r�d| _| �
t jg� W n t y� Y n0 |�d td �| _|�d
td
�| _d}| j�rttj�| j�}|�r^tj�|��r^tj�|��rltj�|��rttd ��| j�s�| j�r�| �
t jg� n| �
t j g� z |d �s�d
| _ nd| _ W n t �y� d
| _ Y n0 z|d | _ |d= W n t �y
d| _ Y n0 | j dk�r*t d| j � d���z| � |d � W nB t �yP Y n0 t �y~ } ztd�|�W Y d}~n
d}~0 0 g d�}|D ]@\}}z ||v�r�|| ||< ||= W n t �y� Y n0 �q�d|v �s�d|v �rJz|d } |d= W n t �y | j!} Y n0 z|d }
|d= W n t �y< | j"}
Y n0 | �#| |
� d|v �rh|d �rh|d | _$zt%|d �| _&|d= W nB t �y� Y n0 t'�y� } zt d�|�W Y d}~n
d}~0 0 d|v �r�|� d�| _(d |v �r�|d | _)|d = d
} |�*� D ]�\} }
z t| W n& t �y: td | � d��d�Y n0 | �+d ��rfd} | j,�-| �.d d�|
i� n`| �+d ��r�d} | j,�-| |
i� n>d | }zt/| ||
�0� � W n t�y� t/| ||
� Y n0 �q | j1�r�tj2d!k�r�d| _(| j(�r | j d"k�r t d#��| �r
d$| j,v�r td% | j,d$< d&| j,v�r:td' | j,d&< d(| j,v�sV| j,d( du �r`d| j,d(< t3d)| j,v �t3d*| j,v �k�r�td+��t4d,�t4| j,�k�s�d| j,d)< d| j,d*< n&| j,d) du | j,d* du k�r�td-��| j,�d.�du�r�| �5� | j,�d/�du�r
| �6� | j7du �r i | _7n�t8| j7t9��s6t d0��n�| j7�*� D ]�\}}|t:v �rV�q@t8|t;��szt d1|� d2| j7� d���t<|�d3k�r�t d4|� d5���|�+d ��r�t d6��t8|t;��s�t d7|� d8|� d9���t<|�d:k�r@t d7|� d8|� d;����q@| j=t j>@ �r | �?� d<|v �r�|d< du�r�t8|d< t;��s<t d=��|d< �@� }|d>k�rntj2d?k�rft d@��dA| _An|dBk�r�dC| _Ant dD��dE|v �r |dE du�r |dE | _Bt8| jBt;��s�t tCjDdFdG���| jBdk�r�t tCjDdHdG���dI| jBv�r t tCjDdJdG���| jE�r| �FdK| jEdL� dS )Ma Configures the MySQL Connection.
This method allows you to configure the `MySQLConnection`
instance after it has been instantiated.
Args:
**kwargs: For a complete list of possible arguments, see [1].
Raises:
AttributeError: When provided unsupported connection arguments.
InterfaceError: When the provided connection argument is invalid.
References:
[1]: https://dev.mysql.com/doc/connector-python/en/connector-python-connectargs.html
NZdsnz!Data source name is not supported� get_warnings�raise_on_warningsZ client_flags�compressTrQ rR z.allow_local_infile_in_path must be a directoryZconsume_resultsFZ auth_pluginrN Z authentication_webauthn_clientr� z5' cannot be used as the default authentication pluginZconverter_classzEConverter class should be a subclass of conversion.MySQLConverterBase))�dbr� )�usernamer� )�passwd�password)rP Zconnection_timeout)Zread_default_fileZ option_filesr� r� �host�portz'TCP/IP port number should be an integerrO Z init_commandzUnsupported argument '�ssl_Ztls_�_r� Zmysql_clear_passwordzEClear password authentication is not supported over insecure channelsZ verify_certZssl_verify_certZverify_identityZssl_verify_identity�ca�key�certz:ssl_key and ssl_cert need to be both specified, or neither)r� r� z4ssl_key and ssl_cert need to be both set, or neitherr� r� z conn_attrs must be of type dictz+Attribute name should be a string, found: 'z' in '� zAttribute name 'z"' exceeds 32 characters limit sizezNKey names in connection attributes cannot start with '_', found: '{attr_name}'z Attribute 'z
' value: 'z' must be a string typei z$' exceeds 1024 characters limit size�kerberos_auth_modez('kerberos_auth_mode' must be of type strZsspi�ntz6'kerberos_auth_mode=SSPI' is only available on WindowsZMySQLSSPIKerberosAuthPluginZgssapiZMySQLKerberosAuthPluginz@Invalid 'kerberos_auth_mode' mode. Please use 'SSPI' or 'GSSAPI'Zkrb_service_principalzis not a string)�errorzcan not be an empty string�/zis incorrectly formattedZwebauth_callbackr )Gr� r- rT r. rS �copyr) r4 r� �KeyErrorr� r# rU �set_client_flagsry ZCOMPRESSr� r ro rp r� �path�abspath�exists�isdir�islinkr� Z LOCAL_FILESrz rs r( �set_converter_class� TypeErrorr^ r_ � set_loginrb r� rc �
ValueErrorrf r{ r� r� re r� �replace�setattrr� rd r� r� r� r� r� r] r� �dictr r� �lenrV Z CONNECT_ARGS�_add_default_conn_attrs�lowerrt rh �KRB_SERVICE_PINCIPAL_ERRORr� rg �_validate_callable)r~ r� �config�defaultZinfile_in_path�errZ
compat_map�compat� translater� r� Z set_ssl_flagr� r� � attributer� r� r� rG rG rH r� s�
���
�
�
�
���
� �
�
�
���
� � ��
�
��
�
� ��
�z MySQLConnectionAbstract.configc C s dS )z'Adds the default connection attributes.NrG r} rG rG rH r� > s z/MySQLConnectionAbstract._add_default_conn_attrsr zUnion[str, Callable])� option_name�callback�num_argsrL c
C s� t |t�rHz t|�}W n0 tyF } zt|� �|�W Y d}~n
d}~0 0 t|�s`td| � d���tt|�j�}||kr�td| � d|� d|� ���dS )a� Validates if it's a Python callable.
Args:
option_name (str): Connection option name.
callback (str or callable): The fully qualified path to the callable or
a callable.
num_args (int): Number of positional arguments allowed.
Raises:
ProgrammingError: If `callback` is not valid or wrong number of positional
arguments.
.. versionadded:: 8.2.0
NzExpected a callable for 'r� z ' requires z4 positional argument, but the callback provided has ) r� r� r@ r� r+ �callabler� r
�
parameters)r r r r� Z
num_paramsrG rG rH r� A s
"��z*MySQLConnectionAbstract._validate_callabler= zTuple[int, ...])�server_versionrL c C sp t | ttf�r| �� } t�d�}|�| �}|s6td��tdd� |� � dd� D ��}|dk rltd| � d ���|S )
a9 Checks the MySQL version.
This method will check the MySQL version and raise an InterfaceError
when it is not supported or invalid. It will return the version
as a tuple with major, minor and patch.
Raises InterfaceError if invalid server version.
Returns tuple
z$^(\d{1,2})\.(\d{1,2})\.(\d{1,3})(.*)z Failed parsing MySQL versionc s s | ]}t |�V qd S r� )r� )r� �vrG rG rH � <genexpr>x r� z@MySQLConnectionAbstract._check_server_version.<locals>.<genexpr>r � )� r zMySQL Version 'z' is not supported)
r� � bytearray�bytes�decode�re�compile�matchr( �tuple�groups)r Z regex_verr �versionrG rG rH �_check_server_versiond s
z-MySQLConnectionAbstract._check_server_versionzOptional[Tuple[int, ...]]c C s | j S )z�Gets the MySQL version.
Returns:
The MySQL server version as a tuple. If not previously connected, it will
return `None`.
)r[ r} rG rG rH �get_server_version~ s z*MySQLConnectionAbstract.get_server_versionc C s* z | j d W S ttfy$ Y dS 0 dS )z�Gets the original MySQL version information.
Returns:
The original MySQL server as text. If not previously connected, it will
return `None`.
Zserver_version_originalN)r\ r� r� r} rG rG rH �get_server_info� s z'MySQLConnectionAbstract.get_server_infoc C s dS )aM Returns bool to indicate whether a transaction is active for the connection.
The value is `True` regardless of whether you start a transaction using the
`start_transaction()` API call or by directly executing an SQL statement such
as START TRANSACTION or BEGIN.
`in_transaction` was added in MySQL Connector/Python 1.1.0.
Examples:
```
>>> cnx.start_transaction()
>>> cnx.in_transaction
True
>>> cnx.commit()
>>> cnx.in_transaction
False
```
NrG r} rG rG rH �in_transaction� s z&MySQLConnectionAbstract.in_transactionzUnion[int, Sequence[int]])�flagsrL c C sn t |t�r|dkr|| _nNt |ttf�r`|D ]0}|dk rN| jt|� M _q,| j|O _q,ntd��| jS )a� Sets the client flags.
The flags-argument can be either an int or a list (or tuple) of
ClientFlag-values. If it is an integer, it will set client_flags
to flags as is.
If flags is a sequence, each item in the sequence sets the flag when the
value is positive or unsets it when negative (see example below).
Args:
flags: A list (or tuple), each flag will be set or unset when it's negative.
Returns:
integer: Client flags.
Raises:
ProgrammingError: When the flags argument is not a set or an integer
bigger than 0.
Examples:
```
For example, to unset `LONG_FLAG` and set the `FOUND_ROWS` flags:
>>> from mysql.connector.constants import ClientFlag
>>> cnx.set_client_flags([ClientFlag.FOUND_ROWS, -ClientFlag.LONG_FLAG])
>>> cnx.reconnect()
```
r z+set_client_flags expect integer (>0) or set)r� r� rV r r� �absr+ )r~ r �flagrG rG rH r� � s z(MySQLConnectionAbstract.set_client_flagsr c C s t �dS )ak Shuts down connection to MySQL Server.
This method closes the socket. It raises no exceptions.
Unlike `disconnect()`, `shutdown()` closes the client connection without
attempting to send a `QUIT` command to the server first. Thus, it will not
block if the connection is disrupted for some reason such as network failure.
N)�NotImplementedErrorr} rG rG rH �shutdown� s z MySQLConnectionAbstract.shutdown)r rL c C s | j |@ dkS )z|Checks if a client flag is set.
Returns:
`True` if the client flag was set, `False` otherwise.
r )rV )r~ r rG rG rH �isset_client_flag� s z)MySQLConnectionAbstract.isset_client_flagc C s | � d�d S )zGets the current time zone.zSELECT @@session.time_zoner ��
info_queryr} rG rG rH � time_zone� s �z!MySQLConnectionAbstract.time_zonec C s | � d|� d�� || _dS )zSets the time zone.zSET @@session.time_zone = 'r� N)r� rY r� rG rG rH r" � s c C s | j du r| �d�d | _ | j S )zGets the SQL mode.NzSELECT @@session.sql_moder )rX r! r} rG rG rH �sql_mode� s
z MySQLConnectionAbstract.sql_modezUnion[str, Sequence[int]]c C s4 t |ttf�rd�|�}| �d|� d�� || _dS )a� Sets the SQL mode.
This method sets the SQL Mode for the current connection. The value
argument can be either a string with comma separate mode names, or
a sequence of mode names.
It is good practice to use the constants class `SQLMode`:
```
>>> from mysql.connector.constants import SQLMode
>>> cnx.sql_mode = [SQLMode.NO_ZERO_DATE, SQLMode.REAL_AS_FLOAT]
```
r� zSET @@session.sql_mode = 'r� N)r� r� r r� r� rX r� rG rG rH r# � s
zOptional[RowType])�queryrL c C s dS )a9 Sends a query which only returns 1 row.
Shortcut for:
```
cursor = self.cursor(buffered=True)
cursor.execute(query)
return cursor.fetchone()
```
Args:
query: Statement to execute.
Returns:
row: A tuple (RowType).
NrG �r~ r$ rG rG rH r! s z"MySQLConnectionAbstract.info_queryN)r� r� rL c C s4 |dur|� � | _nd| _|dur*|| _nd| _dS )z�Sets login information for MySQL.
Sets the username and/or password for the user connecting to the MySQL Server.
Args:
username: Account's user name.
password: Account's password.
NrN )r� r^ r_ )r~ r� r� rG rG rH r� s z!MySQLConnectionAbstract.set_loginTc C s || _ | jr| j�|� dS )z�Toggles unicode mode.
Sets whether we return string fields as unicode or not.
Args:
value: A boolean - default is `True`.
N)ri rv � set_unicoder� rG rG rH r& 2 s z#MySQLConnectionAbstract.set_unicodec C s | � d�d }|dkS )z%Gets whether autocommit is on or off.zSELECT @@session.autocommitr r r r� rG rG rH �
autocommit> s z"MySQLConnectionAbstract.autocommitc C s& |rdnd}| � d|� �� || _dS )zToggles autocommit.�ONZOFFzSET @@session.autocommit = N)r� rZ )r~ r� �switchrG rG rH r' D s c C s | j S )z�Gets whether this connection retrieves warnings automatically.
This method returns whether this connection retrieves warnings
automatically.
Returns `True`, or `False` when warnings are not retrieved.
)rj r} rG rG rH r� K s z$MySQLConnectionAbstract.get_warningsc C s t |t�std��|| _dS )z�Sets whether warnings should be automatically retrieved.
The toggle-argument must be a boolean. When True, cursors for this
connection will retrieve information about warnings (if any).
Raises `ValueError` on error.
�Expected a boolean typeN)r� r� r� rj r� rG rG rH r� V s
c C s | j S )z�Gets whether this connection raises an error on warnings.
This method returns whether this connection will raise errors when
MySQL reports warnings.
Returns `True` or `False`.
)rk r} rG rG rH r� c s z)MySQLConnectionAbstract.raise_on_warningsc C s& t |t�std��|| _|r"|| _dS )a� Sets whether warnings raise an error.
The toggle-argument must be a boolean. When True, cursors for this
connection will raise an error when MySQL reports warnings.
Raising on warnings implies retrieving warnings automatically. In
other words: warnings will be set to True. If set to False, warnings
will be also set to False.
Raises `ValueError` on error.
r* N)r� r� r� rk rj r� rG rG rH r� n s
c C s | j S )z�Gets whether there is an unread result.
This method is used by cursors to check whether another cursor still
needs to retrieve its result set.
Returns `True`, or `False` when there is no unread result.
)rl r} rG rG rH �
unread_result� s z%MySQLConnectionAbstract.unread_resultc C s t |t�std��|| _dS )z�Sets whether there is an unread result.
This method is used by cursors to let other cursors know there is
still a result set that needs to be retrieved.
Raises `ValueError` on errors.
r* N)r� r� r� rl r� rG rG rH r+ � s
c C s | j �| j�d S )a, Returns the character set for current connection.
This property returns the character set name of the current connection.
The server is queried when the connection is active. If not connected,
the configured character set name is returned.
Returns a string.
r �r| �get_inforW r} rG rG rH �charset� s
z MySQLConnectionAbstract.charsetc C s" | j �| j�d }|dv r dS |S )az Returns the Python character set for current connection.
This property returns the character set name of the current connection.
Note that, unlike property charset, this checks if the previously set
character set is supported by Python and if not, it returns the
equivalent character set that Python supports.
Returns a string.
r )Zutf8mb4Zutf8mb3�binary�utf8r, )r~ �encodingrG rG rH �python_charset� s z&MySQLConnectionAbstract.python_charsetzOptional[Union[int, str]])r. � collationrL c C s. d}t |ttf�s(|dur(t|�d���t |t�sB|durBtd��|r�t |t�rf| j�|�\| _}}q�t |t�r�| j�||�\| _}}q�t|�d���n<|r�| jj|d�\| _}}n td }| jj|dd�\| _}}| � d|� d|� d�� z| �
|� W n t �y Y n0 | j �r*| j j
|| jd � dS )
a� Sets the character set and collation for the current connection.
This method sets the character set and collation to be used for
the current connection. The charset argument can be either the
name of a character set as a string, or the numerical equivalent
as defined in constants.CharacterSet.
When the collation is not given, the default will be looked up and
used.
Args:
charset: Can be either the name of a character set, or the numerical
equivalent as defined in `constants.CharacterSet`.
collation: When collation is `None`, the default collation for the
character set is used.
Examples:
The following will set the collation for the latin1 character set to
`latin1_general_ci`:
```
>>> cnx = mysql.connector.connect(user='scott')
>>> cnx.set_charset_collation('latin1', 'latin1_general_ci')
```
z+{} should be either integer, string or NoneNr. z)collation should be either string or None)r3 z SET NAMES 'z ' COLLATE 'r� )Z
character_set)r� r� r� r� r� r| �get_charset_inforW r �_execute_queryZset_character_set_namer� rv � set_charset)r~ r. r3 �err_msg� charset_nameZcollation_namerG rG rH �set_charset_collation� sR
��
�� ���z-MySQLConnectionAbstract.set_charset_collationc C s | j �| j�d S )a Returns the collation for current connection.
This property returns the collation name of the current connection.
The server is queried when the connection is active. If not connected,
the configured collation name is returned.
Returns a string.
� )r| r4 rW r} rG rG rH r3 s
z!MySQLConnectionAbstract.collation�
Optional[int]c C s dS )zMySQL connection ID.NrG r} rG rG rH �
connection_id s z%MySQLConnectionAbstract.connection_idc C s dS )z>Gathers information of the MySQL server before authentication.NrG r} rG rG rH �
_do_handshake s z%MySQLConnectionAbstract._do_handshakec C s dS )z)Opens the connection to the MySQL server.NrG r} rG rG rH �_open_connection s z(MySQLConnectionAbstract._open_connectionc C sF | � | j� | j| _| jr"| j| _| jr0| j| _| jrB| � | j� dS )z�Executes commands after connection has been established.
This method executes commands after the connection has been
established. Some setting like autocommit, character set, and SQL mode
are set using this method.
N)
r9 rW rZ r' rY r" rX r# r{ r5 r} rG rG rH �_post_connection s z(MySQLConnectionAbstract._post_connectionc C s dS )a Disconnects from the MySQL server.
This method tries to send a `QUIT` command and close the socket. It raises
no exceptions.
`MySQLConnection.close()` is a synonymous for `MySQLConnection.disconnect()`
method name and more commonly used.
To shut down the connection without sending a `QUIT` command first,
use `shutdown()`.
NrG r} rG rG rH �
disconnect) s z"MySQLConnectionAbstract.disconnectzCallable[[], Any]r� c K s� |r| j f i |�� | �� | �� |�dd�|�dd� }}|sF|rZ| j�||�d | _| jtj @ sp| �
� nXz| j | jd� W nD t y� | �
d| jp�| j� d�� | j | jd� | �
d� Y n0 dS ) a
Connects to the MySQL server.
This method sets up the connection to the MySQL server. If no
arguments are given, it will use the already configured or default
values.
Args:
**kwargs: For a complete list of possible arguments, see [1].
Examples:
```
>>> cnx = MySQLConnection(user='joe', database='test')
```
References:
[1]: https://dev.mysql.com/doc/connector-python/en/connector-python-connectargs.html
r. Nr3 r )r. zSET PASSWORD = 'r� z)ALTER USER CURRENT_USER() PASSWORD EXPIRE)r� r@ r> r� r| r4 rW rV r# Z CAN_HANDLE_EXPIRED_PASSWORDSr? r9 r& r� r` r_ )r~ r� r. r3 rG rG rH �connect9 s&
� �
z MySQLConnectionAbstract.connectr )�attempts�delayrL c
C s d}d}| j r"| j jttjjd�}z�||kr�|d }z | �� | �� | �� rRW q�W nJ t t
fy� } z.||kr�d|� d|� �}t |�|�W Y d}~n
d}~0 0 |dkr$t |� q$W nF t y� } z.t
r�t| |� t||� t|� � W Y d}~n
d}~0 0 || _t
�rt| | j� dS )a� Attempts to reconnect to the MySQL server.
The argument `attempts` should be the number of times a reconnect
is tried. The `delay` argument is the number of seconds to wait between
each retry.
You may want to set the number of attempts higher and use delay when
you expect the MySQL server to be down for maintenance or when you
expect the network to be temporary unavailable.
Args:
attempts: Number of attempts to make when reconnecting.
delay: Use it (defined in seconds) if you want to wait between each retry.
Raises:
InterfaceError: When reconnection fails.
r N)r� �kindr z!Can not reconnect to MySQL after z
attempt(s): )rS Z
start_spanr, r3 ZSpanKindZCLIENTr@ rA � is_connectedr' �IOErrorr( r r/ r2 r1 r0 rT )r~ rB rC �counter�spanr� �msgZ
interface_errrG rG rH � reconnecto s@ ���
z!MySQLConnectionAbstract.reconnectc C s dS )a Reports whether the connection to MySQL Server is available or not.
Checks whether the connection to MySQL is available using the `ping()` method,
but unlike `ping()`, `is_connected()` returns `True` when the connection is
available, `False` otherwise
NrG r} rG rG rH rE � s z$MySQLConnectionAbstract.is_connectedF)rJ rB rC rL c C s dS )a� Checks availability of the MySQL server.
When reconnect is set to `True`, one or more attempts are made to try
to reconnect to the MySQL server using the reconnect()-method.
`delay` is the number of seconds to wait between each retry.
When the connection is not available, an InterfaceError is raised.
Args:
reconnect: If True, one or more `attempts` are made to try to reconnect
to the MySQL server, and these options are forwarded to the
`reconnect()` method.
attempts: Number of attempts to make when reconnecting.
delay: Use it (defined in seconds) if you want to wait between each retry.
Raises:
InterfaceError: When the connection is not available. Use the
`is_connected()` method if you just want to check the
connection without raising an error.
NrG )r~ rJ rB rC rG rG rH �ping� s z MySQLConnectionAbstract.pingc C s dS )a� Commits current transaction.
This method is part of PEP 249 - Python Database API Specification v2.0.
This method sends a COMMIT statement to the MySQL server, committing the
current transaction. Since by default Connector/Python does not autocommit.
It is important to call this method after every transaction that modifies
data for tables that use transactional storage engines.
Examples:
```
>>> stmt = "INSERT INTO employees (first_name) VALUES (%s), (%s)"
>>> cursor.execute(stmt, ('Jane', 'Mary'))
>>> cnx.commit()
```
NrG r} rG rG rH �commit� s z MySQLConnectionAbstract.commitzOptional[bool]z%Optional[Type['MySQLCursorAbstract']]z'MySQLCursorAbstract')�buffered�raw�prepared� cursor_class�
dictionary� named_tuplerL c C s dS )a� Instantiates and returns a cursor.
By default, `MySQLCursor` or `CMySQLCursor` is returned. Depending on the
options while connecting, a buffered and/or raw cursor is instantiated
instead. Also depending upon the cursor options, rows can be returned as
dictionary or named tuple.
Dictionary and namedtuple based cursors are available with buffered output
but not raw.
It is possible to also give a custom cursor through the `cursor_class`
parameter, but it needs to be a subclass of `mysql.connector.cursor.CursorBase`
or `mysql.connector.cursor_cext.CMySQLCursor` according to the type of
connection that's being used.
Args:
buffered: If `True`, the cursor fetches all rows from the server after an
operation is executed. This is useful when queries return small
result sets.
raw: If `True`, the cursor skips the conversion from MySQL data types to
Python types when fetching rows. A raw cursor is usually used to get
better performance or when you want to do the conversion yourself.
prepared: If `True`, the cursor is used for executing prepared statements.
cursor_class: It can be used to pass a class to use for instantiating a
new cursor. It must be a subclass of `cursor.CursorBase` or
`cursor_cext.CMySQLCursor` according to the type of connection
that's being used.
dictionary: If `True`, the cursor returns rows as dictionaries.
named_tuple: If `True`, the cursor returns rows as named tuples.
Returns:
cursor: A cursor object.
Raises:
ProgrammingError: When `cursor_class` is not a subclass of
`MySQLCursorAbstract`.
ValueError: When cursor is not available.
NrG )r~ rM rN rO rP rQ rR rG rG rH �cursor� s
z MySQLConnectionAbstract.cursorc C s dS )zExecutes a query.NrG r% rG rG rH r5 s z&MySQLConnectionAbstract._execute_queryc C s dS )a Rollbacks current transaction.
Sends a ROLLBACK statement to the MySQL server, undoing all data changes
from the current transaction. By default, Connector/Python does not
autocommit, so it is possible to cancel transactions when using
transactional storage engines such as `InnoDB`.
Examples:
```
>>> stmt = "INSERT INTO employees (first_name) VALUES (%s), (%s)"
>>> cursor.execute(stmt, ('Jane', 'Mary'))
>>> cnx.rollback()
```
NrG r} rG rG rH �rollback s z MySQLConnectionAbstract.rollback)�consistent_snapshot�isolation_level�readonlyrL c C s� | j rtd��|rV|�� �dd��� }g d�}||vrFtd|� d���| �d|� �� |dur�| jd k rztd
| j� d ���|r�d }nd
}| �d|� �� d}|r�|d7 }| �|� dS )an Starts a transaction.
This method explicitly starts a transaction sending the
START TRANSACTION statement to the MySQL server. You can optionally
set whether there should be a consistent snapshot, which
isolation level you need or which access mode i.e. READ ONLY or
READ WRITE.
Args:
consistent_snapshot: If `True`, Connector/Python sends WITH CONSISTENT
SNAPSHOT with the statement. MySQL ignores this for
isolation levels for which that option does not apply.
isolation_level: Permitted values are 'READ UNCOMMITTED', 'READ COMMITTED',
'REPEATABLE READ', and 'SERIALIZABLE'. If the value is
`None`, no isolation level is sent, so the default level
applies.
readonly: Can be `True` to start the transaction in READ ONLY mode or
`False` to start it in READ WRITE mode. If readonly is omitted,
the server's default access mode is used.
Raises:
ProgrammingError: When a transaction is already in progress
and when `ValueError` when `isolation_level`
specifies an Unknown level.
Examples:
For example, to start a transaction with isolation level `SERIALIZABLE`,
you would do the following:
```
>>> cnx = mysql.connector.connect(...)
>>> cnx.start_transaction(isolation_level='SERIALIZABLE')
```
z Transaction already in progressr� � )zREAD UNCOMMITTEDzREAD COMMITTEDzREPEATABLE READZ SERIALIZABLEzUnknown isolation level "�"z SET TRANSACTION ISOLATION LEVEL N)� � rZ zMySQL server version z does not support this featurez READ ONLYz
READ WRITEzSET TRANSACTION zSTART TRANSACTIONz WITH CONSISTENT SNAPSHOT) r r+ r� r� r� r� r5 r[ r� )r~ rU rV rW �level�levelsZ access_moder$ rG rG rH �start_transaction s* '
�z)MySQLConnectionAbstract.start_transactionzOptional[Dict[str, Any]])�user_variables�session_variablesrL c C s� | � � std��z | �� W n> ttfyZ | jr>td�d�| �| j| j| j | j
� Y n0 |sd|r�| � � }|r�|� � D ] \}}|�
d|� d|� �� qx|r�|� � D ] \}}|�
d|� d|� �� q�|�� dS )a� Clears the current active session.
This method resets the session state, if the MySQL server is 5.7.3
or later active session will be reset without re-authenticating.
For other server versions session will be reset by re-authenticating.
It is possible to provide a sequence of variables and their values to
be set after clearing the session. This is possible for both user
defined variables and session variables.
Args:
user_variables: User variables map.
session_variables: System variables map.
Raises:
OperationalError: If not connected.
InternalError: If there are unread results and InterfaceError on errors.
Examples:
```
>>> user_variables = {'var1': '1', 'var2': '10'}
>>> session_variables = {'wait_timeout': 100000, 'sql_mode': 'TRADITIONAL'}
>>> cnx.reset_session(user_variables, session_variables)
```
z MySQL Connection not availablezYReset session is not supported with compression for MySQL server version 5.7.2 or earlierNzSET @`z` = z
SET SESSION `)rE r* �cmd_reset_connectionr) r ry �cmd_change_userr^ r_ ra rW rS r� �executer� )r~ r_ r` �curr� r� rG rG rH �
reset_sessionj s4 ���
z%MySQLConnectionAbstract.reset_sessionz Optional[Type[MySQLConverter]])� convclassrL c C sL |r@t |t�r@| j�| j�d }|| _||| j�| _| j| j_ nt
d��dS )z�
Sets the converter class to be used.
Args:
convclass: Should be a class overloading methods and members of
`conversion.MySQLConverter`.
r zFConverter class should be a subclass of conversion.MySQLConverterBase.N) �
issubclassr% r| r- rW rw ri rv rx Z str_fallbackr� )r~ rf r8 rG rG rH r� � s �z+MySQLConnectionAbstract.set_converter_class� Optional[List[DescriptionType]]zOptional[CMySQLPrepStmt]z2Tuple[Optional[RowType], Optional[Dict[str, Any]]])r/ �columnsrN � prep_stmtrL c C s dS )a� Retrieves the next row of a query result set.
Args:
binary: If `True`, read as binary result (only meaningful for pure Python
connections).
columns: Field types (only meaningful for pure Python connections and when
`binary=True`).
raw: If `True`, the converter class does not convert the parsed values.
prep_stmt: Prepared statement object (only meaningful for
C-ext connections).
Returns:
tuple: The row as a tuple (RowType) containing byte objects, or `None` when
no more rows are available. (at position 0). EOF packet
information as a dictionary containing `status_flag` and
`warning_count` (at position 1).
Raises:
InterfaceError: When all rows have been retrieved.
NrG )r~ r/ ri rN rj rG rG rH �get_row� s z MySQLConnectionAbstract.get_rowz.Tuple[List[RowType], Optional[Dict[str, Any]]])�countr/ ri rN rj rL c C s dS )a Gets all rows returned by the MySQL server.
Args:
count: Used to obtain a given number of rows. If set to `None`, all
rows are fetched.
binary: If `True`, read as binary result (only meaningful for pure Python
connections).
columns: Field types (only meaningful for pure Python connections and when
`binary=True`).
raw: If `True`, the converter class does not convert the parsed values.
prep_stmt: Prepared statement object (only meaningful for
C-ext connections).
Returns:
tuple: A list of tuples (RowType) containing the row data as byte objects,
or an empty list when no rows are available (at position 0).
EOF packet information as a dictionary containing `status_flag`
and `warning_count` (at position 1).
Raises:
InterfaceError: When all rows have been retrieved.
NrG )r~ rl r/ ri rN rj rG rG rH �get_rows� s z MySQLConnectionAbstract.get_rows)r� rL c C s dS )a� Changes the current database.
This method makes specified database the default (current) database.
In subsequent queries, this database is the default for table references
that include no explicit database qualifier.
Args:
database: Database to become the default (current) database.
Returns:
ok_packet: Dictionary containing the OK packet information.
NrG )r~ r� rG rG rH � cmd_init_db� s z#MySQLConnectionAbstract.cmd_init_db)r$ rN rM �
raw_as_stringrL c C s dS )a Sends a query to the MySQL server.
This method sends the query to the MySQL server and returns the result. To send
multiple statements, use the `cmd_query_iter()` method instead.
The returned dictionary contains information depending on what kind of query
was executed. If the query is a `SELECT` statement, the result contains
information about columns. Other statements return a dictionary containing
OK or EOF packet information.
Errors received from the MySQL server are raised as exceptions.
Arguments `raw`, `buffered` and `raw_as_string` are only meaningful
for `C-ext` connections.
Args:
query: Statement to be executed.
raw: If `True`, the cursor skips the conversion from MySQL data types to
Python types when fetching rows. A raw cursor is usually used to get
better performance or when you want to do the conversion yourself. If
not provided, take its value from the MySQL instance.
buffered: If `True`, the cursor fetches all rows from the server after an
operation is executed. This is useful when queries return small
result sets.
raw_as_string: Is a special argument for Python v2 and returns `str`
instead of `bytearray`.
Returns:
dictionary: `Result` or `OK packet` information
Raises:
InterfaceError: When multiple results are found.
NrG )r~ r$ rN rM ro rG rG rH r� s z!MySQLConnectionAbstract.cmd_queryz(Generator[Mapping[str, Any], None, None])�
statementsrL c C s dS )aZ Sends one or more statements to the MySQL server.
Similar to the `cmd_query()` method, but instead returns a generator
object to iterate through results. It sends the statements to the
MySQL server and through the iterator you can get the results.
Use `cmd_query_iter()` when sending multiple statements, and separate
the statements with semicolons.
Args:
statements: Statements to be executed separated with semicolons.
Returns:
generator: Generator object with `Result` or `OK packet` information.
Examples:
The following example shows how to iterate through the results after
sending multiple statements:
```
>>> statement = 'SELECT 1; INSERT INTO t1 VALUES (); SELECT 2'
>>> for result in cnx.cmd_query_iter(statement):
>>> if 'columns' in result:
>>> columns = result['columns']
>>> rows = cnx.get_rows()
>>> else:
>>> # do something useful with INSERT result
```
NrG )r~ rp rG rG rH �cmd_query_iter, s z&MySQLConnectionAbstract.cmd_query_iter)�optionsrL c C s dS )a� Sends the Refresh command to the MySQL server.
`WARNING: This MySQL Server functionality is deprecated.`
This method flushes tables or caches, or resets replication server
information. The connected user must have the RELOAD privilege.
The options argument should be a bitmask value constructed using
constants from the `constants.RefreshOption` class.
The result is a dictionary with the OK packet information.
Args:
options: Bitmask value constructed using constants from
the `constants.RefreshOption` class.
Returns:
dictionary: OK packet information.
Examples:
```
>>> from mysql.connector import RefreshOption
>>> refresh = RefreshOption.LOG | RefreshOption.THREADS
>>> cnx.cmd_refresh(refresh)
```
NrG )r~ rr rG rG rH � cmd_refreshM s z#MySQLConnectionAbstract.cmd_refreshzOptional[bytes]c C s dS )a� Closes the current connection with the server.
This method sends the `QUIT` command to the MySQL server, closing the
current connection. Since there is no response from the MySQL server,
the packet that was sent is returned.
Returns:
packet_sent: `None` when using a C-ext connection,
else the actual packet that was sent.
NrG r} rG rG rH �cmd_quitj s z MySQLConnectionAbstract.cmd_quit)�
shutdown_typerL c C s dS )z�Shuts down the MySQL Server.
This method sends the SHUTDOWN command to the MySQL server.
The `shutdown_type` is not used, and it's kept for backward compatibility.
NrG )r~ ru rG rG rH � cmd_shutdownw s z$MySQLConnectionAbstract.cmd_shutdownc C s dS )a Sends the statistics command to the MySQL Server.
Returns:
dict: Stats packet information about the MySQL server including uptime
in seconds and the number of running threads, questions, reloads, and
open tables.
NrG r} rG rG rH �cmd_statistics s z&MySQLConnectionAbstract.cmd_statisticsc C s t d��dS )a| Get the process list of the MySQL Server.
This method is a placeholder to notify that the PROCESS_INFO command
is not supported by raising the `NotSupportedError`.
The command
"SHOW PROCESSLIST" should be send using the cmd_query()-method or
using the `INFORMATION_SCHEMA` database.
Raises `NotSupportedError` exception.
z;Not implemented. Use SHOW PROCESSLIST or INFORMATION_SCHEMAN)r) rG rG rG rH �cmd_process_info� s
�z(MySQLConnectionAbstract.cmd_process_info)� mysql_pidrL c C s dS )a Kills a MySQL process.
Asks the server to kill the thread specified by `mysql_pid`. Although
still available, it is better to use the KILL SQL statement.
Args:
mysql_pid: Process ID to be killed.
Returns:
ok_packet: Dictionary containing the OK packet information.
Examples:
```
>>> cnx.cmd_process_kill(123) # using cmd_process_kill()
>>> cnx.cmd_query('KILL 123') # alternatively (recommended)
```
NrG )r~ ry rG rG rH �cmd_process_kill� s z(MySQLConnectionAbstract.cmd_process_killc C s dS )z�Instructs the server to write debugging information to the error log.
The connected user must have the `SUPER` privilege.
Returns:
ok_packet: Dictionary containing the EOF (end-of-file) packet information.
NrG r} rG rG rH � cmd_debug� s z!MySQLConnectionAbstract.cmd_debugc C s dS )z�Checks whether the connection to the server is working.
This method is not to be used directly. Use `ping()` or
`is_connected()` instead.
Returns:
ok_packet: Dictionary containing the OK packet information.
NrG r} rG rG rH �cmd_ping� s z MySQLConnectionAbstract.cmd_pingrN rM )
r� r� r� r. � password1� password2� password3�oci_config_file�oci_config_profilerL c
C s dS )a Changes the current logged in user.
It also causes the specified database to become the default (current)
database. It is also possible to change the character set using the
charset argument.
Args:
username: New account's username.
password: New account's password.
database: Database to become the default (current) database.
charset: Client charset (see [1]), only the lower 8-bits.
password1: New account's password factor 1 - it's used instead
of `password` if set (higher precedence).
password2: New account's password factor 2.
password3: New account's password factor 3.
oci_config_file: OCI configuration file location (path-like string).
oci_config_profile: OCI configuration profile location (path-like string).
Returns:
ok_packet: Dictionary containing the OK packet information.
Examples:
```
>>> cnx.cmd_change_user(username='', password='', database='', charset=33)
```
References:
[1]: https://dev.mysql.com/doc/dev/mysql-server/latest/ page_protocol_basic_character_set.html#a_protocol_character_set
NrG )
r~ r� r� r� r. r} r~ r r� r� rG rG rH rb � s
z'MySQLConnectionAbstract.cmd_change_userr z(Union[Mapping[str, Any], CMySQLPrepStmt])� statementrL c C s dS )a% Prepares a MySQL statement.
Args:
statement: statement to prepare.
Returns:
prepared_stmt: A `Prepared Statement` structure - a dictionary
is returned when using a pure Python connection, and a
`_mysql_connector.MySQLPrepStmt` object is returned when
using a C-ext connection.
References:
[1]: https://dev.mysql.com/doc/dev/mysql-server/latest/
page_protocol_com_stmt_prepare.html
NrG )r~ r� rG rG rH �cmd_stmt_prepare� s z(MySQLConnectionAbstract.cmd_stmt_preparerG zUnion[int, CMySQLPrepStmt]z Sequence[BinaryProtocolType]r z&Optional[Union[Dict[str, Any], Tuple]])� statement_id�datar r rL c C s dS )aF Executes a prepared MySQL statement.
Args:
statement_id: Statement ID found in the dictionary returned by
`MySQLConnection.cmd_stmt_prepare` when using a pure Python
connection, or a `_mysql_connector.MySQLPrepStmt` instance
as returned by `CMySQLConnection.cmd_stmt_prepare` when
using a C-ext connection.
data: Data sequence against which the prepared statement will be executed.
parameters: Currently unused!
flags: see [1].
Returns:
dictionary or tuple: `OK packet` or `Result` information.
Notes:
The previous method's signature applies to pure Python, the C-ext has
the following signature:
```
def cmd_stmt_execute(
self, statement_id: CMySQLPrepStmt, *args: Any
) -> Optional[Union[Dict[str, Any], Tuple]]:
```
You should expect a similar returned value type, however, the input
is different. In this case `data` must be provided as positional
arguments instead of a sequence.
References:
[1]: https://dev.mysql.com/doc/dev/mysql-server/latest/ page_protocol_com_stmt_execute.html
NrG )r~ r� r� r r rG rG rH �cmd_stmt_execute s z(MySQLConnectionAbstract.cmd_stmt_execute)r� rL c C s dS )a� Deallocates a prepared MySQL statement.
Args:
statement_id: Statement ID found in the dictionary returned by
`MySQLConnection.cmd_stmt_prepare` when using a pure Python
connection, or a `_mysql_connector.MySQLPrepStmt` instance
as returned by `CMySQLConnection.cmd_stmt_prepare` when
using a C-ext connection.
NrG �r~ r� rG rG rH �cmd_stmt_close- s z&MySQLConnectionAbstract.cmd_stmt_closer )r� �param_idr� rL c C s dS )a? Sends data for a column.
Currently, not implemented for the C-ext.
Args:
statement_id: Statement ID found in the dictionary returned by
`MySQLConnection.cmd_stmt_prepare` when using a pure Python
connection, or a `_mysql_connector.MySQLPrepStmt` instance
as returned by `CMySQLConnection.cmd_stmt_prepare` when
using a C-ext connection.
param_id: The parameter to supply data to [1].
data: The actual payload to send [1].
Returns:
total_sent: The total number of bytes that were sent is returned.
References:
[1]: https://dev.mysql.com/doc/dev/mysql-server/latest/ page_protocol_com_stmt_send_long_data.html
NrG )r~ r� r� r� rG rG rH �cmd_stmt_send_long_data9 s z/MySQLConnectionAbstract.cmd_stmt_send_long_datac C s dS )a� Resets data for prepared statement sent as long data.
Args:
statement_id: Statement ID found in the dictionary returned by
`MySQLConnection.cmd_stmt_prepare` when using a pure Python
connection, or a `_mysql_connector.MySQLPrepStmt` instance
as returned by `CMySQLConnection.cmd_stmt_prepare` when
using a C-ext connection.
NrG r� rG rG rH �cmd_stmt_resetR s z&MySQLConnectionAbstract.cmd_stmt_resetc C s dS )aN Resets the session state without re-authenticating.
Reset command only works on MySQL server 5.7.3 or later.
This method permits the session state to be cleared without reauthenticating.
For MySQL servers older than 5.7.3 (when `COM_RESET_CONNECTION` was introduced)
, the `reset_session()` method can be used instead - that method resets the
session state by reauthenticating, which is more expensive.
This method was added in Connector/Python 1.2.1.
Returns:
`True` for a successful reset otherwise `False`.
NrG r} rG rG rH ra ^ s z,MySQLConnectionAbstract.cmd_reset_connection)r )NN)T)NN)r r )Fr r )NNNNNN)FNN)NN)FNNN)NFNNN)FFF)N) rN rN rN rM rN rN rN rN rN )rG rG r )XrC rD rE rF r r� r� r� �propertyr� r� r� r� r� r� r� r� r� r� r� r� r r� �setterr� r� r� r� � staticmethodr� r r r r r� r r r" r# r! r� r& r' r� r� r+ r. r2 r9 r3 r< r= r> r? r@ r� �__annotations__rA rJ rE rK rL rS r5 rT r^ re r� rk rm rn r� rq rs rt rv rw rx rz r{ r| rb r� r� r� r� r� ra rG rG rG rH rI � s�
C
_Q . �" ( �
�J
66 � 0 �L �: � � �)
�$+ �) rI c @ s� e Zd ZdZdd�dd�Zd d�dd�Zdd d
dd �d d
�ZedZdddd�dd��Zedd�dd��Z ed[ddddd�d d ��Z
edd dd �d d!��Z ed"d�d#d$��Z ed\d&d'd(�d)d*��Z
ed'd�d+d,��Zed-d�d.d/��Zd0d�d1d2�Zd3d0d4�d5d6�Zd]d3d3d0d8�d9d:�Zd^ddd<�d=d>�Zeed?d�d@dA���Zeed&d�dBdC���ZedDd�dEdF��ZedGd�dHdI��Zed&d�dJdK��ZdGd�dLdM�ZdNd�dOdP�ZddQddR�dSdT�Z ddQdU�dVdW�Z dd�dXdY�Z d7S )_�MySQLCursorAbstractz�Abstract cursor class
Abstract class defining cursor class with method and members
required by the Python Database API Specification v2.0.
rJ rK c C s: d| _ d| _d| _d| _d| _d| _g | _g | _d| _dS )ZInitializationNr� r r ) � _description� _rowcount�_last_insert_id� _warnings�_warning_countZ _executedZ_executed_listZ_stored_resultsZ arraysizer} rG rG rH r w s z MySQLCursorAbstract.__init__c C s | S r� rG r} rG rG rH r� � s z MySQLCursorAbstract.__enter__r� r� r r� c C s | � � d S r� r� r� rG rG rH r� � s z MySQLCursorAbstract.__exit__rG r� r z0Optional[Union[Dict[str, RowItemType], RowType]])�procname�argsrL c C s dS )a� Calls a stored procedure with the given arguments.
The arguments will be set during this session, meaning they will be called like
_<procname>__arg<nr> where <nr> is an enumeration (+1) of the arguments.
Args:
procname: The stored procedure name.
args: Sequence of parameters - it must contain one entry for each argument
that the procedure expects.
Returns:
Does not return a value, but a result set will be available when the
CALL-statement executes successfully.
`callproc()` returns a modified copy of the input sequence. `Input`
parameters are left untouched. `Output` and `input/output` parameters may
be replaced with new values.
Result sets produced by the stored procedure are automatically fetched and
stored as `MySQLCursorBuffered` instances.
The value returned (if any) is a `Dict` when cursor's subclass is
`MySQLCursorDict`, else a `Tuple` (RowType).
Raises:
InterfaceError: When something is wrong
Examples:
1) Defining the Stored Routine in MySQL:
```
CREATE PROCEDURE multiply(IN pFac1 INT, IN pFac2 INT, OUT pProd INT)
BEGIN
SET pProd := pFac1 * pFac2;
END;
```
2) Executing in Python:
```
>>> args = (5, 6, 0) # 0 is to hold value of the OUT parameter pProd
>>> cursor.callproc('multiply', args)
('5', '6', 30L)
```
References:
[1]: https://dev.mysql.com/doc/connector-python/en/ connector-python-api-mysqlcursor-callproc.html
NrG )r~ r� r� rG rG rH �callproc� s z MySQLCursorAbstract.callprocc C s dS )a= Close the cursor.
Use close() when you are done using a cursor. This method closes the cursor,
resets all results, and ensures that the cursor object has no reference to its
original connection object.
This method is part of PEP 249 - Python Database API Specification v2.0.
NrG r} rG rG rH r� � s zMySQLCursorAbstract.closeFzFUnion[Sequence[MySQLConvertibleType], Dict[str, MySQLConvertibleType]]r� z4Optional[Generator[MySQLCursorAbstract, None, None]])� operation�params�multirL c C s dS )aZ Executes the given operation substituting any markers with the given parameters.
For example, getting all rows where id is 5:
```
>>> cursor.execute("SELECT * FROM t1 WHERE id = %s", (5,))
```
The `multi` argument should be set to `True` when executing multiple
statements in one operation.
If warnings were generated, and `connection.get_warnings` is `True`, then
`self.warnings` will be a list containing these warnings.
Args:
operation: Operation to be executed.
params: The parameters found in the tuple or dictionary params are bound
to the variables in the operation. Specify variables using `%s` or
`%(name)s` parameter style (that is, using format or pyformat style).
multi: If `multi` is set to `True`, `execute()` is able to execute multiple
statements specified in the operation string.
Returns:
An iterator when `multi` is `True`, otherwise `None`.
Raises:
InterfaceError: If `multi` is not set and multiple results are found.
Examples:
The following example selects and inserts data in a single `execute()`
operation and displays the result of each statement:
```
>>> operation = 'SELECT 1; INSERT INTO t1 VALUES (); SELECT 2'
>>> for result in cursor.execute(operation, multi=True):
>>> if result.with_rows:
>>> print("Rows produced by statement '{}':".format(
>>> result.statement))
>>> print(result.fetchall())
>>> else:
>>> print("Number of rows affected by statement '{}': {}".format(
>>> result.statement, result.rowcount))
```
NrG )r~ r� r� r� rG rG rH rc � s zMySQLCursorAbstract.executezPSequence[Union[Sequence[MySQLConvertibleType], Dict[str, MySQLConvertibleType]]])r� �
seq_paramsrL c C s dS )a� Executes the given operation multiple times.
The `executemany()` method will execute the operation iterating
over the list of parameters in `seq_params`.
`INSERT` statements are optimized by batching the data, that is
using the MySQL multiple rows syntax.
Args:
operation: Operation to be executed.
seq_params: Parameters to be used when executing the operation.
Returns:
Results are discarded. If they are needed, consider looping over data
using the `execute()` method.
Examples:
An optimization is applied for inserts: The data values given by the
parameter sequences are batched using multiple-row syntax. The following
example inserts three records:
```
>>> data = [
>>> ('Jane', date(2005, 2, 12)),
>>> ('Joe', date(2006, 5, 23)),
>>> ('John', date(2010, 10, 3)),
>>> ]
>>> stmt = "INSERT INTO employees (first_name, hire_date) VALUES (%s, %s)"
>>> cursor.executemany(stmt, data)
```
For the preceding example, the INSERT statement sent to MySQL is:
```
>>> INSERT INTO employees (first_name, hire_date)
>>> VALUES ('Jane', '2005-02-12'), ('Joe', '2006-05-23'), ('John', '2010-10-03')
```
NrG )r~ r� r� rG rG rH � executemany s z MySQLCursorAbstract.executemanyz0Optional[Union[RowType, Dict[str, RowItemType]]]c C s dS )a Retrieves next row of a query result set
Returns:
If the cursor's subclass is `MySQLCursorDict`, a dictionaries is
returned, otherwise a tuple (RowType). `None` is returned when there aren't
results to be read.
Examples:
```
>>> cursor.execute("SELECT * FROM employees")
>>> row = cursor.fetchone()
>>> while row is not None:
>>> print(row)
>>> row = cursor.fetchone()
```
NrG r} rG rG rH �fetchone0 s z MySQLCursorAbstract.fetchoner r� z,List[Union[RowType, Dict[str, RowItemType]]])�sizerL c C s dS )a� Fetches the next set of rows of a query result.
Args:
size: The number of rows returned can be specified using the size
argument, which is one by default.
Returns:
If the cursor's subclass is `MySQLCursorDict`, a list of dictionaries is
returned, otherwise a list of tuples (RowType). When no more rows are
available, it returns an empty list.
NrG )r~ r� rG rG rH � fetchmanyC s z MySQLCursorAbstract.fetchmanyc C s dS )a� Fetches all (or all remaining) rows of a query result set.
Returns:
If the cursor's subclass is `MySQLCursorDict`, a list of dictionaries is
returned, otherwise a list of tuples (RowType).
Examples:
```
>>> cursor.execute("SELECT * FROM employees ORDER BY emp_no")
>>> head_rows = cursor.fetchmany(size=2)
>>> remaining_rows = cursor.fetchall()
```
NrG r} rG rG rH �fetchallQ s z MySQLCursorAbstract.fetchallz Iterator[MySQLCursorAbstract]c C s dS )a Returns an iterator (of MySQLCursorAbstract subclass instances) for stored results.
This method returns an iterator over results which are stored when
callproc() is called. The iterator will provide `MySQLCursorBuffered`
instances.
Examples:
```
>>> cursor.callproc('myproc')
()
>>> for result in cursor.stored_results():
... print result.fetchall()
...
[(1,)]
[(2,)]
```
NrG r} rG rG rH �stored_resultsa s z"MySQLCursorAbstract.stored_resultsr c C s dS �zNot Implemented.NrG r} rG rG rH �nextsetu s zMySQLCursorAbstract.nextsetr
)�sizesrL c C s dS r� rG )r~ r� rG rG rH �
setinputsizesx s z!MySQLCursorAbstract.setinputsizesN)r� �columnrL c C s dS r� rG )r~ r� r� rG rG rH �
setoutputsize{ s z!MySQLCursorAbstract.setoutputsizeT)�freerL c C s dS )z Resets the cursor to defaultNrG )r~ r� rG rG rH �reset~ s zMySQLCursorAbstract.resetrh c C s | j S )a^ This read-only property returns a list of tuples describing the columns in a
result set.
A tuple is described as follows::
```
(column_name,
type,
None,
None,
None,
None,
null_ok,
column_flags) # Addition to PEP-249 specs
```
See [1] for more details and examples.
Returns:
A list of tuples.
References:
[1]: https://dev.mysql.com/doc/connector-python/en/ connector-python-api-mysqlcursor-description.html
)r� r} rG rG rH � description� s z MySQLCursorAbstract.descriptionc C s | j S )a Returns the number of rows produced or affected.
This property returns the number of rows produced by queries
such as `SELECT`, or affected rows when executing DML statements
like `INSERT` or `UPDATE`.
Note that for non-buffered cursors it is impossible to know the
number of rows produced before having fetched them all. For those,
the number of rows will be -1 right after execution, and
incremented when fetching rows.
Returns an integer.
)r� r} rG rG rH �rowcount� s z MySQLCursorAbstract.rowcountr; c C s | j S )a Returns the value generated for an AUTO_INCREMENT column.
Returns the value generated for an AUTO_INCREMENT column by
the previous INSERT or UPDATE statement or `None` when there is
no such a value available.
Returns a long value or `None`.
)r� r} rG rG rH � lastrowid� s
z MySQLCursorAbstract.lastrowidzOptional[List[WarningType]]c C s | j S )a� Returns a list of tuples (WarningType) containing warnings generated
by the previously executed operation.
Examples:
```
>>> cnx.get_warnings = True
>>> cursor.execute("SELECT 'a'+1")
>>> cursor.fetchall()
[(1.0,)]
>>> cursor.warnings
[(u'Warning', 1292, u"Truncated incorrect DOUBLE value: 'a'")]
```
�r� r} rG rG rH �warnings� s z MySQLCursorAbstract.warningsc C s | j S )z�Returns the number of warnings.
This property returns the number of warnings generated by the
previously executed operation.
Returns an integer value.
)r� r} rG rG rH �
warning_count� s z!MySQLCursorAbstract.warning_countc C s | j S )a� Returns a list of tuples (WarningType) containing warnings generated by
the previously executed operation.
Examples:
```
>>> cnx.get_warnings = True
>>> cursor.execute("SELECT 'a'+1")
>>> cursor.fetchall()
[(1.0,)]
>>> cursor.fetchwarnings()
[(u'Warning', 1292, u"Truncated incorrect DOUBLE value: 'a'")]
```
r� r} rG rG rH �
fetchwarnings� s z!MySQLCursorAbstract.fetchwarningsz.Optional[List[Tuple[str, BinaryProtocolType]]]c C s( t | d�r| jjS t | d�r$| jjS dS )z�Gets a list of query attributes from the connector's side.
Returns:
List of existing query attributes.
�_cnx� _connectionN)�hasattrr� r� r� r} rG rG rH �get_attributes� s
z"MySQLCursorAbstract.get_attributesr7 )r� r� rL c C sn t |t�std��|dur4t |t�s4td|� d���t| d�rP| j�||f� nt| d�rj| j�||f� dS )a Adds a query attribute and its value into the connector's query attributes list.
Query attributes must be enabled on the server - they are disabled by default. A
warning is logged when setting query attributes for a server connection
that does not support them.
Args:
name: Key name used to identify the attribute.
value: A value converted to the MySQL Binary Protocol.
Raises:
ProgrammingError: If the value's conversion fails.
�&Parameter `name` must be a string typeNzObject z$ cannot be converted to a MySQL typer� r� )r� r� r+ �MYSQL_PY_TYPESr� r� r� r� )r~ r� r� rG rG rH �
add_attribute� s
�
z!MySQLCursorAbstract.add_attributer� c C sB t |t�std��t| d�r(| j�|�S t| d�r>| j�|�S dS )a, Removes a query attribute by name from the connector's query attributes list.
If no match, `None` is returned, else the corresponding value is returned.
Args:
name: Key name used to identify the attribute.
Returns:
value: Attribute's value.
r� r� r� N)r� r� r+ r� r� r� r� r� rG rG rH �remove_attribute
s
z$MySQLCursorAbstract.remove_attributec C s. t | d�r| j�� nt | d�r*| j�� dS )z<Clears the list of query attributes on the connector's side.r� r� N)r� r� r� r� r} rG rG rH �clear_attributes
s
z$MySQLCursorAbstract.clear_attributes)rG )rG F)r )N)T) rC rD rE rF r r� r� r r� r� rc r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� rG rG rG rH r� p sX �3
�4-
r� )drF �
__future__r r� r �weakref�abcr r r r r r �decimalr �inspectr
r �typesr �typingr
r r r r r r r r r r r r r r� �sslr� r � ImportError� constantsr r r r r! r" r# �
conversionr$ r% �errorsr& r' r( r) r* r+ Zopentelemetry.constantsr, r- r. r/ Z opentelemetry.instrumentationr0 r1 r2 r3 Z optionfilesr4 Z tls_ciphersr5 r6 r7 r8 r9 r: r; r< r= r> �utilsr? r@ �WeakValueDictionaryrA r� r� r� r� r� r� r �floatr� r� r� rB rI r� rG rG rG rH �<module> s� @ $ (
������
U