How to create a new Expectation Suite from a jsonschema file¶
The JsonSchemaProfiler
helps you quickly create Expectation Suites from jsonschema files.
Prerequisites: This how-to guide assumes you have already:
Have a valid jsonschema file that has top level object of type object.
Warning
This implementation does not traverse any levels of nesting.
Steps¶
Set a filename and a suite name
jsonschema_file = "YOUR_JSON_SCHEMA_FILE.json" suite_name = "YOUR_SUITE_NAME"
Load a DataContext
context = ge.data_context.DataContext()
Load the jsonschema file
with open(jsonschema_file, "r") as f: schema = json.load(f)
Instantiate the profiler
profiler = JsonSchemaProfiler()
Create the suite
suite = profiler.profile(schema, suite_name)
Save the suite
context.save_expectation_suite(suite)
Optionally, generate Data Docs and review the results there.
Data Docs provides a concise and useful way to review the Expectation Suite that has been created.
context.build_data_docs() You can also review and update the Expectations created by the profiler to get to the Expectation Suite you want using ``great_expectations suite edit``.
Additional notes¶
Important
Note that JsonSchemaProfiler generates Expectation Suites using column map expectations, which assumes a tabular data structure, because Great Expectations does not currently support nested data structures.
The full example script is here:
import json
import great_expectations as ge
from great_expectations.profile.json_schema_profiler import JsonSchemaProfiler
jsonschema_file = "YOUR_JSON_SCHEMA_FILE.json"
suite_name = "YOUR_SUITE_NAME"
context = ge.data_context.DataContext()
with open(jsonschema_file, "r") as f:
raw_json = f.read()
schema = json.loads(raw_json)
print("Generating suite...")
profiler = JsonSchemaProfiler()
suite = profiler.profile(schema, suite_name)
context.save_expectation_suite(suite)