?????????? ????????? - ??????????????? - /home/agenciai/.local/lib/python3.9/site-packages/mysql/connector/__pycache__/abstracts.cpython-39.pyc
???????
a ��JhQ� � @ sj 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"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/m0Z0m1Z1m2Z2m3Z3m4Z4m5Z5 ddl6m7Z7m8Z8 ddl9m:Z:m;Z;m<Z<m=Z=m>Z>m?Z? ddl@mAZAmBZBmCZCmDZD eD�r�ddlEmFZFmGZGmHZHmIZI ddlJmKZK ddlLmMZM ddlNmOZOmPZP ddlmQZQmRZRmSZSmTZTmUZUmVZVmWZWmXZXmYZYmZZZm[Z[ ddl\m]Z]m^Z^ dZ_dZ`dZad Zbd Zcd Zdeeee e efegehe e f ZiG d d � d e]�ZjG d!d"� d"e�ZkG d#d$� d$e�ZldS )%z+Module gathering all abstract base classes.� )� annotationsN)�ABC�abstractmethod)�date�datetime�time� timedelta)�Decimal)� signature)�sleep)� TracebackType)�Any�BinaryIO�Callable�ClassVar�Deque�Dict� Generator�Iterator�List�Mapping�NoReturn�Optional�Sequence�Tuple�Type�Union�castF� HAS_TLSv1_3T� ) � CONN_ATTRS_DN�DEFAULT_CONFIGURATION�DEPRECATED_METHOD_WARNING�MYSQL_DEFAULT_CHARSET_ID_57�MYSQL_DEFAULT_CHARSET_ID_80�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)� deprecated)�read_option_files)� UNACCEPTABLE_TLS_CIPHERSUITES�UNACCEPTABLE_TLS_VERSIONS) �BinaryProtocolType�CextEofPacketType�DescriptionType� EofPacketType� HandShakeType�MySQLConvertibleType�MySQLScriptPartition� RowItemType�RowType� StrOrBytes� WarningType)�GenericWrapper� import_objectzVThe '{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.z`Option "openid_token_file" {error}, it must be a string in the form "path/to/openid/token/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__� rP rP �N/home/agenciai/.local/lib/python3.9/site-packages/mysql/connector/abstracts.pyrK � s rK 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 �dd dAd+ddB�dCdD��Z e dEdFdG�dHdI��Z e e j!dJdK��dLd�dMdN��Z"e e j!dOdK��d.d�dPdQ��Z#edLd�dRdS��Z$ed.d�dTdU��Z%eedd�dVdW���Z&e e j!dXdK��dYd+dZ�d[d\��Z'ed+d�d]d^��Z(e(jdYddZ�d_d^��Z(d`d�dadb�Z)d+ddc�ddde�Z*ed d�dfdg��Z+e+jd dd�dhdg��Z+ed d�didj��Z,e,jdkdd�dldj��Z,ed dmdn�dodp��Z-�dd.d.ddr�dsdt�Z.e e j!dudK���dddd�dwdx��Z/edd�dydz��Z0e0jeddd�d{dz���Z0edd�d|d}��Z1e1jddd�d~d}��Z1edd�dd���Z2e2jddd�d�d���Z2edd�d�d���Z3e3jddd�d�d���Z3edd�d�d���Z4e4jddd�d�d���Z4ed d�d�d���Z5ed d�d�d���Z6ed+d�d�d���Z7ed+d�d�d���Z8e8jd+dd�d�d���Z8ed d�d�d���Z9�dd�d.dd��d�d��Z:ed�d�d�d���Z;e;jd�dd��d�d���Z;ed�d�d�d���Z<e<jd�dd��d�d���Z<eed�d�d�d����Z=edd�d�d���Z>edd�d�d���Z?dd�d�d��Z@edd�d�d���ZAeAZBd�eCd�< d7dd;�d�d��ZD�dd+d+dd��d�d��ZEedd�d�d���ZFe�d dd+d+dd��d�d���ZGedd�d�d���ZHe�d d�d�d�d�d�d�d�d�d��d�d���ZIed ddn�d�d���ZJedd�d�d�ZK�d dd.d�ddÜd�dńZL�d d�d�ddǜd�dɄZMe e j!d�dK��d�dd̜d�d΄�ZNed�d�d�dЄ�ZOeOjd�dd̜d�dЄ�ZOe�d dd�d�d�d7d�d՜d�dׄ�ZPe�d!d�dd�d�d�d7d�dٜd�dۄ�ZQed d�dܜd�dބ�ZRe�d"d d�ddd7d�dߜd�d��ZSed d7d�d�d�d��ZTed+d�d�d�d��ZUed�d�d�d��ZVe�d#d�dd�d�d��ZWed�d�d�d��ZXe d`d�d�d��ZYed+d�d�d�d���ZZed�d�d�d���Z[ed�d�d�d���Z\e�d$d d d d�d d d d d d d�d�� d�d���Z]ed�d7�d �d��d�d��Z^e�d%�d�d�dd+d7�d�d ��d �d ��Z_e�dd7d�d ��d �d��Z`e�dd+�dd7d+�d��d�d��Zae�dd7d�d ��d�d��Zbedd��d�d��ZcdqS (& �MySQLConnectionAbstractz8Abstract class for classes connecting to a MySQL server.�None��returnc C s~ d| _ d| _d| _d| _t�� | _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| _"d| _#td | _$td | _%td | _&d| _'d| _(d| _)d| _*d| _+td | _,td | _-d| _.i | _/d| _0d| _1d| _2d| _3d| _4d| _5d| _6d| _7d| _8d| _9t:� | _;d| _<d| _=dS )Z InitializeNTF� z 127.0.0.1i� r � ssl_disabled�connect_timeout� read_timeout� write_timeout�allow_local_infile�allow_local_infile_in_path)>�$_MySQLConnectionAbstract__charset_id�_tracer�_spanZotel_context_propagationr) � get_default� _client_flags� _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�_openid_token_file� _use_unicode� _get_warnings�_raise_on_warningsZ_connection_timeout� _read_timeout�_write_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_setZ_local_infile_filenamesZ_query��selfrP rP rQ �__init__� s~ � �z MySQLConnectionAbstract.__init__c C s | S �NrP r� rP rP rQ � __enter__ s z!MySQLConnectionAbstract.__enter__�Type[BaseException]� BaseExceptionr ��exc_type� exc_value� tracebackrU c C s | � � d S r� ��close�r� r� r� r� rP rP rQ �__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`. rP r� rP rP rQ �get_self s z MySQLConnectionAbstract.get_self�boolc C s | j p| jduotjdkS )z)Returns `True` if is a secure connection.N�posix)r rn �os�namer� rP rP rQ � is_secure! s �z!MySQLConnectionAbstract.is_securec C s | j S )z Returns If have next result.)rz r� rP rP rQ �have_next_result( s z(MySQLConnectionAbstract.have_next_resultz$List[Tuple[str, BinaryProtocolType]]c C s t | j�� �S )z Returns query attributes list.)�listr~ �itemsr� rP rP rQ � query_attrs- s z#MySQLConnectionAbstract.query_attrsz Tuple[str, BinaryProtocolType])�valuerU 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�r~ )r� r� � attr_name� attr_valuerP rP rQ �query_attrs_append2 s z*MySQLConnectionAbstract.query_attrs_append�strr> �r� rU 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)r~ �pop�r� r� rP rP rQ �query_attrs_remove? s z*MySQLConnectionAbstract.query_attrs_removec C s i | _ dS )z5Clears query attributes list on the connector's side.Nr� r� rP rP rQ �query_attrs_clearI 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 rP rP )�.0�tls_csrP rP rQ � <listcomp>b � 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.�:)ro � isinstancer� � startswith�endswith�AttributeError�split�strip�upper�appendr� �set�getr' �sort�index�updater& �extendr% �DUPLICATED_IN_LIST_ERROR�formatr< �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_osslrP rP rQ �_validate_tls_ciphersuitesM 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� rV 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)ro r� r� r� r� r� r� r� r� r� r� �TLS_V1_3_SUPPORTED�TLS_VER_NO_SUPPORTEDr' r� r� r� r= r/ � TLS_VERSION_UNACCEPTABLE_ERROR�TLS_VERSION_ERROR)r� r� Z tls_versionZtls_versr� Zuse_tls_versionsZunacceptable_tls_versionsZinvalid_tls_versionsrP rP rQ �_validate_tls_versions� s� ��� � ��� ���� � ��z.MySQLConnectionAbstract._validate_tls_versionsc C s | j S )z6The user name used for connecting to the MySQL server.)rh r� rP rP rQ �user� s z MySQLConnectionAbstract.userc C s | j S )z MySQL server IP address or name.)rl r� rP rP rQ � server_host s z#MySQLConnectionAbstract.server_host�intc C s | j S )zMySQL server TCP/IP port.)rm r� rP rP rQ � server_port s z#MySQLConnectionAbstract.server_port� Optional[str]c C s | j S )z8The Unix socket file for connecting to the MySQL server.)rn r� rP rP rQ � unix_socket s z#MySQLConnectionAbstract.unix_socketc C s dS )zThe current database.NrP r� rP rP rQ �database s z MySQLConnectionAbstract.databasec C s | � d|� �� dS )zSets the current database.zUSE N)� cmd_query�r� r� rP rP rQ r� s c C s | j S )z#Returns whether to consume results.)r� r� rP rP rQ �can_consume_results s z+MySQLConnectionAbstract.can_consume_resultsc C s t |t�sJ �|| _dS )z Sets if can consume results.N)r� r� r� r� rP rP rQ r� s r c C s | j S )z'Returns the pool configuration version.�r� r� rP rP rQ �pool_config_version& s z+MySQLConnectionAbstract.pool_config_versionc C s || _ dS )z#Sets the pool configuration versionNr� r� rP rP rQ r� + s )�kwargsrU 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�rltj�| j�}|�rVtj�|��rVtj�|��rdtj�|��rltd ��| 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�rt d| j � d���z|d | _ W nB t �y< Y n0 t �yj } ztd�|�W Y d}~n d}~0 0 g d�}|D ]@\}}z ||v�r�|| ||< ||= W n t �y� Y n0 �qxd|v �s�d|v �r6z|d } |d= W n t �y� | j!} Y n0 z|d } |d= W n t �y( | j"} Y n0 | �#| | � d|v �rT|d �rT|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 ��rRd} | j,�-| �.d d�| i� n`| �+d ��rtd} | 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#��| 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,�d0�du�r�| �5� | j,�d1�du�r | �6� | j7du �r i | _7n�t8| j7t9��s6t d2��n�| j7�*� D ]�\}}|t:v �rV�q@t8|t;��szt d3|� d4| j7� d���t<|�d5k�r�t d6|� d7���|�+d ��r�t d8��t8|t;��s�t d9|� d:|� d;���t<|�d<k�r@t d9|� d:|� d=����q@| j=t j>@ �r | �?� d>|v �r�|d> du�r�t8|d> t;��s<t d?��|d> �@� }|d@k�rntj2dAk�rft dB��dC| _An|dDk�r�dE| _Ant dF��dG|v �r |dG du�r |dG | _Bt8| jBt;��s�t tCjDdHdI���| jBdk�r�t tCjDdJdI���dK| jBv�r t tCjDdLdI���| jE�r| �FdM| jEdN� |�dO�du�r�|dO | _Gt8| jGt;��sPt tHjDdHdI���| jGdk�rlt tHjDdPdI���tj�| jG��s�t dQ| jG� dR���|�dS�du�r�|dS | _It8| jIt%��r�| jIdTk �r�t dU��|�dV�du� r|dV | _Jt8| jJt%��r�| jJdTk � rt dW��dS )Xa 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_warnings� client_flags�compressTr[ r\ z.allow_local_infile_in_path must be a directoryZconsume_resultsFZ auth_pluginrV Z authentication_webauthn_clientr� z5' cannot be used as the default authentication plugin�converter_classzEConverter class should be a subclass of conversion.MySQLConverterBase))�dbr� )�usernamer� )�passwd�password)rX Zconnection_timeout)Zread_default_fileZ option_filesr� r� �host�portz'TCP/IP port number should be an integerrW Z init_commandzUnsupported argument '�ssl_Ztls_�_r� Zmysql_clear_passwordzEClear password authentication is not supported over insecure channelsZ$authentication_openid_connect_clientzEOpenID Connect 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 �openid_token_filezcannot be an empty stringz The path 'z1' provided via 'openid_token_file' does not existrY r z.Option read_timeout must be a positive integerrZ z/Option write_timeout must be a positive integer)Kr� r3 r_ r4 r^ �copyr/ r; r� �KeyErrorr� r) r` r� r� ZCOMPRESSr� r! r| r} r� �path�abspath�exists�isdir�islinkr� Z LOCAL_FILESr� r� r. r� � TypeErrorrh ri � set_loginrl r� rm � ValueErrorrp r� r� r� ro r� �replace�setattrr� rn r� r� r� r� r� rg r� �dictr r� �lenra Z CONNECT_ARGS�_add_default_conn_attrs�lowerr� rr �KRB_SERVICE_PRINCIPAL_ERRORr� rq �_validate_callablers �OPENID_TOKEN_FILE_ERRORrw rx )r� r� �config�defaultZinfile_in_path�errZ compat_map�compat� translater� r� Z set_ssl_flagr� r� � attributer� r� r� rP rP rQ r 0 s� ��� � � � ��� � � � � � ��� � � �� � �� � � �� � � � � z MySQLConnectionAbstract.configc C s dS )z'Adds the default connection attributes.NrP r� rP rP rQ r z s z/MySQLConnectionAbstract._add_default_conn_attrsr zUnion[str, Callable])� option_name�callback�num_argsrU 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� rJ r r1 �callabler r � parameters)r r r r Z num_paramsrP rP rQ r } s "��z*MySQLConnectionAbstract._validate_callablerG zTuple[int, ...])�server_versionrU 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� �vrP rP rQ � <genexpr>� 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" �versionrP rP rQ �_check_server_version� s z-MySQLConnectionAbstract._check_server_versionr �Z property_namezOptional[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`. �re r� rP rP rQ �get_server_version� s z*MySQLConnectionAbstract.get_server_version� server_infoc C s | j S )z�Gets the original MySQL version information. Returns: The original MySQL server as text. If not previously connected, it will return `None`. )r* r� rP rP rQ �get_server_info� s z'MySQLConnectionAbstract.get_server_infoc C s | j S )z�Gets the MySQL Server version the connector is connected to. Returns: The MySQL server version as a tuple. If not previously connected, it will return `None`. r( r� rP rP rQ r � s z&MySQLConnectionAbstract.server_versionc C s* z | j d W S ttfy$ Y dS 0 dS )z�Gets the original MySQL server version information. Returns: The original MySQL server as text. If not previously connected, it will return `None`. Zserver_version_originalN)rf r r� r� rP rP rQ r* � s z#MySQLConnectionAbstract.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 ``` NrP r� rP rP rQ �in_transaction� s z&MySQLConnectionAbstract.in_transactionr� zUnion[int, Sequence[int]])�flagsrU c C s || _ | j S )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� )r� r- rP rP rQ �set_client_flags� s z(MySQLConnectionAbstract.set_client_flagsc C s | j S )z-Gets the client flags of the current session.�ra r� rP rP rQ r� s z$MySQLConnectionAbstract.client_flagsc C sl t |t�r|dkr|| _nNt |ttf�r`|D ]0}|dk rN| jt|� M _q,| j|O _q,ntd��dS )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. 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.client_flags = [ClientFlag.FOUND_ROWS, -ClientFlag.LONG_FLAG] >>> cnx.reconnect() ``` r z.client_flags setter expect integer (>0) or setN)r� r� ra r# r� �absr1 )r� r- �flagrP rP rQ r� s r 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� rP rP rQ �shutdownE s z MySQLConnectionAbstract.shutdown)r1 rU c C s | j |@ dkS )z|Checks if a client flag is set. Returns: `True` if the client flag was set, `False` otherwise. r r/ )r� r1 rP rP rQ �isset_client_flagP s z)MySQLConnectionAbstract.isset_client_flagc C s | � d�d S )zGets the current time zone.zSELECT @@session.time_zoner �� info_queryr� rP rP rQ � time_zoneX s �z!MySQLConnectionAbstract.time_zonec C s | � d|� d�� || _dS )zSets the time zone.zSET @@session.time_zone = 'r� N)r� rc r� rP rP rQ r7 _ s c C s | j du r| �d�d | _ | j S )zGets the SQL mode.NzSELECT @@session.sql_moder )rb r6 r� rP rP rQ �sql_modee 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� rb r� rP rP rQ r8 l s zOptional[RowType])�queryrU 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). NrP �r� r9 rP rP rQ r6 s z"MySQLConnectionAbstract.info_queryN)r� r� rU 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. NrV )r� rh ri )r� r� r� rP rP rQ r � s z!MySQLConnectionAbstract.set_login� use_unicodeTc C s || _ dS �z�Sets whether we return string fields as unicode or not. Args: value: A boolean - default is `True`. N)r; r� rP rP rQ � set_unicode� s z#MySQLConnectionAbstract.set_unicodec C s | j S )z7Gets whether we return string fields as unicode or not.)rt r� rP rP rQ r; � s z#MySQLConnectionAbstract.use_unicodec C s dS r< rP r� rP rP rQ r; � s c C s | � d�d }|dkS )z%Gets whether autocommit is on or off.zSELECT @@session.autocommitr r r5 r� rP rP rQ � autocommit� s z"MySQLConnectionAbstract.autocommitc C s& |rdnd}| � d|� �� || _dS )zToggles autocommit.�ONZOFFzSET @@session.autocommit = N)r� rd )r� r� �switchrP rP rQ r> � 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. )ru r� rP rP rQ r� � 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 ru r� rP rP rQ r� � 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`. )rv r� rP rP rQ r� � 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. rA N)r� r� r rv ru r� rP rP rQ r� � 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. )ry r� rP rP rQ � 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. rA N)r� r� r ry r� rP rP rQ rB s c 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� �get_charset_info� _charset_idr� rP rP rQ � collation s z!MySQLConnectionAbstract.collationc 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_inforE r� rP rP rQ �charset% s z MySQLConnectionAbstract.charsetc C s | j S )��The charset ID utilized during the connection phase. If the charset ID hasn't been set, the default charset ID is returned. )rE r� rP rP rQ � charset_id1 s z"MySQLConnectionAbstract.charset_idc C s2 | j du r,| jdu rtS | jdk r&tnt| _ | j S )rJ N)� r )r] re r# r$ r� rP rP rQ rE 9 s ��z#MySQLConnectionAbstract._charset_idc C s || _ dS )z9Sets the charset ID utilized during the connection phase.N)r] r� rP rP rQ rE O s c 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�utf8rG )r� �encodingrP rP rQ �python_charsetT s z&MySQLConnectionAbstract.python_charsetzOptional[Union[int, str]])rI rF rU 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�� | 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 NoneNrI z)collation should be either string or None)rF z SET NAMES 'z ' COLLATE 'r� )Z character_set) r� r� r� r r� r� rD rE r! �_execute_queryr� � set_charset)r� rI rF �err_msg� charset_nameZcollation_namerP rP rQ �set_charset_collationd sJ �� �� ���z-MySQLConnectionAbstract.set_charset_collation� Optional[int]c C s | j S )a� Gets the connection context's timeout in seconds for each attempt to read any data from the server. `read_timeout` is number of seconds upto which the connector should wait for the server to reply back before raising an ReadTimeoutError. We can set this option to None, which would signal the connector to wait indefinitely till the read operation is completed or stopped abruptly. �rw r� rP rP rQ rY � s z$MySQLConnectionAbstract.read_timeout��timeoutrU c C s, |dur"t |t�r|dk r"td��|| _dS )a� Sets or updates the connection context's timeout in seconds for each attempt to read any data from the server. `read_timeout` is number of seconds upto which the connector should wait for the server to reply back before raising an ReadTimeoutError. We can set this option to None, which would signal the connector to wait indefinitely till the read operation is completed or stopped abruptly. Args: timeout: Accepts a non-negative integer which is the timeout to be set in seconds or None. Raises: InterfaceError: If a positive integer or None is not passed via the timeout parameter. Examples: The following will set the read_timeout of the current session to 5 seconds: ``` >>> cnx = mysql.connector.connect(user='scott') >>> cnx.read_timeout = 5 ``` Nr �6Option read_timeout must be a positive integer or None�r� r� r. rw �r� rY rP rP rQ rY � s �c C s | j S �a� Gets the connection context's timeout in seconds for each attempt to send data to the server. `write_timeout` is number of seconds upto which the connector should spend to write to the server before raising an WriteTimeoutError. We can set this option to None, which would signal the connector to wait indefinitely till the write operation is completed or stopped abruptly. �rx r� rP rP rQ rZ � s z%MySQLConnectionAbstract.write_timeoutc C s, |dur"t |t�r|dk r"td��|| _dS )a� Sets or updates the connection context's timeout in seconds for each attempt to send data to the server. `write_timeout` is number of seconds upto which the connector should spend to write to the server before raising an WriteTimeoutError. We can set this option to None, which would signal the connector to wait indefinitely till the write operation is completed or stopped abruptly. Args: timeout: Accepts a non-negative integer which is the timeout to be set in seconds or None. Raises: InterfaceError: If a positive integer or None is not passed via the timeout parameter. Examples: The following will set the write_timeout of the current session to 5 seconds: ``` >>> cnx = mysql.connector.connect(user='scott') >>> cnx.write_timeout = 5 ``` Nr �7Option write_timeout must be a positive integer or None�r� r� r. rx r\ rP rP rQ rZ � s �c C s dS )zMySQL connection ID.NrP r� rP rP rQ � connection_id s z%MySQLConnectionAbstract.connection_idc C s dS )z>Gathers information of the MySQL server before authentication.NrP r� rP rP rQ � _do_handshake s z%MySQLConnectionAbstract._do_handshakec C s dS )z)Opens the connection to the MySQL server.NrP r� rP rP rQ �_open_connection s z(MySQLConnectionAbstract._open_connectionc C sH | j | jd� | j| _| jr$| j| _| jr2| j| _| jrD| � | 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. �rI N) rU rE rd r> rc r7 rb r8 r� rQ r� rP rP rQ �_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()`. NrP r� rP rP rQ r� s z MySQLConnectionAbstract.closez5ClassVar[Callable[['MySQLConnectionAbstract'], None]]� disconnectc 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 rI NrF r rd zSET PASSWORD = 'r� z)ALTER USER CURRENT_USER() PASSWORD EXPIRE)r rf rc r� r� rD rE ra r) Z CAN_HANDLE_EXPIRED_PASSWORDSre rU r, r� rj ri )r� r� rI rF rP rP rQ �connect. s& � � z MySQLConnectionAbstract.connectr )�attempts�delayrU 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): )r^ Z start_spanr2 r9 ZSpanKindZCLIENTrf rg � is_connectedr- �IOErrorr. r r5 r8 r7 r6 r_ )r� rh ri �counter�spanr �msgZ interface_errrP rP rQ � reconnectd 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 NrP r� rP rP rQ rk � s z$MySQLConnectionAbstract.is_connectedF)rp rh ri rU 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. NrP )r� rp rh ri rP rP rQ �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() ``` NrP r� rP rP rQ �commit� s z MySQLConnectionAbstract.commit�Optional[bool]z%Optional[Type['MySQLCursorAbstract']]z'MySQLCursorAbstract')�buffered�raw�prepared� cursor_class� dictionaryrY rZ rU 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 a dictionary or a tuple. Dictionary 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.MySQLCursor` or `mysql.connector.cursor_cext.CMySQLCursor` according to the type of connection that's being used. **NOTE: The parameters read and write timeouts in cursors are unsupported for C-Extension.** 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.MySQLCursor` or `cursor_cext.CMySQLCursor` according to the type of connection that's being used. dictionary: If `True`, the cursor returns rows as dictionaries. read_timeout: A positive integer representing timeout in seconds for each attempt to read any data from the server. write_timeout: A positive integer representing timeout in seconds for each attempt to send any data to the server. Returns: cursor: A cursor object. Raises: ProgrammingError: When `cursor_class` is not a subclass of `MySQLCursorAbstract`. ValueError: When cursor is not available. InterfaceError: When read_timeout or write_timeout is not a positive integer. NrP )r� rt ru rv rw rx rY rZ rP rP rQ �cursor� s z MySQLConnectionAbstract.cursorc C s dS )zExecutes a query.NrP r: rP rP rQ rQ 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() ``` NrP r� rP rP rQ �rollback s z MySQLConnectionAbstract.rollback)�consistent_snapshot�isolation_level�readonlyrU 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)� � r� zMySQL server version z does not support this featurez READ ONLYz READ WRITEzSET TRANSACTION zSTART TRANSACTIONz WITH CONSISTENT SNAPSHOT) r, r1 r� r r� r rQ re r� )r� r{ r| r} �levelZlevelsZ access_moder9 rP rP rQ �start_transaction s* ' �z)MySQLConnectionAbstract.start_transactionzOptional[Dict[str, Any]])�user_variables�session_variablesrU 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 `)rk r0 �cmd_reset_connectionr/ r2 r� �cmd_change_userrh ri rk rE ry r� �executer� )r� r� r� �curr� r� rP rP rQ � reset_sessionh s4 ��� z%MySQLConnectionAbstract.reset_sessionr� z Optional[Type[MySQLConverter]])� convclassrU c C s || _ dS )�� Sets the converter class to be used. Args: convclass: Should be a class overloading methods and members of `conversion.MySQLConverter`. N)r� )r� r� rP rP rQ �set_converter_class� s z+MySQLConnectionAbstract.set_converter_classc C s | j S )z5Gets the converter class set for the current session.)r� r� rP rP rQ r� � s z'MySQLConnectionAbstract.converter_classc C sL |r@t |t�r@| j�| j�d }|| _||| j�| _| j| j_ nt d��dS )r� r zFConverter class should be a subclass of conversion.MySQLConverterBase.N) � issubclassr+ r� rH rE r� r; r� r� Z str_fallbackr )r� r� rT rP rP rQ r� � s �� Optional[List[DescriptionType]]zOptional[CMySQLPrepStmt]z2Tuple[Optional[RowType], Optional[Dict[str, Any]]])rM �columnsru � prep_stmtr� rU c K 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. NrP )r� rM r� ru r� r� rP rP rQ �get_row� s z MySQLConnectionAbstract.get_rowz.Tuple[List[RowType], Optional[Dict[str, Any]]])�countrM r� ru r� r� rU c K 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. NrP )r� r� rM r� ru r� r� rP rP rQ �get_rows� s z MySQLConnectionAbstract.get_rows)r� rU 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. NrP )r� r� rP rP rQ � cmd_init_db s z#MySQLConnectionAbstract.cmd_init_db)r9 ru rt � raw_as_stringr� rU c K 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 NrP )r� r9 ru rt r� r� rP rP rQ r� s z!MySQLConnectionAbstract.cmd_queryz(Generator[Mapping[str, Any], None, None])� statementsr� rU c K 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 ``` NrP )r� r� r� rP rP rQ �cmd_query_iter; s z&MySQLConnectionAbstract.cmd_query_iterzDict[str, Any])�optionsrU c C s dS )a� Send the Refresh command to the MySQL server. This method sends the Refresh command to the MySQL server. The options argument should be a bitwise value using constants.RefreshOption. Typical usage example: ``` RefreshOption = mysql.connector.RefreshOption refresh = RefreshOption.LOG | RefreshOption.INFO cnx.cmd_refresh(refresh) ``` Args: options: Bitmask value constructed using constants from the `constants.RefreshOption` class. Returns: A dictionary representing the OK packet got as response when executing the command. Raises: ValueError: If an invalid command `refresh options` is provided. DeprecationWarning: If one of the options is deprecated for the server you are connecting to. NrP )r� r� rP rP rQ � cmd_refresh^ 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. NrP r� rP rP rQ �cmd_quitz s z MySQLConnectionAbstract.cmd_quit)� shutdown_typerU 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. NrP )r� r� rP rP rQ � cmd_shutdown� 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. NrP r� rP rP rQ �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/ rP rP rP rQ �cmd_process_info� s �z(MySQLConnectionAbstract.cmd_process_info)� mysql_pidrU 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) ``` NrP )r� r� rP rP rQ �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. NrP r� rP rP rQ � 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. NrP r� rP rP rQ �cmd_ping� s z MySQLConnectionAbstract.cmd_pingrV ) r� r� r� rI � password1� password2� password3�oci_config_file�oci_config_profiler� rU 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. The character set passed during initial connection is reused if no value of charset is passed via this method. 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). openid_token_file: OpenID Connect token file 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 NrP ) r� r� r� r� rI r� r� r� r� r� r� rP rP rQ r� � s z'MySQLConnectionAbstract.cmd_change_userr z(Union[Mapping[str, Any], CMySQLPrepStmt])� statementr� rU c K 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 NrP )r� r� r� rP rP rQ �cmd_stmt_prepare s z(MySQLConnectionAbstract.cmd_stmt_preparerP zUnion[int, CMySQLPrepStmt]z Sequence[BinaryProtocolType]r z&Optional[Union[Dict[str, Any], Tuple]])� statement_id�datar r- r� rU c K 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 NrP )r� r� r� r r- r� rP rP rQ �cmd_stmt_execute s z(MySQLConnectionAbstract.cmd_stmt_execute)r� r� rU c K 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. NrP �r� r� r� rP rP rQ �cmd_stmt_closeC s z&MySQLConnectionAbstract.cmd_stmt_closer )r� �param_idr� r� rU c K 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 NrP )r� r� r� r� r� rP rP rQ �cmd_stmt_send_long_dataS s z/MySQLConnectionAbstract.cmd_stmt_send_long_datac K 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. NrP r� rP rP rQ �cmd_stmt_resetp 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`. NrP r� rP rP rQ r� � s z,MySQLConnectionAbstract.cmd_reset_connection)r )NN)T)NN)r r )Fr r )NNNNNNN)FNN)NN)FNNN)NFNNN)FFF)N) rV rV rV NrV rV rV rV rV rV )rP rP r )drL rM rN rO 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� r3 r4 r7 r8 r6 r r= r; r> r� r� rB rF rI rK rE rP rU rY rZ ra rb rc re r� rf �__annotations__rg rp rk rq rr ry rQ rz r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� rP rP rP rQ rR � s� T _Q L�" $ � �C 67 � 8 �L �: � � � '" �&. �** " rR c @ s\ e Zd ZdZdkddddd�dd�Zd d �d d �Zd d ddd�dd�Zedd �dd��Zej ddd�dd��Zedd �dd��Z e j ddd�dd��Z e dlddd d �d d ��Z e dd �d d!��Z e dmdd#d$dd%�d&d'��Ze dd(dd)�d*d+��Ze d,d �d-d.��Ze dnd0d1d2�d3d4��Ze d1d �d5d6��Zd7d �d8d9�Ze d:d �d;d<��Ze d=d �d>d?��Zd@dAdB�dCdD�Zdod@d@dAdE�dFdG�Zdpd$ddI�dJdK�ZedLd �dMdN��Zed0d �dOdP��Zedd �dQdR��ZedSd �dTdU��Z ed0d �dVdW��Z edXd �dYdZ��Z e e j!d[d\��dSd �d]d^��Z"d_d �d`da�Z#ddbddc�ddde�Z$ddbdf�dgdh�Z%dd �didj�Z&dS )q�MySQLCursorAbstractz�Abstract cursor class Abstract class defining cursor class with method and members required by the Python Database API Specification v2.0. Nz!Optional[MySQLConnectionAbstract]rV rS )� connectionrY rZ rU c C s� || _ |dur.t|t�s"tdd��t�|�| _ d| _d| _d| _d| _ d| _ d| _ g | _ g | _ d| _d| _d| _d| _|| _|| _d| _d| _d| _dS ) z#Defines the MySQL cursor interface.Ni )�errnor� r r F)NN)� _connectionr� rR r. �weakref�proxy� _description� _rowcount�_last_insert_id� _warnings�_warning_count� _executedZ_executed_listZ_stored_resultsZ arraysize�_binaryr{ Z_nextrowrw rx Z_stmt_partitionsZ_stmt_partition�_stmt_map_results)r� r� rY rZ rP rP rQ r� � s0 ��z MySQLCursorAbstract.__init__rT c C s | S r� rP r� rP rP rQ r� � s z MySQLCursorAbstract.__enter__r� r� r r� c C s | � � d S r� r� r� rP rP rQ r� � s z MySQLCursorAbstract.__exit__c C s | j S )a� Gets the cursor context's timeout in seconds for each attempt to read any data from the server. `read_timeout` is number of seconds upto which the connector should wait for the server to reply back before raising an ReadTimeoutError. We can set this option to None, which would signal the connector to wait indefinitely till the read operation is completed or stopped abruptly. rW r� rP rP rQ rY � s z MySQLCursorAbstract.read_timeoutrX c C s, |dur"t |t�r|dk r"td��|| _dS )a� Sets or updates the cursor context's timeout in seconds for each attempt to read any data from the server. `read_timeout` is number of seconds upto which the connector should wait for the server to reply back before raising an ReadTimeoutError. We can set this option to None, which would signal the connector to wait indefinitely till the read operation is completed or stopped abruptly. Args: timeout: Accepts a non-negative integer which is the timeout to be set in seconds or None. Raises: InterfaceError: If a positive integer or None is not passed via the timeout parameter. Examples: The following will set the read_timeout of the current session to 5 seconds: ``` >>> cnx = mysql.connector.connect(user='scott') >>> cur = cnx.cursor() >>> cur.read_timeout = 5 ``` Nr rZ r[ r\ rP rP rQ rY � s �c C s | j S r] r^ r� rP rP rQ rZ � s z!MySQLCursorAbstract.write_timeoutc C s, |dur"t |t�r|dk r"td��|| _dS )a� Sets or updates the connection context's timeout in seconds for each attempt to send data to the server. `write_timeout` is number of seconds upto which the connector should spend to write to the server before raising an WriteTimeoutError. We can set this option to None, which would signal the connector to wait indefinitely till the write operation is completed or stopped abruptly. Args: timeout: Accepts a non-negative integer which is the timeout to be set in seconds or None. Raises: InterfaceError: If a positive integer or None is not passed via the timeout parameter. Examples: The following will set the write_timeout of the current session to 5 seconds: ``` >>> cnx = mysql.connector.connect(user='scott') >>> cur = cnx.cursor() >>> cur.write_timeout = 5 ``` Nr r_ r` r\ rP rP rQ rZ s �rP r� r z0Optional[Union[Dict[str, RowItemType], RowType]])�procname�argsrU 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 NrP )r� r� r� rP rP rQ �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. NrP r� rP rP rQ r� ] s zMySQLCursorAbstract.closeFzFUnion[Sequence[MySQLConvertibleType], Dict[str, MySQLConvertibleType]]r� )� operation�params� map_resultsrU c C s dS )a> Executes the given operation (a MySQL script) 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,)) ``` If you want each single statement in the script to be related to its corresponding result set, you should enable the `map_results` switch - see workflow example below. If the given script uses `DELIMITER` statements (which are not recognized by MySQL Server), the connector will parse such statements to remove them from the script and substitute delimiters as needed. This pre-processing may cause a performance hit when using long scripts. Note that when enabling `map_results`, the script is expected to use `DELIMITER` statements in order to split the script into multiple query strings. The following characters are currently not supported by the connector in `DELIMITER` statements: `"`, `'`, #`, `/*` and `*/`. 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 - it can be a single or a multi statement. 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). map_results: It is `False` by default. If `True`, it allows you to know what statement caused what result set - see workflow example below. Only relevant when working with multi statements. Returns: `None`. Example (basic usage): The following example runs many single statements in a single go and loads the corresponding result sets sequentially: ``` sql_operation = ''' SET @a=1, @b='2024-02-01'; SELECT @a, LENGTH('hello'), @b; SELECT @@version; ''' with cnx.cursor() as cur: cur.execute(sql_operation) result_set = cur.fetchall() # do something with result set ... while cur.nextset(): result_set = cur.fetchall() # do something with result set ... ``` In case the operation is a single statement, you may skip the looping section as no more result sets are to be expected. Example (statement-result mapping): The following example runs many single statements in a single go and loads the corresponding result sets sequentially. Additionally, each result set gets related to the statement that caused it: ``` sql_operation = ''' SET @a=1, @b='2024-02-01'; SELECT @a, LENGTH('hello'), @b; SELECT @@version; ''' with cnx.cursor() as cur: cur.execute(sql_operation, map_results=True) # statement 1 is `SET @a=1, @b='2024-02-01'`, # result set from statement 1 is `[]` - aka, an empty set. result_set, statement = cur.fetchall(), cur.statement # do something with result set ... # 1st call to `nextset()` will laod the result set from statement 2, # statement 2 is `SELECT @a, LENGTH('hello'), @b`, # result set from statement 2 is `[(1, 5, '2024-02-01')]`. # # 2nd call to `nextset()` will laod the result set from statement 3, # statement 3 is `SELECT @@version`, # result set from statement 3 is `[('9.0.0-labs-mrs-8',)]`. # # 3rd call to `nextset()` will return `None` as there are no more sets, # leading to the end of the consumption process of result sets. while cur.nextset(): result_set, statement = cur.fetchall(), cur.statement # do something with result set ... ``` In case the mapping is disabled (`map_results=False`), all result sets get related to the same statement, which is the one provided when calling `execute()`. In other words, the property `statement` will not change as result sets are consumed, which contrasts with the case in which the mapping is enabled. Note that we offer a new fetch-related API command which can be leveraged as a shortcut for consuming result sets - it is equivalent to the previous workflow. ``` sql_operation = ''' SET @a=1, @b='2024-02-01'; SELECT @a, LENGTH('hello'), @b; SELECT @@version; ''' with cnx.cursor() as cur: cur.execute(sql_operation, map_results=True) for statement, result_set in cur.fetchsets(): # do something with result set ``` NrP )r� r� r� r� rP rP rQ r� h s zMySQLCursorAbstract.executezPSequence[Union[Sequence[MySQLConvertibleType], Dict[str, MySQLConvertibleType]]])r� � seq_paramsrU 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') ``` NrP )r� r� r� rP rP rQ � 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() ``` NrP r� rP rP rQ �fetchone s z MySQLCursorAbstract.fetchoner r� z,List[Union[RowType, Dict[str, RowItemType]]])�sizerU 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. NrP )r� r� rP rP rQ � fetchmany/ 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() ``` NrP r� rP rP rQ �fetchall= s z MySQLCursorAbstract.fetchallzYGenerator[tuple[Optional[str], list[Union[RowType, Dict[str, RowItemType]]]], None, None]c c s� d}| j s| j}z | �� }W n ty2 g }Y n0 | j r@| jn||fV | �� r�z | �� }W n tyt g }Y n0 | j r�| jn||fV qJdS )a� Generates the result sets stream caused by the last `execute*()`. Returns: A 2-tuple; the first element is the statement that caused the result set, and the second is the result set itself. This method is used as part of the multi statement execution workflow - see example below. Example: Consider the following example where multiple statements are executed in one go: ``` sql_operation = ''' SET @a=1, @b='2024-02-01'; SELECT @a, LENGTH('hello'), @b; SELECT @@version; ''' with cnx.cursor() as cur: cur.execute(sql_operation, map_results=True) result_set, statement = cur.fetchall(), cur.statement # do something with result set ... while cur.nextset(): result_set, statement = cur.fetchall(), cur.statement # do something with result set ... ``` In this case, as an alternative to loading the result sets with `nextset()` in combination with a `while` loop, you can use `fetchsets()` which is equivalent to the previous approach: ``` sql_operation = ''' SET @a=1, @b='2024-02-01'; SELECT @a, LENGTH('hello'), @b; SELECT @@version; ''' with cnx.cursor() as cur: cur.execute(sql_operation) for statement, result_set in cur.fetchsets(): # do something with result set ``` N)r� r� r� r. �nextset)r� Zstatement_cachedZ result_setrP rP rQ � fetchsetsM s$ 9 � �z MySQLCursorAbstract.fetchsetsz 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,)] ``` NrP r� rP rP rQ �stored_results� s z"MySQLCursorAbstract.stored_resultsrs c C s dS )a Makes the cursor skip to the next available set, discarding any remaining rows from the current set. This method is used as part of the multi statement execution workflow - see example below. Returns: It returns `None` if there are no more sets. Otherwise, it returns `True` and subsequent calls to the `fetch*()` methods will return rows from the next result set. Example: The following example runs many single statements in a single go and loads the corresponding result sets sequentially: ``` sql_operation = ''' SET @a=1, @b='2024-02-01'; SELECT @a, LENGTH('hello'), @b; SELECT @@version; ''' with cnx.cursor() as cur: cur.execute(sql_operation) result_set = cur.fetchall() # do something with result set ... while cur.nextset(): result_set = cur.fetchall() # do something with result set ... ``` In case the operation is a single statement, you may skip the looping section as no more result sets are to be expected. NrP r� rP rP rQ r� � s zMySQLCursorAbstract.nextsetr r )�sizesrU c C s dS �zNot Implemented.NrP )r� r� rP rP rQ � setinputsizes� s z!MySQLCursorAbstract.setinputsizes)r� �columnrU c C s dS r� rP )r� r� r� rP rP rQ � setoutputsize� s z!MySQLCursorAbstract.setoutputsizeT)�freerU c C s dS )z Resets the cursor to defaultNrP )r� r� rP rP rQ �reset� s zMySQLCursorAbstract.resetr� 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� rP rP rQ � 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� rP rP rQ �rowcount� s z MySQLCursorAbstract.rowcountc 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� rP rP rQ � lastrowid s z MySQLCursorAbstract.lastrowidzOptional[List[WarningType]]c C s | j S )a� Gets 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� rP rP rQ �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� rP rP rQ � warning_count* s z!MySQLCursorAbstract.warning_countr� c C sL | j du rdS z| j �� �d�W S ttfyF tt| j �� � Y S 0 dS )a� Returns the latest executed statement. When a multiple statement is executed, the value of `statement` corresponds to the one that caused the current result set, provided the statement-result mapping was enabled. Otherwise, the value of `statement` matches the statement just as provided when calling `execute()` and it does not change as result sets are traversed. Nzutf-8)r� r� r r� �UnicodeDecodeErrorr r� r� rP rP rQ r� 5 s z MySQLCursorAbstract.statementr� r' 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.fetchwarnings() [(u'Warning', 1292, u"Truncated incorrect DOUBLE value: 'a'")] ``` r� r� rP rP rQ � fetchwarningsF s z!MySQLCursorAbstract.fetchwarningsz.Optional[List[Tuple[str, BinaryProtocolType]]]c C s t | d�r| jjS dS )z�Gets a list of query attributes from the connector's side. Returns: List of existing query attributes. r� N)�hasattrr� r� r� rP rP rQ �get_attributesW s z"MySQLCursorAbstract.get_attributesr> )r� r� rU c C sR t |t�std��|dur4t |t�s4td|� d���t| d�rN| 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� r1 �MYSQL_PY_TYPESr� r� r� )r� r� r� rP rP rQ � add_attributea s � z!MySQLCursorAbstract.add_attributer� c C s, t |t�std��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� N)r� r� r1 r� r� r� r� rP rP rQ �remove_attributex s z$MySQLCursorAbstract.remove_attributec C s t | d�r| j�� dS )z<Clears the list of query attributes on the connector's side.r� N)r� r� r� r� rP rP rQ �clear_attributes� s z$MySQLCursorAbstract.clear_attributes)NNN)rP )rP F)r )N)T)'rL rM rN rO r� r� r� r� rY r� rZ r r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r: r" r� r� r� r� r� r� rP rP rP rQ r� � sv �) �3 � - M( r� )mrO � __future__r r� r r� �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 r r r� �sslr� r � ImportError� constantsr r! r" r# r$ r% r& r' r( r) � conversionr* r+ �errorsr, r- r. r/ r0 r1 Zopentelemetry.constantsr2 r3 r4 r5 Z opentelemetry.instrumentationr6 r7 r8 r9 Z _decoratingr: Z optionfilesr; Z tls_ciphersr< r= r> r? r@ rA rB rC rD rE rF rG rH �utilsrI rJ r� r� r� r� r r r �floatr� r� r� rK rR r� rP rP rP rQ �<module> s� L0 4 ������� l
| ver. 1.6 |
Github
|
.
| PHP 8.2.30 | ??????????? ?????????: 0 |
proxy
|
phpinfo
|
???????????