Skip navigation links
MySQL Connector/J X DevAPI Reference
v8.3.0-SNAPSHOT
A B C D E F G H I J K L M N O P R S T U V W X 

A

add(String) - Method in interface com.mysql.cj.xdevapi.AddStatement
Add a document as a JSON string.
add(DbDoc...) - Method in interface com.mysql.cj.xdevapi.AddStatement
Add a sequence of DbDocs.
add(Map<String, ?>) - Method in interface com.mysql.cj.xdevapi.Collection
Add a document in the form of a Map.
add(String...) - Method in interface com.mysql.cj.xdevapi.Collection
Add one or more documents.
add(DbDoc) - Method in interface com.mysql.cj.xdevapi.Collection
Add a document in the form of a DbDoc.
add(DbDoc...) - Method in interface com.mysql.cj.xdevapi.Collection
Add a sequence of documents.
add(String, JsonValue) - Method in interface com.mysql.cj.xdevapi.DbDoc
Add JsonValue to the top-level document hierarchy.
addArg(String, Object) - Method in interface com.mysql.cj.xdevapi.FilterParams
Set binding.
addOrReplaceOne(String, DbDoc) - Method in interface com.mysql.cj.xdevapi.Collection
Adds the document to the collection.
addOrReplaceOne(String, String) - Method in interface com.mysql.cj.xdevapi.Collection
Adds the document to the collection.
AddResult - Interface in com.mysql.cj.xdevapi
A result from the collection.add() statement.
AddStatement - Interface in com.mysql.cj.xdevapi
A statement adding documents to a collection.
arrayAppend(String, Object) - Method in interface com.mysql.cj.xdevapi.ModifyStatement
Append a value to the specified array.
arrayInsert(String, Object) - Method in interface com.mysql.cj.xdevapi.ModifyStatement
Insert a value into the specified array.
asNumber() - Method in enum com.mysql.cj.xdevapi.FilterParams.RowLock
Get the row lock type id.
asNumber() - Method in enum com.mysql.cj.xdevapi.FilterParams.RowLockOptions
Get the row lock option id.

B

bind(String, Object) - Method in interface com.mysql.cj.xdevapi.Statement
Bind the named argument to the given value.
bind(Map<String, Object>) - Method in interface com.mysql.cj.xdevapi.Statement
Bind the set of arguments named by the keys in the map to the associated values in the map.
bind(List<Object>) - Method in interface com.mysql.cj.xdevapi.Statement
Bind a list of objects numerically starting at 0.
bind(Object...) - Method in interface com.mysql.cj.xdevapi.Statement
Bind an array of objects numerically starting at 0.

C

change(String, Object) - Method in interface com.mysql.cj.xdevapi.ModifyStatement
Add an update to the statement setting the field, if it exists at the document path, to the given value.
clearArgs() - Method in interface com.mysql.cj.xdevapi.FilterParams
Remove all current bindings.
clearBindings() - Method in interface com.mysql.cj.xdevapi.Statement
Clear all bindings for this statement.
Client - Interface in com.mysql.cj.xdevapi
X DevAPI class encapsulating a Session pooling functionality.
Client.ClientProperty - Enum in com.mysql.cj.xdevapi
 
ClientFactory - Class in com.mysql.cj.xdevapi
ClientFactory is used for creation of Client instances.
ClientFactory() - Constructor for class com.mysql.cj.xdevapi.ClientFactory
 
ClientProperty(String) - Constructor for enum com.mysql.cj.xdevapi.Client.ClientProperty
 
close() - Method in interface com.mysql.cj.xdevapi.Client
Close Client.
close() - Method in interface com.mysql.cj.xdevapi.Session
Close this session.
Collection - Interface in com.mysql.cj.xdevapi
Representation of a document collection.
Column - Interface in com.mysql.cj.xdevapi
Represents individual column of RowResult
com.mysql.cj.xdevapi - package com.mysql.cj.xdevapi
Java classes for X DevAPI support.
commit() - Method in interface com.mysql.cj.xdevapi.Session
Commit the transaction.
count() - Method in interface com.mysql.cj.xdevapi.Collection
Query the number of documents in this collection.
count() - Method in interface com.mysql.cj.xdevapi.FetchResult
How many items are in this result? This method forces internal buffering of the entire result.
count() - Method in interface com.mysql.cj.xdevapi.Table
Query the number of rows in this table.
createCollection(String) - Method in interface com.mysql.cj.xdevapi.Schema
Create a new collection.
createCollection(String, boolean) - Method in interface com.mysql.cj.xdevapi.Schema
Create a new collection if it does not already exist on the server.
createCollection(String, Schema.CreateCollectionOptions) - Method in interface com.mysql.cj.xdevapi.Schema
Create a new collection.
CreateCollectionOptions() - Constructor for class com.mysql.cj.xdevapi.Schema.CreateCollectionOptions
 
createIndex(String, DbDoc) - Method in interface com.mysql.cj.xdevapi.Collection
Create a new statement defining the creation of an index on this collection.
createIndex(String, String) - Method in interface com.mysql.cj.xdevapi.Collection
Create a new statement defining the creation of an index on this collection.
createSchema(String) - Method in interface com.mysql.cj.xdevapi.Session
Create and return a new schema with the name given by name.
createSchema(String, boolean) - Method in interface com.mysql.cj.xdevapi.Session
Create and return a new schema with the name given by name.

D

DatabaseObject - Interface in com.mysql.cj.xdevapi
A client-side representation of X Plugin server object, e.g.
DatabaseObject.DbObjectStatus - Enum in com.mysql.cj.xdevapi
Existence states of database objects.
DatabaseObject.DbObjectType - Enum in com.mysql.cj.xdevapi
Type of database objects.
DbDoc - Interface in com.mysql.cj.xdevapi
The object representation of a JSON document.
DbObjectStatus() - Constructor for enum com.mysql.cj.xdevapi.DatabaseObject.DbObjectStatus
 
DbObjectType() - Constructor for enum com.mysql.cj.xdevapi.DatabaseObject.DbObjectType
 
delete() - Method in interface com.mysql.cj.xdevapi.Table
Create a new delete statement.
DeleteStatement - Interface in com.mysql.cj.xdevapi
A statement to delete rows from a table.
DocResult - Interface in com.mysql.cj.xdevapi
A sequence of documents retrieved from a find query.
dropCollection(String) - Method in interface com.mysql.cj.xdevapi.Schema
Drop the collection from this schema.
dropIndex(String) - Method in interface com.mysql.cj.xdevapi.Collection
Create a new statement defining the removal of an index on this collection.
dropSchema(String) - Method in interface com.mysql.cj.xdevapi.Session
Drop the existing schema with the name given by name.

E

execute() - Method in interface com.mysql.cj.xdevapi.Statement
Execute the statement synchronously.
executeAsync() - Method in interface com.mysql.cj.xdevapi.Statement
Execute the statement asynchronously.
existsInDatabase() - Method in interface com.mysql.cj.xdevapi.DatabaseObject
Query the existence of this database object.
expr(String) - Static method in class com.mysql.cj.xdevapi.Expression
Static method for static import to allow: set("b", expr("a + 1"))
Expression - Class in com.mysql.cj.xdevapi
A wrapper for expression strings.
Expression(String) - Constructor for class com.mysql.cj.xdevapi.Expression
 
expressionString - Variable in class com.mysql.cj.xdevapi.Expression
 

F

fetchAll() - Method in interface com.mysql.cj.xdevapi.FetchResult
Create a list of all elements in the result forcing internal buffering.
fetchOne() - Method in interface com.mysql.cj.xdevapi.FetchResult
Fetch the next element.
FetchResult<T> - Interface in com.mysql.cj.xdevapi
A set of elements from a query command.
fields(String...) - Method in interface com.mysql.cj.xdevapi.FindStatement
Add/replace the field projections defining the result.
fields(Expression) - Method in interface com.mysql.cj.xdevapi.FindStatement
Add/replace the field projection defining the result.
FilterParams - Interface in com.mysql.cj.xdevapi
Transforms X DevAPI filter parameters into X Protocol message entities.
FilterParams.RowLock - Enum in com.mysql.cj.xdevapi
The type of row lock.
FilterParams.RowLockOptions - Enum in com.mysql.cj.xdevapi
Options that define the behavior while retrieving locked rows.
find() - Method in interface com.mysql.cj.xdevapi.Collection
Create a new find statement retrieving all documents in the collection.
find(String) - Method in interface com.mysql.cj.xdevapi.Collection
Create a new find statement retrieving documents matching the given search condition.
FindStatement - Interface in com.mysql.cj.xdevapi
A statement to find the set of documents according to the given specification.

G

getAffectedItemsCount() - Method in interface com.mysql.cj.xdevapi.Result
Get the count of affected items from manipulation statements.
getArgs() - Method in interface com.mysql.cj.xdevapi.FilterParams
Get binding arguments.
getAutoIncrementValue() - Method in interface com.mysql.cj.xdevapi.InsertResult
Get the auto-increment value if one was generated from a row insert statement.
getAutoIncrementValue() - Method in interface com.mysql.cj.xdevapi.SqlResult
 
getBigDecimal(String) - Method in interface com.mysql.cj.xdevapi.Row
Retrieve the value for column `fieldName' as a decimal value.
getBigDecimal(int) - Method in interface com.mysql.cj.xdevapi.Row
Retrieve the value for column at position `pos' (starting at 0) as a decimal value.
getBoolean(String) - Method in interface com.mysql.cj.xdevapi.Row
Retrieve the value for column `fieldName' as a boolean value.
getBoolean(int) - Method in interface com.mysql.cj.xdevapi.Row
Retrieve the value for column at position `pos' (starting at 0) as a boolean value.
getByte(String) - Method in interface com.mysql.cj.xdevapi.Row
Retrieve the value for column `fieldName' as a byte value.
getByte(int) - Method in interface com.mysql.cj.xdevapi.Row
Retrieve the value for column at position `pos' (starting at 0) as a byte value.
getCharacterSetName() - Method in interface com.mysql.cj.xdevapi.Column
Get character set name for the column value.
getClient(String, String) - Method in class com.mysql.cj.xdevapi.ClientFactory
Creates a Client object which provides a Session pooling functionality.
getClient(String, Properties) - Method in class com.mysql.cj.xdevapi.ClientFactory
Creates a Client object that provides a Session pooling functionality.
getCollationName() - Method in interface com.mysql.cj.xdevapi.Column
Get collation name for the column value.
getCollection() - Method in interface com.mysql.cj.xdevapi.FilterParams
Get X Protocol Collection object.
getCollection(String) - Method in interface com.mysql.cj.xdevapi.Schema
Retrieve a reference to the named collection.
getCollection(String, boolean) - Method in interface com.mysql.cj.xdevapi.Schema
Retrieve a reference to the named collection hinting that an exception should be thrown if the collection is not known to the server.
getCollectionAsTable(String) - Method in interface com.mysql.cj.xdevapi.Schema
Retrieve a reference to the named collection using the table API.
getCollections() - Method in interface com.mysql.cj.xdevapi.Schema
Retrieve the set of collections existing in this schema.
getCollections(String) - Method in interface com.mysql.cj.xdevapi.Schema
Retrieve the set of collections existing in this schema and matching the given pattern.
getColumnCount() - Method in interface com.mysql.cj.xdevapi.RowResult
Count of columns.
getColumnLabel() - Method in interface com.mysql.cj.xdevapi.Column
Get alias of this column.
getColumnName() - Method in interface com.mysql.cj.xdevapi.Column
Get name of this column.
getColumnNames() - Method in interface com.mysql.cj.xdevapi.RowResult
Names of columns.
getColumns() - Method in interface com.mysql.cj.xdevapi.RowResult
Metadata.
getCriteria() - Method in interface com.mysql.cj.xdevapi.FilterParams
Get the search criteria.
getDate(String) - Method in interface com.mysql.cj.xdevapi.Row
Retrieve the value for column `fieldName' as a Date value.
getDate(int) - Method in interface com.mysql.cj.xdevapi.Row
Retrieve the value for column at position `pos' (starting at 0) as a byte value.
getDbDoc(String) - Method in interface com.mysql.cj.xdevapi.Row
Retrieve the value for column `fieldName' as a DbDoc value.
getDbDoc(int) - Method in interface com.mysql.cj.xdevapi.Row
Retrieve the value for column at position `pos' (starting at 0) as a DbDoc value.
getDefaultSchema() - Method in interface com.mysql.cj.xdevapi.Session
Retrieve the default schema name, which might have been configured at the time of connection.
getDefaultSchemaName() - Method in interface com.mysql.cj.xdevapi.Session
Retrieve the default schema name, which might have been configured at the time of connection.
getDouble(String) - Method in interface com.mysql.cj.xdevapi.Row
Retrieve the value for column `fieldName' as a double value.
getDouble(int) - Method in interface com.mysql.cj.xdevapi.Row
Retrieve the value for column at position `pos' (starting at 0) as a double value.
getExpressionString() - Method in class com.mysql.cj.xdevapi.Expression
Get the string form of this expression
getFields() - Method in interface com.mysql.cj.xdevapi.FilterParams
Get X Protocol Projection objects.
getFilterParams() - Method in interface com.mysql.cj.xdevapi.SelectStatement
Return FilterParams defined for this statement.
getFractionalDigits() - Method in interface com.mysql.cj.xdevapi.Column
Get number of fractional digits in this column's value.
getGeneratedIds() - Method in interface com.mysql.cj.xdevapi.AddResult
Get a list of document ids generated in the server for the documents added by collection.add().
getGrouping() - Method in interface com.mysql.cj.xdevapi.FilterParams
Get X Protocol Expr objects for groupBy.
getGroupingCriteria() - Method in interface com.mysql.cj.xdevapi.FilterParams
Get X Protocol Expr objects for grouping criteria.
getInt(String) - Method in interface com.mysql.cj.xdevapi.Row
Retrieve the value for column `fieldName' as an integer value.
getInt(int) - Method in interface com.mysql.cj.xdevapi.Row
Retrieve the value for column at position `pos' (starting at 0) as an integer value.
getKeyName() - Method in enum com.mysql.cj.xdevapi.Client.ClientProperty
 
getLength() - Method in interface com.mysql.cj.xdevapi.Column
Get this column's length.
getLevel() - Method in class com.mysql.cj.xdevapi.Schema.Validation
 
getLimit() - Method in interface com.mysql.cj.xdevapi.FilterParams
Get max number of rows to filter.
getLock() - Method in interface com.mysql.cj.xdevapi.FilterParams
getLockOption() - Method in interface com.mysql.cj.xdevapi.FilterParams
getLong(String) - Method in interface com.mysql.cj.xdevapi.Row
Retrieve the value for column `fieldName' as a long value.
getLong(int) - Method in interface com.mysql.cj.xdevapi.Row
Retrieve the value for column at position `pos' (starting at 0) as a long value.
getName() - Method in interface com.mysql.cj.xdevapi.DatabaseObject
Retrieve the name of the database object represented by the Java object.
getOffset() - Method in interface com.mysql.cj.xdevapi.FilterParams
Get number of rows to skip before finding others.
getOne(String) - Method in interface com.mysql.cj.xdevapi.Collection
Return the document with the given id.
getOrder() - Method in interface com.mysql.cj.xdevapi.FilterParams
Get X Protocol Order objects.
getReuseExisting() - Method in class com.mysql.cj.xdevapi.Schema.CreateCollectionOptions
 
getSchema() - Method in interface com.mysql.cj.xdevapi.DatabaseObject
Retrieve the schema owning this database object.
getSchema() - Method in class com.mysql.cj.xdevapi.Schema.Validation
 
getSchema(String) - Method in interface com.mysql.cj.xdevapi.Session
Retrieve the Schema corresponding to name.
getSchemaName() - Method in interface com.mysql.cj.xdevapi.Column
Get name of Schema.
getSchemas() - Method in interface com.mysql.cj.xdevapi.Session
Retrieve the list of Schema objects for which the current user has access.
getSession() - Method in interface com.mysql.cj.xdevapi.Client
Get Session from pool or the new one.
getSession() - Method in interface com.mysql.cj.xdevapi.DatabaseObject
Retrieve the session owning the given schema object.
getSession(ConnectionUrl) - Method in class com.mysql.cj.xdevapi.SessionFactory
Creates Session by given URL.
getSession(String) - Method in class com.mysql.cj.xdevapi.SessionFactory
Creates Session by given URL.
getSession(Properties) - Method in class com.mysql.cj.xdevapi.SessionFactory
Creates a Session using the information contained in the given properties.
getString(String) - Method in interface com.mysql.cj.xdevapi.Row
Retrieve the value for column `fieldName' as a string value.
getString(int) - Method in interface com.mysql.cj.xdevapi.Row
Retrieve the value for column at position `pos' (starting at 0) as a string value.
getTable(String) - Method in interface com.mysql.cj.xdevapi.Schema
Retrieve a reference to the named table.
getTable(String, boolean) - Method in interface com.mysql.cj.xdevapi.Schema
Retrieve a reference to the named table hinting that an exception should be thrown if the collection is not known to the server.
getTableLabel() - Method in interface com.mysql.cj.xdevapi.Column
Get alias of Table.
getTableName() - Method in interface com.mysql.cj.xdevapi.Column
Get name of Table.
getTables() - Method in interface com.mysql.cj.xdevapi.Schema
Retrieve the set of tables existing in this schema.
getTables(String) - Method in interface com.mysql.cj.xdevapi.Schema
Retrieve the set of tables existing in this schema and matching the given pattern.
getTime(String) - Method in interface com.mysql.cj.xdevapi.Row
Retrieve the value for column `fieldName' as a Time value.
getTime(int) - Method in interface com.mysql.cj.xdevapi.Row
Retrieve the value for column at position `pos' (starting at 0) as a byte value.
getTimestamp(String) - Method in interface com.mysql.cj.xdevapi.Row
Retrieve the value for column `fieldName' as a Timestamp value.
getTimestamp(int) - Method in interface com.mysql.cj.xdevapi.Row
Retrieve the value for column at position `pos' (starting at 0) as a byte value.
getType() - Method in interface com.mysql.cj.xdevapi.Column
Get this column's Type.
getUri() - Method in interface com.mysql.cj.xdevapi.Session
Get the URL used to create this session.
getValidation() - Method in class com.mysql.cj.xdevapi.Schema.CreateCollectionOptions
 
getValidation() - Method in class com.mysql.cj.xdevapi.Schema.ModifyCollectionOptions
 
getWarnings() - Method in interface com.mysql.cj.xdevapi.Result
Get warnings generated during statement execution.
getWarningsCount() - Method in interface com.mysql.cj.xdevapi.Result
Get the number of warnings generated during statement execution.
groupBy(String...) - Method in interface com.mysql.cj.xdevapi.FindStatement
Add/replace the aggregation fields for this query.
groupBy(String...) - Method in interface com.mysql.cj.xdevapi.SelectStatement
Add/replace the aggregation fields for this query.

H

hasData() - Method in interface com.mysql.cj.xdevapi.FetchResult
Does this result have data? This indicates that the result was produced from a data-returning query.
having(String) - Method in interface com.mysql.cj.xdevapi.FindStatement
Add/replace the aggregate criteria for this query.
having(String) - Method in interface com.mysql.cj.xdevapi.SelectStatement
Add/replace the aggregate criteria for this query.

I

insert() - Method in interface com.mysql.cj.xdevapi.Table
Create an insert statement using the list of all columns in the table.
insert(String...) - Method in interface com.mysql.cj.xdevapi.Table
Create an insert statement using the given list columns.
insert(Map<String, Object>) - Method in interface com.mysql.cj.xdevapi.Table
Create an insert statement using the given key/value pairs.
InsertResult - Interface in com.mysql.cj.xdevapi
A result from the table.insert() statement.
InsertStatement - Interface in com.mysql.cj.xdevapi
A statement INSERTing new row(s) into a table.
isAutoIncrement() - Method in interface com.mysql.cj.xdevapi.Column
Checks if this is an auto increment column.
isNullable() - Method in interface com.mysql.cj.xdevapi.Column
Checks if column can contain null values.
isNumberSigned() - Method in interface com.mysql.cj.xdevapi.Column
Checks if value represents a signed number.
isOpen() - Method in interface com.mysql.cj.xdevapi.Session
Is this session open?
isPadded() - Method in interface com.mysql.cj.xdevapi.Column
Checks if the value has a padding.
isPartKey() - Method in interface com.mysql.cj.xdevapi.Column
Checks if this column is a part of key.
isPrimaryKey() - Method in interface com.mysql.cj.xdevapi.Column
Checks if this is a primary key column.
isRelational() - Method in interface com.mysql.cj.xdevapi.FilterParams
Are relational columns identifiers allowed?
isUniqueKey() - Method in interface com.mysql.cj.xdevapi.Column
Checks if this is a unique key column.
isUpsert() - Method in interface com.mysql.cj.xdevapi.AddStatement
Check the upsert flag.
isView() - Method in interface com.mysql.cj.xdevapi.Table
Check if the underlying object is a view or not.
iterator() - Method in interface com.mysql.cj.xdevapi.FetchResult
Create an iterator over all elements of the result.

J

JsonValue - Interface in com.mysql.cj.xdevapi
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.

K

keyName - Variable in enum com.mysql.cj.xdevapi.Client.ClientProperty
 

L

level - Variable in class com.mysql.cj.xdevapi.Schema.Validation
 
limit(long) - Method in interface com.mysql.cj.xdevapi.DeleteStatement
Add/replace the row limit for the deletion.
limit(long) - Method in interface com.mysql.cj.xdevapi.FindStatement
Add/replace the document limit for this query.
limit(long) - Method in interface com.mysql.cj.xdevapi.ModifyStatement
Add/replace the document limit for this statement.
limit(long) - Method in interface com.mysql.cj.xdevapi.RemoveStatement
Add/replace the document limit for the removal.
limit(long) - Method in interface com.mysql.cj.xdevapi.SelectStatement
Add/replace the row limit for this query.
limit(long) - Method in interface com.mysql.cj.xdevapi.UpdateStatement
Add/replace the row limit for this statement.
LockContention() - Constructor for enum com.mysql.cj.xdevapi.Statement.LockContention
 
lockExclusive() - Method in interface com.mysql.cj.xdevapi.FindStatement
Locks matching rows exclusively so no other transactions can read or write to them.
lockExclusive(Statement.LockContention) - Method in interface com.mysql.cj.xdevapi.FindStatement
Locks matching rows exclusively so no other transactions can read or write to them, using the provided lock contention option.
lockExclusive() - Method in interface com.mysql.cj.xdevapi.SelectStatement
Locks matching rows exclusively so no other transactions can read or write to them.
lockExclusive(Statement.LockContention) - Method in interface com.mysql.cj.xdevapi.SelectStatement
Locks matching rows exclusively so no other transactions can read or write to them, using the provided lock contention option.
lockShared() - Method in interface com.mysql.cj.xdevapi.FindStatement
Locks matching rows against updates.
lockShared(Statement.LockContention) - Method in interface com.mysql.cj.xdevapi.FindStatement
Locks matching rows against updates using the provided lock contention option.
lockShared() - Method in interface com.mysql.cj.xdevapi.SelectStatement
Locks matching rows against updates.
lockShared(Statement.LockContention) - Method in interface com.mysql.cj.xdevapi.SelectStatement
Locks matching rows against updates using the provided lock contention option.

M

modify(String) - Method in interface com.mysql.cj.xdevapi.Collection
Create a new modify statement affecting documents matching the given search condition.
modifyCollection(String, Schema.ModifyCollectionOptions) - Method in interface com.mysql.cj.xdevapi.Schema
Modify the schema validation of a collection.
ModifyCollectionOptions() - Constructor for class com.mysql.cj.xdevapi.Schema.ModifyCollectionOptions
 
ModifyStatement - Interface in com.mysql.cj.xdevapi
A statement representing a set of document modifications.

N

newDoc() - Method in interface com.mysql.cj.xdevapi.Collection
Create a new document.
nextResult() - Method in interface com.mysql.cj.xdevapi.SqlResult
Move to the next result.

O

offset(long) - Method in interface com.mysql.cj.xdevapi.FindStatement
Add/replace the document offset for this query.
offset(long) - Method in interface com.mysql.cj.xdevapi.SelectStatement
Add/replace the row offset for this query.
orderBy(String...) - Method in interface com.mysql.cj.xdevapi.DeleteStatement
Add/replace the order by specification for the deletion.
orderBy(String...) - Method in interface com.mysql.cj.xdevapi.FindStatement
Add/replace the order specification for this query.
orderBy(String...) - Method in interface com.mysql.cj.xdevapi.RemoveStatement
Deprecated.
orderBy(String...) - Method in interface com.mysql.cj.xdevapi.SelectStatement
Add/replace the order specification for this query.
orderBy(String...) - Method in interface com.mysql.cj.xdevapi.UpdateStatement
Add/replace the order specification for this statement.

P

parseUrl(String) - Method in class com.mysql.cj.xdevapi.SessionFactory
Parses the connection string URL.
patch(DbDoc) - Method in interface com.mysql.cj.xdevapi.ModifyStatement
Takes in a patch object and applies it on all documents matching the modify() filter, using the JSON_MERGE_PATCH() function.
patch(String) - Method in interface com.mysql.cj.xdevapi.ModifyStatement
Takes in a document patch and applies it on all documents matching the modify() filter, using the JSON_MERGE_PATCH() function.

R

releaseSavepoint(String) - Method in interface com.mysql.cj.xdevapi.Session
Releases the named savepoint.
remove(String) - Method in interface com.mysql.cj.xdevapi.Collection
Create a new removal statement affecting documents matching the given search condition.
removeOne(String) - Method in interface com.mysql.cj.xdevapi.Collection
Removes the document with the given id.
RemoveStatement - Interface in com.mysql.cj.xdevapi
A statement requesting to remove a set of documents.
replaceOne(String, DbDoc) - Method in interface com.mysql.cj.xdevapi.Collection
Takes in a document object that will replace the matching document.
replaceOne(String, String) - Method in interface com.mysql.cj.xdevapi.Collection
Takes in a document object that will replace the matching document.
Result - Interface in com.mysql.cj.xdevapi
Base result.
reuseExisting - Variable in class com.mysql.cj.xdevapi.Schema.CreateCollectionOptions
 
rollback() - Method in interface com.mysql.cj.xdevapi.Session
Rollback the transaction.
rollbackTo(String) - Method in interface com.mysql.cj.xdevapi.Session
Rolls back the transaction to the named savepoint.
Row - Interface in com.mysql.cj.xdevapi
A row element returned from a SELECT query.
RowLock(int) - Constructor for enum com.mysql.cj.xdevapi.FilterParams.RowLock
 
rowLock - Variable in enum com.mysql.cj.xdevapi.FilterParams.RowLock
 
rowLockOption - Variable in enum com.mysql.cj.xdevapi.FilterParams.RowLockOptions
 
RowLockOptions(int) - Constructor for enum com.mysql.cj.xdevapi.FilterParams.RowLockOptions
 
RowResult - Interface in com.mysql.cj.xdevapi
A result exposing a set of rows from a SELECT query.

S

Schema - Interface in com.mysql.cj.xdevapi
A client-side representation of a database schema.
schema - Variable in class com.mysql.cj.xdevapi.Schema.Validation
 
Schema.CreateCollectionOptions - Class in com.mysql.cj.xdevapi
Schema.ModifyCollectionOptions - Class in com.mysql.cj.xdevapi
Schema.Validation - Class in com.mysql.cj.xdevapi
Schema.Validation.ValidationLevel - Enum in com.mysql.cj.xdevapi
Defines how validation options are applied.
select(String...) - Method in interface com.mysql.cj.xdevapi.Table
Create a new select statement using the given projections.
SelectStatement - Interface in com.mysql.cj.xdevapi
A statement representing a SELECT query.
serialVersionUID - Static variable in exception com.mysql.cj.xdevapi.XDevAPIError
 
Session - Interface in com.mysql.cj.xdevapi
X DevAPI introduces a new, high-level database connection concept that is called Session.
SessionFactory - Class in com.mysql.cj.xdevapi
SessionFactory is used for creation of sessions.
SessionFactory() - Constructor for class com.mysql.cj.xdevapi.SessionFactory
 
set(String, Object) - Method in interface com.mysql.cj.xdevapi.ModifyStatement
Add an update to the statement setting the field as the document path to the given value for all documents matching the search criteria.
set(Map<String, Object>) - Method in interface com.mysql.cj.xdevapi.UpdateStatement
Add the given set of updates to the statement.
set(String, Object) - Method in interface com.mysql.cj.xdevapi.UpdateStatement
Add the given update to the statement setting field to value for all rows matching the search criteria.
setCriteria(String) - Method in interface com.mysql.cj.xdevapi.FilterParams
Parse criteriaString into X Protocol Expr object.
setFields(String...) - Method in interface com.mysql.cj.xdevapi.FilterParams
Parse projection expressions into X Protocol Projection objects.
setGrouping(String...) - Method in interface com.mysql.cj.xdevapi.FilterParams
Parse groupBy expressions into X Protocol Expr objects.
setGroupingCriteria(String) - Method in interface com.mysql.cj.xdevapi.FilterParams
Parse having expressions into X Protocol Expr objects.
setLevel(Schema.Validation.ValidationLevel) - Method in class com.mysql.cj.xdevapi.Schema.Validation
 
setLimit(Long) - Method in interface com.mysql.cj.xdevapi.FilterParams
Set maximum rows to find.
setLock(FilterParams.RowLock) - Method in interface com.mysql.cj.xdevapi.FilterParams
setLockOption(FilterParams.RowLockOptions) - Method in interface com.mysql.cj.xdevapi.FilterParams
setOffset(Long) - Method in interface com.mysql.cj.xdevapi.FilterParams
Set number of rows to skip before finding others.
setOrder(String...) - Method in interface com.mysql.cj.xdevapi.FilterParams
Parse order expressions into X Protocol Order objects.
setReuseExisting(boolean) - Method in class com.mysql.cj.xdevapi.Schema.CreateCollectionOptions
 
setSavepoint() - Method in interface com.mysql.cj.xdevapi.Session
Creates a transaction savepoint with an implementation-defined generated name and returns its name, which can be used in Session.rollbackTo(String) or Session.releaseSavepoint(String).
setSavepoint(String) - Method in interface com.mysql.cj.xdevapi.Session
Creates or replaces a transaction savepoint with the given name.
setSchema(String) - Method in class com.mysql.cj.xdevapi.Schema.Validation
 
setUpsert(boolean) - Method in interface com.mysql.cj.xdevapi.AddStatement
Set upsert flag on this statement.
setValidation(Schema.Validation) - Method in class com.mysql.cj.xdevapi.Schema.CreateCollectionOptions
 
setValidation(Schema.Validation) - Method in class com.mysql.cj.xdevapi.Schema.ModifyCollectionOptions
 
skip(long) - Method in interface com.mysql.cj.xdevapi.FindStatement
Deprecated.
Deprecated in c/J 8.0.12, please use FindStatement.offset(long) instead.
sort(String...) - Method in interface com.mysql.cj.xdevapi.FindStatement
Add/replace the order specification for this query.
sort(String...) - Method in interface com.mysql.cj.xdevapi.ModifyStatement
Add/replace the order specification for this statement.
sort(String...) - Method in interface com.mysql.cj.xdevapi.RemoveStatement
Add/replace the order specification for the removal.
sql(String) - Method in interface com.mysql.cj.xdevapi.Session
Create a native SQL command.
SqlResult - Interface in com.mysql.cj.xdevapi
A result from a SQL statement which may have several sets of data following by a DML result.
SqlStatement - Interface in com.mysql.cj.xdevapi
A statement representing a raw SQL command.
startTransaction() - Method in interface com.mysql.cj.xdevapi.Session
Start a new transaction.
Statement<STMT_T,RES_T> - Interface in com.mysql.cj.xdevapi
A statement is a query or state-affecting command against a database that returns a result.
Statement.LockContention - Enum in com.mysql.cj.xdevapi
The lock contention options for the locking modes available.
supportsOffset() - Method in interface com.mysql.cj.xdevapi.FilterParams
Whether offset clause is supported in the statement or not.

T

Table - Interface in com.mysql.cj.xdevapi
A client-side representation of a database table.
toFormattedString() - Method in interface com.mysql.cj.xdevapi.JsonValue
Get a human readable "pretty" JSON string.
Type - Enum in com.mysql.cj.xdevapi
Column type.
Type() - Constructor for enum com.mysql.cj.xdevapi.Type
 

U

unset(String...) - Method in interface com.mysql.cj.xdevapi.ModifyStatement
Nullify the given fields.
update() - Method in interface com.mysql.cj.xdevapi.Table
Create a new update statement.
UpdateStatement - Interface in com.mysql.cj.xdevapi
A statement representing a set of row modifications.
UpdateType - Enum in com.mysql.cj.xdevapi
Update operation type.
UpdateType() - Constructor for enum com.mysql.cj.xdevapi.UpdateType
 

V

validation - Variable in class com.mysql.cj.xdevapi.Schema.CreateCollectionOptions
 
validation - Variable in class com.mysql.cj.xdevapi.Schema.ModifyCollectionOptions
 
Validation() - Constructor for class com.mysql.cj.xdevapi.Schema.Validation
 
ValidationLevel() - Constructor for enum com.mysql.cj.xdevapi.Schema.Validation.ValidationLevel
 
valueOf(String) - Static method in enum com.mysql.cj.xdevapi.Client.ClientProperty
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.mysql.cj.xdevapi.DatabaseObject.DbObjectStatus
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.mysql.cj.xdevapi.DatabaseObject.DbObjectType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.mysql.cj.xdevapi.FilterParams.RowLock
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.mysql.cj.xdevapi.FilterParams.RowLockOptions
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.mysql.cj.xdevapi.Schema.Validation.ValidationLevel
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.mysql.cj.xdevapi.Statement.LockContention
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.mysql.cj.xdevapi.Type
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.mysql.cj.xdevapi.UpdateType
Returns the enum constant of this type with the specified name.
values() - Static method in enum com.mysql.cj.xdevapi.Client.ClientProperty
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.mysql.cj.xdevapi.DatabaseObject.DbObjectStatus
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.mysql.cj.xdevapi.DatabaseObject.DbObjectType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.mysql.cj.xdevapi.FilterParams.RowLock
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.mysql.cj.xdevapi.FilterParams.RowLockOptions
Returns an array containing the constants of this enum type, in the order they are declared.
values(List<Object>) - Method in interface com.mysql.cj.xdevapi.InsertStatement
Add a row (sequence of values) to this statement.
values(Object...) - Method in interface com.mysql.cj.xdevapi.InsertStatement
Add a row (sequence of values) to this statement.
values() - Static method in enum com.mysql.cj.xdevapi.Schema.Validation.ValidationLevel
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.mysql.cj.xdevapi.Statement.LockContention
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.mysql.cj.xdevapi.Type
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.mysql.cj.xdevapi.UpdateType
Returns an array containing the constants of this enum type, in the order they are declared.
verifyAllArgsBound() - Method in interface com.mysql.cj.xdevapi.FilterParams
Verify that all arguments are bound.

W

Warning - Interface in com.mysql.cj.xdevapi
A warning generated during statement execution.
where(String) - Method in interface com.mysql.cj.xdevapi.DeleteStatement
Add/replace the filter for the deletion.
where(String) - Method in interface com.mysql.cj.xdevapi.SelectStatement
Add/replace the search condition for this query.
where(String) - Method in interface com.mysql.cj.xdevapi.UpdateStatement
Add/replace the search criteria for this statement.

X

XDevAPIError - Exception in com.mysql.cj.xdevapi
An Error returned from X DevAPI.
XDevAPIError(String) - Constructor for exception com.mysql.cj.xdevapi.XDevAPIError
Create new XDevAPIError instance.
XDevAPIError(String, Throwable) - Constructor for exception com.mysql.cj.xdevapi.XDevAPIError
Create new XDevAPIError instance.
A B C D E F G H I J K L M N O P R S T U V W X 
Skip navigation links
MySQL Connector/J X DevAPI Reference
v8.3.0-SNAPSHOT

Copyright © 2016, 2024, Oracle and/or its affiliates.