Skip to main content

Partitioned Write Strategy with Schema Change

Container for specifying the partitioned write strategy that supports different behaviors when schema changes.

PartitionedWriteStrategyWithSchemaChange

info

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

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

PropertyDefaultTypeRequiredDescription
partitionedYesOptions to use when writing partitioned data to a Write Component.
on_schema_changestring ("ignore", "fail", "append_new_columns", "sync_all_columns")
NoPolicy to apply when schema changes are detected. Defaults to 'fail' if not provided.

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
  FivetranComponent
YesComponent configuration options.

WriteComponent

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.
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.
writeOne of:
  BigQueryWriteComponent
  SnowflakeWriteComponent
  S3WriteComponent
  SFTPWriteComponent
  GcsWriteComponent
  AbfsWriteComponent
  MySQLWriteComponent
  OracleWriteComponent
  PostgresWriteComponent
Yes

BigQueryWriteComponent

Component that writes data to a BigQuery table.

PropertyDefaultTypeRequiredDescription
dependenciesarray[None]
NoList of dependencies that must complete before this Component runs.
connectionstringYesName of the Connection to use for writing data.
inputYesInput component name.
normalizeboolean
NoBoolean flag indicating if the output column names should be normalized to a standard naming convention when writing.
preserve_caseboolean
NoBoolean flag indicating if the case of the column names should be preserved when writing.
uppercaseboolean
NoBoolean flag indicating if the column names should be transformed to uppercase when writing.
strategyfull:
  mode: drop_and_recreate
Any of:
  snapshot
  FullWriteStrategy
  IncrementalWriteStrategyWithSchemaChange
  PartitionedWriteStrategyWithSchemaChange
NoResource for write strategy.
pre_sqlAny of:
  string
  array[string]
NoSQL statements to execute before the main write operation. Can be a single SQL statement string or multiple statements as a list of strings.
post_sqlAny of:
  string
  array[string]
NoSQL statements to execute after the main write operation. Can be a single SQL statement string or multiple statements as a list of strings.
bigqueryYes

MySQLWriteComponent

Component that writes data to a MySQL table

PropertyDefaultTypeRequiredDescription
dependenciesarray[None]
NoList of dependencies that must complete before this Component runs.
connectionstringYesName of the Connection to use for writing data.
inputYesInput component name.
normalizeboolean
NoBoolean flag indicating if the output column names should be normalized to a standard naming convention when writing.
preserve_caseboolean
NoBoolean flag indicating if the case of the column names should be preserved when writing.
uppercaseboolean
NoBoolean flag indicating if the column names should be transformed to uppercase when writing.
strategyfull:
  mode: drop_and_recreate
Any of:
  snapshot
  FullWriteStrategy
  IncrementalWriteStrategyWithSchemaChange
  PartitionedWriteStrategyWithSchemaChange
NoResource for write strategy.
pre_sqlAny of:
  string
  array[string]
NoSQL statements to execute before the main write operation. Can be a single SQL statement string or multiple statements as a list of strings.
post_sqlAny of:
  string
  array[string]
NoSQL statements to execute after the main write operation. Can be a single SQL statement string or multiple statements as a list of strings.
mysqlYes

OracleWriteComponent

Component that writes data to an Oracle table

PropertyDefaultTypeRequiredDescription
dependenciesarray[None]
NoList of dependencies that must complete before this Component runs.
connectionstringYesName of the Connection to use for writing data.
inputYesInput component name.
normalizeboolean
NoBoolean flag indicating if the output column names should be normalized to a standard naming convention when writing.
preserve_caseboolean
NoBoolean flag indicating if the case of the column names should be preserved when writing.
uppercaseboolean
NoBoolean flag indicating if the column names should be transformed to uppercase when writing.
strategyfull:
  mode: drop_and_recreate
Any of:
  snapshot
  FullWriteStrategy
  IncrementalWriteStrategyWithSchemaChange
  PartitionedWriteStrategyWithSchemaChange
NoResource for write strategy.
pre_sqlAny of:
  string
  array[string]
NoSQL statements to execute before the main write operation. Can be a single SQL statement string or multiple statements as a list of strings.
post_sqlAny of:
  string
  array[string]
NoSQL statements to execute after the main write operation. Can be a single SQL statement string or multiple statements as a list of strings.
oracleYes

PostgresWriteComponent

Component that writes data to a Postgres table

PropertyDefaultTypeRequiredDescription
dependenciesarray[None]
NoList of dependencies that must complete before this Component runs.
connectionstringYesName of the Connection to use for writing data.
inputYesInput component name.
normalizeboolean
NoBoolean flag indicating if the output column names should be normalized to a standard naming convention when writing.
preserve_caseboolean
NoBoolean flag indicating if the case of the column names should be preserved when writing.
uppercaseboolean
NoBoolean flag indicating if the column names should be transformed to uppercase when writing.
strategyfull:
  mode: drop_and_recreate
Any of:
  snapshot
  FullWriteStrategy
  IncrementalWriteStrategyWithSchemaChange
  PartitionedWriteStrategyWithSchemaChange
NoResource for write strategy.
pre_sqlAny of:
  string
  array[string]
NoSQL statements to execute before the main write operation. Can be a single SQL statement string or multiple statements as a list of strings.
post_sqlAny of:
  string
  array[string]
NoSQL statements to execute after the main write operation. Can be a single SQL statement string or multiple statements as a list of strings.
postgresYes

SnowflakeWriteComponent

Component that writes data to a Snowflake table.

PropertyDefaultTypeRequiredDescription
dependenciesarray[None]
NoList of dependencies that must complete before this Component runs.
connectionstringYesName of the Connection to use for writing data.
inputYesInput component name.
normalizeboolean
NoBoolean flag indicating if the output column names should be normalized to a standard naming convention when writing.
preserve_caseboolean
NoBoolean flag indicating if the case of the column names should be preserved when writing.
uppercaseboolean
NoBoolean flag indicating if the column names should be transformed to uppercase when writing.
strategyfull:
  mode: drop_and_recreate
Any of:
  snapshot
  FullWriteStrategy
  IncrementalWriteStrategyWithSchemaChange
  PartitionedWriteStrategyWithSchemaChange
NoResource for write strategy.
pre_sqlAny of:
  string
  array[string]
NoSQL statements to execute before the main write operation. Can be a single SQL statement string or multiple statements as a list of strings.
post_sqlAny of:
  string
  array[string]
NoSQL statements to execute after the main write operation. Can be a single SQL statement string or multiple statements as a list of strings.
snowflakeYes

PartitionedWriteStrategyOptions

Resource options for incremental writes, including mode selection and criteria for detecting deletions and unique records.

PropertyDefaultTypeRequiredDescription
modeYesSpecifies the mode to use when writing data in partitions: 'append' to append new or modified partitions, 'insert_overwrite' to insert new partitions and replace/overwrite modified partitions, and 'sync' to encompass both 'insert_overwrite' functionality and to delete partitions when deleted at the source.
partition_colstring
NoColumn name used for partitioning. Uses the internal Ascend partition identifier by default.

PartitionedWriteModeEnum

No properties defined.