Skip to main content

dbt Model Component

DbtModelComponent

info

DbtModelComponent is defined beneath the following ancestor nodes in the YAML structure:

Below are the properties for the DbtModelComponent. Each property links to the specific details section further down in this page.

PropertyDefaultTypeRequiredDescription
node_idstringYesReference to the dbt Node's unique identifier.
namestringYesName of the dbt Node.
dependenciesarray[None]
NoList of dependencies for the dbt Node.
modelYes

Property Details

Component

A Component is a fundamental building block of a data Flow. Supported Component types include: Read, Transform, Task, Test, and more.

PropertyDefaultTypeRequiredDescription
componentOne of:
  CustomPythonReadComponent
  ApplicationComponent
  AliasedTableComponent
  ExternalTableComponent
  DbtNodeComponent
YesComponent configuration options.

DbtNodeComponent

A component representing a dbt node, generated by a dbt application.

PropertyDefaultTypeRequiredDescription
skipboolean
NoBoolean flag indicating whether to skip processing for the Component or not.
retry_strategyNoRetry strategy configuration options for the Component if any exceptions are encountered.
data_maintenanceNoThe data maintenance configuration options for the Component.
descriptionstring
NoBrief description of what the model does.
metadataNoMeta information of a resource. In most cases it doesn't affect the system behavior but may be helpful to analyze project resources.
namestringYesThe name of the model
flow_namestring
NoName of the Flow that the Component belongs to.
dbt_nodeOne of:
  DbtSeedComponent
  DbtModelComponent
YesConfiguration for the dbt Node Component.

DbtModelComponentOptions

Configuration for a dbt Model Component.

PropertyDefaultTypeRequiredDescription
databasestring
NoName of the dbt Node's database.
schemastringYesName of the dbt Node's schema.
aliasstring
NoA table name override for the dbt Node (defaults to Node's name).
relation_namestringYesThe fully-qualified name of the object that was (or will be) created/updated within the database.

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.

PropertyDefaultTypeRequiredDescription
flowstringYesName of the parent Flow that the input Component belongs to.
namestringYesName of the input Component.
aliasstring
NoAlias to use for the input Component.
partition_specAny of:
  string ("full_reduction", "map")
NoInternal 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.
wherestring
NoOptional filter condition to apply to the input Component's data.
partition_bindingAny of:
  string
NoOptional partition binding specification to apply to the Component on a per-output-partition basis against other inputs' partitions.

PartitionBinding

PropertyDefaultTypeRequiredDescription
logical_operatorlogical_operatorstring ("AND", "OR")NoTLogical operator to use to combine the partition binding predicates provided
predicatespredicatesarray[string]NoList of partition binding predicates to apply to the input Component's data

RepartitionSpec

Specification for repartitioning operations on input Component's data

PropertyDefaultTypeRequiredDescription
repartitionNoOptions for repartitioning the input Component's data.

RepartitionOptions

Options for repartitioning the input Component's data.

PropertyDefaultTypeRequiredDescription
partition_bystringYesColumn to partition by.
granularitystringYesGranularity to use for the partitioning.