Fivetran Component

Component that integrates with Fivetran to extract and sync data from various sources.

This Component connects to a Fivetran Landing Zone application and synchronizes objects (tables, schemas, etc.) from a Fivetran connection to the configured destination. It can function as either:

• A derived Component of a Fivetran Application Component (for multi-object connectors)
• A top-level Component (for single-object connectors)

FivetranComponent

info

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

• Component

Below are the properties for the FivetranComponent. 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.
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.
data_maintenance			No	The data maintenance configuration options for the Component.
tests			No	Defines tests to run on this Component's data.
fivetran			Yes	Configuration options for the Fivetran data synchronization 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   FivetranComponent	Yes	Component configuration options.

FivetranOptions

Property	Default	Type	Required	Description
dependencies		array[None]	No	List of dependencies that must complete before this Component runs.
landing_zone_id		string	Yes	Unique identifier of the Fivetran Landing Zone application that manages the data destination and synchronization configuration.
connection_id		string	Yes	Fivetran connection identifier that specifies the source data location for extraction.
parent_component_id		string	No	Identifier of the parent Fivetran component. - If None: This connector operates as a top-level component containing only one object. The 'object' field must also be None, or an error will be raised. - If specified: This component operates as a sub-component representing a single object within the Fivetran connector. This field is automatically generated by the compiler and should not be manually modified.
object		string	No	Fully qualified name of the object or table that Fivetran syncs to the destination. - If None: This Fivetran connector contains only a single object - If specified: Must be one of the objects in the Fivetran connector, or an error will be raised This field is automatically generated by the compiler and should not be manually modified. Example: mongo_schema.test_table

ComponentTestOptions

Options for component tests, including data quality tests and schema checks.

Property	Default	Type	Required	Description
columns		object with property values of type array[One of: (Any of: (not_null, NotNullTest), Any of: (not_empty, NotEmptyTest), Any of: (unique, UniqueTest), CombinationUniqueTest, InRangeTest, DateInRangeTest, InSetTest, SubstringMatchTest, CountDistinctEqualTest, CountGreaterThanOrEqualTest, CountGreaterThanTest, CountLessThanOrEqualTest, CountLessThanTest, CountEqualTest, GreaterThanTest, LessThanTest, GreaterThanOrEqualTest, LessThanOrEqualTest, MeanInRangeTest, StddevInRangeTest, ColumnTestSql, ColumnTestPython)]	No	List of column-level data quality tests for a Component.
component		array[One of: (Any of: (not_null, NotNullTest), Any of: (not_empty, NotEmptyTest), Any of: (unique, UniqueTest), CombinationUniqueTest, InRangeTest, DateInRangeTest, InSetTest, SubstringMatchTest, CountDistinctEqualTest, CountGreaterThanOrEqualTest, CountGreaterThanTest, CountLessThanOrEqualTest, CountLessThanTest, CountEqualTest, GreaterThanTest, LessThanTest, GreaterThanOrEqualTest, LessThanOrEqualTest, MeanInRangeTest, StddevInRangeTest, ColumnTestSql, ColumnTestPython)]	No	List of Component-level tests.
schema			No	List of schema checks for a Component.

ColumnTestPython

Test to validate data using a Python function for a single column.

Property	Default	Type	Required	Description
severity	error	string ("error", "warn")	No	The severity level for issues raised by the test. Default is 'error'. Use 'error' for critical issues that should interrupt flow processing. Use 'warn' for warnings/minor issues that should not interrupt flow processing.
name		string	Yes
python			Yes	Configuration options for the Python column test.

ColumnTestPythonOptions

Property	Default	Type	Required	Description
entrypoint		string	Yes	Entry point for the Python Transform function.
source		string	Yes	Source file for the Python Transform function.
params		object with property values of type None	No	Parameters for the Python test function.
is_asset_test		boolean	No

ColumnTestSql

Test to validate data using an SQL query for a single column.

Property	Default	Type	Required	Description
severity	error	string ("error", "warn")	No	The severity level for issues raised by the test. Default is 'error'. Use 'error' for critical issues that should interrupt flow processing. Use 'warn' for warnings/minor issues that should not interrupt flow processing.
name		string	Yes
sql		string	No	SQL query that tests data for conditions.

CombinationUniqueTest

Test to check if a value is unique.

Property	Default	Type	Required	Description
severity	error	string ("error", "warn")	No	The severity level for issues raised by the test. Default is 'error'. Use 'error' for critical issues that should interrupt flow processing. Use 'warn' for warnings/minor issues that should not interrupt flow processing.
combination_unique			Yes	Test to check if a value is unique.

CombinationUniqueTestOptions

Configuration options for the unique test.

Property	Default	Type	Required	Description
columns		array[string]	Yes	Combination of columns to check for uniqueness.

ComponentSchemaTest

Test to validate that component columns match expected types.

Property	Default	Type	Required	Description
severity	error	string ("error", "warn")	No	The severity level for issues raised by the test. Default is 'error'. Use 'error' for critical issues that should interrupt flow processing. Use 'warn' for warnings/minor issues that should not interrupt flow processing.
match	exact	string ("exact", "ignore_missing")	No	The type of schema matching to perform. 'exact' requires all columns to be present, 'ignore_missing' allows for missing columns.
columns		object with property values of type string	No	Mapping of column names to their expected types.

CountDistinctEqualTest

Test to check if the number of distinct values is equal to a certain number.

Property	Default	Type	Required	Description
severity	error	string ("error", "warn")	No	The severity level for issues raised by the test. Default is 'error'. Use 'error' for critical issues that should interrupt flow processing. Use 'warn' for warnings/minor issues that should not interrupt flow processing.
count_distinct_equal			Yes

CountDistinctEqualTestOptions

Configuration options for the count_distinct_equal test.

Property	Default	Type	Required	Description
count		integer	Yes	Number of distinct values to expect.
group_by_columns		array[string]	No	Columns to group by.

CountEqualTest

Test to check if the number of rows is equal to a certain number.

Property	Default	Type	Required	Description
severity	error	string ("error", "warn")	No	The severity level for issues raised by the test. Default is 'error'. Use 'error' for critical issues that should interrupt flow processing. Use 'warn' for warnings/minor issues that should not interrupt flow processing.
count_equal			Yes	Configuration options for the the count_equal test.

CountEqualTestOptions

Configuration options for the count_equal test.

Property	Default	Type	Required	Description
count		integer	Yes	Number of rows to expect.

CountGreaterThanOrEqualTest

Test to check if the number of rows is greater than or equal to a certain number.

Property	Default	Type	Required	Description
severity	error	string ("error", "warn")	No	The severity level for issues raised by the test. Default is 'error'. Use 'error' for critical issues that should interrupt flow processing. Use 'warn' for warnings/minor issues that should not interrupt flow processing.
count_greater_than_or_equal			Yes

CountGreaterThanOrEqualTestOptions

Configuration options for the count_greater_than_or_equal test.

Property	Default	Type	Required	Description
count		integer	Yes	Value to compare against.
group_by_columns		array[string]	No	Columns to group by.

CountGreaterThanTest

Test to check if the number of rows is greater than a certain number.

Property	Default	Type	Required	Description
severity	error	string ("error", "warn")	No	The severity level for issues raised by the test. Default is 'error'. Use 'error' for critical issues that should interrupt flow processing. Use 'warn' for warnings/minor issues that should not interrupt flow processing.
count_greater_than			Yes

CountGreaterThanTestOptions

Configuration options for the count_greater_than test.

Property	Default	Type	Required	Description
count		integer	Yes	Value to compare against.
group_by_columns		array[string]	No	Columns to group by.

CountLessThanOrEqualTest

Test to check if the number of rows is greater than or equal to a certain number.

Property	Default	Type	Required	Description
severity	error	string ("error", "warn")	No	The severity level for issues raised by the test. Default is 'error'. Use 'error' for critical issues that should interrupt flow processing. Use 'warn' for warnings/minor issues that should not interrupt flow processing.
count_less_than_or_equal			Yes

CountLessThanOrEqualTestOptions

Configuration options for the count_less_than_or_equal test.

Property	Default	Type	Required	Description
count		integer	Yes	Value to compare against.
group_by_columns		array[string]	No	Columns to group by.

CountLessThanTest

Test to check if the number of rows is less than a certain number.

Property	Default	Type	Required	Description
severity	error	string ("error", "warn")	No	The severity level for issues raised by the test. Default is 'error'. Use 'error' for critical issues that should interrupt flow processing. Use 'warn' for warnings/minor issues that should not interrupt flow processing.
count_less_than			Yes

CountLessThanTestOptions

Configuration options for the count_less_than test.

Property	Default	Type	Required	Description
count		integer	Yes	Value to compare against.
group_by_columns		array[string]	No	Columns to group by.

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.

DateInRangeTest

Test to check if a date is within a certain range.

Property	Default	Type	Required	Description
severity	error	string ("error", "warn")	No	The severity level for issues raised by the test. Default is 'error'. Use 'error' for critical issues that should interrupt flow processing. Use 'warn' for warnings/minor issues that should not interrupt flow processing.
date_in_range			Yes

DateInRangeTestOptions

Configuration options for the date_in_range test.

Property	Default	Type	Required	Description
min		string	Yes	Minimum value to expect.
max		string	Yes	Maximum value to expect.

GreaterThanOrEqualTest

Test to check if a value is greater than or equal to a certain number.

Property	Default	Type	Required	Description
severity	error	string ("error", "warn")	No	The severity level for issues raised by the test. Default is 'error'. Use 'error' for critical issues that should interrupt flow processing. Use 'warn' for warnings/minor issues that should not interrupt flow processing.
greater_than_or_equal			Yes

GreaterThanOrEqualTestOptions

Configuration options for the greater_than_or_equal test.

Property	Default	Type	Required	Description
value		Any of:   integer   number   string	Yes	Value to compare against.

GreaterThanTest

Test to check if a value is greater than a certain number.

Property	Default	Type	Required	Description
severity	error	string ("error", "warn")	No	The severity level for issues raised by the test. Default is 'error'. Use 'error' for critical issues that should interrupt flow processing. Use 'warn' for warnings/minor issues that should not interrupt flow processing.
greater_than			Yes

GreaterThanTestOptions

Configuration options for the greater_than test.

Property	Default	Type	Required	Description
value		Any of:   integer   number   string	Yes	Value to compare against.

InRangeTest

Test to check if a value is within a certain range.

Property	Default	Type	Required	Description
severity	error	string ("error", "warn")	No	The severity level for issues raised by the test. Default is 'error'. Use 'error' for critical issues that should interrupt flow processing. Use 'warn' for warnings/minor issues that should not interrupt flow processing.
in_range			Yes

InRangeTestOptions

Configuration options for the in_range test.

Property	Default	Type	Required	Description
min		Any of:   integer   number   string	Yes	Minimum value to expect.
max		Any of:   integer   number   string	Yes	Maximum value to expect.

InSetTest

Test to check if a value is in a set of values.

Property	Default	Type	Required	Description
severity	error	string ("error", "warn")	No	The severity level for issues raised by the test. Default is 'error'. Use 'error' for critical issues that should interrupt flow processing. Use 'warn' for warnings/minor issues that should not interrupt flow processing.
in_set			Yes

InSetTestOptions

Configuration options for the in_set test.

Property	Default	Type	Required	Description
values		array[Any of: (integer, number, string)]	Yes	Set of values to expect.

LessThanOrEqualTest

Test to check if a value is less than or equal to a certain number.

Property	Default	Type	Required	Description
severity	error	string ("error", "warn")	No	The severity level for issues raised by the test. Default is 'error'. Use 'error' for critical issues that should interrupt flow processing. Use 'warn' for warnings/minor issues that should not interrupt flow processing.
less_than_or_equal			Yes

LessThanOrEqualTestOptions

Configuration options for the less_than_or_equal test.

Property	Default	Type	Required	Description
value		Any of:   integer   number   string	Yes	Value to compare against.

LessThanTest

Test to check if a value is less than a certain number.

Property	Default	Type	Required	Description
severity	error	string ("error", "warn")	No	The severity level for issues raised by the test. Default is 'error'. Use 'error' for critical issues that should interrupt flow processing. Use 'warn' for warnings/minor issues that should not interrupt flow processing.
less_than			Yes

LessThanTestOptions

Configuration options for the less_than test.

Property	Default	Type	Required	Description
value		Any of:   integer   number   string	Yes	Value to compare against.

MeanInRangeTest

Test to check if a value is within a certain mean range.

Property	Default	Type	Required	Description
severity	error	string ("error", "warn")	No	The severity level for issues raised by the test. Default is 'error'. Use 'error' for critical issues that should interrupt flow processing. Use 'warn' for warnings/minor issues that should not interrupt flow processing.
mean_in_range			Yes

MeanInRangeTestOptions

Configuration options for the mean_in_range test.

Property	Default	Type	Required	Description
min		Any of:   integer   number   string	Yes	Minimum value to expect.
max		Any of:   integer   number   string	Yes	Maximum value to expect.

NotEmptyTest

Test to check if a value is not empty.

Property	Default	Type	Required	Description
severity	error	string ("error", "warn")	No	The severity level for issues raised by the test. Default is 'error'. Use 'error' for critical issues that should interrupt flow processing. Use 'warn' for warnings/minor issues that should not interrupt flow processing.
not_empty			No	Test to check if a value is not empty.

NotNullTest

Test to check if a value is not null.

Property	Default	Type	Required	Description
severity	error	string ("error", "warn")	No	The severity level for issues raised by the test. Default is 'error'. Use 'error' for critical issues that should interrupt flow processing. Use 'warn' for warnings/minor issues that should not interrupt flow processing.
not_null			No	Test to check if a value is not null.

StddevInRangeTest

Test to check if a value is within a certain standard deviation range.

Property	Default	Type	Required	Description
severity	error	string ("error", "warn")	No	The severity level for issues raised by the test. Default is 'error'. Use 'error' for critical issues that should interrupt flow processing. Use 'warn' for warnings/minor issues that should not interrupt flow processing.
stddev_in_range			Yes

StddevInRangeTestOptions

Configuration options for the stddev_in_range test.

Property	Default	Type	Required	Description
min		Any of:   integer   number   string	Yes	Minimum value to expect.
max		Any of:   integer   number   string	Yes	Maximum value to expect.

SubstringMatchTest

Test to check if a value contains a substring.

Property	Default	Type	Required	Description
severity	error	string ("error", "warn")	No	The severity level for issues raised by the test. Default is 'error'. Use 'error' for critical issues that should interrupt flow processing. Use 'warn' for warnings/minor issues that should not interrupt flow processing.
substring_match			Yes

SubstringMatchTestOptions

Configuration options for the substring_match test.

Property	Default	Type	Required	Description
substring		string	Yes	Substring to search for.

UniqueTest

Test to check if a value is unique.

Property	Default	Type	Required	Description
severity	error	string ("error", "warn")	No	The severity level for issues raised by the test. Default is 'error'. Use 'error' for critical issues that should interrupt flow processing. Use 'warn' for warnings/minor issues that should not interrupt flow processing.
unique			No	Test to check if a value is unique.

NoTestOptions

Configuration options for tests that have no test body definition (not_null, unique, etc.).

No properties defined.

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. Will need to supply at least one of the two parameters. 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.

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.

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	Type of partitioning to apply to the Component's input data before processing the Component's logic. 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.