snow connection add¶
Adds a connection to configuration file.
Syntax¶
snow connection add
--connection-name <connection_name>
--account <account>
--user <user>
--password <password>
--role <role>
--warehouse <warehouse>
--database <database>
--schema <schema>
--host <host>
--port <port>
--region <region>
--authenticator <authenticator>
--private-key <private_key_file>
--token-file-path <token_file_path>
--default
--format <format>
--verbose
--debug
--silent
Arguments¶
None
Options¶
--connection-name, -n TEXT
Name of the new connection.
--account, -a, --accountname TEXT
Account name to use when authenticating with Snowflake.
--user, -u, --username TEXT
Username to connect to Snowflake.
--password, -p TEXT
Snowflake password. Default: optional.
--role, -r TEXT
Role to use on Snowflake. Default: optional.
--warehouse, -w TEXT
Warehouse to use on Snowflake. Default: optional.
--database, -d TEXT
Database to use on Snowflake. Default: optional.
--schema, -s TEXT
Schema to use on Snowflake. Default: optional.
--host, -h TEXT
Host name the connection attempts to connect to Snowflake. Default: optional.
--port, -P TEXT
Port to communicate with on the host. Default: optional.
--region, -R TEXT
Region name if not the default Snowflake deployment. Default: optional.
--authenticator, -A TEXT
Chosen authenticator, if other than password-based. Default: optional.
--private-key, --private-key-path, -k TEXT
Path to file containing private key. Default: optional.
--token-file-path, -t TEXT
Path to file with an OAuth token that should be used when connecting to Snowflake. Default: optional.
--default
If provided the connection will be configured as default connection. Default: False.
--format [TABLE|JSON]
Specifies the output format. Default: TABLE.
--verbose, -v
Displays log entries for log levels
info
and higher. Default: False.--debug
Displays log entries for log levels
debug
and higher; debug logs contains additional information. Default: False.--silent
Turns off intermediate output to console. Default: False.
--help
Displays the help text for this command.
Usage notes¶
The snow connection add
command adds the connection to your default config.toml
file.
For more information, see Connecting to Snowflake and configuring Snowflake CLI.
Examples¶
To add a connection, run the following:
$ snow connection add
Name for this connection: my_conn
Snowflake account name: my_sf_account
Snowflake username: jdoe
Snowflake password [optional]:
Role for the connection [optional]: accountadmin
Warehouse for the connection [optional]: my_wh
Database for the connection [optional]:
Schema for the connection [optional]:
Connection host [optional]:
Connection port [optional]:
Snowflake region [optional]:
Authentication method [optional]:
Path to private key file [optional]:
Wrote new connection my_conn to <user-home>/.snowflake/config.toml