Reference

Connection

• mysqlx.get_client
  • get_client()
• mysqlx.get_session
  • get_session()
• mysqlx.Client
  • Client
    • Client.close()
    • Client.get_session()
• mysqlx.Session
  • Session
    • Session.close()
    • Session.close_connections()
    • Session.commit()
    • Session.create_schema()
    • Session.drop_schema()
    • Session.get_connection()
    • Session.get_default_schema()
    • Session.get_schema()
    • Session.get_schemas()
    • Session.is_open()
    • Session.release_savepoint()
    • Session.rollback()
    • Session.rollback_to()
    • Session.set_savepoint()
    • Session.sql()
    • Session.start_transaction()
    • Session.use_pure

CRUD

• mysqlx.Schema
  • Schema
    • Schema.am_i_real()
    • Schema.create_collection()
    • Schema.drop_collection()
    • Schema.exists_in_database()
    • Schema.get_collection()
    • Schema.get_collection_as_table()
    • Schema.get_collections()
    • Schema.get_connection()
    • Schema.get_name()
    • Schema.get_schema()
    • Schema.get_session()
    • Schema.get_table()
    • Schema.get_tables()
    • Schema.get_view()
    • Schema.modify_collection()
    • Schema.name
    • Schema.schema
    • Schema.session
    • Schema.who_am_i()
• mysqlx.Collection
  • Collection
    • Collection.add()
    • Collection.add_or_replace_one()
    • Collection.am_i_real()
    • Collection.count()
    • Collection.create_index()
    • Collection.drop_index()
    • Collection.exists_in_database()
    • Collection.find()
    • Collection.get_connection()
    • Collection.get_name()
    • Collection.get_one()
    • Collection.get_schema()
    • Collection.get_session()
    • Collection.modify()
    • Collection.name
    • Collection.remove()
    • Collection.remove_one()
    • Collection.replace_one()
    • Collection.schema
    • Collection.session
    • Collection.who_am_i()
• mysqlx.Table
  • Table
    • Table.am_i_real()
    • Table.count()
    • Table.delete()
    • Table.exists_in_database()
    • Table.get_connection()
    • Table.get_name()
    • Table.get_schema()
    • Table.get_session()
    • Table.insert()
    • Table.is_view()
    • Table.name
    • Table.schema
    • Table.select()
    • Table.session
    • Table.update()
    • Table.who_am_i()
• mysqlx.View
  • View
    • View.am_i_real()
    • View.count()
    • View.delete()
    • View.exists_in_database()
    • View.get_connection()
    • View.get_name()
    • View.get_schema()
    • View.get_session()
    • View.insert()
    • View.is_view()
    • View.name
    • View.schema
    • View.select()
    • View.session
    • View.update()
    • View.who_am_i()
• mysqlx.expr
  • expr()

Result

• mysqlx.Column
  • Column
    • Column.character_set_name
    • Column.collation_name
    • Column.column_label
    • Column.column_name
    • Column.fractional_digits
    • Column.get_character_set_name()
    • Column.get_collation_name()
    • Column.get_column_label()
    • Column.get_column_name()
    • Column.get_fractional_digits()
    • Column.get_length()
    • Column.get_proto_type()
    • Column.get_schema_name()
    • Column.get_table_label()
    • Column.get_table_name()
    • Column.get_type()
    • Column.is_bytes()
    • Column.is_number_signed()
    • Column.is_padded()
    • Column.length
    • Column.schema_name
    • Column.table_label
    • Column.table_name
    • Column.type
• mysqlx.Row
  • Row
    • Row.get_string()
• mysqlx.Result
  • Result
    • Result.append_warning()
    • Result.get_affected_items_count()
    • Result.get_autoincrement_value()
    • Result.get_document_id()
    • Result.get_generated_ids()
    • Result.get_generated_insert_id()
    • Result.get_warnings()
    • Result.get_warnings_count()
    • Result.set_closed()
    • Result.set_generated_ids()
    • Result.set_generated_insert_id()
    • Result.set_rows_affected()
• mysqlx.BufferingResult
  • BufferingResult
    • BufferingResult.append_warning()
    • BufferingResult.count
    • BufferingResult.fetch_all()
    • BufferingResult.fetch_one()
    • BufferingResult.get_affected_items_count()
    • BufferingResult.get_warnings()
    • BufferingResult.get_warnings_count()
    • BufferingResult.index_of()
    • BufferingResult.set_closed()
    • BufferingResult.set_generated_ids()
    • BufferingResult.set_generated_insert_id()
    • BufferingResult.set_has_data()
    • BufferingResult.set_has_more_results()
    • BufferingResult.set_rows_affected()
• mysqlx.RowResult
  • RowResult
    • RowResult.append_warning()
    • RowResult.columns
    • RowResult.count
    • RowResult.fetch_all()
    • RowResult.fetch_one()
    • RowResult.get_affected_items_count()
    • RowResult.get_columns()
    • RowResult.get_warnings()
    • RowResult.get_warnings_count()
    • RowResult.index_of()
    • RowResult.set_closed()
    • RowResult.set_generated_ids()
    • RowResult.set_generated_insert_id()
    • RowResult.set_has_data()
    • RowResult.set_has_more_results()
    • RowResult.set_rows_affected()
• mysqlx.SqlResult
  • SqlResult
    • SqlResult.append_warning()
    • SqlResult.columns
    • SqlResult.count
    • SqlResult.fetch_all()
    • SqlResult.fetch_one()
    • SqlResult.get_affected_items_count()
    • SqlResult.get_autoincrement_value()
    • SqlResult.get_columns()
    • SqlResult.get_warnings()
    • SqlResult.get_warnings_count()
    • SqlResult.has_data()
    • SqlResult.index_of()
    • SqlResult.next_result()
    • SqlResult.set_closed()
    • SqlResult.set_generated_ids()
    • SqlResult.set_generated_insert_id()
    • SqlResult.set_has_data()
    • SqlResult.set_has_more_results()
    • SqlResult.set_rows_affected()

Statement

• mysqlx.DbDoc
  • DbDoc
    • DbDoc.as_str()
    • DbDoc.copy()
    • DbDoc.keys()
• mysqlx.Statement
  • Statement
    • Statement.changed
    • Statement.deallocate_prepare_execute
    • Statement.exec_counter
    • Statement.execute()
    • Statement.increment_exec_counter()
    • Statement.is_doc_based()
    • Statement.prepared
    • Statement.repeated
    • Statement.reset_exec_counter()
    • Statement.schema
    • Statement.stmt_id
    • Statement.target
• mysqlx.FilterableStatement
  • FilterableStatement
    • FilterableStatement.bind()
    • FilterableStatement.changed
    • FilterableStatement.deallocate_prepare_execute
    • FilterableStatement.exec_counter
    • FilterableStatement.execute()
    • FilterableStatement.get_binding_map()
    • FilterableStatement.get_bindings()
    • FilterableStatement.get_grouping()
    • FilterableStatement.get_having()
    • FilterableStatement.get_limit_offset()
    • FilterableStatement.get_limit_row_count()
    • FilterableStatement.get_projection_expr()
    • FilterableStatement.get_sort_expr()
    • FilterableStatement.get_where_expr()
    • FilterableStatement.increment_exec_counter()
    • FilterableStatement.is_doc_based()
    • FilterableStatement.limit()
    • FilterableStatement.offset()
    • FilterableStatement.prepared
    • FilterableStatement.repeated
    • FilterableStatement.reset_exec_counter()
    • FilterableStatement.schema
    • FilterableStatement.sort()
    • FilterableStatement.stmt_id
    • FilterableStatement.target
    • FilterableStatement.where()
• mysqlx.SqlStatement
  • SqlStatement
    • SqlStatement.bind()
    • SqlStatement.changed
    • SqlStatement.deallocate_prepare_execute
    • SqlStatement.exec_counter
    • SqlStatement.execute()
    • SqlStatement.get_binding_map()
    • SqlStatement.get_bindings()
    • SqlStatement.increment_exec_counter()
    • SqlStatement.is_doc_based()
    • SqlStatement.prepared
    • SqlStatement.repeated
    • SqlStatement.reset_exec_counter()
    • SqlStatement.schema
    • SqlStatement.sql
    • SqlStatement.stmt_id
    • SqlStatement.target
• mysqlx.FindStatement
  • FindStatement
    • FindStatement.bind()
    • FindStatement.changed
    • FindStatement.deallocate_prepare_execute
    • FindStatement.exec_counter
    • FindStatement.execute()
    • FindStatement.fields()
    • FindStatement.get_binding_map()
    • FindStatement.get_bindings()
    • FindStatement.get_grouping()
    • FindStatement.get_having()
    • FindStatement.get_limit_offset()
    • FindStatement.get_limit_row_count()
    • FindStatement.get_projection_expr()
    • FindStatement.get_sort_expr()
    • FindStatement.get_where_expr()
    • FindStatement.group_by()
    • FindStatement.having()
    • FindStatement.increment_exec_counter()
    • FindStatement.is_doc_based()
    • FindStatement.is_lock_exclusive()
    • FindStatement.is_lock_shared()
    • FindStatement.limit()
    • FindStatement.lock_contention
    • FindStatement.lock_exclusive()
    • FindStatement.lock_shared()
    • FindStatement.offset()
    • FindStatement.prepared
    • FindStatement.repeated
    • FindStatement.reset_exec_counter()
    • FindStatement.schema
    • FindStatement.sort()
    • FindStatement.stmt_id
    • FindStatement.target
    • FindStatement.where()
• mysqlx.AddStatement
  • AddStatement
    • AddStatement.add()
    • AddStatement.changed
    • AddStatement.deallocate_prepare_execute
    • AddStatement.exec_counter
    • AddStatement.execute()
    • AddStatement.get_values()
    • AddStatement.increment_exec_counter()
    • AddStatement.is_doc_based()
    • AddStatement.is_upsert()
    • AddStatement.prepared
    • AddStatement.repeated
    • AddStatement.reset_exec_counter()
    • AddStatement.schema
    • AddStatement.stmt_id
    • AddStatement.target
    • AddStatement.upsert()
• mysqlx.RemoveStatement
  • RemoveStatement
    • RemoveStatement.bind()
    • RemoveStatement.changed
    • RemoveStatement.deallocate_prepare_execute
    • RemoveStatement.exec_counter
    • RemoveStatement.execute()
    • RemoveStatement.get_binding_map()
    • RemoveStatement.get_bindings()
    • RemoveStatement.get_grouping()
    • RemoveStatement.get_having()
    • RemoveStatement.get_limit_offset()
    • RemoveStatement.get_limit_row_count()
    • RemoveStatement.get_projection_expr()
    • RemoveStatement.get_sort_expr()
    • RemoveStatement.get_where_expr()
    • RemoveStatement.increment_exec_counter()
    • RemoveStatement.is_doc_based()
    • RemoveStatement.limit()
    • RemoveStatement.offset()
    • RemoveStatement.prepared
    • RemoveStatement.repeated
    • RemoveStatement.reset_exec_counter()
    • RemoveStatement.schema
    • RemoveStatement.sort()
    • RemoveStatement.stmt_id
    • RemoveStatement.target
    • RemoveStatement.where()
• mysqlx.ModifyStatement
  • ModifyStatement
    • ModifyStatement.array_append()
    • ModifyStatement.array_insert()
    • ModifyStatement.bind()
    • ModifyStatement.change()
    • ModifyStatement.changed
    • ModifyStatement.deallocate_prepare_execute
    • ModifyStatement.exec_counter
    • ModifyStatement.execute()
    • ModifyStatement.get_binding_map()
    • ModifyStatement.get_bindings()
    • ModifyStatement.get_grouping()
    • ModifyStatement.get_having()
    • ModifyStatement.get_limit_offset()
    • ModifyStatement.get_limit_row_count()
    • ModifyStatement.get_projection_expr()
    • ModifyStatement.get_sort_expr()
    • ModifyStatement.get_update_ops()
    • ModifyStatement.get_where_expr()
    • ModifyStatement.increment_exec_counter()
    • ModifyStatement.is_doc_based()
    • ModifyStatement.limit()
    • ModifyStatement.offset()
    • ModifyStatement.patch()
    • ModifyStatement.prepared
    • ModifyStatement.repeated
    • ModifyStatement.reset_exec_counter()
    • ModifyStatement.schema
    • ModifyStatement.set()
    • ModifyStatement.sort()
    • ModifyStatement.stmt_id
    • ModifyStatement.target
    • ModifyStatement.unset()
    • ModifyStatement.where()
• mysqlx.SelectStatement
  • SelectStatement
    • SelectStatement.bind()
    • SelectStatement.changed
    • SelectStatement.deallocate_prepare_execute
    • SelectStatement.exec_counter
    • SelectStatement.execute()
    • SelectStatement.get_binding_map()
    • SelectStatement.get_bindings()
    • SelectStatement.get_grouping()
    • SelectStatement.get_having()
    • SelectStatement.get_limit_offset()
    • SelectStatement.get_limit_row_count()
    • SelectStatement.get_projection_expr()
    • SelectStatement.get_sort_expr()
    • SelectStatement.get_sql()
    • SelectStatement.get_where_expr()
    • SelectStatement.group_by()
    • SelectStatement.having()
    • SelectStatement.increment_exec_counter()
    • SelectStatement.is_doc_based()
    • SelectStatement.is_lock_exclusive()
    • SelectStatement.is_lock_shared()
    • SelectStatement.limit()
    • SelectStatement.lock_contention
    • SelectStatement.lock_exclusive()
    • SelectStatement.lock_shared()
    • SelectStatement.offset()
    • SelectStatement.order_by()
    • SelectStatement.prepared
    • SelectStatement.repeated
    • SelectStatement.reset_exec_counter()
    • SelectStatement.schema
    • SelectStatement.sort()
    • SelectStatement.stmt_id
    • SelectStatement.target
    • SelectStatement.where()
• mysqlx.InsertStatement
  • InsertStatement
    • InsertStatement.changed
    • InsertStatement.deallocate_prepare_execute
    • InsertStatement.exec_counter
    • InsertStatement.execute()
    • InsertStatement.get_values()
    • InsertStatement.increment_exec_counter()
    • InsertStatement.is_doc_based()
    • InsertStatement.prepared
    • InsertStatement.repeated
    • InsertStatement.reset_exec_counter()
    • InsertStatement.schema
    • InsertStatement.stmt_id
    • InsertStatement.target
    • InsertStatement.values()
• mysqlx.DeleteStatement
  • DeleteStatement
    • DeleteStatement.bind()
    • DeleteStatement.changed
    • DeleteStatement.deallocate_prepare_execute
    • DeleteStatement.exec_counter
    • DeleteStatement.execute()
    • DeleteStatement.get_binding_map()
    • DeleteStatement.get_bindings()
    • DeleteStatement.get_grouping()
    • DeleteStatement.get_having()
    • DeleteStatement.get_limit_offset()
    • DeleteStatement.get_limit_row_count()
    • DeleteStatement.get_projection_expr()
    • DeleteStatement.get_sort_expr()
    • DeleteStatement.get_where_expr()
    • DeleteStatement.increment_exec_counter()
    • DeleteStatement.is_doc_based()
    • DeleteStatement.limit()
    • DeleteStatement.offset()
    • DeleteStatement.order_by()
    • DeleteStatement.prepared
    • DeleteStatement.repeated
    • DeleteStatement.reset_exec_counter()
    • DeleteStatement.schema
    • DeleteStatement.sort()
    • DeleteStatement.stmt_id
    • DeleteStatement.target
    • DeleteStatement.where()
• mysqlx.UpdateStatement
  • UpdateStatement
    • UpdateStatement.bind()
    • UpdateStatement.changed
    • UpdateStatement.deallocate_prepare_execute
    • UpdateStatement.exec_counter
    • UpdateStatement.execute()
    • UpdateStatement.get_binding_map()
    • UpdateStatement.get_bindings()
    • UpdateStatement.get_grouping()
    • UpdateStatement.get_having()
    • UpdateStatement.get_limit_offset()
    • UpdateStatement.get_limit_row_count()
    • UpdateStatement.get_projection_expr()
    • UpdateStatement.get_sort_expr()
    • UpdateStatement.get_update_ops()
    • UpdateStatement.get_where_expr()
    • UpdateStatement.increment_exec_counter()
    • UpdateStatement.is_doc_based()
    • UpdateStatement.limit()
    • UpdateStatement.offset()
    • UpdateStatement.order_by()
    • UpdateStatement.prepared
    • UpdateStatement.repeated
    • UpdateStatement.reset_exec_counter()
    • UpdateStatement.schema
    • UpdateStatement.set()
    • UpdateStatement.sort()
    • UpdateStatement.stmt_id
    • UpdateStatement.target
    • UpdateStatement.where()
• mysqlx.CreateCollectionIndexStatement
  • CreateCollectionIndexStatement
    • CreateCollectionIndexStatement.changed
    • CreateCollectionIndexStatement.deallocate_prepare_execute
    • CreateCollectionIndexStatement.exec_counter
    • CreateCollectionIndexStatement.execute()
    • CreateCollectionIndexStatement.increment_exec_counter()
    • CreateCollectionIndexStatement.is_doc_based()
    • CreateCollectionIndexStatement.prepared
    • CreateCollectionIndexStatement.repeated
    • CreateCollectionIndexStatement.reset_exec_counter()
    • CreateCollectionIndexStatement.schema
    • CreateCollectionIndexStatement.stmt_id
    • CreateCollectionIndexStatement.target
• mysqlx.ReadStatement
  • ReadStatement
    • ReadStatement.bind()
    • ReadStatement.changed
    • ReadStatement.deallocate_prepare_execute
    • ReadStatement.exec_counter
    • ReadStatement.execute()
    • ReadStatement.get_binding_map()
    • ReadStatement.get_bindings()
    • ReadStatement.get_grouping()
    • ReadStatement.get_having()
    • ReadStatement.get_limit_offset()
    • ReadStatement.get_limit_row_count()
    • ReadStatement.get_projection_expr()
    • ReadStatement.get_sort_expr()
    • ReadStatement.get_where_expr()
    • ReadStatement.group_by()
    • ReadStatement.having()
    • ReadStatement.increment_exec_counter()
    • ReadStatement.is_doc_based()
    • ReadStatement.is_lock_exclusive()
    • ReadStatement.is_lock_shared()
    • ReadStatement.limit()
    • ReadStatement.lock_contention
    • ReadStatement.lock_exclusive()
    • ReadStatement.lock_shared()
    • ReadStatement.offset()
    • ReadStatement.prepared
    • ReadStatement.repeated
    • ReadStatement.reset_exec_counter()
    • ReadStatement.schema
    • ReadStatement.sort()
    • ReadStatement.stmt_id
    • ReadStatement.target
    • ReadStatement.where()
• mysqlx.WriteStatement
  • WriteStatement
    • WriteStatement.changed
    • WriteStatement.deallocate_prepare_execute
    • WriteStatement.exec_counter
    • WriteStatement.execute()
    • WriteStatement.get_values()
    • WriteStatement.increment_exec_counter()
    • WriteStatement.is_doc_based()
    • WriteStatement.prepared
    • WriteStatement.repeated
    • WriteStatement.reset_exec_counter()
    • WriteStatement.schema
    • WriteStatement.stmt_id
    • WriteStatement.target

Errors

• mysqlx.DataError
  • DataError
    • DataError.add_note()
    • DataError.args
    • DataError.with_traceback()
• mysqlx.DatabaseError
  • DatabaseError
    • DatabaseError.add_note()
    • DatabaseError.args
    • DatabaseError.with_traceback()
• mysqlx.Error
  • Error
    • Error.add_note()
    • Error.args
    • Error.with_traceback()
• mysqlx.IntegrityError
  • IntegrityError
    • IntegrityError.add_note()
    • IntegrityError.args
    • IntegrityError.with_traceback()
• mysqlx.InterfaceError
  • InterfaceError
    • InterfaceError.add_note()
    • InterfaceError.args
    • InterfaceError.with_traceback()
• mysqlx.InternalError
  • InternalError
    • InternalError.add_note()
    • InternalError.args
    • InternalError.with_traceback()
• mysqlx.NotSupportedError
  • NotSupportedError
    • NotSupportedError.add_note()
    • NotSupportedError.args
    • NotSupportedError.with_traceback()
• mysqlx.OperationalError
  • OperationalError
    • OperationalError.add_note()
    • OperationalError.args
    • OperationalError.with_traceback()
• mysqlx.PoolError
  • PoolError
    • PoolError.add_note()
    • PoolError.args
    • PoolError.with_traceback()
• mysqlx.ProgrammingError
  • ProgrammingError
    • ProgrammingError.add_note()
    • ProgrammingError.args
    • ProgrammingError.with_traceback()
• mysqlx.TimeoutError
  • TimeoutError
    • TimeoutError.add_note()
    • TimeoutError.args
    • TimeoutError.with_traceback()