PipelinewiseSnowflake
A Singer target loads data into a Snowflake database.
Full documentation can be found here
type: "io.kestra.plugin.singer.targets.PipelinewiseSnowflake"YES1Snowflake account name.
(i.e. rtXXXXX.eu-central-1)
YES1The database name.
YESThe raw data from a tap.
YES1The database user.
YES1Snowflake virtual warehouse name.
YESfalseYESfalseYES(Default: Value of s3_bucket) When archive_load_files is enabled, the archived files will be placed in this bucket.
YES(Default: archive) When archive_load_files is enabled, the archived files will be placed in the archive S3 bucket under this prefix.
YESS3 Access Key ID. If not provided, AWS_ACCESS_KEY_ID environment variable or IAM role will be used.
YESAWS profile name for profile based authentication. If not provided, AWS_PROFILE environment variable will be used.
YESS3 Secret Access Key. If not provided, AWS_SECRET_ACCESS_KEY environment variable or IAM role will be used.
YESAWS Session token. If not provided, AWS_SESSION_TOKEN environment variable will be used.
YES100000YESdurationMaximum time to wait for batch to reach batch_size_rows.
YESWhen this is defined, Client-Side Encryption is enabled. The data in S3 will be encrypted. No third parties, including Amazon AWS and any ISPs, can see data in the clear. Snowflake COPY command will decrypt the data once it is in Snowflake. The master key must be 256-bit length and must be encoded as base64 string.
YESOverride default singer command.
YESpython:3.10.12The task runner container image, only used if the task runner is container-based.
YES0YESName of the schema where the tables will be created, without database prefix. If schema_mapping is not defined then every stream sent by the tap is loaded into this schema.
YESGrant USAGE privilege on newly created schemas and grant SELECT privilege on newly created tables to a specific role or a list of roles. If schema_mapping is not defined then every stream sent by the tap is granted accordingly.
YESfalseNODeprecated, use 'taskRunner' instead
YESNamed file format name created at pre-requirements section. Has to be a fully qualified name including the schema name.
YESfalseYESfalseYESfalseYES0YES16YESThe database user's password.
YESOverride default pip packages to use a specific version.
YEStrueYESOptional string to tag executed queries in Snowflake. Replaces tokens {{database}}, {{schema}} and {{table}} with the appropriate values. The tags are displayed in the output of the Snowflake QUERY_HISTORY, QUERY_HISTORY_BY_* functions.
YESSnowflake role to use. If not defined then the user's default role will be used.
YESS3 ACL name to set on the uploaded files.
YESS3 Bucket name. Required if to use S3 External stage. When this is defined then stage has to be defined as well.
YESThe complete URL to use for the constructed client. This is allowing to use non-native s3 account.
YESA static prefix before the generated S3 key names. Using prefixes you can upload files into specific directories in the S3 bucket.
YESDefault region when creating new connections.
YESUseful if you want to load multiple streams from one tap to multiple Snowflake schemas.
If the tap sends the stream_id in <schema_name>-<table_name> format then this option overwrites the default_target_schema value. Note, that using schema_mapping you can overwrite the default_target_schema_select_permission value to grant SELECT permissions to different groups per schemas or optionally you can create indices automatically for the replicated tables.
Note: This is an experimental feature and recommended to use via PipelineWise YAML files that will generate the object mapping in the right JSON format. For further info check a PipelineWise YAML Example
YESNamed external stage name created at pre-requirements section. Has to be a fully qualified name including the schema name. If not specified, table internal stage are used. When this is defined then s3_bucket has to be defined as well.
YESsinger-stateThe name of Singer state file stored in KV Store.
NO{
"type": "io.kestra.plugin.scripts.runner.docker.Docker"
}The task runner to use.
Task runners are provided by plugins, each have their own properties.
YESfalseKey of the state in KV Store
YESYESThe maximum amount of kernel memory the container can use.
The minimum allowed value is 4MB. Because kernel memory cannot be swapped out, a container which is starved of kernel memory may block host machine resources, which can have side effects on the host machine and on other containers. See the kernel-memory docs for more details.
YESThe maximum amount of memory resources the container can use.
Make sure to use the format number + unit (regardless of the case) without any spaces.
The unit can be KB (kilobytes), MB (megabytes), GB (gigabytes), etc.
Given that it's case-insensitive, the following values are equivalent:
"512MB""512Mb""512mb""512000KB""0.5GB"
It is recommended that you allocate at least 6MB.
YESAllows you to specify a soft limit smaller than memory which is activated when Docker detects contention or low memory on the host machine.
If you use memoryReservation, it must be set lower than memory for it to take precedence. Because it is a soft limit, it does not guarantee that the container doesn’t exceed the limit.
YESThe total amount of memory and swap that can be used by a container.
If memory and memorySwap are set to the same value, this prevents containers from using any swap. This is because memorySwap includes both the physical memory and swap space, while memory is only the amount of physical memory that can be used.
YESA setting which controls the likelihood of the kernel to swap memory pages.
By default, the host kernel can swap out a percentage of anonymous pages used by a container. You can set memorySwappiness to a value between 0 and 100 to tune this percentage.
YESYES1Docker image to use.
YESDocker configuration file.
Docker configuration file that can set access credentials to private container registries. Usually located in ~/.docker/config.json.
NOLimits the CPU usage to a given maximum threshold value.
By default, each container’s access to the host machine’s CPU cycles is unlimited. You can set various constraints to limit a given container’s access to the host machine’s CPU cycles.
YESYESDocker entrypoint to use.
YESExtra hostname mappings to the container network interface configuration.
YESDocker API URI.
NOLimits memory usage to a given maximum threshold value.
Docker can enforce hard memory limits, which allow the container to use no more than a given amount of user or system memory, or soft limits, which allow the container to use as much memory as it needs unless certain conditions are met, such as when the kernel detects low memory or contention on the host machine. Some of these options have different effects when used alone or when more than one option is set.
YESDocker network mode to use e.g. host, none, etc.
YESYESALWAYSIF_NOT_PRESENTALWAYSNEVERThe image pull policy for a container image and the tag of the image, which affect when Docker attempts to pull (download) the specified image.
YESSize of /dev/shm in bytes.
The size must be greater than 0. If omitted, the system uses 64MB.
YESUser in the Docker container.
YESList of volumes to mount.
Must be a valid mount expression as string, example : /home/user:/app.
Volumes mount are disabled by default for security reasons; you must enable them on server configuration by setting kestra.tasks.scripts.docker.volume-enabled to true.
YESThe registry authentication.
The auth field is a base64-encoded authentication string of username: password or a token.
YESThe identity token.
YESThe registry password.
YESThe registry URL.
If not defined, the registry will be extracted from the image name.
YESThe registry token.
YESThe registry username.
YESA list of capabilities; an OR list of AND lists of capabilities.
YESYESYESYESDriver-specific options, specified as key/value pairs.
These options are passed directly to the driver.