3 (h b@sdZddlZddlZddlmZddlmZddlmZm Z m Z m Z ddl m Z mZmZddlmZmZmZdd lmZmZmZmZmZmZmZmZmZd Zd Zd Z d Z!dZ"Gddde#Z$Gddde$Z%Gddde$Z&Gddde$Z'Gddde'Z(dS)z,Implementation of the CRUD database objects.N)DbDoc) STRING_TYPES)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(||_||_|jj|_|jj|_dS)N)_schema_name get_session_sessionget_connection _connection)selfschemanamer"?/tmp/pip-install-q3hcpn_q/mysql-connector-python/mysqlx/crud.py__init__?s zDatabaseObject.__init__cCs|jS)z5:class:`mysqlx.Session`: The Session object. )r)rr"r"r#sessionEszDatabaseObject.sessioncCs|jS)z3:class:`mysqlx.Schema`: The Schema object. )r)rr"r"r#r KszDatabaseObject.schemacCs|jS)z/str: The name of this database object. )r)rr"r"r#r!QszDatabaseObject.namecCs|jS)z~Returns the underlying connection. Returns: mysqlx.connection.Connection: The connection object. )r)rr"r"r#rWszDatabaseObject.get_connectioncCs|jS)zwReturns the session of this database object. Returns: mysqlx.Session: The Session object. )r)rr"r"r#r_szDatabaseObject.get_sessioncCs|jS)z{Returns the Schema object of this database object. Returns: mysqlx.Schema: The Schema object. )r)rr"r"r# get_schemagszDatabaseObject.get_schemacCs|jS)zwReturns the name of this database object. Returns: str: The name of this database object. )r)rr"r"r#get_nameoszDatabaseObject.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)NotImplementedError)rr"r"r#exists_in_databasews z!DatabaseObject.exists_in_databasez8.0.12z)Use 'exists_in_database()' method insteadcCs|jS)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))rr"r"r# am_i_reals zDatabaseObject.am_i_realzUse 'get_name()' method insteadcCs|jS)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')rr"r"r#who_am_is zDatabaseObject.who_am_iN)__name__ __module__ __qualname____doc__r$propertyr%r r!rrr&r'r)r r*r+r"r"r"r#r8s    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|j||dS)N)rsuperr1r$)rr%r!) __class__r"r#r$szSchema.__init__cCs tjt|j}|jj|dkS)zVerifies if this object exists in the database. Returns: bool: `True` if object exists in database. r)_COUNT_SCHEMAS_QUERYformatr rrexecute_sql_scalar)rsqlr"r"r#r)szSchema.exists_in_databasec Cs|jjdd|ji}|jg}xZ|D]R}|ddkr8q&yt||d}Wn"tk rlt||d}YnX|j|q&W|S)zyReturns a list of collections for this schema. Returns: `list`: List of Collection objects. list_objectsr typeZ COLLECTION TABLE_NAMEr!)rget_row_resultr fetch_all Collection ValueErrorappend)rrows collectionsrow collectionr"r"r#get_collectionss   zSchema.get_collectionsFcCs |j||S)zuReturns a a table object for the given collection Returns: mysqlx.Table: Table object. ) get_table)rr!check_existencer"r"r#get_collection_as_tableszSchema.get_collection_as_tablec Cs|jjdd|ji}|jg}d}xX|D]P}|d|kr*yt||d}Wn"tk rnt||d}YnX|j|q*W|S) zoReturns a list of tables for this schema. Returns: `list`: List of Table objects. r8r TABLEVIEWr9r:r!)rHrI)rr;rr<Tabler>r?)rr@tablesZ object_typesrBtabler"r"r# get_tabless   zSchema.get_tablescCs"t||}|r|jstd|S)zwReturns the table of the given name for this schema. Returns: mysqlx.Table: Table object. zTable does not exist)rJr)r )rr!rFrLr"r"r#rEs  zSchema.get_tablecCs"t||}|r|jstd|S)ztReturns the view of the given name for this schema. Returns: mysqlx.View: View object. zView does not exist)Viewr)r )rr!rFviewr"r"r#get_views  zSchema.get_viewcCs"t||}|r|jstd|S)zReturns the collection of the given name for this schema. Returns: mysqlx.Collection: Collection object. zCollection does not exist)r=r)r )rr!rFrCr"r"r#get_collections  zSchema.get_collectioncCs&|jjdtjt|jt|ddS)zmDrops a collection. Args: name (str): The name of the collection to be dropped. r7FN)rexecute_nonquery_DROP_TABLE_QUERYr5rr)rr!r"r"r#drop_collectionszSchema.drop_collectionNc Ks|s tdd|kr(tjdt|d}t||}|j|d}|dk rt|t sZ| rbtdd}x"|D]}||krltd j|qlWg} d|kr|d} t| t std | j d| fd|kr |d} t| t tfstd | j dt| trt j | n| fd | f|d <y|j jddd|Wnhtk r} zJ| jtkrTtd| jtkrv|stdj|nt| j| jWYdd} ~ XnX|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 zCollection name is invalidZreusezG'reuse' is deprecated since 8.0.21. Please use 'reuse_existing' instead)r r!NzInvalid value for 'validation'levelr z"Invalid option in 'validation': {}zInvalid value for 'level'zInvalid value for 'schema' validationoptionsmysqlxcreate_collectionTzlYour MySQL server does not support the requested operation. Please update to MySQL 8.0.19 or a later versionzCollection '{}' already exists)rUr )r warningswarnDeprecationWarningr=r isinstancedictr5strr?jsondumpsrrRr errnorr rmsg) rr!Zreuse_existingrVkwargsrCfields valid_optionsoptionrWrUr errr"r"r#rYsV           zSchema.create_collectionc Cs>|s tdt|t s| r&tdd}x"|D]}||kr0tdj|q0Wg}d|kr|d}t|tsttd|jd|fd|kr|d}t|ttfstd|jdt|trtj|n|f|j|d|fd }y|j j d d d |WnFt k r8} z(| j t krtd t| j| j WYdd} ~ XnXdS)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 zCollection name is invalidzInvalid value for 'validation'rUr z"Invalid option in 'validation': {}zInvalid value for 'level'zInvalid value for 'schema'rV)r r!rWrXZmodify_collection_optionsTzlYour MySQL server does not support the requested operation. Please update to MySQL 8.0.19 or a later versionN)rUr )r r]r^r5r_r?r`rarrrRr rbrr rc) rr!rVrfrgrWrUr rerhr"r"r#modify_collectionesB     zSchema.modify_collection)F)F)F)F)FN)N)r,r-r.r/r$r)rDrGrMrErPrQrTrYri __classcell__r"r")r3r#r1s     Sr1c@sreZdZdZddZdddZddZd d Zd d Zd dZ ddZ ddZ ddZ ddZ ddZddZdS)r=zRepresents a collection of documents on a schema. Args: schema (mysqlx.Schema): The Schema object. name (str): The collection name. cCs*tjt|jjt|j}|jj|dkS)zVerifies if this object exists in the database. Returns: bool: `True` if object exists in database. r)_COUNT_TABLES_QUERYr5r rr!rrr6)rr7r"r"r#r)s zCollection.exists_in_databaseNcCst||}|jj|_|S)zRetrieves documents from a collection. Args: condition (Optional[str]): The string with the filter expression of the documents to be retrieved. )rrget_next_statement_idstmt_id)r 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)rvaluesr"r"r#rqs zCollection.addcCst||}|jj|_|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. )rrrlrm)rrnror"r"r#removes  zCollection.removecCst||}|jj|_|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. )rrrlrm)rrnror"r"r#modifys  zCollection.modifycCsttjt|jjt|j}y|jj|}WnDtk rn}z(|j t kr\tdj|j|jjWYdd}~XnX|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_QUERYr5rrr!rrr6r rbr)rr7resrhr"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_indexcCs$|jjddd|jj|j|ddS)z[Drops a collection index. Args: index_name (str): Index name. rXZdrop_collection_indexF)r rCr!N)rrRrr!r)rrxr"r"r# drop_indexs zCollection.drop_indexcCs|jdjd|jd|jS)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 z _id = :id$id)rtsetbindexecute)rdoc_iddocr"r"r# replace_one#szCollection.replace_onecCs,t|tst|}|j|j|jdjS)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 T)r]rrqcopyZupsertr)rrrr"r"r#add_or_replace_one.s zCollection.add_or_replace_onecCs,|jdjd|j}|j}|jj|S)zReturns a Document matching the Document ID. Args: doc_id (str): Document ID Returns: mysqlx.DbDoc: The Document matching the Document ID. z _id = :idr|)rpr~rZ fetch_onerZfetch_active_result)rrresultrr"r"r#get_one:s  zCollection.get_onecCs|jdjd|jS)zRemoves a Document matching the Document ID. Args: doc_id (str): Document ID Returns: mysqlx.Result: Result object. z _id = :idr|)rsr~r)rrr"r"r# remove_oneHs zCollection.remove_one)N)r,r-r.r/r)rprqrsrtrwryrzrrrrr"r"r"r#r=s     r=c@sHeZdZdZddZddZddZdd Zd d Zd d Z ddZ dS)rJzRepresents 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*tjt|jjt|j}|jj|dkS)zVerifies if this object exists in the database. Returns: bool: `True` if object exists in database. r)rkr5r rr!rrr6)rr7r"r"r#r)_s zTable.exists_in_databasecGst|f|}|jj|_|S)zCreates a new :class:`mysqlx.SelectStatement` object. Args: *fields: The fields to be retrieved. Returns: mysqlx.SelectStatement: SelectStatement object )rrrlrm)rreror"r"r#selectis  z Table.selectcGst|f|}|jj|_|S)zCreates a new :class:`mysqlx.InsertStatement` object. Args: *fields: The fields to be inserted. Returns: mysqlx.InsertStatement: InsertStatement object )rrrlrm)rreror"r"r#insertvs  z Table.insertcCst|}|jj|_|S)zCreates a new :class:`mysqlx.UpdateStatement` object. Returns: mysqlx.UpdateStatement: UpdateStatement object )rrrlrm)rror"r"r#updates z Table.updatecCst|}|jj|_|S)zCreates a new :class:`mysqlx.DeleteStatement` object. Returns: mysqlx.DeleteStatement: DeleteStatement object .. versionchanged:: 8.0.12 The ``condition`` parameter was removed. )rrrlrm)rror"r"r#deletes  z Table.deletecCsttjt|jjt|j}y|jj|}WnDtk rn}z(|j t kr\tdj|j|jjWYdd}~XnX|S)ziCounts the rows in the table. Returns: int: The total of rows in the table. z(Table '{}' does not exist in schema '{}'N) rur5rrr!rrr6r rbr)rr7rvrhr"r"r#rws  z Table.countcCs*tjt|jjt|j}|jj|dkS)zDetermine if the underlying object is a view or not. Returns: bool: `True` if the underlying object is a view. r)_COUNT_VIEWS_QUERYr5r rr!rrr6)rr7r"r"r#is_views z Table.is_viewN) r,r-r.r/r)rrrrrwrr"r"r"r#rJTs      rJc@seZdZdZddZdS)rNzRepresents 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*tjt|jjt|j}|jj|dkS)zVerifies if this object exists in the database. Returns: bool: `True` if object exists in database. r)rr5r rr!rrr6)rr7r"r"r#r)s zView.exists_in_databaseN)r,r-r.r/r)r"r"r"r#rNsrN))r/r`rZZdbdocrcompatr errorcoderrrrerrorsr r r helpersr r rZ statementrrrrrrrrrrrkr4rurSobjectrr1r=rJrNr"r"r"r#s*  ,f1c