@azure/cosmos
Version:
Microsoft Azure Cosmos DB Service Node.js SDK for NOSQL API
69 lines • 3.63 kB
JavaScript
;
Object.defineProperty(exports, "__esModule", { value: true });
exports.QueryTypes = void 0;
exports.rejectContinuationTokenForUnsupportedQueries = rejectContinuationTokenForUnsupportedQueries;
// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
const ErrorResponse_js_1 = require("../request/ErrorResponse.js");
/**
* Rejects continuation token usage for unsupported query types
* @param continuationToken - The continuation token if provided
* @param unsupportedQueryTypes - Array of query types that don't support continuation tokens
* @throws ErrorResponse if continuation token is provided for any unsupported query type
* @hidden
*/
function rejectContinuationTokenForUnsupportedQueries(continuationToken, unsupportedQueryTypes) {
if (!continuationToken) {
return;
}
// Find the first unsupported query type that is present
const conflictingQueryType = unsupportedQueryTypes.find((queryType) => queryType.isPresent);
if (conflictingQueryType) {
throw new ErrorResponse_js_1.ErrorResponse(conflictingQueryType.errorMessage);
}
}
/**
* Factory functions for creating unsupported query type descriptors
* @internal
*/
exports.QueryTypes = {
nonStreamingOrderBy: (isPresent) => ({
name: "NonStreamingOrderBy",
isPresent,
errorMessage: "Continuation tokens are not supported for non-streaming ORDER BY queries. " +
"These queries must process all results to ensure correct ordering and cannot be resumed from an intermediate state. " +
"Consider removing the continuation token and using fetchAll() instead for complete results.",
}),
groupBy: (isPresent) => ({
name: "GroupBy",
isPresent,
errorMessage: "Continuation tokens are not supported for GROUP BY queries. " +
"These queries must process all results to compute aggregations and cannot be resumed from an intermediate state. " +
"Consider removing the continuation token and using fetchAll() instead for complete results.",
}),
unorderedDistinct: (isPresent) => ({
name: "UnorderedDistinct",
isPresent,
errorMessage: "Continuation tokens are not supported for unordered DISTINCT queries. " +
"These queries require tracking large amounts of duplicate data in continuation tokens which is not practical. " +
"Consider removing the continuation token and using fetchAll() instead, or use ordered DISTINCT queries which are supported.",
}),
hybridSearch: (isPresent) => ({
name: "HybridSearch",
isPresent,
errorMessage: "Continuation tokens are not supported for hybrid search queries. " +
"Hybrid search queries require processing and ranking of all component query results " +
"to compute accurate Reciprocal Rank Fusion (RRF) scores and cannot be resumed from an intermediate state. " +
"Consider removing the continuation token and using fetchAll() instead for complete results.",
}),
// Easy to add new unsupported query types here
vectorSearch: (isPresent) => ({
name: "VectorSearch",
isPresent,
errorMessage: "Continuation tokens are not supported for vector search queries. " +
"Vector search queries require processing similarity calculations across all data " +
"and cannot be resumed from an intermediate state. " +
"Consider removing the continuation token and using fetchAll() instead for complete results.",
}),
};
//# sourceMappingURL=QueryValidationHelper.js.map