metadata.sdk.data_quality.workflow_config_builder
Builder for creating OpenMetadata workflow configurations for test suite execution.
Classes:
- WorkflowConfigBuilder – Builds OpenMetadataWorkflowConfig for test suite execution.
Attributes:
- T –
metadata.sdk.data_quality.workflow_config_builder.T
metadata.sdk.data_quality.workflow_config_builder.WorkflowConfigBuilder
Builds OpenMetadataWorkflowConfig for test suite execution.
This builder encapsulates the logic for creating a complete workflow configuration required to execute data quality tests against a table. It constructs the source, processor, sink, and workflow configurations based on the provided table entity, service connection, and test definitions.
Attributes:
- table (
Optional[Table]) – Table entity to run tests against - service_connection (
Optional[DatabaseConnection]) – Database service connection for the table - ometa_config (
Optional[DatabaseConnection]) – OpenMetadata server configuration - test_definitions (
List[TestCaseDefinition]) – List of test case definitions to execute
Functions:
- add_test_definition – Add test definition to workflow config
- add_test_definitions – Add test definitions to the workflow configuration.
- build – Build the complete OpenMetadata workflow configuration.
- with_enable_streamable_logs –
- with_force_test_update –
- with_log_level –
- with_raise_on_error –
- with_success_threshold –
- with_table –
Parameters:
- client (
OpenMetadata) – OpenMetadata client
metadata.sdk.data_quality.workflow_config_builder.WorkflowConfigBuilder.add_test_definition
Add test definition to workflow config Args: test_definition: Test case definition to add
Returns:
Self– Self
metadata.sdk.data_quality.workflow_config_builder.WorkflowConfigBuilder.add_test_definitions
Add test definitions to the workflow configuration.
Parameters:
- test_definitions (
List[TestCaseDefinition]) – List of test case definitions to add
Returns:
Self– Self for method chaining
metadata.sdk.data_quality.workflow_config_builder.WorkflowConfigBuilder.build
Build the complete OpenMetadata workflow configuration.
This method constructs all components of the workflow configuration:
- Source: TestSuite source with table FQN and service connection
- Processor: Test case runner with test definitions
- Sink: Metadata REST sink for persisting results
- WorkflowConfig: Logger and server settings
Returns:
OpenMetadataWorkflowConfig– Complete OpenMetadataWorkflowConfig ready for execution