6.2.2. 独自のテーブルメタデータ情報を追加する¶

6.2.2.1.1. テーブル・キャプション情報¶

6.2.2.1.2. サンプルSQL情報¶

-- SQLクエリの説明１
-- SQLクエリの説明１
SELECT
  ...
FROM
  ...
WHERE
  ...
ORDER BY ...
;

-- SQLクエリの説明２
-- SQLクエリの説明２
SELECT
  ...
FROM
  ...
WHERE
  ...
ORDER BY ...
;

• SQLクエリには必ずコメントで説明を記載してください。

• SQLの最後は ; （セミコロン）で終えて、改行してください。

• 複数のサンプルクエリを記載する場合は、クエリ間に空白行を入れてください。

• プリペアドステートメントは使用せずに、データベース操作などでそのまま実行可能な SQL を用意してください。

  • データベース操作については、「システム管理者操作ガイド」-「データベース操作」を参照してください。

• 利用しているデータベースで実行可能な SQL を用意してください。

• example_query_xxx.sql

  ※ xxxの部分は任意

  （例）example_query_viewcreator.sql

6.2.2.1.3. テーブルカテゴリ情報¶

{
    "summary":"カテゴリの要約文を書いてください",
    "description":"カテゴリの詳細説明文を書いてください",
    "tables":[
        {
            "name":"テーブル物理名"
        },
        {
            "name":"テーブル物理名にマッチする正規表現"
        }
    ],
    "categories":[
        {
            "summary":"サブカテゴリの要約文を書いてください",
            "description":"サブカテゴリの詳細説明を書いてください",
            "tables":[],
            "categories":[]
        }
  ]
}

• （例）sample_table_1, sample_table_2をまとめて指定する場合

  "tables":[
      {
          "name":"^sample_table_.*"
      }
  ]

• table_category_xxx.json

  ※ xxxの部分は任意

  （例）table_category_viewcreator.json