mysqlx.AddStatement

class mysqlx.AddStatement(collection)

Bases: WriteStatement

A statement for document addition on a collection.

Parameters:

collection (mysqlx.Collection) – The Collection object.

add(*values)

Adds a list of documents into a collection.

Parameters:

*values – The documents to be added into the collection.

Returns:

AddStatement object.

Return type:

mysqlx.AddStatement

property changed

True if this statement has changes.

Type:

bool

property deallocate_prepare_execute

True to deallocate + prepare + execute statement.

Type:

bool

property exec_counter

The number of times this statement was executed.

Type:

int

execute()

Execute the statement.

Returns:

Result object.

Return type:

mysqlx.Result

get_values()

Returns the list of values.

Returns:

The list of values.

Return type:

list

increment_exec_counter()

Increments the number of times this statement has been executed.

is_doc_based()

Check if it is document based.

Returns:

True if it is document based.

Return type:

bool

is_upsert()

Returns True if it’s an upsert.

Returns:

True if it’s an upsert.

Return type:

bool

property prepared

True if this statement has been prepared.

Type:

bool

property repeated

True if this statement was executed more than once.

Type:

bool

reset_exec_counter()

Resets the number of times this statement has been executed.

property schema

The Schema object.

Type:

mysqlx.Schema

property stmt_id

Returns this statement ID.

Returns:

The statement ID.

Return type:

int

property target

The database object target.

Type:

object

upsert(value=True)

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.

Parameters:

value (optional[bool]) – Set or unset the upsert flag.