MariaDBでJSONデータをバリデーション：JSON_SCHEMA_VALID関数の実践ガイド

MariaDB JSON_SCHEMA_VALID 関数：詳細解説

JSON_SCHEMA_VALID 関数は、MariaDB 10.2.7 以降で利用可能な関数で、JSON データが指定された JSON スキーマに準拠しているかどうかを検証します。検証結果は、1（真）または 0（偽）で返されます。

構文

JSON_SCHEMA_VALID(json_schema, json_document)

引数

• json_schema: JSON スキーマを文字列で指定します。
• json_document: 検証対象の JSON データを文字列で指定します。

スキーマ定義

JSON スキーマは、JSON オブジェクトで記述されます。スキーマは、以下の要素で構成されます。

• type: データ型を指定します。有効な値は、string、number、boolean、object、array、null です。
• properties: オブジェクトの場合、プロパティとそのスキーマを定義します。
• items: 配列の場合、要素のスキーマを定義します。
• required: オブジェクトの場合、必須のプロパティをカンマ区切りで列挙します。
• additionalProperties: オブジェクトの場合、定義されていないプロパティを許可するかどうかを指定します。
• minimum: 数値の場合、最小値を指定します。
• pattern: 文字列の場合、正規表現パターンを指定します。

詳細解説

JSON_SCHEMA_VALID 関数は、以下のルールに基づいて JSON データを検証します。

• json_schema と json_document は、どちらも有効な JSON 文字列である必要があります。
• json_document は、json_schema で定義されたスキーマに準拠している必要があります。

例

-- スキーマ定義
SET @schema = '{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "required": true
    },
    "age": {
      "type": "number",
      "minimum": 18
    }
  }
}';

-- データ検証
SELECT JSON_SCHEMA_VALID(@schema, '{ "name": "John Doe", "age": 25 }'); -- 1 (真)
SELECT JSON_SCHEMA_VALID(@schema, '{ "age": 15 }'); -- 0 (偽)

エラー処理

JSON_SCHEMA_VALID 関数は、検証エラーが発生した場合、エラーメッセージを mariadb.error_message システム変数に格納します。

その他の JSON 関数

MariaDB は、JSON_SCHEMA_VALID 関数以外にも、JSON データを操作するための様々な関数を提供しています。詳細は、MariaDB ドキュメントの JSON Functions: [無効な URL を削除しました] を参照してください。

MariaDB JSON_SCHEMA_VALID 関数：サンプルコード

-- スキーマ定義
SET @schema = '{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "required": true
    },
    "age": {
      "type": "number",
      "minimum": 18
    }
  }
}';

-- 正常なデータ
SELECT JSON_SCHEMA_VALID(@schema, '{ "name": "John Doe", "age": 25 }'); -- 1 (真)

-- 誤ったデータ
SELECT JSON_SCHEMA_VALID(@schema, '{ "name": 123 }'); -- 0 (偽)
SELECT JSON_SCHEMA_VALID(@schema, '{ "age": 15 }'); -- 0 (偽)

配列の検証

-- スキーマ定義
SET @schema = '{
  "type": "array",
  "items": {
    "type": "number",
    "minimum": 10
  }
}';

-- 正常なデータ
SELECT JSON_SCHEMA_VALID(@schema, '[12, 15, 20]'); -- 1 (真)

-- 誤ったデータ
SELECT JSON_SCHEMA_VALID(@schema, '[12, "abc", 20]'); -- 0 (偽)
SELECT JSON_SCHEMA_VALID(@schema, '[5, 10]'); -- 0 (偽)

ネストされたオブジェクトの検証

-- スキーマ定義
SET @schema = '{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "required": true
    },
    "address": {
      "type": "object",
      "properties": {
        "street": {
          "type": "string",
          "required": true
        },
        "city": {
          "type": "string",
          "required": true
        }
      }
    }
  }
}';

-- 正常なデータ
SELECT JSON_SCHEMA_VALID(@schema, '{ "name": "John Doe", "address": { "street": "123 Main Street", "city": "San Francisco" } }'); -- 1 (真)

-- 誤ったデータ
SELECT JSON_SCHEMA_VALID(@schema, '{ "name": "John Doe" }'); -- 0 (偽)
SELECT JSON_SCHEMA_VALID(@schema, '{ "name": "John Doe", "address": { "street": 123 } }'); -- 0 (偽)

その他のサンプル

• 文字列の検証: JSON_SCHEMA_VALID('{ "type": "string" }', 'Hello, world!')
• 数値の検証: JSON_SCHEMA_VALID('{ "type": "number", "minimum": 10 }', 15)
• ブール値の検証: JSON_SCHEMA_VALID('{ "type": "boolean" }', true)
• null 値の検証: JSON_SCHEMA_VALID('{ "type": "null" }', null)

エラー処理

-- スキーマ定義
SET @schema = '{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "required": true
    }
  }
}';

-- 検証エラー
SELECT JSON_SCHEMA_VALID(@schema, '{ }');

SELECT mariadb.error_message;
-- 'The document must contain a property named "name".'

JSON 関数の詳細

MariaDB は、JSON_SCHEMA_VALID 関数以外にも、JSON データを操作するための様々な関数を提供しています。詳細は、MariaDB ドキュメントの JSON Functions: [無効な URL を削除しました] を参照してください。

JSON データの検証方法

これらのツールは、ブラウザ上で無料で利用できます。

これらのライブラリは、プログラム上で JSON データの検証を行うことができます。

自作のプログラム

JSON スキーマに基づいて、独自のプログラムを作成することも可能です。

JSON_SCHEMA_VALID 関数と比較した各方法のメリットとデメリット

• 検証の複雑さ
• プログラミングスキル
• 開発コスト