QueryOptions class Query
Options for Cluster.query and Scope.query.
- Inheritance
-
- Object
- CommonOptions
- QueryOptions
Constructors
-
QueryOptions({Object? parameters, QueryScanConsistency? scanConsistency, MutationState? consistentWith, bool adhoc = true, bool flexIndex = false, bool preserveExpiry = false, String? clientContextId, int? maxParallelism, int? pipelineBatch, int? pipelineCap, Duration? scanWait, int? scanCap, bool readOnly = false, QueryProfileMode profile = QueryProfileMode.off, bool metrics = false, String? queryContext, Map<
String, Object?> ? raw, Duration? timeout}) -
const
Properties
- adhoc → bool
-
Whether this is an ad-hoc query, or if it should be prepared for faster
execution in the future.
final
- clientContextId → String?
-
The client context id for this query.
final
- consistentWith → MutationState?
-
A MutationState which the query should be consistent with.
final
- flexIndex → bool
-
Whether flex-indexes should be enabled.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- maxParallelism → int?
-
The maximum parallelism for this query.
final
- metrics → bool
-
Whether metrics should be captured as part of the execution of the query.
final
- parameters → Object?
-
Values to be used for the placeholders within the query.
final
- pipelineBatch → int?
-
The pipeline batch size for this query.
final
- pipelineCap → int?
-
The pipeline capacity for this query.
final
- preserveExpiry → bool
-
Whether the query should preserve the existing document expiry times when
mutating documents.
final
- profile → QueryProfileMode
-
The level of profiling that should be used for the query.
final
- queryContext → String?
-
The context within which this query should be executed.
final
-
raw
→ Map<
String, Object?> ? -
Any additional parameters which should be passed to the query engine when
executing the query.
final
- readOnly → bool
-
Whether this query should be executed in read-only mode.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- scanCap → int?
-
The scan capacity for this query.
final
- scanConsistency → QueryScanConsistency?
-
The consistency requirements when executing the query.
final
- scanWait → Duration?
-
The scan wait time for this query.
final
- timeout → Duration?
-
The timeout for this operation.
finalinherited
Methods
-
copyWith(
{Object? parameters, QueryScanConsistency? scanConsistency, MutationState? consistentWith, bool? adhoc, bool? flexIndex, bool? preserveExpiry, String? clientContextId, int? maxParallelism, int? pipelineBatch, int? pipelineCap, Duration? scanWait, int? scanCap, bool? readOnly, QueryProfileMode? profile, bool? metrics, String? queryContext, Map< String, Object?> ? raw, Duration? timeout}) → QueryOptions - Creates a copy of this QueryOptions with the specified options updated.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited