@azure/cosmos 4.3.0 → 4.4.0

package/dist/browser/queryExecutionContext/pipelinedQueryExecutionContext.js

@@ -0,0 +1,174 @@
+import { ErrorResponse } from "../request/ErrorResponse.js";
+import { OffsetLimitEndpointComponent } from "./EndpointComponent/OffsetLimitEndpointComponent.js";
+import { OrderByEndpointComponent } from "./EndpointComponent/OrderByEndpointComponent.js";
+import { OrderedDistinctEndpointComponent } from "./EndpointComponent/OrderedDistinctEndpointComponent.js";
+import { UnorderedDistinctEndpointComponent } from "./EndpointComponent/UnorderedDistinctEndpointComponent.js";
+import { GroupByEndpointComponent } from "./EndpointComponent/GroupByEndpointComponent.js";
+import { getInitialHeader, mergeHeaders } from "./headerUtils.js";
+import { OrderByQueryExecutionContext } from "./orderByQueryExecutionContext.js";
+import { ParallelQueryExecutionContext } from "./parallelQueryExecutionContext.js";
+import { GroupByValueEndpointComponent } from "./EndpointComponent/GroupByValueEndpointComponent.js";
+import { NonStreamingOrderByDistinctEndpointComponent } from "./EndpointComponent/NonStreamingOrderByDistinctEndpointComponent.js";
+import { NonStreamingOrderByEndpointComponent } from "./EndpointComponent/NonStreamingOrderByEndpointComponent.js";
+/** @hidden */
+export class PipelinedQueryExecutionContext {
+    constructor(clientContext, collectionLink, query, options, partitionedQueryExecutionInfo, correlatedActivityId, emitRawOrderByPayload = false) {
+        this.clientContext = clientContext;
+        this.collectionLink = collectionLink;
+        this.query = query;
+        this.options = options;
+        this.partitionedQueryExecutionInfo = partitionedQueryExecutionInfo;
+        this.emitRawOrderByPayload = emitRawOrderByPayload;
+        this.vectorSearchBufferSize = 0;
+        this.nonStreamingOrderBy = false;
+        this.endpoint = null;
+        this.pageSize = options["maxItemCount"];
+        if (this.pageSize === undefined) {
+            this.pageSize = PipelinedQueryExecutionContext.DEFAULT_PAGE_SIZE;
+        }
+        // Pick between Nonstreaming and streaming endpoints
+        this.nonStreamingOrderBy = partitionedQueryExecutionInfo.queryInfo.hasNonStreamingOrderBy;
+        // Pick between parallel vs order by execution context
+        const sortOrders = partitionedQueryExecutionInfo.queryInfo.orderBy;
+        // TODO: Currently we don't get any field from backend to determine streaming queries
+        if (this.nonStreamingOrderBy) {
+            if (!options.allowUnboundedNonStreamingQueries) {
+                this.checkQueryConstraints(partitionedQueryExecutionInfo.queryInfo);
+            }
+            this.vectorSearchBufferSize = this.calculateVectorSearchBufferSize(partitionedQueryExecutionInfo.queryInfo, options);
+            const maxBufferSize = options["vectorSearchBufferSize"]
+                ? options["vectorSearchBufferSize"]
+                : PipelinedQueryExecutionContext.DEFAULT_MAX_VECTOR_SEARCH_BUFFER_SIZE;
+            if (this.vectorSearchBufferSize > maxBufferSize) {
+                throw new ErrorResponse(`Executing a vector search query with TOP or OFFSET + LIMIT value ${this.vectorSearchBufferSize} larger than the vectorSearchBufferSize ${maxBufferSize} ` +
+                    `is not allowed`);
+            }
+            const distinctType = partitionedQueryExecutionInfo.queryInfo.distinctType;
+            const context = new ParallelQueryExecutionContext(this.clientContext, this.collectionLink, this.query, this.options, this.partitionedQueryExecutionInfo, correlatedActivityId);
+            if (distinctType === "None") {
+                this.endpoint = new NonStreamingOrderByEndpointComponent(context, sortOrders, this.vectorSearchBufferSize, partitionedQueryExecutionInfo.queryInfo.offset, this.emitRawOrderByPayload);
+            }
+            else {
+                this.endpoint = new NonStreamingOrderByDistinctEndpointComponent(context, partitionedQueryExecutionInfo.queryInfo, this.vectorSearchBufferSize, this.emitRawOrderByPayload);
+            }
+        }
+        else {
+            if (Array.isArray(sortOrders) && sortOrders.length > 0) {
+                // Need to wrap orderby execution context in endpoint component, since the data is nested as a \
+                //      "payload" property.
+                this.endpoint = new OrderByEndpointComponent(new OrderByQueryExecutionContext(this.clientContext, this.collectionLink, this.query, this.options, this.partitionedQueryExecutionInfo, correlatedActivityId), this.emitRawOrderByPayload);
+            }
+            else {
+                this.endpoint = new ParallelQueryExecutionContext(this.clientContext, this.collectionLink, this.query, this.options, this.partitionedQueryExecutionInfo, correlatedActivityId);
+            }
+            if (Object.keys(partitionedQueryExecutionInfo.queryInfo.groupByAliasToAggregateType).length >
+                0 ||
+                partitionedQueryExecutionInfo.queryInfo.aggregates.length > 0 ||
+                partitionedQueryExecutionInfo.queryInfo.groupByExpressions.length > 0) {
+                if (partitionedQueryExecutionInfo.queryInfo.hasSelectValue) {
+                    this.endpoint = new GroupByValueEndpointComponent(this.endpoint, partitionedQueryExecutionInfo.queryInfo);
+                }
+                else {
+                    this.endpoint = new GroupByEndpointComponent(this.endpoint, partitionedQueryExecutionInfo.queryInfo);
+                }
+            }
+            // If distinct then add that to the pipeline
+            const distinctType = partitionedQueryExecutionInfo.queryInfo.distinctType;
+            if (distinctType === "Ordered") {
+                this.endpoint = new OrderedDistinctEndpointComponent(this.endpoint);
+            }
+            if (distinctType === "Unordered") {
+                this.endpoint = new UnorderedDistinctEndpointComponent(this.endpoint);
+            }
+            // If top then add that to the pipeline. TOP N is effectively OFFSET 0 LIMIT N
+            const top = partitionedQueryExecutionInfo.queryInfo.top;
+            if (typeof top === "number") {
+                this.endpoint = new OffsetLimitEndpointComponent(this.endpoint, 0, top);
+            }
+            // If offset+limit then add that to the pipeline
+            const limit = partitionedQueryExecutionInfo.queryInfo.limit;
+            const offset = partitionedQueryExecutionInfo.queryInfo.offset;
+            if (typeof limit === "number" && typeof offset === "number") {
+                this.endpoint = new OffsetLimitEndpointComponent(this.endpoint, offset, limit);
+            }
+        }
+        this.fetchBuffer = [];
+    }
+    hasMoreResults() {
+        return this.fetchBuffer.length !== 0 || this.endpoint.hasMoreResults();
+    }
+    async fetchMore(diagnosticNode) {
+        this.fetchMoreRespHeaders = getInitialHeader();
+        return this._fetchMoreImplementation(diagnosticNode);
+    }
+    async _fetchMoreImplementation(diagnosticNode) {
+        try {
+            if (this.fetchBuffer.length >= this.pageSize) {
+                const temp = this.fetchBuffer.slice(0, this.pageSize);
+                this.fetchBuffer = this.fetchBuffer.slice(this.pageSize);
+                return { result: temp, headers: this.fetchMoreRespHeaders };
+            }
+            else {
+                const response = await this.endpoint.fetchMore(diagnosticNode);
+                mergeHeaders(this.fetchMoreRespHeaders, response.headers);
+                if (response === undefined || response.result === undefined) {
+                    if (this.fetchBuffer.length > 0) {
+                        const temp = this.fetchBuffer;
+                        this.fetchBuffer = [];
+                        return { result: temp, headers: this.fetchMoreRespHeaders };
+                    }
+                    else {
+                        return { result: undefined, headers: this.fetchMoreRespHeaders };
+                    }
+                }
+                this.fetchBuffer.push(...response.result);
+                if (this.options.enableQueryControl) {
+                    if (this.fetchBuffer.length >= this.pageSize) {
+                        const temp = this.fetchBuffer.slice(0, this.pageSize);
+                        this.fetchBuffer = this.fetchBuffer.slice(this.pageSize);
+                        return { result: temp, headers: this.fetchMoreRespHeaders };
+                    }
+                    else {
+                        const temp = this.fetchBuffer;
+                        this.fetchBuffer = [];
+                        return { result: temp, headers: this.fetchMoreRespHeaders };
+                    }
+                }
+                // Recursively fetch more results to ensure the pageSize number of results are returned
+                // to maintain compatibility with the previous implementation
+                return this._fetchMoreImplementation(diagnosticNode);
+            }
+        }
+        catch (err) {
+            mergeHeaders(this.fetchMoreRespHeaders, err.headers);
+            err.headers = this.fetchMoreRespHeaders;
+            if (err) {
+                throw err;
+            }
+        }
+    }
+    calculateVectorSearchBufferSize(queryInfo, options) {
+        if (queryInfo.top === 0 || queryInfo.limit === 0)
+            return 0;
+        return queryInfo.top
+            ? queryInfo.top
+            : queryInfo.limit
+                ? queryInfo.offset + queryInfo.limit
+                : options["vectorSearchBufferSize"] && options["vectorSearchBufferSize"] > 0
+                    ? options["vectorSearchBufferSize"]
+                    : PipelinedQueryExecutionContext.DEFAULT_MAX_VECTOR_SEARCH_BUFFER_SIZE;
+    }
+    checkQueryConstraints(queryInfo) {
+        const hasTop = queryInfo.top || queryInfo.top === 0;
+        const hasLimit = queryInfo.limit || queryInfo.limit === 0;
+        if (!hasTop && !hasLimit) {
+            throw new ErrorResponse("Executing a non-streaming search query without TOP or LIMIT can consume a large number of RUs " +
+                "very fast and have long runtimes. Please ensure you are using one of the above two filters " +
+                "with your vector search query.");
+        }
+        return;
+    }
+}
+PipelinedQueryExecutionContext.DEFAULT_PAGE_SIZE = 10;
+PipelinedQueryExecutionContext.DEFAULT_MAX_VECTOR_SEARCH_BUFFER_SIZE = 50000;
+//# sourceMappingURL=pipelinedQueryExecutionContext.js.map

package/dist/browser/queryExecutionContext/pipelinedQueryExecutionContext.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"pipelinedQueryExecutionContext.js","sourceRoot":"","sources":["../../../src/queryExecutionContext/pipelinedQueryExecutionContext.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,aAAa,EAAE,MAAM,6BAA6B,CAAC;AAE5D,OAAO,EAAE,4BAA4B,EAAE,MAAM,qDAAqD,CAAC;AACnG,OAAO,EAAE,wBAAwB,EAAE,MAAM,iDAAiD,CAAC;AAC3F,OAAO,EAAE,gCAAgC,EAAE,MAAM,yDAAyD,CAAC;AAC3G,OAAO,EAAE,kCAAkC,EAAE,MAAM,2DAA2D,CAAC;AAC/G,OAAO,EAAE,wBAAwB,EAAE,MAAM,iDAAiD,CAAC;AAE3F,OAAO,EAAE,gBAAgB,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAClE,OAAO,EAAE,4BAA4B,EAAE,MAAM,mCAAmC,CAAC;AACjF,OAAO,EAAE,6BAA6B,EAAE,MAAM,oCAAoC,CAAC;AACnF,OAAO,EAAE,6BAA6B,EAAE,MAAM,sDAAsD,CAAC;AAGrG,OAAO,EAAE,4CAA4C,EAAE,MAAM,qEAAqE,CAAC;AACnI,OAAO,EAAE,oCAAoC,EAAE,MAAM,6DAA6D,CAAC;AAEnH,cAAc;AACd,MAAM,OAAO,8BAA8B;IAUzC,YACU,aAA4B,EAC5B,cAAsB,EACtB,KAA4B,EAC5B,OAAoB,EACpB,6BAA4D,EACpE,oBAA4B,EACpB,wBAAiC,KAAK;QANtC,kBAAa,GAAb,aAAa,CAAe;QAC5B,mBAAc,GAAd,cAAc,CAAQ;QACtB,UAAK,GAAL,KAAK,CAAuB;QAC5B,YAAO,GAAP,OAAO,CAAa;QACpB,kCAA6B,GAA7B,6BAA6B,CAA+B;QAE5D,0BAAqB,GAArB,qBAAqB,CAAiB;QAZxC,2BAAsB,GAAW,CAAC,CAAC;QAGnC,wBAAmB,GAAG,KAAK,CAAC;QAWlC,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;QACrB,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC;QACxC,IAAI,IAAI,CAAC,QAAQ,KAAK,SAAS,EAAE,CAAC;YAChC,IAAI,CAAC,QAAQ,GAAG,8BAA8B,CAAC,iBAAiB,CAAC;QACnE,CAAC;QACD,oDAAoD;QACpD,IAAI,CAAC,mBAAmB,GAAG,6BAA6B,CAAC,SAAS,CAAC,sBAAsB,CAAC;QAE1F,sDAAsD;QACtD,MAAM,UAAU,GAAG,6BAA6B,CAAC,SAAS,CAAC,OAAO,CAAC;QACnE,qFAAqF;QACrF,IAAI,IAAI,CAAC,mBAAmB,EAAE,CAAC;YAC7B,IAAI,CAAC,OAAO,CAAC,iCAAiC,EAAE,CAAC;gBAC/C,IAAI,CAAC,qBAAqB,CAAC,6BAA6B,CAAC,SAAS,CAAC,CAAC;YACtE,CAAC;YAED,IAAI,CAAC,sBAAsB,GAAG,IAAI,CAAC,+BAA+B,CAChE,6BAA6B,CAAC,SAAS,EACvC,OAAO,CACR,CAAC;YACF,MAAM,aAAa,GAAG,OAAO,CAAC,wBAAwB,CAAC;gBACrD,CAAC,CAAC,OAAO,CAAC,wBAAwB,CAAC;gBACnC,CAAC,CAAC,8BAA8B,CAAC,qCAAqC,CAAC;YAEzE,IAAI,IAAI,CAAC,sBAAsB,GAAG,aAAa,EAAE,CAAC;gBAChD,MAAM,IAAI,aAAa,CACrB,oEAAoE,IAAI,CAAC,sBAAsB,2CAA2C,aAAa,GAAG;oBACxJ,gBAAgB,CACnB,CAAC;YACJ,CAAC;YAED,MAAM,YAAY,GAAG,6BAA6B,CAAC,SAAS,CAAC,YAAY,CAAC;YAC1E,MAAM,OAAO,GAAqB,IAAI,6BAA6B,CACjE,IAAI,CAAC,aAAa,EAClB,IAAI,CAAC,cAAc,EACnB,IAAI,CAAC,KAAK,EACV,IAAI,CAAC,OAAO,EACZ,IAAI,CAAC,6BAA6B,EAClC,oBAAoB,CACrB,CAAC;YAEF,IAAI,YAAY,KAAK,MAAM,EAAE,CAAC;gBAC5B,IAAI,CAAC,QAAQ,GAAG,IAAI,oCAAoC,CACtD,OAAO,EACP,UAAU,EACV,IAAI,CAAC,sBAAsB,EAC3B,6BAA6B,CAAC,SAAS,CAAC,MAAM,EAC9C,IAAI,CAAC,qBAAqB,CAC3B,CAAC;YACJ,CAAC;iBAAM,CAAC;gBACN,IAAI,CAAC,QAAQ,GAAG,IAAI,4CAA4C,CAC9D,OAAO,EACP,6BAA6B,CAAC,SAAS,EACvC,IAAI,CAAC,sBAAsB,EAC3B,IAAI,CAAC,qBAAqB,CAC3B,CAAC;YACJ,CAAC;QACH,CAAC;aAAM,CAAC;YACN,IAAI,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,IAAI,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBACvD,gGAAgG;gBAChG,2BAA2B;gBAC3B,IAAI,CAAC,QAAQ,GAAG,IAAI,wBAAwB,CAC1C,IAAI,4BAA4B,CAC9B,IAAI,CAAC,aAAa,EAClB,IAAI,CAAC,cAAc,EACnB,IAAI,CAAC,KAAK,EACV,IAAI,CAAC,OAAO,EACZ,IAAI,CAAC,6BAA6B,EAClC,oBAAoB,CACrB,EACD,IAAI,CAAC,qBAAqB,CAC3B,CAAC;YACJ,CAAC;iBAAM,CAAC;gBACN,IAAI,CAAC,QAAQ,GAAG,IAAI,6BAA6B,CAC/C,IAAI,CAAC,aAAa,EAClB,IAAI,CAAC,cAAc,EACnB,IAAI,CAAC,KAAK,EACV,IAAI,CAAC,OAAO,EACZ,IAAI,CAAC,6BAA6B,EAClC,oBAAoB,CACrB,CAAC;YACJ,CAAC;YACD,IACE,MAAM,CAAC,IAAI,CAAC,6BAA6B,CAAC,SAAS,CAAC,2BAA2B,CAAC,CAAC,MAAM;gBACrF,CAAC;gBACH,6BAA6B,CAAC,SAAS,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC;gBAC7D,6BAA6B,CAAC,SAAS,CAAC,kBAAkB,CAAC,MAAM,GAAG,CAAC,EACrE,CAAC;gBACD,IAAI,6BAA6B,CAAC,SAAS,CAAC,cAAc,EAAE,CAAC;oBAC3D,IAAI,CAAC,QAAQ,GAAG,IAAI,6BAA6B,CAC/C,IAAI,CAAC,QAAQ,EACb,6BAA6B,CAAC,SAAS,CACxC,CAAC;gBACJ,CAAC;qBAAM,CAAC;oBACN,IAAI,CAAC,QAAQ,GAAG,IAAI,wBAAwB,CAC1C,IAAI,CAAC,QAAQ,EACb,6BAA6B,CAAC,SAAS,CACxC,CAAC;gBACJ,CAAC;YACH,CAAC;YAED,4CAA4C;YAC5C,MAAM,YAAY,GAAG,6BAA6B,CAAC,SAAS,CAAC,YAAY,CAAC;YAC1E,IAAI,YAAY,KAAK,SAAS,EAAE,CAAC;gBAC/B,IAAI,CAAC,QAAQ,GAAG,IAAI,gCAAgC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YACtE,CAAC;YACD,IAAI,YAAY,KAAK,WAAW,EAAE,CAAC;gBACjC,IAAI,CAAC,QAAQ,GAAG,IAAI,kCAAkC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YACxE,CAAC;YAED,8EAA8E;YAC9E,MAAM,GAAG,GAAG,6BAA6B,CAAC,SAAS,CAAC,GAAG,CAAC;YACxD,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;gBAC5B,IAAI,CAAC,QAAQ,GAAG,IAAI,4BAA4B,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,EAAE,GAAG,CAAC,CAAC;YAC1E,CAAC;YAED,gDAAgD;YAChD,MAAM,KAAK,GAAG,6BAA6B,CAAC,SAAS,CAAC,KAAK,CAAC;YAC5D,MAAM,MAAM,GAAG,6BAA6B,CAAC,SAAS,CAAC,MAAM,CAAC;YAC9D,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE,CAAC;gBAC5D,IAAI,CAAC,QAAQ,GAAG,IAAI,4BAA4B,CAAC,IAAI,CAAC,QAAQ,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC;YACjF,CAAC;QACH,CAAC;QACD,IAAI,CAAC,WAAW,GAAG,EAAE,CAAC;IACxB,CAAC;IAEM,cAAc;QACnB,OAAO,IAAI,CAAC,WAAW,CAAC,MAAM,KAAK,CAAC,IAAI,IAAI,CAAC,QAAQ,CAAC,cAAc,EAAE,CAAC;IACzE,CAAC;IAEM,KAAK,CAAC,SAAS,CAAC,cAAsC;QAC3D,IAAI,CAAC,oBAAoB,GAAG,gBAAgB,EAAE,CAAC;QAC/C,OAAO,IAAI,CAAC,wBAAwB,CAAC,cAAc,CAAC,CAAC;IACvD,CAAC;IAEO,KAAK,CAAC,wBAAwB,CACpC,cAAsC;QAEtC,IAAI,CAAC;YACH,IAAI,IAAI,CAAC,WAAW,CAAC,MAAM,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;gBAC7C,MAAM,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;gBACtD,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;gBACzD,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,CAAC,oBAAoB,EAAE,CAAC;YAC9D,CAAC;iBAAM,CAAC;gBACN,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,cAAc,CAAC,CAAC;gBAC/D,YAAY,CAAC,IAAI,CAAC,oBAAoB,EAAE,QAAQ,CAAC,OAAO,CAAC,CAAC;gBAC1D,IAAI,QAAQ,KAAK,SAAS,IAAI,QAAQ,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;oBAC5D,IAAI,IAAI,CAAC,WAAW,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;wBAChC,MAAM,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC;wBAC9B,IAAI,CAAC,WAAW,GAAG,EAAE,CAAC;wBACtB,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,CAAC,oBAAoB,EAAE,CAAC;oBAC9D,CAAC;yBAAM,CAAC;wBACN,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,OAAO,EAAE,IAAI,CAAC,oBAAoB,EAAE,CAAC;oBACnE,CAAC;gBACH,CAAC;gBACD,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC;gBAE1C,IAAI,IAAI,CAAC,OAAO,CAAC,kBAAkB,EAAE,CAAC;oBACpC,IAAI,IAAI,CAAC,WAAW,CAAC,MAAM,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;wBAC7C,MAAM,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;wBACtD,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;wBACzD,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,CAAC,oBAAoB,EAAE,CAAC;oBAC9D,CAAC;yBAAM,CAAC;wBACN,MAAM,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC;wBAC9B,IAAI,CAAC,WAAW,GAAG,EAAE,CAAC;wBACtB,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,CAAC,oBAAoB,EAAE,CAAC;oBAC9D,CAAC;gBACH,CAAC;gBACD,uFAAuF;gBACvF,6DAA6D;gBAC7D,OAAO,IAAI,CAAC,wBAAwB,CAAC,cAAc,CAAC,CAAC;YACvD,CAAC;QACH,CAAC;QAAC,OAAO,GAAQ,EAAE,CAAC;YAClB,YAAY,CAAC,IAAI,CAAC,oBAAoB,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC;YACrD,GAAG,CAAC,OAAO,GAAG,IAAI,CAAC,oBAAoB,CAAC;YACxC,IAAI,GAAG,EAAE,CAAC;gBACR,MAAM,GAAG,CAAC;YACZ,CAAC;QACH,CAAC;IACH,CAAC;IAEO,+BAA+B,CAAC,SAAoB,EAAE,OAAoB;QAChF,IAAI,SAAS,CAAC,GAAG,KAAK,CAAC,IAAI,SAAS,CAAC,KAAK,KAAK,CAAC;YAAE,OAAO,CAAC,CAAC;QAC3D,OAAO,SAAS,CAAC,GAAG;YAClB,CAAC,CAAC,SAAS,CAAC,GAAG;YACf,CAAC,CAAC,SAAS,CAAC,KAAK;gBACf,CAAC,CAAC,SAAS,CAAC,MAAM,GAAG,SAAS,CAAC,KAAK;gBACpC,CAAC,CAAC,OAAO,CAAC,wBAAwB,CAAC,IAAI,OAAO,CAAC,wBAAwB,CAAC,GAAG,CAAC;oBAC1E,CAAC,CAAC,OAAO,CAAC,wBAAwB,CAAC;oBACnC,CAAC,CAAC,8BAA8B,CAAC,qCAAqC,CAAC;IAC/E,CAAC;IAEO,qBAAqB,CAAC,SAAoB;QAChD,MAAM,MAAM,GAAG,SAAS,CAAC,GAAG,IAAI,SAAS,CAAC,GAAG,KAAK,CAAC,CAAC;QACpD,MAAM,QAAQ,GAAG,SAAS,CAAC,KAAK,IAAI,SAAS,CAAC,KAAK,KAAK,CAAC,CAAC;QAC1D,IAAI,CAAC,MAAM,IAAI,CAAC,QAAQ,EAAE,CAAC;YACzB,MAAM,IAAI,aAAa,CACrB,gGAAgG;gBAC9F,6FAA6F;gBAC7F,gCAAgC,CACnC,CAAC;QACJ,CAAC;QACD,OAAO;IACT,CAAC;;AAxNc,gDAAiB,GAAG,EAAE,AAAL,CAAM;AACvB,oEAAqC,GAAG,KAAK,AAAR,CAAS","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\nimport type { ClientContext } from \"../ClientContext.js\";\nimport type { Response, FeedOptions } from \"../request/index.js\";\nimport type { PartitionedQueryExecutionInfo, QueryInfo } from \"../request/ErrorResponse.js\";\nimport { ErrorResponse } from \"../request/ErrorResponse.js\";\nimport type { CosmosHeaders } from \"./CosmosHeaders.js\";\nimport { OffsetLimitEndpointComponent } from \"./EndpointComponent/OffsetLimitEndpointComponent.js\";\nimport { OrderByEndpointComponent } from \"./EndpointComponent/OrderByEndpointComponent.js\";\nimport { OrderedDistinctEndpointComponent } from \"./EndpointComponent/OrderedDistinctEndpointComponent.js\";\nimport { UnorderedDistinctEndpointComponent } from \"./EndpointComponent/UnorderedDistinctEndpointComponent.js\";\nimport { GroupByEndpointComponent } from \"./EndpointComponent/GroupByEndpointComponent.js\";\nimport type { ExecutionContext } from \"./ExecutionContext.js\";\nimport { getInitialHeader, mergeHeaders } from \"./headerUtils.js\";\nimport { OrderByQueryExecutionContext } from \"./orderByQueryExecutionContext.js\";\nimport { ParallelQueryExecutionContext } from \"./parallelQueryExecutionContext.js\";\nimport { GroupByValueEndpointComponent } from \"./EndpointComponent/GroupByValueEndpointComponent.js\";\nimport type { SqlQuerySpec } from \"./SqlQuerySpec.js\";\nimport type { DiagnosticNodeInternal } from \"../diagnostics/DiagnosticNodeInternal.js\";\nimport { NonStreamingOrderByDistinctEndpointComponent } from \"./EndpointComponent/NonStreamingOrderByDistinctEndpointComponent.js\";\nimport { NonStreamingOrderByEndpointComponent } from \"./EndpointComponent/NonStreamingOrderByEndpointComponent.js\";\n\n/** @hidden */\nexport class PipelinedQueryExecutionContext implements ExecutionContext {\n  private fetchBuffer: any[];\n  private fetchMoreRespHeaders: CosmosHeaders;\n  private endpoint: ExecutionContext;\n  private pageSize: number;\n  private vectorSearchBufferSize: number = 0;\n  private static DEFAULT_PAGE_SIZE = 10;\n  private static DEFAULT_MAX_VECTOR_SEARCH_BUFFER_SIZE = 50000;\n  private nonStreamingOrderBy = false;\n\n  constructor(\n    private clientContext: ClientContext,\n    private collectionLink: string,\n    private query: string | SqlQuerySpec,\n    private options: FeedOptions,\n    private partitionedQueryExecutionInfo: PartitionedQueryExecutionInfo,\n    correlatedActivityId: string,\n    private emitRawOrderByPayload: boolean = false,\n  ) {\n    this.endpoint = null;\n    this.pageSize = options[\"maxItemCount\"];\n    if (this.pageSize === undefined) {\n      this.pageSize = PipelinedQueryExecutionContext.DEFAULT_PAGE_SIZE;\n    }\n    // Pick between Nonstreaming and streaming endpoints\n    this.nonStreamingOrderBy = partitionedQueryExecutionInfo.queryInfo.hasNonStreamingOrderBy;\n\n    // Pick between parallel vs order by execution context\n    const sortOrders = partitionedQueryExecutionInfo.queryInfo.orderBy;\n    // TODO: Currently we don't get any field from backend to determine streaming queries\n    if (this.nonStreamingOrderBy) {\n      if (!options.allowUnboundedNonStreamingQueries) {\n        this.checkQueryConstraints(partitionedQueryExecutionInfo.queryInfo);\n      }\n\n      this.vectorSearchBufferSize = this.calculateVectorSearchBufferSize(\n        partitionedQueryExecutionInfo.queryInfo,\n        options,\n      );\n      const maxBufferSize = options[\"vectorSearchBufferSize\"]\n        ? options[\"vectorSearchBufferSize\"]\n        : PipelinedQueryExecutionContext.DEFAULT_MAX_VECTOR_SEARCH_BUFFER_SIZE;\n\n      if (this.vectorSearchBufferSize > maxBufferSize) {\n        throw new ErrorResponse(\n          `Executing a vector search query with TOP or OFFSET + LIMIT value ${this.vectorSearchBufferSize} larger than the vectorSearchBufferSize ${maxBufferSize} ` +\n            `is not allowed`,\n        );\n      }\n\n      const distinctType = partitionedQueryExecutionInfo.queryInfo.distinctType;\n      const context: ExecutionContext = new ParallelQueryExecutionContext(\n        this.clientContext,\n        this.collectionLink,\n        this.query,\n        this.options,\n        this.partitionedQueryExecutionInfo,\n        correlatedActivityId,\n      );\n\n      if (distinctType === \"None\") {\n        this.endpoint = new NonStreamingOrderByEndpointComponent(\n          context,\n          sortOrders,\n          this.vectorSearchBufferSize,\n          partitionedQueryExecutionInfo.queryInfo.offset,\n          this.emitRawOrderByPayload,\n        );\n      } else {\n        this.endpoint = new NonStreamingOrderByDistinctEndpointComponent(\n          context,\n          partitionedQueryExecutionInfo.queryInfo,\n          this.vectorSearchBufferSize,\n          this.emitRawOrderByPayload,\n        );\n      }\n    } else {\n      if (Array.isArray(sortOrders) && sortOrders.length > 0) {\n        // Need to wrap orderby execution context in endpoint component, since the data is nested as a \\\n        //      \"payload\" property.\n        this.endpoint = new OrderByEndpointComponent(\n          new OrderByQueryExecutionContext(\n            this.clientContext,\n            this.collectionLink,\n            this.query,\n            this.options,\n            this.partitionedQueryExecutionInfo,\n            correlatedActivityId,\n          ),\n          this.emitRawOrderByPayload,\n        );\n      } else {\n        this.endpoint = new ParallelQueryExecutionContext(\n          this.clientContext,\n          this.collectionLink,\n          this.query,\n          this.options,\n          this.partitionedQueryExecutionInfo,\n          correlatedActivityId,\n        );\n      }\n      if (\n        Object.keys(partitionedQueryExecutionInfo.queryInfo.groupByAliasToAggregateType).length >\n          0 ||\n        partitionedQueryExecutionInfo.queryInfo.aggregates.length > 0 ||\n        partitionedQueryExecutionInfo.queryInfo.groupByExpressions.length > 0\n      ) {\n        if (partitionedQueryExecutionInfo.queryInfo.hasSelectValue) {\n          this.endpoint = new GroupByValueEndpointComponent(\n            this.endpoint,\n            partitionedQueryExecutionInfo.queryInfo,\n          );\n        } else {\n          this.endpoint = new GroupByEndpointComponent(\n            this.endpoint,\n            partitionedQueryExecutionInfo.queryInfo,\n          );\n        }\n      }\n\n      // If distinct then add that to the pipeline\n      const distinctType = partitionedQueryExecutionInfo.queryInfo.distinctType;\n      if (distinctType === \"Ordered\") {\n        this.endpoint = new OrderedDistinctEndpointComponent(this.endpoint);\n      }\n      if (distinctType === \"Unordered\") {\n        this.endpoint = new UnorderedDistinctEndpointComponent(this.endpoint);\n      }\n\n      // If top then add that to the pipeline. TOP N is effectively OFFSET 0 LIMIT N\n      const top = partitionedQueryExecutionInfo.queryInfo.top;\n      if (typeof top === \"number\") {\n        this.endpoint = new OffsetLimitEndpointComponent(this.endpoint, 0, top);\n      }\n\n      // If offset+limit then add that to the pipeline\n      const limit = partitionedQueryExecutionInfo.queryInfo.limit;\n      const offset = partitionedQueryExecutionInfo.queryInfo.offset;\n      if (typeof limit === \"number\" && typeof offset === \"number\") {\n        this.endpoint = new OffsetLimitEndpointComponent(this.endpoint, offset, limit);\n      }\n    }\n    this.fetchBuffer = [];\n  }\n\n  public hasMoreResults(): boolean {\n    return this.fetchBuffer.length !== 0 || this.endpoint.hasMoreResults();\n  }\n\n  public async fetchMore(diagnosticNode: DiagnosticNodeInternal): Promise<Response<any>> {\n    this.fetchMoreRespHeaders = getInitialHeader();\n    return this._fetchMoreImplementation(diagnosticNode);\n  }\n\n  private async _fetchMoreImplementation(\n    diagnosticNode: DiagnosticNodeInternal,\n  ): Promise<Response<any>> {\n    try {\n      if (this.fetchBuffer.length >= this.pageSize) {\n        const temp = this.fetchBuffer.slice(0, this.pageSize);\n        this.fetchBuffer = this.fetchBuffer.slice(this.pageSize);\n        return { result: temp, headers: this.fetchMoreRespHeaders };\n      } else {\n        const response = await this.endpoint.fetchMore(diagnosticNode);\n        mergeHeaders(this.fetchMoreRespHeaders, response.headers);\n        if (response === undefined || response.result === undefined) {\n          if (this.fetchBuffer.length > 0) {\n            const temp = this.fetchBuffer;\n            this.fetchBuffer = [];\n            return { result: temp, headers: this.fetchMoreRespHeaders };\n          } else {\n            return { result: undefined, headers: this.fetchMoreRespHeaders };\n          }\n        }\n        this.fetchBuffer.push(...response.result);\n\n        if (this.options.enableQueryControl) {\n          if (this.fetchBuffer.length >= this.pageSize) {\n            const temp = this.fetchBuffer.slice(0, this.pageSize);\n            this.fetchBuffer = this.fetchBuffer.slice(this.pageSize);\n            return { result: temp, headers: this.fetchMoreRespHeaders };\n          } else {\n            const temp = this.fetchBuffer;\n            this.fetchBuffer = [];\n            return { result: temp, headers: this.fetchMoreRespHeaders };\n          }\n        }\n        // Recursively fetch more results to ensure the pageSize number of results are returned\n        // to maintain compatibility with the previous implementation\n        return this._fetchMoreImplementation(diagnosticNode);\n      }\n    } catch (err: any) {\n      mergeHeaders(this.fetchMoreRespHeaders, err.headers);\n      err.headers = this.fetchMoreRespHeaders;\n      if (err) {\n        throw err;\n      }\n    }\n  }\n\n  private calculateVectorSearchBufferSize(queryInfo: QueryInfo, options: FeedOptions): number {\n    if (queryInfo.top === 0 || queryInfo.limit === 0) return 0;\n    return queryInfo.top\n      ? queryInfo.top\n      : queryInfo.limit\n        ? queryInfo.offset + queryInfo.limit\n        : options[\"vectorSearchBufferSize\"] && options[\"vectorSearchBufferSize\"] > 0\n          ? options[\"vectorSearchBufferSize\"]\n          : PipelinedQueryExecutionContext.DEFAULT_MAX_VECTOR_SEARCH_BUFFER_SIZE;\n  }\n\n  private checkQueryConstraints(queryInfo: QueryInfo): void {\n    const hasTop = queryInfo.top || queryInfo.top === 0;\n    const hasLimit = queryInfo.limit || queryInfo.limit === 0;\n    if (!hasTop && !hasLimit) {\n      throw new ErrorResponse(\n        \"Executing a non-streaming search query without TOP or LIMIT can consume a large number of RUs \" +\n          \"very fast and have long runtimes. Please ensure you are using one of the above two filters \" +\n          \"with your vector search query.\",\n      );\n    }\n    return;\n  }\n}\n"]}

package/dist/browser/queryIterator.d.ts

@@ -0,0 +1,158 @@
+import type { ClientContext } from "./ClientContext.js";
+import { DiagnosticNodeInternal } from "./diagnostics/DiagnosticNodeInternal.js";
+import { ResourceType } from "./common/index.js";
+import type { FetchFunctionCallback, SqlQuerySpec } from "./queryExecutionContext/index.js";
+import type { FeedOptions } from "./request/FeedOptions.js";
+import { FeedResponse } from "./request/FeedResponse.js";
+/**
+ * Represents a QueryIterator Object, an implementation of feed or query response that enables
+ * traversal and iterating over the response
+ * in the Azure Cosmos DB database service.
+ */
+export declare class QueryIterator<T> {
+    private clientContext;
+    private query;
+    private options;
+    private fetchFunctions;
+    private resourceLink?;
+    private resourceType?;
+    private fetchAllTempResources;
+    private fetchAllLastResHeaders;
+    private queryExecutionContext;
+    private queryPlanPromise;
+    private isInitialized;
+    private correlatedActivityId;
+    private partitionKeyRangeCache;
+    /**
+     * @hidden
+     */
+    constructor(clientContext: ClientContext, query: SqlQuerySpec | string, options: FeedOptions, fetchFunctions: FetchFunctionCallback | FetchFunctionCallback[], resourceLink?: string, resourceType?: ResourceType);
+    /**
+     * Gets an async iterator that will yield results until completion.
+     *
+     * NOTE: AsyncIterators are a very new feature and you might need to
+     * use polyfils/etc. in order to use them in your code.
+     *
+     * If you're using TypeScript, you can use the following polyfill as long
+     * as you target ES6 or higher and are running on Node 6 or higher.
+     *
+     * ```ts snippet:ignore
+     * if (!Symbol || !Symbol.asyncIterator) {
+     *   (Symbol as any).asyncIterator = Symbol.for("Symbol.asyncIterator");
+     * }
+     * ```
+     *
+     * @example Iterate over all databases
+     * ```ts snippet:QueryIteratorIterateDatabases
+     * import { CosmosClient } from "@azure/cosmos";
+     *
+     * const endpoint = "https://your-account.documents.azure.com";
+     * const key = "<database account masterkey>";
+     * const client = new CosmosClient({ endpoint, key });
+     *
+     * for await (const { resources: db } of client.databases.readAll().getAsyncIterator()) {
+     *   console.log(`Got ${db} from AsyncIterator`);
+     * }
+     * ```
+     */
+    getAsyncIterator(): AsyncIterable<FeedResponse<T>>;
+    /**
+     * Determine if there are still remaining resources to process based on the value of the continuation token or the
+     * elements remaining on the current batch in the QueryIterator.
+     * @returns true if there is other elements to process in the QueryIterator.
+     */
+    hasMoreResults(): boolean;
+    /**
+     * Fetch all pages for the query and return a single FeedResponse.
+     * @example
+     * ```ts snippet:ReadmeSampleQueryDatabase
+     * import { CosmosClient } from "@azure/cosmos";
+     *
+     * const endpoint = "https://your-account.documents.azure.com";
+     * const key = "<database account masterkey>";
+     * const client = new CosmosClient({ endpoint, key });
+     *
+     * const { database } = await client.databases.createIfNotExists({ id: "Test Database" });
+     *
+     * const { container } = await database.containers.createIfNotExists({ id: "Test Container" });
+     *
+     * const { resources } = await container.items
+     *   .query("SELECT * from c WHERE c.isCapitol = true")
+     *   .fetchAll();
+     * ```
+     */
+    fetchAll(): Promise<FeedResponse<T>>;
+    /**
+     * @hidden
+     */
+    fetchAllInternal(diagnosticNode: DiagnosticNodeInternal): Promise<FeedResponse<T>>;
+    /**
+     * Retrieve the next batch from the feed.
+     *
+     * This may or may not fetch more pages from the backend depending on your settings
+     * and the type of query. Aggregate queries will generally fetch all backend pages
+     * before returning the first batch of responses.
+     *
+     * @example
+     * ```ts snippet:ReadmeSampleNonStreamableCrossPartitionQuery
+     * import { CosmosClient } from "@azure/cosmos";
+     *
+     * const endpoint = "https://your-account.documents.azure.com";
+     * const key = "<database account masterkey>";
+     * const client = new CosmosClient({ endpoint, key });
+     *
+     * const { database } = await client.databases.createIfNotExists({ id: "Test Database" });
+     *
+     * const { container } = await database.containers.createIfNotExists({ id: "Test Container" });
+     *
+     * const querySpec = {
+     *   query: "SELECT c.status, COUNT(c.id) AS count FROM c GROUP BY c.status",
+     * };
+     * const queryOptions = {
+     *   maxItemCount: 10, // maximum number of items to return per page
+     *   enableCrossPartitionQuery: true,
+     * };
+     * const queryIterator = container.items.query(querySpec, queryOptions);
+     * while (queryIterator.hasMoreResults()) {
+     *   const { resources: result } = await queryIterator.fetchNext();
+     *   // process results
+     * }
+     * ```
+     */
+    fetchNext(): Promise<FeedResponse<T>>;
+    /**
+     * Reset the QueryIterator to the beginning and clear all the resources inside it
+     * @example
+     * ```ts snippet:QueryIteratorReset
+     * import { CosmosClient } from "@azure/cosmos";
+     *
+     * const endpoint = "https://your-account.documents.azure.com";
+     * const key = "<database account masterkey>";
+     * const client = new CosmosClient({ endpoint, key });
+     * const { database } = await client.databases.createIfNotExists({ id: "Test Database" });
+     * const { container } = await database.containers.createIfNotExists({ id: "Test Container" });
+     *
+     * const querySpec = {
+     *   query: "SELECT c.status, COUNT(c.id) AS count FROM c GROUP BY c.status",
+     * };
+     * const queryIterator = container.items.query(querySpec);
+     * while (queryIterator.hasMoreResults()) {
+     *   const { resources: result } = await queryIterator.fetchNext();
+     *   // process results
+     * }
+     * queryIterator.reset();
+     * ```
+     *
+     */
+    reset(): void;
+    private toArrayImplementation;
+    private createExecutionContext;
+    private createHybridQueryExecutionContext;
+    private createPipelinedExecutionContext;
+    private fetchQueryPlan;
+    private needsQueryPlan;
+    private initPromise;
+    private _init;
+    private handleSplitError;
+}
+//# sourceMappingURL=queryIterator.d.ts.map

package/dist/browser/queryIterator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"queryIterator.d.ts","sourceRoot":"","sources":["../../src/queryIterator.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACxD,OAAO,EACL,sBAAsB,EAEvB,MAAM,yCAAyC,CAAC;AACjD,OAAO,EAAmB,YAAY,EAAe,MAAM,mBAAmB,CAAC;AAC/E,OAAO,KAAK,EAGV,qBAAqB,EACrB,YAAY,EACb,MAAM,kCAAkC,CAAC;AAa1C,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAC5D,OAAO,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAC;AAWzD;;;;GAIG;AACH,qBAAa,aAAa,CAAC,CAAC;IAYxB,OAAO,CAAC,aAAa;IACrB,OAAO,CAAC,KAAK;IACb,OAAO,CAAC,OAAO;IACf,OAAO,CAAC,cAAc;IACtB,OAAO,CAAC,YAAY,CAAC;IACrB,OAAO,CAAC,YAAY,CAAC;IAhBvB,OAAO,CAAC,qBAAqB,CAAM;IACnC,OAAO,CAAC,sBAAsB,CAAgB;IAC9C,OAAO,CAAC,qBAAqB,CAAmB;IAChD,OAAO,CAAC,gBAAgB,CAAmD;IAC3E,OAAO,CAAC,aAAa,CAAU;IAC/B,OAAO,CAAC,oBAAoB,CAAS;IACrC,OAAO,CAAC,sBAAsB,CAAyB;IACvD;;OAEG;gBAEO,aAAa,EAAE,aAAa,EAC5B,KAAK,EAAE,YAAY,GAAG,MAAM,EAC5B,OAAO,EAAE,WAAW,EACpB,cAAc,EAAE,qBAAqB,GAAG,qBAAqB,EAAE,EAC/D,YAAY,CAAC,EAAE,MAAM,EACrB,YAAY,CAAC,EAAE,YAAY;IAYrC;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACW,gBAAgB,IAAI,aAAa,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;IAkDhE;;;;OAIG;IACI,cAAc,IAAI,OAAO;IAIhC;;;;;;;;;;;;;;;;;;OAkBG;IAEU,QAAQ,IAAI,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;IAMjD;;OAEG;IACU,gBAAgB,CAAC,cAAc,EAAE,sBAAsB,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;IAW/F;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACU,SAAS,IAAI,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;IA0ClD;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACI,KAAK,IAAI,IAAI;YAYN,qBAAqB;YAyCrB,sBAAsB;YAgBtB,iCAAiC;YA4BjC,+BAA+B;YAiB/B,cAAc;IAiB5B,OAAO,CAAC,cAAc;IAWtB,OAAO,CAAC,WAAW,CAAgB;YAarB,KAAK;IAOnB,OAAO,CAAC,gBAAgB;CAYzB"}