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

Commit a81f28d

Browse files
recursethisAndre Rosa
authored andcommitted
Update README.md
1 parent e285f22 commit a81f28d

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

README.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Datagen CLI
22

3-
This command line interface application allows you to take schemas defined in JSON (`.json`), Avro (`.avsc`), or SQL (`.sql`) and produce believable fake data to Kafka in JSON or Avro format or to Postgres.
3+
This command line interface application allows you to take schemas defined in JSON (`.json`), Avro (`.avsc`), or SQL (`.sql`) and produce believable fake data to Kafka in JSON or Protobuf format or Avro format or to Postgres.
44

55
The benefits of using this datagen tool are:
66
- You can specify what values are generated using the expansive [FakerJS API](https://fakerjs.dev/api/) to craft data that more faithfully imitates your use case. This allows you to more easily apply business logic downstream.
@@ -85,7 +85,7 @@ Fake Data Generator
8585
Options:
8686
-V, --version output the version number
8787
-s, --schema <char> Schema file to use
88-
-f, --format <char> The format of the produced data (choices: "json", "avro", "postgres", "webhook", default: "json")
88+
-f, --format <char> The format of the produced data (choices: "json", "avro", "postgres", "webhook", "proto", default: "json")
8989
-n, --number <char> Number of records to generate. For infinite records, use -1 (default: "10")
9090
-c, --clean Clean (delete) Kafka topics and schema subjects previously created
9191
-dr, --dry-run Dry run (no data will be produced to Kafka)
@@ -213,7 +213,11 @@ Here is the general syntax for a JSON input schema:
213213
{
214214
"_meta": {
215215
"topic": "<my kafka topic>",
216-
"key": "<field to be used for kafka record key>" ,
216+
"key": "<field to be used for kafka record key>" ,
217+
"proto": {
218+
"dir": "<directory with protobuf schemas>",
219+
"schema": "<protobfuf message schema name>"
220+
},
217221
"relationships": [
218222
{
219223
"topic": "<topic for dependent dataset>",

0 commit comments

Comments
 (0)