Important

Self-managed SingleStore will soon transition from version 9.1 RC to version 10. This new semantic versioning scheme will provide SingleStore with finer control over engine and feature releases that were not possible with the current versioning scheme.

In the interim, SingleStore 9.1 RC can be used to preview, evaluate, and provide feedback on the new and upcoming features in SingleStore 10 prior to its general availability. Ahead of this transition, SingleStore 9.0 is recommended for production workloads, which can later be upgraded to SingleStore 10.

BSON_EXTRACT_BINARY

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:

SQL

SELECT
BSON_EXTRACT_BINARY('{"a":{"$binary":{"base64":"QUJDRA==","subType":"0"}}}':>BSON, 'a') AS Result;

+--------+
| Result |
+--------+
| ABCD   |
+--------+

SQL

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:

SQL

SELECT
BSON_EXTRACT_BINARY('{"a":{"$binary":{"base64":"QUJDRA==","subType":"0"}}, "b":50}':>BSON, 'b') AS Result;

+--------+
| Result |
+--------+
| NULL   |
+--------+