@azure/cosmos
Version:
Microsoft Azure Cosmos DB Service Node.js SDK for NOSQL API
40 lines • 1.49 kB
TypeScript
import type { QueryRangeWithContinuationToken, BaseContinuationToken } from "./CompositeQueryContinuationToken.js";
/**
* Continuation token for order by queries.
* @hidden
*/
export interface OrderByQueryContinuationToken extends BaseContinuationToken {
/**
* Order by items for the query
*/
orderByItems: any[];
/**
* Number of items to skip in the query
*/
skipCount: number;
/**
* Document ID of the last document result
*/
documentRid: string;
/**
* Hash of the last document result for distinct order queries
* Used to ensure duplicates are not returned across continuation boundaries
*/
hashedLastResult?: string;
}
/**
* Creates an OrderByQueryContinuationToken
* @hidden
*/
export declare function createOrderByQueryContinuationToken(rangeMappings: QueryRangeWithContinuationToken[], orderByItems: any[], rid: string, skipCount: number, documentRid?: string, offset?: number, limit?: number, hashedLastResult?: string): OrderByQueryContinuationToken;
/**
* Serializes an OrderByQueryContinuationToken to a JSON string
* @hidden
*/
export declare function serializeOrderByQueryContinuationToken(token: OrderByQueryContinuationToken): string;
/**
* Deserializes a JSON string to an OrderByQueryContinuationToken
* @hidden
*/
export declare function parseOrderByQueryContinuationToken(tokenString: string): OrderByQueryContinuationToken;
//# sourceMappingURL=OrderByQueryContinuationToken.d.ts.map