CREATE CONNECTION¶

Creates a new connection in the account. For more details, see Redirecting client connections.

See also:

ALTER CONNECTION , DROP CONNECTION , SHOW CONNECTIONS

Syntax¶

Primary Connection

CREATE CONNECTION [ IF NOT EXISTS ] <name>
  [ COMMENT = '<string_literal>' ]
Copy

Secondary Connection

CREATE CONNECTION [ IF NOT EXISTS ] <name>
  AS REPLICA OF <organization_name>.<account_name>.<name>
  [ COMMENT = '<string_literal>' ]
Copy

Required parameters¶

name

String that specifies the identifier (i.e. name) for the connection. It must conform to the following:

  • Must start with an alphabetic character and may only contain letters, decimal digits (0-9), and underscores (_).

  • For a primary connection, the name must be unique across connection names and account names in the organization.

  • For a secondary connection, the name must match the name of its primary connection.

Secondary connection parameters¶

AS REPLICA OF organization_name.account_name.name

Specifies the identifier for a primary connection from which to create a replica (i.e. a secondary connection).

organization_name

Specifies the identifier for the organization.

account_name

Specifies the identifier for the account.

name

Specifies the identifier for the primary connection.

Optional parameters¶

COMMENT = 'string_literal'

Specifies a comment for the connection.

Default: No value

Access control requirements¶

Only account administrators (users with the ACCOUNTADMIN role) can execute this SQL command.

Usage notes¶

  • If private connectivity to the Snowflake service is enabled for your Snowflake account, your network manager must create and manage a DNS CNAME record. For more details, see Configuring the DNS settings for private connectivity to the Snowflake service.

  • Regarding metadata:

    Attention

    Customers should ensure that no personal data (other than for a User object), sensitive data, export-controlled data, or other regulated data is entered as metadata when using the Snowflake service. For more information, see Metadata fields in Snowflake.

Examples¶

Create a connection. For this example, suppose that you are connected to the account myaccount1 in the organization myorg.

CREATE CONNECTION IF NOT EXISTS myconnection;
Copy

Create a secondary connection as a replica of its primary connection. Substitute your own account and organization values in the fully qualified name used in the parameter. You can get the fully qualified value to use from the primary column in the output of SHOW CONNECTIONS.

CREATE CONNECTION myconnection AS REPLICA OF myorg.myaccount1.myconnection;
Copy
Language: English