NEW T-SQL FEATURES IN SQL SERVER 2016 – XII | OPENJSON Function (SQL Server)
In this post we shall check out the new features Microsoft introduced in SQL Server 2016 | OPENJSON Function (SQL Server)
New feature – XII | OPENJSON Function (SQL Server)
From Microsoft – The OPENJSON rowset function converts JSON text into a set of rows and columns. After you transform a JSON collection into a rowset with OPENJSON, you can run any SQL query on the returned data or insert it into a SQL Server table.
The OPENJSON function takes a single JSON object or a collection of JSON objects and transforms them into one or more rows. By default, the OPENJSON function returns the following data:+
1. From a JSON object, the function returns all the key:value pairs that it finds at the first level.
2. From a JSON array, the function returns all the elements of the array with their indexes.
You can add an optional WITH clause to provide a schema that explicitly defines the structure of the output.
Notes
1. The OPENJSON function is available only under compatibility level 130. We can’t find and run the OPENJSON function below this
compatibility level. You can change the compatibility level of a database by using the following command:
--
ALTER DATABASE <DatabaseName> SET COMPATIBILITY_LEVEL = 130
--
|
2. The OPENJSON has two flavors – default output and explicit structure.
3. OPENJSON with the default output
When you use the OPENJSON function without providing an explicit schema for the results – that is, without a WITH clause after OPENJSON – the function returns a table with the following three columns:
Key -> Name of the property(If Present) else index
value -> Property value(Data)
type -> An integer value means the type of the value.
4. OPENJSON output with an explicit structure
When you specify a schema for the results by using the WITH clause of the OPENJSON function, the function returns a table with only the columns that you define in the WITH clause. In the optional WITH clause, you specify a set of output columns, their types, and the paths of the JSON source properties for each output value. OPENJSON iterates through the array of JSON objects, reads the value on the specified path for each column, and converts the value to the specified type.
Examples
/* Using Option 1 – OPENJSON with the default output | Default Columns key, value and type */
--
DECLARE @j NVARCHAR(MAX)
SET @j='{"name":"Pawan","MiddleName":"Kumar","Surname":"Khowal","Class":10,"SkillSet":["SQL","SSIS","SSRS","SSAS"],"IsDatabaseDeveloper":true}';
SELECT * FROM OPENJSON(@j)
GO
OUTPUT
key value type
--------------------------- --------------------------------------------- ----
name Pawan 1
MiddleName Kumar 1
Surname Khowal 1
Class 10 2
SkillSet ["SQL","SSIS","SSRS","SSAS"] 4
IsDatabaseDeveloper true 3
(6 rows affected)
--
|
/* Using Option 1 – OPENJSON with the default output | Columns key and value */
--
DECLARE @j NVARCHAR(MAX)
SET @j='{"name":"Pawan","MiddleName":"Kumar","Surname":"Khowal","Class":10,"SkillSet":["SQL","SSIS","SSRS","SSAS"],"IsDatabaseDeveloper":true}';
SELECT [Key],[Value] FROM OPENJSON(@j)
GO
OUTPUT
Key Value
--------------------------------- ----------------------------------
name Pawan
MiddleName Kumar
Surname Khowal
Class 10
SkillSet ["SQL","SSIS","SSRS","SSAS"]
IsDatabaseDeveloper true
(6 rows affected)
--
|
/* Using Option 1 – OPENJSON with the default output | Get DATA FROM Object/Array from JSON without Property – SkillSet */
--
DECLARE @j NVARCHAR(MAX)
SET @j='{"name":"Pawan","MiddleName":"Kumar","Surname":"Khowal","Class":10,"SkillSet":["SQL","SSIS","SSRS","SSAS"],"IsDatabaseDeveloper":true}';
SELECT [Key],[Value] FROM OPENJSON(@j,'$.SkillSet')
GO
OUTPUT
Key Value
--------------------- -----------
0 SQL
1 SSIS
2 SSRS
3 SSAS
(4 rows affected)
--
|
/* Using Option 1 – OPENJSON with the default output | Get DATA FROM Object/Array from JSON with Property – Add */
--
DECLARE @j NVARCHAR(MAX)
SET @j = '{"Name":"Pawan","Add":{"State":"Illinois","Country":"Chicago"}}'
SELECT [Key],[Value] FROM OPENJSON(@j, '$.Add')
GO
OUTPUT
Key Value
--------------------- -------------
State Illinois
Country Chicago
(2 rows affected)
--
|
/* Using Option 1 – OPENJSON with the default output | Get DATA FROM single object..Just to split the data */
--
DECLARE @j NVARCHAR(MAX)
SET @j = '[1,2,8,121,121,12,8910,17]'
SELECT [Key],[Value] FROM OPENJSON(@j)
GO
OUTPUT
Key Value
-------------------------- --------------
0 1
1 2
2 8
3 121
4 121
5 12
6 8910
7 17
(8 rows affected)
--
|
/* Using Option 2 – OPENJSON output with an explicit structure | Get DATA FROM object..Add */
--
DECLARE @j NVARCHAR(MAX)
SET @j = '{"Name":"Pawan","Add":{"State":"Illinois","Country":"Chicago"}}'
SELECT * FROM OPENJSON(@j, '$.Add')
WITH ( [State] VARCHAR(20) , [Country] VARCHAR(50) )
GO
OUTPUT
State Country
-------------------- --------------------------------------------------
Illinois Chicago
(1 row affected
--
|
/* Using Option 2 – OPENJSON output with an explicit structure | Get DATA FROM object..Add and Name from the outer data */
--
DECLARE @j NVARCHAR(MAX)
SET @j = '{"Devs":[{"Name":"Pawan","Adda":{"State":"Illinois","Country":"Chicago"}}]}'
SELECT * FROM OPENJSON(@j,'$.Devs')
WITH ( [Name] VARCHAR(10) '$.Name', [State] VARCHAR(20) '$.Adda.State', [Country] VARCHAR(20) '$.Adda.Country' )
GO
OUTPUT
Name State Country
---------- -------------------- --------------------
Pawan Illinois Chicago
(1 row affected)
--
|
/* Using Option 2 – OPENJSON output with an explicit structure | Get DATA FROM object..Add and Name from the outer data */
--
DECLARE @j NVARCHAR(MAX)
SET @j = '{"Name":"Pawan","Adda":{"State":"Illinois","Country":"Chicago"}}'
SELECT * FROM OPENJSON(@j)
WITH ( [Name] VARCHAR(10), [State] VARCHAR(20) '$.Adda.State', [Country] VARCHAR(20) '$.Adda.Country' )
GO
OUTPUT
Name State Country
---------- -------------------- --------------------
Pawan Illinois Chicago
(1 row affected)
--
|
Refer Microsoft LINK below for more details-
Enjoy !!! Keep Learning
Pawan Khowal
Http://MSBISkills.com
Improving my SQL BI Skills 