SHOW CHANNELS

Lists the Snowpipe Streaming channels for which you have access privileges. This command can be used to list the channels for a specified table, database or schema (or the current database/schema for the session), or your entire account.

See also:

Syntax

SHOW CHANNELS [ LIKE '<pattern>' ]
           [ IN
                {
                  ACCOUNT                  |

                  DATABASE                 |
                  DATABASE <database_name> |

                  SCHEMA                   |
                  SCHEMA <schema_name>     |
                  <schema_name>

                  TABLE                    |
                  TABLE <table_name>
                }
           ]
Copy

Parameters

LIKE 'pattern'

Optionally filters the command output by object name. The filter uses case-insensitive pattern matching, with support for SQL wildcard characters (% and _).

For example, the following patterns return the same results:

... LIKE '%testing%' ...
... LIKE '%TESTING%' ...

. Default: No value (no filtering is applied to the output).

[ IN ... ]

Optionally specifies the scope of the command. Specify one of the following:

ACCOUNT

Returns records for the entire account.

DATABASE, . DATABASE db_name

Returns records for the current database in use or for a specified database (db_name).

If you specify DATABASE without db_name and no database is in use, the keyword has no effect on the output.

Note

Using SHOW commands without an IN clause in a database context can result in fewer than expected results.

Objects with the same name are only displayed once if no IN clause is used. For example, if you have table t1 in schema1 and table t1 in schema2, and they are both in scope of the database context you’ve specified (that is, the database you’ve selected is the parent of schema1 and schema2), then SHOW TABLES only displays one of the t1 tables.

SCHEMA, . SCHEMA schema_name

Returns records for the current schema in use or a specified schema (schema_name).

SCHEMA is optional if a database is in use or if you specify the fully qualified schema_name (for example, db.schema).

If no database is in use, specifying SCHEMA has no effect on the output.

TABLE, . TABLE table_name

Returns records for the table.

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 doesn’t require a running warehouse to execute.

  • The command only returns objects for which the current user’s current role has been granted at least one access privilege.

  • The MANAGE GRANTS access privilege implicitly allows its holder to see every object in the account. By default, only the account administrator (users with the ACCOUNTADMIN role) and security administrator (users with the SECURITYADMIN role) have the MANAGE GRANTS privilege.

  • 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 pipe properties and metadata in the following columns:

Column

Description

created_on

Date and time when the channel is created.

name

Name of the channel.

database_name

Database in which the channel is stored.

schema_name

Schema in which the channel is stored.

table_name

Table where the channel is mapped to.

client_sequencer

For internal use.

row_sequencer

For internal use.

offset_token

A string used to track ingestion process.

Examples

Show all the channels that you have privileges to view in the public schema in the mydb database:

use database mydb;

show channels;

+-------------------------------+-----------+---------------+------------------+------------------------+------------------+---------------+--------------+
| created_on                    | name      | database_name | schema_name      | table_name             | client_sequencer | row_sequencer | offset_token |
|-------------------------------+-----------+---------------+------------------+------------------------+------------------+---------------+--------------+
| 2023-05-05 17:13:17.579 -0700 | CHANNEL8  | TEST_DB1      | STREAMING_INGEST | STREAMING_INGEST_TABLE | 7                | 1             | 0            |
|                               |           |               |                  |                        |                  |               |              |
+-------------------------------+-----------+---------------+------------------+------------------------+------------------+---------------+--------------+
Copy
Language: English