U 4Jeg@sFdZddlmZddlZddlZddlmZmZmZm Z m Z m Z ddl m Z ddlmZmZmZmZddlmZmZmZdd lmZmZmZdd lmZmZmZmZm Z m!Z!m"Z"m#Z#m$Z$dd l%m&Z&m'Z'm(Z(m)Z)erdd l*m+Z+d Z,dZ-dZ.dZ/dZ0GdddZ1Gddde1Z2Gddde1Z3Gddde1Z4Gddde4Z5dS)z,Implementation of the CRUD database objects.) annotationsN) TYPE_CHECKINGAnyDictListOptionalUnion)DbDoc)ER_NO_SUCH_TABLEER_TABLE_EXISTS_ERRORER_X_CMD_NUM_ARGUMENTSER_X_INVALID_ADMIN_COMMAND)NotSupportedErrorOperationalErrorProgrammingError) deprecatedescapequote_identifier) AddStatementCreateCollectionIndexStatementDeleteStatement FindStatementInsertStatementModifyStatementRemoveStatementSelectStatementUpdateStatement)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}'zSELECT COUNT(*) FROM {0}.{1}zDROP TABLE IF EXISTS {0}.{1}c@seZdZdZddddddZedd d d Zedd d d Zedd ddZdd ddZ dd ddZ dd ddZ dd ddZ dd ddZ edddd dd Zedd!dd d"d#Zd$S)%DatabaseObjectzProvides base functionality for database objects. Args: schema (mysqlx.Schema): The Schema object. name (str): The database object name. rr!None)schemanamereturncCs:||_t|tr|n||_|j|_|j|_dSN) _schema isinstancebytesdecode_name get_session_sessionget_connection _connection)selfr%r&r3//tmp/pip-unpacked-wheel-7_167w8m/mysqlx/crud.py__init__Vs zDatabaseObject.__init__r r'cCs|jS)z,:class:`mysqlx.Session`: The Session object.r/r2r3r3r4session\szDatabaseObject.sessioncCs|jS)z*:class:`mysqlx.Schema`: The Schema object.r)r8r3r3r4r%aszDatabaseObject.schemastrcCs|jS)z&str: The name of this database object.r-r8r3r3r4r&fszDatabaseObject.namercCs|jS)z~Returns the underlying connection. Returns: mysqlx.connection.Connection: The connection object. )r1r8r3r3r4r0kszDatabaseObject.get_connectioncCs|jS)zwReturns the session of this database object. Returns: mysqlx.Session: The Session object. r7r8r3r3r4r.sszDatabaseObject.get_sessioncCs|jS)z{Returns the Schema object of this database object. Returns: mysqlx.Schema: The Schema object. r:r8r3r3r4 get_schema{szDatabaseObject.get_schemacCs|jS)zwReturns the name of this database object. Returns: str: The name of this database object. r<r8r3r3r4get_nameszDatabaseObject.get_namercCstdS)zVerifies if this object exists in the database. Returns: bool: `True` if object exists in database. Raises: NotImplementedError: This method must be implemented. N)NotImplementedErrorr8r3r3r4exists_in_databases z!DatabaseObject.exists_in_databasez8.0.12z)Use 'exists_in_database()' method insteadcCs|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@r8r3r3r4 am_i_reals zDatabaseObject.am_i_realzUse 'get_name()' method insteadcCs|S)zReturns the name of this database object. Returns: str: The name of this database object. .. deprecated:: 8.0.12 Use ``get_name()`` method instead. )r>r8r3r3r4who_am_is zDatabaseObject.who_am_iN)__name__ __module__ __qualname____doc__r5propertyr9r%r&r0r.r=r>r@rrArBr3r3r3r4r#Ns" r#cseZdZdZddddfdd Zdd d d Zd d d dZd+ddddddZdd ddZd,ddddddZ d-ddddddZ d.ddddddZ dddd d!Z d/ddd#d$dd%d&d'Z d0dd#dd(d)d*ZZS)1SchemazA 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$)r9r&r'cs||_t||dSr()r/superr5)r2r9r& __class__r3r4r5szSchema.__init__boolr6cCs tt|j}|j|dkSzVerifies if this object exists in the database. Returns: bool: `True` if object exists in database. r )_COUNT_SCHEMAS_QUERYformatrr-r1execute_sql_scalarr2sqlr3r3r4r@szSchema.exists_in_databasezList[Collection]c Cs||jdd|ji}|g}|D]R}|ddkr6q$zt||d}Wn"tk rjt||d}YnX||q$|S)zyReturns a list of collections for this schema. Returns: `list`: List of Collection objects. list_objectsr%typeZ COLLECTION TABLE_NAMEr&)r1get_row_resultr- fetch_all Collection ValueErrorappend)r2rows collectionsrow collectionr3r3r4get_collectionss  zSchema.get_collectionsFTable)r&check_existencer'cCs |||S)zuReturns a a table object for the given collection Returns: mysqlx.Table: Table object. ) get_table)r2r&rar3r3r4get_collection_as_tables zSchema.get_collection_as_tablez List[Table]c Cs~|jdd|ji}|g}d}|D]P}|d|kr(zt||d}Wn"tk rlt||d}YnX||q(|S)zoReturns a list of tables for this schema. Returns: `list`: List of Table objects. rSr%)ZTABLEZVIEWrTrUr&)r1rVr-rWr`rYrZ)r2r[ZtablesZ object_typesr]tabler3r3r4 get_tabless  zSchema.get_tablescCs"t||}|r|std|S)zwReturns the table of the given name for this schema. Returns: mysqlx.Table: Table object. zTable does not exist)r`r@r)r2r&rardr3r3r4rbs  zSchema.get_tableViewcCs"t||}|r|std|S)ztReturns the view of the given name for this schema. Returns: mysqlx.View: View object. zView does not exist)rfr@r)r2r&raviewr3r3r4get_views  zSchema.get_viewrXcCs"t||}|r|std|S)zReturns the collection of the given name for this schema. Returns: mysqlx.Collection: Collection object. zCollection does not exist)rXr@r)r2r&rar^r3r3r4get_collections  zSchema.get_collection)r&r'cCs&|jdtt|jt|ddS)zmDrops a collection. Args: name (str): The name of the collection to be dropped. rRFN)r1execute_nonquery_DROP_TABLE_QUERYrOrr-)r2r&r3r3r4drop_collection szSchema.drop_collectionNz%Optional[Dict[str, Union[str, Dict]]]r)r&reuse_existing validationkwargsr'c Ks|s tdd|kr(tdt|d}t||}|j|d}|dk r t|trV|s^tdd}|D]}||krftd|qfg} d |kr|d } t| tstd | d | fd |kr|d } t| ttfstd | d t| trt | n| fd | f|d<z|j ddd|Wnptk r} zP| jtkrJtd| | jtkrp|std|d| nt| j| j| W5d} ~ XYnX|S)aJCreates 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&NInvalid value for 'validation'levelr% Invalid option in 'validation': rsInvalid value for 'level'r%Invalid value for 'schema'rnoptionsmysqlxcreate_collectionTlYour MySQL server does not support the requested operation. Please update to MySQL 8.0.19 or a later version Collection 'z' already exists)rwarningswarnDeprecationWarningrXr-r*dictr;rZjsondumpsr1rjrerrnor rr msg) r2r&rmrnror^fields valid_optionsoptionrwrsr%errr3r3r4ry.sp        "zSchema.create_collection)r&rnr'c Cs:|s tdt|tr|s"tdd}|D]}||kr*td|q*g}d|krz|d}t|tsltd|d|fd|kr|d}t|ttfstd|dt|trt|n|f|j|d |fd }z|j d d d |WnJt k r4} z*| j t krt d| t| j| j | W5d} ~ XYnXdS)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 rprqrrrtrsrur%rvrn)r%r&rwrxZmodify_collection_optionsTrzN)rr*rr;rZrrr-r1rjrrrrr) r2r&rnrrrwrsr%rrr3r3r4modify_collectionsT  zSchema.modify_collection)F)F)F)F)FN)N)rCrDrErFr5r@r_rcrerbrhrirlryr __classcell__r3r3rJr4rHs      `rHc@seZdZdZddddZd0ddd d d Zd d dddZddd ddZddd ddZddddZ ddddddZ 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)1rXzRepresents a collection of documents on a schema. Args: schema (mysqlx.Schema): The Schema object. name (str): The collection name. rLr6cCs*tt|jjt|j}|j|dkSrM_COUNT_TABLES_QUERYrOrr)r&r-r1rPrQr3r3r4r@szCollection.exists_in_databaseNz Optional[str]r) conditionr'cCst||}|j|_|S)zRetrieves documents from a collection. Args: condition (Optional[str]): The string with the filter expression of the documents to be retrieved. )rr1get_next_statement_idstmt_idr2rstmtr3r3r4finds  zCollection.findr r)valuesr'cGst|j|S)zAdds a list of documents to a collection. Args: *values: The document list to be added into the collection. Returns: mysqlx.AddStatement: AddStatement object. )radd)r2rr3r3r4rs zCollection.addr;rcCst||}|j|_|S)apRemoves 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. )rr1rrrr3r3r4removes  zCollection.removercCst||}|j|_|S)arModifies 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. )rr1rrrr3r3r4modify s  zCollection.modifyintc Cs|tt|jjt|j}z|j|}WnLtk rv}z.|j t krdtd|jd|jjd|W5d}~XYnX|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_QUERYrOrr)r&r-r1rPrrr r2rRresrr3r3r4counts  zCollection.countzDict[str, Any]r) index_name fields_descr'cCs t|||S)abCreates 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)r2rrr3r3r4 create_index/szCollection.create_indexr$)rr'c Cs$|jddd|jj|j|ddS)z[Drops a collection index. Args: index_name (str): Index name. rxZdrop_collection_indexF)r%r^r&N)r1rjr)r&r-)r2rr3r3r4 drop_indexIszCollection.drop_indexzUnion[Dict, DbDoc]z'Result')doc_iddocr'cCs:d|kr|d|krtd|dd|d|S)zReplaces 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 _idKReplacement document has an _id that is different than the matched document _id = :id$id)rrsetbindexecuter2rrr3r3r4 replace_oneZs zCollection.replace_onecCsHd|kr|d|krtdt|ts.t|}|||dS)zUpserts 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 rrT)rr*r rcopyZupsertrrr3r3r4add_or_replace_oneis zCollection.add_or_replace_one)rr'cCs,|dd|}|}|j|S)zReturns a Document matching the Document ID. Args: doc_id (str): Document ID Returns: mysqlx.DbDoc: The Document matching the Document ID. rr)rrrZ fetch_oner1Zfetch_active_result)r2rresultrr3r3r4get_onezs  zCollection.get_onecCs|dd|S)zRemoves a Document matching the Document ID. Args: doc_id (str): Document ID Returns: mysqlx.Result: Result object. rr)rrr)r2rr3r3r4 remove_ones zCollection.remove_one)N)rCrDrErFr@rrrrrrrrrrrr3r3r3r4rXs   rXc@sveZdZdZddddZdddd d Zd d dd dZddddZddddZddddZ ddddZ dS)r`zRepresents 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. rLr6cCs*tt|jjt|j}|j|dkSrMrrQr3r3r4r@szTable.exists_in_databaser;r)rr'cGst|f|}|j|_|S)zCreates a new :class:`mysqlx.SelectStatement` object. Args: *fields: The fields to be retrieved. Returns: mysqlx.SelectStatement: SelectStatement object )rr1rrr2rrr3r3r4selects  z Table.selectrrcGst|f|}|j|_|S)zCreates a new :class:`mysqlx.InsertStatement` object. Args: *fields: The fields to be inserted. Returns: mysqlx.InsertStatement: InsertStatement object )rr1rrrr3r3r4inserts  z Table.insertrcCst|}|j|_|S)zCreates a new :class:`mysqlx.UpdateStatement` object. Returns: mysqlx.UpdateStatement: UpdateStatement object )rr1rrr2rr3r3r4updates z Table.updatercCst|}|j|_|S)zCreates a new :class:`mysqlx.DeleteStatement` object. Returns: mysqlx.DeleteStatement: DeleteStatement object .. versionchanged:: 8.0.12 The ``condition`` parameter was removed. )rr1rrrr3r3r4deletes  z Table.deleterc Cs|tt|jjt|j}z|j|}WnLtk rv}z.|j t krdtd|jd|jjd|W5d}~XYnX|S)ziCounts the rows in the table. Returns: int: The total of rows in the table. zTable 'rrNrrr3r3r4rs  z Table.countcCs*tt|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_QUERYrOrr)r&r-r1rPrQr3r3r4is_viewsz Table.is_viewN) rCrDrErFr@rrrrrrr3r3r3r4r`s      r`c@seZdZdZddddZdS)rfzRepresents 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. rLr6cCs*tt|jjt|j}|j|dkSrMrrQr3r3r4r@szView.exists_in_databaseN)rCrDrErFr@r3r3r3r4rfs rf)6rF __future__rrr|typingrrrrrrZdbdocr errorcoder r r rerrorsrrrZhelpersrrrZ statementrrrrrrrrrtypesrrr r!rr"rrrNrrkr#rHrXr`rfr3r3r3r4s8   ,  d"Cc