Download

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

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

Examples

id: snowflake_download
namespace: company.team

tasks:
  - id: download
    type: io.kestra.plugin.jdbc.snowflake.Download
    url: jdbc:snowflake://<account_identifier>.snowflakecomputing.com
    username: snowflake_user
    password: snowflake_password
    stageName: "@demo_db.public.%myStage"
    fileName: prefix/destFile.csv

Properties

compress

• Type: boolean
• Dynamic: ❌
• Required: ✔️
• Default: true

Whether to compress data before uploading stream.

fileName

• Type: string
• Dynamic: ✔️
• Required: ✔️

File name on Snowflake stage that should be downloaded.

stageName

• Type: string
• Dynamic: ✔️
• Required: ✔️

Snowflake stage name.

~ or table name or stage name.

url

• Type: string
• Dynamic: ✔️
• Required: ✔️

The JDBC URL to connect to the database.

database

• Type: string
• Dynamic: ✔️
• Required: ❌

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

• Type: string
• Dynamic: ✔️
• Required: ❌

The database user's password.

privateKey

• Type: string
• Dynamic: ✔️
• Required: ❌

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

It needs to be an un-encoded private key in plaintext.

privateKeyFile

• Type: string
• Dynamic: ✔️
• Required: ❌

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

It needs to be the path on the host where the private key file is located.

privateKeyFilePassword

• Type: string
• Dynamic: ✔️
• Required: ❌

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

role

• Type: string
• Dynamic: ✔️
• Required: ❌

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

• Type: string
• Dynamic: ✔️
• Required: ❌

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

• Type: string
• Dynamic: ✔️
• Required: ❌

The database user.

warehouse

• Type: string
• Dynamic: ✔️
• Required: ❌

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

• Type: string
• Required: ❌
• Format: uri

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

Definitions