a cfc@sdZddlZddlZddlmZddlmZmZmZm Z ddl m Z m Z m Z ddlmZmZmZddlmZmZmZmZmZmZmZmZmZd Zd Zd Zd Zd Z Gddde!Z"Gddde"Z#Gddde"Z$Gddde"Z%Gddde%Z&dS)z,Implementation of the CRUD database objects.N)DbDoc)ER_NO_SUCH_TABLEER_TABLE_EXISTS_ERRORER_X_CMD_NUM_ARGUMENTSER_X_INVALID_ADMIN_COMMAND)NotSupportedErrorOperationalErrorProgrammingError) deprecatedescapequote_identifier) FindStatement AddStatementRemoveStatementModifyStatementSelectStatementInsertStatementDeleteStatementUpdateStatementCreateCollectionIndexStatementz_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@seZdZdZddZeddZeddZedd Zd d Z d d Z ddZ ddZ ddZ eddddZeddddZdS)DatabaseObjectzProvides base functionality for database objects. Args: schema (mysqlx.Schema): The Schema object. name (str): The database object name. cCs:||_t|tr|n||_|j|_|j|_dSN) _schema isinstancebytesdecode_name get_session_sessionget_connection _connection)selfschemanamer%H/home/httpd/docs/test/DocsMgr/lib/python3.9/site-packages/mysqlx/crud.py__init__>s zDatabaseObject.__init__cCs|jS)z5:class:`mysqlx.Session`: The Session object. rr"r%r%r&sessionDszDatabaseObject.sessioncCs|jS)z3:class:`mysqlx.Schema`: The Schema object. rr)r%r%r&r#JszDatabaseObject.schemacCs|jS)z/str: The name of this database object. rr)r%r%r&r$PszDatabaseObject.namecCs|jS)z~Returns the underlying connection. Returns: mysqlx.connection.Connection: The connection object. )r!r)r%r%r&r VszDatabaseObject.get_connectioncCs|jS)zwReturns the session of this database object. Returns: mysqlx.Session: The Session object. r(r)r%r%r&r^szDatabaseObject.get_sessioncCs|jS)z{Returns the Schema object of this database object. Returns: mysqlx.Schema: The Schema object. r+r)r%r%r& get_schemafszDatabaseObject.get_schemacCs|jS)zwReturns the name of this database object. Returns: str: The name of this database object. r,r)r%r%r&get_namenszDatabaseObject.get_namecCstdS)zVerifies if this object exists in the database. Returns: bool: `True` if object exists in database. Raises: NotImplementedError: This method must be implemented. N)NotImplementedErrorr)r%r%r&exists_in_databasevs 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. )r0r)r%r%r& 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.r)r%r%r&who_am_is zDatabaseObject.who_am_iN)__name__ __module__ __qualname____doc__r'propertyr*r#r$r rr-r.r0r r1r2r%r%r%r&r7s"     rcs|eZdZdZfddZddZddZdd d Zd d Zdd dZ dddZ dddZ ddZ dddZ dddZZS) SchemazA client-side representation of a database schema. Provides access to the schema contents. Args: session (mysqlx.XSession): Session object. name (str): The Schema name. cs||_tt|||dSr)rsuperr8r')r"r*r$ __class__r%r&r'szSchema.__init__cCs tt|j}|j|dkSzVerifies if this object exists in the database. Returns: bool: `True` if object exists in database. r)_COUNT_SCHEMAS_QUERYformatr rr!execute_sql_scalarr"sqlr%r%r&r0szSchema.exists_in_databasec Csz|jdd|ji}|g}|D]P}|ddkr6q$zt||d}Wn tyht||d}Yn0||q$|S)zyReturns a list of collections for this schema. Returns: `list`: List of Collection objects. list_objectsr#typeZ COLLECTION TABLE_NAMEr$)r!get_row_resultr fetch_all Collection ValueErrorappend)r"rows collectionsrow collectionr%r%r&get_collectionss   zSchema.get_collectionsFcCs |||S)zuReturns a a table object for the given collection Returns: mysqlx.Table: Table object. ) get_table)r"r$check_existencer%r%r&get_collection_as_tableszSchema.get_collection_as_tablec Cs||jdd|ji}|g}d}|D]N}|d|vr(zt||d}Wn tyjt||d}Yn0||q(|S)zoReturns a list of tables for this schema. Returns: `list`: List of Table objects. rBr#)ZTABLEZVIEWrCrDr$)r!rErrFTablerHrI)r"rJZtablesZ object_typesrLtabler%r%r& 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)rRr0r )r"r$rPrSr%r%r&rOs  zSchema.get_tablecCs"t||}|r|std|S)ztReturns the view of the given name for this schema. Returns: mysqlx.View: View object. zView does not exist)Viewr0r )r"r$rPviewr%r%r&get_views  zSchema.get_viewcCs"t||}|r|std|S)zReturns the collection of the given name for this schema. Returns: mysqlx.Collection: Collection object. zCollection does not exist)rGr0r )r"r$rPrMr%r%r&get_collections  zSchema.get_collectioncCs&|jdtt|jt|ddS)zmDrops a collection. Args: name (str): The name of the collection to be dropped. rAFN)r!execute_nonquery_DROP_TABLE_QUERYr>r r)r"r$r%r%r&drop_collections zSchema.drop_collectionNc Ks|s tdd|vr(tdt|d}t||}|j|d}|dur t|trV|s^tdd}|D]}||vrftd|qfg} d |vr|d } t| t std | d | fd |vr|d } t| t tfstd | d t| trt | n| fd | f|d<z|j ddd|Wnjty} zP| jtkrFtd| jtkrh|svtd|nt| j| jWYd} ~ n d} ~ 00|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': {}r_Invalid value for 'level'r#Invalid value for 'schema' validationoptionsmysqlxcreate_collectionTlYour MySQL server does not support the requested operation. Please update to MySQL 8.0.19 or a later versionzCollection '{}' already exists)r warningswarnDeprecationWarningrGrrdictr>strrIjsondumpsr!rYr errnorrrmsg) r"r$Zreuse_existingrckwargsrMfields valid_optionsoptionrdr_r#errr%r%r&rfsh        $zSchema.create_collectionc Cs8|s tdt|tr|s"tdd}|D]}||vr*td|q*g}d|vrz|d}t|tsltd|d|fd|vr|d}t|ttfstd|dt|trt|n|f|j|d |fd }z|j d d d |WnHt y2} z.| j t krtdt| j| j WYd} ~ n d} ~ 00dS)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 r\r]r^r`r_rar#rbrc)r#r$rdreZmodify_collection_optionsTrgN)r rrkr>rlrIrmrnrr!rYr rorrrp) r"r$rcrsrtrdr_r#rrrur%r%r&modify_collectiondsR   zSchema.modify_collection)F)F)F)F)FN)N)r3r4r5r6r'r0rNrQrTrOrWrXr[rfrv __classcell__r%r%r:r&r8s     Sr8c@sreZdZdZddZdddZddZd d Zd d Zd dZ ddZ ddZ ddZ ddZ ddZddZdS)rGzRepresents a collection of documents on a schema. Args: schema (mysqlx.Schema): The Schema object. name (str): The collection name. cCs*tt|jjt|j}|j|dkSr<_COUNT_TABLES_QUERYr>r rr$rr!r?r@r%r%r&r0szCollection.exists_in_databaseNcCst||}|j|_|S)zRetrieves documents from a collection. Args: condition (Optional[str]): The string with the filter expression of the documents to be retrieved. )rr!get_next_statement_idstmt_idr" conditionstmtr%r%r&finds  zCollection.findcGst|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)r"valuesr%r%r&rs zCollection.addcCst||}|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. )rr!rzr{r|r%r%r&removes  zCollection.removecCst||}|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. )rr!rzr{r|r%r%r&modifys  zCollection.modifyc Csvtt|jjt|j}z|j|}WnFtyp}z.|j t krZtd|j|jjWYd}~n d}~00|S)z}Counts the documents in the collection. Returns: int: The total of documents in the collection. z-Collection '{}' does not exist in schema '{}'N _COUNT_QUERYr>r rr$rr!r?r rorr"rAresrur%r%r&counts  zCollection.countcCs 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)r" index_nameZ fields_descr%r%r& create_indexszCollection.create_indexc Cs$|jddd|jj|j|ddS)z[Drops a collection index. Args: index_name (str): Index name. reZdrop_collection_indexF)r#rMr$N)r!rYrr$r)r"rr%r%r& drop_indexs  zCollection.drop_indexcCs:d|vr|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)r rsetbindexecuter"doc_iddocr%r%r& replace_one"szCollection.replace_onecCsHd|vr|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)r rrrcopyZupsertrrr%r%r&add_or_replace_one2s zCollection.add_or_replace_onecCs,|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_oner!Zfetch_active_result)r"rresultrr%r%r&get_oneCs  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)r"rr%r%r& remove_oneQs zCollection.remove_one)N)r3r4r5r6r0rrrrrrrrrrrr%r%r%r&rGs   rGc@sHeZdZdZddZddZddZdd Zd d Zd d Z ddZ dS)rRzRepresents 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. cCs*tt|jjt|j}|j|dkSr<rxr@r%r%r&r0hszTable.exists_in_databasecGs t|g|R}|j|_|S)zCreates a new :class:`mysqlx.SelectStatement` object. Args: *fields: The fields to be retrieved. Returns: mysqlx.SelectStatement: SelectStatement object )rr!rzr{r"rrr~r%r%r&selectrs  z Table.selectcGs t|g|R}|j|_|S)zCreates a new :class:`mysqlx.InsertStatement` object. Args: *fields: The fields to be inserted. Returns: mysqlx.InsertStatement: InsertStatement object )rr!rzr{rr%r%r&inserts  z Table.insertcCst|}|j|_|S)zCreates a new :class:`mysqlx.UpdateStatement` object. Returns: mysqlx.UpdateStatement: UpdateStatement object )rr!rzr{r"r~r%r%r&updates z Table.updatecCst|}|j|_|S)zCreates a new :class:`mysqlx.DeleteStatement` object. Returns: mysqlx.DeleteStatement: DeleteStatement object .. versionchanged:: 8.0.12 The ``condition`` parameter was removed. )rr!rzr{rr%r%r&deletes  z Table.deletec Csvtt|jjt|j}z|j|}WnFtyp}z.|j t krZtd|j|jjWYd}~n d}~00|S)ziCounts the rows in the table. Returns: int: The total of rows in the table. z(Table '{}' does not exist in schema '{}'Nrrr%r%r&rs  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_QUERYr>r rr$rr!r?r@r%r%r&is_viewsz Table.is_viewN) r3r4r5r6r0rrrrrrr%r%r%r&rR]s      rRc@seZdZdZddZdS)rUzRepresents 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. cCs*tt|jjt|j}|j|dkSr<rr@r%r%r&r0szView.exists_in_databaseN)r3r4r5r6r0r%r%r%r&rUs rU)'r6rmrhZdbdocr errorcoderrrrerrorsrr r helpersr r r Z statementrrrrrrrrrrryr=rrZobjectrr8rGrRrUr%r%r%r&s( ,f;c