snow git setup¶
Sets up a git repository object.
Syntax¶
snow git setup
<repository_name>
--connection <connection>
--host <host>
--port <port>
--account <account>
--user <user>
--password <password>
--authenticator <authenticator>
--private-key-file <private_key_file>
--token-file-path <token_file_path>
--database <database>
--schema <schema>
--role <role>
--warehouse <warehouse>
--temporary-connection
--mfa-passcode <mfa_passcode>
--enable-diag
--diag-log-path <diag_log_path>
--diag-allowlist-path <diag_allowlist_path>
--format <format>
--verbose
--debug
--silent
Arguments¶
repository_name
Identifier of the git repository. For example: my_repo.
Options¶
--connection, -c, --environment TEXT
Name of the connection, as defined in your
config.toml
. Default:default
.--host TEXT
Host address for the connection. Overrides the value specified for the connection.
--port INTEGER
Port for the connection. Overrides the value specified for the connection.
--account, --accountname TEXT
Name assigned to your Snowflake account. Overrides the value specified for the connection.
--user, --username TEXT
Username to connect to Snowflake. Overrides the value specified for the connection.
--password TEXT
Snowflake password. Overrides the value specified for the connection.
--authenticator TEXT
Snowflake authenticator. Overrides the value specified for the connection.
--private-key-file, --private-key-path TEXT
Snowflake private key file path. Overrides the value specified for the connection.
--token-file-path TEXT
Path to file with an OAuth token that should be used when connecting to Snowflake.
--database, --dbname TEXT
Database to use. Overrides the value specified for the connection.
--schema, --schemaname TEXT
Database schema to use. Overrides the value specified for the connection.
--role, --rolename TEXT
Role to use. Overrides the value specified for the connection.
--warehouse TEXT
Warehouse to use. Overrides the value specified for the connection.
--temporary-connection, -x
Uses connection defined with command line parameters, instead of one defined in config. Default: False.
--mfa-passcode TEXT
Token to use for multi-factor authentication (MFA).
--enable-diag
Run python connector diagnostic test. Default: False.
--diag-log-path TEXT
Diagnostic report path. Default: <temporary_directory>.
--diag-allowlist-path TEXT
Diagnostic report path to optional allowlist.
--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 git setup
command prompts for the following information:
URL: address of repository to use for
git clone
operation.Secret: Snowflake secret containing authentication credentials. Not needed if origin repository does not require authentication for read-only operations, such as clone and fetch.
API integration: object allowing Snowflake to interact with a Git repository.
If the role or user specified in your connection has not been granted, executing this command generates an error similar to the following:
003001 (42501): 01b2f095-0508-c66d-0001-c1be009a66ee: SQL access control error: Insufficient privileges to operate on account XXX
In this situation, you should check your connection configuration or ask your account administrator to give you the necessary privileges or to create the integration for you. For more information, see Create an API integration for interacting with the repository API.
Examples¶
Create a repository that requires a secret and credentials:
$ snow git setup snowcli_git Origin url: https://github.com/snowflakedb/snowflake-cli.git Use secret for authentication? [y/N]: y Secret identifier (will be created if not exists) [snowcli_git_secret]: new_secret Secret 'new_secret' will be created username: john_doe password/token: **** API integration identifier (will be created if not exists) [snowcli_git_api_integration]:
Secret 'new_secret' successfully created. API integration snowcli_git_api_integration successfully created. +------------------------------------------------------+ | status | |------------------------------------------------------| | Git Repository SNOWCLI_GIT was successfully created. | +------------------------------------------------------+
Create a repository without a secret and an existing API integration ID:
$ snow git setup snowcli_git Origin url: https://github.com/snowflakedb/snowflake-cli.git Use secret for authentication [y/N]: n API integration identifier (will be created if not exists) [snowcli_git_api_integration]: EXISTING_INTEGRATION
Using existing API integration 'EXISTING_INTEGRATION'. +------------------------------------------------------+ | status | |------------------------------------------------------| | Git Repository SNOWCLI_GIT was successfully created. | +------------------------------------------------------+