U fY@sdZddlZddlZddlZddlmZmZddlmZddl m Z ddl m Z ddl mZdd lmZdd lmZd ZGd d d eZddZd7ddZd8ddZd9ddZd:ddZGdddeZGdddeZGdddeZGdd d eZGd!d"d"eZGd#d$d$eZ Gd%d&d&eZ!Gd'd(d(eZ"Gd)d*d*e"Z#Gd+d,d,e"Z$Gd-d.d.eZ%Gd/d0d0eZ&Gd1d2d2eZ'Gd3d4d4eZ(Gd5d6d6eZ)dS);zImplementation of Statements.N)ProgrammingErrorNotSupportedError) ExprParser)LockContention)DbDoc) deprecated)Result) mysqlxpb_enumz&The given index name "{}" is not validc@seZdZdZddZdS)ExprzExpression wrapper.cCs ||_dSN)expr)selfr r4/tmp/pip-unpacked-wheel-mzf9r1ws/mysqlx/statement.py__init__0sz Expr.__init__N)__name__ __module__ __qualname____doc__rrrrrr .sr cGs*t|dkr&t|dttfr&|dS|S)zParse flexible parameters.rr)len isinstancelisttuple)valuesrrrflexible_params4srcCsPd|kr8|ddkr |ddkp6|ddko6|ddkS|ddkoN|ddkS)zCheck if the given identifier is quoted. Args: identifier (string): Identifier to check. sql_mode (Optional[string]): SQL mode. Returns: `True` if the identifier has backtick quotes, and False otherwise. ANSI_QUOTESr`"r identifiersql_moderrris_quoted_identifier;s r$cCs<t|dkrdSd|kr*d|ddSd|ddS) a@Quote the given identifier with backticks, converting backticks (`) in the identifier name with the correct escape sequence (``). Args: identifier (string): Identifier to quote. sql_mode (Optional[string]): SQL mode. Returns: A string with the identifier quoted with backticks. rz``rz"{0}"r z""z`{0}`r)rformatreplacer!rrrquote_identifierKs r'csdfdd|DS)aQuote the given multi-part identifier with backticks. Args: identifiers (iterable): List of identifiers to quote. sql_mode (Optional[string]): SQL mode. Returns: A string with the multi-part identifier quoted with backticks. .csg|]}t|qSr)r').0r"r#rr gsz.quote_multipart_identifier..)join)Z identifiersr#rr*rquote_multipart_identifier]s r-cCs^d|kr dnd}||kr"d|nd}||d}t|dkrB|n |d||d|fS) zParse table name. Args: default_schema (str): The default schema. table_name (str): The table name. sql_mode(Optional[str]): The SQL mode. Returns: str: The parsed table name. rr rz.{0}r(rrr)r%splitrstrip)Zdefault_schemaZ table_namer#quote delimitertemprrrparse_table_nameks   r3c@seZdZdZd"ddZeddZeddZed d Zej d d Zed d Z eddZ e j ddZ eddZ e j ddZ eddZ eddZej ddZddZddZddZdd Zd!S)# Statementa Provides base functionality for statement objects. Args: target (object): The target database object, it can be :class:`mysqlx.Collection` or :class:`mysqlx.Table`. doc_based (bool): `True` if it is document based. TcCs@||_||_|r|nd|_d|_d|_d|_d|_d|_dS)NrTF) _target _doc_basedget_connection _connection_stmt_id _exec_counter_changed _prepared_deallocate_prepare_executertarget doc_basedrrrrszStatement.__init__cCs|jS)z#object: The database object target.)r5rrrrr?szStatement.targetcCs|jjS)z*:class:`mysqlx.Schema`: The Schema object.)r5schemarArrrrBszStatement.schemacCs|jS)zXReturns this statement ID. Returns: int: The statement ID. r9rArrrstmt_idszStatement.stmt_idcCs ||_dSr rCrvaluerrrrDscCs|jS)z5int: The number of times this statement was executed.r:rArrr exec_counterszStatement.exec_countercCs|jS)z+bool: `True` if this statement has changes.r;rArrrchangedszStatement.changedcCs ||_dSr rIrErrrrJscCs|jS)z1bool: `True` if this statement has been prepared.r<rArrrpreparedszStatement.preparedcCs ||_dSr rKrErrrrLscCs |jdkS)zDbool: `True` if this statement was executed more than once. rrGrArrrrepeatedszStatement.repeatedcCs|jS)zBbool: `True` to deallocate + prepare + execute statement. r=rArrrdeallocate_prepare_executesz$Statement.deallocate_prepare_executecCs ||_dSr rNrErrrrOscCs|jS)zkCheck if it is document based. Returns: bool: `True` if it is document based. )r6rArrr is_doc_basedszStatement.is_doc_basedcCs|jd7_dS)z@Increments the number of times this statement has been executed.rNrGrArrrincrement_exec_countersz Statement.increment_exec_countercCs d|_dS)zrsrrrnszWriteStatement.__init__cCs|jS)z^Returns the list of values. Returns: `list`: The list of values. )rrArrr get_valuesrszWriteStatement.get_valuescCstdSrSrTrArrrrVzszWriteStatement.execute)rrrrrrrVrrrrsrrks rcsBeZdZdZfddZddZd ddZd d Zd d ZZ S) AddStatementzA statement for document addition on a collection. Args: collection (mysqlx.Collection): The Collection object. cs"tt||dd|_g|_dS)NTF)r[rr_upsertids)r collectionrsrrrszAddStatement.__init__cCs|jS)zhReturns `True` if it's an upsert. Returns: bool: `True` if it's an upsert. rrArrr is_upsertszAddStatement.is_upsertTcCs ||_|S)zSets the upset flag to the boolean of the value provided. Setting of this flag allows updating of the matched rows/documents with the provided value. Args: value (optional[bool]): Set or unset the upsert flag. rrErrrupsertszAddStatement.upsertcGs:t|D],}t|tr$|j|q|jt|q|S)zAdds a list of documents into a collection. Args: *values: The documents to be added into the collection. Returns: mysqlx.AddStatement: AddStatement object. )rrrrr)rrvalrrradds  zAddStatement.addcCs t|jdkrtS|j|S)[Execute the statement. Returns: mysqlx.Result: Result object. r)rrr r8 send_insertrArrrrVszAddStatement.execute)T) rrrrrrrrrVrrrrsrrs   rc@s"eZdZdZdddZddZdS) UpdateSpeczUpdate specification class implementation. Args: update_type (int): The update type. source (str): The source. value (Optional[str]): The value. NcCsj|tdkr|||nL||_||_t|dkrL|ddkrL|dd|_t|jdj|_||_dS)N*Mysqlx.Crud.UpdateOperation.UpdateType.SETr$rF) r _table_set update_typesourcerrZdocument_fieldr"rF)rrrrFrrrrs zUpdateSpec.__init__cCs$td|_t|d|_||_dS)zlTable set. Args: source (str): The source. value (str): The value. rTN)r rrZparse_table_update_fieldrrF)rrrFrrrrs zUpdateSpec._table_set)N)rrrrrrrrrrrs rcspeZdZdZfddZddZddZdd Zed d d Z d dZ ddZ ddZ ddZ ddZZS)ModifyStatementaUA statement for document update operations on a Collection. Args: collection (mysqlx.Collection): The Collection object. condition (str): Sets the search condition to identify the documents to be modified. .. versionchanged:: 8.0.12 The ``condition`` parameter is now mandatory. cstt|j||di|_dSN)r?rr)r[rr _update_opsrrrrrsrrrs zModifyStatement.__init__cGs |j|S)zSets the sorting criteria. Args: *clauses: The expression strings defining the sort criteria. Returns: mysqlx.ModifyStatement: ModifyStatement object. rrrrrrs zModifyStatement.sortcCs|jSztReturns the list of update operations. Returns: `list`: The list of update operations. rrArrrget_update_opsszModifyStatement.get_update_opscCs ttd|||j|<d|_|S)a2Sets or updates attributes on documents in a collection. Args: doc_path (string): The document path of the item to be set. value (string): The value to be set on the specified attribute. Returns: mysqlx.ModifyStatement: ModifyStatement object. z/Mysqlx.Crud.UpdateOperation.UpdateType.ITEM_SETTrr rr;rZdoc_pathrFrrrsets  zModifyStatement.setrcCs ttd|||j|<d|_|S)aAdd an update to the statement setting the field, if it exists at the document path, to the given value. Args: doc_path (string): The document path of the item to be set. value (object): The value to be set on the specified attribute. Returns: mysqlx.ModifyStatement: ModifyStatement object. .. deprecated:: 8.0.12 z3Mysqlx.Crud.UpdateOperation.UpdateType.ITEM_REPLACETrrrrrchanges zModifyStatement.changecGs,t|D]}ttd||j|<qd|_|S)aRemoves attributes from documents in a collection. Args: doc_paths (list): The list of document paths of the attributes to be removed. Returns: mysqlx.ModifyStatement: ModifyStatement object. z2Mysqlx.Crud.UpdateOperation.UpdateType.ITEM_REMOVET)rrr rr;)rZ doc_pathsitemrrrunset&s  zModifyStatement.unsetcCs ttd|||j|<d|_|S)aInsert a value into the specified array in documents of a collection. Args: field (string): A document path that identifies the array attribute and position where the value will be inserted. value (object): The value to be inserted. Returns: mysqlx.ModifyStatement: ModifyStatement object. z3Mysqlx.Crud.UpdateOperation.UpdateType.ARRAY_INSERTTrrfieldrFrrr array_insert6s  zModifyStatement.array_insertcCs ttd|||j|<d|_|S)aInserts a value into a specific position in an array attribute in documents of a collection. Args: doc_path (string): A document path that identifies the array attribute and position where the value will be inserted. value (object): The value to be inserted. Returns: mysqlx.ModifyStatement: ModifyStatement object. z3Mysqlx.Crud.UpdateOperation.UpdateType.ARRAY_APPENDTrrrrr array_appendHs  zModifyStatement.array_appendcCsX|dkr d}t|ttttfs&tdttddt|trB|n||j d<d|_ |S)aTakes a :class:`mysqlx.DbDoc`, string JSON format or a dict with the changes and applies it on all matching documents. Args: doc (object): A generic document (DbDoc), string in JSON format or dict, with the changes to apply to the matching documents. Returns: mysqlx.ModifyStatement: ModifyStatement object. Nrz>Invalid data for update operation on document collection tablez2Mysqlx.Crud.UpdateOperation.UpdateType.MERGE_PATCHpatchT) rrrurrwrrr r rr;)rdocrrrr[s  zModifyStatement.patchcCs|jstd|j|S)Execute the statement. Returns: mysqlx.Result: Result object. Raises: ProgrammingError: If condition was not set. z!No condition was found for modifyrorr8Z send_updaterArrrrVss zModifyStatement.execute)rrrrrrrrrrrrrrrVrrrrsrrs   rcszeZdZdZdfdd ZeddZdd Zd d Zd d Z e j fddZ e j fddZ ddZddZddZZS) ReadStatementaProvide base functionality for Read operations Args: target (object): The target database object, it can be :class:`mysqlx.Collection` or :class:`mysqlx.Table`. doc_based (Optional[bool]): `True` if it is document based (default: `True`). condition (Optional[str]): Sets the search condition to filter documents or records. TNcs,tt||||d|_d|_tj|_dSNF)r[rr_lock_exclusive _lock_sharedrDEFAULT_lock_contentionrqrsrrrszReadStatement.__init__cCs|jS)z::class:`mysqlx.LockContention`: The lock contention value.)rrArrrlock_contentionszReadStatement.lock_contentioncCs6zt|}Wntk r*tdYnX||_dS)zSet the lock contention. Args: lock_contention (:class:`mysqlx.LockContention`): Lock contention. Raises: ProgrammingError: If is an invalid lock contention value. z;Invalid lock contention mode. Use 'NOWAIT' or 'SKIP_LOCKED'N)rindexrzrr)rr_rrr_set_lock_contentions z"ReadStatement._set_lock_contentioncCs|jS)zrReturns `True` if is `EXCLUSIVE LOCK`. Returns: bool: `True` if is `EXCLUSIVE LOCK`. )rrArrris_lock_exclusiveszReadStatement.is_lock_exclusivecCs|jS)zlReturns `True` if is `SHARED LOCK`. Returns: bool: `True` if is `SHARED LOCK`. )rrArrris_lock_sharedszReadStatement.is_lock_sharedcCsd|_d|_|||S)zExecute a read operation with `SHARED LOCK`. Only one lock can be active at a time. Args: lock_contention (:class:`mysqlx.LockContention`): Lock contention. FTrrrrrrrr lock_shareds zReadStatement.lock_sharedcCsd|_d|_|||S)zExecute a read operation with `EXCLUSIVE LOCK`. Only one lock can be active at a time. Args: lock_contention (:class:`mysqlx.LockContention`): Lock contention. TFrrrrrlock_exclusives zReadStatement.lock_exclusivecGs|j||S)zSets a grouping criteria for the resultset. Args: *fields: The string expressions identifying the grouping criteria. Returns: mysqlx.ReadStatement: ReadStatement object. )rrrrrgroup_bys zReadStatement.group_bycCs|||S)a=Sets a condition for records to be considered in agregate function operations. Args: condition (string): A condition on the agregate functions used on the grouping criteria. Returns: mysqlx.ReadStatement: ReadStatement object. )rrrrrhavings zReadStatement.havingcCs |j|Sr)r8Z send_findrArrrrVszReadStatement.execute)TN)rrrrrrWrrrrrrrrrrrVrrrrsrrs     rcs2eZdZdZd fdd ZddZddZZS) FindStatementaA statement document selection on a Collection. Args: collection (mysqlx.Collection): The Collection object. condition (Optional[str]): An optional expression to identify the documents to be retrieved. If not specified all the documents will be included on the result unless a limit is set. Ncstt||d|dS)NT)r[rrrrsrrrszFindStatement.__init__cGs |j|S)zSets a document field filter. Args: *fields: The string expressions identifying the fields to be extracted. Returns: mysqlx.FindStatement: FindStatement object. )rrrrrrs zFindStatement.fieldscGs |j|SzSets the sorting criteria. Args: *clauses: The expression strings defining the sort criteria. Returns: mysqlx.FindStatement: FindStatement object. rrrrrr s zFindStatement.sort)N)rrrrrrrrrrrsrrs  rcs8eZdZdZfddZddZddZdd ZZS) SelectStatementzA statement for record retrieval operations on a Table. Args: table (mysqlx.Table): The Table object. *fields: The fields to be retrieved. cs tt||d|j|dSr)r[rrrrtablerrsrrrszSelectStatement.__init__cCs ||S)zSets the search condition to filter. Args: condition (str): Sets the search condition to filter records. Returns: mysqlx.SelectStatement: SelectStatement object. rrrrrr#s zSelectStatement.wherecGs |j|S)zSets the order by criteria. Args: *clauses: The expression strings defining the order by criteria. Returns: mysqlx.SelectStatement: SelectStatement object. rrrrrorder_by.s zSelectStatement.order_byc Cs|jrd|jnd}|jr(d|jnd}|jr>d|jnd}|jrTd|jnd}|j rnd|j |j nd}dj|j p~d|j j|jj|||||d }|S) zYReturns the generated SQL. Returns: str: The generated SQL. z WHERE {0}rz GROUP BY {0}z HAVING {0}z ORDER BY {0}z LIMIT {0} OFFSET {1}zISELECT {select} FROM {schema}.{table}{where}{group}{having}{order}{limit}*)selectrBrrrgrouprorder)ror%rgrkr_rlr^rnrerjrbrarcrBnamer?)rrrrrrZstmtrrrget_sql9s4 zSelectStatement.get_sql) rrrrrrrrrrrrsrrs    rcs0eZdZdZfddZddZddZZS)InsertStatementzA statement for insert operations on Table. Args: table (mysqlx.Table): The Table object. *fields: The fields to be inserted. cs tt||dt||_dSr)r[rrr_fieldsrrsrrrXszInsertStatement.__init__cGs|jtt||S)zSet the values to be inserted. Args: *values: The values of the columns to be inserted. Returns: mysqlx.InsertStatement: InsertStatement object. )rrrr)rrrrrr\s zInsertStatement.valuescCs |j|Sr)r8rrArrrrVhszInsertStatement.execute)rrrrrrrVrrrrsrrQs  rcsHeZdZdZfddZddZddZdd Zd d Zd d Z Z S)UpdateStatementzA statement for record update operations on a Table. Args: table (mysqlx.Table): The Table object. .. versionchanged:: 8.0.12 The ``fields`` parameters were removed. cstt|j|ddi|_dSr)r[rrrrrrsrrrzszUpdateStatement.__init__cCs ||S)zSets the search condition to filter. Args: condition (str): Sets the search condition to filter records. Returns: mysqlx.UpdateStatement: UpdateStatement object. rrrrrr~s zUpdateStatement.wherecGs |j|S)zSets the order by criteria. Args: *clauses: The expression strings defining the order by criteria. Returns: mysqlx.UpdateStatement: UpdateStatement object. rrrrrrs zUpdateStatement.order_bycCs|jSrrrArrrrszUpdateStatement.get_update_opscCs ttd|||j|<d|_|S)aUpdates the column value on records in a table. Args: field (string): The column name to be updated. value (object): The value to be set on the specified column. Returns: mysqlx.UpdateStatement: UpdateStatement object. rTrrrrrrs  zUpdateStatement.setcCs|jstd|j|S)zExecute the statement. Returns: mysqlx.Result: Result object Raises: ProgrammingError: If condition was not set. z!No condition was found for updaterrArrrrVs zUpdateStatement.execute) rrrrrrrrrrVrrrrsrrqs   rcs0eZdZdZfddZddZddZZS)RemoveStatementaEA statement for document removal from a collection. Args: collection (mysqlx.Collection): The Collection object. condition (str): Sets the search condition to identify the documents to be removed. .. versionchanged:: 8.0.12 The ``condition`` parameter was added. cstt|j||ddSr)r[rrrrsrrrs zRemoveStatement.__init__cGs |j|Srrrrrrrs zRemoveStatement.sortcCs|jstd|j|S)rz!No condition was found for removerorr8Z send_deleterArrrrVs zRemoveStatement.execute)rrrrrrrVrrrrsrrs  rcs8eZdZdZfddZddZddZdd ZZS) DeleteStatementzA statement that drops a table. Args: table (mysqlx.Table): The Table object. .. versionchanged:: 8.0.12 The ``condition`` parameter was removed. cstt|j|dddSr)r[rrrrsrrrszDeleteStatement.__init__cCs ||S)zSets the search condition to filter. Args: condition (str): Sets the search condition to filter records. Returns: mysqlx.DeleteStatement: DeleteStatement object. rrrrrrs zDeleteStatement.wherecGs |j|S)zSets the order by criteria. Args: *clauses: The expression strings defining the order by criteria. Returns: mysqlx.DeleteStatement: DeleteStatement object. rrrrrrs zDeleteStatement.order_bycCs|jstd|j|S)rz!No condition was found for deleterrArrrrVs zDeleteStatement.execute) rrrrrrrrVrrrrsrrs    rcs(eZdZdZfddZddZZS)CreateCollectionIndexStatementa)A statement that creates an index on a collection. Args: collection (mysqlx.Collection): Collection. index_name (string): Index name. index_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, "collation": collation, "options": options, "srid": srid}, # {... more members, # repeated as many times # as needed} ], "type": type} cs8tt|j|dt||_||_|jdg|_dS)N)r?r) r[rrcopydeepcopy _index_desc _index_namepop _fields_desc)rrZ index_nameZ index_descrsrrr's z'CreateCollectionIndexStatement.__init__c CsP|jdkrtt|jz`t|j}t|trZ|dt dkrxtt|jn|j t dkrxtt|jWn(t t fk rtt|jYnX|j std|jt|j tstdi}|j|d<|jj|d<|jjj|d<d|jkr|jd|d<nd |d<|jd d |d <|d r@td g|d <|jr`td|jz|j D]v}i}|d|d<|d|d<|dd |d<|dd |d<t|dtstdt|dtstd|ddkr|dstd|dd kr,|ddkr,tdd|krn|dds`td|d|d|d<d|kr|ddkrtd|d|d<d|kr|ddkrtd|d|d<|d |qjWn4tk r}ztd ||W5d}~XYnX|j D]}|r"td!|q"|jd"d#d$|S)%rNtypezMysqlx.Expr.Expr.Type.IDENTzERequired member 'fields' not found in the given index description: {}z-Required member 'fields' must contain a list.rrrBZINDEXuniqueFz!Unique indexes are not supported. constraintzUnidentified fields: {}rmemberrequiredarrayz'Field member 'required' must be Booleanz$Field member 'array' must be BooleanZSPATIALzQField member 'required' must be set to 'True' when index type is set to 'SPATIAL'ZGEOJSONzIIndex 'type' must be set to 'SPATIAL' when field type is set to 'GEOJSON'Z collationZTEXTzFThe 'collation' member can only be used when field type is set to '{}'optionszIThe 'options' member can only be used when index type is set to 'GEOJSON'ZsridzFThe 'srid' member can only be used when index type is set to 'GEOJSON'z4Required inner member {} not found in constraint: {}zUnidentified inner fields:{}ZmysqlxZcreate_collection_indexT)rrERR_INVALID_INDEX_NAMEr%rr Z get_messagerrur rrzAttributeErrorrrrr5rrBrrr TypeErrorupper startswithrKeyErrorr8Zexecute_nonquery)rZ parsed_identrZ field_descrerrrrrrV-s                   z&CreateCollectionIndexStatement.execute)rrrrrrVrrrrsrrs r)r)r)r)r)*rrrxrerrorsrrr r constantsrZdbdocrZhelpersrresultr Zprotobufr r objectr rr$r'r-r3r4rYrrrrrrrrrrrrrrrrrsF          iFA:"#r%9 H(0