JSON_EXTRACT_SCALAR

​

Syntax

​

Scalar

json_extract_scalar(json_string, path)

​

Json value plain (scalar)

json_value(json_string, path)

• Takes two arguments, JSON_VALUE(json_string, path), and returns STRING. ON EMPTY, ON ERROR, PASSING, and other RETURNING types are outside this alias’s supported forms.

​

Arguments

​

Scalar, json value plain

​

Returns

• Type: STRING
• NULL behavior: NULL inputs or a missing or invalid path return NULL. Objects and arrays return NULL. A JSON null scalar returns the text null.

​

Properties

​

Units

• Input unit: Array path indices are zero based.
• Output unit: Text

​

Usage notes

• Array indices are zero based.
• JSON strings are unquoted; numbers and Booleans become their textual representations.
• JSON null handling here differs from GET_JSON_OBJECT.
• JSON_VALUE uses the same extraction rules as JSON_EXTRACT_SCALAR and returns STRING. Use its two-argument form.
• Deterministic: The same inputs and settings produce the same result.

​

Examples

​

Typical behavior

SELECT json_extract_scalar('{"a":7}', '$.a') AS "value";

​

JSON_VALUE default STRING form

• Takes two arguments, JSON_VALUE(json_string, path), and returns STRING. ON EMPTY, ON ERROR, PASSING, and other RETURNING types are outside this alias’s supported forms.

SELECT json_value('{"a":7}', '$.a') AS "value";

​

Limitations

• Use the path syntax and extraction forms shown on this page.
• JSON_VALUE takes two arguments and returns STRING. ON EMPTY, ON ERROR, and PASSING clauses are not supported.
• A RETURNING clause does not change the STRING result type. Do not use it to request a typed result.

​

Related functions

• json_extract
• get_json_object