ClickHouse/docs/ja/operations/system-tables/information_schema.md
2024-11-18 11:58:58 +09:00

23 KiB
Raw Blame History

slug
/ja/operations/system-tables/information_schema

INFORMATION_SCHEMA

INFORMATION_SCHEMA(またはinformation_schema)は、データベースオブジェクトのメタデータに関する(多少)標準化されたDBMSに依存しないビューを提供するシステムデータベースです。INFORMATION_SCHEMAのビューは通常のシステムテーブルに比べて性能が劣ることがありますが、ツールはこれを使用して複数のDBMSにまたがって基本情報を取得することができます。INFORMATION_SCHEMA内のビューの構造と内容は後方互換性を持ちながら進化することが想定されており、新しい機能が追加されるだけで、既存の機能は変更されたり削除されたりしません。内部実装に関しては、INFORMATION_SCHEMA内のビューは通常、system.columnssystem.databases、そしてsystem.tablesのような通常のシステムテーブルにマッピングされます。

SHOW TABLES FROM INFORMATION_SCHEMA;

-- または:
SHOW TABLES FROM information_schema;
┌─name────────────────────┐
│ COLUMNS                 │
│ KEY_COLUMN_USAGE        │
│ REFERENTIAL_CONSTRAINTS │
│ SCHEMATA                │
| STATISTICS              |
│ TABLES                  │
│ VIEWS                   │
│ columns                 │
│ key_column_usage        │
│ referential_constraints │
│ schemata                │
| statistics              |
│ tables                  │
│ views                   │
└─────────────────────────┘

INFORMATION_SCHEMAには以下のビューが含まれます:

互換性のため、大文字と小文字を区別しない等価なビュー、例:INFORMATION_SCHEMA.columnsが提供されています。このことは、これらのビュー内のすべてのカラムにも当てはまり、小文字(例:table_name)と大文字(例:TABLE_NAME)のバリエーションが提供されています。

COLUMNS

system.columnsシステムテーブルから読み取ったカラムと、ClickHouseでサポートされていないか、意味をなさない常にNULL)が、標準によって必要なカラムを含みます。

カラム:

  • table_catalog (String) — テーブルが所在するデータベースの名前。
  • table_schema (String) — テーブルが所在するデータベースの名前。
  • table_name (String) — テーブル名。
  • column_name (String) — カラム名。
  • ordinal_position (UInt64) — カラムがテーブル内で何番目にあるかを示す位置。1から始まります。
  • column_default (String) — デフォルト値の式、または定義されていない場合は空文字列。
  • is_nullable (UInt8) — カラムタイプがNullableかどうかを示すフラグ。
  • data_type (String) — カラムタイプ。
  • character_maximum_length (Nullable(UInt64)) — バイナリデータ、文字データ、またはテキストデータおよび画像の最大長バイト。ClickHouseではFixedStringデータタイプにのみ意味を持ちます。それ以外の場合はNULLが返されます。
  • character_octet_length (Nullable(UInt64)) — バイナリデータ、文字データ、またはテキストデータおよび画像の最大長バイト。ClickHouseではFixedStringデータタイプにのみ意味を持ちます。それ以外の場合はNULLが返されます。
  • numeric_precision (Nullable(UInt64)) — 近似的または正確な数値データ、整数データ、または金額データの精度。ClickHouseでは整数型のビット幅およびDecimal型の精度。その他の場合はNULLが返されます。
  • numeric_precision_radix (Nullable(UInt64)) — 近似的または正確な数値データ、整数データまたは金額データの精度の基。ClickHouseでは整数型の基が2、Decimal型の基が10です。その他の場合はNULLが返されます。
  • numeric_scale (Nullable(UInt64)) — 近似的または正確な数値データ、整数データ、または金額データのスケール。ClickHouseではDecimal型にのみ意味があります。それ以外の場合はNULLが返されます。
  • datetime_precision (Nullable(UInt64)) — DateTime64データタイプの小数の精度。その他のデータタイプの場合はNULLが返されます。
  • character_set_catalog (Nullable(String)) — NULL、サポートされていません。
  • character_set_schema (Nullable(String)) — NULL、サポートされていません。
  • character_set_name (Nullable(String)) — NULL、サポートされていません。
  • collation_catalog (Nullable(String)) — NULL、サポートされていません。
  • collation_schema (Nullable(String)) — NULL、サポートされていません。
  • collation_name (Nullable(String)) — NULL、サポートされていません。
  • domain_catalog (Nullable(String)) — NULL、サポートされていません。
  • domain_schema (Nullable(String)) — NULL、サポートされていません。
  • domain_name (Nullable(String)) — NULL、サポートされていません。
  • extra (Nullable(String)) — MATERIALIZED型カラムの場合はSTORED GENERATEDALIAS型カラムの場合はVIRTUAL GENERATEDDEFAULT型カラムの場合はDEFAULT_GENERATED、またはNULL

クエリ:

SELECT table_catalog,
       table_schema,
       table_name,
       column_name,
       ordinal_position,
       column_default,
       is_nullable,
       data_type,
       character_maximum_length,
       character_octet_length,
       numeric_precision,
       numeric_precision_radix,
       numeric_scale,
       datetime_precision,
       character_set_catalog,
       character_set_schema,
       character_set_name,
       collation_catalog,
       collation_schema,
       collation_name,
       domain_catalog,
       domain_schema,
       domain_name,
       column_comment,
       column_type
FROM INFORMATION_SCHEMA.COLUMNS
WHERE (table_schema = currentDatabase() OR table_schema = '')
  AND table_name NOT LIKE '%inner%' 
LIMIT 1 
FORMAT Vertical;

結果:

Row 1:
──────
table_catalog:            default
table_schema:             default
table_name:               describe_example
column_name:              id
ordinal_position:         1
column_default:
is_nullable:              0
data_type:                UInt64
character_maximum_length: ᴺᵁᴸᴸ
character_octet_length:   ᴺᵁᴸᴸ
numeric_precision:        64
numeric_precision_radix:  2
numeric_scale:            0
datetime_precision:       ᴺᵁᴸᴸ
character_set_catalog:    ᴺᵁᴸᴸ
character_set_schema:     ᴺᵁᴸᴸ
character_set_name:       ᴺᵁᴸᴸ
collation_catalog:        ᴺᵁᴸᴸ
collation_schema:         ᴺᵁᴸᴸ
collation_name:           ᴺᵁᴸᴸ
domain_catalog:           ᴺᵁᴸᴸ
domain_schema:            ᴺᵁᴸᴸ
domain_name:              ᴺᵁᴸᴸ

SCHEMATA

system.databasesシステムテーブルから読み取ったカラムを含み、ClickHouseでサポートされていないか、意味をなさない常にNULL)が標準によって必要なカラムを含みます。

カラム:

  • catalog_name (String) — データベースの名前。
  • schema_name (String) — データベースの名前。
  • schema_owner (String) — スキーマの所有者名。常に'default'
  • default_character_set_catalog (Nullable(String)) — NULL、サポートされていません。
  • default_character_set_schema (Nullable(String)) — NULL、サポートされていません。
  • default_character_set_name (Nullable(String)) — NULL、サポートされていません。
  • sql_path (Nullable(String)) — NULL、サポートされていません。

クエリ:

SELECT catalog_name,
       schema_name,
       schema_owner,
       default_character_set_catalog,
       default_character_set_schema,
       default_character_set_name,
       sql_path
FROM information_schema.schemata
WHERE schema_name ilike 'information_schema' 
LIMIT 1 
FORMAT Vertical;

結果:

Row 1:
──────
catalog_name:                  INFORMATION_SCHEMA
schema_name:                   INFORMATION_SCHEMA
schema_owner:                  default
default_character_set_catalog: ᴺᵁᴸᴸ
default_character_set_schema:  ᴺᵁᴸᴸ
default_character_set_name:    ᴺᵁᴸᴸ
sql_path:                      ᴺᵁᴸᴸ

TABLES

system.tablesシステムテーブルから読み取ったカラムを含みます。

カラム:

  • table_catalog (String) — テーブルが所在するデータベースの名前。
  • table_schema (String) — テーブルが所在するデータベースの名前。
  • table_name (String) — テーブル名。
  • table_type (String) — テーブルタイプ。可能な値:
    • BASE TABLE
    • VIEW
    • FOREIGN TABLE
    • LOCAL TEMPORARY
    • SYSTEM VIEW
  • table_rows (Nullable(UInt64)) — 行の総数。NULLの場合、決定できなかったことを示します。
  • data_length (Nullable(UInt64)) — ディスク上にデータのサイズ。NULLの場合、決定できなかったことを示します。
  • table_collation (Nullable(String)) — テーブルのデフォルト照合順序。常にutf8mb4_0900_ai_ci
  • table_comment (Nullable(String)) — テーブル作成時に使用されたコメント。

クエリ:

SELECT table_catalog, 
       table_schema, 
       table_name, 
       table_type, 
       table_collation, 
       table_comment
FROM INFORMATION_SCHEMA.TABLES
WHERE (table_schema = currentDatabase() OR table_schema = '')
  AND table_name NOT LIKE '%inner%'
LIMIT 1 
FORMAT Vertical;

結果:

Row 1:
──────
table_catalog:   default
table_schema:    default
table_name:      describe_example
table_type:      BASE TABLE
table_collation: utf8mb4_0900_ai_ci
table_comment:   

VIEWS

system.tablesシステムテーブルから読み取ったカラムで、テーブルエンジンViewが使用されている場合。

カラム:

  • table_catalog (String) — テーブルが所在するデータベースの名前。
  • table_schema (String) — テーブルが所在するデータベースの名前。
  • table_name (String) — テーブル名。
  • view_definition (String) — ビューのSELECTクエリ。
  • check_option (String) — NONE、チェックなし。
  • is_updatable (Enum8) — NO、ビューは更新されません。
  • is_insertable_into (Enum8) — 作成されたビューがマテリアライズドかどうかを示します。可能な値:
    • NO — 作成されたビューはマテリアライズドではありません。
    • YES — 作成されたビューはマテリアライズドです。
  • is_trigger_updatable (Enum8) — NO、トリガーは更新されません。
  • is_trigger_deletable (Enum8) — NO、トリガーは削除されません。
  • is_trigger_insertable_into (Enum8) — NO、トリガーにデータは挿入されません。

クエリ:

CREATE VIEW v (n Nullable(Int32), f Float64) AS SELECT n, f FROM t;
CREATE MATERIALIZED VIEW mv ENGINE = Null AS SELECT * FROM system.one;
SELECT table_catalog,
       table_schema,
       table_name,
       view_definition,
       check_option,
       is_updatable,
       is_insertable_into,
       is_trigger_updatable,
       is_trigger_deletable,
       is_trigger_insertable_into
FROM information_schema.views
WHERE table_schema = currentDatabase() 
LIMIT 1
FORMAT Vertical;

結果:

Row 1:
──────
table_catalog:              default
table_schema:               default
table_name:                 mv
view_definition:            SELECT * FROM system.one
check_option:               NONE
is_updatable:               NO
is_insertable_into:         YES
is_trigger_updatable:       NO
is_trigger_deletable:       NO
is_trigger_insertable_into: NO

KEY_COLUMN_USAGE

制約により制限されたsystem.tablesシステムテーブルからのカラムを含みます。

カラム:

  • constraint_catalog (String) — 現在は未使用。常にdef
  • constraint_schema (String) — 制約が属するスキーマ(データベース)の名前。
  • constraint_name (Nullable(String)) — 制約の名前。
  • table_catalog (String) — 現在は未使用。常にdef
  • table_schema (String) — テーブルが属するスキーマ(データベース)の名前。
  • table_name (String) — 制約を持つテーブルの名前。
  • column_name (Nullable(String)) — 制約を持つカラムの名前。
  • ordinal_position (UInt32) — 現在は未使用。常に1
  • position_in_unique_constraint (Nullable(UInt32)) — 現在は未使用。常にNULL
  • referenced_table_schema (Nullable(String)) — 現在は未使用。常にNULL。
  • referenced_table_name (Nullable(String)) — 現在は未使用。常にNULL。
  • referenced_column_name (Nullable(String)) — 現在は未使用。常にNULL。

CREATE TABLE test (i UInt32, s String) ENGINE MergeTree ORDER BY i;
SELECT constraint_catalog,
       constraint_schema,
       constraint_name,
       table_catalog,
       table_schema,
       table_name,
       column_name,
       ordinal_position,
       position_in_unique_constraint,
       referenced_table_schema,
       referenced_table_name,
       referenced_column_name
FROM information_schema.key_column_usage 
WHERE table_name = 'test' 
FORMAT Vertical;

結果:

Row 1:
──────
constraint_catalog:            def
constraint_schema:             default
constraint_name:               PRIMARY
table_catalog:                 def
table_schema:                  default
table_name:                    test
column_name:                   i
ordinal_position:              1
position_in_unique_constraint: ᴺᵁᴸᴸ
referenced_table_schema:       ᴺᵁᴸᴸ
referenced_table_name:         ᴺᵁᴸᴸ
referenced_column_name:        ᴺᵁᴸᴸ

REFERENTIAL_CONSTRAINTS

外部キーに関する情報を含みます。現在、外部ツールTableau Onlineとの互換性を提供するのに十分な空の結果行なしを返します。

カラム:

  • constraint_catalog (String) — 現在は未使用。
  • constraint_schema (String) — 現在は未使用。
  • constraint_name (Nullable(String)) — 現在は未使用。
  • unique_constraint_catalog (String) — 現在は未使用。
  • unique_constraint_schema (String) — 現在は未使用。
  • unique_constraint_name (Nullable(String)) — 現在は未使用。
  • match_option (String) — 現在は未使用。
  • update_rule (String) — 現在は未使用。
  • delete_rule (String) — 現在は未使用。
  • table_name (String) — 現在は未使用。
  • referenced_table_name (String) — 現在は未使用。

STATISTICS

テーブルのインデックスに関する情報を提供します。現在は、外部ツールTableau Onlineとの互換性を提供するのに十分な空の結果行なしを返します。

カラム:

  • table_catalog (String) — 現在は未使用。
  • table_schema (String) — 現在は未使用。
  • table_name (String) — 現在は未使用。
  • non_unique (Int32) — 現在は未使用。
  • index_schema (String) — 現在は未使用。
  • index_name (Nullable(String)) — 現在は未使用。
  • seq_in_index (UInt32) — 現在は未使用。
  • column_name (Nullable(String)) — 現在は未使用。
  • collation (Nullable(String)) — 現在は未使用。
  • cardinality (Nullable(Int64)) — 現在は未使用。
  • sub_part (Nullable(Int64)) — 現在は未使用。
  • packed (Nullable(String)) — 現在は未使用。
  • nullable (String) — 現在は未使用。
  • index_type (String) — 現在は未使用。
  • comment (String) — 現在は未使用。
  • index_comment (String) — 現在は未使用。
  • is_visible (String) — 現在は未使用。
  • expression (Nullable(String)) — 現在は未使用。