BSON_EXTRACT_BOOL

Warning

SingleStore 9.0 gives you the opportunity to preview, evaluate, and provide feedback on new and upcoming features prior to their general availability. In the interim, SingleStore 8.9 is recommended for production workloads, which can later be upgraded to SingleStore 9.0.

Syntax

BSON_EXTRACT_BOOL(<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

SingleStore TINYINT type.

Remarks

The following table specifies the value returned by BSON_EXTRACT_BOOL() for each input value:

Input Value	Output Value
BSON boolean `true`	1
BSON boolean `false`	0
BSON `NULL`	`NULL`
Any other value or a non-boolean BSON type	`NULL`

Examples

Note: The following examples explicitly cast string to BSON for clarity.

The following examples extract a boolean value:

SQL

SELECT BSON_EXTRACT_BOOL('{"a":{"b":true}}':>BSON, 'a', 'b') AS Result;

+--------+
| Result |
+--------+
|      1 |
+--------+

SQL

SELECT BSON_EXTRACT_BOOL('{"a":{"b":false}}':>BSON, 'a', 'b') AS Result;

+--------+
| Result |
+--------+
|      0 |
+--------+