SHOW LINKS

The SHOW LINKS command shows all connection links on S3, Azure, GCS, HDFS, Kafka, or other data sources for a permitted user.

Syntax

SHOW LINKS [ON db_name]

Output

Column

Description

Link

Name of the connection link provided at the time of link creation

Type

Type of connection link - S3, Azure, GCS, HDFS, or Kafka

Description

Details of the connection link

Config

Connection link configuration (JSON)

Remarks

  • db_name is the name of the SingleStore database. It is an optional parameter. If not specified, the connection links in the current (context) database are displayed.

  • To view and use connection links, you need the SHOW LINK permission. Contact your database administrator to grant this permission.

  • See the Permission Matrix for the required permission.

Example

The following example displays the connection links to the Orderdb database:

SHOW LINKS ON Orderdb;
+-------------------+------+---------------------------------+------------------------+
| Link              | Type | Description                     | Config                 |
+-------------------+------+---------------------------------+------------------------+
| product_S3        | S3   | Products ordered in December    | {"region":"us-east-1"} |
+-------------------+------+---------------------------------+------------------------+

You can also query the information schema to view all links in the cluster, along with the link details.

SELECT * FROM INFORMATION_SCHEMA.LINKS;
+---------------+------------+------+------------------------------+-----------------------------+
| DATABASE_NAME | LINK       | TYPE | DESCRIPTION                  | CONFIG                      |
+---------------+------------+------+------------------------------+-----------------------------+
| Orderdb       | product_S3 | S3   | Products ordered in December | {"region":"us-east-1"}      |
+---------------+------------+------+------------------------------+-----------------------------+

Last modified:

Was this article helpful?