Download

Download data from a Snowflake stage to Kestra's internal storage.

yaml
type: "io.kestra.plugin.jdbc.snowflake.Download"

Examples

yaml
id: snowflake_download
namespace: company.team

tasks:
  - id: download
    type: io.kestra.plugin.jdbc.snowflake.Download
    url: jdbc:snowflake://<account_identifier>.snowflakecomputing.com
    username: "{{ secret('SNOWFLAKE_USERNAME') }}"
    password: "{{ secret('SNOWFLAKE_PASSWORD') }}"
    stageName: "@demo_db.public.%myStage"
    fileName: prefix/destFile.csv

Properties

fileName *string

File name on Snowflake stage that should be downloaded.

stageName *string

Snowflake stage name.

~ or table name or stage name.

url *string

The JDBC URL to connect to the database.

compress booleanstring

Default true

Whether to compress data before uploading stream.

database string

Specifies the default database to use once connected.

The specified database should be an existing database for which the specified default role has privileges. If you need to use a different database after connecting, execute the USE DATABASE command.

password string

The database user's password.

privateKey string

Specifies the private key for key pair authentication and key rotation.

It needs to be an un-encoded private key in plaintext like: 'MIIEvwIBADA...EwKx0TSWT9A=='

privateKeyPassword string

Specifies the private key password for key pair authentication and key rotation.

role string

Specifies the default access control role to use in the Snowflake session initiated by the driver.

The specified role should be an existing role that has already been assigned to the specified user for the driver. If the specified role has not already been assigned to the user, the role is not used when the session is initiated by the driver. If you need to use a different role after connecting, execute the USE ROLE command.

schema string

Specifies the default schema to use for the specified database once connected.

The specified schema should be an existing schema for which the specified default role has privileges. If you need to use a different schema after connecting, execute the USE SCHEMA command.

username string

The database user.

warehouse string

Specifies the virtual warehouse to use once connected.

The specified warehouse should be an existing warehouse for which the specified default role has privileges. If you need to use a different warehouse after connecting, execute the USE WAREHOUSE command to set a different warehouse for the session.

Outputs

uri string

Format uri

The URI of the file on Kestra's internal storage.

​Download

Download