Skip to main content

modifySnowflakeDataSource

This mutation selects a Data Source by its ID or unique name and modifies it to have the given unique name, description, and connection settings.

If any of the optional arguments are omitted, those properties will be unchanged on the Data Source.

A Data Source is a connection to your data warehouse. It has the necessary connection details for Propel to access Snowflake or any other supported Data Source.

Arguments

  • input required modifySnowflakeDataSourceInput

    The fields for modifying a Snowflake Data Source.

    • input.idOrUniqueName required idOrUniqueName

      The ID or unique name of the Data Source to modify.

      The ID or unique name input.

      If both ID and unique name are provided, the ID will take precedence.

    • input.uniqueName optional String

      The Data Source's new unique name.

    • input.description optional String

      The Data Source's new description.

    • input.connectionSettings optional PartialSnowflakeConnectionSettingsInput

      The Data Source's new connection settings.

      The fields for modifying a Snowflake Data Source's connection settings.

      • input.connectionSettings.account optional String

        The Snowflake account. Only include the part before the "snowflakecomputing.com" part of your Snowflake URL (make sure you are in classic console, not Snowsight). For AWS-based accounts, this looks like "znXXXXX.us-east-2.aws". For Google Cloud-based accounts, this looks like "ffXXXXX.us-central1.gcp". If not provided this property will not be modified.

      • input.connectionSettings.database optional String

        The Snowflake database name. If not provided this property will not be modified.

      • input.connectionSettings.warehouse optional String

        The Snowflake warehouse name. It should be "PROPELLING" if you used the default name in the setup script. If not provided this property will not be modified.

      • input.connectionSettings.schema optional String

        The Snowflake schema. If not provided this property will not be modified.

      • input.connectionSettings.username optional String

        The Snowflake username. It should be "PROPEL" if you used the default name in the setup script. If not provided this property will not be modified.

      • input.connectionSettings.password optional String

        The Snowflake password. If not provided this property will not be modified.

      • input.connectionSettings.role optional String

        The Snowflake role. It should be "PROPELLER" if you used the default name in the setup script. If not provided this property will not be modified.


Returns

Nullable DataSourceOrFailureResponse

The result of a mutation which creates or modifies a DataSource.

If successful, an DataSourceResponse will be returned; otherwise, a FailureResponse will be returned.