Skip to main content

PutSnowflakeInternalStageFile

Description​

Puts files into a Snowflake internal stage. The internal stage must be created in the Snowflake account beforehand.

Tags​

connection, database, jdbc, snowflake, snowpipe

Properties​

In the list below required Properties are shown with an asterisk (*). Other properties are considered optional. The table also indicates any default values, and whether a property supports the NiFi Expression Language.

Display NameAPI NameDefault ValueAllowable ValuesDescription
Snowflake Connection Service *Snowflake Connection ServiceController Service:
DBCPService

Implementations:
DBCPConnectionPoolLookup
DBCPConnectionPool
HikariCPConnectionPool
SnowflakeConnectionService
Database Connection Service for accessing Snowflake
Internal Stage Type *Internal Stage Type
  • User
  • Table
  • Named
The type of internal stage to use
DatabaseDatabaseThe database to use by default. The same as passing 'db=DATABASE_NAME' to the connection string.

Supports Expression Language, using Environment variables.

This property is only considered if:
  • the property Internal Stage Type has a value of named or table
SchemaSchemaThe schema to use by default. The same as passing 'schema=SCHEMA' to the connection string.

Supports Expression Language, using Environment variables.

This property is only considered if:
  • the property Internal Stage Type has a value of named or table
Table *TableThe name of the table in the Snowflake account.

Supports Expression Language, using FlowFile attributes and Environment variables.

This property is only considered if:
  • the property Internal Stage Type has a value of table
Stage *StageThe name of the internal stage in the Snowflake account to put files into.

Supports Expression Language, using FlowFile attributes and Environment variables.

This property is only considered if:
  • the property Internal Stage Type has a value of named
File PrefixFile PrefixPath prefix under which the data should be uploaded on the stage.

Supports Expression Language, using FlowFile attributes and Environment variables.
File Name *File Name${filename}Destination file name to use.

Supports Expression Language, using FlowFile attributes and Environment variables.
Compression EnabledCompression Enabledfalse
  • true
  • false
Set true to compress data before uploading the file

Dynamic Properties​

This component does not support dynamic properties.

Relationships​

NameDescription
failureFor FlowFiles of failed PUT operation
successFor FlowFiles of successful PUT operation

Reads Attributes​

This processor does not read attributes.

Writes Attributes​

NameDescription
snowflake.staged.file.pathStaged file path

State Management​

This component does not store state.

Restricted​

This component is not restricted.

Input Requirement​

This component requires an incoming relationship.

System Resource Considerations​

This component does not specify system resource considerations.

See Also​