BSON_EXTRACT_BINARY

Extracts and returns the BSON binary value while ignoring the subtype, optionally at the specified path.

Syntax

BSON_EXTRACT_BINARY(<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 LONGBLOB value.

Remarks

  • BSON_EXTRACT_BINARY() enables support for comparing binary values in BSON_MATCH_ANY() via MATCH_PARAM_BINARY_STRICT().

  • If the value at the specified path is not a BSON binary value, BSON_EXTRACT_BINARY() returns SQL NULL.

Examples

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

  • Returns the binary value at the specified path:

    SELECT
    BSON_EXTRACT_BINARY('{"a":{"$binary":{"base64":"QUJDRA==","subType":"0"}}}':>BSON, 'a') AS Result;
    +--------+
    | Result |
    +--------+
    | ABCD   |
    +--------+
    SELECT
    BSON_EXTRACT_BINARY('[{"$binary":{"base64":"MTIzNA==","subType":"02"}}]':>BSON, '0') AS Result;
    +--------+
    | Result |
    +--------+
    | 1234   |
    +--------+
  • Returns SQL NULL because the value at the specified path is not a BSON binary value:

    SELECT
    BSON_EXTRACT_BINARY('{"a":{"$binary":{"base64":"QUJDRA==","subType":"0"}}, "b":50}':>BSON, 'b') 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