datafold-sdk

Datafold allows you to trigger data diffs from CI using the datafold-sdk. This allows you to easily integrate Datafold in your CI with arbitrary pipeline orchestrators. This often requires some glue code to wire, for example, Airflow to Datafold. First, you go to CI settings.
Next, click "Add new CI config":
First, we select the repository set up under Git settings. Then we choose the data source that we have set up earlier, and we give it a name so we can easily remember the settings. The other settings are optional; more info can be found under the question-mark icon. After saving, we'll have a CI config id that we need later on:
Now, the connection has been set up, and for the pull request, you'll see the Datafold check on the pull request:
Now, you need to let Datafold know which tables we need to diff. First, we need to set the credentials using the environment variable DATAFOLD_APIKEY. In the case of self-hosted Datafold, you need to set the DATAFOLD_HOST as well:
1
export DATAFOLD_APIKEY=tnQrPAyIHquhx4x9LJdOHC28waU1P0FdCvabcabc
2
export DATAFOLD_HOST=https://datafold.company.io
Copied!
From the CLI you can run:
1
datafold ci submit \
2
    --ci-config-id 13 \
3
    --pr-num 6 <<- EOF
4
[{
5
        "prod": "INTEGRATION.BEERS.BEERS",
6
        "pr": "INTEGRATION.BEERS_DEV.BEERS",
7
        "pk": ["BEER_ID"]
8
}]
9
EOF
10
Successfully started a diff under Run ID 401
Copied!
This will request a single diff for the BEERS table between the BEERS and BEERS_DEV schema. Of course, you can add multiple tables to the array.
This will trigger the diff, and the results will be posted in the Pull Request:
Also, for the Pythonistas, you can do it directly from Python:
1
Python 3.9.10 (main, Jan 15 2022, 11:48:04) 
2
Type 'copyright', 'credits' or 'license' for more information
3
IPython 7.26.0 -- An enhanced Interactive Python. Type '?' for help.
4
​
5
In [1]: from datafold_sdk.sdk.ci import run_diff, CiDiff
6
​
7
In [2]: run_id = run_diff(
8
   ...:     host="https://datafold.company.io",
9
   ...:     api_key="tnQrPAyIHquhx4x9LJdOHC28waU1P0FdCvabcabc",
10
   ...:     ci_config_id=13,
11
   ...:     pr_num=6,
12
   ...:     diffs=[
13
   ...:       CiDiff(
14
   ...:         prod='INTEGRATION.BEERS.BEERS',
15
   ...:         pr='INTEGRATION.BEERS_DEV.BEERS',
16
   ...:         pk=["BEER_ID"]
17
   ...:       )
18
   ...:     ]
19
   ...: )
20
​
21
In [3]: print(f"Successfully started a diff under Run ID {run_id}")
22
Successfully started a diff under Run ID 402
Copied!

GitLab example

Next - Integrations

BI Integration

Last modified 3mo ago

Copy link