Skip to content

$sortArray

Definition

Returns a new array without changing the source list.

Expression operator · Arrays · Studio Visual: available. Studio validates the complete expression separately.

Syntax

{
  "$sortArray": {
    "input": <input>,
    "sortBy": <sortBy>
  }
}

Replace angle-bracket placeholders with expressions or values.

Optional parameters may be omitted.

Parameters

Parameter Required Description
input Yes Expression supplying the value to process. A field reference such as "$price" reads from the current document.
sortBy Yes Literal 1 for ascending or -1 for descending; for object items, an ordered object of field names and directions.

Behavior

The following observations use the example expression below. Each row substitutes one argument while retaining the other example arguments. A missing field differs from an explicit null; the result shown is what Core actually returned.

For the input argument:

Input case Supplied value Result
null null null
missing Field absent null
decimal 2.5 Error — $sortArray input must be an array
numeric string "12" Error — $sortArray input must be an array
text "hello" Error — $sortArray input must be an array
boolean true Error — $sortArray input must be an array
typed date {"$date":"2026-01-15T15:00:00Z"} Error — $sortArray input must be an array
empty array [] []
numeric array [1,2,3] [1,2,3]
object {"x":1} Error — $sortArray input must be an array

Argument handling

Invocation Result
{"$sortArray":[]} Error — $sortArray requires input and sortBy
{"$sortArray":{"unexpected":1}} Error — $sortArray requires input and sortBy

Examples

Expression: 

{
  "$sortArray": {
    "input": [
      3,
      1,
      2
    ],
    "sortBy": 1
  }
}

Input document: 

{}

Observed SrotaX result: [1,2,3].

Detailed input cases

Expand the complete argument-by-argument test matrix

Each table changes only the indicated argument from the example above. Other arguments retain their baseline values. Values normally come from the input field probe; literal configuration arguments are replaced directly. “Missing” means the field is absent, not explicitly null. Numeric strings are strings, not numbers.

Argument: input

Input case Supplied value SrotaX result
null null null
missing Field absent null
zero 0 Error — $sortArray input must be an array
negative -2 Error — $sortArray input must be an array
decimal 2.5 Error — $sortArray input must be an array
numeric string "12" Error — $sortArray input must be an array
text "hello" Error — $sortArray input must be an array
empty string "" Error — $sortArray input must be an array
boolean true Error — $sortArray input must be an array
false false Error — $sortArray input must be an array
typed date {"$date":"2026-01-15T15:00:00Z"} Error — $sortArray input must be an array
decimal128 {"$numberDecimal":"1.25"} Error — $sortArray input must be an array
empty array [] []
numeric array [1,2,3] [1,2,3]
mixed array [1,null,"x",3] [null,1,3,"x"]
nested array [[1,2],[3]] [[1,2],[3]]
empty object {} Error — $sortArray input must be an array
object {"x":1} Error — $sortArray input must be an array
ISO date string "2026-01-15T15:00:00Z" Error — $sortArray input must be an array
omitted named argument Argument removed Error — $sortArray requires input and sortBy

Argument: sortBy

Input case Supplied value SrotaX result
null null Error — $sortArray sort direction must be 1 or -1
zero 0 Error — $sortArray sort direction must be 1 or -1
negative -2 Error — $sortArray sort direction must be 1 or -1
decimal 2.5 Error — $sortArray sort direction must be 1 or -1
numeric string "12" Error — $sortArray sort direction must be 1 or -1
text "hello" Error — $sortArray sort direction must be 1 or -1
empty string "" Error — $sortArray sort direction must be 1 or -1
boolean true Error — $sortArray sort direction must be 1 or -1
false false Error — $sortArray sort direction must be 1 or -1
typed date {"$date":"2026-01-15T15:00:00Z"} Error — $sortArray sort direction must be 1 or -1
decimal128 {"$numberDecimal":"1.25"} Error — $sortArray sort direction must be 1 or -1
empty array [] Error — $sortArray sort direction must be 1 or -1
numeric array [1,2,3] Error — $sortArray sort direction must be 1 or -1
mixed array [1,null,"x",3] Error — $sortArray sort direction must be 1 or -1
nested array [[1,2],[3]] Error — $sortArray sort direction must be 1 or -1
empty object {} Error — $sortArray sortBy must not be empty
object {"x":1} [3,1,2]
ISO date string "2026-01-15T15:00:00Z" Error — $sortArray sort direction must be 1 or -1
omitted named argument Argument removed Error — $sortArray requires input and sortBy

Verification

This page records 42 executed cases. It covers individual argument substitutions, not every cross-product of arguments, locale, daylight-saving transitions, numeric overflow, collation or resource limits. No untested behavior is guaranteed.

Download exact expressions, inputs and SrotaX results. Errors are observed messages, not stable public error codes. The reference generator reads the checked-in execution report; do not edit generated observations by hand.

MongoDB differences

Compared with MongoDB 9.0.4: 8 exact BSON matches, 34 both rejected, 0 value/type/acceptance differences, 0 object-field-order differences.

“Exact” includes numeric BSON types and object key order. A value of 3 as int32 differs from 3.0 as double. Object-field-order differences are reported separately; object key ordering is not enforced by the engine regression baseline. Both rejected does not mean the error codes or messages match. This is finite-case evidence, not full compatibility certification.

No differences were observed in the compared cases.

Download full comparison evidence.