U
|
¤ý°dg ã @ sF d Z ddlmZ ddlZddlZddlmZmZmZm Z m
|
Z
|
m Z ddl m Z ddlmZmZmZmZ ddlmZmZmZ dd lmZmZmZ dd
|
lm Z m Z m Z m Z m Z m!Z!m"Z"m#Z#m$Z$ dd l%m&Z&m'Z'm(Z(m)Z) eràdd l*m+Z+ d Z,dZ-dZ.dZ/dZ0G dd dZ1G dd de1Z2G dd de1Z3G dd de1Z4G dd de4Z5dS ) z,Implementation of the CRUD database objects.é )Ú annotationsN)Ú TYPE_CHECKINGÚAnyÚDictÚListÚOptionalÚUnioné )ÚDbDoc)ÚER_NO_SUCH_TABLEÚER_TABLE_EXISTS_ERRORÚER_X_CMD_NUM_ARGUMENTSÚER_X_INVALID_ADMIN_COMMAND)ÚNotSupportedErrorÚOperationalErrorÚProgrammingError)Ú
|
deprecatedÚescapeÚquote_identifier) Ú AddStatementÚ CreateCollectionIndexStatementÚDeleteStatementÚ FindStatementÚInsertStatementÚModifyStatementÚRemoveStatementÚSelectStatementÚUpdateStatement)ÚConnectionTypeÚ
|
SchemaTypeÚ SessionTypeÚ
|
StrOrBytes)ÚResultz_SELECT COUNT(*) FROM information_schema.views WHERE table_schema = '{0}' AND table_name = '{1}'z`SELECT COUNT(*) FROM information_schema.tables WHERE table_schema = '{0}' AND table_name = '{1}'zJSELECT COUNT(*) FROM information_schema.schemata WHERE schema_name = '{0}'z SELECT COUNT(*) FROM {0}.{1}z DROP TABLE IF EXISTS {0}.{1}c @ sÎ e Zd ZdZddddddZedd d
|
d Zedd d d Zedd ddZdd ddZ dd ddZ
|
dd ddZ dd ddZ dd dd Z ed d dd d d Zed d!dd d"d#Zd$S )%ÚDatabaseObjectz¢Provides base functionality for database objects.
|
|
Args:
|
schema (mysqlx.Schema): The Schema object.
|
name (str): The database object name.
|
r r! ÚNone)ÚschemaÚnameÚreturnc C s: || _ t|tr| ¡ n|| _| j ¡ | _| j ¡ | _d S ©N) Ú_schemaÚ
|
isinstanceÚbytesÚdecodeÚ_nameÚ get_sessionÚ_sessionÚget_connectionÚ _connection)Úselfr% r& © r3 úBd:\z\workplace\vscode\pyvenv\venv\Lib\site-packages\mysqlx/crud.pyÚ__init__V s zDatabaseObject.__init__r ©r' c C s | j S )z,:class:`mysqlx.Session`: The Session object.©r/ ©r2 r3 r3 r4 Úsession\ s zDatabaseObject.sessionc C s | j S )z*:class:`mysqlx.Schema`: The Schema object.©r) r8 r3 r3 r4 r% a s zDatabaseObject.schemaÚstrc C s | j S )z&str: The name of this database object.©r- r8 r3 r3 r4 r& f s zDatabaseObject.namer c C s | j S )z~Returns the underlying connection.
|
|
Returns:
|
mysqlx.connection.Connection: The connection object.
|
)r1 r8 r3 r3 r4 r0 k s z DatabaseObject.get_connectionc C s | j S )zwReturns the session of this database object.
|
|
Returns:
|
mysqlx.Session: The Session object.
|
r7 r8 r3 r3 r4 r. s s zDatabaseObject.get_sessionc C s | j S )z{Returns the Schema object of this database object.
|
|
Returns:
|
mysqlx.Schema: The Schema object.
|
r: r8 r3 r3 r4 Ú
|
get_schema{ s zDatabaseObject.get_schemac C s | j S )zwReturns the name of this database object.
|
|
Returns:
|
str: The name of this database object.
|
r< r8 r3 r3 r4 Úget_name s zDatabaseObject.get_namer c C s t dS )zÓVerifies if this object exists in the database.
|
|
Returns:
|
bool: `True` if object exists in database.
|
|
Raises:
|
NotImplementedError: This method must be implemented.
|
N)ÚNotImplementedErrorr8 r3 r3 r4 Úexists_in_database s z!DatabaseObject.exists_in_databasez8.0.12z)Use 'exists_in_database()' method insteadc C s | ¡ S )a+ Verifies if this object exists in the database.
|
|
Returns:
|
bool: `True` if object exists in database.
|
|
Raises:
|
NotImplementedError: This method must be implemented.
|
|
.. deprecated:: 8.0.12
|
Use ``exists_in_database()`` method instead.
|
)r@ r8 r3 r3 r4 Ú am_i_real s zDatabaseObject.am_i_realz Use 'get_name()' method insteadc C s | ¡ S )zÅReturns the name of this database object.
|
|
Returns:
|
str: The name of this database object.
|
|
.. deprecated:: 8.0.12
|
Use ``get_name()`` method instead.
|
)r> r8 r3 r3 r4 Úwho_am_i¥ s
|
zDatabaseObject.who_am_iN)Ú__name__Ú
|
__module__Ú __qualname__Ú__doc__r5 Úpropertyr9 r% r& r0 r. r= r> r@ r rA rB r3 r3 r3 r4 r# N s" r# c sà e Zd ZdZdddd fdd Zdd d
|
d Zd d d dZd+ddddddZdd ddZd,ddddddZ d-ddddddZ
|
d.ddd dd d Z ddd d d!Z d/ddd#d$d d%d&d'Z d0dd#dd(d)d*Z ZS )1ÚSchemazÆA client-side representation of a database schema. Provides access to
|
the schema contents.
|
|
Args:
|
session (mysqlx.XSession): Session object.
|
name (str): The Schema name.
|
r r; r$ )r9 r& r' c s || _ t | |¡ d S r( )r/ Úsuperr5 )r2 r9 r& ©Ú __class__r3 r4 r5 » s zSchema.__init__Úboolr6 c C s t t| j¡}| j |¡dkS ©zVerifies if this object exists in the database.
|
|
Returns:
|
bool: `True` if object exists in database.
|
r )Ú_COUNT_SCHEMAS_QUERYÚformatr r- r1 Úexecute_sql_scalar©r2 Úsqlr3 r3 r4 r@ ¿ s zSchema.exists_in_databasezList[Collection]c C s| | j dd| ji¡}| ¡ g }|D ]R}|d dkr6q$zt| |d }W n" tk
|
rj t| |d }Y nX | |¡ q$|S )zyReturns a list of collections for this schema.
|
|
Returns:
|
`list`: List of Collection objects.
|
Ú list_objectsr% ÚtypeZ
|
COLLECTIONÚ
|
TABLE_NAMEr& )r1 Úget_row_resultr- Ú fetch_allÚ
|
CollectionÚ
|
ValueErrorÚappend)r2 ÚrowsÚ collectionsÚrowÚ
|
collectionr3 r3 r4 Úget_collectionsÈ s zSchema.get_collectionsFÚTable)r& Úcheck_existencer' c C s | ||¡S )zuReturns a a table object for the given collection
|
|
Returns:
|
mysqlx.Table: Table object.
|
|
)Ú get_table)r2 r& ra r3 r3 r4 Úget_collection_as_tableÛ s z Schema.get_collection_as_tablez List[Table]c C s~ | j dd| ji¡}| ¡ g }d}|D ]P}|d |kr(zt| |d }W n" tk
|
rl t| |d }Y nX | |¡ q(|S )zoReturns a list of tables for this schema.
|
|
Returns:
|
`list`: List of Table objects.
|
rS r% )ZTABLEZVIEWrT rU r& )r1 rV r- rW r` rY rZ )r2 r[ ZtablesZ object_typesr] Útabler3 r3 r4 Ú
|
get_tablesæ s zSchema.get_tablesc C s" t | |}|r | ¡ s td|S )zwReturns the table of the given name for this schema.
|
|
Returns:
|
mysqlx.Table: Table object.
|
zTable does not exist)r` r@ r )r2 r& ra rd r3 r3 r4 rb ü s
|
|
zSchema.get_tableÚViewc C s" t | |}|r | ¡ s td|S )ztReturns the view of the given name for this schema.
|
|
Returns:
|
mysqlx.View: View object.
|
zView does not exist)rf r@ r )r2 r& ra Úviewr3 r3 r4 Úget_view s
|
|
zSchema.get_viewrX c C s" t | |}|r | ¡ s td|S )zReturns the collection of the given name for this schema.
|
|
Returns:
|
mysqlx.Collection: Collection object.
|
zCollection does not exist)rX r@ r )r2 r& ra r^ r3 r3 r4 Úget_collection s
|
|
zSchema.get_collection)r& r' c C s& | j dt t| jt|¡d¡ dS )zmDrops a collection.
|
|
Args:
|
name (str): The name of the collection to be dropped.
|
rR FN)r1 Úexecute_nonqueryÚ_DROP_TABLE_QUERYrO r r- )r2 r& r3 r3 r4 Údrop_collection s ÿûzSchema.drop_collectionNz%Optional[Dict[str, Union[str, Dict]]]r )r& Úreuse_existingÚ
|
validationÚkwargsr' c
|
K s |s t dd|kr(t dt¡ |d }t| |}| j|d}|dk r
|
t|trV|s^t dd}|D ]}||krft d| qfg } d |kr¶|d }
|
t|
|
ts¨t d
|
| d |
|
f¡ d |krþ|d } t| ttfsÜt d | d t| tröt
|
| ¡n| f¡ d | f|d< z| j ddd|¡ W np tk
|
r } zP| jtkrJtd| | jtkrp|st d| d| nt | j| j| W 5 d} ~ X Y nX |S )aJ Creates in the current schema a new collection with the specified
|
name and retrieves an object representing the new collection created.
|
|
Args:
|
name (str): The name of the collection.
|
reuse_existing (bool): `True` to reuse an existing collection.
|
validation (Optional[dict]): A dict, containing the keys `level`
|
with the validation level and `schema`
|
with a dict or a string representation
|
of a JSON schema specification.
|
|
Returns:
|
mysqlx.Collection: Collection object.
|
|
Raises:
|
:class:`mysqlx.ProgrammingError`: If ``reuse_existing`` is False
|
and collection exists or the
|
collection name is invalid.
|
:class:`mysqlx.NotSupportedError`: If schema validation is not
|
supported by the server.
|
|
.. versionchanged:: 8.0.21
|
úCollection name is invalidZreusezG'reuse' is deprecated since 8.0.21. Please use 'reuse_existing' instead)r% r& Nú Invalid value for 'validation'©Úlevelr% ú Invalid option in 'validation': rs úInvalid value for 'level'r% úInvalid value for 'schema'rn ÚoptionsÚmysqlxÚcreate_collectionTúlYour MySQL server does not support the requested operation. Please update to MySQL 8.0.19 or a later versionú Collection 'z' already exists)r ÚwarningsÚwarnÚDeprecationWarningrX r- r* Údictr; rZ ÚjsonÚdumpsr1 rj r Úerrnor r r Úmsg) r2 r& rm rn ro r^ ÚfieldsÚ valid_optionsÚoptionrw rs r% Úerrr3 r3 r4 ry . sp ý
|
|
|
þÿ ÿ ÿü
|
ÿþ"zSchema.create_collection)r& rn r' c
|
|
C s: |s t dt|tr|s"t dd}|D ]}||kr*t d| q*g }d|krz|d }t|tslt d| d|f¡ d|krÂ|d }t|ttfs t d| dt|trºt |¡n|f¡ | j|d |fd
|
}z| j d d d |¡ W nJ t
|
k
|
r4 } z*| j t krt d| t | j| j | W 5 d} ~ X Y nX dS )a
|
Modifies a collection using a JSON schema validation.
|
|
Args:
|
name (str): The name of the collection.
|
validation (Optional[dict]): A dict, containing the keys `level`
|
with the validation level and `schema`
|
with a dict or a string representation
|
of a JSON schema specification.
|
|
Raises:
|
:class:`mysqlx.ProgrammingError`: If the collection name or
|
validation is invalid.
|
:class:`mysqlx.NotSupportedError`: If schema validation is not
|
supported by the server.
|
|
.. versionadded:: 8.0.21
|
rp rq rr rt rs ru r% rv rn )r% r& rw rx Zmodify_collection_optionsTrz N)r r* r r; rZ r r r- r1 rj r r r r r )
|
r2 r& rn r
r rw rs r% r r r3 r3 r4 Úmodify_collection sT
|
þÿý ÿ ÿüzSchema.modify_collection)F)F)F)F)FN)N)rC rD rE rF r5 r@ r_ rc re rb rh ri rl ry r Ú __classcell__r3 r3 rJ r4 rH ² s ÿ ü` ÿrH c @ sÔ e Zd ZdZddddZd0ddd d
|
d Zd d dddZddd ddZddd ddZddddZ ddd d d d Z
|
dd d!d"d#Z dd$d%d&d'd(Z dd$d%d&d)d*Z dd d+d,d-Zdd%d+d.d/ZdS )1rX zRepresents a collection of documents on a schema.
|
|
Args:
|
schema (mysqlx.Schema): The Schema object.
|
name (str): The collection name.
|
rL r6 c C s* t t| jjt| j¡}| j |¡dkS rM ©Ú_COUNT_TABLES_QUERYrO r r) r& r- r1 rP rQ r3 r3 r4 r@ Ú s z Collection.exists_in_databaseNz Optional[str]r )Ú conditionr' c C s t | |}| j ¡ |_|S )zÔRetrieves documents from a collection.
|
|
Args:
|
condition (Optional[str]): The string with the filter expression of
|
the documents to be retrieved.
|
)r r1 Úget_next_statement_idÚstmt_id©r2 r Ústmtr3 r3 r4 Úfindã s
|
zCollection.findr
|
r )Úvaluesr' c G s t | j| S )zÑAdds a list of documents to a collection.
|
|
Args:
|
*values: The document list to be added into the collection.
|
|
Returns:
|
mysqlx.AddStatement: AddStatement object.
|
)r Úadd)r2 r r3 r3 r4 r î s zCollection.addr; r c C s t | |}| j ¡ |_|S )ap Removes documents based on the ``condition``.
|
|
Args:
|
condition (str): The string with the filter expression of the
|
documents to be removed.
|
|
Returns:
|
mysqlx.RemoveStatement: RemoveStatement object.
|
|
.. versionchanged:: 8.0.12
|
The ``condition`` parameter is now mandatory.
|
)r r1 r r r r3 r3 r4 Úremoveù s
|
zCollection.remover c C s t | |}| j ¡ |_|S )ar Modifies documents based on the ``condition``.
|
|
Args:
|
condition (str): The string with the filter expression of the
|
documents to be modified.
|
|
Returns:
|
mysqlx.ModifyStatement: ModifyStatement object.
|
|
.. versionchanged:: 8.0.12
|
The ``condition`` parameter is now mandatory.
|
)r r1 r r r r3 r3 r4 Úmodify
|
s
|
zCollection.modifyÚintc
|
C s| t t| jjt| j¡}z| j |¡}W nL tk
|
rv } z.|j t
|
krdtd| j d| jj d| W 5 d}~X Y nX |S )z}Counts the documents in the collection.
|
|
Returns:
|
int: The total of documents in the collection.
|
r{ ú ' does not exist in schema 'ú'N© Ú _COUNT_QUERYrO r r) r& r- r1 rP r r r ©r2 rR Úresr r3 r3 r4 Úcount s
|
ÿ
|
ÿýzCollection.countzDict[str, Any]r )Ú
|
index_nameÚ fields_descr' c C s t | ||S )ab Creates a collection index.
|
|
Args:
|
index_name (str): Index name.
|
fields_desc (dict): A dictionary containing the fields members that
|
constraints the index to be created. It must
|
have the form as shown in the following::
|
|
{"fields": [{"field": member_path,
|
"type": member_type,
|
"required": member_required,
|
"array": array,
|
"collation": collation,
|
"options": options,
|
"srid": srid},
|
# {... more members,
|
# repeated as many times
|
# as needed}
|
],
|
"type": type}
|
)r )r2 r r r3 r3 r4 Ú create_index/ s zCollection.create_indexr$ )r r' c C s$ | j ddd| jj| j|d¡ dS )z[Drops a collection index.
|
|
Args:
|
index_name (str): Index name.
|
rx Zdrop_collection_indexF)r% r^ r& N)r1 rj r) r& r- )r2 r r3 r3 r4 Ú
|
drop_indexI s ýüzCollection.drop_indexzUnion[Dict, DbDoc]z'Result')Údoc_idÚdocr' c C s: d|kr |d |kr t d| d¡ d|¡ d|¡ ¡ S )zÒReplaces the Document matching the document ID with a new document
|
provided.
|
|
Args:
|
doc_id (str): Document ID
|
doc (:class:`mysqlx.DbDoc` or `dict`): New Document
|
Ú_idúKReplacement document has an _id that is different than the matched documentú _id = :idú$Úid)r r ÚsetÚbindÚexecute©r2 r¢ r£ r3 r3 r4 Ú replace_oneZ s
|
ÿzCollection.replace_onec C sH d|kr |d |kr t dt|ts.t|}| | |¡¡ d¡ ¡ S )zÏUpserts the Document matching the document ID with a new document
|
provided.
|
|
Args:
|
doc_id (str): Document ID
|
doc (:class:`mysqlx.DbDoc` or dict): New Document
|
r¤ r¥ T)r r* r
|
r ÚcopyZupsertr« r¬ r3 r3 r4 Úadd_or_replace_onei s ÿ
|
z Collection.add_or_replace_one)r¢ r' c C s, | d¡ d|¡ ¡ }| ¡ }| j ¡ |S )z½Returns a Document matching the Document ID.
|
|
Args:
|
doc_id (str): Document ID
|
|
Returns:
|
mysqlx.DbDoc: The Document matching the Document ID.
|
r¦ r¨ )r rª r« Z fetch_oner1 Zfetch_active_result)r2 r¢ Úresultr£ r3 r3 r4 Úget_onez s
|
zCollection.get_onec C s | d¡ d|¡ ¡ S )z¦Removes a Document matching the Document ID.
|
|
Args:
|
doc_id (str): Document ID
|
|
Returns:
|
mysqlx.Result: Result object.
|
r¦ r¨ )r rª r« )r2 r¢ r3 r3 r4 Ú
|
remove_one s zCollection.remove_one)N)rC rD rE rF r@ r r r r r r r¡ r r¯ r± r² r3 r3 r3 r4 rX Ò s rX c @ sv e Zd ZdZddddZdddd d
|
Zd d dd dZddddZddddZddddZ ddddZ
|
dS )r` zîRepresents a database table on a schema.
|
|
Provides access to the table through standard INSERT/SELECT/UPDATE/DELETE
|
statements.
|
|
Args:
|
schema (mysqlx.Schema): The Schema object.
|
name (str): The table name.
|
rL r6 c C s* t t| jjt| j¡}| j |¡dkS rM r rQ r3 r3 r4 r@ s zTable.exists_in_databaser; r )r r' c G s t | f| }| j ¡ |_|S )zËCreates a new :class:`mysqlx.SelectStatement` object.
|
|
Args:
|
*fields: The fields to be retrieved.
|
|
Returns:
|
mysqlx.SelectStatement: SelectStatement object
|
)r r1 r r ©r2 r r r3 r3 r4 Úselect¨ s z Table.selectr r c G s t | f| }| j ¡ |_|S )zÊCreates a new :class:`mysqlx.InsertStatement` object.
|
|
Args:
|
*fields: The fields to be inserted.
|
|
Returns:
|
mysqlx.InsertStatement: InsertStatement object
|
)r r1 r r r³ r3 r3 r4 Úinsertµ s z Table.insertr c C s t | }| j ¡ |_|S )zCreates a new :class:`mysqlx.UpdateStatement` object.
|
|
Returns:
|
mysqlx.UpdateStatement: UpdateStatement object
|
)r r1 r r ©r2 r r3 r3 r4 Úupdate s z Table.updater c C s t | }| j ¡ |_|S )zãCreates a new :class:`mysqlx.DeleteStatement` object.
|
|
Returns:
|
mysqlx.DeleteStatement: DeleteStatement object
|
|
.. versionchanged:: 8.0.12
|
The ``condition`` parameter was removed.
|
)r r1 r r r¶ r3 r3 r4 ÚdeleteÌ s z Table.deleter c
|
C s| t t| jjt| j¡}z| j |¡}W nL tk
|
rv } z.|j t
|
krdtd| j d| jj d| W 5 d}~X Y nX |S )ziCounts the rows in the table.
|
|
Returns:
|
int: The total of rows in the table.
|
zTable 'r r Nr r r3 r3 r4 r Ù s
|
ÿ
|
ÿýz Table.countc C s* t t| jjt| j¡}| j |¡dkS )zDetermine if the underlying object is a view or not.
|
|
Returns:
|
bool: `True` if the underlying object is a view.
|
r ©Ú_COUNT_VIEWS_QUERYrO r r) r& r- r1 rP rQ r3 r3 r4 Úis_viewí s z Table.is_viewN) rC rD rE rF r@ r´ rµ r· r¸ r r» r3 r3 r3 r4 r` s
|
|
r` c @ s e Zd ZdZddddZdS )rf zÌRepresents a database view on a schema.
|
|
Provides a mechanism for creating, alter and drop views.
|
|
Args:
|
schema (mysqlx.Schema): The Schema object.
|
name (str): The table name.
|
rL r6 c C s* t t| jjt| j¡}| j |¡dkS rM r¹ rQ r3 r3 r4 r@ s zView.exists_in_databaseN)rC rD rE rF r@ r3 r3 r3 r4 rf ÷ s rf )6rF Ú
|
__future__r r r| Útypingr r r r r r Zdbdocr
|
Ú errorcoder r r r Úerrorsr r r Zhelpersr r r Z statementr r r r r r r r r Útypesr r r r! r° r" rº r rN r rk r# rH rX r` rf r3 r3 r3 r4 Ú<module> s8 , ÿÿÿd " Cc
|
