3 S^L@sdZddlmZddlmZddlmZmZddlm Z m Z m Z ddl m Z mZmZmZmZmZmZmZmZdZdZd Zd Zd ZGd d d eZGdddeZGdddeZGdddeZGdddeZ dS)z,Implementation of the CRUD database objects.)DbDoc)ER_NO_SUCH_TABLE)OperationalErrorProgrammingError) 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-build-8app2_gc/mysql-connector-python/mysqlx/crud.py__init__:s zDatabaseObject.__init__cCs|jS)z5:class:`mysqlx.Session`: The Session object. )r)rrrrsession@szDatabaseObject.sessioncCs|jS)z3:class:`mysqlx.Schema`: The Schema object. )r)rrrrrFszDatabaseObject.schemacCs|jS)z/str: The name of this database object. )r)rrrrrLszDatabaseObject.namecCs|jS)z~Returns the underlying connection. Returns: mysqlx.connection.Connection: The connection object. )r)rrrrrRszDatabaseObject.get_connectioncCs|jS)zwReturns the session of this database object. Returns: mysqlx.Session: The Session object. )r)rrrrrZszDatabaseObject.get_sessioncCs|jS)z{Returns the Schema object of this database object. Returns: mysqlx.Schema: The Schema object. )r)rrrr get_schemabszDatabaseObject.get_schemacCs|jS)zwReturns the name of this database object. Returns: str: The name of this database object. )r)rrrrget_namejszDatabaseObject.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)rrrrexists_in_databasers 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#)rrrr am_i_real}s 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!)rrrrwho_am_is zDatabaseObject.who_am_iN)__name__ __module__ __qualname____doc__rpropertyrrrrrr r!r#rr$r%rrrrr3s    rcsreZdZdZfddZddZddZdd d Zd d Zdd dZ dddZ dddZ ddZ dddZ ZS)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)rsuperr+r)rrr) __class__rrrszSchema.__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_QUERYformatrrrexecute_sql_scalar)rsqlrrrr#szSchema.exists_in_databasec Cs||jjd|j}|jg}xZ|D]R}|ddkr4q"yt||d}Wn"tk rht||d}YnX|j|q"W|S)zyReturns a list of collections for this schema. Returns: `list`: List of Collection objects. list_objectstypeZ COLLECTION TABLE_NAMEr)rget_row_resultr fetch_all Collection ValueErrorappend)rrows collectionsrow collectionrrrget_collectionss  zSchema.get_collectionsFcCs |j||S)zuReturns a a table object for the given collection Returns: mysqlx.Table: Table object. ) get_table)rrcheck_existencerrrget_collection_as_tableszSchema.get_collection_as_tablec Cs~|jjd|j}|jg}d}xX|D]P}|d|kr&yt||d}Wn"tk rjt||d}YnX|j|q&W|S)zoReturns a list of tables for this schema. Returns: `list`: List of Table objects. r2TABLEVIEWr3r4r)rBrC)rr5rr6Tabler8r9)rr:ZtablesZ object_typesr<tablerrr 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)rDr#r)rrr@rErrrr?s  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)rrr@viewrrrget_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)r7r#r)rrr@r=rrrget_collections  zSchema.get_collectioncCs&|jjdtjt|jt|ddS)zmDrops a collection. Args: name (str): The name of the collection to be dropped. r1FN)rexecute_nonquery_DROP_TABLE_QUERYr/rr)rrrrrdrop_collectionszSchema.drop_collectioncCsF|s tdt||}|js6|jjddd|j|n |sBtd|S)aCreates 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 (bool): `True` to reuse an existing collection. Returns: mysqlx.Collection: Collection object. Raises: :class:`mysqlx.ProgrammingError`: If ``reuse`` is False and collection exists. zCollection name is invalidxplugincreate_collectionTzCollection already exists)rr7r#rrKr)rrZreuser=rrrrO s  zSchema.create_collection)F)F)F)F)F)r&r'r(r)rr#r>rArFr?rIrJrMrO __classcell__rr)r-rr+s     r+c@sreZdZdZddZdddZddZd d Zd d Zd dZ ddZ ddZ ddZ ddZ ddZddZdS)r7zRepresents 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_QUERYr/rrrrrr0)rr1rrrr#-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. )r rget_next_statement_idstmt_id)r conditionstmtrrrfind7s  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. )r add)rvaluesrrrrWBs 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. )r rrRrS)rrTrUrrrremoveNs  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. )r rrRrS)rrTrUrrrmodify_s  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_QUERYr/rrrrrr0rerrnor)rr1reserrrrrcountps  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_descrrr create_indexszCollection.create_indexcCs |jjddd|jj|j|dS)z[Drops a collection index. Args: index_name (str): Index name. rNZdrop_collection_indexFN)rrKrrr)rr`rrr 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)rZsetbindexecute)rdoc_iddocrrr replace_oneszCollection.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) isinstancerrWcopyZupsertrg)rrhrirrradd_or_replace_ones 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 = :idrd)rVrfrgZ fetch_onerZfetch_active_result)rrhresultrirrrget_ones  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 = :idrd)rYrfrg)rrhrrr remove_ones zCollection.remove_one)N)r&r'r(r)r#rVrWrYrZr_rarbrjrmrorprrrrr7%s     r7c@sHeZdZdZddZddZddZdd Zd d Zd d Z ddZ dS)rDzRepresents 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)rQr/rrrrrr0)rr1rrrr#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 )r rrRrS)rfieldsrUrrrselects  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 )rrrRrS)rrqrUrrrinserts  z Table.insertcCst|}|jj|_|S)zCreates a new :class:`mysqlx.UpdateStatement` object. Returns: mysqlx.UpdateStatement: UpdateStatement object )rrrRrS)rrUrrrupdates 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. )rrrRrS)rrUrrrdeletes  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) r[r/rrrrrr0rr\r)rr1r]r^rrrr_s  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_QUERYr/rrrrrr0)rr1rrris_view-s z Table.is_viewN) r&r'r(r)r#rrrsrtrur_rwrrrrrDs      rDc@seZdZdZddZdS)rGzRepresents 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)rvr/rrrrrr0)rr1rrrr#Bs zView.exists_in_databaseN)r&r'r(r)r#rrrrrG8srGN)!r)Zdbdocr errorcodererrorsrrhelpersrrrZ statementr r r r r rrrrrvrQr.r[rLobjectrr+r7rDrGrrrrs"  ,f 1c