dbt model¶
Base class for dbt assets.
Reference documentation
This is reference documentation covering the entire Atlan model. It is not the best place to start when trying to understand integrating dbt metadata with Atlan. For that, we would suggest starting with the common asset actions snippets.
classDiagram
direction RL
class Dbt {
<<abstract>>
}
link Dbt "../dbt"
class Catalog {
<<abstract>>
}
link Catalog "../entities/catalog"
Catalog <|-- Dbt : extends
class Asset {
<<abstract>>
}
link Asset "../entities/asset"
Asset <|-- Catalog : extends
class Referenceable {
<<abstract>>
}
link Referenceable "../entities/referenceable"
Referenceable <|-- Asset : extends
class Metric {
<<abstract>>
}
link Metric "../entities/metric"
DataQuality <|-- Metric : extends
class DbtMetric
link DbtMetric "../entities/dbtmetric"
Metric <|-- DbtMetric : extends
class DataQuality {
<<abstract>>
}
link DataQuality "../entities/dataquality"
Catalog <|-- DataQuality : extends
class DbtModelColumn
link DbtModelColumn "../entities/dbtmodelcolumn"
Dbt <|-- DbtModelColumn : extends
class DbtModel
link DbtModel "../entities/dbtmodel"
Dbt <|-- DbtModel : extends
class DbtColumnProcess
link DbtColumnProcess "../entities/dbtcolumnprocess"
Dbt <|-- DbtColumnProcess : extends
class DbtMetric
link DbtMetric "../entities/dbtmetric"
Dbt <|-- DbtMetric : extends
class DbtSource
link DbtSource "../entities/dbtsource"
Dbt <|-- DbtSource : extends
class DbtProcess
link DbtProcess "../entities/dbtprocess"
Dbt <|-- DbtProcess : extends
Process <|-- DbtProcess : extends
ColumnProcess <|-- DbtColumnProcess : extends
class DbtTag
link DbtTag "../entities/dbttag"
Dbt <|-- DbtTag : extends
class DbtTest
link DbtTest "../entities/dbttest"
Dbt <|-- DbtTest : extends
class Process
link Process "../process"
Asset <|-- Process : extends
class ColumnProcess
link ColumnProcess "../entities/columnprocess"
Process <|-- ColumnProcess : extends
Type-specific properties¶
Following are the properties uniquely available on Dbt
assets in Atlan.
dbtAccountName
TBC | |
---|---|
1 2 3 4 |
|
-
Set the
dbtAccountName
for aDbt
. -
Retrieve the
dbtAccountName
from aDbt
.For more details
For more information, see the asset CRUD snippets on retrieving assets.
-
Find all assets in Atlan with their
dbtAccountName
exactly matching the provided value.For more details
For more information, see the searching section on term queries.
-
Find all assets in Atlan with their
dbtAccountName
textually matching the provided value.For more details
For more information, see the searching section on full text queries.
dbtAlias
TBC | |
---|---|
1 2 3 4 |
|
-
Set the
dbtAlias
for aDbt
. -
Retrieve the
dbtAlias
from aDbt
.For more details
For more information, see the asset CRUD snippets on retrieving assets.
-
Find all assets in Atlan with their
dbtAlias
exactly matching the provided value.For more details
For more information, see the searching section on term queries.
-
Find all assets in Atlan with their
dbtAlias
textually matching the provided value.For more details
For more information, see the searching section on full text queries.
dbtConnectionContext
TBC | |
---|---|
1 2 3 |
|
-
Set the
dbtConnectionContext
for aDbt
. -
Retrieve the
dbtConnectionContext
from aDbt
.For more details
For more information, see the asset CRUD snippets on retrieving assets.
-
Find all assets in Atlan with their
dbtConnectionContext
exactly matching the provided value.For more details
For more information, see the searching section on term queries.
dbtEnvironmentDbtVersion
TBC | |
---|---|
1 2 3 4 |
|
-
Set the
dbtEnvironmentDbtVersion
for aDbt
. -
Retrieve the
dbtEnvironmentDbtVersion
from aDbt
.For more details
For more information, see the asset CRUD snippets on retrieving assets.
-
Find all assets in Atlan with their
dbtEnvironmentDbtVersion
exactly matching the provided value.For more details
For more information, see the searching section on term queries.
-
Find all assets in Atlan with their
dbtEnvironmentDbtVersion
textually matching the provided value.For more details
For more information, see the searching section on full text queries.
dbtEnvironmentName
TBC | |
---|---|
1 2 3 4 |
|
-
Set the
dbtEnvironmentName
for aDbt
. -
Retrieve the
dbtEnvironmentName
from aDbt
.For more details
For more information, see the asset CRUD snippets on retrieving assets.
-
Find all assets in Atlan with their
dbtEnvironmentName
exactly matching the provided value.For more details
For more information, see the searching section on term queries.
-
Find all assets in Atlan with their
dbtEnvironmentName
textually matching the provided value.For more details
For more information, see the searching section on full text queries.
dbtJobLastRun
TBC | |
---|---|
1 2 3 |
|
-
Set the
dbtJobLastRun
for aDbt
. -
Retrieve the
dbtJobLastRun
from aDbt
.For more details
For more information, see the asset CRUD snippets on retrieving assets.
-
Find all assets in Atlan with their
dbtJobLastRun
greater than the provided value.For more details
For more information, see the searching section on range queries.
dbtJobName
TBC | |
---|---|
1 2 3 4 |
|
-
Set the
dbtJobName
for aDbt
. -
Retrieve the
dbtJobName
from aDbt
.For more details
For more information, see the asset CRUD snippets on retrieving assets.
-
Find all assets in Atlan with their
dbtJobName
exactly matching the provided value.For more details
For more information, see the searching section on term queries.
-
Find all assets in Atlan with their
dbtJobName
textually matching the provided value.For more details
For more information, see the searching section on full text queries.
dbtJobNextRun
TBC | |
---|---|
1 2 3 |
|
-
Set the
dbtJobNextRun
for aDbt
. -
Retrieve the
dbtJobNextRun
from aDbt
.For more details
For more information, see the asset CRUD snippets on retrieving assets.
-
Find all assets in Atlan with their
dbtJobNextRun
greater than the provided value.For more details
For more information, see the searching section on range queries.
dbtJobNextRunHumanized
TBC | |
---|---|
1 2 3 4 |
|
-
Set the
dbtJobNextRunHumanized
for aDbt
. -
Retrieve the
dbtJobNextRunHumanized
from aDbt
.For more details
For more information, see the asset CRUD snippets on retrieving assets.
-
Find all assets in Atlan with their
dbtJobNextRunHumanized
exactly matching the provided value.For more details
For more information, see the searching section on term queries.
-
Find all assets in Atlan with their
dbtJobNextRunHumanized
textually matching the provided value.For more details
For more information, see the searching section on full text queries.
dbtJobSchedule
TBC | |
---|---|
1 2 3 |
|
-
Set the
dbtJobSchedule
for aDbt
. -
Retrieve the
dbtJobSchedule
from aDbt
.For more details
For more information, see the asset CRUD snippets on retrieving assets.
-
Find all assets in Atlan with their
dbtJobSchedule
exactly matching the provided value.For more details
For more information, see the searching section on term queries.
dbtJobScheduleCronHumanized
TBC | |
---|---|
1 2 3 4 |
|
-
Set the
dbtJobScheduleCronHumanized
for aDbt
. -
Retrieve the
dbtJobScheduleCronHumanized
from aDbt
.For more details
For more information, see the asset CRUD snippets on retrieving assets.
-
Find all assets in Atlan with their
dbtJobScheduleCronHumanized
exactly matching the provided value.For more details
For more information, see the searching section on term queries.
-
Find all assets in Atlan with their
dbtJobScheduleCronHumanized
textually matching the provided value.For more details
For more information, see the searching section on full text queries.
dbtJobStatus
TBC | |
---|---|
1 2 3 |
|
-
Set the
dbtJobStatus
for aDbt
. -
Retrieve the
dbtJobStatus
from aDbt
.For more details
For more information, see the asset CRUD snippets on retrieving assets.
-
Find all assets in Atlan with their
dbtJobStatus
exactly matching the provided value.For more details
For more information, see the searching section on term queries.
dbtMeta
TBC | |
---|---|
1 2 3 |
|
-
Set the
dbtMeta
for aDbt
. -
Retrieve the
dbtMeta
from aDbt
.For more details
For more information, see the asset CRUD snippets on retrieving assets.
-
Find all assets in Atlan with their
dbtMeta
exactly matching the provided value.For more details
For more information, see the searching section on term queries.
dbtPackageName
TBC | |
---|---|
1 2 3 4 |
|
-
Set the
dbtPackageName
for aDbt
. -
Retrieve the
dbtPackageName
from aDbt
.For more details
For more information, see the asset CRUD snippets on retrieving assets.
-
Find all assets in Atlan with their
dbtPackageName
exactly matching the provided value.For more details
For more information, see the searching section on term queries.
-
Find all assets in Atlan with their
dbtPackageName
textually matching the provided value.For more details
For more information, see the searching section on full text queries.
dbtProjectName
TBC | |
---|---|
1 2 3 4 |
|
-
Set the
dbtProjectName
for aDbt
. -
Retrieve the
dbtProjectName
from aDbt
.For more details
For more information, see the asset CRUD snippets on retrieving assets.
-
Find all assets in Atlan with their
dbtProjectName
exactly matching the provided value.For more details
For more information, see the searching section on term queries.
-
Find all assets in Atlan with their
dbtProjectName
textually matching the provided value.For more details
For more information, see the searching section on full text queries.
dbtSemanticLayerProxyUrl
TBC | |
---|---|
1 2 3 |
|
-
Set the
dbtSemanticLayerProxyUrl
for aDbt
. -
Retrieve the
dbtSemanticLayerProxyUrl
from aDbt
.For more details
For more information, see the asset CRUD snippets on retrieving assets.
-
Find all assets in Atlan with their
dbtSemanticLayerProxyUrl
exactly matching the provided value.For more details
For more information, see the searching section on term queries.
dbtTags
TBC | |
---|---|
1 2 3 4 5 |
|
-
Set the
dbtTags
for aDbt
. -
Retrieve the
dbtTags
from aDbt
.For more details
For more information, see the asset CRUD snippets on retrieving assets.
-
Find all assets in Atlan with their
dbtTags
exactly matching the provided value.For more details
For more information, see the searching section on term queries.
dbtUniqueId
TBC | |
---|---|
1 2 3 4 |
|
-
Set the
dbtUniqueId
for aDbt
. -
Retrieve the
dbtUniqueId
from aDbt
.For more details
For more information, see the asset CRUD snippets on retrieving assets.
-
Find all assets in Atlan with their
dbtUniqueId
exactly matching the provided value.For more details
For more information, see the searching section on term queries.
-
Find all assets in Atlan with their
dbtUniqueId
textually matching the provided value.For more details
For more information, see the searching section on full text queries.
dbt_account_name
TBC | |
---|---|
1 2 3 4 |
|
-
Set the
dbt_account_name
for aDbt
. -
Retrieve the
dbt_account_name
from aDbt
.For more details
For more information, see the asset CRUD snippets on retrieving assets.
-
Find all assets in Atlan with their
dbt_account_name
exactly matching the provided value.For more details
For more information, see the searching section on term queries.
-
Find all assets in Atlan with their
dbt_account_name
textually matching the provided value.For more details
For more information, see the searching section on full text queries.
dbt_alias
TBC | |
---|---|
1 2 3 4 |
|
-
Set the
dbt_alias
for aDbt
. -
Retrieve the
dbt_alias
from aDbt
.For more details
For more information, see the asset CRUD snippets on retrieving assets.
-
Find all assets in Atlan with their
dbt_alias
exactly matching the provided value.For more details
For more information, see the searching section on term queries.
-
Find all assets in Atlan with their
dbt_alias
textually matching the provided value.For more details
For more information, see the searching section on full text queries.
dbt_connection_context
TBC | |
---|---|
1 2 3 |
|
-
Set the
dbt_connection_context
for aDbt
. -
Retrieve the
dbt_connection_context
from aDbt
.For more details
For more information, see the asset CRUD snippets on retrieving assets.
-
Find all assets in Atlan with their
dbt_connection_context
exactly matching the provided value.For more details
For more information, see the searching section on term queries.
dbt_environment_dbt_version
TBC | |
---|---|
1 2 3 4 |
|
-
Set the
dbt_environment_dbt_version
for aDbt
. -
Retrieve the
dbt_environment_dbt_version
from aDbt
.For more details
For more information, see the asset CRUD snippets on retrieving assets.
-
Find all assets in Atlan with their
dbt_environment_dbt_version
exactly matching the provided value.For more details
For more information, see the searching section on term queries.
-
Find all assets in Atlan with their
dbt_environment_dbt_version
textually matching the provided value.For more details
For more information, see the searching section on full text queries.
dbt_environment_name
TBC | |
---|---|
1 2 3 4 |
|
-
Set the
dbt_environment_name
for aDbt
. -
Retrieve the
dbt_environment_name
from aDbt
.For more details
For more information, see the asset CRUD snippets on retrieving assets.
-
Find all assets in Atlan with their
dbt_environment_name
exactly matching the provided value.For more details
For more information, see the searching section on term queries.
-
Find all assets in Atlan with their
dbt_environment_name
textually matching the provided value.For more details
For more information, see the searching section on full text queries.
dbt_job_last_run
TBC | |
---|---|
1 2 3 |
|
-
Set the
dbt_job_last_run
for aDbt
. -
Retrieve the
dbt_job_last_run
from aDbt
.For more details
For more information, see the asset CRUD snippets on retrieving assets.
-
Find all assets in Atlan with their
dbt_job_last_run
greater than the provided value.For more details
For more information, see the searching section on range queries.
dbt_job_name
TBC | |
---|---|
1 2 3 4 |
|
-
Set the
dbt_job_name
for aDbt
. -
Retrieve the
dbt_job_name
from aDbt
.For more details
For more information, see the asset CRUD snippets on retrieving assets.
-
Find all assets in Atlan with their
dbt_job_name
exactly matching the provided value.For more details
For more information, see the searching section on term queries.
-
Find all assets in Atlan with their
dbt_job_name
textually matching the provided value.For more details
For more information, see the searching section on full text queries.
dbt_job_next_run
TBC | |
---|---|
1 2 3 |
|
-
Set the
dbt_job_next_run
for aDbt
. -
Retrieve the
dbt_job_next_run
from aDbt
.For more details
For more information, see the asset CRUD snippets on retrieving assets.
-
Find all assets in Atlan with their
dbt_job_next_run
greater than the provided value.For more details
For more information, see the searching section on range queries.
dbt_job_next_run_humanized
TBC | |
---|---|
1 2 3 4 |
|
-
Set the
dbt_job_next_run_humanized
for aDbt
. -
Retrieve the
dbt_job_next_run_humanized
from aDbt
.For more details
For more information, see the asset CRUD snippets on retrieving assets.
-
Find all assets in Atlan with their
dbt_job_next_run_humanized
exactly matching the provided value.For more details
For more information, see the searching section on term queries.
-
Find all assets in Atlan with their
dbt_job_next_run_humanized
textually matching the provided value.For more details
For more information, see the searching section on full text queries.
dbt_job_schedule
TBC | |
---|---|
1 2 3 |
|
-
Set the
dbt_job_schedule
for aDbt
. -
Retrieve the
dbt_job_schedule
from aDbt
.For more details
For more information, see the asset CRUD snippets on retrieving assets.
-
Find all assets in Atlan with their
dbt_job_schedule
exactly matching the provided value.For more details
For more information, see the searching section on term queries.
dbt_job_schedule_cron_humanized
TBC | |
---|---|
1 2 3 4 |
|
-
Set the
dbt_job_schedule_cron_humanized
for aDbt
. -
Retrieve the
dbt_job_schedule_cron_humanized
from aDbt
.For more details
For more information, see the asset CRUD snippets on retrieving assets.
-
Find all assets in Atlan with their
dbt_job_schedule_cron_humanized
exactly matching the provided value.For more details
For more information, see the searching section on term queries.
-
Find all assets in Atlan with their
dbt_job_schedule_cron_humanized
textually matching the provided value.For more details
For more information, see the searching section on full text queries.
dbt_job_status
TBC | |
---|---|
1 2 3 |
|
-
Set the
dbt_job_status
for aDbt
. -
Retrieve the
dbt_job_status
from aDbt
.For more details
For more information, see the asset CRUD snippets on retrieving assets.
-
Find all assets in Atlan with their
dbt_job_status
exactly matching the provided value.For more details
For more information, see the searching section on term queries.
dbt_meta
TBC | |
---|---|
1 2 3 |
|
-
Set the
dbt_meta
for aDbt
. -
Retrieve the
dbt_meta
from aDbt
.For more details
For more information, see the asset CRUD snippets on retrieving assets.
-
Find all assets in Atlan with their
dbt_meta
exactly matching the provided value.For more details
For more information, see the searching section on term queries.
dbt_package_name
TBC | |
---|---|
1 2 3 4 |
|
-
Set the
dbt_package_name
for aDbt
. -
Retrieve the
dbt_package_name
from aDbt
.For more details
For more information, see the asset CRUD snippets on retrieving assets.
-
Find all assets in Atlan with their
dbt_package_name
exactly matching the provided value.For more details
For more information, see the searching section on term queries.
-
Find all assets in Atlan with their
dbt_package_name
textually matching the provided value.For more details
For more information, see the searching section on full text queries.
dbt_project_name
TBC | |
---|---|
1 2 3 4 |
|
-
Set the
dbt_project_name
for aDbt
. -
Retrieve the
dbt_project_name
from aDbt
.For more details
For more information, see the asset CRUD snippets on retrieving assets.
-
Find all assets in Atlan with their
dbt_project_name
exactly matching the provided value.For more details
For more information, see the searching section on term queries.
-
Find all assets in Atlan with their
dbt_project_name
textually matching the provided value.For more details
For more information, see the searching section on full text queries.
dbt_semantic_layer_proxy_url
TBC | |
---|---|
1 2 3 |
|
-
Set the
dbt_semantic_layer_proxy_url
for aDbt
. -
Retrieve the
dbt_semantic_layer_proxy_url
from aDbt
.For more details
For more information, see the asset CRUD snippets on retrieving assets.
-
Find all assets in Atlan with their
dbt_semantic_layer_proxy_url
exactly matching the provided value.For more details
For more information, see the searching section on term queries.
dbt_tags
TBC | |
---|---|
1 2 3 |
|
-
Set the
dbt_tags
for aDbt
. -
Retrieve the
dbt_tags
from aDbt
.For more details
For more information, see the asset CRUD snippets on retrieving assets.
-
Find all assets in Atlan with their
dbt_tags
exactly matching the provided value.For more details
For more information, see the searching section on term queries.
dbt_unique_id
TBC | |
---|---|
1 2 3 4 |
|
-
Set the
dbt_unique_id
for aDbt
. -
Retrieve the
dbt_unique_id
from aDbt
.For more details
For more information, see the asset CRUD snippets on retrieving assets.
-
Find all assets in Atlan with their
dbt_unique_id
exactly matching the provided value.For more details
For more information, see the searching section on term queries.
-
Find all assets in Atlan with their
dbt_unique_id
textually matching the provided value.For more details
For more information, see the searching section on full text queries.
dbtAccountName
TBC | |
---|---|
1 2 3 4 5 |
|
-
Set the
dbtAccountName
for aDbt
.For more details
For more information, see the asset CRUD snippets.
dbtAlias
TBC | |
---|---|
1 2 3 4 5 |
|
-
Set the
dbtAlias
for aDbt
.For more details
For more information, see the asset CRUD snippets.
dbtConnectionContext
TBC | |
---|---|
1 2 3 4 5 |
|
-
Set the
dbtConnectionContext
for aDbt
.For more details
For more information, see the asset CRUD snippets.
dbtEnvironmentDbtVersion
TBC | |
---|---|
1 2 3 4 5 |
|
-
Set the
dbtEnvironmentDbtVersion
for aDbt
.For more details
For more information, see the asset CRUD snippets.
dbtEnvironmentName
TBC | |
---|---|
1 2 3 4 5 |
|
-
Set the
dbtEnvironmentName
for aDbt
.For more details
For more information, see the asset CRUD snippets.
dbtJobLastRun
TBC | |
---|---|
1 2 3 4 5 |
|
-
Set the
dbtJobLastRun
for aDbt
.For more details
For more information, see the asset CRUD snippets.
dbtJobName
TBC | |
---|---|
1 2 3 4 5 |
|
-
Set the
dbtJobName
for aDbt
.For more details
For more information, see the asset CRUD snippets.
dbtJobNextRun
TBC | |
---|---|
1 2 3 4 5 |
|
-
Set the
dbtJobNextRun
for aDbt
.For more details
For more information, see the asset CRUD snippets.
dbtJobNextRunHumanized
TBC | |
---|---|
1 2 3 4 5 |
|
-
Set the
dbtJobNextRunHumanized
for aDbt
.For more details
For more information, see the asset CRUD snippets.
dbtJobSchedule
TBC | |
---|---|
1 2 3 4 5 |
|
-
Set the
dbtJobSchedule
for aDbt
.For more details
For more information, see the asset CRUD snippets.
dbtJobScheduleCronHumanized
TBC | |
---|---|
1 2 3 4 5 |
|
-
Set the
dbtJobScheduleCronHumanized
for aDbt
.For more details
For more information, see the asset CRUD snippets.
dbtJobStatus
TBC | |
---|---|
1 2 3 4 5 |
|
-
Set the
dbtJobStatus
for aDbt
.For more details
For more information, see the asset CRUD snippets.
dbtMeta
TBC | |
---|---|
1 2 3 4 5 |
|
-
Set the
dbtMeta
for aDbt
.For more details
For more information, see the asset CRUD snippets.
dbtPackageName
TBC | |
---|---|
1 2 3 4 5 |
|
-
Set the
dbtPackageName
for aDbt
.For more details
For more information, see the asset CRUD snippets.
dbtProjectName
TBC | |
---|---|
1 2 3 4 5 |
|
-
Set the
dbtProjectName
for aDbt
.For more details
For more information, see the asset CRUD snippets.
dbtSemanticLayerProxyUrl
TBC | |
---|---|
1 2 3 4 5 |
|
-
Set the
dbtSemanticLayerProxyUrl
for aDbt
.For more details
For more information, see the asset CRUD snippets.
dbtTags
TBC | |
---|---|
1 2 3 4 5 6 7 8 |
|
-
Set the
dbtTags
for aDbt
.For more details
For more information, see the asset CRUD snippets.
dbtUniqueId
TBC | |
---|---|
1 2 3 4 5 |
|
-
Set the
dbtUniqueId
for aDbt
.For more details
For more information, see the asset CRUD snippets.
Relationships¶
The following illustrates how the various dbt objects inter-relate with each other:
erDiagram
Connection ||..o{ DbtProcess : ""
Connection ||..o{ DbtSource : ""
Connection ||..o{ DbtModel : ""
DbtModel |o--o{ DbtMetric : dbtMetrics
DbtModel |o--o{ DbtModelColumn : dbtModelColumns
DbtModel }o--o{ Asset : dbtModelSqlAssets
DbtModel |o--o| Asset : sqlAsset
DbtMetric }o--o{ Column : dbtMetricFilterColumns
DbtModelColumn }o--o{ Column : dbtModelColumnSqlColumns
DbtModelColumn }o--o| Column : sqlColumn
DbtSource }o--o{ Asset : sqlAssets
DbtSource }o--o| Asset : sqlAsset
DbtProcess }o--|{ Asset : inputs
DbtProcess }o--|{ Asset : outputs
DbtProcess ||--o{ DbtColumnProcess : columnProcesses
DbtColumnProcess }o--|{ Asset : inputs
DbtColumnProcess }o--|{ Asset : outputs
Asset }o--o{ DbtTest : dbtTests
DbtModelColumn }o--o{ DbtTest : dbtTests
DbtModel }o--o{ DbtTest : dbtTests
DbtSource }o--o{ DbtTest : dbtTests