Snowflake miner package

The Snowflake miner package mines query history from Snowflake. This data is used for generating lineage and usage metrics.

Source extraction

Will create a new connection

This should only be used to create the workflow the first time.

Instead, when you want to re-crawl assets, re-run the existing workflow (see Re-run existing workflow below).

1.0.0

To mine query history directly from Snowflake using its built-in database:

Java Python Raw REST API

Workflow miner = SnowflakeMiner.defaultSource( // (1)
                "default/snowflake/1234567890"); // (2)
WorkflowResponse response = miner.run(); // (3)

1. The SnowflakeMiner package will create a workflow to mine query history from Snowflake. The defaultSource() method creates a workflow for mining history directly from Snowflake using its built-in database.
2. You must provide the exact qualifiedName of the Snowflake connection in Atlan for which you want to mine query history.

3. You can then run the workflow using the run() method on the object you've created.

   Workflows run asynchronously

   Remember that workflows run asynchronously. See the packages and workflows introduction for details on how you can check the status and wait until the workflow has been completed.

Coming soon

Create the workflow via UI only

We recommend creating the workflow only via the UI. To rerun an existing workflow, see the steps below.

Re-run existing workflow

1.0.0

To re-run an existing workflow for Snowflake query mining:

Java Python Raw REST API

List<WorkflowSearchResult> existing = WorkflowSearchRequest // (1)
            .findByType(SnowflakeMiner.PREFIX, 5); // (2)
// Determine which of the results is the Snowflake workflow you want to re-run...
WorkflowRunResponse response = existing.get(n).rerun(); // (3)

1. You can search for existing workflows through the WorkflowSearchRequest class.
2. You can find workflows by their type using the findByType() helper method and providing the prefix for one of the packages. In this example, we do so for the SnowflakeMiner. (You can also specify the maximum number of resulting workflows you want to retrieve as results.)

3. Once you've found the workflow you want to re-run, you can simply call the rerun() helper method on the workflow search result. The WorkflowRunResponse is just a subtype of WorkflowResponse so has the same helper method to monitor progress of the workflow run.

   Workflows run asynchronously

   Remember that workflows run asynchronously. See the packages and workflows introduction for details on how you can check the status and wait until the workflow has been completed.

Coming soon

Requires multiple steps through the raw REST API

1. Find the existing workflow.
2. Send through the resulting re-run request.

{
  "from": 0,
  "size": 5,
  "query": {
    "bool": {
      "filter": [
        {
          "nested": {
            "path": "metadata",
            "query": {
              "prefix": {
                "metadata.name.keyword": {
                  "value": "atlan-snowflake-miner" // (1)
                }
              }
            }
          }
        }
      ]
    }
  },
  "sort": [
    {
      "metadata.creationTimestamp": {
        "nested": {
          "path": "metadata"
        },
        "order": "desc"
      }
    }
  ],
  "track_total_hits": true
}

1. Searching by the atlan-snowflake-miner prefix will ensure you only find existing Snowflake miner workflows.

   Name of the workflow

   The name of the workflow will be nested within the _source.metadata.name property of the response object. (Remember since this is a search, there could be multiple results, so you may want to use the other details in each result to determine which workflow you really want.)

{
  "namespace": "default",
  "resourceKind": "WorkflowTemplate",
  "resourceName": "atlan-snowflake-miner-1684500411" // (1)
}

1. Send the name of the workflow as the resourceName to rerun it.

---