We use cookies to improve site navigation, analyze site usage, and enhance your user experience. Click "Accept" to enable cookies or "Reject" to reject cookies.

sdk

No menu items for this category
Home/Sdk/Python/Api Reference/Data Quality/Workflow As Code/Tests/Column Tests
OpenMetadata Documentation

metadata.sdk.data_quality.tests.column_tests

Column-level test definitions for DQ as Code API.

Classes:

metadata.sdk.data_quality.tests.column_tests.ColumnValueLengthsToBeBetween

Bases: ColumnTest

Validates that the length of string values in a column falls within a specified range.

This test checks character count for text columns, useful for validating string constraints, preventing truncation, and ensuring data format compliance.

Parameters:

  • column (str) – Name of the column to validate
  • min_length (Optional[int]) – Minimum acceptable string length
  • max_length (Optional[int]) – Maximum acceptable string length
  • name (Optional[str]) – Custom test case name
  • display_name (Optional[str]) – Custom display name for UI
  • description (Optional[str]) – Custom test description

Examples:

Functions:

Attributes:

metadata.sdk.data_quality.tests.column_tests.ColumnValueLengthsToBeBetween.column_name

metadata.sdk.data_quality.tests.column_tests.ColumnValueLengthsToBeBetween.compute_passed_failed_row_count

metadata.sdk.data_quality.tests.column_tests.ColumnValueLengthsToBeBetween.description

metadata.sdk.data_quality.tests.column_tests.ColumnValueLengthsToBeBetween.display_name

metadata.sdk.data_quality.tests.column_tests.ColumnValueLengthsToBeBetween.name

metadata.sdk.data_quality.tests.column_tests.ColumnValueLengthsToBeBetween.parameters

metadata.sdk.data_quality.tests.column_tests.ColumnValueLengthsToBeBetween.test_definition_name

metadata.sdk.data_quality.tests.column_tests.ColumnValueLengthsToBeBetween.to_test_case_definition

Create a test case definition from this test definition. Returns: TestCaseDefinition instance

metadata.sdk.data_quality.tests.column_tests.ColumnValueLengthsToBeBetween.with_compute_row_count

Enable or disable passed/failed row count computation.

When enabled, the test will compute and report the number and percentage of rows that passed or failed the test validation.

Parameters:

  • compute (bool) – Whether to compute row-level pass/fail statistics

Returns:

  • Self – Self for method chaining

metadata.sdk.data_quality.tests.column_tests.ColumnValueLengthsToBeBetween.with_description

Set a custom description.

Parameters:

  • description (str) – Detailed description of what this test validates

Returns:

  • Self – Self for method chaining

metadata.sdk.data_quality.tests.column_tests.ColumnValueLengthsToBeBetween.with_display_name

Set a custom display name.

Parameters:

  • display_name (str) – Human-readable name for UI display

Returns:

  • Self – Self for method chaining

metadata.sdk.data_quality.tests.column_tests.ColumnValueLengthsToBeBetween.with_name

Set a custom test case name.

Parameters:

  • name (str) – Unique identifier for this test case

Returns:

  • Self – Self for method chaining

metadata.sdk.data_quality.tests.column_tests.ColumnValueMaxToBeBetween

Bases: ColumnTest

Validates that the maximum value in a column falls within a specified range.

This test computes the maximum value across all rows and checks if it's within bounds. Useful for monitoring data ranges and detecting outliers in the upper range.

Parameters:

  • column (str) – Name of the column to validate
  • min_value (Optional[float]) – Minimum acceptable maximum value
  • max_value (Optional[float]) – Maximum acceptable maximum value
  • name (Optional[str]) – Custom test case name
  • display_name (Optional[str]) – Custom display name for UI
  • description (Optional[str]) – Custom test description

Examples:

Functions:

Attributes:

metadata.sdk.data_quality.tests.column_tests.ColumnValueMaxToBeBetween.column_name

metadata.sdk.data_quality.tests.column_tests.ColumnValueMaxToBeBetween.compute_passed_failed_row_count

metadata.sdk.data_quality.tests.column_tests.ColumnValueMaxToBeBetween.description

metadata.sdk.data_quality.tests.column_tests.ColumnValueMaxToBeBetween.display_name

metadata.sdk.data_quality.tests.column_tests.ColumnValueMaxToBeBetween.name

metadata.sdk.data_quality.tests.column_tests.ColumnValueMaxToBeBetween.parameters

metadata.sdk.data_quality.tests.column_tests.ColumnValueMaxToBeBetween.test_definition_name

metadata.sdk.data_quality.tests.column_tests.ColumnValueMaxToBeBetween.to_test_case_definition

Create a test case definition from this test definition. Returns: TestCaseDefinition instance

metadata.sdk.data_quality.tests.column_tests.ColumnValueMaxToBeBetween.with_compute_row_count

Enable or disable passed/failed row count computation.

When enabled, the test will compute and report the number and percentage of rows that passed or failed the test validation.

Parameters:

  • compute (bool) – Whether to compute row-level pass/fail statistics

Returns:

  • Self – Self for method chaining

metadata.sdk.data_quality.tests.column_tests.ColumnValueMaxToBeBetween.with_description

Set a custom description.

Parameters:

  • description (str) – Detailed description of what this test validates

Returns:

  • Self – Self for method chaining

metadata.sdk.data_quality.tests.column_tests.ColumnValueMaxToBeBetween.with_display_name

Set a custom display name.

Parameters:

  • display_name (str) – Human-readable name for UI display

Returns:

  • Self – Self for method chaining

metadata.sdk.data_quality.tests.column_tests.ColumnValueMaxToBeBetween.with_name

Set a custom test case name.

Parameters:

  • name (str) – Unique identifier for this test case

Returns:

  • Self – Self for method chaining

metadata.sdk.data_quality.tests.column_tests.ColumnValueMeanToBeBetween

Bases: ColumnTest

Validates that the mean (average) value in a column falls within a specified range.

This test computes the arithmetic mean of all values and checks if it's within bounds. Useful for statistical validation and detecting data drift in numeric columns.

Parameters:

  • column (str) – Name of the column to validate
  • min_value (Optional[float]) – Minimum acceptable mean value
  • max_value (Optional[float]) – Maximum acceptable mean value
  • name (Optional[str]) – Custom test case name
  • display_name (Optional[str]) – Custom display name for UI
  • description (Optional[str]) – Custom test description

Examples:

Functions:

Attributes:

metadata.sdk.data_quality.tests.column_tests.ColumnValueMeanToBeBetween.column_name

metadata.sdk.data_quality.tests.column_tests.ColumnValueMeanToBeBetween.compute_passed_failed_row_count

metadata.sdk.data_quality.tests.column_tests.ColumnValueMeanToBeBetween.description

metadata.sdk.data_quality.tests.column_tests.ColumnValueMeanToBeBetween.display_name

metadata.sdk.data_quality.tests.column_tests.ColumnValueMeanToBeBetween.name

metadata.sdk.data_quality.tests.column_tests.ColumnValueMeanToBeBetween.parameters

metadata.sdk.data_quality.tests.column_tests.ColumnValueMeanToBeBetween.test_definition_name

metadata.sdk.data_quality.tests.column_tests.ColumnValueMeanToBeBetween.to_test_case_definition

Create a test case definition from this test definition. Returns: TestCaseDefinition instance

metadata.sdk.data_quality.tests.column_tests.ColumnValueMeanToBeBetween.with_compute_row_count

Enable or disable passed/failed row count computation.

When enabled, the test will compute and report the number and percentage of rows that passed or failed the test validation.

Parameters:

  • compute (bool) – Whether to compute row-level pass/fail statistics

Returns:

  • Self – Self for method chaining

metadata.sdk.data_quality.tests.column_tests.ColumnValueMeanToBeBetween.with_description

Set a custom description.

Parameters:

  • description (str) – Detailed description of what this test validates

Returns:

  • Self – Self for method chaining

metadata.sdk.data_quality.tests.column_tests.ColumnValueMeanToBeBetween.with_display_name

Set a custom display name.

Parameters:

  • display_name (str) – Human-readable name for UI display

Returns:

  • Self – Self for method chaining

metadata.sdk.data_quality.tests.column_tests.ColumnValueMeanToBeBetween.with_name

Set a custom test case name.

Parameters:

  • name (str) – Unique identifier for this test case

Returns:

  • Self – Self for method chaining

metadata.sdk.data_quality.tests.column_tests.ColumnValueMedianToBeBetween

Bases: ColumnTest

Validates that the median value in a column falls within a specified range.

This test computes the median (middle value) and checks if it's within bounds. More robust than mean for skewed distributions, useful for detecting outliers.

Parameters:

  • column (str) – Name of the column to validate
  • min_value (Optional[float]) – Minimum acceptable median value
  • max_value (Optional[float]) – Maximum acceptable median value
  • name (Optional[str]) – Custom test case name
  • display_name (Optional[str]) – Custom display name for UI
  • description (Optional[str]) – Custom test description

Examples:

Functions:

Attributes:

metadata.sdk.data_quality.tests.column_tests.ColumnValueMedianToBeBetween.column_name

metadata.sdk.data_quality.tests.column_tests.ColumnValueMedianToBeBetween.compute_passed_failed_row_count

metadata.sdk.data_quality.tests.column_tests.ColumnValueMedianToBeBetween.description

metadata.sdk.data_quality.tests.column_tests.ColumnValueMedianToBeBetween.display_name

metadata.sdk.data_quality.tests.column_tests.ColumnValueMedianToBeBetween.name

metadata.sdk.data_quality.tests.column_tests.ColumnValueMedianToBeBetween.parameters

metadata.sdk.data_quality.tests.column_tests.ColumnValueMedianToBeBetween.test_definition_name

metadata.sdk.data_quality.tests.column_tests.ColumnValueMedianToBeBetween.to_test_case_definition

Create a test case definition from this test definition. Returns: TestCaseDefinition instance

metadata.sdk.data_quality.tests.column_tests.ColumnValueMedianToBeBetween.with_compute_row_count

Enable or disable passed/failed row count computation.

When enabled, the test will compute and report the number and percentage of rows that passed or failed the test validation.

Parameters:

  • compute (bool) – Whether to compute row-level pass/fail statistics

Returns:

  • Self – Self for method chaining

metadata.sdk.data_quality.tests.column_tests.ColumnValueMedianToBeBetween.with_description

Set a custom description.

Parameters:

  • description (str) – Detailed description of what this test validates

Returns:

  • Self – Self for method chaining

metadata.sdk.data_quality.tests.column_tests.ColumnValueMedianToBeBetween.with_display_name

Set a custom display name.

Parameters:

  • display_name (str) – Human-readable name for UI display

Returns:

  • Self – Self for method chaining

metadata.sdk.data_quality.tests.column_tests.ColumnValueMedianToBeBetween.with_name

Set a custom test case name.

Parameters:

  • name (str) – Unique identifier for this test case

Returns:

  • Self – Self for method chaining

metadata.sdk.data_quality.tests.column_tests.ColumnValueMinToBeBetween

Bases: ColumnTest

Validates that the minimum value in a column falls within a specified range.

This test computes the minimum value across all rows and checks if it's within bounds. Useful for monitoring data ranges and detecting outliers in the lower range.

Parameters:

  • column (str) – Name of the column to validate
  • min_value (Optional[float]) – Minimum acceptable minimum value
  • max_value (Optional[float]) – Maximum acceptable minimum value
  • name (Optional[str]) – Custom test case name
  • display_name (Optional[str]) – Custom display name for UI
  • description (Optional[str]) – Custom test description

Examples:

Functions:

Attributes:

metadata.sdk.data_quality.tests.column_tests.ColumnValueMinToBeBetween.column_name

metadata.sdk.data_quality.tests.column_tests.ColumnValueMinToBeBetween.compute_passed_failed_row_count

metadata.sdk.data_quality.tests.column_tests.ColumnValueMinToBeBetween.description

metadata.sdk.data_quality.tests.column_tests.ColumnValueMinToBeBetween.display_name

metadata.sdk.data_quality.tests.column_tests.ColumnValueMinToBeBetween.name

metadata.sdk.data_quality.tests.column_tests.ColumnValueMinToBeBetween.parameters

metadata.sdk.data_quality.tests.column_tests.ColumnValueMinToBeBetween.test_definition_name

metadata.sdk.data_quality.tests.column_tests.ColumnValueMinToBeBetween.to_test_case_definition

Create a test case definition from this test definition. Returns: TestCaseDefinition instance

metadata.sdk.data_quality.tests.column_tests.ColumnValueMinToBeBetween.with_compute_row_count

Enable or disable passed/failed row count computation.

When enabled, the test will compute and report the number and percentage of rows that passed or failed the test validation.

Parameters:

  • compute (bool) – Whether to compute row-level pass/fail statistics

Returns:

  • Self – Self for method chaining

metadata.sdk.data_quality.tests.column_tests.ColumnValueMinToBeBetween.with_description

Set a custom description.

Parameters:

  • description (str) – Detailed description of what this test validates

Returns:

  • Self – Self for method chaining

metadata.sdk.data_quality.tests.column_tests.ColumnValueMinToBeBetween.with_display_name

Set a custom display name.

Parameters:

  • display_name (str) – Human-readable name for UI display

Returns:

  • Self – Self for method chaining

metadata.sdk.data_quality.tests.column_tests.ColumnValueMinToBeBetween.with_name

Set a custom test case name.

Parameters:

  • name (str) – Unique identifier for this test case

Returns:

  • Self – Self for method chaining

metadata.sdk.data_quality.tests.column_tests.ColumnValueStdDevToBeBetween

Bases: ColumnTest

Validates that the standard deviation of column values falls within a specified range.

This test computes the standard deviation (measure of variance) and checks if it's within bounds. Useful for detecting unexpected data variability or consistency issues.

Parameters:

  • column (str) – Name of the column to validate
  • min_value (Optional[float]) – Minimum acceptable standard deviation
  • max_value (Optional[float]) – Maximum acceptable standard deviation
  • name (Optional[str]) – Custom test case name
  • display_name (Optional[str]) – Custom display name for UI
  • description (Optional[str]) – Custom test description

Examples:

Functions:

Attributes:

metadata.sdk.data_quality.tests.column_tests.ColumnValueStdDevToBeBetween.column_name

metadata.sdk.data_quality.tests.column_tests.ColumnValueStdDevToBeBetween.compute_passed_failed_row_count

metadata.sdk.data_quality.tests.column_tests.ColumnValueStdDevToBeBetween.description

metadata.sdk.data_quality.tests.column_tests.ColumnValueStdDevToBeBetween.display_name

metadata.sdk.data_quality.tests.column_tests.ColumnValueStdDevToBeBetween.name

metadata.sdk.data_quality.tests.column_tests.ColumnValueStdDevToBeBetween.parameters

metadata.sdk.data_quality.tests.column_tests.ColumnValueStdDevToBeBetween.test_definition_name

metadata.sdk.data_quality.tests.column_tests.ColumnValueStdDevToBeBetween.to_test_case_definition

Create a test case definition from this test definition. Returns: TestCaseDefinition instance

metadata.sdk.data_quality.tests.column_tests.ColumnValueStdDevToBeBetween.with_compute_row_count

Enable or disable passed/failed row count computation.

When enabled, the test will compute and report the number and percentage of rows that passed or failed the test validation.

Parameters:

  • compute (bool) – Whether to compute row-level pass/fail statistics

Returns:

  • Self – Self for method chaining

metadata.sdk.data_quality.tests.column_tests.ColumnValueStdDevToBeBetween.with_description

Set a custom description.

Parameters:

  • description (str) – Detailed description of what this test validates

Returns:

  • Self – Self for method chaining

metadata.sdk.data_quality.tests.column_tests.ColumnValueStdDevToBeBetween.with_display_name

Set a custom display name.

Parameters:

  • display_name (str) – Human-readable name for UI display

Returns:

  • Self – Self for method chaining

metadata.sdk.data_quality.tests.column_tests.ColumnValueStdDevToBeBetween.with_name

Set a custom test case name.

Parameters:

  • name (str) – Unique identifier for this test case

Returns:

  • Self – Self for method chaining

metadata.sdk.data_quality.tests.column_tests.ColumnValuesMissingCount

Bases: ColumnTest

Validates that the count of missing or null values meets expectations.

This test counts rows with missing values and validates against expected thresholds. Supports custom missing value patterns beyond NULL (e.g., "N/A", "", "NULL").

Parameters:

  • column (str) – Name of the column to validate
  • missing_count_value (Optional[int]) – Expected number of missing values
  • missing_value_match (Optional[str]) – List of strings to treat as missing values (optional)
  • name (Optional[str]) – Custom test case name
  • display_name (Optional[str]) – Custom display name for UI
  • description (Optional[str]) – Custom test description

Examples:

Functions:

Attributes:

metadata.sdk.data_quality.tests.column_tests.ColumnValuesMissingCount.column_name

metadata.sdk.data_quality.tests.column_tests.ColumnValuesMissingCount.compute_passed_failed_row_count

metadata.sdk.data_quality.tests.column_tests.ColumnValuesMissingCount.description

metadata.sdk.data_quality.tests.column_tests.ColumnValuesMissingCount.display_name

metadata.sdk.data_quality.tests.column_tests.ColumnValuesMissingCount.name

metadata.sdk.data_quality.tests.column_tests.ColumnValuesMissingCount.parameters

metadata.sdk.data_quality.tests.column_tests.ColumnValuesMissingCount.test_definition_name

metadata.sdk.data_quality.tests.column_tests.ColumnValuesMissingCount.to_test_case_definition

Create a test case definition from this test definition. Returns: TestCaseDefinition instance

metadata.sdk.data_quality.tests.column_tests.ColumnValuesMissingCount.with_compute_row_count

Enable or disable passed/failed row count computation.

When enabled, the test will compute and report the number and percentage of rows that passed or failed the test validation.

Parameters:

  • compute (bool) – Whether to compute row-level pass/fail statistics

Returns:

  • Self – Self for method chaining

metadata.sdk.data_quality.tests.column_tests.ColumnValuesMissingCount.with_description

Set a custom description.

Parameters:

  • description (str) – Detailed description of what this test validates

Returns:

  • Self – Self for method chaining

metadata.sdk.data_quality.tests.column_tests.ColumnValuesMissingCount.with_display_name

Set a custom display name.

Parameters:

  • display_name (str) – Human-readable name for UI display

Returns:

  • Self – Self for method chaining

metadata.sdk.data_quality.tests.column_tests.ColumnValuesMissingCount.with_name

Set a custom test case name.

Parameters:

  • name (str) – Unique identifier for this test case

Returns:

  • Self – Self for method chaining

metadata.sdk.data_quality.tests.column_tests.ColumnValuesSumToBeBetween

Bases: ColumnTest

Validates that the sum of all values in a column falls within a specified range.

This test computes the total sum across all rows and checks if it's within bounds. Useful for validating totals, aggregates, and detecting unexpected data volumes.

Parameters:

  • column (str) – Name of the column to validate
  • min_value (Optional[float]) – Minimum acceptable sum
  • max_value (Optional[float]) – Maximum acceptable sum
  • name (Optional[str]) – Custom test case name
  • display_name (Optional[str]) – Custom display name for UI
  • description (Optional[str]) – Custom test description

Examples:

Functions:

Attributes:

metadata.sdk.data_quality.tests.column_tests.ColumnValuesSumToBeBetween.column_name

metadata.sdk.data_quality.tests.column_tests.ColumnValuesSumToBeBetween.compute_passed_failed_row_count

metadata.sdk.data_quality.tests.column_tests.ColumnValuesSumToBeBetween.description

metadata.sdk.data_quality.tests.column_tests.ColumnValuesSumToBeBetween.display_name

metadata.sdk.data_quality.tests.column_tests.ColumnValuesSumToBeBetween.name

metadata.sdk.data_quality.tests.column_tests.ColumnValuesSumToBeBetween.parameters

metadata.sdk.data_quality.tests.column_tests.ColumnValuesSumToBeBetween.test_definition_name

metadata.sdk.data_quality.tests.column_tests.ColumnValuesSumToBeBetween.to_test_case_definition

Create a test case definition from this test definition. Returns: TestCaseDefinition instance

metadata.sdk.data_quality.tests.column_tests.ColumnValuesSumToBeBetween.with_compute_row_count

Enable or disable passed/failed row count computation.

When enabled, the test will compute and report the number and percentage of rows that passed or failed the test validation.

Parameters:

  • compute (bool) – Whether to compute row-level pass/fail statistics

Returns:

  • Self – Self for method chaining

metadata.sdk.data_quality.tests.column_tests.ColumnValuesSumToBeBetween.with_description

Set a custom description.

Parameters:

  • description (str) – Detailed description of what this test validates

Returns:

  • Self – Self for method chaining

metadata.sdk.data_quality.tests.column_tests.ColumnValuesSumToBeBetween.with_display_name

Set a custom display name.

Parameters:

  • display_name (str) – Human-readable name for UI display

Returns:

  • Self – Self for method chaining

metadata.sdk.data_quality.tests.column_tests.ColumnValuesSumToBeBetween.with_name

Set a custom test case name.

Parameters:

  • name (str) – Unique identifier for this test case

Returns:

  • Self – Self for method chaining

metadata.sdk.data_quality.tests.column_tests.ColumnValuesToBeAtExpectedLocation

Bases: ColumnTest

Validates that a specific value appears at an expected row position.

This test checks for an exact value at a particular row index, useful for validating sorted data, header rows, or expected entries at known positions.

Parameters:

  • column (str) – Name of the column to validate
  • expected_value (str) – The exact value expected at the specified location
  • row_index (int) – Zero-based row position to check (default: 0)
  • name (Optional[str]) – Custom test case name
  • display_name (Optional[str]) – Custom display name for UI
  • description (Optional[str]) – Custom test description

Examples:

Functions:

Attributes:

metadata.sdk.data_quality.tests.column_tests.ColumnValuesToBeAtExpectedLocation.column_name

metadata.sdk.data_quality.tests.column_tests.ColumnValuesToBeAtExpectedLocation.compute_passed_failed_row_count

metadata.sdk.data_quality.tests.column_tests.ColumnValuesToBeAtExpectedLocation.description

metadata.sdk.data_quality.tests.column_tests.ColumnValuesToBeAtExpectedLocation.display_name

metadata.sdk.data_quality.tests.column_tests.ColumnValuesToBeAtExpectedLocation.name

metadata.sdk.data_quality.tests.column_tests.ColumnValuesToBeAtExpectedLocation.parameters

metadata.sdk.data_quality.tests.column_tests.ColumnValuesToBeAtExpectedLocation.test_definition_name

metadata.sdk.data_quality.tests.column_tests.ColumnValuesToBeAtExpectedLocation.to_test_case_definition

Create a test case definition from this test definition. Returns: TestCaseDefinition instance

metadata.sdk.data_quality.tests.column_tests.ColumnValuesToBeAtExpectedLocation.with_compute_row_count

Enable or disable passed/failed row count computation.

When enabled, the test will compute and report the number and percentage of rows that passed or failed the test validation.

Parameters:

  • compute (bool) – Whether to compute row-level pass/fail statistics

Returns:

  • Self – Self for method chaining

metadata.sdk.data_quality.tests.column_tests.ColumnValuesToBeAtExpectedLocation.with_description

Set a custom description.

Parameters:

  • description (str) – Detailed description of what this test validates

Returns:

  • Self – Self for method chaining

metadata.sdk.data_quality.tests.column_tests.ColumnValuesToBeAtExpectedLocation.with_display_name

Set a custom display name.

Parameters:

  • display_name (str) – Human-readable name for UI display

Returns:

  • Self – Self for method chaining

metadata.sdk.data_quality.tests.column_tests.ColumnValuesToBeAtExpectedLocation.with_name

Set a custom test case name.

Parameters:

  • name (str) – Unique identifier for this test case

Returns:

  • Self – Self for method chaining

metadata.sdk.data_quality.tests.column_tests.ColumnValuesToBeBetween

Bases: ColumnTest

Validates that all values in a column fall within a specified numeric range.

This test checks that individual column values are between minimum and maximum bounds. Useful for validating numeric constraints, age ranges, prices, quantities, etc.

Parameters:

  • column (str) – Name of the column to validate
  • min_value (Optional[float]) – Minimum acceptable value (inclusive)
  • max_value (Optional[float]) – Maximum acceptable value (inclusive)
  • name (Optional[str]) – Custom test case name
  • display_name (Optional[str]) – Custom display name for UI
  • description (Optional[str]) – Custom test description

Examples:

Functions:

Attributes:

metadata.sdk.data_quality.tests.column_tests.ColumnValuesToBeBetween.column_name

metadata.sdk.data_quality.tests.column_tests.ColumnValuesToBeBetween.compute_passed_failed_row_count

metadata.sdk.data_quality.tests.column_tests.ColumnValuesToBeBetween.description

metadata.sdk.data_quality.tests.column_tests.ColumnValuesToBeBetween.display_name

metadata.sdk.data_quality.tests.column_tests.ColumnValuesToBeBetween.name

metadata.sdk.data_quality.tests.column_tests.ColumnValuesToBeBetween.parameters

metadata.sdk.data_quality.tests.column_tests.ColumnValuesToBeBetween.test_definition_name

metadata.sdk.data_quality.tests.column_tests.ColumnValuesToBeBetween.to_test_case_definition

Create a test case definition from this test definition. Returns: TestCaseDefinition instance

metadata.sdk.data_quality.tests.column_tests.ColumnValuesToBeBetween.with_compute_row_count

Enable or disable passed/failed row count computation.

When enabled, the test will compute and report the number and percentage of rows that passed or failed the test validation.

Parameters:

  • compute (bool) – Whether to compute row-level pass/fail statistics

Returns:

  • Self – Self for method chaining

metadata.sdk.data_quality.tests.column_tests.ColumnValuesToBeBetween.with_description

Set a custom description.

Parameters:

  • description (str) – Detailed description of what this test validates

Returns:

  • Self – Self for method chaining

metadata.sdk.data_quality.tests.column_tests.ColumnValuesToBeBetween.with_display_name

Set a custom display name.

Parameters:

  • display_name (str) – Human-readable name for UI display

Returns:

  • Self – Self for method chaining

metadata.sdk.data_quality.tests.column_tests.ColumnValuesToBeBetween.with_name

Set a custom test case name.

Parameters:

  • name (str) – Unique identifier for this test case

Returns:

  • Self – Self for method chaining

metadata.sdk.data_quality.tests.column_tests.ColumnValuesToBeInSet

Bases: ColumnTest

Validates that all values in a column belong to a specified set of allowed values.

This test ensures data integrity by checking that column values are constrained to a predefined list. Useful for enum-like columns or categorical data.

Parameters:

  • column (str) – Name of the column to validate
  • allowed_values (List[str]) – List of acceptable values for the column
  • name (Optional[str]) – Custom test case name
  • display_name (Optional[str]) – Custom display name for UI
  • description (Optional[str]) – Custom test description

Examples:

Functions:

Attributes:

metadata.sdk.data_quality.tests.column_tests.ColumnValuesToBeInSet.column_name

metadata.sdk.data_quality.tests.column_tests.ColumnValuesToBeInSet.compute_passed_failed_row_count

metadata.sdk.data_quality.tests.column_tests.ColumnValuesToBeInSet.description

metadata.sdk.data_quality.tests.column_tests.ColumnValuesToBeInSet.display_name

metadata.sdk.data_quality.tests.column_tests.ColumnValuesToBeInSet.name

metadata.sdk.data_quality.tests.column_tests.ColumnValuesToBeInSet.parameters

metadata.sdk.data_quality.tests.column_tests.ColumnValuesToBeInSet.test_definition_name

metadata.sdk.data_quality.tests.column_tests.ColumnValuesToBeInSet.to_test_case_definition

Create a test case definition from this test definition. Returns: TestCaseDefinition instance

metadata.sdk.data_quality.tests.column_tests.ColumnValuesToBeInSet.with_compute_row_count

Enable or disable passed/failed row count computation.

When enabled, the test will compute and report the number and percentage of rows that passed or failed the test validation.

Parameters:

  • compute (bool) – Whether to compute row-level pass/fail statistics

Returns:

  • Self – Self for method chaining

metadata.sdk.data_quality.tests.column_tests.ColumnValuesToBeInSet.with_description

Set a custom description.

Parameters:

  • description (str) – Detailed description of what this test validates

Returns:

  • Self – Self for method chaining

metadata.sdk.data_quality.tests.column_tests.ColumnValuesToBeInSet.with_display_name

Set a custom display name.

Parameters:

  • display_name (str) – Human-readable name for UI display

Returns:

  • Self – Self for method chaining

metadata.sdk.data_quality.tests.column_tests.ColumnValuesToBeInSet.with_name

Set a custom test case name.

Parameters:

  • name (str) – Unique identifier for this test case

Returns:

  • Self – Self for method chaining

metadata.sdk.data_quality.tests.column_tests.ColumnValuesToBeNotInSet

Bases: ColumnTest

Validates that column values do not contain any forbidden values.

This test detects the presence of blacklisted or invalid values in a column. Useful for data quality checks where certain values should never appear.

Parameters:

  • column (str) – Name of the column to validate
  • forbidden_values (List[str]) – List of values that must not appear in the column
  • name (Optional[str]) – Custom test case name
  • display_name (Optional[str]) – Custom display name for UI
  • description (Optional[str]) – Custom test description

Examples:

Functions:

Attributes:

metadata.sdk.data_quality.tests.column_tests.ColumnValuesToBeNotInSet.column_name

metadata.sdk.data_quality.tests.column_tests.ColumnValuesToBeNotInSet.compute_passed_failed_row_count

metadata.sdk.data_quality.tests.column_tests.ColumnValuesToBeNotInSet.description

metadata.sdk.data_quality.tests.column_tests.ColumnValuesToBeNotInSet.display_name

metadata.sdk.data_quality.tests.column_tests.ColumnValuesToBeNotInSet.name

metadata.sdk.data_quality.tests.column_tests.ColumnValuesToBeNotInSet.parameters

metadata.sdk.data_quality.tests.column_tests.ColumnValuesToBeNotInSet.test_definition_name

metadata.sdk.data_quality.tests.column_tests.ColumnValuesToBeNotInSet.to_test_case_definition

Create a test case definition from this test definition. Returns: TestCaseDefinition instance

metadata.sdk.data_quality.tests.column_tests.ColumnValuesToBeNotInSet.with_compute_row_count

Enable or disable passed/failed row count computation.

When enabled, the test will compute and report the number and percentage of rows that passed or failed the test validation.

Parameters:

  • compute (bool) – Whether to compute row-level pass/fail statistics

Returns:

  • Self – Self for method chaining

metadata.sdk.data_quality.tests.column_tests.ColumnValuesToBeNotInSet.with_description

Set a custom description.

Parameters:

  • description (str) – Detailed description of what this test validates

Returns:

  • Self – Self for method chaining

metadata.sdk.data_quality.tests.column_tests.ColumnValuesToBeNotInSet.with_display_name

Set a custom display name.

Parameters:

  • display_name (str) – Human-readable name for UI display

Returns:

  • Self – Self for method chaining

metadata.sdk.data_quality.tests.column_tests.ColumnValuesToBeNotInSet.with_name

Set a custom test case name.

Parameters:

  • name (str) – Unique identifier for this test case

Returns:

  • Self – Self for method chaining

metadata.sdk.data_quality.tests.column_tests.ColumnValuesToBeNotNull

Bases: ColumnTest

Validates that a column contains no null or missing values.

This test ensures data completeness by checking for NULL values in a column. One of the most common data quality tests for required fields.

Parameters:

  • column (str) – Name of the column to validate
  • name (Optional[str]) – Custom test case name
  • display_name (Optional[str]) – Custom display name for UI
  • description (Optional[str]) – Custom test description

Examples:

Functions:

Attributes:

metadata.sdk.data_quality.tests.column_tests.ColumnValuesToBeNotNull.column_name

metadata.sdk.data_quality.tests.column_tests.ColumnValuesToBeNotNull.compute_passed_failed_row_count

metadata.sdk.data_quality.tests.column_tests.ColumnValuesToBeNotNull.description

metadata.sdk.data_quality.tests.column_tests.ColumnValuesToBeNotNull.display_name

metadata.sdk.data_quality.tests.column_tests.ColumnValuesToBeNotNull.name

metadata.sdk.data_quality.tests.column_tests.ColumnValuesToBeNotNull.parameters

metadata.sdk.data_quality.tests.column_tests.ColumnValuesToBeNotNull.test_definition_name

metadata.sdk.data_quality.tests.column_tests.ColumnValuesToBeNotNull.to_test_case_definition

Create a test case definition from this test definition. Returns: TestCaseDefinition instance

metadata.sdk.data_quality.tests.column_tests.ColumnValuesToBeNotNull.with_compute_row_count

Enable or disable passed/failed row count computation.

When enabled, the test will compute and report the number and percentage of rows that passed or failed the test validation.

Parameters:

  • compute (bool) – Whether to compute row-level pass/fail statistics

Returns:

  • Self – Self for method chaining

metadata.sdk.data_quality.tests.column_tests.ColumnValuesToBeNotNull.with_description

Set a custom description.

Parameters:

  • description (str) – Detailed description of what this test validates

Returns:

  • Self – Self for method chaining

metadata.sdk.data_quality.tests.column_tests.ColumnValuesToBeNotNull.with_display_name

Set a custom display name.

Parameters:

  • display_name (str) – Human-readable name for UI display

Returns:

  • Self – Self for method chaining

metadata.sdk.data_quality.tests.column_tests.ColumnValuesToBeNotNull.with_name

Set a custom test case name.

Parameters:

  • name (str) – Unique identifier for this test case

Returns:

  • Self – Self for method chaining

metadata.sdk.data_quality.tests.column_tests.ColumnValuesToBeUnique

Bases: ColumnTest

Validates that all values in a column are unique with no duplicates.

This test checks for duplicate values in columns that should contain unique identifiers or keys. Essential for primary key and unique constraint validation.

Parameters:

  • column (str) – Name of the column to validate
  • name (Optional[str]) – Custom test case name
  • display_name (Optional[str]) – Custom display name for UI
  • description (Optional[str]) – Custom test description

Examples:

Functions:

Attributes:

metadata.sdk.data_quality.tests.column_tests.ColumnValuesToBeUnique.column_name

metadata.sdk.data_quality.tests.column_tests.ColumnValuesToBeUnique.compute_passed_failed_row_count

metadata.sdk.data_quality.tests.column_tests.ColumnValuesToBeUnique.description

metadata.sdk.data_quality.tests.column_tests.ColumnValuesToBeUnique.display_name

metadata.sdk.data_quality.tests.column_tests.ColumnValuesToBeUnique.name

metadata.sdk.data_quality.tests.column_tests.ColumnValuesToBeUnique.parameters

metadata.sdk.data_quality.tests.column_tests.ColumnValuesToBeUnique.test_definition_name

metadata.sdk.data_quality.tests.column_tests.ColumnValuesToBeUnique.to_test_case_definition

Create a test case definition from this test definition. Returns: TestCaseDefinition instance

metadata.sdk.data_quality.tests.column_tests.ColumnValuesToBeUnique.with_compute_row_count

Enable or disable passed/failed row count computation.

When enabled, the test will compute and report the number and percentage of rows that passed or failed the test validation.

Parameters:

  • compute (bool) – Whether to compute row-level pass/fail statistics

Returns:

  • Self – Self for method chaining

metadata.sdk.data_quality.tests.column_tests.ColumnValuesToBeUnique.with_description

Set a custom description.

Parameters:

  • description (str) – Detailed description of what this test validates

Returns:

  • Self – Self for method chaining

metadata.sdk.data_quality.tests.column_tests.ColumnValuesToBeUnique.with_display_name

Set a custom display name.

Parameters:

  • display_name (str) – Human-readable name for UI display

Returns:

  • Self – Self for method chaining

metadata.sdk.data_quality.tests.column_tests.ColumnValuesToBeUnique.with_name

Set a custom test case name.

Parameters:

  • name (str) – Unique identifier for this test case

Returns:

  • Self – Self for method chaining

metadata.sdk.data_quality.tests.column_tests.ColumnValuesToMatchRegex

Bases: ColumnTest

Validates that column values match a specified regular expression pattern.

This test ensures data format consistency by checking that values conform to expected patterns. Useful for emails, phone numbers, IDs, and formatted strings.

Parameters:

  • column (str) – Name of the column to validate
  • regex (str) – Regular expression pattern that values must match
  • name (Optional[str]) – Custom test case name
  • display_name (Optional[str]) – Custom display name for UI
  • description (Optional[str]) – Custom test description

Examples:

Functions:

Attributes:

metadata.sdk.data_quality.tests.column_tests.ColumnValuesToMatchRegex.column_name

metadata.sdk.data_quality.tests.column_tests.ColumnValuesToMatchRegex.compute_passed_failed_row_count

metadata.sdk.data_quality.tests.column_tests.ColumnValuesToMatchRegex.description

metadata.sdk.data_quality.tests.column_tests.ColumnValuesToMatchRegex.display_name

metadata.sdk.data_quality.tests.column_tests.ColumnValuesToMatchRegex.name

metadata.sdk.data_quality.tests.column_tests.ColumnValuesToMatchRegex.parameters

metadata.sdk.data_quality.tests.column_tests.ColumnValuesToMatchRegex.test_definition_name

metadata.sdk.data_quality.tests.column_tests.ColumnValuesToMatchRegex.to_test_case_definition

Create a test case definition from this test definition. Returns: TestCaseDefinition instance

metadata.sdk.data_quality.tests.column_tests.ColumnValuesToMatchRegex.with_compute_row_count

Enable or disable passed/failed row count computation.

When enabled, the test will compute and report the number and percentage of rows that passed or failed the test validation.

Parameters:

  • compute (bool) – Whether to compute row-level pass/fail statistics

Returns:

  • Self – Self for method chaining

metadata.sdk.data_quality.tests.column_tests.ColumnValuesToMatchRegex.with_description

Set a custom description.

Parameters:

  • description (str) – Detailed description of what this test validates

Returns:

  • Self – Self for method chaining

metadata.sdk.data_quality.tests.column_tests.ColumnValuesToMatchRegex.with_display_name

Set a custom display name.

Parameters:

  • display_name (str) – Human-readable name for UI display

Returns:

  • Self – Self for method chaining

metadata.sdk.data_quality.tests.column_tests.ColumnValuesToMatchRegex.with_name

Set a custom test case name.

Parameters:

  • name (str) – Unique identifier for this test case

Returns:

  • Self – Self for method chaining

metadata.sdk.data_quality.tests.column_tests.ColumnValuesToNotMatchRegex

Bases: ColumnTest

Validates that column values do not match a forbidden regular expression pattern.

This test detects values that match unwanted patterns, useful for identifying invalid formats, test data, or security risks.

Parameters:

  • column (str) – Name of the column to validate
  • regex (str) – Regular expression pattern that values must NOT match
  • name (Optional[str]) – Custom test case name
  • display_name (Optional[str]) – Custom display name for UI
  • description (Optional[str]) – Custom test description

Examples:

Functions:

Attributes:

metadata.sdk.data_quality.tests.column_tests.ColumnValuesToNotMatchRegex.column_name

metadata.sdk.data_quality.tests.column_tests.ColumnValuesToNotMatchRegex.compute_passed_failed_row_count

metadata.sdk.data_quality.tests.column_tests.ColumnValuesToNotMatchRegex.description

metadata.sdk.data_quality.tests.column_tests.ColumnValuesToNotMatchRegex.display_name

metadata.sdk.data_quality.tests.column_tests.ColumnValuesToNotMatchRegex.name

metadata.sdk.data_quality.tests.column_tests.ColumnValuesToNotMatchRegex.parameters

metadata.sdk.data_quality.tests.column_tests.ColumnValuesToNotMatchRegex.test_definition_name

metadata.sdk.data_quality.tests.column_tests.ColumnValuesToNotMatchRegex.to_test_case_definition

Create a test case definition from this test definition. Returns: TestCaseDefinition instance

metadata.sdk.data_quality.tests.column_tests.ColumnValuesToNotMatchRegex.with_compute_row_count

Enable or disable passed/failed row count computation.

When enabled, the test will compute and report the number and percentage of rows that passed or failed the test validation.

Parameters:

  • compute (bool) – Whether to compute row-level pass/fail statistics

Returns:

  • Self – Self for method chaining

metadata.sdk.data_quality.tests.column_tests.ColumnValuesToNotMatchRegex.with_description

Set a custom description.

Parameters:

  • description (str) – Detailed description of what this test validates

Returns:

  • Self – Self for method chaining

metadata.sdk.data_quality.tests.column_tests.ColumnValuesToNotMatchRegex.with_display_name

Set a custom display name.

Parameters:

  • display_name (str) – Human-readable name for UI display

Returns:

  • Self – Self for method chaining

metadata.sdk.data_quality.tests.column_tests.ColumnValuesToNotMatchRegex.with_name

Set a custom test case name.

Parameters:

  • name (str) – Unique identifier for this test case

Returns:

  • Self – Self for method chaining