From 8cfddbf5d9e4d7fdc9eea70a0b9c042430e40d9b Mon Sep 17 00:00:00 2001 From: Pablo Martin Date: Thu, 26 Jan 2023 16:48:01 +0100 Subject: [PATCH] Drafted intended API for GE. --- README.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/README.md b/README.md index 5d4b6f4..2a6f5e2 100644 --- a/README.md +++ b/README.md @@ -119,6 +119,28 @@ with Flow(...) as flow: close_ssh_tunnel.run(tunnel=tunnel) ``` +### Use Great Expectations + +**Run a Great Expectations validation on a MySQL query** + +```python +from lolafect.connections import connect_to_mysql +from lolafect.data_testing import run_data_test_on_mysql + +with Flow(...) as flow: + + a_mysql_connection = connect_to_mysql(...) + + my_query = """SELECT something FROM somewhere""" + my_expectations = {...} # A bunch of things you want to validate on the result of the query + + validation_results = run_validation_on_mysql( + mysql_connection=a_mysql_connection, + query=my_query, + expectations=my_expectations + ) +``` + ### Slack **Send a warning message to slack if your tasks fails**