mysqlx.Statement

class mysqlx.Statement(target: DatabaseObject, doc_based: bool = True)

Bases: object

Provides base functionality for statement objects.

Parameters:
  • target (object) – The target database object, it can be mysqlx.Collection or mysqlx.Table.

  • doc_based (bool) – True if it is document based.

property changed: bool

True if this statement has changes.

Type:

bool

property deallocate_prepare_execute: bool

True to deallocate + prepare + execute statement.

Type:

bool

property exec_counter: int

The number of times this statement was executed.

Type:

int

execute() Any

Execute the statement.

Raises:

NotImplementedError – This method must be implemented.

increment_exec_counter() None

Increments the number of times this statement has been executed.

is_doc_based() bool

Check if it is document based.

Returns:

True if it is document based.

Return type:

bool

property prepared: bool

True if this statement has been prepared.

Type:

bool

property repeated: bool

True if this statement was executed more than once.

Type:

bool

reset_exec_counter() None

Resets the number of times this statement has been executed.

property schema: Schema

The Schema object.

Type:

mysqlx.Schema

property stmt_id: int

Returns this statement ID.

Returns:

The statement ID.

Return type:

int

property target: DatabaseObject

The database object target.

Type:

object