Skip to content
This repository was archived by the owner on Aug 8, 2025. It is now read-only.

Commit 737a7cd

Browse files
committed
Add in header showing how to run with YAML example files
1 parent 38a5f4e commit 737a7cd

1 file changed

Lines changed: 7 additions & 0 deletions

File tree

README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,13 @@ Change to another data source via:
8989
DATA_SOURCE=cassandra docker-compose up -d datacaterer
9090
```
9191

92+
### Run with YAML files
93+
94+
Example YAML files can be found here:
95+
- [Plan](docker/data/custom/plan): Define tasks, data sources, foreign keys, etc. to run
96+
- [Task](docker/data/custom/task): Define data generation details such as schema and number of records
97+
- [Validation](docker/data/custom/validation): Define data validation details to run on data sources
98+
9299
If you want to use a [different YAML plan](docker/data/custom/plan) for the data source, you can run:
93100

94101
```shell

0 commit comments

Comments
 (0)