create_test

Create a new Test Spec

dbnl.experimental.create_test(
    *,
    test_spec_dict: Dict[str, Any]
) -> Dict[str, Any]:

Parameters

Arguments
Description

test_spec_dict

A dictionary of the expected Test Spec schema

Returns

Type
Description

Dict[str, Any]

The JSON dict of the created Test Spec object. The return JSON will contain the id of the Test Spec.

Test Spec JSON Schema

{
  "project_id": string,

  // Test data
  "name": string (project-unique),
  "description": string?,
  "statistic_name": string,
  "statistic_params": map[string, any],
  "statistic_inputs": list[
    {
      "select_query_template": {
        "select": string // a column or a function on column(s)
      }
    }
  ],
  "assertion": {
    "name": string,
    "params": map[string, any]
  },
  "tag_ids": string[]?
}

Was this helpful?