Record Stable Key Sort

Stably sort own scalar record keys: numeric keys numerically, other/mixed scalar keys by typed JSON spelling; ties retain source order.

Description

Stably sort own scalar record keys: numeric keys numerically, other/mixed scalar keys by typed JSON spelling; ties retain source order.

A stable key sort preserves source order for equal keys. Mixed scalar types need an explicit ordering rule so the result is reproducible.

When to use this tool

Stably sort own scalar record keys: numeric keys numerically, other/mixed scalar keys by typed JSON spelling; ties retain source order.

  • Prepare the supplied recordsJson, keyField, descending fields for this operation.
  • Compare the complete example with the representation used by your own input before carrying the result into another step.

How to use the tool and how it works

  1. Enter recordsJson, keyField, descending. Use the exact text syntax, units and index conventions explained below.
  2. Run the tool. If input validation fails, correct the supplied fields before interpreting any result.
  3. Read result.records, result.sourceIndexes. Interpret false, null and empty lists using the distinctions below; they can be valid outputs.

Require every record to have an own scalar keyField. Compare two numbers numerically; otherwise compare their JSON-serialized scalar keys lexically. Reverse that primary comparison when descending, retaining original index order for ties.1

Input fieldMeaning and representationAccepted input
recordsJsonJSON text, entered as one text field. The decoded structure is illustrated below; it is not a separate file.Text
keyFieldkey field.Text; at most 8,192 UTF-16 code units, subject to the grammar above
descendingExplicit choice for descending; supply a boolean rather than a text label.true or false

For the JSON text fields, the following decoded structures show the example records before they are serialized into input strings. Keep field names, list nesting and value types as shown.

json
[
  {
    "field": "recordsJson",
    "decoded": [
      {
        "id": 2
      },
      {
        "id": 1
      },
      {
        "id": 2
      }
    ]
  }
]
Output fieldInterpretation
resultObject containing the named outputs below.
result.recordsThe records list in the ordering and representation described above.
result.sourceIndexesOriginal zero-based source positions, under the ordering described above.
json
{
  "input": {
    "recordsJson": "[{\"id\":2},{\"id\":1},{\"id\":2}]",
    "keyField": "id",
    "descending": false
  },
  "output": {
    "result": {
      "records": [
        {
          "id": 1
        },
        {
          "id": 2
        },
        {
          "id": 2
        }
      ],
      "sourceIndexes": [
        1,
        0,
        2
      ]
    }
  }
}

Limitations and assumptions

  • Mixed-type order is serialized-text order rather than natural-language collation or a database type hierarchy. Source indexes identify the reordered records; nested keys and missing sort fields are unsupported.
  • Decoded JSON is bounded to 20,000 nodes and 32 nesting levels; record arrays have at most 128 records. Parsed number values use JavaScript floating point rather than arbitrary-precision decimal arithmetic.
  • Every declared top-level field is required and unexpected fields are rejected. Numeric inputs must be finite; ordinary text fields are bounded to 8,192 UTF-16 code units, with tighter operation-specific limits where stated.
  • Ordinary string lists have at most 128 entries of at most 128 code units each; numeric lists and matrices have separate bounded size checks. Nonfinite results and excessively large serialized outputs are rejected.
  • Indexes are zero-based and spans have an exclusive end unless explicitly stated otherwise. A valid false, null or empty-list result is distinct from malformed input.

Alternative or Complementary methods

For document-wide requirements, combine these structural inventories with an explicit JSON Schema. Preserve the distinction between missing properties and null values, and between numbers and numeric-looking strings when building joins or indexes.

References

  1. Tool behavior and example: Record Stable Key Sort — tool.io

Similar or alternative tools

Don't forget to set a bookmark for tool.io!
Privacy | Imprint | Cookies