📣
TiDB Cloud Essential はパブリックプレビュー中です。このページは自動翻訳されたものです。原文はこちらからご覧ください。
AI
開発者向け
ベストプラクティス
API

JSONドキュメントを検証するJSON関数

TiDB は、MySQL 8.0 で利用可能なJSONスキーマ検証関数のほとんどをサポートしています。

注記：

現在、この機能はクラスターTiDB CloudスターターおよびTiDB Cloudエッセンシャルでは利用できません。

JSON_SCHEMA_VALID()

JSON_SCHEMA_VALID(schema, json_doc)関数は、データの整合性と一貫性を確保するために、スキーマに対して JSON ドキュメントを検証します。

これをチェック制約と一緒に使用すると、テーブルが変更されたときに自動スキーマ検証を行うことができます。

この関数はJSONスキーマ仕様に従います。

サポートされている検証キーワードは次のとおりです。

検証キーワード適用タイプ説明
typeどれでもタイプをテストします（ arrayやstringなど）
enumどれでも値が指定された値の配列内にあるかどうかをテストします
constどれでもenumと同様だが、単一の値である
allOfどれでも指定されたすべてのスキーマに一致します
anyOfどれでも指定されたスキーマのいずれかに一致する
multipleOfnumber / integer値が指定された値の倍数かどうかをテストします
maximumnumber / integer値が最大値（含む）を下回っているかどうかをテストします
exclusiveMaximumnumber / integer値が最大値（含まない）を下回っているかどうかをテストします
minimumnumber / integer値が最小値（含む）を超えているかどうかをテストします
exclusiveMinimumnumber / integer値が最小値（含まない）より大きいかどうかをテストします
maxlengthstring値の長さが指定された値を超えていないかどうかをテストします
minLengthstring値の長さが指定された値以上かどうかをテストします
formatstring文字列が名前付きフォーマットと一致するかどうかをテストします
patternstring文字列がパターンに一致するかどうかをテストします
itemsarray配列の項目に適用するスキーマ
prefixItemsarray配列の位置項目に適用するスキーマ
maxItemsarray配列内の項目数が指定された値を超えていないかどうかをテストします
minItemsarray配列内の項目数が指定された値以上かどうかをテストします
uniqueItemsarray配列内の項目が一意かどうかをテストしますtrue / false
containsarray配列に含まれる項目のスキーマを設定します
maxContainsarraycontainsと一緒に使用して、アイテムが存在できる最大回数をテストします。
minContainsarraycontainsと一緒に使用して、アイテムが存在できる最小回数をテストします。
propertiesobjectオブジェクトのプロパティに適用するスキーマ
patternPropertiesobjectプロパティ名のパターンマッチングに基づいて特定のプロパティに適用するスキーマ
additionalPropertiesobject追加のプロパティが許可されるかどうか、 true / false
minPropertiesobjectオブジェクトが持つことができるプロパティの最小数をテストします
maxPropertiesobjectオブジェクトが持つことができるプロパティの最大数をテストします
requiredobject指定されたプロパティ名がオブジェクト内に存在するかどうかをテストします

例:

いくつかの例では、次の JSON ドキュメントを使用します。

{
    "fruits": [
        "orange",
        "apple",
        "pear"
    ],
    "vegetables": [
        "carrot",
        "pepper",
        "kale"]
}

JSON ドキュメントを保持するにはユーザー定義変数を使用します。

SET @j := '{"fruits": ["orange", "apple", "pear"], "vegetables": ["carrot", "pepper", "kale"]}';

まず、次のタイプをテストします。

SELECT JSON_SCHEMA_VALID('{"type": "object"}',@j);

+--------------------------------------------+
| JSON_SCHEMA_VALID('{"type": "object"}',@j) |
+--------------------------------------------+
|                                          1 |
+--------------------------------------------+
1 row in set (0.00 sec)

SELECT JSON_SCHEMA_VALID('{"type": "array"}',@j);

+-------------------------------------------+
| JSON_SCHEMA_VALID('{"type": "array"}',@j) |
+-------------------------------------------+
|                                         0 |
+-------------------------------------------+
1 row in set (0.00 sec)

mysql> SELECT JSON_TYPE(@j);

+---------------+
| JSON_TYPE(@j) |
+---------------+
| OBJECT        |
+---------------+
1 row in set (0.00 sec)

上記の出力からわかるように、 @jの型はobjectです。これはJSON_TYPE()の出力と一致します。

ここで、特定の属性の存在を検証します。

SELECT JSON_SCHEMA_VALID('{"required": ["fruits","vegetables"]}',@j);

+---------------------------------------------------------------+
| JSON_SCHEMA_VALID('{"required": ["fruits","vegetables"]}',@j) |
+---------------------------------------------------------------+
|                                                             1 |
+---------------------------------------------------------------+
1 row in set (0.00 sec)

上記の出力では、属性fruitsとvegetablesの存在の検証が成功したことがわかります。

SELECT JSON_SCHEMA_VALID('{"required": ["fruits","vegetables","grains"]}',@j);

+------------------------------------------------------------------------+
| JSON_SCHEMA_VALID('{"required": ["fruits","vegetables","grains"]}',@j) |
+------------------------------------------------------------------------+
|                                                                      0 |
+------------------------------------------------------------------------+
1 row in set (0.00 sec)

上記の出力では、 grainsが存在しないため、 fruits 、 vegetables 、 grains属性の存在の検証が失敗していることがわかります。

ここで、 fruitsが配列であることを検証します。

SELECT JSON_SCHEMA_VALID('{"properties": {"fruits": {"type": "array"}}}',@j);

+-----------------------------------------------------------------------+
| JSON_SCHEMA_VALID('{"properties": {"fruits": {"type": "array"}}}',@j) |
+-----------------------------------------------------------------------+
|                                                                     1 |
+-----------------------------------------------------------------------+
1 row in set (0.01 sec)

上記の出力は、 fruitsが配列であることを確認しています。

SELECT JSON_SCHEMA_VALID('{"properties": {"fruits": {"type": "string"}}}',@j);

+------------------------------------------------------------------------+
| JSON_SCHEMA_VALID('{"properties": {"fruits": {"type": "string"}}}',@j) |
+------------------------------------------------------------------------+
|                                                                      0 |
+------------------------------------------------------------------------+
1 row in set (0.00 sec)

上記の出力は、 fruits文字列ではないことを示しています。

次に、配列内の項目の数を確認します。

SELECT JSON_SCHEMA_VALID('{"properties": {"fruits": {"type": "array", "minItems": 3}}}',@j);

+--------------------------------------------------------------------------------------+
| JSON_SCHEMA_VALID('{"properties": {"fruits": {"type": "array", "minItems": 3}}}',@j) |
+--------------------------------------------------------------------------------------+
|                                                                                    1 |
+--------------------------------------------------------------------------------------+
1 row in set (0.00 sec)

上記の出力は、 fruits少なくとも 3 つの項目を持つ配列であることを示しています。

SELECT JSON_SCHEMA_VALID('{"properties": {"fruits": {"type": "array", "minItems": 4}}}',@j);

+--------------------------------------------------------------------------------------+
| JSON_SCHEMA_VALID('{"properties": {"fruits": {"type": "array", "minItems": 4}}}',@j) |
+--------------------------------------------------------------------------------------+
|                                                                                    0 |
+--------------------------------------------------------------------------------------+
1 row in set (0.00 sec)

上記の出力は、 fruits少なくとも 4 つの項目を持つ配列ではないことを示しています。これは、最小項目数を満たしていないためです。

整数値の場合、特定の範囲内にあるかどうかを確認できます。

SELECT JSON_SCHEMA_VALID('{"type": "integer", "minimum": 40, "maximum": 45}', '42');
+------------------------------------------------------------------------------+
| JSON_SCHEMA_VALID('{"type": "integer", "minimum": 40, "maximum": 45}', '42') |
+------------------------------------------------------------------------------+
|                                                                            1 |
+------------------------------------------------------------------------------+
1 row in set (0.01 sec)

SELECT JSON_SCHEMA_VALID('{"type": "integer", "minimum": 40, "maximum": 45}', '123');

+-------------------------------------------------------------------------------+
| JSON_SCHEMA_VALID('{"type": "integer", "minimum": 40, "maximum": 45}', '123') |
+-------------------------------------------------------------------------------+
|                                                                             0 |
+-------------------------------------------------------------------------------+
1 row in set (0.00 sec)

文字列の場合、特定のパターンに一致するかどうかを検証できます。

SELECT JSON_SCHEMA_VALID('{"type": "string", "pattern": "^Ti"}', '"TiDB"');

+---------------------------------------------------------------------+
| JSON_SCHEMA_VALID('{"type": "string", "pattern": "^Ti"}', '"TiDB"') |
+---------------------------------------------------------------------+
|                                                                   1 |
+---------------------------------------------------------------------+
1 row in set (0.00 sec)

SELECT JSON_SCHEMA_VALID('{"type": "string", "pattern": "^Ti"}', '"PingCAP"');

+------------------------------------------------------------------------+
| JSON_SCHEMA_VALID('{"type": "string", "pattern": "^Ti"}', '"PingCAP"') |
+------------------------------------------------------------------------+
|                                                                      0 |
+------------------------------------------------------------------------+
1 row in set (0.00 sec)

値が特定の名前付きフォーマットに一致するかどうかを確認できます。検証可能なフォーマットにはipv4 、 ipv6 、 time 、 date 、 duration 、 email 、 hostname 、 uuid 、 uriなどがあります。

SELECT JSON_SCHEMA_VALID('{"format": "ipv4"}', '"127.0.0.1"');

+--------------------------------------------------------+
| JSON_SCHEMA_VALID('{"format": "ipv4"}', '"127.0.0.1"') |
+--------------------------------------------------------+
|                                                      1 |
+--------------------------------------------------------+
1 row in set (0.00 sec)

SELECT JSON_SCHEMA_VALID('{"format": "ipv4"}', '"327.0.0.1"');

+--------------------------------------------------------+
| JSON_SCHEMA_VALID('{"format": "ipv4"}', '"327.0.0.1"') |
+--------------------------------------------------------+
|                                                      0 |
+--------------------------------------------------------+
1 row in set (0.00 sec)

enum使用して、文字列が配列内にあるかどうかを確認することもできます。

SELECT JSON_SCHEMA_VALID('{"enum": ["TiDB", "MySQL"]}', '"TiDB"');

+------------------------------------------------------------+
| JSON_SCHEMA_VALID('{"enum": ["TiDB", "MySQL"]}', '"TiDB"') |
+------------------------------------------------------------+
|                                                          1 |
+------------------------------------------------------------+
1 row in set (0.00 sec)

SELECT JSON_SCHEMA_VALID('{"enum": ["TiDB", "MySQL"]}', '"MySQL"');

+-------------------------------------------------------------+
| JSON_SCHEMA_VALID('{"enum": ["TiDB", "MySQL"]}', '"MySQL"') |
+-------------------------------------------------------------+
|                                                           1 |
+-------------------------------------------------------------+
1 row in set (0.00 sec)

SELECT JSON_SCHEMA_VALID('{"enum": ["TiDB", "MySQL"]}', '"SQLite"');

+--------------------------------------------------------------+
| JSON_SCHEMA_VALID('{"enum": ["TiDB", "MySQL"]}', '"SQLite"') |
+--------------------------------------------------------------+
|                                                            0 |
+--------------------------------------------------------------+
1 row in set (0.00 sec)

anyOf使用すると、特定の要件を組み合わせて、いずれかの要件が満たされているかどうかを検証できます。

SELECT JSON_SCHEMA_VALID('{"anyOf": [{"type": "string"},{"type": "integer"}]}', '"TiDB"');

+------------------------------------------------------------------------------------+
| JSON_SCHEMA_VALID('{"anyOf": [{"type": "string"},{"type": "integer"}]}', '"TiDB"') |
+------------------------------------------------------------------------------------+
|                                                                                  1 |
+------------------------------------------------------------------------------------+
1 row in set (0.00 sec)

SELECT JSON_SCHEMA_VALID('{"anyOf": [{"type": "string"},{"type": "integer"}]}', '["TiDB", "MySQL"]');

+-----------------------------------------------------------------------------------------------+
| JSON_SCHEMA_VALID('{"anyOf": [{"type": "string"},{"type": "integer"}]}', '["TiDB", "MySQL"]') |
+-----------------------------------------------------------------------------------------------+
|                                                                                             0 |
+-----------------------------------------------------------------------------------------------+
1 row in set (0.00 sec)

SELECT JSON_SCHEMA_VALID('{"anyOf": [{"type": "string"},{"type": "integer"}]}', '5');

+-------------------------------------------------------------------------------+
| JSON_SCHEMA_VALID('{"anyOf": [{"type": "string"},{"type": "integer"}]}', '5') |
+-------------------------------------------------------------------------------+
|                                                                             1 |
+-------------------------------------------------------------------------------+
1 row in set (0.00 sec)

MySQLの互換性

  • JSON_SCHEMA_VALID()で検証するスキーマが無効な場合（例： {"type": "sting"} ）、MySQL はそれを受け入れる可能性がありますが、TiDB はエラーを返します。 "sting"にスペルミスがあり、正しくは"string"です。
  • MySQL は、JSON スキーマ標準の古いドラフト バージョンを使用します。

参照

このページは役に立ちましたか？