Top Description Methods
com.mysql.cj.xdevapi

public Interface FindStatement

extends Statement<FindStatement, DocResult>
Known Direct Implementers
com.mysql.cj.xdevapi.FindStatementImpl

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

Method Summary

Modifier and TypeMethod and Description
public FindStatement

Returns:

FindStatement
fields
(String...
projection expression
projections
)

Add/replace the field projections defining the result.

public FindStatement

Returns:

FindStatement
fields
(Expression
projection expression
docProjection
)

Add/replace the field projection defining the result.

public FindStatement

Returns:

FindStatement
groupBy
(String...
groupBy expression
groupBy
)

Add/replace the aggregation fields for this query.

public FindStatement

Returns:

FindStatement
having
(String
having expression
having
)

Add/replace the aggregate criteria for this query.

public FindStatement

Returns:

FindStatement
limit
(long
limit
numberOfRows
)

Add/replace the document limit for this query.

public FindStatement

Returns:

FindStatement
lockExclusive
()

Locks matching rows exclusively so no other transactions can read or write to them.

public FindStatement

Returns:

FindStatement
lockExclusive
(Statement.LockContention lockContention)

Locks matching rows exclusively so no other transactions can read or write to them, using the provided lock contention option.

public FindStatement

Returns:

FindStatement
lockShared
()

Locks matching rows against updates.

public FindStatement

Returns:

FindStatement
lockShared
(Statement.LockContention lockContention)

Locks matching rows against updates using the provided lock contention option.

public FindStatement

Returns:

FindStatement
offset
(long
number of documents to skip
limitOffset
)

Add/replace the document offset for this query.

public FindStatement

Returns:

FindStatement
orderBy
(String...
sort expression
sortFields
)

Add/replace the order specification for this query.

public default FindStatement

Returns:

FindStatement
skip
(long
number of documents to skip
limitOffset
)
Deprecated Deprecated in c/J 8.0.12, please use offset(long) instead.

Add/replace the document offset for this query.

public FindStatement

Returns:

FindStatement
sort
(String...
sort expression
sortFields
)

Add/replace the order specification for this query.

Inherited from com.mysql.cj.xdevapi.Statement:
bindbindbindbindclearBindingsexecuteexecuteAsync

Method Detail

fieldsback to summary
public FindStatement fields(String... projections)

Add/replace the field projections defining the result.

Parameters
projections:String[]

projection expression

Returns:FindStatement

FindStatement

fieldsback to summary
public FindStatement fields(Expression docProjection)

Add/replace the field projection defining the result.

Parameters
docProjection:Expression

projection expression

Returns:FindStatement

FindStatement

groupByback to summary
public FindStatement groupBy(String... groupBy)

Add/replace the aggregation fields for this query.

Parameters
groupBy:String[]

groupBy expression

Returns:FindStatement

FindStatement

havingback to summary
public FindStatement having(String having)

Add/replace the aggregate criteria for this query.

Parameters
having:String

having expression

Returns:FindStatement

FindStatement

limitback to summary
public FindStatement limit(long numberOfRows)

Add/replace the document limit for this query.

Parameters
numberOfRows:long

limit

Returns:FindStatement

FindStatement

lockExclusiveback to summary
public FindStatement lockExclusive()

Locks matching rows exclusively so no other transactions can read or write to them.

Returns:FindStatement

FindStatement

lockExclusiveback to summary
public FindStatement lockExclusive(Statement.LockContention lockContention)

Locks matching rows exclusively so no other transactions can read or write to them, using the provided lock contention option.

Parameters
lockContention:Statement.LockContention

The com.mysql.cj.xdevapi.Statement.LockContention value to set.

Returns:FindStatement

FindStatement

lockSharedback to summary
public FindStatement lockShared()

Locks matching rows against updates.

Returns:FindStatement

FindStatement

lockSharedback to summary
public FindStatement lockShared(Statement.LockContention lockContention)

Locks matching rows against updates using the provided lock contention option.

Parameters
lockContention:Statement.LockContention

The com.mysql.cj.xdevapi.Statement.LockContention value to set.

Returns:FindStatement

FindStatement

offsetback to summary
public FindStatement offset(long limitOffset)

Add/replace the document offset for this query.

Parameters
limitOffset:long

number of documents to skip

Returns:FindStatement

FindStatement

orderByback to summary
public FindStatement orderBy(String... sortFields)

Add/replace the order specification for this query.

Parameters
sortFields:String[]

sort expression

Returns:FindStatement

FindStatement

skipback to summary
public default FindStatement skip(long limitOffset)

Deprecated

Deprecated in c/J 8.0.12, please use offset(long) instead.

Add/replace the document offset for this query.

Parameters
limitOffset:long

number of documents to skip

Returns:FindStatement

FindStatement

Annotations
@Deprecated
sortback to summary
public FindStatement sort(String... sortFields)

Add/replace the order specification for this query.

Synonym for orderBy(String...)

Parameters
sortFields:String[]

sort expression

Returns:FindStatement

FindStatement