Skip to content

Validations

Validations can be used to run data checks after you have run the data generator or even as a standalone task. A report summarising the success or failure of the validations is produced and can be examined for further investigation.

  • Basic - Basic column level validations
  • Group by/Aggregate - Run aggregates over grouped data, then validate
  • Upstream data source - Ensure record values exist in datasets based on other data sources or data generated
  • [Data Profile (Coming soon)] - Score how close the data profile of generated data is against the target data profile

Define Validations

Full example validation can be found below. For more details, check out each of the subsections defined further below.

var csvTxns = csv("transactions", "/tmp/csv", Map.of("header", "true"))
  .validations(
    validation().col("amount").lessThan(100),
    validation().col("year").isEqual(2021).errorThreshold(0.1),  //equivalent to if error percentage is > 10%, then fail
    validation().col("name").matches("Peter .*").errorThreshold(200)  //equivalent to if number of errors is > 200, then fail
  )
  .validationWait(waitCondition().pause(1));

var conf = configuration().enableValidation(true);

val csvTxns = csv("transactions", "/tmp/csv", Map("header" -> "true"))
  .validations(
    validation.col("amount").lessThan(100),
    validation.col("year").isEqual(2021).errorThreshold(0.1),  //equivalent to if error percentage is > 10%, then fail
    validation.col("name").matches("Peter .*").errorThreshold(200)  //equivalent to if number of errors is > 200, then fail
  )  
  .validationWait(waitCondition.pause(1))

val conf = configuration.enableValidation(true)

---
name: "account_checks"
dataSources:
  transactions:
    options:
      path: "/tmp/csv"
    validations:
      - expr: "amount < 100"
      - expr: "year == 2021"
        errorThreshold: 0.1   #equivalent to if error percentage is > 10%, then fail
      - expr: "REGEXP_LIKE(name, 'Peter .*')"
        errorThreshold: 200   #equivalent to if number of errors is > 200, then fail
        description: "Should be lots of Peters"
    waitCondition:
      pauseInSeconds: 1

Wait Condition

Once data has been generated, you may want to wait for a certain condition to be met before starting the data validations. This can be via:

  • Pause for seconds
  • When file is available
  • Data exists
  • Webhook

Pause

var csvTxns = csv("transactions", "/tmp/csv", Map.of("header", "true"))
  .validationWait(waitCondition().pause(1));

val csvTxns = csv("transactions", "/tmp/csv", Map("header" -> "true"))
  .validationWait(waitCondition.pause(1))

---
name: "account_checks"
dataSources:
  transactions:
    options:
      path: "/tmp/csv"
    waitCondition:
      pauseInSeconds: 1

Data exists

var csvTxns = csv("transactions", "/tmp/csv", Map.of("header", "true"))
  .validationWaitDataExists("updated_date > DATE('2023-01-01')");

val csvTxns = csv("transactions", "/tmp/csv", Map("header" -> "true"))
  .validationWaitDataExists("updated_date > DATE('2023-01-01')")

---
name: "account_checks"
dataSources:
  transactions:
    options:
      path: "/tmp/csv"
    waitCondition:
      dataSourceName: "transactions"
      options:
        path: "/tmp/csv"
      expr: "updated_date > DATE('2023-01-01')"

Webhook

var csvTxns = csv("transactions", "/tmp/csv", Map.of("header", "true"))
  .validationWait(waitCondition().webhook("http://localhost:8080/finished")); //by default, GET request successful when 200 status code

//or

var csvTxnsWithStatusCodes = csv("transactions", "/tmp/csv", Map.of("header", "true"))
  .validationWait(waitCondition().webhook("http://localhost:8080/finished", "GET", 200, 202));  //successful if 200 or 202 status code

//or

var csvTxnsWithExistingHttpConnection = csv("transactions", "/tmp/csv", Map.of("header", "true"))
  .validationWait(waitCondition().webhook("my_http", "http://localhost:8080/finished"));  //use connection configuration from existing 'my_http' connection definition

val csvTxns = csv("transactions", "/tmp/csv", Map("header" -> "true"))
  .validationWait(waitCondition.webhook("http://localhost:8080/finished"))  //by default, GET request successful when 200 status code

//or

val csvTxnsWithStatusCodes = csv("transactions", "/tmp/csv", Map("header" -> "true"))
  .validationWait(waitCondition.webhook("http://localhost:8080/finished", "GET", 200, 202)) //successful if 200 or 202 status code

//or

val csvTxnsWithExistingHttpConnection = csv("transactions", "/tmp/csv", Map("header" -> "true"))
  .validationWait(waitCondition.webhook("my_http", "http://localhost:8080/finished")) //use connection configuration from existing 'my_http' connection definition

---
name: "account_checks"
dataSources:
  transactions:
    options:
      path: "/tmp/csv"
    waitCondition:
      url: "http://localhost:8080/finished" #by default, GET request successful when 200 status code

#or

---
name: "account_checks"
dataSources:
  transactions:
    options:
      path: "/tmp/csv"
    waitCondition:
      url: "http://localhost:8080/finished"
      method: "GET"
      statusCodes: [200, 202] #successful if 200 or 202 status code

#or

---
name: "account_checks"
dataSources:
  transactions:
    options:
      path: "/tmp/csv"
    waitCondition:
      dataSourceName: "my_http" #use connection configuration from existing 'my_http' connection definition
      url: "http://localhost:8080/finished"

File available

var csvTxns = csv("transactions", "/tmp/csv", Map.of("header", "true"))
  .validationWait(waitCondition().file("/tmp/json"));

val csvTxns = csv("transactions", "/tmp/csv", Map.of("header", "true"))
  .validationWait(waitCondition.file("/tmp/json"))

---
name: "account_checks"
dataSources:
  transactions:
    options:
      path: "/tmp/csv"
    waitCondition:
      path: "/tmp/json"

Report

Once run, it will produce a report like this.