Skip to content

Commit

Permalink
Add IQ doc
Browse files Browse the repository at this point in the history
  • Loading branch information
loicgreffier committed May 20, 2024
1 parent 34f1a20 commit 4ee92c9
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@ need to do:
* [On Start](#on-start)
* [Interactive Queries](#interactive-queries)
* [Application Server Configuration](#application-server-configuration)
* [Querying State Stores with REST Endpoints](#querying-state-stores-with-rest-endpoints)
* [Topology](#topology-2)
* [Deduplication](#deduplication)
* [By Key](#by-key)
Expand All @@ -68,6 +69,8 @@ business implementation rather than the setup.

- **🤿 Interactive Queries**: Dive into Kafka Streams state stores.

- **🫧 Deduplication**: Remove duplicate events from a stream.

- **🧪 Testing**: Automatic Topology Test Driver setup. Start writing your tests with minimal effort.

## Dependencies
Expand Down Expand Up @@ -360,6 +363,18 @@ kafka:
2. The value of a default environment variable named `APPLICATION_SERVER`.
3. `localhost`.

#### Querying State Stores with REST Endpoints

Kstreamplify provides REST endpoints to query the state stores of your Kafka Streams application.
It handles state stores being on different instances of the application by providing an [RPC layer](https://docs.confluent.io/platform/current/streams/developer-guide/interactive-queries.html#adding-an-rpc-layer-to-your-application).

Here is an overview of the available endpoints:

- GET `/store`: Returns the list of available state stores
- GET `/store/{store}/info`: Returns the host information of the state store
- GET `/store/{store}`: Returns all records of the state store
- GET `/store/{store}/{key}`: Returns the record of the state store for the given key

<h3 id="topology-2">Topology</h4>

Kstreamplify provides a REST endpoint to retrieve the Kafka Streams topology as JSON.
Expand Down

0 comments on commit 4ee92c9

Please sign in to comment.