Skip to content

Commit d0312b6

Browse files
Allen JonesAllen Jones
authored andcommitted
docs: fix documentation inaccuracies in README.md
- Fix query autoStart default: true → false (matches code) - Fix PostgreSQL publicationName example: drasi_pub → drasi_publication - Add missing metadata field to gRPC reaction table - Add complete field table for gRPC Adaptive reaction section - Improve Mock source dataType description with node label info
1 parent 58c9d8e commit d0312b6

1 file changed

Lines changed: 17 additions & 3 deletions

File tree

README.md

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -284,7 +284,7 @@ sources:
284284
password: ${DB_PASSWORD}
285285
tables: [orders, customers]
286286
slotName: drasi_slot
287-
publicationName: drasi_pub
287+
publicationName: drasi_publication
288288
sslMode: prefer
289289
tableKeys:
290290
- table: orders
@@ -362,7 +362,7 @@ sources:
362362

363363
| Field | Type | Default | Description |
364364
|-------|------|---------|-------------|
365-
| `dataType` | string | `generic` | Type of mock data to generate |
365+
| `dataType` | string | `generic` | Type of mock data: `sensor` (SensorReading nodes), `counter` (Counter nodes), `generic` (Generic nodes) |
366366
| `intervalMs` | integer | `5000` | Data generation interval in milliseconds |
367367

368368
#### Platform Source (`platform`)
@@ -465,7 +465,7 @@ queries:
465465
| `query` | string | (required) | Query string (Cypher or GQL) |
466466
| `queryLanguage` | string | `GQL` | Query language: `Cypher` or `GQL` |
467467
| `sources` | array | (required) | Source subscriptions |
468-
| `autoStart` | boolean | `true` | Start query automatically |
468+
| `autoStart` | boolean | `false` | Start query automatically |
469469
| `enableBootstrap` | boolean | `true` | Process initial data from sources |
470470
| `bootstrapBufferSize` | integer | `10000` | Event buffer size during bootstrap |
471471
| `priorityQueueCapacity` | integer | (global) | Override queue capacity for this query |
@@ -621,6 +621,7 @@ reactions:
621621
| `maxRetries` | integer | `3` | Maximum retry attempts |
622622
| `connectionRetryAttempts` | integer | `5` | Connection retry attempts |
623623
| `initialConnectionTimeoutMs` | integer | `10000` | Initial connection timeout |
624+
| `metadata` | object | `{}` | Custom gRPC metadata key-value pairs |
624625

625626
#### gRPC Adaptive Reaction (`grpc-adaptive`)
626627

@@ -636,6 +637,19 @@ reactions:
636637
adaptiveMaxBatchSize: 1000
637638
```
638639

640+
| Field | Type | Default | Description |
641+
|-------|------|---------|-------------|
642+
| `endpoint` | string | `grpc://localhost:50052` | gRPC endpoint URL |
643+
| `timeoutMs` | integer | `5000` | Connection timeout in milliseconds |
644+
| `maxRetries` | integer | `3` | Maximum retry attempts |
645+
| `connectionRetryAttempts` | integer | `5` | Connection retry attempts |
646+
| `initialConnectionTimeoutMs` | integer | `10000` | Initial connection timeout |
647+
| `metadata` | object | `{}` | Custom gRPC metadata key-value pairs |
648+
| `adaptiveMinBatchSize` | integer | `1` | Minimum batch size |
649+
| `adaptiveMaxBatchSize` | integer | `1000` | Maximum batch size |
650+
| `adaptiveWindowSize` | integer | `100` | Window size for adaptive calculations |
651+
| `adaptiveBatchTimeoutMs` | integer | `1000` | Batch timeout in milliseconds |
652+
639653
#### SSE Reaction (`sse`)
640654

641655
Streams query results via Server-Sent Events.

0 commit comments

Comments
 (0)