Skip to content

Commit

Permalink
chore: update Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
thmeitz committed Jun 28, 2023
1 parent 33656fd commit 8b27ac7
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,27 @@ This client is `not production ready` and the interfaces can be changed without

⚠️ Disclaimer #1: This is a personal project and not supported or endorsed by Confluent.

### Breaking Change v0.1.0

All API calls must now contain a context object.

#### KsqldbClient Changes

- `Execute(ctx context.Context, options ExecOptions)`
- `GetClusterStatus(ctx context.Context)`
- `GetQueryStatus(ctx context.Context, commandId string)`
- `GetServerInfo(ctx context.Context)`
- `GetServerStatus(ctx context.Context)`
- `TerminateCluster(ctx context.Context, topics ...string)`
- `ValidateProperty(ctx context.Context, property string)`

#### HTTPClient Interface Changes

- `Get(ctx context.Context, url string)`
- `Post(ctx context.Context, url, contentType string, body io.Reader)`

*Please update your code!*

## Migration?

Checkout [ksqldb-migrate](https://github.com/thmeitz/ksqldb-migrate), a tool to run your ksqlDB migrations.
Expand Down

0 comments on commit 8b27ac7

Please sign in to comment.