o ba@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(||_||_|j|_|j|_dSN)_schema_name get_session_sessionget_connection _connection)selfschemanamer"J/var/www/secure340b-portal/env/lib/python3.10/site-packages/mysqlx/crud.py__init__>s zDatabaseObject.__init__cC|jS)z5:class:`mysqlx.Session`: The Session object. rrr"r"r#sessionDzDatabaseObject.sessioncCr%)z3:class:`mysqlx.Schema`: The Schema object. rr'r"r"r#r Jr)zDatabaseObject.schemacCr%)z/str: The name of this database object. rr'r"r"r#r!Pr)zDatabaseObject.namecCr%)z~Returns the underlying connection. Returns: mysqlx.connection.Connection: The connection object. )rr'r"r"r#rVzDatabaseObject.get_connectioncCr%)zwReturns the session of this database object. Returns: mysqlx.Session: The Session object. r&r'r"r"r#r^r,zDatabaseObject.get_sessioncCr%)z{Returns the Schema object of this database object. Returns: mysqlx.Schema: The Schema object. r*r'r"r"r# get_schemafr,zDatabaseObject.get_schemacCr%)zwReturns the name of this database object. Returns: str: The name of this database object. r+r'r"r"r#get_namenr,zDatabaseObject.get_namecCst)zVerifies if this object exists in the database. Returns: bool: `True` if object exists in database. Raises: NotImplementedError: This method must be implemented. )NotImplementedErrorr'r"r"r#exists_in_databasevs z!DatabaseObject.exists_in_databasez8.0.12z)Use 'exists_in_database()' method insteadcC|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 insteadcCr1)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!rrr-r.r0r r2r3r"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)rsuperr9r$)rr(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 rrexecute_sql_scalarrsqlr"r"r#r0szSchema.exists_in_databasec Csz|jdd|ji}|g}|D](}|ddkrqz t||d}Wnty4t||d}Ynw||q|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 |||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_tables zSchema.get_collection_as_tablec Cs||jdd|ji}|g}d}|D]'}|d|vr;z t||d}Wnty5t||d}Ynw||q|S)zoReturns a list of tables for this schema. Returns: `list`: List of Table objects. rCr )ZTABLEZVIEWrDrEr!)rrFrrGTablerIrJ)rrKZtablesZ object_typesrMtabler"r"r# get_tabless    zSchema.get_tablescC"t||}|r|std|S)zwReturns the table of the given name for this schema. Returns: mysqlx.Table: Table object. zTable does not exist)rSr0r )rr!rQrTr"r"r#rP zSchema.get_tablecCrV)ztReturns the view of the given name for this schema. Returns: mysqlx.View: View object. zView does not exist)Viewr0r )rr!rQviewr"r"r#get_viewrWzSchema.get_viewcCrV)zReturns the collection of the given name for this schema. Returns: mysqlx.Collection: Collection object. zCollection does not exist)rHr0r )rr!rQrNr"r"r#get_collectionrWzSchema.get_collectioncCs&|jdtt|jt|ddS)zmDrops a collection. Args: name (str): The name of the collection to be dropped. rBFN)rexecute_nonquery_DROP_TABLE_QUERYr?r r)rr!r"r"r#drop_collections zSchema.drop_collectionNc Ks|stdd|vrtdt|d}t||}|j|d}|durt|tr*|s.tdd}|D] }||vr?td|q2g} d |vrZ|d } t| t sStd | d | fd |vr~|d } t| t tfsmtd | d t| trzt | n| fd | f|d<z |j ddd|W|Sty} z&| jtkrtd| jtkr|std|nt| j| jWYd} ~ |Sd} ~ ww)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': {}rbInvalid 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 warningswarnDeprecationWarningrHr isinstancedictr?strrJjsondumpsrr\r errnorrrmsg) rr!Zreuse_existingrfkwargsrNfields valid_optionsoptionrgrbr errr"r"r#rist        zSchema.create_collectionc Cs&|stdt|tr |stdd}|D] }||vr"td|qg}d|vr=|d}t|ts6td|d|fd|vra|d}t|ttfsPtd|dt|tr]t|n|f|j|d |fd }z |j d d d |WdSt y} z| j t krtdt| j| j d} ~ ww)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`rarcrbrdr rerf)r r!rgrhZmodify_collection_optionsTrjN)r rnror?rprJrqrrrrr\r rsrrrt) rr!rfrwrxrgrbr rvryr"r"r#modify_collectiondsX    zSchema.modify_collection)F)FNr)r4r5r6r7r$r0rOrRrUrPrZr[r^rirz __classcell__r"r"r;r#r9s     Sr9c@sreZdZdZddZdddZddZd d Zd d Zd dZ ddZ ddZ ddZ ddZ ddZddZdS)rHzRepresents a collection of documents on a schema. Args: schema (mysqlx.Schema): The Schema object. name (str): The collection name. cC*tt|jjt|j}|j|dkSr=_COUNT_TABLES_QUERYr?r rr!rrr@rAr"r"r#r0zCollection.exists_in_databaseNcCt||}|j|_|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_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)rvaluesr"r"r#rs zCollection.addcCr)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. )rrrrrr"r"r#remove zCollection.removecCr)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. )rrrrrr"r"r#modifyrzCollection.modifyc Chtt|jjt|j}z |j|}W|Sty3}z|j t kr.td|j|jjd}~ww)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!rrr@r rsrrrBresryr"r"r#count 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_indexs zCollection.create_indexc Cs$|jddd|jj|j|ddS)z[Drops a collection index. Args: index_name (str): Index name. rhZdrop_collection_indexF)r rNr!N)rr\rr!r)rrr"r"r# drop_indexs zCollection.drop_indexcCs|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 _id = :id$id)rsetbindexecuterdoc_iddocr"r"r# replace_one"s zCollection.replace_onecCs,t|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 T)rnrrcopyZupsertrrr"r"r#add_or_replace_one-s 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_onerZfetch_active_result)rrresultrr"r"r#get_one9s  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)rrr"r"r# remove_oneGs zCollection.remove_oner)r4r5r6r7r0rrrrrrrrrrrr"r"r"r#rHs      rHc@sHeZdZdZddZddZddZdd Zd d Zd d Z ddZ dS)rSzRepresents 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. cCr|r=r}rAr"r"r#r0^rzTable.exists_in_databasecG t|g|R}|j|_|S)zCreates a new :class:`mysqlx.SelectStatement` object. Args: *fields: The fields to be retrieved. Returns: mysqlx.SelectStatement: SelectStatement object )rrrrrrvrr"r"r#selecth z Table.selectcGr)zCreates a new :class:`mysqlx.InsertStatement` object. Args: *fields: The fields to be inserted. Returns: mysqlx.InsertStatement: InsertStatement object )rrrrrr"r"r#inserturz Table.insertcCt|}|j|_|S)zCreates a new :class:`mysqlx.UpdateStatement` object. Returns: mysqlx.UpdateStatement: UpdateStatement object )rrrrrrr"r"r#updates z Table.updatecCr)zCreates a new :class:`mysqlx.DeleteStatement` object. Returns: mysqlx.DeleteStatement: DeleteStatement object .. versionchanged:: 8.0.12 The ``condition`` parameter was removed. )rrrrrr"r"r#deletes z Table.deletec Cr)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#rrz Table.countcCr|)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!rrr@rAr"r"r#is_viewrz Table.is_viewN) r4r5r6r7r0rrrrrrr"r"r"r#rSSs      rSc@seZdZdZddZdS)rXzRepresents 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. cCr|r=rrAr"r"r#r0rzView.exists_in_databaseN)r4r5r6r7r0r"r"r"r#rXs rX)'r7rqrkZdbdocr errorcoderrrrerrorsrr r helpersr r r Z statementrrrrrrrrrrr~r>rr]objectrr9rHrSrXr"r"r"r#s* ,f1c