Ë
|
Wñúh@Ó ã ó 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& ddl'Z' e(e'd « re'jR rd Z&ddl+m,Z,m-Z-m.Z.m/Z/m0Z0m1Z1m2Z2m3Z3m4Z4m5Z5 ddl6m7Z7m8Z8 ddl9m:Z:m;Z;m<Z<m=Z=m>Z> ddl?m@Z@mAZAmBZBmCZC eCr ddlDmEZEmFZFmGZGmHZH ddlImJZJ ddlKmLZL ddlMmNZNmOZO ddlmPZPmQZQmRZRmSZSmTZTmUZUmVZVmWZWmXZXmYZYmZZZ ddl[m\Z\m]Z] dZ^dZ_dZ`d Zad Zbd Zceede
|
e eeefege e f Zh G d d e\« Zi G d! d"e« Zj G d# d$e« Zky# e*$ r Y ¾w xY w)%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Ú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 ó e Zd ZdZy)Ú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__© ó úLH:\Change_password\venv_build\Lib\site-packages\mysql/connector/abstracts.pyrL rL « s òrR rL c óh
|
e Zd ZU dZdqdZdrdZ dsdZdrdZedtd« Z edtd« Z
|
edud« Z dvd Z dwd
|
Z dqd Zdqd Zdqd Zedxd« Zedxd« Zedyd« Zedzd« Zeedxd« « Zej. d{d« Zedtd« Zej. d|d« Zed}d« Zej. d~d« ZddZdqdZe d dd« Z e dd « Z e e jB d¬ « « dd « Z" e e jB d ¬ « « dzd « Z#edd!« Z$edzd"« Z%eedtd#« « Z& e e jB d$¬ « « dd%« Z'edyd&« Z(e(j. d
d'« Z(dd(Z)dd)Z*edxd*« Z+e+j. d{d+« Z+edxd,« Z,e,j. dd-« Z,edd.« Z- d dd0Z. e e jB d1¬ « « dd|d2« Z/edtd3« Z0e0j. ed|d4« « Z0edtd5« Z1e1j. d|d6« Z1edtd7« Z2e2j. d|d8« Z2edtd9« Z3e3j. d|d:« Z3edtd;« Z4e4j. d|d<« Z4edxd=« Z5edxd>« Z6edyd?« Z7edyd@« Z8e8j. ddA« Z8edxdB« Z9 d ddCZ:eddD« Z;e;j. ddE« Z;eddF« Z<e<j. ddG« Z<eeddH« « Z=edqdI« Z>edqdJ« Z?dqdKZ@edqdL« ZAeAZBdMeCdN< ddOZDdddPZEedtdQ« ZFedddR« ZGedqdS« ZHe d ddT« ZIeddU« ZJedqdV« ZK d ddWZLe d ddX« ZM e e jB dY¬ « « ddZ« ZNedd[« ZOeOj. dd\« ZOe d dd]« ZPe d d d^« ZQed¡d_« ZRe d¢ d£d`« ZSe d¤da« ZTed¥db« ZUed¦dc« ZVed§d¨dd« ZWed©de« ZXe ddf« ZYedªdg« ZZed©dh« Z[ed©di« Z\e d« d¬dj« Z]e ddk« Z^e d® d¯dl« Z_e d°dm« Z`e d±dn« Zae d°do« Zbedtdp« Zcy/)²ÚMySQLConnectionAbstractz8Abstract class for classes connecting to a MySQL server.c ó¼ d| _ d| _ d| _ d| _ t j
|
« | _ d| _ d| _ d| _ d| _
|
d| _ i | _ d| _ d| _ d| _ d| _ d| _ d| _ d| _ d| _ d| _ d| _ d| _ i | _ t2 d | _ d| _ d| _ d| _ d| _ d| _ d| _ d| _! d| _" d| _# t2 d | _$ t2 d
|
| _% t2 d | _& d| _' d| _( d| _) d| _* d| _+ t2 d | _, t2 d | _- d| _. i | _/ d| _0 d| _1 d| _2 d| _3 d| _4 d| _5 d| _6 d| _7 d| _8 d| _9 tu « | _; d| _< d| _= y)Ú
|
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Ú_spanÚotel_context_propagationr* Ú get_defaultÚ _client_flagsÚ _sql_modeÚ
|
_time_zoneÚ _autocommitÚ_server_versionÚ
|
_handshakeÚ _conn_attrsÚ_userÚ _passwordÚ
|
_password1Ú
|
_password2Ú
|
_password3Ú _databaseÚ_hostÚ_portÚ _unix_socketÚ _client_hostÚ _client_portÚ_sslr" Ú _ssl_disabledÚ _force_ipv6Ú_oci_config_fileÚ_oci_config_profileÚ_webauthn_callbackÚ_krb_service_principalÚ_openid_token_fileÚ _use_unicodeÚ _get_warningsÚ_raise_on_warningsÚ_connection_timeoutÚ _read_timeoutÚ_write_timeoutÚ _bufferedÚ_unread_resultÚ_have_next_resultÚ_rawÚ_in_transactionÚ_allow_local_infileÚ_allow_local_infile_in_pathÚ_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Ú_local_infile_filenamesÚ_query©Úselfs rS Ú__init__z MySQLConnectionAbstract.__init__¹ s ð ,0Ôð ð ! Ø
|
Ø.2Ô%ä",×"8Ñ"8Ó":ÔØ(,Ø)-Ø!&ÔØ:>Ô Ø37Ø+-Ôà
|
Ø Ø !Ø !Ø !Ø Ø%
|
Ø
|
Ø+/ÔØ!#ÔØ!"ÔØFH Ü#8¸ Ñ#HÔØ!&ÔØ/3Ô Ø26Ô ØOSÔ Ø59Ô#Ø15Ô à"&ÔØ#(ÔØ(-Ô Ü2GØ ñ3
|
Ô ô -BÀ.Ñ,QÔÜ-BÀ?Ñ-SÔØ $Ø$)ÔØ',Ô Ø Ø%*Ô Ü)>Ð?SÑ)TÔ Ü:OØ (ñ;
|
Ô(ð *.Ô!Ø;=Ôà!&ÔØ+/ÔØ15Ô Ø)-Ô!Ø37Ø@DÔ Ø-2Ô$Ø $à&+Ô Ø,0ÔÜ,8«NÔà=AÔ$ð (ð (, Ø(rR c ó | S ©NrQ r s rS Ú __enter__z!MySQLConnectionAbstract.__enter__ ó Ø rR c ó$ | j « y r ©Úclose©r Úexc_typeÚ exc_valueÚ tracebacks rS Ú__exit__z MySQLConnectionAbstract.__exit__ ó ð
|
|
rR c ó | S )zReturns self for `weakref.proxy`.
|
|
This method is used when the original object is needed when using
|
`weakref.proxy`.
|
rQ r s rS Úget_selfz MySQLConnectionAbstract.get_self s ð rR c ód | j xs# | j duxr t j dk( S )z)Returns `True` if is a secure connection.NÚposix)r rs ÚosÚnamer s rS Ú is_securez!MySQLConnectionAbstract.is_secure s3 ð × Ñ ò
|
Ø × Ñ TÐ )Ò @¬b¯g©g¸Ñ.@ð
|
rR c ó | j S )z Returns If have next result.)r r s rS Úhave_next_resultz(MySQLConnectionAbstract.have_next_result' s ð ×%Ñ%Ð%rR c óH t | j j « « S )z Returns query attributes list.)Úlistr Úitemsr s rS Ú query_attrsz#MySQLConnectionAbstract.query_attrs, s ô D×%Ñ%×+Ñ+Ó-Ó.Ð.rR c óJ |\ }}|| j vr|| j |< yy)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 ÚvalueÚ attr_nameÚ
|
attr_values rS Úquery_attrs_appendz*MySQLConnectionAbstract.query_attrs_append1 s1 ð !&Ñ :Ø D× -Ñ -Ñ -Ø+5D× Ñ iÒ (ð .rR c ó: | j 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¯ s rS Úquery_attrs_removez*MySQLConnectionAbstract.query_attrs_remove> s ð × Ñ ×$Ñ$ T¨4Ó0Ð0rR c ó i | _ y)z5Clears query attributes list on the connector's side.Nr¸ r s rS Úquery_attrs_clearz)MySQLConnectionAbstract.query_attrs_clearH s
|
à ÕrR c óü g }| j d }t |t « r|j d« r|j d« st d| d« |dd j d« }|s t d « |D ]4 }|j « j « }|s$|j |« 6 n8t |t t f« r|D cg c] }|s| }}nt d
|
| d« | j j d d « t d d n| j d d d }|j d ¬« |d }g g g}i }g } t d t j |« dz D ]2 }
|
|j! t" |
|
« | j% t& |
|
« 4 |D ]µ } d| v r9| | v r5| t& d v r|d j | « +|d j | « @| |v rd|| } | |v r t t( j+ d| ¬« « | t" d v r|d j || « |d j || « ¨t d| d« |d s|d s t d« |d D ]* } | t, d j/ « v s t1 d| d« |d D ]* } | t, d j/ « v s t1 d| d« dj3 |d « dj3 |d « g| j d< y c c}w )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' listzItls_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.ú:)rv Ú
|
isinstanceÚstrÚ
|
startswithÚendswithÚAttributeErrorÚsplitÚstripÚupperÚappendr´ ÚsetÚgetr( ÚsortÚindexÚupdater' Úextendr& ÚDUPLICATED_IN_LIST_ERRORÚformatr< Úvaluesr0 Újoin)r rÄ Útls_csÚtls_cssÚ_tls_csrÊ Ú newer_tls_verÚtranslated_namesÚiani_cipher_suites_namesÚossl_cipher_suites_namesÚtls_verr¯ Útranslated_nameÚcipher_as_ossls rS Ú_validate_tls_ciphersuitesz2MySQLConnectionAbstract._validate_tls_ciphersuitesL s à ÐØÐ-Ñ.ä fcÔ "Ø×%Ñ% cÔ*¨v¯©¸sÔ/CÜ$Ø?À¸xÀqÐIóð ð Qrl×(Ñ(¨Ó-GÙÜ$ØLóð ð #ò 5Ø ,,.×.Ñ.Ó0ÚØ$×+Ñ+¨GÕ4ñ 5ô
|
¤¤s Ô ,Ø5;Ö F¨6ºv¢Ð FÐ Ñ Fä ð)Ø)/¨°ð3óð ð yy}}^¨TÓ2Ð:ô Oà>Ñ*©1Ð-ð ð ×Ñ $ÐÔ'Ø$ Q ð .0°¨HÐØ#%Ð Ø.0Ð ô $Ð$K¤l×&8Ñ&8¸ Ó&GÈ!Ñ&KÐLò GGØ $× +Ñ +Ô,=¸gÑ,FÔ GØ $× +Ñ +Ô,<¸WÑ,EÕ Fð Gð %ò DØd{tÐ'?Ñ ?ØÔ+¨IÑ6Ñ6Ø$ QÑ'×.Ñ.¨tÕ4à$ QÑ'×.Ñ.¨tÕ4ØÐ1Ñ1Ø":¸4Ñ"@Ø"Ð&6Ñ6Ü(Ü0×7Ñ7Ø!3¸?ð 8ó óð ð
|
Ô,¨YÑ7Ñ7Ø$ QÑ'×.Ñ.Ð/GÈÑ/MÕNà$ QÑ'×.Ñ.Ð/GÈÑ/MÕNä$Ø! $ ð (#ð #óð ð' ð. Ò"Ð+;¸AÒ+>Ü ØLóð ð
|
/¨qÑ 1ò NØ Ô!>¸yÑ!I×!PÑ!PÓ!RÒRÜ'Ø nÐ -Ð-UÐVóð ð ð
|
/¨qÑ 1ò NØ Ô!>¸yÑ!I×!PÑ!PÓ!RÒRÜ'Ø nÐ -Ð-UÐVóð ð ð HHÐ% aÑ(Ó )Ø HHÐ% aÑ(Ó )ð)
|
Ð$Ò%ùòK Gs ÃK9ÃK9c óô g }| j d }t |t « rÆ|j d« r|j d« st d| d« |dd j d« }|D ]M }|j « }|d k( r||v r t t j d|¬
|
« « |j |« O |d gk( rÑt sËt t j |t « « t |t « rJ|s t d « |D ]7 }||v r t t j d|¬
|
« « |j |« 9 nNt |t « r|D ] }|j |« n%t d dj! t « d| d« |s t d« g }g }g }|D ]F }|t v r|j |« |t" v r|j |« 6|j |« H |r?|d gk( r)t s#t% t j |t « « || j d< y|r#t% t& j |t « « |r#t t( j t « « y)z"Validates the tls_versions option.rÊ rÅ rÆ z%tls_versions must be a list, found: 'rÇ r rÈ rÉ rX 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)rv rÐ rÑ rÒ rÓ rÔ rÕ rÖ rß rà rØ ÚTLS_V1_3_SUPPORTEDÚTLS_VER_NO_SUPPORTEDr( r´ rÙ râ r= r0 Ú TLS_VERSION_UNACCEPTABLE_ERRORÚTLS_VERSION_ERROR)r rÊ Ú tls_versionÚtls_versrê Úuse_tls_versionsÚunacceptable_tls_versionsÚinvalid_tls_versionss rS Ú_validate_tls_versionsz.MySQLConnectionAbstract._validate_tls_versions« s¾ à Øii Ñ/ ä k¤3Ô 'Ø ×*Ñ*¨3Ô/°K×4HÑ4HÈÔ4MÜ$Ø;¸K¸=ÈÐJóð ð # 1 RÐ(×.Ñ.¨sÓ3HØ#ò
|
1Ø %mmo Ø "Ò$Ø Ø ,Ñ.Ü(Ü0×7Ñ7Ø!/°{ð 8ó óð ð
|
×#Ñ# KÕ0ð
|
1ð I;Ò&Õ/AÜ$Ü(×/Ñ/° ¼\ÓJóð ô ¤TÔ *Ù Ü$ð*óð ð 'ò -ØlÑ*Ü(Ü0×7Ñ7Ø!/°wð 8ó óð ð
|
×#Ñ# GÕ,ñ -ô ¤SÔ )Ø&ò -Ø ×#Ñ# GÕ,ñ -ô !ðØii¤ Ó-Ð.¨j¸ ¸ÀaðIóð ñ
|
Ü ðCóð ð
|
ÐØ$&Ð!Ø !Ð Ø#ò 5GØ,Ñ&Ø ×'Ñ'¨Ô0ØÔ3Ñ3Ø)×0Ñ0°Õ9à$×+Ñ+¨GÕ4ð 5ñ Ø I ;Ò.Õ7IÜ'Ü(×/Ñ/° ¼\ÓJóð ð )9DIInÒ %Ù &Ü#Ü.×5Ñ5Ø-¬|óóð ñ
|
"Ü Ô!2×!9Ñ!9¸'Ä<Ó!PÓQÐ Qð "rR c ó | j S )z6The user name used for connecting to the MySQL server.)rk r s rS Úuserz MySQLConnectionAbstract.userü ó ð zzÐrR c ó | j S )z MySQL server IP address or name.)rq r s rS Ú server_hostz#MySQLConnectionAbstract.server_host rû rR c ó | j S )zMySQL server TCP/IP port.)rr r s rS Ú server_portz#MySQLConnectionAbstract.server_port rû rR c ó | j S )z8The Unix socket file for connecting to the MySQL server.)rs r s rS Ú unix_socketz#MySQLConnectionAbstract.unix_socket ó ð × Ñ Ð rR c ó y)zThe current database.NrQ r s rS Údatabasez MySQLConnectionAbstract.database ó rR c ó, | j d| « y)zSets the current database.zUSE N)Ú cmd_query©r r¹ s rS r z MySQLConnectionAbstract.database s ð eW~Õ&rR c ó | j S )z#Returns whether to consume results.)r r s rS Úcan_consume_resultsz+MySQLConnectionAbstract.can_consume_results ó ð ×$Ñ$Ð$rR c ó6 t |t « sJ || _ y)z Sets if can consume results.N)rÐ Úboolr r s rS r
|
z+MySQLConnectionAbstract.can_consume_results s ô %¤Ô&Ð&Ð&Ø %Õ rR c ó | j S )z'Returns the pool configuration version.©r r s rS Úpool_config_versionz+MySQLConnectionAbstract.pool_config_version% s ð ×(Ñ(Ð(rR c ó || _ y)z#Sets the pool configuration versionNr r s rS r z+MySQLConnectionAbstract.pool_config_version* s ð %*Õ!rR c ó2 |j t d« | _ |j t d« | _ |j « }d|v r t d« t dXi |¤} |d | _ |d= |d | _
|
|d= t j « }|d xs || _ |d= |d r d| _ t j g| _ |j! d t" d « | _ |j! d
|
t" d
|
« | _ d}| j& rt( j* j- | j& « }|r>t( j* j/ |« r t( j* j1 |« r t( j* j3 |« r t5 d « | j$ s | j& rt j6 g| _ nt j6 g| _ |d sd | _ nd| _ |d | _ |d= | j: dk( rt= d| j: d« |d | _ g d¢}|D ] \ }} ||vr|| ||< ||= d|v sd|v r$ |d } |d= |d }
|
|d= | jG | |
|
« d|v r|d r
|
|d | _$ tK |d « | _& |d= d|v r|j d« | _( d |v r |d | _) |d = d } |jU « D ]¢ \ } } t" | | jW d « r0d} | jX j[ | j] d d« | i« Q| jW d « r d} | jX j[ | | i« d | z } t_ | || ja « « ¤ | jb rt( jd d!k( rd| _( | jP r4| j: d"k( r t= d#« | j: d$k( r t= d%« | rrd&| jX vrt" d' | jX d&< d(| jX vrt" d) | jX d(< d*| jX vs| jX d* d| jX d*< tg d+| jX v « tg d,| jX v « k7 r t5 d-« ti d.« ti | jX « k s d| jX d+< d| jX d,< n.| jX d+ du | jX d, du k7 r t5 d/« | jX j! d0« | jk « | jX j! d1« | jm « | jn i | _7 n÷tq | jn tr « s t= d2« | jn jU « D ]µ \ }}|tt v rtq |tv « s t= d3| d4| jn d« ty |« d5kD rt= d6| d7« |jW d « r t= d8« tq |tv « st= d9| d:| d;« ty |« d<kD s¥t= d9| d:| d=« | jz t j| z r| j « d>|v ry|d> ttq |d> tv « s t= d?« |d> j « }|d@k( r&t( jd dAk7 r t= dB« dC| _A n|dDk( rdE| _A n t= dF« dG|v r£|dG |dG | _B tq | j tv « s t= t j dH¬I« « | j dk( r t= t j dJ¬I« « dK| j vr t= t j dL¬I« « | j r | j dM| j dN« |j! dO« ³|dO | _G tq | j tv « s t= t j dH¬I« « | j dk( r t= t j dP¬I« « t( j* j/ | j « st= dQ| j dR« |j! dS« >|dS | _I tq | j tJ « r| j dTk r t= dU« |j! dV« ?|dV | _J tq | j tJ « r| j dTk r t= dW« yy# t $ r Y öw xY w# t $ r Y øw xY w# t $ r Y âw xY w# t $ r Y Ïw xY w# t $ r d | _ Y ®w xY w# t $ r d| _ Y ·w xY w# t $ r Y t@ $ r}t5 d« |d}~ww xY w# t $ r Y ¶w xY w# t $ r | jB } Y ©w xY w# t $ r | jD }
|
Y ¼w xY w# t $ r Y tN $ r}t= d« |d}~ww xY w# t $ r t5 d | d« dw xY w# t4 $ r t_ | || « Y ¥w xY w)Ya 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
|
NÚdsnz!Data source name is not supportedÚ get_warningsÚraise_on_warningsÚ client_flagsÚcompressTr] r^ z.allow_local_infile_in_path must be a directoryÚconsume_resultsFÚ auth_pluginrX Ú 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)rZ Úconnection_timeout)Úread_default_fileÚ option_filesrú r ÚhostÚportz'TCP/IP port number should be an integerrY Ú init_commandzUnsupported argument 'Ússl_Útls_Ú_r Úmysql_clear_passwordzEClear password authentication is not supported over insecure channelsÚ$authentication_openid_connect_clientzEOpenID Connect authentication is not supported over insecure channelsÚ verify_certÚssl_verify_certÚverify_identityÚssl_verify_identityÚcaÚkeyÚcertz:ssl_key and ssl_cert need to be both specified, or neither)r0 r1 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 strÚsspiÚntz6'kerberos_auth_mode=SSPI' is only available on WindowsÚMySQLSSPIKerberosAuthPluginÚgssapiÚMySQLKerberosAuthPluginz@Invalid 'kerberos_auth_mode' mode. Please use 'SSPI' or 'GSSAPI'Úkrb_service_principalzis not a string)Úerrorzcan not be an empty stringú/zis incorrectly formattedÚwebauth_callbackr Úopenid_token_filezcannot be an empty stringz
|
The path 'z1' provided via 'openid_token_file' does not existr[ r z.Option read_timeout must be a positive integerr\ z/Option write_timeout must be a positive integerrQ )Kr¾ r3 ra r4 r` Úcopyr0 r; r ÚKeyErrorr r* rc r r ÚCOMPRESSrÚ r" r r r® ÚpathÚabspathÚexistsÚisdirÚislinkrÔ Ú LOCAL_FILESr r r/ r Ú TypeErrorrk rl Ú set_loginrq Úintrr Ú
|
ValueErrorrw r rµ rÒ rv rÝ ÚreplaceÚsetattrrÖ rs r¯ r rÙ rø rí rj rÐ Údictr! rÑ Úlenrd Ú CONNECT_ARGSÚ_add_default_conn_attrsÚlowerr r| ÚKRB_SERVICE_PRINCIPAL_ERRORrà r{ Ú_validate_callabler} ÚOPENID_TOKEN_FILE_ERRORr r )r ÚkwargsÚconfigÚdefaultÚinfile_in_pathÚerrÚ
|
compat_mapÚcompatÚ translaterú r Ú set_ssl_flagr0 r¹ Ú attributerº r» r3 s rS rV z MySQLConnectionAbstract.config/ s ð" ZZ¤°Ó6
|
Ø zzÔ"3°TÓ: à Ø F?Ü#Ð$GÓHÐ Hô #Ñ, VÑ,ð Ø & ~Ñ 6DÔ Ø~Ð&ð Ø%+Ð,?Ñ%@DÔ "ØÐ*Ð+ð
|
Ü ×,Ñ,Ó.GØ & ~Ñ 6Ò A¸'DÔ Ø~Ð&ð ØjÒ!Ø!%Ü%/×%8Ñ%8Ð$9Ô!ð $*§:¡:Ø Ô"7Ð8LÑ"Mó$
|
Ô ð ,2¯:©:Ø (Ü !Ð">Ñ ?ó,
|
Ô(ð Ø × +Ò +Ü WW__¨T×-MÑ-MÓ NNá ÜGGNN >Ô2Ü nÔ5Ü77>> .Ô1ä$Ð%UÓVÐVØ × #Ò # t×'GÒ'GÜ!+×!7Ñ!7Ð 8DÕ ä",×"8Ñ"8Ð!8Ð 9DÔ ð *ØÐ+Ò,Ø(-Õ%à(,Ô%ð
|
#Ø & }Ñ 5DÔ Ø}Ð%ð
|
× Ñ Ð @Ò @Ü ØD×%Ñ%Ð&ð 'ð óð ð Ø#)Ð*;Ñ#<DÔ ò
|
|
ð ",ò Ñ FIð Ø FÑ*Ø(.¨v©F9Ñ%Ø6Nð ð VÑ z¨VÑ 3ð "Ø f~Ø6Nð *Ø! *Ñ-Ø:Ð&ð NN4 Ô *ð VÑ v¢Ø DJð UÜ V F^Ó,DJØvð VÑ #Ø!'§¡¨NÓ!;DÔ ð VÑ #Ø!'¨Ñ!7DÔ Ø~Ð&ð Ø ,,.ò 4JCð PÜ% cÒ*ð ~~fÔ%Ø # Ø × Ñ #§+¡+¨f°bÓ"9¸5Ð!AÕBØ Ô'Ø # Ø × Ñ # u Õ.à #I ð4ÜD )¨U¯[©[«]Õ;ð 4ð( × Ò ¤§¡¨GÒ!3Ø!%DÔ à × Ò Ø× Ñ Ð$:Ò:Ü$Ø[óð ð × Ñ Ð$JÒJÜ$Ø[óð ò Ø D§I¡IÑ-Ü+@ÐARÑ+S -Ñ(Ø ¨¯ © Ñ1Ü/DØ)ñ0 Ð+Ñ,ð 499Ñ$¨¯ © °$©Ð(?Ø"$ $ÜETYYÐ&Ó'¬4°¸$¿)¹)Ð0CÓ+DÒDÜ$ØPóð ô Ó'¬3¨t¯y©y«>Ò9Ø#' %Ñ Ø$( &Ò!Ø))EÑ" dÐ*°· ± ¸&Ñ0AÀTÐ0IÒJÜ$ØJóð ð yy}}^Ó,Ð8Ø×+Ñ+Ô-àyy}}Ð /Ó0Ð<Ø×/Ñ/Ô1à × Ñ Ð #Ø !DÕ ÜD× ,Ñ ,¬dÔ3Ü Ð!BÓCÐ Cà)-×)9Ñ)9×)?Ñ)?Ó)Aò Ñ% :Ø ¤ Ñ-Ø ä! )¬SÔ1Ü(ð Ø %; f¨T×-=Ñ-=Ð,>¸aðAóð ô
|
y> BÒ&Ü(Ø*¨9¨+Ð5WÐXóð ð ×'Ñ'¨Ô,Ü(ð4óð ô
|
" *¬cÔ2Ü(Ø% i [°
|
¸:¸,ð G+ð +óð ô
|
z? TÓ)Ü(Ø% i [°
|
¸:¸,ð G=ð =óð ð9 ðB × Ñ ¤
|
× 7Ñ 7Ò 7Ø × (Ñ (Ô *à 6Ñ )¨fÐ5IÑ.JÐ.VÜ fÐ%9Ñ :¼CÔ@Ü$Ð%OÓPÐPØ!'Ð(<Ñ!=×!CÑ!CÓ!EÐ Ø! VÒ+Ü77d?Ü(ØPóð ð +HÕ'Ø# xÒ/Ø*CÕ'ä$ØVóð ð
|
$ vÑ -ØÐ.Ñ/Ð;à*0Ð1HÑ*IDÔ 'Ü d× 9Ñ 9¼3Ô?Ü$Ü/×6Ñ6Ð=NÐ6ÓOóð ð ×*Ñ*¨bÒ0Ü$Ü/×6Ñ6Ø :ð 7ó óð ð
|
$×5Ñ5Ñ5Ü$Ü/×6Ñ6Ð=WÐ6ÓXóð ð × "Ò "Ø × #Ñ #Ð$6¸×8OÑ8OÐQRÔ Sà ::Ð)Ó *Ð 6Ø&,Ð-@Ñ&ADÔ #Ü d× 5Ñ 5´sÔ;Ü$Ü+×2Ñ2Ð9JÐ2ÓKóð ð ×&Ñ&¨"Ò,Ü$Ü+×2Ñ2Ð9TÐ2ÓUóð ô 77>> $×"9Ñ"9Ô:Ü$Ø ×!8Ñ!8Ð 9ð :%ð %óð ð
|
::nÓ %Ð 1Ø!'¨Ñ!7DÔ Ü d× 0Ñ 0´#Ô6¸$×:LÑ:LÈqÒ:PÜ$Ð%UÓVÐVØ ::oÓ &Ð 2Ø"(¨ Ñ"9DÔ Ü d× 1Ñ 1´3Ô7¸4×;NÑ;NÐQRÒ;RÜ$Ð%VÓWÐWð <Sð 3øôM ò Ú ð ûô
|
ò Ú ð ûô ò Ú ð ûô ò Ú ð ûô< ò *Ø$)D× !ð *ûô ò #Ø "D× ð #ûô ò Ú Üò Ü ð0óð ð ûð ûô( ò Úð ûô ò "Øzzð "ûô
|
ò *Ø >>ð *ûô ò Ú Üò UÜ Ð!JÓKÐQTÐ Tûð Uûô ò PÜ$Ð'=¸c¸UÀ!Ð%DÓEÈ4ÐOð Pûô &ò 4ÜD )¨U×3ð4úsü Á" e Á0 e) Á>%e9 Â$"f Ç*f Ç? f0 È5
|
g É g/É&g? É/h Ê h7 Ë7 i Í8i<å e&å%e&å) e6å5e6å9 fæfæ fæfæf-æ,f-æ0gçgç g,çg,ç g'ç'g,ç/ g<ç;g<ç?hèhèh4è3h4è7 i éi é iéi é i9é<jêjc ó y)z'Adds the default connection attributes.NrQ r s rS rP z/MySQLConnectionAbstract._add_default_conn_attrsy r rR c ó t |t « r t |« }t |« st d| d« t t |« j « }||k7 rt d| d| d| « y# t $ r}t | « |d}~ww xY w)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 rJ r1 ÚcallablerN r Ú
|
parameters)Ú option_nameÚcallbackÚnum_argsrY Ú
|
num_paramss rS rS z*MySQLConnectionAbstract._validate_callable| sª ô$ h¤Ô $ð :Ü(¨Ó2ô Ô!Ü"Ð%>¸{¸mÈ1Ð#MÓNÐ Nô 8Ó,×7Ñ7Ó8
|
Ø Ò !Ü"ØK= ¨H¨:ð 6)Ø)3¨ ð6óð ð "øô ò :Ü&¨#¨Ó0°cÐ9ûð :ús A/ Á/ B
|
Á8 BÂB
|
Úserver_versionc ó& t | t t f« r| j « } t j
|
d« }|j | « }|s t d« t d |j « dd D « « }|dk rt d| 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 3 ó2 K | ] }t |« y wr )rI )Ú.0Úvs rS ú <genexpr>z@MySQLConnectionAbstract._check_server_version.<locals>.<genexpr>³ s è ø Ò< 1AÑ<ùs r é )é r zMySQL Version 'z' is not supported)
|
rÐ Ú bytearrayÚbytesÚdecodeÚreÚcompileÚmatchr/ ÚtupleÚgroups)rg Ú regex_verrt Úversions rS Ú_check_server_versionz-MySQLConnectionAbstract._check_server_version s ô n¤y´%Ð&8Ô 9Ø +× 2Ñ 2Ó 4NäJJÐ FÓG Ø Ó/ÙÜ Ð!?Ó@Ð @äÑ<¨¯ © «°q¸Ð(;Ô<Ó<Ø VÒ Ü ?°>Ð2BÐBTÐ!UÓVÐ VàrR ©Ú property_namec ó | j S )z£Gets the MySQL version.
|
|
Returns:
|
The MySQL server version as a tuple. If not previously connected, it will
|
return `None`.
|
©rh r s rS Úget_server_versionz*MySQLConnectionAbstract.get_server_version¹ ó ð ×#Ñ#Ð#rR Ú server_infoc ó | 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 s rS Úget_server_infoz'MySQLConnectionAbstract.get_server_infoà s ð × Ñ Ð rR c ó | 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 s rS rg z&MySQLConnectionAbstract.server_versionÍ r rR c óL | j d S # t t f$ r Y yw xY w)z½Gets the original MySQL server version information.
|
|
Returns:
|
The original MySQL server as text. If not previously connected, it will
|
return `None`.
|
Úserver_version_originalN)ri rG r? r s rS r z#MySQLConnectionAbstract.server_info× s. ð Ø??Ð#<Ñ=Ð =øÜ8Ð$ò Ùð ús #¢#c ó y)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
|
```
|
NrQ r s rS Úin_transactionz&MySQLConnectionAbstract.in_transactionä r rR r c ó( || _ | 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 Úflagss rS Úset_client_flagsz(MySQLConnectionAbstract.set_client_flagsú s ð: "ÔØ× Ñ Ð rR c ó | j S )z-Gets the client flags of the current session.©rd r s rS r z$MySQLConnectionAbstract.client_flags s ð ×!Ñ!Ð!rR c ó t |t « r |dkD r|| _ yt |t t f« rB|D ]< }|dk r | xj t |« z c_ (| xj |z c_ > yt d« )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Ð rI rd ru r´ Úabsr1 )r r Úflags rS r z$MySQLConnectionAbstract.client_flags sv ô4 eSÔ ! e¨a¢iØ!&DÕ Ü ¤¤t}Ô -Ø ò /Ø!8Ø×&Ò&¬3¨t«9¨*Ñ4Ö&à×&Ò&¨$Ñ.Ö&ñ /ô #Ð#SÓTÐ TrR c ó t )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.
|
)ÚNotImplementedErrorr s rS Úshutdownz MySQLConnectionAbstract.shutdownD s
|
ô "Ð!rR c ó& | j |z dkD S )z|Checks if a client flag is set.
|
|
Returns:
|
`True` if the client flag was set, `False` otherwise.
|
r r )r r s rS Úisset_client_flagz)MySQLConnectionAbstract.isset_client_flagO s ð ×"Ñ" TÑ)¨QÑ.Ð.rR c ó* | j d« d S )zGets the current time zone.zSELECT @@session.time_zoner ©Ú
|
info_queryr s rS Ú time_zonez!MySQLConnectionAbstract.time_zoneW s ð Ð ;Ó<Ø ñ
|
ð
|
rR c ó< | j d| d« || _ y)zSets the time zone.zSET @@session.time_zone = 'rÇ N)r rf r s rS r z!MySQLConnectionAbstract.time_zone^ s! ð Ð4°U°G¸1Ð=Ô>Ø rR c ód | j | j d« d | _ | j S )zGets the SQL mode.zSELECT @@session.sql_moder )re r r s rS Úsql_modez MySQLConnectionAbstract.sql_moded s. ð >>Ð !Ø !__Ð-HÓ IÈ!Ñ LDNØ~~Ð rR c ó t |t t f« rdj |« }| j d| d« || _ y)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´ ru râ r re r s rS r z MySQLConnectionAbstract.sql_modek s< ô ed¤E]Ô +ØHHUOEØ Ð3°E°7¸!Ð<Ô=Ø rR c ó y)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).
|
NrQ ©r Úquerys rS r z"MySQLConnectionAbstract.info_query~ r rR Nc ód ||j « | _ nd| _ ||| _ yd| _ y)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.
|
NrX )rÖ rk rl )r r r s rS rH z!MySQLConnectionAbstract.set_login s3 ð Ð Ø! Ó)DJàDJØ Ð Ø %DNà DNrR Ú use_unicodec ó || _ y©zSets whether we return string fields as unicode or not.
|
|
Args:
|
value: A boolean - default is `True`.
|
N)r¡ r s rS Ú set_unicodez#MySQLConnectionAbstract.set_unicode¥ s ð !ÕrR c ó | j S )z7Gets whether we return string fields as unicode or not.)r~ r s rS r¡ z#MySQLConnectionAbstract.use_unicode® r rR c ó yr£ rQ r s rS r¡ z#MySQLConnectionAbstract.use_unicode³ r rR c ó4 | j d« d }|dk( S )z%Gets whether autocommit is on or off.zSELECT @@session.autocommitr r r r s rS Ú
|
autocommitz"MySQLConnectionAbstract.autocommit¼ s" ð Ð =Ó>¸qÑAØzÐrR c óF |rdnd}| j d| « || _ y)zToggles autocommit.ÚONÚOFFzSET @@session.autocommit = N)r rg )r r¹ Úswitchs rS r¨ z"MySQLConnectionAbstract.autocommit s) ñ EØ Ð4°V°HÐ=Ô>Ø ÕrR c ó | 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.
|
)r r s rS r z$MySQLConnectionAbstract.get_warningsÉ s ð ×!Ñ!Ð!rR c óH t |t « s t d« || _ y)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 rJ r r s rS r z$MySQLConnectionAbstract.get_warningsÔ s" ô %¤Ô&Ü Ð 6Ó7Ð 7Ø "ÕrR c ó | 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`.
|
)r r s rS r z)MySQLConnectionAbstract.raise_on_warningsá s ð ×&Ñ&Ð&rR c ó\ t |t « s t d« || _ |r|| _ yy)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 rJ r r r s rS r z)MySQLConnectionAbstract.raise_on_warningsì s2 ô %¤Ô&Ü Ð 6Ó7Ð 7Ø"'Ô á Ø!&DÕ ð rR c ó | 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.
|
)r
r s rS Ú unread_resultz%MySQLConnectionAbstract.unread_result ó ð ×"Ñ"Ð"rR c óH t |t « s t d« || _ y)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 rJ r
r s rS r³ z%MySQLConnectionAbstract.unread_result s" ô %¤Ô&Ü Ð 6Ó7Ð 7Ø #ÕrR c óR | j 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 s rS Ú collationz!MySQLConnectionAbstract.collation s& ð ×"Ñ"×3Ñ3°D×4DÑ4DÓEÀaÑHÐHrR c óR | j 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_infor¹ r s rS Úcharsetz MySQLConnectionAbstract.charset$ s& ð ×"Ñ"×+Ñ+¨D×,<Ñ,<Ó=¸aÑ@Ð@rR c ó | j S )úThe charset ID utilized during the connection phase.
|
|
If the charset ID hasn't been set, the default charset ID is returned.
|
)r¹ r s rS Ú
|
charset_idz"MySQLConnectionAbstract.charset_id0 s ð × Ñ Ð rR c ó | j 2| j t S | j dk rt nt | _ | j S )rÀ )é r )r_ rh r$ r% r s rS r¹ z#MySQLConnectionAbstract._charset_id8 sR ð × Ñ Ð $Ø×#Ñ#Ð+ô
|
3Ð2ð ×'Ñ'¨&Ò0õ ,ä0ð Ô ð × Ñ Ð rR c ó || _ y)z9Sets the charset ID utilized during the connection phase.N)r_ r s rS r¹ z#MySQLConnectionAbstract._charset_idN s ð "ÕrR c ó` | j j | j « d }|dv ry|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 )Úutf8mb4Úutf8mb3ÚbinaryÚutf8r¼ )r Úencodings rS Úpython_charsetz&MySQLConnectionAbstract.python_charsetS s6 ð ×&Ñ&×/Ñ/°×0@Ñ0@ÓAÀ!ÑDØ Ð7Ñ 7ØØrR c óú d}t |t t f« s |t |j d« « t |t « s | t d« |r
t |t « r%| j
|
j |« \ | _ }}n§t |t « r&| j
|
j ||« \ | _ }}nqt |j d« « |r&| j
|
j |¬« \ | _ }}n/t d }| j
|
j |d¬« \ | _ }}| j d| d| d« | j r(| j j || j
|
¬ « yy)
|
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)rº z SET NAMES 'z ' COLLATE 'rÇ )Ú character_set) rÐ rI rÑ rJ rà r r¸ r¹ r" Ú_execute_queryr Ú set_charset)r r¾ rº Úerr_msgÚ charset_nameÚcollation_names rS Úset_charset_collationz-MySQLConnectionAbstract.set_charset_collationc sx ð6 @Ü'¤C¬ :Ô.°7Ð3FÜ W^^¨IÓ 6Ó7Ð 7Ü)¤SÔ)¨iÐ.CÜ Ð HÓIÐ Iá Ü'¤3Ô'ð
|
×'Ñ'×8Ñ8¸ÓAñ ØÔ$Ø Ù"äG¤SÔ)ð
|
×'Ñ'×8Ñ8¸À)ÓLñ ØÔ$Ø Ù"ô ! § ¡ ° Ó!:Ó;Ð;Ù ð
|
×#Ñ#×4Ñ4¸yÐ4ÓIñ ØÔ Ø Ù ô ,¨IÑ6Gð
|
×#Ñ#×4Ñ4°WÈÐ4ÓMñ ØÔ Ø Ø ð ×Ñk¨,¨ °{À>ÐBRÐRSÐ TÔUà >>Ø NN× &Ñ & |À4×CVÑCVÐ &Õ Wð rR c ó | 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.
|
©r r s rS r[ z$MySQLConnectionAbstract.read_timeout¦ ó ð ×!Ñ!Ð!rR c óV | t |t « r|dk r t d« || _ y)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Ð rI r/ r ©r Útimeouts rS r[ z$MySQLConnectionAbstract.read_timeout³ s4 ð2 Ð Ü g¤sÔ+¨w¸ª{Ü$ØLóð ð %ÕrR c ó | 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.
|
©r r s rS r\ z%MySQLConnectionAbstract.write_timeoutÓ ó ð ×"Ñ"Ð"rR c óV | t |t « r|dk r t d« || _ y)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Ð rI r/ r rÚ s rS r\ z%MySQLConnectionAbstract.write_timeoutà s4 ð2 Ð Ü g¤sÔ+¨w¸ª{Ü$ØMóð ð &ÕrR c ó y)zMySQL connection ID.NrQ r s rS Ú connection_idz%MySQLConnectionAbstract.connection_id r rR c ó y)z>Gathers information of the MySQL server before authentication.NrQ r s rS Ú _do_handshakez%MySQLConnectionAbstract._do_handshake r rR c ó y)z)Opens the connection to the MySQL server.NrQ r s rS Ú_open_connectionz(MySQLConnectionAbstract._open_connection r rR c ó" | j | j ¬« | j | _ | j r| j | _ | j r| j | _ | j r | j | j « yy)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.
|
©r¾ N)
|
rÓ r¹ rg r¨ rf r re r r rÎ r s rS Ú_post_connectionz(MySQLConnectionAbstract._post_connection sn ð ×"Ñ"¨4×+;Ñ+;Ð"Ô<Ø ×*Ñ*Ø ??Ø !__DNØ >>Ø NNDMØ × Ò Ø × Ñ × 2Ñ 2Õ 3ð rR c ó y)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()`.
|
NrQ r s rS r£ z MySQLConnectionAbstract.close r rR z5ClassVar[Callable[['MySQLConnectionAbstract'], None]]Ú
|
disconnectc ól |r | j d i |¤ | j « | j « |j dd« |j dd« }}|s|r$| j j ||« d | _ | j t j z s| j « y | j | j ¬« y# t $ r] | j d| j xs | j d« | j | j ¬« | j d« Y yw xY w)
|
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¾ Nrº r rê zSET PASSWORD = 'rÇ z)ALTER USER CURRENT_USER() PASSWORD EXPIRErQ )rV rí rè r¾ r r¸ r¹ rd r* Ú CAN_HANDLE_EXPIRED_PASSWORDSrë rÓ r- r rm rl )r rU r¾ rº s rS Úconnectz MySQLConnectionAbstract.connect- s ñ& Ø DKKÑ !&Ò !à ÔØ × Ñ Ô ð JJy $Ó 'Ø JJ{ DÓ )ð ñ iØ #× 2Ñ 2× CÑ CÀGÈYÓ WØñ DÔ ð ×!Ñ!¤J×$KÑ$KÒKØ × !Ñ !Õ #ð LØ×*Ñ*°4×3CÑ3CÐ*ÕDøÜ ò Lð Ð!1°$·/±/Ò2SÀTÇ^Á^Ð1TÐTUÐ VÔWð ×*Ñ*°4×3CÑ3CÐ*ÔDð Ð JÖKð Lús Â0 C à A#D3Ä2D3c óf d}d}| j r9| j j t t j j
|
¬« } ||k7 rN|dz } | j « | j « | j « rn |dkD r t |« ||k7 rN|| _ t rt | | j" « yy# t t f$ r#}||k( rd| d| }t |« |Y d}~hd}~ww xY w# t $ r/}t r#t | |« t ||« t! |« d}~ww xY w)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` Ú
|
start_spanr2 r9 ÚSpanKindÚCLIENTrí rð Ú is_connectedr. ÚIOErrorr/ r r5 r8 r7 r6 ra )r ÚattemptsÚdelayÚcounterÚspanrY ÚmsgÚ interface_errs rS Ú reconnectz!MySQLConnectionAbstract.reconnectc s9 ð$ Øà <<à<<×*Ñ*Ü)´·±×0EÑ0Eð +ó Dð ØXÒ%Ø! A+ð ;ØOOÔ%ØLLNØ×(Ñ(Ô*Ø ð +ð 19Ü%Lð XÓ%ð.
|
Ý Ü % d¨D¯J©JÕ 7ð øô# wÐ'ò ;Ø (Ò*à ?À¸zð J+Ø+.¨%ð 1ð ô -¨SÓ 1°sÐ:ô +ûð;ûô ò ÝÜ)¨$°Ô5Ü& t¨]Ô;ÜØ ûð úsB Á
|
C8 Á0C ÂC8 ÃC5ÃC0Ã+C8 Ã0C5Ã5C8 Ã8 D0Ä*D+Ä+D0c ó y)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
|
NrQ r s rS rö z$MySQLConnectionAbstract.is_connected r rR c ó y)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.
|
NrQ )r rþ rø rù s rS Úpingz MySQLConnectionAbstract.ping£ r rR c ó y)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()
|
```
|
NrQ r s rS Úcommitz MySQLConnectionAbstract.commit» r rR c ó y)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.
|
NrQ )r ÚbufferedÚrawÚpreparedÚ cursor_classÚ
|
dictionaryr[ r\ s rS Úcursorz MySQLConnectionAbstract.cursorÏ r rR c ó y)zExecutes a query.NrQ r s rS rÎ z&MySQLConnectionAbstract._execute_query r rR c ó y)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()
|
```
|
NrQ r s rS Úrollbackz MySQLConnectionAbstract.rollback r rR c ó¦ | j r t d« |rY|j « j dd« j « }g d¢}||vrt d| d« | j d| « |C| j d k rt d
|
| j d « |rd }nd }| j d| « d}|r|dz }| j |« y)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 READÚ 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Ö rK r× rJ rÎ rh r )r Úconsistent_snapshotÚisolation_levelÚreadonlyÚlevelÚlevelsÚ access_moder s rS Ústart_transactionz)MySQLConnectionAbstract.start_transaction sü ðN × Ò Ü"Ð#DÓEÐ Eá Ø#×)Ñ)Ó+×3Ñ3°C¸Ó=×CÑCÓEEòFð FÑ"Ü Ð#<¸_Ð<MÈQÐ!OÓPÐPà × Ñ Ð"BÀ5À'Ð JÔ Kà Ð Ø×#Ñ# iÒ/Ü Ø+¨D×,@Ñ,@Ð+Að B+ð +óð ñ
|
Ø ) à * Ø × Ñ Ð"2°;°-Ð @Ô Aà#Ù Ø Ð0Ñ 0EØ uÕ rR c ó y)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)
|
```
|
NrQ )r Úuser_variablesÚsession_variabless rS Ú reset_sessionz%MySQLConnectionAbstract.reset_sessiong r rR r c ó || _ y)úÅ
|
Sets the converter class to be used.
|
|
Args:
|
convclass: Should be a class overloading methods and members of
|
`conversion.MySQLConverter`.
|
N)r )r Ú convclasss rS Úset_converter_classz+MySQLConnectionAbstract.set_converter_class s ð )Õ rR c ó | j S )z5Gets the converter class set for the current session.)r r s rS r z'MySQLConnectionAbstract.converter_class r rR c ó |rst |t « rc| j j | j « d }|| _ ||| j « | _ | j | j _ yt d« )r r zFConverter class should be a subclass of conversion.MySQLConverterBase.N) Ú
|
issubclassr, r r½ r¹ r r¡ r r Ú str_fallbackrG )r r! rÑ s rS r z'MySQLConnectionAbstract.converter_class sp ñ IÔ/AÔBØ ×.Ñ.×7Ñ7¸×8HÑ8HÓIÈ!ÑLLØ$-DÔ !Ù & |°T×5EÑ5EÓ FDNØ*.×*FÑ*FDNNÕ 'äØXóð rR c ó y)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.
|
NrQ )r rÈ Úcolumnsr Ú prep_stmtrU s rS Úget_rowz MySQLConnectionAbstract.get_rowª r rR c ó y)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.
|
NrQ )r ÚcountrÈ r( r r) rU s rS Úget_rowsz MySQLConnectionAbstract.get_rowsÈ r rR c ó y)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.
|
NrQ )r r s rS Ú cmd_init_dbz#MySQLConnectionAbstract.cmd_init_dbé r rR c ó y)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
|
NrQ )r r r r Ú raw_as_stringrU s rS r z!MySQLConnectionAbstract.cmd_queryø r rR c ó y)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
|
```
|
NrQ )r Ú
|
statementsrU s rS Úcmd_query_iterz&MySQLConnectionAbstract.cmd_query_iter r rR c ó y)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.
|
NrQ )r Úoptionss rS Ú cmd_refreshz#MySQLConnectionAbstract.cmd_refreshC r rR c ó y)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.
|
NrQ r s rS Úcmd_quitz MySQLConnectionAbstract.cmd_quit_ r rR c ó y)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.
|
NrQ )r Ú shutdown_types rS Ú cmd_shutdownz$MySQLConnectionAbstract.cmd_shutdownl r rR c ó y)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.
|
NrQ r s rS Úcmd_statisticsz&MySQLConnectionAbstract.cmd_statisticst r rR c ó t d« )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_SCHEMA)r0 rQ rR rS Úcmd_process_infoz(MySQLConnectionAbstract.cmd_process_info~ s ô Ø Ió
|
ð
|
rR c ó y)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)
|
```
|
NrQ )r Ú mysql_pids rS Úcmd_process_killz(MySQLConnectionAbstract.cmd_process_kill r rR c ó y)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.
|
NrQ r s rS Ú cmd_debugz!MySQLConnectionAbstract.cmd_debug£ r rR c ó y)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.
|
NrQ r s rS Úcmd_pingz MySQLConnectionAbstract.cmd_ping r rR c ó y)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
|
NrQ ) r r r r r¾ Ú password1Ú password2Ú password3Úoci_config_fileÚoci_config_profiler= s rS Úcmd_change_userz'MySQLConnectionAbstract.cmd_change_user¸ r rR c ó y)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
|
NrQ )r Ú statementrU s rS Úcmd_stmt_preparez(MySQLConnectionAbstract.cmd_stmt_prepareç r rR c ó y)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
|
NrQ )r Ú statement_idÚdatarb r rU s rS Úcmd_stmt_executez(MySQLConnectionAbstract.cmd_stmt_executeý r rR c ó y)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.
|
NrQ ©r rS rU s rS Úcmd_stmt_closez&MySQLConnectionAbstract.cmd_stmt_close( r rR c ó y)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
|
NrQ )r rS Úparam_idrT rU s rS Úcmd_stmt_send_long_dataz/MySQLConnectionAbstract.cmd_stmt_send_long_data8 r rR c ó y)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.
|
NrQ rW s rS Úcmd_stmt_resetz&MySQLConnectionAbstract.cmd_stmt_resetU r rR c ó y)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`.
|
NrQ r s rS Úcmd_reset_connectionz,MySQLConnectionAbstract.cmd_reset_connectione r rR ©ÚreturnÚNone)ra rU ©r¥ zType[BaseException]r¦ Ú BaseExceptionr§ r ra rb )ra r )ra z$List[Tuple[str, BinaryProtocolType]])r¹ z Tuple[str, BinaryProtocolType]ra rb ©r¯ rÑ ra r> )ra rÑ ©ra rI ©ra ú Optional[str])r¹ rÑ ra rb )r¹ r ra rb )ra r )r¹ r ra rb )rU r ra rb )r )rc rÑ rd zUnion[str, Callable]re rI ra rb )rg rG ra zTuple[int, ...])ra zOptional[Tuple[int, ...]])r úUnion[int, Sequence[int]]ra rI )r ri ra rb )ra r )r rI ra r )r¹ zUnion[str, Sequence[int]]ra rb )r rÑ ra zOptional[RowType]©NN)r rh r rh ra rb ©T)r¹ rI ra rb )r¾ zOptional[Union[int, str]]rº rh ra rb ©ra ú Optional[int]©rÛ rm ra rb )r r )rø rI rù rI ra rb )Fr r )rþ r rø rI rù rI ra rb )NNNNNNN)r úOptional[bool]r ro r ro r z%Optional[Type['MySQLCursorAbstract']]r ro r[ rm r\ rm ra z'MySQLCursorAbstract')r rÑ ra rb )FNN)r r r rh r ro ra rb )r úOptional[Dict[str, Any]]r rp ra rb )r! ú Optional[Type[MySQLConverter]]ra rb )ra rq )FNNN) rÈ r r( ú Optional[List[DescriptionType]]r ro r) úOptional[CMySQLPrepStmt]rU r ra z2Tuple[Optional[RowType], Optional[Dict[str, Any]]])NFNNN)r, rm rÈ r r( rr r ro r) rs rU r ra z.Tuple[List[RowType], Optional[Dict[str, Any]]])r rÑ ra rp )FFF) r rÑ r ro r r r1 r rU r ra rp )r3 rÑ rU r ra z(Generator[Mapping[str, Any], None, None])r6 rI ra zDict[str, Any])ra zOptional[bytes]r )r; rm ra rb )ra rp )rB rI ra rp )
|
rX rX rX NrX rX rX rX rX rX )r rÑ r rÑ r rÑ r¾ rm rI rÑ rJ rÑ rK rÑ rL rÑ rM rÑ r= rÑ ra rp )rP rp rU r ra z(Union[Mapping[str, Any], CMySQLPrepStmt])rQ rQ r ) rS úUnion[int, CMySQLPrepStmt]rT z Sequence[BinaryProtocolType]rb r r rI rU r ra z&Optional[Union[Dict[str, Any], Tuple]])rS rt rU r ra rb )
|
rS rt rZ rI rT r rU r ra rI )drM rN rO rP r r r¨ r« Úpropertyr° r² r¶ r¼ rÀ r rí rø rú rý rÿ r r r Úsetterr
|
r rV rP Ú staticmethodrS ry r: r# rà r~ r rg r r r r r r r r r rH r¤ r¡ r¨ r r r³ rº r¾ rÁ r¹ rË rÓ r[ r\ rä ræ rè rë r£ rí Ú__annotations__rð rþ rö r r r
|
rÎ r r r r" r r* r- r/ r r4 r7 r9 r< r> r@ rC rE rG rN rQ rU rX r[ r] r_ rQ rR rS rU rU ¶ s
ÙBóR)óhðà%ðð !ðð !ð ð
|
|
ó óð ò
|
ó ð
|
ð ò&ó ð&ð ò/ó ð/ó 6ó1ó ó]
|
ó~ORðb òó ðð òó ðð òó ðð ò!ó ð!ð Øò$ó ó ð$ð __ò'ó ð'ð ò%ó ð%ð × Ñ ò&ó ð&ð
|
ò)ó ð)ð × Ñ ò*ó ð*óHXóT
|
6ð àJKð Øð Ø$8ð ØDGð à ò ó ð ðD òó ðñ2 Ð0Ð)×0Ñ0Ð?OÔPÓQò$ó Rð$ñ Ð0Ð)×0Ñ0¸}ÔMÓNò ó Oð ð ò$ó ð$ð ò
|
ó ð
|
ð Øò ó ó ð ñ( Ð0Ð)×0Ñ0¸~ÔNÓOò !ó Pð !ð> ò"ó ð"ð ×Ñò"Uó ð"UóH "ó/ð ò
|
ó ð
|
ð ×Ñò ó ð ð
|
ò ó ð ð __ò ó ð ð$ ò ó ð ð& IMð Ø%ð Ø8Eð à ó ñ( Ð0Ð)×0Ñ0¸}ÔMÓNó!ó Oð!ð ò!ó ð!ð ×ÑØò ó ó ð ð òó ðð
|
×Ñò!ó ð!ð ò"ó ð"ð ×Ñò
|
#ó ð
|
#ð ò'ó ð'ð × Ñ ò'ó ð'ð& ò#ó ð#ð ×Ñò
|
$ó ð
|
$ð ò Ió ð Ið ò Aó ð Að ò ó ð ð ò!ó ð!ð* ×Ñò"ó ð"ð ò ó ð ð UYðAXØ0ðAXØDQðAXà óAXðF ò
|
"ó ð
|
"ð ×Ñò %ó ð %ð> ò
|
#ó ð
|
#ð ×Ñò &ó ð &ð> Øò#ó ó ð#ð òMó ðMð ò8ó ð8ó4ð ò ó ð ð INJÐEÓMó4Lôl58ðn ò ó ð ð ó ó ð ð. ò ó ð ð& ð $(Ø "Ø#'Ø>BØ%)Ø&*Ø'+ð6 à ð6 ð ð6 ð !ð 6 ð
|
<ð 6 ð #ð 6 ð $ð6 ð %ð6 ð
|
ò6 ó ð6 ðp ò ó ð ð ò ó ð ð$ %*Ø)-Ø#'ð H à !ðH ð 'ðH ð !ð H ð
|
|
ó H ðT ð 48Ø6:ð à0ð ð 4ð ð
|
ò ó ð ñ> Ð0Ð)×0Ñ0Ð?PÔQÓRò)ó Sð)ð ò%ó ð%ð ×Ñòó ðð$ ð Ø37Ø "Ø.2ð àð ð 1ð ð ð ð
|
,ð ð ð ð
|
<ò ó ð ð: ð $Ø Ø37Ø "Ø.2ð à ð ð ð ð 1ð ð
|
ð ð ,ð ð ð ð
|
8ò ó ð ð@ ò ó ð ð ð $Ø Ø #ð % àð% ð ð% ð ð % ð
|
ð % ð ð % ð
|
"ò% ó ð% ðN ð àð ð ð ð
|
2ò ó ð ðD ò ó ð ð6 ò
|
ó ð
|
ð ó ó ð ð ò ó ð ð ò
|
ó ð
|
ð ò ó ð ð& ò ó ð ð ò ó ð ð ð ØØØ!%ØØØØ !Ø"$Ø!#ð, àð, ð ð, ð ð , ð
|
ð , ð ð , ð ð, ð ð, ð ð, ð ð, ð ð, ð
|
"ò, ó ð, ð\ ð àð ð ð ð
|
2ò ó ð ð* ð .0Ø !Øð ( à0ð( ð +ð( ð ð ( ð
|
ð ( ð ð ( ð
|
0ò( ó ð( ðT ð à0ð ð ð ð
|
ò ó ð ð ð à0ð ð ð ð ð ð
|
ð ð
|
ò ó ð ð8 ð à0ð ð ð ð
|
ò ó ð ð ò ó ñ rR rU c ó e Zd ZdZ d$ d%dZd&dZ d'dZed(d« Zej d)d« Zed(d« Z
|
e
|
j d)d « Z
|
e d* d+d
|
« Z e d,d « Z e d- d.d « Ze d/d « Ze d0d« Ze d1d2d« Ze d3d« Z d4dZe d5d« Ze d6d« Zd7dZd8d9dZd:d;dZed<d« Zed=d« Zed(d« Zed>d« Z ed=d« Z ed?d « Z e e jB d ¬ « « d>d « Z"d@d Z#dAd!Z$dBd"Z%d,d#Z&y)CÚMySQLCursorAbstractzAbstract cursor class
|
|
Abstract class defining cursor class with method and members
|
required by the Python Database API Specification v2.0.
|
Nc óp || _ |6t |t « s t d¬« t j
|
|« | _ d| _ d| _ d| _ d| _ d| _
|
d| _ g | _ g | _ d| _ d| _ d| _ d| _ || _ || _ d| _ d| _ d| _ y) z#Defines the MySQL cursor interface.Ni )ÚerrnorÈ r r Frj )Ú _connectionrÐ rU r/ ÚweakrefÚproxyÚ _descriptionÚ _rowcountÚ_last_insert_idÚ _warningsÚ_warning_countÚ _executedÚ_executed_listÚ_stored_resultsÚ arraysizeÚ_binaryr Ú_nextrowr r Ú_stmt_partitionsÚ_stmt_partitionÚ_stmt_map_results)r Ú
|
connectionr[ r\ s rS r z MySQLCursorAbstract.__init__~ sË ð ?IÔØ Ð !Ü jÔ*AÔBÜ$¨4Ô0Ð0Ü &}}¨ZÓ 8DÔ à=AÔØ Ø.2Ô Ø6:Ø#$ÔØ*.Ø+-ÔØ:<Ô Ø Ø " Ø ð
|
ð ð -9ÔØ-:Ôð ð Ô ð @DÔ Ø',Õ rR c ó | S r rQ r s rS r z MySQLCursorAbstract.__enter__§ r rR c ó$ | j « y r r¢ r¤ s rS r¨ z MySQLCursorAbstract.__exit__ª r© rR c ó | 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.
|
rÕ r s rS r[ z MySQLCursorAbstract.read_timeout² rÖ rR c óV | t |t « r|dk r t d« || _ y)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 rØ rÙ rÚ s rS r[ z MySQLCursorAbstract.read_timeout¿ s4 ð4 Ð Ü g¤sÔ+¨w¸ª{Ü$ØLóð ð %ÕrR c ó | j S rÝ rÞ r s rS r\ z!MySQLCursorAbstract.write_timeoutà rß rR c óV | t |t « r|dk r t d« || _ y)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Ú s rS r\ z!MySQLCursorAbstract.write_timeoutí s4 ð4 Ð Ü g¤sÔ+¨w¸ª{Ü$ØMóð ð &ÕrR c ó y)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
|
NrQ )r ÚprocnameÚargss rS Úcallprocz MySQLCursorAbstract.callproc
|
r rR c ó y)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.
|
NrQ r s rS r£ zMySQLCursorAbstract.closeB
|
r rR c ó y)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
|
```
|
NrQ )r Ú operationÚparamsÚ map_resultss rS ÚexecutezMySQLCursorAbstract.executeM
|
r rR c ó y)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')
|
```
|
NrQ )r r Ú
|
seq_paramss rS Ú executemanyz MySQLCursorAbstract.executemanyÓ
|
r rR c ó y)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()
|
```
|
NrQ r s rS Úfetchonez MySQLCursorAbstract.fetchone r rR c ó y)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.
|
NrQ )r Úsizes rS Ú fetchmanyz MySQLCursorAbstract.fetchmany r rR c ó y)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()
|
```
|
NrQ r s rS Úfetchallz MySQLCursorAbstract.fetchall" r rR c # ó K d}| j s | j } | j « }| j r | j n||f | j « rA | j « }| j r | j n||f | j « r@yy# t $ r g }Y }w xY w# t $ r g }Y Ow xY ww)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 rP r¨ r/ Únextset)r Ústatement_cachedÚ
|
result_sets rS Ú fetchsetsz MySQLCursorAbstract.fetchsets2 sÄ è ø ðr ÐØ×%Ò%Ø #~~Ð ð Ø Jð #× 4Ò 4DNNÐ:JØ ðò ð llnð Ø !]]_
|
ð #'×"8Ò"8Ð>NØðò ð llnøô ò ØJð ûô "ò Ø
|
ð üsQ C B ®.C Á B/ Á-.C Â C Â B,Â)C Â+B,Â,C Â/ B=Â:C Â<B=Â=C c ó y)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,)]
|
```
|
NrQ r s rS Ústored_resultsz"MySQLCursorAbstract.stored_results r rR c ó y)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.
|
NrQ r s rS rª zMySQLCursorAbstract.nextset r rR c ó y©zNot Implemented.NrQ )r Úsizess rS Ú setinputsizesz!MySQLCursorAbstract.setinputsizes¼ r rR c ó yr² rQ )r r¥ Úcolumns rS Ú setoutputsizez!MySQLCursorAbstract.setoutputsize¿ r rR c ó y)z Resets the cursor to defaultNrQ )r Úfrees rS ÚresetzMySQLCursorAbstract.reset r rR c ó | 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 s rS Ú descriptionz MySQLCursorAbstract.descriptionÅ s ð4 × Ñ Ð rR c ó | 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 s rS Úrowcountz MySQLCursorAbstract.rowcountá ó ð ~~Ð rR c ó | 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 s rS Ú lastrowidz MySQLCursorAbstract.lastrowidò s ð ×#Ñ#Ð#rR c ó | 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 s rS Úwarningsz MySQLCursorAbstract.warningsþ r¿ rR c ó | 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 s rS Ú warning_countz!MySQLCursorAbstract.warning_count r´ rR c óê | j y | j j « j d« S # t t f$ r+ t t | j j « « cY S w xY w)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Ö rq rÔ ÚUnicodeDecodeErrorr rÑ r s rS rP z MySQLCursorAbstract.statement sc ð >>Ð !Øð 5Ø>>×'Ñ'Ó)×0Ñ0°Ó9Ð 9øÜ Ô 2Ð3ò 5ÜT^^× 1Ñ 1Ó 3Ó4Ò 4ð 5ús (8 ¸7A2Á1A2rÄ rz c ó | 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 s rS Ú fetchwarningsz!MySQLCursorAbstract.fetchwarnings+ r¿ rR c óH t | d« r| j j S y)zGets a list of query attributes from the connector's side.
|
|
Returns:
|
List of existing query attributes.
|
r} N)Úhasattrr} r¶ r s rS Úget_attributesz"MySQLCursorAbstract.get_attributes< s# ô 4 Ô 'Ø×#Ñ#×/Ñ/Ð /ØrR c óÐ t |t « s t d« | t |t « st d| d« t | d« r | j
|
j ||f« yy)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¹ s rS Ú add_attributez!MySQLCursorAbstract.add_attributeF sl ô $¤Ô$Ü"Ð#KÓLÐ LØ Ð ¤Z°´~Ô%FÜ"Ø%Ð DÐEóð ô 4 Ô 'Ø × Ñ × /Ñ /°°u° Õ >ð (rR c ó t |t « s t d« t | d« r| j j |« S y)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¿ s rS Úremove_attributez$MySQLCursorAbstract.remove_attribute] s> ô $¤Ô$Ü"Ð#KÓLÐ LÜ 4 Ô 'Ø×#Ñ#×6Ñ6°tÓ<Ð <ØrR c óR t | d« r| j j « yy)z<Clears the list of query attributes on the connector's side.r} N)rÌ r} r r s rS Úclear_attributesz$MySQLCursorAbstract.clear_attributesn s# ä 4 Ô 'Ø × Ñ × .Ñ .Õ 0ð (rR )NNN)r z!Optional[MySQLConnectionAbstract]r[ rm r\ rm ra rb )ra rz rc rl rn )rQ )r rÑ r r ra z0Optional[Union[Dict[str, RowItemType], RowType]]r` )rQ F)r rÑ r zFUnion[Sequence[MySQLConvertibleType], Dict[str, MySQLConvertibleType]]r r ra rb )r rÑ r zPSequence[Union[Sequence[MySQLConvertibleType], Dict[str, MySQLConvertibleType]]]ra rb )ra z0Optional[Union[RowType, Dict[str, RowItemType]]])r )r¥ rI ra ú,List[Union[RowType, Dict[str, RowItemType]]])ra rÖ )ra zYGenerator[tuple[Optional[str], list[Union[RowType, Dict[str, RowItemType]]]], None, None])ra z Iterator[MySQLCursorAbstract])ra ro )r³ r ra r r )r¥ r r¶ r ra r rk )r¹ r ra rb )ra rr rf )ra zOptional[List[WarningType]]rg )ra z.Optional[List[Tuple[str, BinaryProtocolType]]])r¯ rÑ r¹ r> ra rb re )'rM rN rO rP r r r¨ ru r[ rv r\ r r r£ r r¡ r£ r¦ r¨ r r¯ rª r´ r· rº r¼ r¾ rÁ rÄ rÆ rP r: r# rà rÊ rÍ rÑ rÓ rÕ rQ rR rS rz rz w sÅ ñð 9=Ø&*Ø'+ð '-à5ð'-ð $ð'-ð %ð '-ð
|
|
ó '-óRðà%ðð !ðð !ð ð
|
|
ó ð ò
|
"ó ð
|
"ð ×Ñò %ó ð %ð@ ò
|
#ó ð
|
#ð ×Ñò &ó ð &ð@ à.0ð1 Øð1 Ø#+ð1 à 9ò1 ó ð1 ðf ò ó ð ð ð Ø !ð C àðC ð
|
ðC ð ð C ð
|
òC ó ðC ðJ ð+ àð+ ð
|
ð+ ð
|
ò + ó ð+ ðZ ò ó ð ð$ ó ó ð ð ò ó ð ð Kð
|
óKðZ ò ó ð ð& ò& ó ð& óP ô ô+ð ò!ó ð!ð6 ò ó ð ð ò $ó ð $ð ò ó ð ð ò#ó ð#ð ò5ó ð5ñ Ð0Ð)×0Ñ0¸zÔJÓKò ó Lð ó ó?ó.ô"1rR rz )lrP Ú
|
__future__r r® rr 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/ r0 r1 Úopentelemetry.constantsr2 r3 r4 r5 Ú opentelemetry.instrumentationr6 r7 r8 r9 Ú _decoratingr: Ú optionfilesr; Ú tls_ciphersr< r= r> r? r@ rA rB rC rD rE rF rG rH ÚutilsrI rJ rß rò rñ rð rR rT rp ÚfloatrI rÑ rÐ rL rU rz rQ rR rS ú<module>ré sg ðñ> 2å "ã Û Û ç #ß 4Ó 4Ý Ý Ý Ý ÷÷ ÷ ÷ õ ð( Ð ð ÛásMÔ" s§¢Ø !Ð÷
|
÷ ÷ ÷ ;÷õ ÷ó ñ ÷ó õ $Ý *ß Q÷ ÷ ÷ ñ ÷ 1ð ð ð 2ð ð Oð ð
|
Pð ð
|
:ð ð#ð ð Ø ØØ Ø ØØØØ ð
|
ô^ô ô~" cô ~" ôBFz 1#õ z 1øðaI ò áð ús Á*D< Ä<EÅE
|
