Skip to main content

πŸ“– Keywords

Keywords are special test conditions executed under the hood by X-AutoMate.
They act as assertions that evaluate whether the data returned by your SQL queries meets the expected criteria.

πŸ’‘ What Are Keywords?​

For example, if your test query is:

SELECT * FROM table WHERE id IS NULL

You might attach the keyword:

βœ… Row Count Is 0

This keyword will fail the test if any rows are returned (i.e., if null values exist in the id column).

X-AutoMate supports a wide range of keywords to enable flexible, data-driven, and context-aware testing.

πŸ“‹ List of Supported Keywords​

KeywordDescription
Check If Exists In DatabaseVerifies if a specific row or value exists in the database.
Check If Not Exists In DatabaseVerifies that a specific row or value does not exist in the database.
DescriptionAdds a human-readable description or comment.
QueryExecutes a SQL query and optionally stores the result.
Row Count Is 0Asserts that a query result returns zero rows.
Row Count Is Equal To XPasses if row count equals X.
Row Count Is Greater Than XPasses if row count is greater than X.
Row Count Is Less Than XPasses if row count is less than X.
Row Count Is At Least XPasses if row count is greater than or equal to X.
Row Count Is At Most XPasses if row count is less than or equal to X.
Data Quality CheckRuns a predefined data quality validation.
Data Quality Custom CheckExecutes a user-defined DQ check via SQL.
Data Quality Check Whether Value Is CloseChecks if a numeric value is close to expected (within tolerance).
Result Is At Most XPasses if query result is ≀ X.
Result Is At Least XPasses if query result is β‰₯ X.
Result Is Less Than XPasses if query result is < X.
Result Is Greater Than XPasses if query result is > X.
Result Is Equal To XPasses if query result is = X.
Result Is 0Passes if query result is exactly 0.
Key Value In Variable Should Be Equal To XChecks if a variable’s key equals X.
Key Value In Variable Should Be Greater Than XChecks if a variable’s key > X.
Key Value In Variable Should Be Lesser Than XChecks if a variable’s key < X.
Key Value In Variable Should Be At Most XChecks if a variable’s key ≀ X.
Key Value In Variable Should Be At Least XChecks if a variable’s key β‰₯ X.
Key Value In Variable Should Not Be XChecks if a variable’s key β‰  X.
Key in Dictionaries Is Not EqualFails if keys in two dictionaries match.
Key in Dictionaries Is EqualPasses if keys in two dictionaries match.
Query To VariableExecutes a query and stores its result in a variable.
Data Quality Simple CheckRuns a built-in DQ validation (e.g., null count, regex, range).

πŸ§ͺ Where Are Keywords Used?​

Keywords are used in all major test types in X-AutoMate:

  • πŸ—οΈ ETL Tests
  • 🧼 Data Quality Checks (DQ)
  • πŸ” Reconciliation Tests

Some keywords are specific to certain test types. For example:

  • Data Quality Custom Check is only used in Custom DQ tests
  • Several reconciliation keywords are auto-selected by X-AutoMate

πŸ€– X-AutoMate will automatically choose the most suitable keyword based on your query and configuration β€” no need to worry about hidden/internal ones.