dbt Node Component
A component representing a dbt node, generated by a dbt application.
DbtNodeComponent
DbtNodeComponent is defined beneath the following ancestor nodes in the YAML structure:
Below are the properties for the DbtNodeComponent. Each property links to the specific details section further down in this page.
| Property | Default | Type | Required | Description |
|---|---|---|---|---|
| skip | boolean | No | Boolean flag indicating whether to skip processing for the Component or not. | |
| retry_strategy | No | Retry strategy configuration options for the Component if any exceptions are encountered. | ||
| data_maintenance | No | The data maintenance configuration options for the Component. | ||
| description | string | No | Brief description of what the model does. | |
| metadata | No | Meta information of a resource. In most cases it doesn't affect the system behavior but may be helpful to analyze project resources. | ||
| name | string | Yes | The name of the model | |
| flow_name | string | No | Name of the Flow that the Component belongs to. | |
| dbt_node | One of: DbtSeedComponent DbtModelComponent | Yes | Configuration for the dbt Node Component. |
Property Details
Component
A Component is a fundamental building block of a data Flow. Supported Component types include: Read, Transform, Task, Test, and more.
| Property | Default | Type | Required | Description |
|---|---|---|---|---|
| component | One of: CustomPythonReadComponent ApplicationComponent AliasedTableComponent ExternalTableComponent DbtNodeComponent | Yes | Component configuration options. |
DbtModelComponent
| Property | Default | Type | Required | Description |
|---|---|---|---|---|
| node_id | string | Yes | Reference to the dbt Node's unique identifier. | |
| name | string | Yes | Name of the dbt Node. | |
| dependencies | array[None] | No | List of dependencies for the dbt Node. | |
| model | Yes |
DbtModelComponentOptions
Configuration for a dbt Model Component.
| Property | Default | Type | Required | Description |
|---|---|---|---|---|
| database | string | No | Name of the dbt Node's database. | |
| schema | string | Yes | Name of the dbt Node's schema. | |
| alias | string | No | A table name override for the dbt Node (defaults to Node's name). | |
| relation_name | string | Yes | The fully-qualified name of the object that was (or will be) created/updated within the database. |
DbtSeedComponent
| Property | Default | Type | Required | Description |
|---|---|---|---|---|
| node_id | string | Yes | Reference to the dbt Node's unique identifier. | |
| name | string | Yes | Name of the dbt Node. | |
| dependencies | array[None] | No | List of dependencies for the dbt Node. | |
| seed | Yes |
DbtSeedComponentOptions
Configuration for a dbt Seed Component.
| Property | Default | Type | Required | Description |
|---|---|---|---|---|
| database | string | No | Name of the dbt Node's database. | |
| schema | string | Yes | Name of the dbt Node's schema. | |
| alias | string | No | A table name override for the dbt Node (defaults to Node's name). | |
| relation_name | string | Yes | The fully-qualified name of the object that was (or will be) created/updated within the database. |
DataMaintenance
Data maintenance configuration options for Components.
| Property | Default | Type | Required | Description |
|---|---|---|---|---|
| enabled | boolean | No | Boolean flag indicating whether data maintenance is enabled for the Component. |
ResourceMetadata
Meta information of a resource. In most cases, it doesn't affect the system behavior but may be helpful to analyze Project resources.
| Property | Default | Type | Required | Description |
|---|---|---|---|---|
| source | No | The origin or source information for the resource. | ||
| source_event_uuid | string | No | Event UUID associated with creation of this resource. |
ResourceLocation
The origin or source information for the resource.
| Property | Default | Type | Required | Description |
|---|---|---|---|---|
| path | string | Yes | Path within repository files where the resource is defined. | |
| first_line_number | integer | No | First line number within path file where the resource is defined. |
RetryStrategy
Retry strategy configuration for Component operations. This configuration leverages the tenacity library to implement robust retry mechanisms. The configuration options directly map to tenacity's retry parameters. Details on the tenacity library can be found here: https://tenacity.readthedocs.io/en/latest/api.html#retry-main-api Current implementation includes: - stop_after_attempt: Maximum number of retry attempts - stop_after_delay: Give up on retries one attempt before you would exceed the delay. - retry_clauses: Pattern-specific retry rules with their own max_attempts. Will need to supply at least one of the parameters (stop_after_attempt, stop_after_delay, or retry_clauses). Additional retry parameters will be added as needed to support more complex use cases.
| Property | Default | Type | Required | Description |
|---|---|---|---|---|
| stop_after_attempt | integer | No | Number of retry attempts before giving up. If set to None, it will not stop after any number of attempts. | |
| stop_after_delay | integer | No | Maximum time (in seconds) to spend on retries before giving up. If set to None, it will not stop after any time delay. | |
| retry_clauses | array[None] | No | Pattern-specific retry rules evaluated in order. First matching pattern wins. Non-matching errors use global stop_after_attempt/stop_after_delay. |
RetryClause
A retry rule matching errors by regex pattern.
| Property | Default | Type | Required | Description |
|---|---|---|---|---|
| pattern | string | Yes | Regex pattern to match against exception message (case-insensitive). | |
| max_attempts | integer | Yes | Maximum retry attempts for errors matching this pattern. |
InputComponent
Specification for input Components defining how partitioning behaviors should be handled. This metadata is required when a Component serves as an input to other Components within a Flow. The reshape parameter controls how input data is partitioned and processed. It accepts either full for full reduction operations or map for partition-wise operations.
| Property | Default | Type | Required | Description |
|---|---|---|---|---|
| flow | string | Yes | Name of the parent Flow that the input Component belongs to. | |
| name | string | Yes | Name of the input Component. | |
| alias | string | No | Alias to use for the input Component. | |
| partition_spec | Any of: string ("full_reduction", "map") | No | Internal specification for how Component input data should be partitioned before processing. This field is populated based on the user-facing reshape parameter in ref() calls, which accepts full (for full reduction operations) or map (for partition-wise operations). Input partitioning is applied before the Component's logic is executed. | |
| where | string | No | Optional filter condition to apply to the input Component's data. | |
| partition_binding | Any of: string | No | Optional partition binding specification to apply to the Component on a per-output-partition basis against other inputs' partitions. |
PartitionBinding
| Property | Default | Type | Required | Description |
|---|---|---|---|---|
| logical_operator | logical_operator | string ("AND", "OR") | No | TLogical operator to use to combine the partition binding predicates provided |
| predicates | predicates | array[string] | No | List of partition binding predicates to apply to the input Component's data |
RepartitionSpec
Specification for repartitioning operations on input Component's data
| Property | Default | Type | Required | Description |
|---|---|---|---|---|
| repartition | No | Options for repartitioning the input Component's data. |
RepartitionOptions
Options for repartitioning the input Component's data.
| Property | Default | Type | Required | Description |
|---|---|---|---|---|
| partition_by | string | Yes | Column to partition by. | |
| granularity | string | Yes | Granularity to use for the partitioning. |