SHOW PRIMARY KEYS¶

Syntax¶

SHOW [ TERSE ] PRIMARY KEYS
    [ IN { ACCOUNT | DATABASE [ <database_name> ] | SCHEMA [ <schema_name> ] | TABLE | [ TABLE ] <table_name> } ]

Parameters¶

TERSE

This clause is accepted in the syntax but has no effect on the output.

IN { ACCOUNT | DATABASE [ <database_name> ] | SCHEMA [ <schema_name> ] | TABLE | [ TABLE ] <table_name> }

Specifies the scope of the command, which determines whether the command lists records only for the current or specified database, schema, table, or account.

If you specify the keyword ACCOUNT, then the command retrieves records for all schemas in all databases of the current account.

If you specify the keyword DATABASE, then:

• If you specify a db_name, then the command retrieves records for all schemas of the specified database.

• If you do not specify a db_name, then:

  • If there is a current database, then the command retrieves records for all schemas in the current database.

  • If there is no current database, then the command retrieves records for all databases and schemas in the account.

If you specify the keyword SCHEMA, then:

• If you specify a qualified schema name (e.g. my_database.my_schema), then the command retrieves records for the specified database and schema.

• If you specify an unqualified schema_name, then:

  • If there is a current database, then the command retrieves records for the specified schema in the current database.

  • If there is no current database, then the command displays the error SQL compilation error: Object does not exist, or operation cannot be performed.

• If you do not specify a schema_name, then:

  • If there is a current database, then:

    • If there is a current schema, then the command retrieves records for the current schema in the current database.

    • If there is no current schema, then the command retrieves records for all schemas in the current database.

  • If there is no current database, then the command retrieves records for all databases and all schemas in the account.

If you specify the keyword TABLE without a table_name, then:

• If there is a current database, then:

  • If there is a current schema, then the command retrieves records for the current schema in the current database.

  • If there is no current schema, then the command retrieves records for all schemas in the current database.

• If there is no current database, then the command retrieves records for all databases and all schemas in the account.

If you specify a <table_name> (with or without the keyword TABLE), then:

• If you specify a fully-qualified <table_name> (e.g. my_database_name.my_schema_name.my_table_name), then the command retrieves all records for the specified table.

• If you specify a schema-qualified <table_name> (e.g. my_schema_name.my_table_name), then:

  • If a current database exists, then the command retrieves all records for the specified table.

  • If no current database exists, then the command displays an error similar to Cannot perform SHOW <object_type>. This session does not have a current database....

• If you specify an unqualified <table_name>, then:

  • If a current database and current schema exist, then the command retrieves records for the specified table in the current schema of the current database.

  • If no current database exists or no current schema exists, then the command displays an error similar to: SQL compilation error: <object> does not exist or not authorized..

Default: Depends on whether the session currently has a database in use:

• Database: DATABASE is the default (that is, the command returns the objects you have privileges to view in the database).

• No database: ACCOUNT is the default (that is, the command returns the objects you have privileges to view in your account).

Usage notes¶

• The command does not require a running warehouse to execute.

• For each single-column primary key, the output contains one row.

• For each multi-column primary key, the output contains one row for each column in the primary key.

• If an account (or database or schema) has a large number of tables, searching the entire account (or table or schema) can consume a significant amount of compute resources.

• To post-process the output of this command, you can use the RESULT_SCAN function, which treats the output as a table that can be queried.

Output¶

The command output provides primary key properties and metadata in the following columns:

Examples¶

SHOW PRIMARY KEYS;

SHOW PRIMARY KEYS IN ACCOUNT;

SHOW PRIMARY KEYS IN DATABASE;

SHOW PRIMARY KEYS IN DATABASE my_database;

SHOW PRIMARY KEYS IN SCHEMA;

SHOW PRIMARY KEYS IN SCHEMA my_schema;

SHOW PRIMARY KEYS IN SCHEMA my_database.my_schema;

SHOW PRIMARY KEYS IN my_table;

SHOW PRIMARY KEYS IN my_database.my_schema.my_table;