Configuring Snowpipe Streaming¶
Snowpipe Streaming Properties¶
Configure the API connection settings in a
profile.json file. The properties are described in this section.
As shown in the Java example (GitHub), you can load the settings from
profile.json by specifying the file path as the input to the variable
Configure the authentication and authorization method for the user. You can use one of the following methods:
JWT: key pair authentication with JSON Web Token (JWT). This is the default method. If
authorization_typeis not configured, the default method
JWTwill be used. Configure the following
private_keyfor key pair authentication.
private_keyPrivate key to authenticate the user. Include only the key, not the header or footer. If the key is split across multiple lines, remove the line breaks.
You can provide an unencrypted key, or you can provide an encrypted key and provide the
snowflake.private.key.passphraseparameter to enable Snowflake to decrypt the key. Use this parameter if and only if the
snowflake.private.keyparameter value is encrypted.
OAuth: Snowflake OAuth. This option is only available with Snowflake Ingest SDK versions 2.0.3 and later. Configure the following parameters for Snowflake OAuth in the
oauth_client_id: The client ID of the OAuth integration.
oauth_client_secret: The client secret of the OAuth integration.
oauth_refresh_token: A valid refresh token of the OAuth integration.
URL for accessing your Snowflake account. This URL must include your account identifier. Note that the protocol (
https://) and port number are optional.
urlis not required if you are already using the Snowflake Ingest SDK and have set the
portproperties in the
User login name for the Snowflake account.
Passphrase to decrypt the private key when the key is encrypted. For information, see Using Key Pair Authentication & Key Rotation (in this topic).
Access control role to use for the session after connecting to Snowflake.
Note that the
roleproperty is optional for Snowflake Ingest SDK versions 2.0.3 and later. It is required for earlier Ingest SDK versions.
For a simple example that shows how the client SDK could be used to build a Snowpipe Streaming application, see this Java file (GitHub).
Quick start examples: