---
title: "Sort Query Results"
url: "https://docs.ravendb.net/6.2/client-api/session/querying/sort-query-results"
version: "6.2"
language: "nodejs"
---

# Sort Query Results

> Client language: Node.js. Also available for [C#](https://docs.ravendb.net/6.2/client-api/session/querying/sort-query-results.md), [Python](https://docs.ravendb.net/6.2/client-api/session/querying/sort-query-results.python.md), [PHP](https://docs.ravendb.net/6.2/client-api/session/querying/sort-query-results.php.md).
>
> RavenDB publishes an official agent skill for coding assistants at https://docs.ravendb.net/skills/ravendb/SKILL.md (also installable with `npx skills add ravendb/skills`). The skill describes itself as: "Read this before writing any RavenDB query, client call or /databases/ request. Covers server setup, document modelling, the Node.js, .NET and Python clients, RQL, indexes, vector search and AI agents. Code written from recall tends to run and return the wrong rows, because RQL resembles SQL and the clients take field names as plain strings."

> **Note**
>
> - When making a query, the server will return the results **sorted** only if explicitly requested by the query.  
>   If no sorting method is specified when issuing the query then results will not be sorted.
>
>   - Note: An exception to the above rule is when [Boosting](https://docs.ravendb.net/6.2/indexes/boosting.nodejs.md) is involved in the query.  
>     Learn more in [Automatic score-based ordering](https://docs.ravendb.net/6.2/indexes/boosting.nodejs.md#automatic-score-based-ordering).
>
> - Sorting is applied by the server after the query filtering stage.  
>   Applying filtering is recommended as it reduces the number of results RavenDB needs to sort  
>   when querying a large dataset.
>
> - Multiple sorting actions can be chained.
>
> - This article provides examples of sorting query results when making a **dynamic-query**.  
>   For sorting results when querying a **static-index** see [sort index query results](https://docs.ravendb.net/6.2/indexes/querying/sorting.nodejs.md).
>
> - In this page:
>   - [Order by field value](#order-by-field-value)
>   - [Order by score](#order-by-score)
>     - [Get resulting score](#get-resulting-score)
>   - [Order by random](#order-by-random)
>   - [Order by spatial](#order-by-spatial)
>   - [Order by count (aggregation query)](#order-by-count-aggregation-query)
>   - [Order by sum (aggregation query)](#order-by-sum-aggregation-query)
>   - [Force ordering type](#force-ordering-type)
>   - [Chain ordering](#chain-ordering)
>   - [Custom sorters](#custom-sorters)
>   - [Syntax](#syntax)

## Order by field value

- Use `orderBy` or `orderByDescending` to order the results by the specified document-field.

- The query is served by an auto-index that includes the sorted field, even when no filtering is applied.  
  For example, `from Employees order by FirstName` uses an auto-index that includes `FirstName`, creating one if needed.  
  Learn more in [Query a collection - with filtering or sorting](https://docs.ravendb.net/6.2/client-api/session/querying/how-to-query.nodejs.md#dynamicQuery).

### Query

```javascript
const products = await session
   // Make a dynamic query on the 'products' collection    
  .query({ collection: "products" })
   // Apply filtering (optional)
  .whereGreaterThan("UnitsInStock", 10)
   // Call 'orderBy'
   // Pass the document-field by which to order the results and the ordering type
  .orderBy("UnitsInStock", "Long")
  .all(); 

// Results will be sorted by the 'UnitsInStock' value in ascending order,
// with smaller values listed first.
```

### RQL

```sql
from "Products"
where UnitsInStock > 10
order by UnitsInStock as long
```

> **Info**
>
> **Ordering Type**:
>
> - If no ordering type is specified in the query then the server will apply the default lexicographical ordering.
>
> - In the above example, the ordering type was set to `Long`.
>
> - Different ordering can be forced - see [Force ordering type](#force-ordering-type) below.

## Order by score

- When querying with some filtering conditions, a basic score is calculated for each item in the results  
  by the underlying indexing engine.

- The higher the score value the better the match.

- Use `orderByScore` or `orderByScoreDescending` to order by this score.

### Query

```javascript
const products = await session
  .query({ collection: "products" })
   // Apply filtering
  .whereLessThan("UnitsInStock", 5)
  .orElse()
  .whereEquals("Discontinued", true)
   // Call 'orderByScore'
  .orderByScore()
  .all();

// Results will be sorted by the score value
// with best matching documents (higher score values) listed first.
```

### RQL

```sql
from "Products"
where UnitsInStock < 5 or Discontinued == true
order by score()
```

> **Info**
>
> #### Get resulting score:
>
> The score details can be retrieved by either:
>
> - **Request to include explanations**:  
>   You can get the score details and see how it was calculated by requesting to include explanations in the query.
>   Currently, this is only available when using Lucene as the underlying indexing engine.  
>   Learn more in [Include query explanations](https://docs.ravendb.net/6.2/client-api/session/querying/debugging/include-explanations.nodejs.md).
>
> - **Get score from metadata**:
>
>   - The score is available in the `@index-score` metadata property within each result.  
>     Note the following difference between the underlying indexing engines:
>
>     - When using **Lucene**:  
>       This metadata property is always available in the results.  
>       Read more about Lucene scoring [here](https://lucene.apache.org/core/3_3_0/scoring.html).
>
>     - When using **Corax**:  
>       In order to enhance performance, this metadata property is Not included in the results by default.  
>       To get this metadata property you must set the [Indexing.Corax.IncludeDocumentScore](https://docs.ravendb.net/6.2/server/configuration/indexing-configuration.md#indexingcoraxincludedocumentscore) configuration value to *true*.  
>       Learn about the available methods for setting an indexing configuration key in this [indexing-configuration](https://docs.ravendb.net/6.2/server/configuration/indexing-configuration.md) article.
>
>   - The following example shows how to get the score from the metadata of the resulting entities that were loaded to the session:
>
> ```javascript
> // Make a query:
> // =============
>
> const employees = await session
>   .query({ collection: "Employees"})
>   .search('Notes', 'English')
>   .search('Notes', 'Italian')
>   .boost(10)
>   .all();
>
> // Get the score:
> // ==============
>
> // Call 'getMetadataFor', pass an entity from the resulting employees list
> const metadata = session.advanced.getMetadataFor(employees[0]);
>
> // Score is available in the '@index-score' metadata property
> const score = metadata[CONSTANTS.Documents.Metadata.INDEX_SCORE];
> ```

## Order by random

- Use `randomOrdering` to randomize the order of the query results.

- An optional seed parameter can be passed.

### Query

```javascript
const products = await session
  .query({ collection: "products" })
  .whereGreaterThan("UnitsInStock", 10)
   // Call 'randomOrdering'
  .randomOrdering()
   // An optional seed can be passed, e.g.:
   // .randomOrdering("someSeed")
  .all();

// Results will be randomly ordered.
```

### RQL

```sql
from "Products"
where UnitsInStock > 10
order by random()
// order by random(someSeed)
```

## Order by spatial

- If your data contains geographical locations,  
  spatial query results can be sorted based on their distance from a specific point.

- See detailed explanation in [Spatial Sorting](https://docs.ravendb.net/6.2/client-api/session/querying/how-to-make-a-spatial-query.nodejs.md#spatial-sorting).

## Order by count (aggregation query)

- The results of a [group-by query](https://docs.ravendb.net/6.2/client-api/session/querying/how-to-perform-group-by-query.nodejs.md) can be sorted by the `count` aggregation operation used in the query.

### Query

```javascript
const numberOfProductsPerCategory = await session
  .query({ collection: "products" })
   // Group by category
  .groupBy("Category")
  .selectKey("Category")
   // Count the number of product documents per category
  .selectCount()
   // Order by the count value
  .orderBy("count", "Long")
  .all();

// Results will contain the number of Product documents per category
// ordered by that count in ascending order.
```

### RQL

```sql
from "Products"
group by Category
order by count() as long
select key() as "Category", count()
```

## Order by sum (aggregation query)

- The results of a [group-by query](https://docs.ravendb.net/6.2/client-api/session/querying/how-to-perform-group-by-query.nodejs.md) can be sorted by the `sum` aggregation operation used in the query.

### Query

```javascript
const numberOfUnitsInStockPerCategory = await session
  .query({ collection: "products" })
   // Group by category
  .groupBy("Category")
  .selectKey("Category")
   // Sum the number of units in stock per category
  .selectSum(new GroupByField("UnitsInStock", "sum"))
   // Order by the sum value
  .orderBy("sum", "Long")
  .all();

// Results will contain the total number of units in stock per category
// ordered by that number in ascending order.
```

### RQL

```sql
from "Products"
group by Category
order by sum as long
select key() as 'Category', sum(UnitsInStock) as sum
```

## Force ordering type

- If no ordering type is specified in the query then the server will apply the default lexicographical ordering.

- A different ordering can be forced by passing the ordering type explicitly to `orderBy` or `orderByDescending`.

- The following ordering types are available:

  - `Long`
  - `Double`
  - `AlphaNumeric`
  - `String` (lexicographic ordering)

> **Note**
>
> **Using alphanumeric ordering example**:
>
> - When ordering mixed-character strings by the default lexicographical ordering  
>   then comparison is done character by character based on the Unicode values.  
>   For example, "Abc9" will come after "Abc10" since 9 is greater than 1.
>
> - If you want the digit characters to be ordered as numbers then use alphanumeric ordering  
>   where "Abc10" will result after "Abc9".
>
> ### Query
>
> ```javascript
> const products = await session
>   .query({ collection: "products" })
>    // Call 'OrderBy', order by field 'QuantityPerUnit'
>    // Pass a second param, requesting to order the text alphanumerically
>   .orderBy("QuantityPerUnit", "AlphaNumeric")
>   .all();
> ```
>
> ### RQL
>
> ```sql
> from "Products"
> order by QuantityPerUnit as alphanumeric
> ```
>
> ```javascript
> // Running the above query on the NorthWind sample data,
> // would produce the following order for the QuantityPerUnit field:
> // ================================================================
>
> // "1 kg pkg."
> // "1k pkg."
> // "2 kg box."
> // "4 - 450 g glasses"
> // "5 kg pkg."
> // ...
>
> // While running with the default Lexicographical ordering would have produced:
> // ============================================================================
>
> // "1 kg pkg."
> // "10 - 200 g glasses"
> // "10 - 4 oz boxes"
> // "10 - 500 g pkgs."
> // "10 - 500 g pkgs."
> // ...
> ```

## Chain ordering

- It is possible to chain multiple orderings in the query.  
  Any combination of secondary sorting is possible as the fields are indexed independently of one another.

- **When using the Lucene search engine** -  
  there is no limit on the number of sorting actions that can be chained in a query.

  **When using the Corax search engine** -  
  a maximum of `16` *order by* clauses is allowed per query. If this limit is exceeded, an exception will be thrown.  
  To resolve this, simplify your query or switch to the Lucene engine. See [Selecting the search engine](https://docs.ravendb.net/6.2/indexes/search-engine/corax.md#selecting-the-search-engine).

### Query

```javascript
const products = await session
  .query({ collection: "products" })
  .whereGreaterThan("UnitsInStock", 10)
   // Apply the primary sort by 'UnitsInStock'
  .orderByDescending("UnitsInStock", "Long")
   // Apply a secondary sort by the score
  .orderByScore()
   // Apply another sort by 'Name'
  .orderBy("Name")
  .all();

// Results will be sorted by the 'UnitsInStock' value (descending),
// then by score,
// and then by 'Name' (ascending).
```

### RQL

```sql
from "Products"
where UnitsInStock > 10
order by UnitsInStock as long desc, score(), Name
```

## Custom sorters

- The Lucene indexing engine allows you to create your own custom sorters.  
  Custom sorters are not supported by [Corax](https://docs.ravendb.net/6.2/indexes/search-engine/corax.md).

- Custom sorters can be deployed to the server by either:

  - Sending the [Put Sorters Operation](https://docs.ravendb.net/6.2/client-api/operations/maintenance/sorters/put-sorter.nodejs.md) from your code.

  - Uploading a custom sorter from Studio, see [Custom Sorters View](https://docs.ravendb.net/6.2/studio/database/settings/custom-sorters.md).

- Once the custom sorter is deployed, you can sort the query results with it.

### Query

```javascript
const products = await session
  .query({ collection: "products" })
  .whereGreaterThan("UnitsInStock", 10)
   // Order by field 'UnitsInStock', pass the name of your custom sorter class
  .orderBy("UnitsInStock", { sorterName: "MySorter" })
  .all();

// Results will be sorted by the 'UnitsInStock' value
// according to the logic from 'MySorter' class
```

### RQL

```sql
from "Products"
where UnitsInStock > 10
order by custom(UnitsInStock, "MySorter")
```

## Syntax

```javascript
// orderBy overloads:
orderBy(field);
orderBy(field, ordering);
orderBy(field, options);

// orderByDescending overloads:
orderByDescending(field);
orderByDescending(field, ordering);
orderByDescending(field, options);
```

| Parameter | Type | Description |
| - | - | - |
| **field** | `string` | The name of the field to sort by |
| **ordering** | `string` | The ordering type that will be used to sort the results:<br />`Long`<br />`Double`<br />`AlphaNumeric`<br />`String` (default) |
| **options** | `object` | An object that specifies the custom `sorterName` |

## See also

- [Query Overview](https://docs.ravendb.net/6.2/client-api/session/querying/how-to-query.nodejs.md)
- [Customize query](https://docs.ravendb.net/6.2/client-api/session/querying/how-to-customize-query.nodejs.md)
- [Group by query](https://docs.ravendb.net/6.2/client-api/session/querying/how-to-perform-group-by-query.nodejs.md)
- [Spatial query](https://docs.ravendb.net/6.2/client-api/session/querying/how-to-make-a-spatial-query.nodejs.md)
- [Full-text search](https://docs.ravendb.net/6.2/client-api/session/querying/text-search/full-text-search.nodejs.md)
