Package com.mysql.cj.xdevapi

Class DocFilterParams

java.lang.Object

com.mysql.cj.xdevapi.AbstractFilterParams

com.mysql.cj.xdevapi.DocFilterParams

All Implemented Interfaces:

FilterParams

public class DocFilterParams
extends AbstractFilterParams

FilterParams implementation for Collection syntax.

Nested Class Summary

Nested classes/interfaces inherited from interface com.mysql.cj.xdevapi.FilterParams

FilterParams.RowLock, FilterParams.RowLockOptions

Field Summary

Fields inherited from class com.mysql.cj.xdevapi.AbstractFilterParams

args, collection, criteriaStr, fields, groupBy, isRelational, limit, lock, lockOption, offset, orderExpr, projection, supportsOffset

Constructor Summary

Constructors

Constructor	Description
DocFilterParams(java.lang.String schemaName, java.lang.String collectionName)	Constructor.
DocFilterParams(java.lang.String schemaName, java.lang.String collectionName, boolean supportsOffset)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	setFields(Expression docProjection)	Parse projection expressions into X Protocol Projection objects.
void	setFields(java.lang.String... projection)	Parse projection expressions into X Protocol Projection objects.

Methods inherited from class com.mysql.cj.xdevapi.AbstractFilterParams

addArg, clearArgs, getArgs, getCollection, getCriteria, getFields, getGrouping, getGroupingCriteria, getLimit, getLock, getLockOption, getOffset, getOrder, isRelational, setCriteria, setGrouping, setGroupingCriteria, setLimit, setLock, setLockOption, setOffset, setOrder, supportsOffset, verifyAllArgsBound

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

DocFilterParams

public DocFilterParams(java.lang.String schemaName, java.lang.String collectionName)

Constructor.

Parameters:

schemaName - Schema name

collectionName - Collection name

DocFilterParams

public DocFilterParams(java.lang.String schemaName, java.lang.String collectionName, boolean supportsOffset)

Constructor.

Parameters:

schemaName - Schema name

collectionName - Collection name

supportsOffset - Whether OFFSET is supported or not

Method Details

setFields

public void setFields(Expression docProjection)

Parse projection expressions into X Protocol Projection objects.

Parameters:

docProjection - projection expression

setFields

public void setFields(java.lang.String... projection)

Description copied from interface: FilterParams

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();
 

Specified by:

setFields in interface FilterParams

Specified by:

setFields in class AbstractFilterParams

Parameters:

projection - projection expression