Github
Community
Support
Search…
Introduction
Quickstart: data monitoring
Quickstart: data lineage
Install & configure
Data lineage
understand elementary
Elementary overview
Modules
Data tests
Data monitoring
Add data tests
Data tests configuration
Data tests report UI
Monitoring in production
dbt
dbt artifacts
data lineage
edr lineage
lineage graph
Query history
Data lineage use Cases
Integrations
Slack
Snowflake
Redshift
BigQuery
Project overview
Contributions
Roadmap
FAQ & Support
FAQ
Troubleshooting
Community & Support
Powered By
GitBook
Install & configure
Quick start - install and configure
Install
Start by downloading and installing elementary-data CLI.
To install the lineage module, run:
1
pip install 'elementary-data[lineage]'
Copied!
Run one of the following commands based on your platform (no need to run all):
1
pip install 'elementary-data[snowflake]'
2
pip install 'elementary-data[bigquery]'
3
pip install 'elementary-data[redshift]'
Copied!
1
# The tool is named edr (Elementary Data Reliability),
2
# run it to validate the installation:
3
edr --help
Copied!
We recommend using pip, for other installation options refer to the
download and install guide
.
Connection profile
In order to connect, elementary needs a profile in a file named
profiles.yml
, (if you use dbt, you already have it).
Path:
HOME_DIR/.dbt/profiles.yml
Profile name:
elementary
Here is an example for Snowflake and BigQuery profiles:
Snowflake
BigQuery
For further information and other authentication options, refer to the
connection profile guide
.
Note that the credentials provided in the profiles file need to have the relevant permissions in order for Elementary to work.
For details, please refer to:
​
Snowflake required permissions
​
​
BigQuery required permissions
​
Previous
Quickstart: data lineage
Next
Data lineage
Last modified
19d ago
Copy link
Contents
Install
Connection profile