Visualização KEY_COLUMN_USAGE

A visualização KEY_COLUMN_USAGE contém colunas das tabelas de TABLE_CONSTRAINTS que são restritas como chaves pelas restrições PRIMARY KEY e FOREIGN KEY.

Esquema

A visualização INFORMATION_SCHEMA.KEY_COLUMN_USAGE tem o seguinte esquema:

Nome da coluna Tipo de dado Valor

CONSTRAINT_CATALOG

STRING

O nome do projeto de restrição.

CONSTRAINT_SCHEMA

STRING

O nome do conjunto de dados de restrição.

CONSTRAINT_NAME

STRING

O nome da restrição.

TABLE_CATALOG

STRING

O nome do projeto da tabela restrita.

TABLE_SCHEMA

STRING

O nome do conjunto de dados da tabela restrita.

TABLE_NAME

STRING

O nome da tabela restrita.

COLUMN_NAME

STRING

O nome da coluna restrita.

ORDINAL_POSITION

INT64

A posição ordinal da coluna na chave de restrição (a partir de 1).

POSITION_IN_UNIQUE_CONSTRAINT

INT64

Para chaves externas, a posição ordinal da coluna na restrição da chave primária (a partir de 1). Esse valor é NULL para restrições de chave primária.

Escopo e sintaxe

As consultas nesta visualização precisam ter um qualificador de conjunto de dados. Para consultas com um qualificador de conjunto de dados, é preciso ter permissões para o conjunto de dados. Para mais informações, consulte Sintaxe. A tabela a seguir explica os escopos de região e recurso dessa visualização:

Nome da visualização Escopo do recurso Escopo da região
[PROJECT_ID.]DATASET_ID.INFORMATION_SCHEMA.KEY_COLUMN_USAGE; Nível do conjunto de dados Local do conjunto de dados
Substitua:

  • Opcional: PROJECT_ID: o ID do seu projeto do Google Cloud. Se não for especificado, o projeto padrão será usado.

    Para consultas com um qualificador de conjunto de dados, é preciso ter permissões para o conjunto de dados. Para consultas com um qualificador de região, é preciso ter permissões para o projeto.

    Exemplos

    Exemplo 1:

    A consulta a seguir mostra as restrições de uma única tabela em um conjunto de dados:

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

    Substitua:

    • PROJECT_ID: opcional. O nome do projeto na nuvem. Se não for especificado, esse comando usará o projeto padrão.
    • DATASET: o nome do conjunto de dados.
    • TABLE: o nome da tabela.

    Por outro lado, a consulta a seguir mostra o uso das colunas das chaves de todas as tabelas em um único conjunto de dados.

    SELECT *
FROM PROJECT_ID.DATASET.INFORMATION_SCHEMA.KEY_COLUMN_USAGE;

    Se uma tabela ou um conjunto de dados não tiver restrições, os resultados da consulta terão esta aparência:

    +-----------------------------+
| There is no data to display |
+-----------------------------+
    Exemplo 2:

    As seguintes instruções DDL criam uma tabela de chaves primária e outra externa.

    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);

    Se consultado com a instrução no Exemplo 1, os resultados da consulta serão semelhantes aos seguintes: Observe que as colunas CONSTRAINT_CATALOG, CONSTRAINT_SCHEMA e duplicadas não estão incluídas nos resultados do exemplo.

    +---------------------------+--------------+-------------+------------------+-------------------------------+
|     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                             |
+---------------------------+--------------+-------------+------------------+-------------------------------+