JSON_VALUE (Transact-SQL)

Applies to: SQL Server 2016 (13.x) and later versions Azure SQL Database Azure SQL Managed Instance Azure Synapse Analytics SQL analytics endpoint in Microsoft Fabric Warehouse in Microsoft Fabric SQL database in Microsoft Fabric

The JSON_VALUE syntax extracts a scalar value from a JSON string.

To extract an object or an array from a JSON string instead of a scalar value, see JSON_QUERY. For info about the differences between JSON_VALUE and JSON_QUERY, see Compare JSON_VALUE and JSON_QUERY.

Transact-SQL syntax conventions

Syntax

JSON_VALUE ( expression , path [ RETURNING data_type ] )

Arguments

expression

An expression. Typically the name of a variable or a column that contains JSON text.

If JSON_VALUE finds JSON that isn't valid in expression before it finds the value identified by path, the function returns an error. If JSON_VALUE doesn't find the value identified by path, it scans the entire text and returns an error if it finds JSON that isn't valid anywhere in expression.

path

A JSON path that specifies the property to extract. For more info, see JSON Path Expressions in the SQL Database Engine.

In SQL Server 2017 (14.x) and in Azure SQL Database, you can provide a variable as the value of path.

If the format of path isn't valid, JSON_VALUE returns an error.

data_type

Return the value specified in the SQL type. Only supported if the input is a JSON type. The supported SQL types are: tinyint, smallint, int, bigint, decimal, numeric, float, real, char, varchar, varchar(max), nchar, nvarchar, nvarchar(max), date, time, datetime2, and datetimeoffset.

Return value

If RETURNING isn't included:

• Returns a single text value of type nvarchar(4000). The collation of the returned value is the same as the collation of the input expression.

• If the value is greater than 4000 characters:

  • In lax mode, JSON_VALUE returns NULL.
  • In strict mode, JSON_VALUE returns an error.

  If you have to return scalar values greater than 4000 characters, use OPENJSON instead of JSON_VALUE. For more info, see OPENJSON.

If RETURNING is included:

Returns the value specified in the SQL type. The supported SQL types are: tinyint, smallint, int, bigint, decimal, numeric, float, real, char, varchar, varchar(max), nchar, nvarchar, nvarchar(max), date, time, datetime2, and datetimeoffset.

JSON functions work the same whether the JSON document is stored in varchar, nvarchar, or the native json data type.

Remarks

Lax mode and strict mode

Consider the following JSON text:

DECLARE @jsonInfo AS NVARCHAR (MAX);

SET @jsonInfo = N'{
     "info":{
       "type":1,
       "address":{
         "town":"Bristol",
         "county":"Avon",
         "country/region":"England"
       },
       "tags":["Sport", "Water polo"]
    },
    "type":"Basic"
 }';

The following table compares the behavior of JSON_VALUE in lax mode and in strict mode. For more info about the optional path mode specification (lax or strict), see JSON Path Expressions in the SQL Database Engine.

Examples

Example 1

The following example uses the values of the JSON properties town and state in query results. Since JSON_VALUE preserves the collation of the source, the sort order of the results depends on the collation of the jsonInfo column.

SELECT FirstName,
       LastName,
       JSON_VALUE(jsonInfo, '$.info.address.town') AS Town
FROM Person.Person
WHERE JSON_VALUE(jsonInfo, '$.info.address.state') LIKE 'US%'
ORDER BY JSON_VALUE(jsonInfo, '$.info.address.town');

Example 2

The following example extracts the value of the JSON property town into a local variable.

DECLARE @jsonInfo AS NVARCHAR (MAX);
DECLARE @town AS NVARCHAR (32);

SET @jsonInfo = N'{"info":{"address":[{"town":"Paris"},{"town":"London"}]}}';
SET @town = JSON_VALUE(@jsonInfo, '$.info.address[0].town'); -- Paris
SET @town = JSON_VALUE(@jsonInfo, '$.info.address[1].town'); -- London

Example 3

The following example creates computed columns based on the values of JSON properties.

CREATE TABLE dbo.Store
(
    StoreID INT IDENTITY (1, 1) NOT NULL,
    Address VARCHAR (500),
    jsonContent NVARCHAR (4000),
    Longitude AS JSON_VALUE(jsonContent, '$.address[0].longitude'),
    Latitude AS JSON_VALUE(jsonContent, '$.address[0].latitude')
);

Example 4

The following example extracts a value from JSON array using JSON_VALUE and returns the value as a date type value.

DECLARE @j AS JSON = '[1, 1.3333, true, "a", "1", "2025-01-01"]';

SELECT JSON_VALUE(@j, '$[5]' RETURNING date) AS date_value;

date_value
--------
2025-01-01

Related content

• JSON Path Expressions in the SQL Database Engine
• JSON data in SQL Server