-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore(docs): update README with basic instructions
- Loading branch information
1 parent
fcb4ff8
commit 6313957
Showing
1 changed file
with
35 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,35 @@ | ||
# dvc-sql-example | ||
A simple DVC pipeline to fetch from an SQL DB, cache as parquet for reproducibility and faster processing | ||
# DVC Azure SQL example | ||
|
||
A simple DVC pipeline to fetch from an SQL DB, cache as parquet for | ||
reproducibility and faster processing. | ||
|
||
## Install | ||
|
||
```bash | ||
python3 -m venv .venv | ||
source .venv/bin/activate | ||
pip install -r requirements.txt | ||
``` | ||
|
||
Depending on the setup and machine, you might need to install ODBC driver. It | ||
depends on the OS, please refer to MS ODBC setup docs. | ||
|
||
## Setup | ||
|
||
Create and `.env` file with: | ||
|
||
|
||
```env | ||
AZURE_CONNECTION_STRING="DRIVER={ODBC Driver 18 for SQL Server};SERVER=<server>.database.windows.net,1433;DATABASE=<db>;UID=<user>;PWD=<password>" | ||
``` | ||
|
||
This file is in `.gitignore`. | ||
|
||
> Note! There should be a better way to manage Azure credentials (e.g. using AD | ||
> or managed identities. This is example is made simple, but we recommend to | ||
> explore other options. | ||
## Running | ||
|
||
Run `dvc repro` or `dvc exp run` to reproduce the pipeline. Use regular | ||
`dvc push`, `dvc pull`, etc, to save and load artifacts. |