BSON_EXTRACT_ALL_BSON

Extracts and returns all the values from a BSON document or array, optionally at the specified path.

If the specified path matches an array, BSON_EXTRACT_ALL_BSON() recursively extracts and aggregates values from each element at the specified path.

Syntax

BSON_EXTRACT_ALL_BSON(<input> [, path_key_1, path_key_2,.., path_key_n])

Arguments

  • input: A valid BSON document or an expression that evaluates to a valid BSON document.

  • path: A comma-separated list of dictionary keys or array positions (zero-based index).

Return Type

A BSON value.

Remarks

  • If the path_key argument is not specified, the top-level document or value is returned.

  • If the specified path_key does not exist, returns NULL.

Examples

Note: The following examples explicitly cast string to BSON for clarity. Similarly, the output is cast to JSON.

  • Returns values for all the matching keys in the BSON document:

    SELECT
    BSON_EXTRACT_ALL_BSON('{"c":[{"a":[{"b":1},{"b":2},{"b":3},{"b":4}]}]}':>BSON, 'c', 'a', 'b'):>JSON AS Result;
    +-------------+
    | Result      |
    +-------------+
    | [[1,2,3,4]] |
    +-------------+
    SELECT
    BSON_EXTRACT_ALL_BSON('{"a":[{"b":[1,2]},{"b":[3,4]},{"b":[5,6]},{"b":[7,8]}]}':>BSON, 'a', 'b'):>JSON AS Result;
    +---------------------------+
    | Result                    |
    +---------------------------+
    | [[1,2],[3,4],[5,6],[7,8]] |
    +---------------------------+
  • Returns the top-level document because the path is not specified:

    SELECT
    BSON_EXTRACT_ALL_BSON('{"c":[{"a":[{"b":1},{"b":2},{"b":3},{"b":4}]}]}':>BSON):>JSON AS Result;
    +-------------------------------------------------+
    | Result                                          |
    +-------------------------------------------------+
    | {"c":[{"a":[{"b":1},{"b":2},{"b":3},{"b":4}]}]} |
    +-------------------------------------------------+
  • Returns NULL because the specified path does not exist in the BSON document:

    SELECT
    BSON_EXTRACT_ALL_BSON('{"c":[{"a":[{"b":1},{"b":2},{"b":3},{"b":4}]}]}':>BSON, 'c', 'd'):>JSON AS Result;
    +--------+
    | Result |
    +--------+
    | NULL   |
    +--------+

Last modified: July 10, 2025

Was this article helpful?

Verification instructions

Note: You must install cosign to verify the authenticity of the SingleStore file.

Use the following steps to verify the authenticity of singlestoredb-server, singlestoredb-toolbox, singlestoredb-studio, and singlestore-client SingleStore files that have been downloaded.

You may perform the following steps on any computer that can run cosign, such as the main deployment host of the cluster.

  1. (Optional) Run the following command to view the associated signature files.

    curl undefined
  2. Download the signature file from the SingleStore release server.

    • Option 1: Click the Download Signature button next to the SingleStore file.

    • Option 2: Copy and paste the following URL into the address bar of your browser and save the signature file.

    • Option 3: Run the following command to download the signature file.

      curl -O undefined
  3. After the signature file has been downloaded, run the following command to verify the authenticity of the SingleStore file.

    echo -n undefined |
    cosign verify-blob --certificate-oidc-issuer https://oidc.eks.us-east-1.amazonaws.com/id/CCDCDBA1379A5596AB5B2E46DCA385BC \
    --certificate-identity https://kubernetes.io/namespaces/freya-production/serviceaccounts/job-worker \
    --bundle undefined \
    --new-bundle-format -
    Verified OK