Query: Adds support for non streaming ORDER BY

[neildsh]

Description

This change adds support for non streaming ORDER BY. Prior to this, the SDK assumed that the documents returned by the backend in response to ORDER BY queries were totally ordered across continuations. With the addition of non streaming ORDER BY to the backend, this is no longer true. The backend indicates this with a new field in the response body, _streaming that will be set to false. In this case, a new non streaming order by pipeline stage is created. This is a blocking pipeline stage similar to GROUP BY. This stage accumulates all backend responses before it yields any results. This stage is exercised only if _streaming is set to false in the backend response to an ORDER BY query.

This change also fixes a few bugs in the SDK code:

The ResponseLengthInBytes property of QueryPage was being set incorrectly in several pipeline stages and has been removed.

The IQueryPipelineStage interface had an awkward SetCancellationToken method that has been removed in favor of taking the CancellationToken as a parameter to the MoveNextAsync method on ITracingAsyncEnumerator instead.

The index utilization header was not being accumulated correctly in SkipEmptyPageQueryPipelineStage, and similar code in ClientAggregateQueryPipelineStage had an unnecessary allocation in a loop.

Type of change

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)

Closing issues

To automatically close an issue: closes #IssueNumber

[sboshra]

    private sealed class StaticQueryPageParameters

I'd avoid 'Static' here #Resolved

---

Refers to: Microsoft.Azure.Cosmos/src/Query/Core/Pipeline/CrossPartition/OrderBy/OrderByCrossPartitionQueryPipelineStage.cs:71 in dd5ae23. [](commit_id = dd5ae23475604edfca950939b757aa0ea313e4dd, deletion_comment = False)

[sboshra]

        public int MaxConcurrency { get; }

new lines #Resolved

---

Refers to: Microsoft.Azure.Cosmos/src/Query/Core/Pipeline/CrossPartition/OrderBy/OrderByCrossPartitionQueryPipelineStage.cs:50 in dd5ae23. [](commit_id = dd5ae23475604edfca950939b757aa0ea313e4dd, deletion_comment = False)

[sboshra]

    private OrderByCrossPartitionQueryPipelineStage(InitializationParameters init)

parameters or something else #Resolved

---

Refers to: Microsoft.Azure.Cosmos/src/Query/Core/Pipeline/CrossPartition/OrderBy/OrderByCrossPartitionQueryPipelineStage.cs:110 in dd5ae23. [](commit_id = dd5ae23475604edfca950939b757aa0ea313e4dd, deletion_comment = False)

[sboshra]

                return true;

this.bufferedPages.Count > 0 #Resolved

---

Refers to: Microsoft.Azure.Cosmos/src/Query/Core/Pipeline/CrossPartition/OrderBy/OrderByCrossPartitionQueryPipelineStage.cs:152 in dd5ae23. [](commit_id = dd5ae23475604edfca950939b757aa0ea313e4dd, deletion_comment = False)

[sboshra]

Should this be added as a resource value? #ByDesign

---

Refers to: Microsoft.Azure.Cosmos/src/Query/Core/Pipeline/CrossPartition/OrderBy/OrderByCrossPartitionQueryPipelineStage.cs:1885 in eba9d5a. [](commit_id = eba9d5a, deletion_comment = False)

[sboshra]

        {

Consider only using the MultiLevel class #Pending

---

Refers to: Microsoft.Azure.Cosmos/src/Query/Core/Pipeline/CrossPartition/OrderBy/OrderByCrossPartitionQueryPipelineStage.cs:2031 in 4271b86. [](commit_id = 4271b8691ad67e7eb7605b19a5ebd85efad439fc, deletion_comment = False)

[sboshra]

[neildsh]

All the other pipeline stages also use inline constants. This code will be invoked in loop, where we may not want to pay the performance cost of doing a resource lookup. I will keep this as is for now.

---

In reply to: 2010479803

---

Refers to: Microsoft.Azure.Cosmos/src/Query/Core/Pipeline/CrossPartition/OrderBy/OrderByCrossPartitionQueryPipelineStage.cs:1885 in eba9d5a. [](commit_id = eba9d5a, deletion_comment = False)

[adityasa]

[neildsh]

/azp run

[azure-pipelines]

Azure Pipelines successfully started running 1 pipeline(s).

[neildsh]

/azp automerge

[azure-pipelines]

Command 'automerge' is not supported by Azure Pipelines.

Supported commands

• help:
• Get descriptions, examples and documentation about supported commands
• Example: help "command_name"
• list:
• List all pipelines for this repository using a comment.
• Example: "list"
• run:
• Run all pipelines or specific pipelines for this repository using a comment. Use this command by itself to trigger all related pipelines, or specify specific pipelines to run.
• Example: "run" or "run pipeline_name, pipeline_name, pipeline_name"
• where:
• Report back the Azure DevOps orgs that are related to this repository and org
• Example: "where"

See additional documentation.