U
|
¤ý°dcà ã @ s4 d Z ddlmZ ddlZddlZddlZddlmZmZm Z m
|
Z
|
m Z m Z m Z ddlmZ ddlmZ ddlmZmZ dd lmZ dd
|
lmZ dd lmZ dd lm Z m Z m Z m Z dd l m!Z!m"Z"m#Z#m$Z$m%Z%m&Z& dZ'G dd dZ(dddddZ)dDddddddZ*dEddddd d Z+dFd ddd d d!Z,dGdddd"d#d$d%Z-G d&d' d'Z.G d(d) d)e.Z/G d*d+ d+e.Z0G d,d- d-e.Z1G d.d/ d/e1Z2G d0d1 d1Z3G d2d3 d3e/Z4G d4d5 d5e/Z5G d6d7 d7e5Z6G d8d9 d9e5Z7G d:d; d;e1Z8G d<d= d=e/Z9G d>d? d?e/Z:G d@dA dAe/Z;G dBdC dCe.Z<dS )Hz Implementation of Statements.é )Ú annotationsN)ÚAnyÚDictÚIterableÚListÚOptionalÚTupleÚUnioné )ÚLockContention)ÚDbDoc)ÚNotSupportedErrorÚProgrammingError)Ú
|
ExprParser)Ú
|
deprecated)Ú mysqlxpb_enum)Ú DocResultÚResultÚ RowResultÚ SqlResult)ÚConnectionTypeÚDatabaseTargetTypeÚ MessageTypeÚProtobufMessageCextTypeÚProtobufMessageTypeÚ
|
SchemaTypez&The given index name "{}" is not validc @ s e Zd ZdZdddddZdS )ÚExprzExpression wrapper.r ÚNone)ÚexprÚreturnc C s
|
|| _ d S ©N)r )Úselfr © r" úGd:\z\workplace\vscode\pyvenv\venv\Lib\site-packages\mysqlx/statement.pyÚ__init__? s z Expr.__init__N)Ú__name__Ú
|
__module__Ú __qualname__Ú__doc__r$ r" r" r" r# r < s r r zUnion[List, Tuple]©Úvaluesr c G s* t | dkr&t| d ttfr&| d S | S )zParse flexible parameters.r
|
r )ÚlenÚ
|
isinstanceÚlistÚtuple)r* r" r" r# Úflexible_paramsC s r/ Ú ÚstrÚbool)Ú
|
identifierÚsql_moder c C sP d|kr8| d dkr | d dkp6| d dko6| d dkS | d dkoN| d dkS )zòCheck 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" )r3 r4 r" r" r# Úis_quoted_identifierJ s
|
|
ÿr9 c C sH t | dkrdS d|kr0| dd¡}d| dS | dd¡}d| dS )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.
|
r z``r5 r8 z""r6 )r+ Úreplace)r3 r4 Úquotedr" r" r# Úquote_identifier[ s r< z Iterable[str])Ú identifiersr4 r c s d fdd| D ¡S )a Quote 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.
|
Ú.c s g | ]}t | qS r" )r< )Ú.0r3 ©r4 r" r# Ú
|
<listcomp>z s z.quote_multipart_identifier.<locals>.<listcomp>)Újoin)r= r4 r" r@ r# Úquote_multipart_identifiero s
|
ÿrC zTuple[str, str])Údefault_schemaÚ
|
table_namer4 r c C s^ d|kr dnd}||kr"d| nd}| |d¡}t|dkrB| n |d |¡|d |¡fS )zÞParse 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.
|
r5 r8 r6 r> r
|
r r7 )Úsplitr+ Ústrip)rD rE r4 ÚquoteÚ delimiterÚtempr" r" r# Úparse_table_name~ s þrK c @ sD e Zd ZdZd+ddddddZedd d
|
d Zed d d dZedd ddZej dddddZedd ddZ
|
edd ddZ e j dddddZ edd ddZ e j dddddZ edd d d Z edd d d Zej dddd d Zdd d!d"Zdd d#d$Zdd d%d&Zd'd d(d)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.
|
Tr r2 r ©ÚtargetÚ doc_basedr c C s@ || _ || _|r| ¡ nd | _d | _d| _d| _d| _d| _d S )Nr TF) Ú_targetÚ
|
_doc_basedÚget_connectionÚ _connectionÚ_stmt_idÚ _exec_counterÚ_changedÚ _preparedÚ_deallocate_prepare_execute©r! rN rO r" r" r# r$ s ÿzStatement.__init__©r c C s | j S )z#object: The database object target.)rP ©r! r" r" r# rN © s zStatement.targetr c C s | j jS )z*:class:`mysqlx.Schema`: The Schema object.)rP Úschemar[ r" r" r# r\ ® s zStatement.schemaÚintc C s | j S )zXReturns this statement ID.
|
|
Returns:
|
int: The statement ID.
|
©rT r[ r" r" r# Ústmt_id³ s zStatement.stmt_id©Úvaluer c C s
|
|| _ d S r r^ ©r! ra r" r" r# r_ ¼ s c C s | j S )z5int: The number of times this statement was executed.©rU r[ r" r" r# Ú exec_counterÀ s zStatement.exec_counterc C s | j S )z+bool: `True` if this statement has changes.©rV r[ r" r" r# ÚchangedÅ s zStatement.changedc C s
|
|| _ d S r re rb r" r" r# rf Ê s c C s | j S )z1bool: `True` if this statement has been prepared.©rW r[ r" r" r# ÚpreparedÎ s zStatement.preparedc C s
|
|| _ d S r rg rb r" r" r# rh Ó s c C s
|
| j dkS )z;bool: `True` if this statement was executed more than once.r
|
rc r[ r" r" r# Úrepeated× s zStatement.repeatedc C s | j S )z9bool: `True` to deallocate + prepare + execute statement.©rX r[ r" r" r# Údeallocate_prepare_executeÜ s z$Statement.deallocate_prepare_executec C s
|
|| _ d S r rj rb r" r" r# rk á s c C s | j S )zkCheck if it is document based.
|
|
Returns:
|
bool: `True` if it is document based.
|
)rQ r[ r" r" r# Ú is_doc_basedå s zStatement.is_doc_basedc C s | j d7 _ dS )z@Increments the number of times this statement has been executed.r
|
Nrc r[ r" r" r# Úincrement_exec_counterí s z Statement.increment_exec_counterc C s
|
d| _ dS )z<Resets the number of times this statement has been executed.r Nrc r[ r" r" r# Úreset_exec_counterñ s z Statement.reset_exec_counterr c C s t dS ©zqExecute the statement.
|
|
Raises:
|
NotImplementedError: This method must be implemented.
|
N©ÚNotImplementedErrorr[ r" r" r# Úexecuteõ s zStatement.executeN)T)r% r& r' r( r$ ÚpropertyrN r\ r_ Úsetterrd rf rh ri rk rl rm rn rr r" r" r" r# rL s< rL c s~ e Zd ZdZdGddddd fd d
|
Zd dd d dZdd dddZdd dddZdddddZdddddZ dd ddd Z
|
d d d d Z d!d d"d#Z d$d d%d&Z d'd d(d)Zd*d d+d,Zd*d d-d.Zd'd d/d0Zd$d d1d2Zd$d d3d4Zed5dd dd6d7Zed5dd dd8d9ZdHd*d:d d;d<d=Zd*d d>d?d@ZdAd dBdCdDZdAd dEdFZ ZS )IÚFilterableStatementaÉ A statement to be used with filterable statements.
|
|
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.
|
TNr r2 ú Optional[str]r ©rN rO Ú conditionr c s t j||d i | _i | _d | _d| _d | _d| _d | _d| _ d | _
|
d| _ d | _ d| _ d | _d| _d| _d| _d| _d| _d| _d| _|r| |¡ d S )N©rN rO r0 r F)Úsuperr$ Ú _binding_mapÚ _bindingsÚ_havingÚ _grouping_strÚ _groupingÚ _limit_offsetÚ_limit_row_countÚ_projection_strÚ_projection_exprÚ _sort_strÚ
|
_sort_exprÚ
|
_where_strÚ _where_exprÚ has_bindingsÚ has_limitÚ has_group_byÚ
|
has_havingÚhas_projectionÚhas_sortÚ has_whereÚ
|
_set_where©r! rN rO rx ©Ú __class__r" r# r$
|
s4 þþþz FilterableStatement.__init__z!Union[DbDoc, Dict[str, Any], str])Úobjr c
|
C s¸ t |tr | t| ¡ ¡ nt |tr8| | ¡ ¡ n|t |tr¬z t |¡}t |ts\tW n, tk
|
r } zt d|W 5 d}~X Y nX |
|
¡ D ]}| ||| ¡ qnt ddS )a Bind single object.
|
|
Args:
|
obj (:class:`mysqlx.DbDoc` or str): DbDoc or JSON string object.
|
|
Raises:
|
:class:`mysqlx.ProgrammingError`: If invalid JSON string to bind.
|
ValueError: If JSON loaded is not a dictionary.
|
zInvalid JSON string to bindNz%Invalid JSON string or object to bind) r, ÚdictÚbindr Zas_strr1 ÚjsonÚloadsÚ
|
ValueErrorr Úkeys)r! r ÚresÚerrÚkeyr" r" r# Ú _bind_single. s
|
|
|
|
|
|
z FilterableStatement._bind_singler1 ©Úclausesr c G s6 d| _ d t| ¡| _t| j| j ¡ | _d| _| S )zÑSets the sorting criteria.
|
|
Args:
|
*clauses: The expression strings defining the sort criteria.
|
|
Returns:
|
mysqlx.FilterableStatement: FilterableStatement object.
|
Tú,) r rB r/ r r rQ Zparse_order_specr
rV ©r! r r" r" r# Ú_sortH s ÿ
|
zFilterableStatement._sort©rx r c
|
C sh d| _ || _z t|| j }| ¡ | _W n, tk
|
rT } ztd|W 5 d}~X Y nX |j| _ d| _
|
| S )a Sets the search condition to filter.
|
|
Args:
|
condition (str): Sets the search condition to filter documents or
|
records.
|
|
Returns:
|
mysqlx.FilterableStatement: FilterableStatement object.
|
TzInvalid conditionN) r r r rQ r r r r Z placeholder_name_to_positionr{ rV )r! rx r r r" r" r# r Y s
|
z FilterableStatement._set_where©Úfieldsr c G s: t | }d| _d |¡| _t| j| j ¡ | _d| _dS )zJSet group by.
|
|
Args:
|
*fields: List of fields.
|
Tr N) r/ r rB r~ r rQ Zparse_expr_listr rV ©r! r¥ r" r" r# Ú _set_group_byn s ÿ
|
z!FilterableStatement._set_group_byc C s$ d| _ t|| j ¡ | _d| _dS )zOSet having.
|
|
Args:
|
condition (str): The condition.
|
TN)r r rQ r r} rV ©r! rx r" r" r# Ú _set_having| s z FilterableStatement._set_havingc G s: t | }d| _d |¡| _t| j| j ¡ | _d| _| S )z¡Set the projection.
|
|
Args:
|
*fields: List of fields.
|
|
Returns:
|
:class:`mysqlx.FilterableStatement`: Returns self.
|
Tr ) r/ r rB r r rQ Z parse_table_select_projectionr rV r¦ r" r" r# Ú_set_projection s ÿ
|
z#FilterableStatement._set_projectionúDict[str, Any]rZ c C s | j S ©zlReturns the binding map dictionary.
|
|
Returns:
|
dict: The binding map dictionary.
|
©r{ r[ r" r" r# Úget_binding_map s z#FilterableStatement.get_binding_mapzUnion[Dict[str, Any], List]c C s | j S ©z\Returns the bindings list.
|
|
Returns:
|
`list`: The bindings list.
|
©r| r[ r" r" r# Ú get_bindings s z FilterableStatement.get_bindingsz9List[Union[ProtobufMessageType, ProtobufMessageCextType]]c C s | j S )zrReturns the grouping expression list.
|
|
Returns:
|
`list`: The grouping expression list.
|
)r r[ r" r" r# Ú get_grouping¨ s z FilterableStatement.get_groupingr c C s | j S )zdReturns the having expression.
|
|
Returns:
|
object: The having expression.
|
)r} r[ r" r" r# Ú
|
get_having° s z FilterableStatement.get_havingr] c C s | j S )z]Returns the limit row count.
|
|
Returns:
|
int: The limit row count.
|
)r r[ r" r" r# Úget_limit_row_count¸ s z'FilterableStatement.get_limit_row_countc C s | j S )zWReturns the limit offset.
|
|
Returns:
|
int: The limit offset.
|
)r r[ r" r" r# Úget_limit_offsetÀ s z$FilterableStatement.get_limit_offsetc C s | j S )zbReturns the where expression.
|
|
Returns:
|
object: The where expression.
|
)r r[ r" r" r# Úget_where_exprÈ s z"FilterableStatement.get_where_exprc C s | j S )zlReturns the projection expression.
|
|
Returns:
|
object: The projection expression.
|
)r r[ r" r" r# Úget_projection_exprÐ s z'FilterableStatement.get_projection_exprc C s | j S )z`Returns the sort expression.
|
|
Returns:
|
object: The sort expression.
|
)r
r[ r" r" r# Ú get_sort_exprÚ s z!FilterableStatement.get_sort_exprú8.0.12c C s
|
| |¡S )a& Sets the search condition to filter.
|
|
Args:
|
condition (str): Sets the search condition to filter documents or
|
records.
|
|
Returns:
|
mysqlx.FilterableStatement: FilterableStatement object.
|
|
.. deprecated:: 8.0.12
|
©r r¨ r" r" r# Úwhereä s zFilterableStatement.wherec G s
|
| j | S )zñSets the sorting criteria.
|
|
Args:
|
*clauses: The expression strings defining the sort criteria.
|
|
Returns:
|
mysqlx.FilterableStatement: FilterableStatement object.
|
|
.. deprecated:: 8.0.12
|
©r¢ r¡ r" r" r# Úsortó s zFilterableStatement.sortz Optional[int])Ú row_countÚoffsetr c C sn t |tr|dk rtd| jsBt| jdk| _t| jdk | _|| _d| _|rj| |¡ t
|
j dt d | S )a Sets the maximum number of items to be returned.
|
|
Args:
|
row_count (int): The maximum number of items.
|
|
Returns:
|
mysqlx.FilterableStatement: FilterableStatement object.
|
|
Raises:
|
ValueError: If ``row_count`` is not a positive integer.
|
|
.. versionchanged:: 8.0.12
|
The usage of ``offset`` was deprecated.
|
r z0The 'row_count' value must be a positive integerTzh'limit(row_count, offset)' is deprecated, please use 'offset(offset)' to set the number of items to skip)Úcategory) r, r] r r r2 rU rV rX r r¿ ÚwarningsÚwarnÚDeprecationWarning)r! r¾ r¿ r" r" r# Úlimit s
|
üzFilterableStatement.limit)r¿ r c C s$ t |tr|dk rtd|| _| S )a: Sets the number of items to skip.
|
|
Args:
|
offset (int): The number of items to skip.
|
|
Returns:
|
mysqlx.FilterableStatement: FilterableStatement object.
|
|
Raises:
|
ValueError: If ``offset`` is not a positive integer.
|
|
.. versionadded:: 8.0.12
|
r z-The 'offset' value must be a positive integer)r, r] r r )r! r¿ r" r" r# r¿ $ s zFilterableStatement.offsetr ©Úargsr c G sN d| _ t|}|dkr&| |d ¡ n$|dkrB|d | j|d < ntd| S )a¨ Binds value(s) to a specific placeholder(s).
|
|
Args:
|
*args: The name of the placeholder and the value to bind.
|
A :class:`mysqlx.DbDoc` object or a JSON string
|
representation can be used.
|
|
Returns:
|
mysqlx.FilterableStatement: FilterableStatement object.
|
|
Raises:
|
ProgrammingError: If the number of arguments is invalid.
|
Tr
|
r é ú#Invalid number of arguments to bind)r r+ r r| r )r! rÆ Úcountr" r" r# r 7 s zFilterableStatement.bindc C s t dS ro rp r[ r" r" r# rr O s zFilterableStatement.execute)TN)N) r% r& r' r( r$ r r¢ r r§ r© rª r® r± r² r³ r´ rµ r¶ r· r¸ r r» r½ rÄ r¿ r rr Ú __classcell__r" r" r r# ru þ s8 ü$
|
|
|
ÿ#ru c sv e Zd ZdZdddd fdd Zeddd d
|
Zd dd d ZddddZdd dddZ ddddZ
|
Z S )Ú SqlStatementz¬A statement for SQL execution.
|
|
Args:
|
connection (mysqlx.connection.Connection): Connection object.
|
sql (string): The sql statement to be executed.
|
r r1 r )Ú
|
connectionÚsqlr c s8 t jd dd || _|| _d | _g | _d| _d| _d S ©NFry )rz r$ rS Ú_sqlr{ r| r r )r! rÌ rÍ r r" r# r$ ` s zSqlStatement.__init__rZ c C s | j S )z string: The SQL text statement.)rÏ r[ r" r" r# rÍ i s zSqlStatement.sqlr« c C s | j S r¬ r r[ r" r" r# r® n s z SqlStatement.get_binding_mapzUnion[Tuple, List]c C s | j S r¯ r° r[ r" r" r# r± v s zSqlStatement.get_bindingsr rÅ c G sH t |dkrtdd| _t| }t|ttfr8|| _n | j |¡ | S )zµBinds value(s) to a specific placeholder(s).
|
|
Args:
|
*args: The value(s) to bind.
|
|
Returns:
|
mysqlx.SqlStatement: SqlStatement object.
|
r rÈ T) r+ r r r/ r, r- r. r| Úappend)r! rÆ Zbindingsr" r" r# r ~ s zSqlStatement.bindr c C s | j | ¡S )zaExecute the statement.
|
|
Returns:
|
mysqlx.SqlResult: SqlResult object.
|
)rS Zsend_sqlr[ r" r" r# rr s zSqlStatement.execute) r% r& r' r( r$ rs rÍ r® r± r rr rÊ r" r" r r# rË X s rË c sF e Zd ZdZdddd fdd Zdd d
|
d Zd d d dZ ZS )ÚWriteStatementz*Provide common write operation attributes.r r2 r rM c s t ||¡ g | _d S r )rz r$ Ú_valuesrY r r" r# r$ s øzWriteStatement.__init__zpList[Union[int, str, DbDoc, Dict[str, Any], List[Optional[Union[str, int, float, ExprParser, Dict[str, Any]]]]]]rZ c C s | j S )z^Returns the list of values.
|
|
Returns:
|
`list`: The list of values.
|
)rÒ r[ r" r" r# Ú
|
get_values© s zWriteStatement.get_valuesr c C s t dS ro rp r[ r" r" r# rr » s zWriteStatement.execute)r% r& r' r( r$ rÓ rr rÊ r" r" r r# rÑ s rÑ c sf e Zd ZdZddd fdd Zddd d
|
Zddd d d dZdd dddZddddZ Z S )Ú AddStatementzA statement for document addition on a collection.
|
|
Args:
|
collection (mysqlx.Collection): The Collection object.
|
r r )Ú
|
collectionr c s t |d¡ d| _g | _d S )NTF)rz r$ Ú_upsertÚids)r! rÕ r r" r# r$ Ë s zAddStatement.__init__r2 rZ c C s | j S )zhReturns `True` if it's an upsert.
|
|
Returns:
|
bool: `True` if it's an upsert.
|
©rÖ r[ r" r" r# Ú is_upsertÐ s zAddStatement.is_upsertTr` c C s
|
|| _ | S )zÿSets 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.
|
rØ rb r" r" r# ÚupsertØ s zAddStatement.upsertr r) c G s: t | D ],}t|tr$| j |¡ q| j t|¡ q| S )zÏAdds a list of documents into a collection.
|
|
Args:
|
*values: The documents to be added into the collection.
|
|
Returns:
|
mysqlx.AddStatement: AddStatement object.
|
)r/ r, r rÒ rÐ )r! r* Úvalr" r" r# Úaddã s
|
|
zAddStatement.addr c C s t | jdkrt S | j | ¡S )ú[Execute the statement.
|
|
Returns:
|
mysqlx.Result: Result object.
|
r )r+ rÒ r rS Ú send_insertr[ r" r" r# rr ó s zAddStatement.execute)T)
|
r% r& r' r( r$ rÙ rÚ rÜ rr rÊ r" r" r r# rÔ Ä s rÔ c @ s8 e Zd ZdZd ddddddd Zdddd
|
d d ZdS )Ú
|
UpdateSpeczñUpdate specification class implementation.
|
|
Args:
|
update_type (int): The update type.
|
source (str): The source.
|
value (Optional[str]): The value.
|
|
Raises:
|
ProgrammingError: If `source` is invalid.
|
Nr] r1 r r )Ú update_typeÚsourcera r c
|
C sp |t dkr| ||¡ nR|| _zt|d ¡ j| _W n. tk
|
rd } zt| |W 5 d }~X Y nX || _ d S )Nú*Mysqlx.Crud.UpdateOperation.UpdateType.SETF)
|
r Ú
|
_table_setrà r Zdocument_fieldr3 rá r r ra )r! rà rá ra r r" r" r# r$ s zUpdateSpec.__init__)rá ra r c C s$ t d| _t|d ¡ | _|| _dS )zlTable set.
|
|
Args:
|
source (str): The source.
|
value (str): The value.
|
râ TN)r rà r Zparse_table_update_fieldrá ra )r! rá ra r" r" r# rã s
|
zUpdateSpec._table_set)N)r% r& r' r( r$ rã r" r" r" r# rß ÿ s rß c sÆ e Zd ZdZdddd fdd Zdd dd d
|
Zd d d dZddd dddZedddd dddZ dd dddZ
|
ddd dddZ ddd dd d Z d d d d d!Z d"d d#d$Z ZS )%ÚModifyStatementaU A 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.
|
r r1 r ©rÕ rx r c s t j||d i | _d S ©N)rN rx ©rz r$ Ú _update_ops©r! rÕ rx r r" r# r$ . s zModifyStatement.__init__r c G s
|
| j | S )zÉSets the sorting criteria.
|
|
Args:
|
*clauses: The expression strings defining the sort criteria.
|
|
Returns:
|
mysqlx.ModifyStatement: ModifyStatement object.
|
r¼ r¡ r" r" r# r½ 2 s zModifyStatement.sortr« rZ c C s | j S ©ztReturns the list of update operations.
|
|
Returns:
|
`list`: The list of update operations.
|
©rè r[ r" r" r# Úget_update_ops= s z ModifyStatement.get_update_opsr )Údoc_pathra r c C s t td||| j|< d| _| S )a2 Sets 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_SETT©rß r rè rV ©r! rí ra r" r" r# ÚsetE s
|
ý
|
zModifyStatement.setr¹ c C s t td||| j|< d| _| S )a Add 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_REPLACETrî rï r" r" r# ÚchangeW s ý
|
zModifyStatement.change)Ú doc_pathsr c G s, t | D ]}ttd|| j|< qd| _| S )a Removes 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)r/ rß r rè rV )r! rò Úitemr" r" r# Úunsetm s
|
þ zModifyStatement.unset©Úfieldra r c C s t td||| j|< d| _| S )a Insert 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_INSERTTrî ©r! rö ra r" r" r# Ú array_insert s ý
|
z ModifyStatement.array_insertc C s t td||| j|< d| _| S )aÀ Inserts 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_APPENDTrî rï r" r" r# Ú array_append s ý
|
z ModifyStatement.array_appendz#Union[Dict, DbDoc, ExprParser, str])Údocr c C sX |dkr d}t |ttttfs&tdttddt |trB| ¡ n|| j d< d| _
|
| S )a¢ Takes 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.
|
Nr0 z>Invalid data for update operation on document collection tablez2Mysqlx.Crud.UpdateOperation.UpdateType.MERGE_PATCHú$ÚpatchT) r, r r r r1 r rß r r rè rV )r! rú r" r" r# rü ¨ s ÿý
|
zModifyStatement.patchr c C s | j std| j | ¡S )ú¤Execute the statement.
|
|
Returns:
|
mysqlx.Result: Result object.
|
|
Raises:
|
ProgrammingError: If condition was not set.
|
z!No condition was found for modify©r r rS Z send_updater[ r" r" r# rr  s zModifyStatement.execute)r% r& r' r( r$ r½ rì rð r rñ rô rø rù rü rr rÊ r" r" r r# rä " s rä c sÆ e Zd ZdZd$ddddd fd d
|
Zed d d dZd ddddZdd ddZdd ddZ e
|
j fd d dddZ e
|
j fd d dddZ dd dd d Zdd d d d Zd!d d"d#Z ZS )%Ú ReadStatementaÅ Provide 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.
|
TNr r2 rv r rw c s( t |||¡ d| _d| _tj| _d S ©NF)rz r$ Ú_lock_exclusiveÚ _lock_sharedr ÚDEFAULTÚ_lock_contentionr r r" r# r$ Ü s zReadStatement.__init__r rZ c C s | j S )z::class:`mysqlx.LockContention`: The lock contention value.)r r[ r" r" r# Úlock_contentionç s z ReadStatement.lock_contention)r r c
|
C sF zt |j}W n, tk
|
r: } ztd|W 5 d}~X Y nX || _dS )zÖSet 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)r ra r r r )r! r Ú_r r" r" r# Ú_set_lock_contentionì s ÿþz"ReadStatement._set_lock_contentionc C s | j S )zrReturns `True` if is `EXCLUSIVE LOCK`.
|
|
Returns:
|
bool: `True` if is `EXCLUSIVE LOCK`.
|
)r r[ r" r" r# Úis_lock_exclusiveþ s z ReadStatement.is_lock_exclusivec C s | j S )zlReturns `True` if is `SHARED LOCK`.
|
|
Returns:
|
bool: `True` if is `SHARED LOCK`.
|
)r r[ r" r" r# Úis_lock_shared s z ReadStatement.is_lock_sharedc C s d| _ d| _| |¡ | S )zÅExecute a read operation with `SHARED LOCK`. Only one lock can be
|
active at a time.
|
|
Args:
|
lock_contention (:class:`mysqlx.LockContention`): Lock contention.
|
FT©r r r ©r! r r" r" r# Ú lock_shared s
|
zReadStatement.lock_sharedc C s d| _ d| _| |¡ | S )zÈExecute a read operation with `EXCLUSIVE LOCK`. Only one lock can be
|
active at a time.
|
|
Args:
|
lock_contention (:class:`mysqlx.LockContention`): Lock contention.
|
TFr
|
r r" r" r# Úlock_exclusive s
|
z ReadStatement.lock_exclusiver1 r¤ c G s | j | | S )zÜSets a grouping criteria for the resultset.
|
|
Args:
|
*fields: The string expressions identifying the grouping criteria.
|
|
Returns:
|
mysqlx.ReadStatement: ReadStatement object.
|
)r§ r¦ r" r" r# Úgroup_by* s
|
zReadStatement.group_byr£ c C s | |¡ | 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.
|
)r© r¨ r" r" r# Úhaving6 s
|
zReadStatement.havingzUnion[DocResult, RowResult]c C s | j | ¡S ©rÝ )rS Z send_findr[ r" r" r# rr D s zReadStatement.execute)TN)r% r& r' r( r$ rs r r r r r r r r r r rr rÊ r" r" r r# rÿ Ð s ü ÿÿ rÿ c sL e Zd ZdZddddd fdd Zd d d
|
d d Zd d d ddZ ZS )Ú FindStatementa¥ A 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.
|
Nr rv r rå c s t |d|¡ d S )NT©rz r$ ré r r" r# r$ X s zFindStatement.__init__r1 r¤ c G s
|
| j | S )zèSets a document field filter.
|
|
Args:
|
*fields: The string expressions identifying the fields to be
|
extracted.
|
|
Returns:
|
mysqlx.FindStatement: FindStatement object.
|
)rª r¦ r" r" r# r¥ ] s
|
zFindStatement.fieldsr c G s
|
| j | S ©zÅSets the sorting criteria.
|
|
Args:
|
*clauses: The expression strings defining the sort criteria.
|
|
Returns:
|
mysqlx.FindStatement: FindStatement object.
|
r¼ r¡ r" r" r# r½ i s zFindStatement.sort)N)r% r& r' r( r$ r¥ r½ rÊ r" r" r r# r M s
|
ÿ r c sX e Zd ZdZdddd fdd Zdd dd d
|
Zdd d d d ZddddZ ZS )ÚSelectStatementz¤A statement for record retrieval operations on a Table.
|
|
Args:
|
table (mysqlx.Table): The Table object.
|
*fields: The fields to be retrieved.
|
r r1 r ©Útabler¥ r c s t |d¡ | j| d S r )rz r$ rª ©r! r r¥ r r" r# r$ } s zSelectStatement.__init__r£ c C s
|
| |¡S )zÔSets the search condition to filter.
|
|
Args:
|
condition (str): Sets the search condition to filter records.
|
|
Returns:
|
mysqlx.SelectStatement: SelectStatement object.
|
rº r¨ r" r" r# r» s zSelectStatement.wherer c G s
|
| j | S )zÎSets the order by criteria.
|
|
Args:
|
*clauses: The expression strings defining the order by criteria.
|
|
Returns:
|
mysqlx.SelectStatement: SelectStatement object.
|
r¼ r¡ r" r" r# Úorder_by s zSelectStatement.order_byrZ c C s² | j rd| j nd}| jr(d| j nd}| jr>d| j nd}| jrTd| j nd}| jrrd| j d| j
|
nd}d| j pd d
|
| j j d | jj | | | | | }|S ) zYReturns the generated SQL.
|
|
Returns:
|
str: The generated SQL.
|
z WHERE r0 z
|
GROUP BY z HAVING z
|
ORDER BY z LIMIT z OFFSET zSELECT Ú*z FROM r> )r r r r~ r r} r r r r r r r\ ÚnamerN )r! r» r r r rÄ Zstmtr" r" r# Úget_sql s ÿý6ÿzSelectStatement.get_sql) r% r& r' r( r$ r» r r rÊ r" r" r r# r u s
|
r c sH e Zd ZdZdddd fdd Zdd dd d
|
Zd d d dZ ZS )ÚInsertStatementzA statement for insert operations on Table.
|
|
Args:
|
table (mysqlx.Table): The Table object.
|
*fields: The fields to be inserted.
|
r r r r c s t |d¡ t| | _d S r )rz r$ r/ Ú_fieldsr r r" r# r$ ¶ s zInsertStatement.__init__r) c G s | j tt| ¡ | S )zÃSet the values to be inserted.
|
|
Args:
|
*values: The values of the columns to be inserted.
|
|
Returns:
|
mysqlx.InsertStatement: InsertStatement object.
|
)rÒ rÐ r- r/ )r! r* r" r" r# r* º s zInsertStatement.valuesr rZ c C s | j | ¡S r )rS rÞ r[ r" r" r# rr Æ s zInsertStatement.execute)r% r& r' r( r$ r* rr rÊ r" r" r r# r ® s r c sv e Zd ZdZddd fdd Zdd dd d
|
Zdd d d d ZddddZddd dddZddddZ Z
|
S )ÚUpdateStatementzÃA statement for record update operations on a Table.
|
|
Args:
|
table (mysqlx.Table): The Table object.
|
|
.. versionchanged:: 8.0.12
|
The ``fields`` parameters were removed.
|
r r ©r r c s t j|dd i | _d S rÎ rç ©r! r r r" r# r$ Ù s zUpdateStatement.__init__r1 r£ c C s
|
| |¡S )zÔSets the search condition to filter.
|
|
Args:
|
condition (str): Sets the search condition to filter records.
|
|
Returns:
|
mysqlx.UpdateStatement: UpdateStatement object.
|
rº r¨ r" r" r# r» Ý s zUpdateStatement.wherer c G s
|
| j | S )zÎSets the order by criteria.
|
|
Args:
|
*clauses: The expression strings defining the order by criteria.
|
|
Returns:
|
mysqlx.UpdateStatement: UpdateStatement object.
|
r¼ r¡ r" r" r# r è s zUpdateStatement.order_byr« rZ c C s | j S rê rë r[ r" r" r# rì ó s z UpdateStatement.get_update_opsr rõ c C s t td||| j|< d| _| S )a Updates 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.
|
râ Trî r÷ r" r" r# rð û s
|
ý
|
zUpdateStatement.setr c C s | j std| j | ¡S )z£Execute the statement.
|
|
Returns:
|
mysqlx.Result: Result object
|
|
Raises:
|
ProgrammingError: If condition was not set.
|
z!No condition was found for updaterþ r[ r" r" r# rr s zUpdateStatement.execute) r% r& r' r( r$ r» r rì rð rr rÊ r" r" r r# r Ï s r c sH e Zd ZdZdddd fdd Zdd dd d
|
Zd d d dZ ZS )ÚRemoveStatementaE A 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.
|
r r1 r rå c s t j||d d S ræ r ré r r" r# r$ ' s zRemoveStatement.__init__r c G s
|
| j | S r r¼ r¡ r" r" r# r½ * s zRemoveStatement.sortr rZ c C s | j std| j | ¡S )rý z!No condition was found for remove©r r rS Z send_deleter[ r" r" r# rr 5 s zRemoveStatement.execute)r% r& r' r( r$ r½ rr rÊ r" r" r r# r! s r! c sV e Zd ZdZddd fdd Zdd dd d
|
Zdd d d d ZddddZ ZS )ÚDeleteStatementz¯A statement that drops a table.
|
|
Args:
|
table (mysqlx.Table): The Table object.
|
|
.. versionchanged:: 8.0.12
|
The ``condition`` parameter was removed.
|
r r r c s t j|dd d S rÎ r r r r" r# r$ M s zDeleteStatement.__init__r1 r£ c C s
|
| |¡S )zÔSets the search condition to filter.
|
|
Args:
|
condition (str): Sets the search condition to filter records.
|
|
Returns:
|
mysqlx.DeleteStatement: DeleteStatement object.
|
rº r¨ r" r" r# r» P s zDeleteStatement.wherer c G s
|
| j | S )zÎSets the order by criteria.
|
|
Args:
|
*clauses: The expression strings defining the order by criteria.
|
|
Returns:
|
mysqlx.DeleteStatement: DeleteStatement object.
|
r¼ r¡ r" r" r# r [ s zDeleteStatement.order_byr rZ c C s | j std| j | ¡S )rý z!No condition was found for deleter" r[ r" r" r# rr f s zDeleteStatement.execute) r% r& r' r( r$ r» r rr rÊ r" r" r r# r# C s
|
r# c s: e Zd ZdZddddd fdd Zd d
|
d d Z ZS ) Ú 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}
|
r r1 r« r )rÕ Ú
|
index_nameÚ
|
index_descr c s4 t j|d t |¡| _|| _| j dg ¡| _d S )N)rN r¥ )rz r$ ÚcopyÚdeepcopyÚ _index_descÚ _index_nameÚpopÚ _fields_desc)r! rÕ r% r& r r" r# r$ s z'CreateCollectionIndexStatement.__init__r rZ c
|
C sh | j dkrtt | j ¡z`t| j ¡ ¡ }t|trZ|d t dkrxtt | j ¡n |j
|
t dkrxtt | j ¡W n8 t t fk
|
r² } ztt | j ¡|W 5 d}~X Y nX | j sÊtd| j t| j tsÞtdi }| j |d< | jj|d< | jjj|d< d| jkr$| j d¡|d< nd |d< | j d
|
d ¡|d
|
< |d
|
rPtd g |d < | jrptd| j z| j D ]x}i }| d¡|d< | d¡|d< | dd ¡|d< | dd ¡|d< t|d tsØtdt|d tsðtd|d ¡ dkr|d std|d ¡ d kr<|d dkr<tdd|kr|d ¡ d¡srtd|d ¡ d | d¡|d< d |kr²|d ¡ dkr¤td | d ¡|d < d |krä|d ¡ dkrÖtd | d ¡|d < |d |¡ qzW n: tk
|
r2 } ztd!| d"| |W 5 d}~X Y nX | j D ]}|r:td#| q:| j d$d%d&|¡S )'rÝ NÚtypezMysqlx.Expr.Expr.Type.IDENTzCRequired member 'fields' not found in the given index description: z,Required member 'fields' must contain a listr rÕ r\ ZINDEXÚuniqueFz!Unique indexes are not supported.Ú
|
constraintzUnidentified fields: rö ÚmemberÚrequiredÚarrayz'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 collationZTEXTzCThe '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'zRequired inner member z not found in constraint: zUnidentified inner fields: ZmysqlxZcreate_collection_indexT) r* r ÚERR_INVALID_INDEX_NAMEÚformatr r Z get_messager, r r r- r ÚAttributeErrorr, r) r- rP r r\ r+ r r2 Ú TypeErrorÚupperÚ
|
startswithrÐ ÚKeyErrorrS Zexecute_nonquery)r! Z parsed_identr rÆ Z
|
field_descr/ r" r" r# rr s¶
|
|
|
ÿ
|
ÿ
|
ÿþ
|
ÿ
|
|
ÿ ÿ
|
ÿ
|
ÿ
|
ÿÿþ
|
ÿz&CreateCollectionIndexStatement.execute)r% r& r' r( r$ rr rÊ r" r" r r# r$ t s r$ )r0 )r0 )r0 )r0 )=r( Ú
|
__future__r r' r rÁ Útypingr r r r r r r Ú constantsr Zdbdocr Úerrorsr r r r Zhelpersr Zprotobufr Úresultr r r r Útypesr r r r r r r5 r r/ r9 r< rC rK rL ru rË rÑ rÔ rß rä rÿ r r r r r! r# r$ r" r" r" r# Ú<module> sN $ ÿj \B*;# /}(9!L(1
|
