FOR JSON EXPLICIT

FOR JSON EXPLICIT

FOR JSON EXPLICIT は、カラムエイリアスを使用して、詳細なフォーマット仕様を提供します。エイリアスが存在しない場合は、指定されたカラムが値として出力されます。エイリアスは、ネストされた構造内で値 (またはオブジェクト) を表すのに必要です。

最初の 2 つのカラム select-list tag と parent に名前を付ける必要があります。複数のクエリを使用すると、各クエリ内のタグと親の関係を指定して、JSON 出力を返すことができます。

エイリアスディレクティブのフォーマットは [encapsulating_object!tag!name!qualifier] で、

! がディレクティブの基準を区切ります。
encapsulating_object は、select-list 項目のカプセル化 (配列) オブジェクトを生成します。
tag は、後続のクエリで使用されるカラムの識別子を定義します。ネスティングの基準 (親に対して) も作成します。
name は、(名前と値のペア) オブジェクトの名前を割り当てます。
qualifier は element (デフォルト) または hide のいずれかで、結果セットの要素を難読化します。

次のクエリは、FOR JSON EXPLICIT を使用して、Employees テーブルから従業員情報を返します。

SELECT
   1                AS tag,
   NULL             AS parent,
   emp.EmployeeID   AS [!1!EmployeeID],
   so.CustomerID    AS [!1!CustomerID],
   so.Region        AS [!1!Region]
FROM Employees AS emp KEY JOIN SalesOrders AS so WHERE emp.EmployeeID <= 195
ORDER BY 3
FOR JSON EXPLICIT;

結果は FOR JSON RAW の例と同じです。

[
   { "EmployeeID" : 129, "CustomerID" : 107, "Region" : "Eastern" },
   { "EmployeeID" : 129, "CustomerID" : 119, "Region" : "Western" },
   ...
   { "EmployeeID" : 129, "CustomerID" : 131, "Region" : "Eastern" },
   { "EmployeeID" " 195, "CustomerID" : 176, "Region" : "Eastern" }
]

次の例は、FOR JSON AUTO の例に似た結果を返します。

SELECT
      1              AS tag,
      NULL           AS parent,
      emp.EmployeeID AS [emp!1!EmployeeID],
      null           AS [so!2!CustomerID],
      null           AS [!2!Region]
FROM Employees as emp where emp.EmployeeID <= 195
UNION ALL
SELECT
      2,
      1,
      emp.EmployeeID,
      so.CustomerID,
      so.Region
FROM Employees as emp KEY JOIN SalesOrders as so where emp.EmployeeID <= 195
ORDER BY 3, 1
FOR JSON EXPLICIT;

上記のクエリは、次の結果を返します。

[
  {"emp": [{"EmployeeID":102}]},
  {"emp":[{"EmployeeID":105}]},
  {"emp":
    [{"EmployeeID":129,
      "so":[
        {"CustomerID":101,"Region":"Eastern"},
        ...
        {"CustomerID":205,"Region":"Eastern"}
      ]
    }]
  },
  {"emp":[{"EmployeeID":148}]},
  {"emp":[{"EmployeeID":160}]},
  {"emp":[{"EmployeeID":184}]},
  {"emp":[{"EmployeeID":191}]},
  {"emp":
    [{"EmployeeID":195,
      "so":[
        {"CustomerID":101,"Region":"Eastern"},
	...
        {"CustomerID":209,"Region":"Western"}
      ]
    }]
  }
]

配列の順序と受注のない従業員を含めること以外で、上記のフォーマットが FOR JSON AUTO の結果と異なるのは、emp が構造の配列であることだけです。FOR JSON AUTO では、emp だけが単一のオブジェクトを持っていると理解されます。FOR JSON EXPLICIT は、集合をサポートする配列のカプセル化を使用します。

次の例では、emp のカプセル化を削除して、値として Region を返します。この例は、FOR JSON EXPLICIT モードが細かいフォーマット制御を行って、RAW モードと AUTO モード間で対象を生成する方法を示します。

SELECT
      1              AS tag,
      NULL           AS parent,
      emp.EmployeeID AS [!1!EmployeeID],			// remove "emp" encapsulation
      null           AS [so!2!id],				  // change "CustomerID" to just "id"
      null           AS [!2!]					   // stipulate that region should be emitted as a value
FROM Employees AS emp WHERE emp.EmployeeID <= 195
UNION ALL
SELECT
      2,
      1,
      emp.EmployeeID,
      so.CustomerID,
      so.Region
FROM Employees as emp KEY JOIN SalesOrders AS so WHERE emp.EmployeeID <= 195
ORDER BY 3, 1
FOR JSON EXPLICIT;

クエリの結果で、so はオブジェクトの配列ではなくなっていますが、2 次元の配列となっています。

[
  {"EmployeeID":102},{"EmployeeID":105},{"EmployeeID":129,
    "so":[
      [{"id":101},"Eastern"],
      ...
      [{"id":205},"Eastern"]
    ]
  },
  {"EmployeeID":148},
  {"EmployeeID":160},
  {"EmployeeID":184},
  {"EmployeeID":191},
  {"EmployeeID":195,
    "so":[
      [{"id":101},"Eastern"],
      ...
      [{"id":209},"Western"]
    ]
  }
]

次の例は、FOR JSON RAW を使用した場合に似ていますが、employeeID、CustomerID、Region が名前／値のペアとしてではなく、値として出力されます。

SELECT
      1               AS tag,
      NULL            AS parent,
      emp.EmployeeID,	// no alias directives
      so.CustomerID,
      so.Region
FROM Employees AS emp KEY JOIN SalesOrders AS so WHERE emp.EmployeeID <= 195
ORDER BY 3
FOR JSON EXPLICIT;

クエリが、EmployeeID、CustomerID、Region で構成される 2 次元配列を生成する結果を返します。

[
  [129,107,"Eastern"],
  ...
  [195,176,"Eastern"]
]

ARRAY コンストラクタ [複合]

FOR JSON EXPLICIT

構文

使用法

例

参照