Table of Contents

Class CloudQueryRequest

Namespace
Excalibur.Data.CloudNative
Assembly
Excalibur.Data.Abstractions.dll

Describes one page of a partition-scoped cloud-native query.

public sealed class CloudQueryRequest
Inheritance
CloudQueryRequest
Inherited Members

Remarks

This type exists so that a query can be resumed. The provider returns a ContinuationToken when more results remain, and that token is handed back through ContinuationToken to fetch the next page — the same shape the underlying vendor SDKs use.

It also keeps the query surface to two parameters. Passing the query, partition key, parameters, consistency options and continuation positionally would exceed the contract's parameter budget and make every future addition another breaking change.

Properties

ConsistencyOptions

Gets the consistency options for this query.

public IConsistencyOptions? ConsistencyOptions { get; init; }

Property Value

IConsistencyOptions

The consistency options, or null to use the provider's default.

ContinuationToken

Gets the continuation token that resumes a previous page.

public string? ContinuationToken { get; init; }

Property Value

string

A token taken from a prior ContinuationToken, or null to start from the first page.

Remarks

The token is opaque and is only meaningful to the provider that issued it. A provider given a token it did not issue throws ArgumentException — it never ignores one, because silently restarting at page one would return the first page forever while a paging loop appeared to make progress.

MaxItemCount

Gets the maximum number of documents to return in this page.

public int? MaxItemCount { get; init; }

Property Value

int?

The page size, or null to let the provider choose.

Remarks

This bounds how much the caller must hold in memory at once. It does not bound the result set: when a page is capped, the remainder is reached through ContinuationToken, so a caller that keeps paging still sees every document.

Every provider honours it. An earlier revision of this contract allowed a provider to refuse a page size instead, which made a caller bounding its own memory work against some providers and throw against others — the caller could not write one correct loop, and there was no way to ask in advance which it had.

Parameters

Gets the query parameters, if the query text is parameterized.

public IDictionary<string, object>? Parameters { get; init; }

Property Value

IDictionary<string, object>

The parameter values, or null when the query takes none.

PartitionKey

Gets the partition to query within.

public required IPartitionKey PartitionKey { get; init; }

Property Value

IPartitionKey

The partition key that scopes the query.

QueryText

Gets the query text, in the provider's own query syntax.

public required string QueryText { get; init; }

Property Value

string

The provider-specific query text.