Package com.mysql.cj.xdevapi

Java classes for X DevAPI support.

Since:

6.0

Interface Summary

Interface	Description
AddResult	A result from the collection.add() statement.
AddStatement	A statement adding documents to a collection.
Client	X DevAPI class encapsulating a Session pooling functionality.
Collection	Representation of a document collection.
Column	Represents individual column of RowResult
DatabaseObject	A client-side representation of X Plugin server object, e.g.
DbDoc	The object representation of a JSON document.
DeleteStatement	A statement to delete rows from a table.
DocResult	A sequence of documents retrieved from a find query.
FetchResult<T>	A set of elements from a query command.
FilterParams	Transforms X DevAPI filter parameters into X Protocol message entities.
FindStatement	A statement to find the set of documents according to the given specification.
InsertResult	A result from the table.insert() statement.
InsertStatement	A statement INSERTing new row(s) into a table.
JsonValue	Common interface for classes representing standard JSON object, array, number, string and 'true', 'false' and 'null' literals and non-standard extensions like mysqlx.expr() expressions.
ModifyStatement	A statement representing a set of document modifications.
RemoveStatement	A statement requesting to remove a set of documents.
Result	Base result.
Row	A row element returned from a SELECT query.
RowResult	A result exposing a set of rows from a SELECT query.
Schema	A client-side representation of a database schema.
SelectStatement	A statement representing a SELECT query.
Session	X DevAPI introduces a new, high-level database connection concept that is called Session.
SqlResult	A result from a SQL statement which may have several sets of data following by a DML result.
SqlStatement	A statement representing a raw SQL command.
Statement<STMT_T,RES_T>	A statement is a query or state-affecting command against a database that returns a result.
Table	A client-side representation of a database table.
UpdateStatement	A statement representing a set of row modifications.
Warning	A warning generated during statement execution.

Class Summary

Class	Description
AbstractDataResult<T>	Base class for data set results.
AbstractFilterParams	Abstract implementation of FilterParams.
AddResultBuilder	Result builder producing an AddResult instance.
AddResultImpl	A result from the collection.add() statement.
AddStatementImpl
ClientFactory	ClientFactory is used for creation of Client instances.
ClientImpl
CollectionImpl
ColumnImpl
CreateIndexParams	Internally-used object passing index creation parameters to XMessageBuilder.
CreateIndexParams.IndexField	Internally used object parsed from indexDefinition; see Collection.createIndex(String, DbDoc) description.
DatabaseObjectDescription	Represents the item of XPLUGIN_STMT_LIST_OBJECTS operation result.
DbDocFactory	Create DbDoc objects from internal row representation.
DbDocImpl	Represents a JSON object:
DbDocValueFactory	A ValueFactory implementation to create DbDocs.
DeleteStatementImpl	DeleteStatement implementation.
DocFilterParams	FilterParams implementation for Collection syntax.
DocResultBuilder	Result builder producing a DocResult instance.
DocResultImpl	A sequence of documents retrieved from a find query.
Expression	A wrapper for expression strings.
ExprParser	Expression parser for X protocol.
ExprUnparser	Serializer utility for dealing with X Protocol expression trees.
ExprUtil	Utilities to deal with Expr (and related) structures.
FilterableStatement<STMT_T,RES_T>	Abstract class, common to several X DevAPI statement classes.
FindStatementImpl	FindStatement implementation.
InsertParams	Helper class for collecting parameters for relational insert command.
InsertResultBuilder	Result builder producing an InsertResult instance.
InsertResultImpl	A result from a statement that doesn't return a set of rows.
InsertStatementImpl
JsonArray	Represents a JSON array.
JsonNumber	Represents a JSON number.
JsonParser
JsonString	Represents a JSON string.
ModifyStatementImpl	ModifyStatement implementation.
PreparableStatement<RES_T>	Abstract class, common to all X DevAPI statement classes that can be prepared.
PreparableStatement.PreparableStatementFinalizer	PhantomReference to track prepared statement ids.
RemoveStatementImpl	RemoveStatement implementation.
RowFactory	Create Row objects from internal row representation.
RowImpl	Row implementation.
RowResultBuilder	Result builder producing a RowResult instance.
RowResultImpl	RowResult implementation.
Schema.CreateCollectionOptions	Defines options to be passed to Schema.createCollection(String, CreateCollectionOptions).
Schema.ModifyCollectionOptions	Defines options to be passed to Schema.modifyCollection(String, ModifyCollectionOptions).
Schema.Validation	Validation options to be passed to Schema.createCollection(String, CreateCollectionOptions) or Schema.modifyCollection(String, ModifyCollectionOptions).
SchemaImpl	Schema implementation.
SelectStatementImpl	SelectStatement implementation.
SessionFactory	SessionFactory is used for creation of sessions.
SessionImpl	Session implementation.
SqlMultiResult	SqlResult representing a multiple result sets.
SqlResultBuilder	Result builder producing a SqlResult instance.
SqlSingleResult	SqlResult representing a single result set.
SqlStatementImpl	SqlStatement implementation.
SqlUpdateResult	SqlResult for insert, update, delete and DDL statements.
StreamingDocResultBuilder	Result builder producing a streaming DocResult instance.
StreamingRowResultBuilder	Result builder producing a streaming RowResult instance.
StreamingSqlResultBuilder	Result builder producing a streaming SqlResult instance.
TableFilterParams	FilterParams implementation for Table syntax.
TableImpl	Table implementation
UpdateParams	Class collecting parameters for Table.update().
UpdateResult	A result from a statement that doesn't return a set of rows.
UpdateResultBuilder<T extends Result>	Result builder producing an UpdateResult instance.
UpdateSpec	Representation of a single update operation in a list of operations to be performed by ModifyStatement.
UpdateStatementImpl	UpdateStatement implementation.
WarningImpl	Warning implementation

Enum Summary

Enum	Description
Client.ClientProperty
DatabaseObject.DbObjectStatus	Existence states of database objects.
DatabaseObject.DbObjectType	Type of database objects.
FilterParams.RowLock	The type of row lock.
FilterParams.RowLockOptions	Options that define the behavior while retrieving locked rows.
JsonLiteral	Represents JSON true, false and null literals.
PreparableStatement.PreparedState
Schema.Validation.ValidationLevel	Defines how validation options are applied.
Statement.LockContention	The lock contention options for the locking modes available.
Type	Column type.
UpdateType	Update operation type.

Exception Summary

Exception	Description
XDevAPIError	An Error returned from X DevAPI.