Top Description Interfaces Classes Enums
[default module]

Package com.mysql.cj.xdevapi


Java classes for X DevAPI support.
Since
6.0

Interface Summary

Modifier and TypeInterface and Description
public interface
AddResult

A result from the collection.add() statement.

public interface
AddStatement

A statement adding documents to a collection.

public interface
Client

X DevAPI class encapsulating a Session pooling functionality.

public interface
Collection

Representation of a document collection.

public interface
Column

Represents individual column of RowResult

public interface
DatabaseObject

A client-side representation of X Plugin server object, e.g. table, collection, etc.

public interface
DbDoc

The object representation of a JSON document.

public interface
DeleteStatement

A statement to delete rows from a table.

public interface
DocResult

A sequence of documents retrieved from a find query.

public interface
FetchResult<
the type of element returned from the query (doc or row)
T
>

A set of elements from a query command.

public interface
FilterParams

Transforms X DevAPI filter parameters into X Protocol message entities.

public interface
FindStatement

A statement to find the set of documents according to the given specification.

public interface
InsertResult

A result from the table.insert() statement.

public interface
InsertStatement

A statement INSERTing new row(s) into a table.

public interface
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.

public interface
ModifyStatement

A statement representing a set of document modifications.

public interface
RemoveStatement

A statement requesting to remove a set of documents.

public interface
Result

Base result.

public interface
Row

A row element returned from a SELECT query.

public interface
RowResult

A result exposing a set of rows from a SELECT query.

public interface
Schema

A client-side representation of a database schema.

public interface
SelectStatement

A statement representing a SELECT query.

public interface
Session

X DevAPI introduces a new, high-level database connection concept that is called Session.

public interface
SqlResult

A result from a SQL statement which may have several sets of data following by a DML result.

public interface
SqlStatement

A statement representing a raw SQL command.

public interface
Statement<
statement type
STMT_T
,
result type
RES_T
>

A statement is a query or state-affecting command against a database that returns a result.

public interface
Table

A client-side representation of a database table.

public interface
UpdateStatement

A statement representing a set of row modifications.

public interface
Warning

A warning generated during statement execution.

Class Summary

Modifier and TypeClass and Description
public abstract class
AbstractDataResult<
Result entry type
T
>

Base class for data set results.

public abstract class
AbstractFilterParams

Abstract implementation of FilterParams.

public class
AddResultBuilder

Result builder producing an AddResult instance.

public class
AddResultImpl

A result from the collection.add() statement.

public class
public class
ClientFactory

ClientFactory is used for creation of Client instances.

public class
public class
public class
public class
CreateIndexParams

Internally-used object passing index creation parameters to XMessageBuilder.

public class
DatabaseObjectDescription

Represents the item of XPLUGIN_STMT_LIST_OBJECTS operation result.

public class
DbDocFactory

Create DbDoc objects from internal row representation.

public class
DbDocImpl

Represents a JSON object:

  {}
  or
  {key : value}
  or
  {key : value, key : value, ...}
public class
DbDocValueFactory

A ValueFactory implementation to create DbDocs.

public class
public class
public class
DocResultBuilder

Result builder producing a DocResult instance.

public class
DocResultImpl

A sequence of documents retrieved from a find query.

public class
Expression

A wrapper for expression strings.

public class
ExprParser

Expression parser for X protocol.

public class
ExprUnparser

Serializer utility for dealing with X Protocol expression trees.

public class
ExprUtil

Utilities to deal with Expr (and related) structures.

public abstract class
FilterableStatement<
statement interface
STMT_T
,
result interface
RES_T
>

Abstract class, common to several X DevAPI statement classes.

public class
public class
InsertParams

Helper class for collecting parameters for relational insert command.

public class
InsertResultBuilder

Result builder producing an InsertResult instance.

public class
InsertResultImpl

A result from a statement that doesn't return a set of rows.

public class
public class
JsonArray

Represents a JSON array.

public class
JsonNumber

Represents a JSON number.

public class
public class
JsonString

Represents a JSON string.

public class
public abstract class
PreparableStatement<
result interface
RES_T
>

Abstract class, common to all X DevAPI statement classes that can be prepared.

public class
public class
RowFactory

Create Row objects from internal row representation.

public class
public class
RowResultBuilder

Result builder producing a RowResult instance.

public class
RowResultImpl

RowResult implementation.

public class
SchemaImpl

Schema implementation.

public class
public class
SessionFactory

SessionFactory is used for creation of sessions.

public class
SessionImpl

Session implementation.

public class
SqlMultiResult

SqlResult representing a multiple result sets.

public class
SqlResultBuilder

Result builder producing a SqlResult instance.

public class
SqlSingleResult

SqlResult representing a single result set.

public class
public class
SqlUpdateResult

SqlResult for insert, update, delete and DDL statements.

public class
StreamingDocResultBuilder

Result builder producing a streaming DocResult instance.

public class
StreamingRowResultBuilder

Result builder producing a streaming RowResult instance.

public class
StreamingSqlResultBuilder

Result builder producing a streaming SqlResult instance.

public class
TableFilterParams

FilterParams implementation for Table syntax.

public class
TableImpl

Table implementation

public class
UpdateParams

Class collecting parameters for Table#update().

public class
UpdateResult

A result from a statement that doesn't return a set of rows.

public class
UpdateResultBuilder<T extends Result>

Result builder producing an UpdateResult instance.

public class
UpdateSpec

Representation of a single update operation in a list of operations to be performed by ModifyStatement.

public class
public class
public class
XDevAPIError

An Error returned from X DevAPI.

Enum Summary

Modifier and TypeEnum and Description
public enum
JsonLiteral

Represents JSON true, false and null literals.

public enum
Type

Column type.

public enum
UpdateType

Update operation type.