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

Commit cc04988

Browse files
committed
Update quick-start, add in missing supported connections
1 parent 4aefc92 commit cc04988

3 files changed

Lines changed: 41 additions & 19 deletions

File tree

docs/docs/connection.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,7 @@ These configurations can be done via API or from configuration. Examples of both
3939
| Messaging | Pulsar | :octicons-x-circle-fill-12:{ .red-cross } |
4040
| Metadata | Data Contract CLI | :white_check_mark: |
4141
| Metadata | Great Expectations | :white_check_mark: |
42+
| Metadata | JSON Schema | :white_check_mark: |
4243
| Metadata | Marquez | :white_check_mark: |
4344
| Metadata | OpenMetadata | :white_check_mark: |
4445
| Metadata | OpenAPI/Swagger | :white_check_mark: |

docs/docs/guide/data-source/metadata/json-schema.md

Lines changed: 28 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -350,6 +350,7 @@ JSON Schema metadata source supports powerful field filtering capabilities to co
350350
1. Or use `Exclude Field Patterns` with regex patterns
351351

352352
The field filtering options provide flexibility to:
353+
353354
- **includeFields**: Only generate data for the specified field paths
354355
- **excludeFields**: Generate data for all fields except the specified ones
355356
- **includeFieldPatterns**: Include fields matching the regex patterns
@@ -439,7 +440,33 @@ Now we can run via the script `./run.sh` that is in the top level directory of t
439440
It should look something like this.
440441

441442
```json
442-
{"customer_direct_debit_initiation_v11":{"group_header":{"message_identification":"MSG001","creation_date_time":"2024-03-15T10:30:45Z","number_of_transactions":1,"control_sum":100.50,"initiating_party":{"name":"ACME Corp"}},"payment_information":{"payment_information_identification":"PMT001","payment_method":"DD","batch_booking":true,"direct_debit_transaction_information":{"payment_identification":{"end_to_end_identification":"TXN001"},"instructed_amount":{"value":100.50,"currency":"EUR"}}}}}
443+
{
444+
"customer_direct_debit_initiation_v11": {
445+
"group_header": {
446+
"message_identification": "MSG001",
447+
"creation_date_time": "2024-03-15T10:30:45Z",
448+
"number_of_transactions": 1,
449+
"control_sum": 100.50,
450+
"initiating_party": {
451+
"name": "ACME Corp"
452+
}
453+
},
454+
"payment_information": {
455+
"payment_information_identification": "PMT001",
456+
"payment_method": "DD",
457+
"batch_booking": true,
458+
"direct_debit_transaction_information": {
459+
"payment_identification": {
460+
"end_to_end_identification": "TXN001"
461+
},
462+
"instructed_amount": {
463+
"value": 100.50,
464+
"currency": "EUR"
465+
}
466+
}
467+
}
468+
}
469+
}
443470
```
444471

445472
Congratulations! You have now made a data generator that uses JSON Schema as a metadata source to generate realistic test data following your schema specifications.

docs/get-started/quick-start.md

Lines changed: 12 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,6 @@ image: "https://data.catering/diagrams/logo/data_catering_logo.svg"
66

77
# Run Data Caterer
88

9-
## Get Token
10-
11-
To run a trial of Data Caterer, you will need a username and token. Get one by following the below instructions.
12-
13-
1. Join the Data Catering [Slack](https://join.slack.com/t/data-catering/shared_invite/zt-2664ylbpi-w3n7lWAO~PHeOG9Ujpm~~w)
14-
2. In any channel, type `/token` (the message will only be seen by you)
15-
3. Take note of your given `user-id` and `token` values (your token value will not be shown again as it is not stored anywhere)
16-
179
## Quick start
1810

1911
<div class="grid cards" markdown>
@@ -69,49 +61,51 @@ To run a trial of Data Caterer, you will need a username and token. Get one by f
6961
git clone git@github.com:data-catering/data-caterer-example.git
7062
cd data-caterer-example && ./run.sh
7163
#check results under docker/sample/report/index.html folder
64+
#If you want to run any other examples, check the class names under src/scala or src/java
65+
#And then run with ./run.sh <class_name>
66+
#i.e. ./run.sh CsvPlan
7267
```
7368

7469
### YAML
7570

7671
```shell
7772
git clone git@github.com:data-catering/data-caterer-example.git
78-
cd data-caterer-example && ./run.sh
73+
cd data-caterer-example && ./run.sh simple-json.yaml
7974
#check results under docker/sample/report/index.html folder
8075
#check example YAML files under:
8176
# - docker/data/custom/plan
8277
# - docker/data/custom/task
8378
# - docker/data/custom/validation
79+
#If you want to run any other examples, check the files under docker/data/custom/plan
80+
#And then run with ./run.sh <file_name>
81+
#i.e. ./run.sh parquet.yaml
8482
```
8583

8684
### Docker
8785

8886
1. Docker
8987
```shell
90-
docker run -d -i -p 9898:9898 -e DEPLOY_MODE=standalone --name datacaterer datacatering/data-caterer:0.15.2
88+
docker run -d -i -p 9898:9898 -e DEPLOY_MODE=standalone --name datacaterer datacatering/data-caterer:0.16.1
9189
```
9290
2. [Open localhost:9898](http://localhost:9898)
93-
3. Login with the user and token given from [here](#get-token)
9491

9592
### Mac
9693

97-
1. In any Slack channel, type `/download-mac` (the message will only be seen by you) and download from the link provided
98-
2. Drag Data Caterer to your Applications folder adn double-click to run
94+
1. [Mac download](https://nightly.link/data-catering/data-caterer/workflows/build/main/data-caterer-mac.zip)
95+
2. Drag Data Caterer to your Applications folder and double-click to run
9996
3. If your browser doesn't open, go to [http://localhost:9898](http://localhost:9898) in your preferred browser
100-
4. Login with the user and token given from [here](#get-token)
10197

10298
### Windows
10399

104-
1. In any Slack channel, type `/download-windows` (the message will only be seen by you) and download from the link provided
100+
1. [Windows download](https://nightly.link/data-catering/data-caterer/workflows/build/main/data-caterer-windows.zip)
105101
2. Click on 'More info' then at the bottom, click 'Run anyway'
106102
3. Go to '/Program Files/DataCaterer' folder and run DataCaterer application
107103
4. If your browser doesn't open, go to [http://localhost:9898](http://localhost:9898) in your preferred browser
108-
5. Login with the user and token given from [here](#get-token)
109104

110105
### Linux
111106

112-
1. In any Slack channel, type `/download-linux` (the message will only be seen by you) and download from the link provided
107+
1. [Linux download](https://nightly.link/data-catering/data-caterer/workflows/build/main/data-caterer-linux.zip)
113108
2. If your browser doesn't open, go to [http://localhost:9898](http://localhost:9898) in your preferred browser
114-
3. Login with the user and token given from [here](#get-token)
115109

116110
#### Report
117111

0 commit comments

Comments
 (0)