KEY_COLUMN_USAGE 檢視畫面

KEY_COLUMN_USAGE 檢視畫面包含 TABLE_CONSTRAINTS 中資料表的資料欄，這些資料欄會受限於主鍵和外鍵限制。

必要的角色

如要取得查詢 INFORMATION_SCHEMA.KEY_COLUMN_USAGE 檢視畫面所需的權限，請要求管理員授予您專案的「BigQuery 資料編輯者 」(roles/bigquery.dataEditor) IAM 角色。如要進一步瞭解如何授予角色，請參閱「管理專案、資料夾和機構的存取權」。

這個預先定義的角色具備查詢 INFORMATION_SCHEMA.KEY_COLUMN_USAGE 檢視畫面所需的權限。如要查看確切的必要權限，請展開「Required permissions」(必要權限) 部分：

所需權限

如要查詢 INFORMATION_SCHEMA.KEY_COLUMN_USAGE 檢視畫面，必須具備下列權限：

  • 查看主鍵和外鍵定義： bigquery.tables.get
  • 查看資料表資訊結構定義： bigquery.tables.list

您或許還可透過自訂角色或其他預先定義的角色取得這些權限。

如要進一步瞭解 BigQuery 中的 IAM 角色和權限，請參閱預先定義的角色和權限一文。

結構定義

INFORMATION_SCHEMA.KEY_COLUMN_USAGE 檢視表具有下列結構定義：

資料欄名稱 資料類型 值

constraint_catalog

STRING

限制專案名稱。

constraint_schema

STRING

限制資料集名稱。

constraint_name

STRING

限制名稱。

table_catalog

STRING

受限資料表的專案名稱。

table_schema

STRING

受限資料表資料集的名稱。

table_name

STRING

受限資料表的名稱。

column_name

STRING

受限資料欄的名稱。

ordinal_position

INT64

資料欄在限制鍵中的序數位置 (從 1 開始)。

position_in_unique_constraint

INT64

如果是外鍵，則為資料欄在主鍵限制中的序數位置 (從 1 開始)。主鍵限制的值為 NULL。

為確保穩定性，建議您在資訊結構定義查詢中明確列出資料欄，而非使用萬用字元 (SELECT *)。明確列出資料欄可避免基礎結構定義變更時，查詢中斷。

範圍和語法

對這個檢視表執行的查詢必須包含資料集限定詞。如要查詢具有資料集限定詞的資料，您必須具備該資料集的權限。詳情請參閱「語法」。下表列出這個檢視畫面的區域和資源範圍：

檢視表名稱 資源範圍 區域範圍
[PROJECT_ID.]DATASET_ID.INFORMATION_SCHEMA.KEY_COLUMN_USAGE; 資料集層級 資料集位置
取代下列項目：
  • 選用：PROJECT_ID： Google Cloud 專案 ID。如未指定，系統會使用預設專案。

如要查詢具有資料集限定詞的資料，您必須具備該資料集的權限。如要查詢含有區域限定符的資料，您必須具備專案權限。

範例

範例 1：

以下查詢會顯示資料集中單一資料表的限制：

SELECT *
FROM PROJECT_ID.DATASET.INFORMATION_SCHEMA.KEY_COLUMN_USAGE
WHERE table_name = TABLE;

更改下列內容：

  • PROJECT_ID：選用。雲端專案的名稱。如未指定，這項指令會使用預設專案。
  • DATASET：資料集名稱。
  • TABLE：資料表名稱。

反之，下列查詢會顯示單一資料集中所有資料表的索引鍵資料欄用量。

SELECT *
FROM PROJECT_ID.DATASET.INFORMATION_SCHEMA.KEY_COLUMN_USAGE;

如果資料表或資料集沒有任何限制，查詢結果會如下所示：

+-----------------------------+
| There is no data to display |
+-----------------------------+
範例 2：

下列 DDL 陳述式會建立主鍵資料表和外鍵資料表。

CREATE TABLE composite_pk (x int64, y string, primary key (x, y) NOT ENFORCED);
 
CREATE TABLE table composite_fk (x int64, y string, z string,  primary key (x, y)
NOT ENFORCED, CONSTRAINT composite_fk foreign key (z, x)
REFERENCES composite_pk (y, x) NOT ENFORCED);

如果使用範例 1 中的陳述式查詢，查詢結果會類似於下列內容。請注意，範例結果不包含 CONSTRAINT_CATALOG、CONSTRAINT_SCHEMA 和重複的資料欄。

+---------------------------+--------------+-------------+------------------+-------------------------------+
|     CONSTRAINT_NAME       |  TABLE_NAME  | COLUMN_NAME | ORDINAL_POSITION | POSITION_IN_UNIQUE_CONSTRAINT |
+---------------------------+--------------+-------------+------------------+-------------------------------+
| composite_pk.pk$          | composite_pk | x           | 1                | NULL                          |
| composite_pk.pk$          | composite_pk | y           | 2                | NULL                          |
| composite_fk.pk$          | composite_fk | x           | 1                | NULL                          |
| composite_fk.pk$          | composite_fk | y           | 2                | NULL                          |
| composite_fk.composite_fk | composite_fk | z           | 1                | 2                             |
| composite_fk.composite_fk | composite_fk | x           | 2                | 1                             |
+---------------------------+--------------+-------------+------------------+-------------------------------+