Categories:

User & Security DDL (Third-Party Service Integrations)

# SHOW INTEGRATIONS¶

Lists the integrations for which you have access privileges. The command can be used to list integrations for the current/specified database or schema, or across your entire account.

The output returns integration metadata and properties, ordered lexicographically by database, schema, and integration name (see Output in this topic for descriptions of the output columns). This is important to note if you wish to filter the results using the provided filters.

DROP INTEGRATION

API integrations

CREATE API INTEGRATION

Security integrations

CREATE SECURITY INTEGRATION

Storage integrations

CREATE STORAGE INTEGRATION

## Syntax¶

SHOW [ TERSE ] [ { API | NOTIFICATION | SECURITY | STORAGE } ] INTEGRATIONS [ LIKE '<pattern>' ]
[ IN { ACCOUNT | DATABASE [ <db_name> ] | [ SCHEMA ] [ <schema_name> ] } ]
[ STARTS WITH '<name_string>' ]
[ LIMIT <rows> [ FROM '<name_string>' ] ]


## Parameters¶

TERSE

Returns only a subset of the output columns:

• created_on

• name

• kind

• database_name

• schema_name

Note

This parameter is not supported currently.

API | NOTIFICATION | SECURITY | STORAGE

Returns integrations of the specified type only.

LIKE 'pattern'

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%' ...

Note

This parameter is not supported currently.

IN ACCOUNT | [ DATABASE ] db_name | [ SCHEMA ] schema_name

Specifies the scope of the command, which determines whether the command lists records only for the current/specified database or schema, or across your entire account:

The DATABASE or SCHEMA keyword is not required; you can set the scope by specifying only the database or schema name. Likewise, the database or schema name is not required if the session currently has a database in use.

• If DATABASE or SCHEMA is specified without a name and the session does not currently have a database in use, the parameter has no effect on the output.

• If SCHEMA is specified with a name and the session does not currently have a database in use, the schema name must be fully qualified with the database name (e.g. testdb.testschema).

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

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

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

Note

This parameter is not supported currently.

STARTS WITH 'name_string'

Filters the command output based on the string of characters that appear at the beginning of the object name. The string must be enclosed in single quotes and is case-sensitive. For example, the following return different results:

... STARTS WITH 'B' ...
... STARTS WITH 'b' ...

Note

This parameter is not supported currently.

LIMIT rows [ FROM 'name_string' ]

Enables “pagination” of the results by limiting the maximum number of rows returned. Note that the actual number of rows returned may be less than the specified limit (e.g. the number of objects is less than the specified limit).

This clause can also include a FROM subclause, effectively serving as a “cursor” for the results. This enables fetching the specified number of rows following the first row whose object name matches the specified string:

• The string must be enclosed in single quotes and is case-sensitive.

• The string does not have to include the full object name; partial names are supported.

Note

FROM can be combined with STARTS WITH in the same statement; however, both conditions must be met or they cancel out each other and no results are returned. In addition, objects are returned in lexicographic order by name, so FROM only returns rows with a higher lexicographic value than the rows returned by STARTS WITH.

For example:

• ... STARTS WITH 'A' LIMIT ... FROM 'B' would return no results.

• ... STARTS WITH 'B' LIMIT ... FROM 'A' would return no results.

• ... STARTS WITH 'A' LIMIT ... FROM 'AB' would return results (if any rows match the input strings).

Note

This parameter is not supported currently.

## Usage Notes¶

• Currently, only the API | NOTIFICATION | SECURITY | STORAGE parameter is supported.

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

• The value for LIMIT rows cannot exceed 10000. If LIMIT rows is omitted, the command results in an error if the result set is larger than 10K rows.

To view results for which more than 10K records exist, either include LIMIT rows or query the corresponding view in the Information Schema.

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

| name | type | category | enabled | comment | created_on |


Column

Description

name

Name of the integration

type

Type of the integration

category

Category of the integration

enabled

The current status of the integration, either TRUE (enabled) or FALSE (disabled)

comment

Comment for the integration

created_on

Date and time when the integration was created

For more information about the properties that can be specified for an integration, see the following topic for the integration by type:

## Examples¶

SHOW NOTIFICATION INTEGRATIONS;

Show all the integrations whose name starts with line that you have privileges to view in the tpch.public schema:
SHOW INTEGRATIONS LIKE 'line%' IN tpch.public;

Show all the integrations, including dropped integrations, that you have privileges to view in the tpch.public schema:
SHOW INTEGRATIONS HISTORY IN tpch.public;