Module ksqldb::types [−][src]
Common return types from KSQL DB
This module attempts to build up a collection of typed responses from the KSQL-DB API.
This is a little bit tricky as the same endpoint has different response bodies depending on
the STATEMENT or QUERY that was executed. This makes it trickly to concretely type the
API so some user input might be required to enable this currently done by specifiying T
when calling the required method.
This module is always going to be a moving target to try and keep the types as up to date with underlying API as much as possible. If you spot something that requires an update, or alternatively are using something that doesn’t have a corresponding type them please raise a PR.
Structs
| CommandStatus | The status of the current command being processed |
| CreateResponse | The response type for any |
| DescribeResponse | The response type for any |
| Description | Information about the entity |
| DropResponse | The response type for any |
| ExplainResponse | The response type for any |
| Explanation | Information about the expression or query |
| Field | Information about the field |
| ListQueriesResponse | The response type for any |
| ListStreamsResponse | The response type for any |
| ListTablesResponse | The response type for any |
| Properties | Information about the properties set on the instance |
| Property | Information about a specific property in the instance |
| Query | |
| RequestInfo | Generic information about the request |
| Schema | Information about the schema |
| Stream | Information about a KSQL Stream |
| Table | Information about a KSQL Table |
| TerminateResponse | The response type for any |
| Warning | Warnings that were returned by KSQL |
Enums
| CommandState | The current state of the given command |
| Entity | The type of entity |
| FieldType | The type of the given field |
| Format | The serialization format used |
| StreamProperties | The stream properties which may be modified within the |