public interface BsonQueryDefinition
extends com.holonplatform.core.Expression
Modifier and Type | Interface and Description |
---|---|
static interface |
BsonQueryDefinition.Builder
Builder
|
Modifier and Type | Method and Description |
---|---|
static BsonQueryDefinition.Builder |
builder()
Get a
BsonQueryDefinition builder. |
Optional<Integer> |
getBatchSize()
Get the number of documents to return per batch.
|
Optional<com.mongodb.client.model.Collation> |
getCollation()
Get the
Collation to use. |
String |
getCollectionName()
Get the collection name to query.
|
Optional<String> |
getComment()
Get the query comment.
|
Optional<com.mongodb.CursorType> |
getCursorType()
Get the cursor type to use.
|
Optional<BsonFilterExpression> |
getFilter()
Get the query filters.
|
Optional<org.bson.conversions.Bson> |
getGroup()
Get the group id for aggregation type query.
|
Optional<BsonFilterExpression> |
getGroupFilter()
Get the filter to apply to the group stage in an aggregation type query.
|
Optional<org.bson.conversions.Bson> |
getHint()
Get the hint for which index to use.
|
Optional<Integer> |
getLimit()
Get the query results limit.
|
Optional<org.bson.conversions.Bson> |
getMax()
Get the exclusive upper bound for a specific index.
|
Optional<org.bson.conversions.Bson> |
getMin()
Get the minimum inclusive lower bound for a specific index.
|
Optional<Integer> |
getOffset()
Get the number of query results to skip.
|
Optional<org.bson.conversions.Bson> |
getSort()
Get the query sorts.
|
Optional<Long> |
getTimeout()
Get the query execution timeout, using the time unit returned by
getTimeoutUnit() . |
TimeUnit |
getTimeoutUnit()
Get the query execution timeout unit.
|
boolean |
isDistinct()
Get whether the query is configured to return distinct results.
|
boolean |
isPartial()
Whether to get partial results from a sharded cluster if one or more shards are unreachable (instead of throwing
an error).
|
boolean |
isReturnKey()
Get whether the find operation will return only the index keys in the resulting documents.
|
boolean |
isShowRecordId()
Whether to add a
$recordId field to the returned documents. |
String getCollectionName()
boolean isDistinct()
Optional<BsonFilterExpression> getFilter()
Optional<org.bson.conversions.Bson> getSort()
Optional<org.bson.conversions.Bson> getGroup()
Optional<BsonFilterExpression> getGroupFilter()
Optional<Integer> getLimit()
Optional<Integer> getOffset()
Optional<Long> getTimeout()
getTimeoutUnit()
.TimeUnit getTimeoutUnit()
Optional<com.mongodb.CursorType> getCursorType()
boolean isPartial()
true
to get partial results from a sharded cluster if one or more shards are unreachableOptional<Integer> getBatchSize()
Optional<com.mongodb.client.model.Collation> getCollation()
Collation
to use.Optional<org.bson.conversions.Bson> getHint()
Optional<org.bson.conversions.Bson> getMax()
Optional<org.bson.conversions.Bson> getMin()
boolean isReturnKey()
boolean isShowRecordId()
$recordId
field to the returned documents.true
to add a $recordId
field to the returned documentsstatic BsonQueryDefinition.Builder builder()
BsonQueryDefinition
builder.BsonQueryDefinition
builderCopyright © 2019 The Holon Platform. All rights reserved.