Skip to main content
Version: 3.0.0

Singular SQL Test

A singular test implemented in SQL that runs as a standalone component.

SingularTestSql

info

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

Below are the properties for the SingularTestSql. 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.
inputsarray[InputComponent]
NoList of input names to use in the test.
sqlstring
NoSQL query that tests data for conditions.

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:
  ReadComponent
  TransformComponent
  TaskComponent
  SingularTestComponent
  CustomPythonReadComponent
  WriteComponent
  CompoundComponent
  AliasedTableComponent
  ExternalTableComponent
YesConfiguration options for the component.

SingularTestComponent

A singular test (Python or SQL) that runs as a standalone component.

PropertyDefaultTypeRequiredDescription
namestring
NoThe name of the model
descriptionstring
NoA brief description of what the model does.
metadataResourceMetadata
NoMeta information of a resource. In most cases it doesn't affect the system behavior but may be helpful to analyze project resources.
flow_namestring
NoThe name of the flow that the component belongs to.
skipboolean
NoA boolean flag indicating whether to skip processing for the component or not.
data_maintenanceDataMaintenance
NoThe data maintenance configuration options for the component.
singular_testOne of:
  SingularTestSql
  SingularTestPython
YesSingular test to run.