Modifier and Type	Class and Description
public static enum	FilterParams.RowLock The type of row lock.
public static enum	FilterParams.RowLockOptions Options that define the behavior while retrieving locked rows.

Method Summary

Modifier and Type	Method and Description
public void	addArg(String bind key name, Object bind value value) Set binding.
public void	clearArgs() Remove all current bindings.
public Object	Returns: List of X Protocol Scalar object getArgs() Get binding arguments.
public Object	Returns: X Protocol Collection object getCollection() Get X Protocol Collection object.
public Object	Returns: X Protocol Expr object getCriteria() Get the search criteria.
public Object	Returns: List of X Protocol Projection objects. getFields() Get X Protocol Projection objects.
public Object	Returns: List of X Protocol Expr objects getGrouping() Get X Protocol Expr objects for groupBy.
public Object	Returns: List of X Protocol Expr objects getGroupingCriteria() Get X Protocol Expr objects for grouping criteria.
public Long	Returns: limit getLimit() Get max number of rows to filter.
public FilterParams.RowLock	Returns: `RowLock` getLock() Get `RowLock` value.
public FilterParams.RowLockOptions	Returns: `RowLockOptions` getLockOption() Get `RowLockOptions` value.
public Long	Returns: maximum rows to skip getOffset() Get number of rows to skip before finding others.
public Object	Returns: List of X Protocol Order objects getOrder() Get X Protocol Order objects.
public boolean	Returns: true if allowed isRelational() Are relational columns identifiers allowed?
public void	setCriteria(String expression criteriaString) Parse criteriaString into X Protocol Expr object.
public void	setFields(String... projection expression projection) Parse projection expressions into X Protocol Projection objects.
public void	setGrouping(String... groupBy expression groupBy) Parse groupBy expressions into X Protocol Expr objects.
public void	setGroupingCriteria(String having expression having) Parse having expressions into X Protocol Expr objects.
public void	setLimit(Long maximum rows to find limit) Set maximum rows to find.
public void	setLock(FilterParams.RowLock `RowLock` rowLock) Set `RowLock` value.
public void	setLockOption(FilterParams.RowLockOptions `RowLockOptions` rowLockOption) Set `RowLockOptions` value.
public void	setOffset(Long maximum rows to skip offset) Set number of rows to skip before finding others.
public void	setOrder(String... order expressions orderExpression) Parse order expressions into X Protocol Order objects.
public boolean	Returns: `true` if offset clause is supported supportsOffset() Whether offset clause is supported in the statement or not.
public void	verifyAllArgsBound() Verify that all arguments are bound.

Method Detail

addArg	back to summary
public void addArg(String name, Object value) Set binding. this.collection.find("a = :arg1 or b = :arg2").bind("arg1", 1).bind("arg2", 2).execute(); Parameters name:String bind key value:Object bind value

addArg

back to summary

public void addArg(String name, Object value)

Set binding.

this.collection.find("a = :arg1 or b = :arg2").bind("arg1", 1).bind("arg2", 2).execute();

Parameters

name:String: bind key
value:Object: bind value

clearArgs	back to summary
public void clearArgs() Remove all current bindings.

getArgs	back to summary
public Object getArgs() Get binding arguments. Returns:Object List of X Protocol Scalar object

getArgs

back to summary

public Object getArgs()

Get binding arguments.

Returns:Object: List of X Protocol Scalar object

getCollection	back to summary
public Object getCollection() Get X Protocol Collection object. Returns:Object X Protocol Collection object

getCollection

back to summary

public Object getCollection()

Get X Protocol Collection object.

Returns:Object: X Protocol Collection object

getCriteria	back to summary
public Object getCriteria() Get the search criteria. Returns:Object X Protocol Expr object

getCriteria

back to summary

public Object getCriteria()

Get the search criteria.

Returns:Object: X Protocol Expr object

getFields	back to summary
public Object getFields() Get X Protocol Projection objects. Returns:Object List of X Protocol Projection objects.

getFields

back to summary

public Object getFields()

Get X Protocol Projection objects.

Returns:Object: List of X Protocol Projection objects.

getGrouping	back to summary
public Object getGrouping() Get X Protocol Expr objects for groupBy. Returns:Object List of X Protocol Expr objects

getGrouping

back to summary

public Object getGrouping()

Get X Protocol Expr objects for groupBy.

Returns:Object: List of X Protocol Expr objects

getGroupingCriteria	back to summary
public Object getGroupingCriteria() Get X Protocol Expr objects for grouping criteria. Returns:Object List of X Protocol Expr objects

getGroupingCriteria

back to summary

public Object getGroupingCriteria()

Get X Protocol Expr objects for grouping criteria.

Returns:Object: List of X Protocol Expr objects

getLimit	back to summary
public Long getLimit() Get max number of rows to filter. Returns:Long limit

getLimit

back to summary

public Long getLimit()

Get max number of rows to filter.

Returns:Long: limit

getLock back to summary

getLock	back to summary
public FilterParams.RowLock getLock() Get `RowLock` value. Returns:FilterParams.RowLock `RowLock`

public FilterParams.RowLock getLock()

Get RowLock value.

Returns:FilterParams.RowLock: RowLock

getLockOption back to summary

getLockOption	back to summary
public FilterParams.RowLockOptions getLockOption() Get `RowLockOptions` value. Returns:FilterParams.RowLockOptions `RowLockOptions`

public FilterParams.RowLockOptions getLockOption()

Get RowLockOptions value.

Returns:FilterParams.RowLockOptions: RowLockOptions

getOffset	back to summary
public Long getOffset() Get number of rows to skip before finding others. Returns:Long maximum rows to skip

getOffset

back to summary

public Long getOffset()

Get number of rows to skip before finding others.

Returns:Long: maximum rows to skip

getOrder	back to summary
public Object getOrder() Get X Protocol Order objects. Returns:Object List of X Protocol Order objects

getOrder

back to summary

public Object getOrder()

Get X Protocol Order objects.

Returns:Object: List of X Protocol Order objects

isRelational	back to summary
public boolean isRelational() Are relational columns identifiers allowed? Returns:boolean true if allowed

isRelational

back to summary

public boolean isRelational()

Are relational columns identifiers allowed?

Returns:boolean: true if allowed

setCriteria	back to summary
public void setCriteria(String criteriaString) Parse criteriaString into X Protocol Expr object. docs = this.collection.find("$.x1 = 29 \| 15").execute(); table.delete().where("age == 13").execute(); Parameters criteriaString:String expression

setCriteria

back to summary

public void setCriteria(String criteriaString)

Parse criteriaString into X Protocol Expr object.

docs = this.collection.find("$.x1 = 29 | 15").execute();
table.delete().where("age == 13").execute();

Parameters

criteriaString:String: expression

setFields	back to summary
public void setFields(String... projection) Parse projection expressions into X Protocol Projection objects. collection.find().fields("CAST($.x as SIGNED) as x").execute(); table.select("_id, name, birthday, age").execute(); table.select("age as age_group, count(name) as cnt, something").execute(); Parameters projection:String[] projection expression

setFields

back to summary

public void setFields(String... projection)

Parse projection expressions into X Protocol Projection objects.

collection.find().fields("CAST($.x as SIGNED) as x").execute();
table.select("_id, name, birthday, age").execute();
table.select("age as age_group, count(name) as cnt, something").execute();

Parameters

projection:String[]: projection expression

setGrouping	back to summary
public void setGrouping(String... groupBy) Parse groupBy expressions into X Protocol Expr objects. SelectStatement stmt = table.select("age as age_group, count(name) as cnt, something"); stmt.groupBy("something", "age_group"); Parameters groupBy:String[] groupBy expression

setGrouping

back to summary

public void setGrouping(String... groupBy)

Parse groupBy expressions into X Protocol Expr objects.

SelectStatement stmt = table.select("age as age_group, count(name) as cnt, something");
stmt.groupBy("something", "age_group");

Parameters

groupBy:String[]: groupBy expression

setGroupingCriteria	back to summary
public void setGroupingCriteria(String having) Parse having expressions into X Protocol Expr objects. SelectStatement stmt = table.select("age as age_group, count(name) as cnt, something"); stmt.groupBy("something", "age_group"); stmt.having("cnt > 1"); Parameters having:String having expression

setGroupingCriteria

back to summary

public void setGroupingCriteria(String having)

Parse having expressions into X Protocol Expr objects.

SelectStatement stmt = table.select("age as age_group, count(name) as cnt, something");
stmt.groupBy("something", "age_group");
stmt.having("cnt > 1");

Parameters

having:String: having expression

setLimit	back to summary
public void setLimit(Long limit) Set maximum rows to find. For example, to find the 3 first rows: docs = this.collection.find().orderBy("$._id").limit(3).execute(); Parameters limit:Long maximum rows to find

setLimit

back to summary

public void setLimit(Long limit)

Set maximum rows to find.

For example, to find the 3 first rows:

docs = this.collection.find().orderBy("$._id").limit(3).execute();

Parameters

limit:Long: maximum rows to find

setLock back to summary

setLock	back to summary
public void setLock(FilterParams.RowLock rowLock) Set `RowLock` value. Parameters rowLock:FilterParams.RowLock `RowLock`

public void setLock(FilterParams.RowLock rowLock)

Set RowLock value.

Parameters

rowLock:FilterParams.RowLock: RowLock

setLockOption back to summary

setLockOption	back to summary
public void setLockOption(FilterParams.RowLockOptions rowLockOption) Set `RowLockOptions` value. Parameters rowLockOption:FilterParams.RowLockOptions `RowLockOptions`

public void setLockOption(FilterParams.RowLockOptions rowLockOption)

Set RowLockOptions value.

Parameters

rowLockOption:FilterParams.RowLockOptions: RowLockOptions

setOffset	back to summary
public void setOffset(Long offset) Set number of rows to skip before finding others. For example, to skip 1 row and find other 3 rows: docs = this.collection.find().orderBy("$._id").limit(3).skip(1).execute(); Parameters offset:Long maximum rows to skip

setOffset

back to summary

public void setOffset(Long offset)

Set number of rows to skip before finding others.

For example, to skip 1 row and find other 3 rows:

docs = this.collection.find().orderBy("$._id").limit(3).skip(1).execute();

Parameters

offset:Long: maximum rows to skip

setOrder	back to summary
public void setOrder(String... orderExpression) Parse order expressions into X Protocol Order objects. DocResult docs = this.collection.find().orderBy("$._id").execute(); docs = this.collection.find().sort("$.x", "$.y").execute(); Parameters orderExpression:String[] order expressions

setOrder

back to summary

public void setOrder(String... orderExpression)

Parse order expressions into X Protocol Order objects.

DocResult docs = this.collection.find().orderBy("$._id").execute();
docs = this.collection.find().sort("$.x", "$.y").execute();

Parameters

orderExpression:String[]: order expressions

supportsOffset back to summary

supportsOffset	back to summary
public boolean supportsOffset() Whether offset clause is supported in the statement or not. Note that setting offset values is always possible, even if they are not supported. Returns:boolean `true` if offset clause is supported

public boolean supportsOffset()

Whether offset clause is supported in the statement or not.

Note that setting offset values is always possible, even if they are not supported.

Returns:boolean: true if offset clause is supported

verifyAllArgsBound	back to summary
public void verifyAllArgsBound() Verify that all arguments are bound. Throws `WrongArgumentException` if any placeholder argument is not bound.

com.mysql.cj.xdevapi back to summary

public final Enum FilterParams.RowLock

Class Inheritance

extends Enum<FilterParams.RowLock>

java.lang.Object
java.lang.Enum
com.mysql.cj.xdevapi.FilterParams.RowLock

The type of row lock.

Field Summary

Modifier and Type	Field and Description
public static final FilterParams.RowLock	EXCLUSIVE_LOCK Lock matching rows so no other transactions can read or write to it.
private int	rowLock
public static final FilterParams.RowLock	SHARED_LOCK Lock matching rows against updates.

Constructor Summary

Access	Constructor and Description
private	RowLock(int rowLock)

Method Summary

Modifier and Type	Method and Description
public int	Returns: row lock type id asNumber() Get the row lock type id.
public static FilterParams.RowLock	valueOf(String name)
public static FilterParams.RowLock[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

EXCLUSIVE_LOCK	back to summary
public static final FilterParams.RowLock EXCLUSIVE_LOCK Lock matching rows so no other transactions can read or write to it.

rowLock	back to summary
private int rowLock

SHARED_LOCK	back to summary
public static final FilterParams.RowLock SHARED_LOCK Lock matching rows against updates.

Constructor Detail

RowLock	back to summary
private RowLock(int rowLock)

Method Detail

asNumber	back to summary
public int asNumber() Get the row lock type id. Returns:int row lock type id

asNumber

back to summary

public int asNumber()

Get the row lock type id.

Returns:int: row lock type id

valueOf	back to summary
public static FilterParams.RowLock valueOf(String name)

values	back to summary
public static FilterParams.RowLock[] values()

com.mysql.cj.xdevapi back to summary

public final Enum FilterParams.RowLockOptions

Class Inheritance

extends Enum<FilterParams.RowLockOptions>

java.lang.Object
java.lang.Enum
com.mysql.cj.xdevapi.FilterParams.RowLockOptions

Options that define the behavior while retrieving locked rows.

Field Summary

Modifier and Type	Field and Description
public static final FilterParams.RowLockOptions	NOWAIT Do not wait to acquire row lock, fail with an error if a requested row is locked.
private int	rowLockOption
public static final FilterParams.RowLockOptions	SKIP_LOCKED Do not wait to acquire a row lock, remove locked rows from the result set.

Constructor Summary

Access	Constructor and Description
private	RowLockOptions(int rowLockOption)

Method Summary

Modifier and Type	Method and Description
public int	Returns: row lock option id asNumber() Get the row lock option id.
public static FilterParams.RowLockOptions	valueOf(String name)
public static FilterParams.RowLockOptions[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

NOWAIT	back to summary
public static final FilterParams.RowLockOptions NOWAIT Do not wait to acquire row lock, fail with an error if a requested row is locked.

rowLockOption	back to summary
private int rowLockOption

SKIP_LOCKED	back to summary
public static final FilterParams.RowLockOptions SKIP_LOCKED Do not wait to acquire a row lock, remove locked rows from the result set.

Constructor Detail

RowLockOptions	back to summary
private RowLockOptions(int rowLockOption)

Method Detail

asNumber	back to summary
public int asNumber() Get the row lock option id. Returns:int row lock option id

asNumber

back to summary

public int asNumber()

Get the row lock option id.

Returns:int: row lock option id

valueOf	back to summary
public static FilterParams.RowLockOptions valueOf(String name)

values	back to summary
public static FilterParams.RowLockOptions[] values()

public Interface FilterParams

Nested and Inner Type Summary

Method Summary

Method Detail

public final Enum FilterParams.RowLock

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Enum FilterParams.RowLockOptions

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail