Skip to main content
Version: 3.0.0

Schema Test

Test to validate that component columns match expected types.

ComponentSchemaTest​

info

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

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

PropertyDefaultTypeRequiredDescription
severityerrorstring ("error", "warn")NoThe 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.
matchexactstring ("exact", "ignore_missing")NoThe type of schema matching to perform. 'exact' requires all columns to be present, 'ignore_missing' allows for missing columns.
columnsobject with property values of type string
NoA mapping of column names to their expected types.

Property Details​

Component​

A component is a fundamental building block of a data flow. Types of components that are supported include: read, transform, task, test, and more.

PropertyDefaultTypeRequiredDescription
componentOne of:
  CustomPythonReadComponent
  ApplicationComponent
  AliasedTableComponent
  ExternalTableComponent
YesConfiguration options for the component.

AliasedTableComponent​

A component that makes data in a pre-existing table available in the Ascend Flow.

PropertyDefaultTypeRequiredDescription
skipboolean
NoA boolean flag indicating whether to skip processing for the component or not.
retry_strategyNoThe retry strategy configuration options for the component if any exceptions are encountered.
descriptionstring
NoA brief 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
NoThe name of the flow that the component belongs to.
data_maintenanceNoThe data maintenance configuration options for the component.
testsNoDefines tests to run on the data of this component.
aliasYesConfiguration options for the aliased table component.

CustomPythonReadComponent​

A component that reads data using user-defined custom Python code.

PropertyDefaultTypeRequiredDescription
data_plane  One of:
    SnowflakeDataPlane
    BigQueryDataPlane
    DatabricksDataPlane
NoData Plane-specific configuration options for a component.
skipboolean
NoA boolean flag indicating whether to skip processing for the component or not.
retry_strategyNoThe retry strategy configuration options for the component if any exceptions are encountered.
descriptionstring
NoA brief 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
NoThe name of the flow that the component belongs to.
data_maintenanceNoThe data maintenance configuration options for the component.
testsNoDefines tests to run on the data of this component.
custom_python_readYes

ExternalTableComponent​

A component that constructs and updates an External Table. Currently supported for Snowflake only.

PropertyDefaultTypeRequiredDescription
skipboolean
NoA boolean flag indicating whether to skip processing for the component or not.
retry_strategyNoThe retry strategy configuration options for the component if any exceptions are encountered.
descriptionstring
NoA brief 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
NoThe name of the flow that the component belongs to.
data_maintenanceNoThe data maintenance configuration options for the component.
testsNoDefines tests to run on the data of this component.
external_tableAny of:
YesConfiguration options for the External Table component.

ReadComponent​

A component that reads data from a data system.

PropertyDefaultTypeRequiredDescription
data_plane  One of:
    SnowflakeDataPlane
    BigQueryDataPlane
    DatabricksDataPlane
NoData Plane-specific configuration options for a component.
skipboolean
NoA boolean flag indicating whether to skip processing for the component or not.
retry_strategyNoThe retry strategy configuration options for the component if any exceptions are encountered.
descriptionstring
NoA brief 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
NoThe name of the flow that the component belongs to.
data_maintenanceNoThe data maintenance configuration options for the component.
testsNoDefines tests to run on the data of this component.
readOne of:
  GenericFileReadComponent
  LocalFileReadComponent
  SFTPReadComponent
  S3ReadComponent
  GcsReadComponent
  AbfsReadComponent
  HttpReadComponent
  MSSQLReadComponent
  MySQLReadComponent
  OracleReadComponent
  PostgresReadComponent
  SnowflakeReadComponent
  BigQueryReadComponent
  DatabricksReadComponent
YesThe read component that reads data from a data system.

TaskComponent​

PropertyDefaultTypeRequiredDescription
skipboolean
NoA boolean flag indicating whether to skip processing for the component or not.
retry_strategyNoThe retry strategy configuration options for the component if any exceptions are encountered.
descriptionstring
NoA brief 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
NoThe name of the flow that the component belongs to.
data_maintenanceNoThe data maintenance configuration options for the component.
testsNoDefines tests to run on the data of this component.
taskOne of:
  TaskSqlComponent
  TaskPythonComponent
Yes

TransformComponent​

A component that executes SQL or Python code to transform data.

PropertyDefaultTypeRequiredDescription
data_plane  One of:
    SnowflakeDataPlane
    BigQueryDataPlane
    DatabricksDataPlane
NoData Plane-specific configuration options for a component.
skipboolean
NoA boolean flag indicating whether to skip processing for the component or not.
retry_strategyNoThe retry strategy configuration options for the component if any exceptions are encountered.
descriptionstring
NoA brief 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
NoThe name of the flow that the component belongs to.
data_maintenanceNoThe data maintenance configuration options for the component.
testsNoDefines tests to run on the data of this component.
transformOne of:
  SqlTransform
  PythonTransform
  SnowparkTransform
  PySparkTransform
YesThe transform component that executes SQL or Python code to transform data.

ComponentTestOptions​

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

PropertyDefaultTypeRequiredDescription
columnsobject with property values of type array[One of: (Any of: (string, NotNullTest), Any of: (string, NotEmptyTest), Any of: (string, UniqueTest), CombinationUniqueTest, InRangeTest, DateInRangeTest, InSetTest, SubstringMatchTest, CountDistinctEqualTest, CountGreaterThanOrEqualTest, CountGreaterThanTest, CountLessThanOrEqualTest, CountLessThanTest, CountEqualTest, GreaterThanTest, LessThanTest, GreaterThanOrEqualTest, LessThanOrEqualTest, MeanInRangeTest, StddevInRangeTest, ColumnTestSql, ColumnTestPython)]
NoList of column-level data quality tests for a component.
componentarray[One of: (Any of: (string, NotNullTest), Any of: (string, NotEmptyTest), Any of: (string, UniqueTest), CombinationUniqueTest, InRangeTest, DateInRangeTest, InSetTest, SubstringMatchTest, CountDistinctEqualTest, CountGreaterThanOrEqualTest, CountGreaterThanTest, CountLessThanOrEqualTest, CountLessThanTest, CountEqualTest, GreaterThanTest, LessThanTest, GreaterThanOrEqualTest, LessThanOrEqualTest, MeanInRangeTest, StddevInRangeTest, ColumnTestSql, ColumnTestPython)]
NoList of component-level tests.
schemaNoList of schema checks for a component.