My Account

When you access the My Account menu, you can configure general Control Hub settings, such as your account and browser settings. You can invite users to join your organization, or sign out of StreamSets. If you are a member of multiple organizations, you can switch between them. If you have a Free account, you can upgrade to a paid subscription.

You can also configure Snowflake credentials and Snowflake pipeline defaults through the My Account menu.

This documentation discusses the Snowflake settings. For information about general Control Hub settings, see the Control Hub documentation.

To access the My Account menu, click the My Account icon () in the top right toolbar.

Snowflake Settings

You can configure the following information in the Snowflake section of your StreamSets account settings:
Snowflake credentials
You can define, update, or delete Snowflake credentials. Transformer for Snowflake requires the credentials to access your Snowflake account.
Once provided, the credentials are securely stored in your StreamSets account for reuse.
Snowflake pipeline defaults
You can specify defaults to use in Snowflake pipelines for the Snowflake URL, data warehouse, database, schema, and role properties. All specified defaults can be updated or overridden, as needed.
Specify pipeline defaults when you want to use the same details in most of your pipelines. Then, you don't need to specify those details each time you configure a new pipeline.

Snowflake Credentials

To access your Snowflake account, Transformer for Snowflake requires your Snowflake credentials. You can either define them in your StreamSets account or provide them upon request.

When you do not have Snowflake credentials stored in your StreamSets account, you are asked for your credentials the first time that you perform a task that requires access to Snowflake. This might occur, for example, when you preview a pipeline or start a job.

Whether you define Snowflake credentials in your StreamSets account or provide them upon request, the required credential details remain the same, and the credentials are securely stored in your account for reuse.

To change the Snowflake credentials that Transformer for Snowflake uses, you either update or delete the Snowflake credentials in your StreamSets account.

Note: To help secure your Snowflake account, you cannot view the existing Snowflake password or private key through the Control Hub user interface. You can only view password and private key values as you enter them.

Defining Snowflake Credentials

Use the following steps to define Snowflake credentials in your StreamSets account settings.
  1. In the top right toolbar, click the My Account icon () and then click your user name.
  2. Click the Snowflake Settings tab.
  3. Under Snowflake Credentials, click Edit. Configure the following properties as needed, and then click Save.

    You can click Show Value to show the password or private key that you enter.

    Snowflake Credentials Property Description
    Username Snowflake user name.
    Authentication Method Authentication method to use: password or private key.
    Password Password for the Snowflake account.

    Available when using password authentication.

    Private Key Private key for the Snowflake account. Enter a PKCS#1 or PKCS#8 private key and include the key delimiters.

    For example, when entering a PKCS#8 private key, include the -----BEGIN PRIVATE KEY----- and -----END PRIVATE KEY----- key delimiters.

    Available when using private key authentication.

    Role Optional role to use when a role is not defined in the pipeline.

    When you do not specify a role in a pipeline or in this property, Snowflake uses the default role for the user. If the user has no default role, Snowflake uses the Public role. For more information, see the Snowflake documentation.

    Use to limit access to the Snowflake account. However, note that the following permissions are generally required to run Snowflake pipelines:
    • Read
    • Write
    • Create Table

Updating or Deleting Snowflake Credentials

Update Snowflake credentials as needed. For example, you might need to update the credentials after you update your Snowflake password.
Note: To update credentials, you must specify the password or private key to use.

You can also delete Snowflake credentials from the account instead of updating them. When you delete credentials without replacing them, you must provide new credentials the next time you perform a task that requires credentials, such as starting a job or previewing data. You might delete credentials when you know that the current credentials are no longer valid, but don't have new credentials available yet.

  1. In the top right toolbar, click the My Account icon () and then click your user name.
  2. Click the Snowflake Settings tab.
  3. To delete all configured properties, under Snowflake Credentials, click Delete. When asked to confirm the deletion, click Delete.
  4. To update the properties, click Edit.
  5. Configure the following properties as needed, and then click Save.
    To save your changes, you must specify the password or private key to use. You can click Show Value to show the password or private key that you enter.
    Snowflake Credentials Property Description
    Username Snowflake user name.
    Authentication Method Authentication method to use: password or private key.
    Password Password for the Snowflake account.

    Available when using password authentication.

    Private Key Private key for the Snowflake account. Enter a PKCS#1 or PKCS#8 private key and include the key delimiters.

    For example, when entering a PKCS#8 private key, include the -----BEGIN PRIVATE KEY----- and -----END PRIVATE KEY----- key delimiters.

    Available when using private key authentication.

    Role Optional role to use when a role is not defined in the pipeline.

    When you do not specify a role in a pipeline or in this property, Snowflake uses the default role for the user. If the user has no default role, Snowflake uses the Public role. For more information, see the Snowflake documentation.

    Use to limit access to the Snowflake account. However, note that the following permissions are generally required to run Snowflake pipelines:
    • Read
    • Write
    • Create Table

Snowflake Pipeline Defaults

You can define Snowflake pipeline defaults in your StreamSets account. When configured, these defaults are used in new pipelines. You can apply the current Snowflake pipeline defaults to existing pipelines at any time.

For example, say you configure the following Snowflake pipeline defaults in your StreamSets account:

When you create a new pipeline, these details are included in pipeline properties on the General tab:

The following table lists the Snowflake pipeline default properties and the corresponding pipeline properties where they are used:
Snowflake Pipeline Default Property Pipeline Property
Account URL Snowflake URL
Warehouse Warehouse
Database Default Schema

The database is used in the property as follows: <database>.<schema>

Schema Default Schema

The schema is used in the property as follows: <database>.<schema>

Role Role

Using Snowflake Pipeline Defaults

Define Snowflake pipeline defaults to make configuring pipelines easier when you want to use the same Snowflake details in all or most of your pipelines. If you often use different Snowflake details, then defining Snowflake pipeline defaults might not be appropriate.

When you define Snowflake pipeline defaults in your StreamSets account, the defaults are included in all new pipelines as static values, so you can easily change them in individual pipelines.

For example, say an account URL is defined as a Snowflake pipeline default. When you create a new pipeline that requires a different Snowflake URL, you simply replace the value in the Snowflake URL pipeline property with the appropriate URL.

Some properties defined in a pipeline are used by default by stages. You can override those properties in individual stages as needed. For more information, see Snowflake Pipeline Properties.

Important: If you add or update Snowflake pipeline defaults in your StreamSets account, those values are only included in new pipelines by default. When needed, you can apply Snowflake pipeline defaults to individual pipelines.

Defining Pipeline Defaults

You can define Snowflake pipeline defaults in your StreamSets account. The values that you specify for pipeline defaults are used in new pipelines and can be applied to existing pipelines, as needed.

  1. In the top right toolbar, click the My Account icon () and then click your user name.
  2. Click the Snowflake Settings tab.
  3. Optionally configure the following properties.
    Snowflake Pipeline Default Property Description
    Account URL Default Snowflake URL to use. For example:

    https://<yourcompany>.snowflakecomputing.com

    Warehouse Default warehouse to use.
    Database Default database to use.
    Schema Default schema to use.
    Role Default role to use.
  4. To save the pipeline defaults, click Save.