snow git copy¶

Copies all files from given state of repository to local directory or stage. If the source path ends with ‘/’, the command copies contents of specified directory. Otherwise, it creates a new directory or file in the destination directory.

Syntax¶

snow git copy
  
  
  --parallel 
  --connection 
  --host 
  --port 
  --account 
  --user 
  --password 
  --authenticator 
  --private-key-file 
  --token-file-path 
  --database 
  --schema 
  --role 
  --warehouse 
  --temporary-connection
  --mfa-passcode 
  --enable-diag
  --diag-log-path 
  --diag-allowlist-path 
  --oauth-client-id 
  --oauth-client-secret 
  --oauth-authorization-url 
  --oauth-token-request-url 
  --oauth-redirect-uri 
  --oauth-scope 
  --oauth-disable-pkce
  --oauth-enable-refresh-tokens
  --oauth-enable-single-use-refresh-tokens
  --client-store-temporary-credential
  --format 
  --verbose
  --debug
  --silent
  --enhanced-exit-codes
Copy

Arguments¶

repository_path

Path to git repository stage with scope provided. Path to the repository root must end with ‘/’. For example: @my_repo/branches/main/.

destination_path

Target path for copy operation. Should be a path to a directory on remote stage or local file system.

Options¶

--parallel INTEGER

Number of parallel threads to use when downloading files. Default: 4.

--connection, -c, --environment TEXT

Name of the connection, as defined in your config.toml file. 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 to use 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 a 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

Whether to generate a connection diagnostic report. Default: False.

--diag-log-path TEXT

Path for the generated report. Defaults to system temporary directory. Default: .

--diag-allowlist-path TEXT

Path to a JSON file that contains allowlist parameters.

--oauth-client-id TEXT

Value of client id provided by the Identity Provider for Snowflake integration.

--oauth-client-secret TEXT

Value of the client secret provided by the Identity Provider for Snowflake integration.

--oauth-authorization-url TEXT

Identity Provider endpoint supplying the authorization code to the driver.

--oauth-token-request-url TEXT

Identity Provider endpoint supplying the access tokens to the driver.

--oauth-redirect-uri TEXT

URI to use for authorization code redirection.

--oauth-scope TEXT

Scope requested in the Identity Provider authorization request.

--oauth-disable-pkce

Disables Proof Key for Code Exchange (PKCE). Default: False.

--oauth-enable-refresh-tokens

Enables a silent re-authentication when the actual access token becomes outdated. Default: False.

--oauth-enable-single-use-refresh-tokens

Whether to opt-in to single-use refresh token semantics. Default: False.

--client-store-temporary-credential

Store the temporary credential.

--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 contain additional information. Default: False.

--silent

Turns off intermediate output to console. Default: False.

--enhanced-exit-codes

Differentiate exit error codes based on failure type. Default: False.

--help

Displays the help text for this command.

Usage notes¶

None.

Examples¶

  • This example creates a snowcli2.0/ directory on stage @public and copies all files from the commit marked with tag v2.0.0 into that directory:

    snow git copy @my_snow_git/tags/v2.0.0/ @public/snowcli2.0/
    
    Copy
  • The following example creates a plugin_tests directory in the local file system and downloads the contents of the tests/plugin directory into it.-

    snow git copy @snowcli_git/branches/main/tests/plugin plugin_tests/
    
    Copy