Configuring and Using Connection Links
On this page
A connection link is a secure link that stores connection details (credentials and configurations) to supported data providers such as S3, Azure, GCS, HDFS, and Kafka.
User Advantages
-
Referring to a connection link in a command is more secure than specifying the connection details directly in the command.
Users need the CREATE LINKpermission to create connection links, and only those users need to know the connection details thereby limiting the exposure of the details. -
Commands such as
BACKUP,RESTORE,CREATE PIPELINE, andSELECTsupport connection links.Users can run these commands without specifying the connection details. However, the user needs the SHOW LINKpermission to use a connection link.
Using a Connection Link
Creation and use of a connection link is dependent on the permissions granted to a user.
-
CREATE LINK: A user with theCREATE LINKpermission can create a connection link and only that user will know the connection details. -
SHOW LINK: A user with theSHOW LINKpermission can view and use all connection links that exist in a SingleStore Helios database. -
DROP LINK: A user with theDROP LINKpermission can remove a connection link that exists in a SingleStore Helios database.
Note: The listed permissions can be workspace or database scoped.*. (workspace scoped) and database. (database scoped) but not database..
Example
The following example demonstrates the steps performed by a user user1 to write all rows of the table t1 of the database productdb to an S3 bucket using a connection link.CREATE LINK linkname AS {AZURE,GCS,HDFS,KAFKA} . -- see CREATE LINK for more information.
-
On user request, the DBA (who has the
CREATE LINKpermission) creates an S3 connection linkdemouser_:S3 CREATE LINK productdb.demouser_S3 AS S3CREDENTIALS '{"aws_access_key_id":"your_access_key_id","aws_secret_access_key":"your_secret_access_key"}'CONFIG '{"region":"us-east-1"}'DESCRIPTION 'Product list'; -
The DBA grants the
SHOW LINKpermission touser1.GRANT SHOW LINK ON productdb.* TO 'user1';This allows
user1to use the S3 connection linkdemouser_and any other connection links defined in theS3 productdbdatabase.user1can run theSHOW LINKScommand to view all the connection links in a database.For example, if a second connection link, demouser2_had been created in theS3 productdbdatabase, runningSHOW LINKSwould return the following results:SHOW LINKS ON productdb;+-------------------------+--------+-----------------------------+ | Link | Type | Description | +-------------------------+--------+-----------------------------+ | demouser_S3 | S3 | Product list | | demouser2_S3 | S3 | Brand list | +-------------------------+--------+-----------------------------+ -
user1runs theSELECT .command to write the contents of the table. INTO LINK t1, to the S3 bucket at the specified path, using the S3 connection linkdemouser_stored in theS3 productdbdatabase.USE productdb;SELECT * FROM t1 INTO LINK demouser_S3 'testing/output';
Last modified: September 19, 2025