1 of 1

Create a Snowflake Data Source

Snowflake data source API reference guide

Deprecation notice

Support for registering Snowflake data sources using this legacy workflow has been deprecated. Instead, register your data using .

The snowflake endpoint allows you to connect and manage Snowflake data sources in Immuta.

Additional fields may be included in some responses you receive; however, these attributes are for internal purposes and are therefore undocumented.

Snowflake workflow

Snowflake imported databases

Immuta does not support Snowflake tables from imported databases. Instead, create a view of the table and register that view as a data source.

Create a data source.
Get information about a data source.
.

POST /snowflake/handler

Save the provided connection information as a data source.

CREATE_DATA_SOURCE Immuta permission
The Snowflake user registering data sources must have the following privileges on all securables:
- USAGE on all databases and schemas with registered data sources

Attribute

Description

Required

Attribute

Description

This request creates a Snowflake data source.

GET /snowflake/handler/{handlerId}

Get the handler metadata associated with the provided handler ID.

Attribute

Description

Required

Attribute

Description

This request returns metadata for the handler with the ID 30.

Method

Path

Purpose

PUT /snowflake/handler/{handlerId}

Update the data source metadata associated with the provided handler ID. This endpoint does not perform partial updates, but will allow the dictionary to be omitted. In this case, it uses the current dictionary.

Required: The global GOVERNANCE permission or be the data source owner

Attribute

Description

Required

Attribute

Description

Required

Attribute

Description

This request updates the metadata for the data source with the handler ID 30.

Payload example

The payload below updates the eventTime to MOST_RECENT_ORDER.

PUT /snowflake/bulk

Update the data source metadata associated with the provided connection string.

Required: The global GOVERNANCE permission or be the data source owner

Attribute

Description

Required

Attribute

Description

This request updates the metadata for all data sources with the connection string specified in example-payload.json.

Payload example

The payload below updates the database to ANALYST_DEMO for the provided connection string.

PUT /snowflake/handler/{handlerId}/triggerHighCardinalityJob

Recalculate the high cardinality column for the specified data source.

Required: The global GOVERNANCE permission or be the data source owner

Attribute

Description

Required

The response returns a string of characters that identify the high cardinality job run.

This request re-runs the job that calculates the high cardinality column for the data source with the handler ID 30.

Create a Snowflake Data Source

Snowflake data source API reference guide

Deprecation notice

Support for registering Snowflake data sources using this legacy workflow has been deprecated. Instead, register your data using .

The snowflake endpoint allows you to connect and manage Snowflake data sources in Immuta.

Additional fields may be included in some responses you receive; however, these attributes are for internal purposes and are therefore undocumented.

Snowflake workflow

Snowflake imported databases

Immuta does not support Snowflake tables from imported databases. Instead, create a view of the table and register that view as a data source.

Create a data source.
Get information about a data source.
.

POST /snowflake/handler

Save the provided connection information as a data source.

CREATE_DATA_SOURCE Immuta permission
The Snowflake user registering data sources must have the following privileges on all securables:
- USAGE on all databases and schemas with registered data sources

Attribute

Description

Required

Attribute

Description

This request creates a Snowflake data source.

GET /snowflake/handler/{handlerId}

Get the handler metadata associated with the provided handler ID.

Attribute

Description

Required

Attribute

Description

This request returns metadata for the handler with the ID 30.

Method

Path

Purpose

PUT /snowflake/handler/{handlerId}

Required: The global GOVERNANCE permission or be the data source owner

Attribute

Description

Required

Attribute

Description

Required

Attribute

Description

This request updates the metadata for the data source with the handler ID 30.

Payload example

The payload below updates the eventTime to MOST_RECENT_ORDER.

PUT /snowflake/bulk

Update the data source metadata associated with the provided connection string.

Required: The global GOVERNANCE permission or be the data source owner

Attribute

Description

Required

Attribute

Description

This request updates the metadata for all data sources with the connection string specified in example-payload.json.

Payload example

The payload below updates the database to ANALYST_DEMO for the provided connection string.

PUT /snowflake/handler/{handlerId}/triggerHighCardinalityJob

Recalculate the high cardinality column for the specified data source.

Required: The global GOVERNANCE permission or be the data source owner

Attribute

Description

Required

The response returns a string of characters that identify the high cardinality job run.

This request re-runs the job that calculates the high cardinality column for the data source with the handler ID 30.

{
  "handler": {
    "metadata": {
      "ssl": true,
      "userFiles": [],
      "authenticationMethod": "userPassword",
      "username": "user",
      "password": "yourpassword",
      "port": 443,
      "hostname": "demo.us-east-1.snowflakecomputing.com",
      "warehouse": "YOUR_WH",
      "database": "ANALYTICS",
      "schema": "TEST",
      "table": "CUSTOMERS",
      "nativeViewName": "customers_immuta",
      "nativeSchemaName": "test_immuta",
      "nativeWorkspaceName": "immuta_analytics",
      "schemaProjectName": "Test",
      "bodataSchemaName": "test",
      "columns": [{
        "name": "CUSTOMER_ID",
        "dataType": "numeric(38,0)",
        "remoteType": "number(38,0)",
        "isPrimaryKey": false,
        "nullable": true
      }, {
        "name": "FIRST_NAME",
        "dataType": "text",
        "remoteType": "varchar(16777216)",
        "isPrimaryKey": false,
        "nullable": true
      }, {
        "name": "LAST_NAME",
        "dataType": "text",
        "remoteType": "varchar(16777216)",
        "isPrimaryKey": false,
        "nullable": true
      }, {
        "name": "FIRST_ORDER",
        "dataType": "date",
        "remoteType": "date",
        "isPrimaryKey": false,
        "nullable": true
      }, {
        "name": "MOST_RECENT_ORDER",
        "dataType": "date",
        "remoteType": "date",
        "isPrimaryKey": false,
        "nullable": true
      }, {
        "name": "NUMBER_OF_ORDERS",
        "dataType": "numeric(18,0)",
        "remoteType": "number(18,0)",
        "isPrimaryKey": false,
        "nullable": true
      }, {
        "name": "TOTAL_ORDER_AMOUNT",
        "dataType": "numeric",
        "remoteType": "number(38,6)",
        "isPrimaryKey": false,
        "nullable": true
      }],
      "eventTime": "FIRST_ORDER",
      "staleDataTolerance": 86400,
      "bodataTableName": "customers",
      "dataSourceName": "Customers"
    }
  },
  "dataSource": {
    "blobHandler": {
      "scheme": "https",
      "url": ""
    },
    "blobHandlerType": "Snowflake",
    "recordFormat": "",
    "type": "queryable",
    "schemaEvolutionId": null,
    "columnEvolutionEnabled": true,
    "name": "Customers",
    "sqlTableName": "customers"
  },
  "schemaEvolution": {
    "ownerProfileId": 2,
    "config": {
      "nameTemplate": {
        "nameFormat": "<Schema> <Tablename>",
        "tableFormat": "<tablename>",
        "sqlSchemaNameFormat": "<schema>",
        "schemaProjectNameFormat": "<Schema>"
      }
    },
    "schemas": []
  }
}

{
  "handler": {
    "policyHandler": null,
    "dataSourceId": 30,
    "metadata": {
      "ssl": true,
      "port": 443,
      "table": "CUSTOMERS",
      "schema": "TEST",
      "database": "ANALYTICS",
      "hostname": "demo.us-east-1.snowflakecomputing.com",
      "username": "user",
      "eventTime": "MOST_RECENT_ORDER",
      "userFiles": [],
      "warehouse": "YOUR_WH",
      "dataSourceName": "Customers",
      "bodataTableName": "customers",
      "highCardinality": "CUSTOMER_ID",
      "bodataSchemaName": "test",
      "columnsNormalized": true,
      "schemaProjectName": "Test",
      "staleDataTolerance": 86400,
      "authenticationMethod": "userPassword",
      "columns": [{
        "name": "CUSTOMER_ID",
        "dataType": "numeric(38,0)",
        "nullable": true,
        "remoteType": "number(38,0)",
        "isPrimaryKey": false,
        "remoteColumn": "CUSTOMER_ID"
      }, {
        "name": "FIRST_NAME",
        "dataType": "text",
        "nullable": true,
        "remoteType": "varchar(16777216)",
        "isPrimaryKey": false,
        "remoteColumn": "FIRST_NAME"
      }, {
        "name": "LAST_NAME",
        "dataType": "text",
        "nullable": true,
        "remoteType": "varchar(16777216)",
        "isPrimaryKey": false,
        "remoteColumn": "LAST_NAME"
      }, {
        "name": "FIRST_ORDER",
        "dataType": "date",
        "nullable": true,
        "remoteType": "date",
        "isPrimaryKey": false,
        "remoteColumn": "FIRST_ORDER"
      }, {
        "name": "MOST_RECENT_ORDER",
        "dataType": "date",
        "nullable": true,
        "remoteType": "date",
        "isPrimaryKey": false,
        "remoteColumn": "MOST_RECENT_ORDER"
      }, {
        "name": "NUMBER_OF_ORDERS",
        "dataType": "numeric(18,0)",
        "nullable": true,
        "remoteType": "number(18,0)",
        "isPrimaryKey": false,
        "remoteColumn": "NUMBER_OF_ORDERS"
      }, {
        "name": "TOTAL_ORDER_AMOUNT",
        "dataType": "numeric",
        "nullable": true,
        "remoteType": "number(38,6)",
        "isPrimaryKey": false,
        "remoteColumn": "TOTAL_ORDER_AMOUNT"
      }]
    },
    "type": "queryable",
    "connectionString": "[email protected]:443/ANALYTICS",
    "id": 30,
    "createdAt": "2021-10-01T16:19:23.562Z",
    "updatedAt": "2021-10-01T17:19:35.853Z",
    "dbms": {
      "name": "snowflake"
    }
  }
}

Create a Snowflake Data Source

Snowflake workflow

Create a Snowflake Data Source

Snowflake workflow

Create a data source

Requirements

Payload parameters

Response parameters

Request example

Payload example

Response example

Get information about a data source

Query parameters

Response parameters

Request example

Response example

Manage data sources

Update a specific data source

Query parameters

Payload parameters

Response parameters

Request example

Response example

Update multiple data sources

Payload parameters

Response parameters

Request example

Response example

Recalculate the high cardinality column for a data source

Query parameters

Response parameters

Request example

Response example