Query class

Class representing CosmosDB SQL query.

Inheritance
Implemented types

Constructors

Query(String command, {int? maxCount, PartitionKey? partitionKey, Map<String, dynamic>? params})
Builds a new CosmosDB SQL query with command and params.

Properties

command → String
The query's SQL command.
final
continuation → String
Continuation token provided by CosmosDB.
no setterinherited
hashCode → int
The hash code for this object.
no setterinherited
id → String
The document's id.
no setter
maxCount → int
Maximum items per page.
finalinherited
partitionKey → PartitionKey
The partition where the query should be executed; by default, the query will be executed against all partitions.
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

crossPartition() → void
Force the query to execute in all partitions.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
onPartition(PartitionKey partitionKey) → void
Restrict the query to the partition identified by partitionKey.
toJson() → Map<String, dynamic>
Serializes this instance to a JSON object.
override
toString() → String
A string representation of this object.
inherited
withParam(String name, dynamic value) → void
Registers a paramater/value to the query.

Operators

operator ==(Object other) → bool
The equality operator.
inherited