Skip to main content

dbt assets package

The dbt assets package crawls dbt assets and publishes them to Atlan for discovery.

Cloud​

Will create a new connection

This should only be used to create the workflow the first time. Each time you run this method it will create a new connection and new assets within that connection — which could lead to duplicate assets if you run the workflow this way multiple times with the same settings.

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

To create a new crawl of dbt assets from a multi-tenant dbt Cloud account:

dbt Cloud multi-tenant
Workflow crawler = DbtCrawler.creator( // (1)
      client, // (2)
      "dbt-snowflake", // (3)
      List.of(client.getRoleCache().getIdForName("$admin")), // (4)
      null,
      null
    )
    .cloud( // (5)
      "https://cloud.getdbt.com",
      "example-token", 
      true
    )
    .limitToConnection( // (6)
      "default/snowflake/1234567890"
    )
    .include("{\"24670\":{\"211208\":{\"163013\":{\"207502\":{}}}}}") // (7)
    .exclude("{\"24670\":{}}") // (8)
    .tags(true) // (9)
    .enrichMaterializedAssets(true) // (10)
    .build()  // (11)
    .toWorkflow();  // (12)
WorkflowResponse response = crawler.run(client);  // (13)

  1. The DbtCrawler package will create a workflow to crawl assets from dbt cloud.

  2. You must provide Atlan client.

  3. You must provide a name for the connection that the dbt assets will exist within.

  4. You must specify at least one connection admin, either:

    • everyone in a role (in this example, all $admin users)
    • a list of groups (names) that will be connection admins.
    • a list of users (names) that will be connection admins.

  5. To configure the crawler for extracting dbt assets directly from dbt cloud account then you must provide the following information:

    • hostname of your dbt cloud instance.
    • token to use to authenticate against dbt cloud instance.
    • whether to use a multi-tenant cloud config (true), otherwise a single-tenant cloud config (false).

  6. You can also optionally specify the qualifiedName of a connection to a source (such as Snowflake), to limit the crawling of dbt assets to that existing connection in Atlan.

  7. You can also optionally specify the list of assets to include in crawling. This is a highly-nested map structure of numeric IDs for the account, project, etc. You will almost certainly need to set up the filter you want through the UI first, and look at the developer console of your browser to see the structure.

  8. You can also optionally specify the list of assets to exclude from crawling. This follows the same structure as the inclusion filter.

  9. You can also optionally specify whether to enable dbt tag syncing as part of crawling dbt.

  10. You can also optionally set whether to enable the enrichment of materialized SQL assets as part of crawling dbt.

  11. Build the minimal package object.

  12. Now, you can convert the package into a Workflow object.

  13. You can then run the workflow using the run() method on the object you've created. Because this operation will execute work in Atlan, you must provide it an AtlanClient through which to connect to the tenant.

    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. :::

Core​

Will create a new connection

This should only be used to create the workflow the first time. Each time you run this method it will create a new connection and new assets within that connection — which could lead to duplicate assets if you run the workflow this way multiple times with the same settings.

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

To create a new crawl of dbt assets from a dbt files location:

dbt Core
Workflow crawler = DbtCrawler.creator( // (1)
      client, // (2)
      "dbt-snowflake", // (3)
      List.of(client.getRoleCache().getIdForName("$admin")), // (4)
      null,
      null
    )
    .core( // (5)
      "dbt-bucket",
      "dbt-data", 
      "ap-south-1"
    )
    .limitToConnection( // (6)
      "default/snowflake/1234567890"
    )
    .tags(true) // (7)
    .enrichMaterializedAssets(true) // (8)
    .build()  // (9)
    .toWorkflow();  // (10)
WorkflowResponse response = crawler.run(client);  // (11)

  1. The DbtCrawler package will create a workflow to crawl assets from dbt files location.

  2. You must provide Atlan client.

  3. You must provide a name for the connection that the dbt assets will exist within

  4. You must specify at least one connection admin, either:

    • everyone in a role (in this example, all $admin users)
    • a list of groups (names) that will be connection admins.
    • a list of users (names) that will be connection admins.

  5. To configure the crawler for extracting dbt assets directly from the dbt files location, you must provide the following information:

    • s3 bucket containing the dbt Core files.
    • prefix within the S3 bucket where the dbt Core files are located.
    • s3 region where the bucket is located.

  6. You can also optionally specify the qualifiedName of a connection to a source (such as Snowflake), to limit the crawling of dbt assets to that existing connection in Atlan.

  7. You can also optionally specify the list of assets to include in crawling. This is a highly-nested map structure of numeric IDs for the account, project, etc. You will almost certainly need to set up the filter you want through the UI first, and look at the developer console of your browser to see the structure.

  8. You can also optionally set whether to enable the enrichment of materialized SQL assets as part of crawling dbt.

  9. Build the minimal package object.

  10. Now, you can convert the package into a Workflow object.

  11. You can then run the workflow using the run() method on the object you've created. Because this operation will execute work in Atlan, you must provide it an AtlanClient through which to connect to the tenant.

    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. :::

Re-run existing workflow​

To re-run an existing workflow for dbt assets:

Re-run existing dbt workflow
List<WorkflowSearchResult> existing = WorkflowSearchRequest // (1)
    .findByType(client, DbtCrawler.PREFIX, 5); // (2)
// Determine which of the results is the dbt workflow you want to re-run...
WorkflowRunResponse response = existing.get(n).rerun(client); // (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 DbtCrawler. (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. Because this operation will execute work in Atlan, you must provide it an AtlanClient through which to connect to the tenant.

    • Optionally, you can use the rerun(client, true) method with idempotency to avoid re-running a workflow that is already in running or in a pending state. This will return details of the already running workflow if found, and by default, it is set to false
    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. :::

Was this page helpful?