client

type Client interface {
	// Close closes all open connections
	Close() error
	// Describe returns information about an object
	Describe(ctx context.Context, source string) (DescribeResult, error)
	// Exec runs KSQL statements which can be anything except SELECT
	Exec(ctx context.Context, params ExecPayload) ([]ExecResult, error)
	// Explain returns details of the execution plan for a query or expression
	Explain(ctx context.Context, queryNameOrExpression string) (ExplainResult, error)
	// Healthcheck gets basic health information from the ksqlDB cluster
	Healthcheck(ctx context.Context) (HealthcheckResult, error)
	// Info returns status information about the ksqlDB cluster
	Info(ctx context.Context) (InfoResult, error)
	// InsertsStream allows you to insert rows into an existing ksqlDB stream. The stream must have already been created in ksqlDB.
	InsertsStream(ctx context.Context, payload InsertsStreamTargetPayload) (*InsertsStreamWriter, error)
	// ListQueries is a convenience method which executes a `LIST QUERIES;` operation
	ListQueries(ctx context.Context) (ListQueriesResult, error)
	// ListTables is a convenience method which executes a `LIST TABLES;` operation
	ListTables(ctx context.Context) (ListTablesResult, error)
	// ListStreams is a convenience method which executes a `LIST STREAMS;` operation
	ListStreams(ctx context.Context) (ListStreamsResult, error)
	// ListProperties is a convenience method which executes a `LIST PROPERTIES;` operation
	ListProperties(ctx context.Context) (ListPropertiesResult, error)
	// Query runs a KSQL query and returns a cursor. For streaming results use the QueryStream method.
	Query(ctx context.Context, payload QueryPayload) (*QueryRows, error)
	// QueryStream runs a streaming push & pull query
	QueryStream(ctx context.Context, payload QueryStreamPayload) (*QueryStreamRows, error)
	// CloseQuery explicitly terminates a push query stream
	CloseQuery(ctx context.Context, payload CloseQueryPayload) error
	// TerminateCluster terminates a running ksqlDB cluster
	TerminateCluster(ctx context.Context, payload TerminateClusterPayload) error
}

type CloseQueryPayload struct {
	QueryID string `json:"queryId"`
}

type CommandResult struct {

	// CommandID is the identified for the requested operation. You can use this ID to poll the result of the operation using the status endpoint.
	CommandID string `json:"commandId,omitempty"`
	// CommandStatus is the status of the requested operation.
	CommandStatus CommandStatus `json:"commandStatus,omitempty"`
	// contains filtered or unexported fields
}

type CommandStatus struct {
	// Status is one of QUEUED, PARSING, EXECUTING, TERMINATED, SUCCESS, or ERROR
	Status string `json:"status"`
	// Message regarding the status of the execution statement.
	Message string `json:"message"`
	// CommandSequenceNumber is the sequence number of the command, -1 if unsuccessful
	CommandSequenceNumber int64 `json:"commandSequenceNumber"`
}

type DescribeResult struct {

	// SourceDescription is a detailed description of the source (a STREAM or TABLE)
	SourceDescription SourceDescription `json:"sourceDescription,omitempty"`
	// contains filtered or unexported fields
}

type ExecPayload struct {
	// KSQL is a sequence of SQL statements. Anything is permitted except SELECT, for which you should use the Query method
	KSQL string `json:"ksql"`
	// StreamsProperties is a map of property overrides
	StreamsProperties StreamsProperties `json:"streamsProperties,omitempty"`
	// CommandSequenceNumber optionally waits until the specified sequence has been completed before running
	CommandSequenceNumber int64 `json:"commandSequenceNumber,omitempty"`
}

type ExecResult struct {

	// CREATE, DROP, TERMINATE
	*CommandResult

	// LIST STREAMS, SHOW STREAMS
	*ListStreamsResult

	// LIST TABLES, SHOW TABLES
	*ListTablesResult

	// LIST QUERIES, SHOW QUERIES
	*ListQueriesResult

	// LIST PROPERTIES, SHOW PROPERTIES
	*ListPropertiesResult

	// DESCRIBE
	*DescribeResult

	// EXPLAIN
	*ExplainResult
	// contains filtered or unexported fields
}

type ExplainResult struct {

	// QueryDescription is a detailed description of a query statement.
	QueryDescription QueryDescription `json:"queryDescription,omitempty"`
	// OverriddenProperties is a map of property overrides that the query is running with.
	OverriddenProperties map[string]interface{} `json:"overriddenProperties,omitempty"`
	// contains filtered or unexported fields
}

type Field struct {
	// The name of the field.
	Name string `json:"name"`
	// A schema object that describes the schema of the field.
	Schema Schema `json:"schema"`
}

type HealthcheckResult struct {
	IsHealthy bool `json:"isHealthy"`
	Details   struct {
		Metastore struct {
			IsHealthy bool `json:"isHealthy"`
		} `json:"metastore"`
		Kafka struct {
			IsHealthy bool `json:"isHealthy"`
		} `json:"kafka"`
	} `json:"details"`
}

type InfoResult map[string]interface{}

type InsertsStreamAck struct {
	Status string `json:"status"`
	Seq    int64  `json:"seq"`
}

type InsertsStreamCloser struct {
	// contains filtered or unexported fields
}

type InsertsStreamTargetPayload struct {
	Target string `json:"target"`
}

type InsertsStreamWriter struct {
	// contains filtered or unexported fields
}

type ListPropertiesResult struct {

	// Properties is the map of server query properties
	Properties map[string]string `json:"properties,omitempty"`
	// contains filtered or unexported fields
}

type ListQueriesResult struct {

	// Queries is the list of running queries
	Queries []Query `json:"queries,omitempty"`
	// contains filtered or unexported fields
}

type ListStreamsResult struct {

	// Streams is the list of streams returned
	Streams []Stream `json:"streams,omitempty"`
	// contains filtered or unexported fields
}

type ListTablesResult struct {

	// Tables is the list of tables returned
	Tables []Table `json:"tables,omitempty"`
	// contains filtered or unexported fields
}

type Option func(*ksqldb)

type Query struct {
	// QueryString is the text of the statement that started the query
	QueryString string `json:"queryString"`
	// Sinks are the streams and tables being written to by the query
	Sinks []string `json:"sinks"`
	// ID is the query id
	ID string `json:"id"`
}

type QueryConfig struct {
	Strategy          QueryStrategy
	StreamsProperties StreamsProperties
}

type QueryDescription struct {
	// StatementText is a ksqlDB statement for which the query being explained is running.
	StatementText string `json:"statementText"`
	// Fields is a list of field objects that describes each field in the query output.
	Fields []Field `json:"fields"`
	// Sources is a list of the stream and table names being read by the query.
	Sources []string `json:"sources"`
	// Sinks is a list of the stream and table names being written to by the query.
	Sinks []string `json:"sinks"`
	// ExecutionPlan is the query execution plan.
	ExecutionPlan string `json:"executionPlan"`
	// Topology is the Kafka Streams topology for the query that is running.
	Topology string `json:"topology"`
}

type QueryError struct {
	// contains filtered or unexported fields
}

type QueryPayload struct {
	// KSQL is SELECT statement
	KSQL string `json:"ksql"`
	// StreamsProperties is a map of property overrides
	StreamsProperties StreamsProperties `json:"streamsProperties,omitempty"`
}

type QueryResult struct {
	Row          Row    `json:"row"`
	ErrorMessage string `json:"errorMessage,omitempty"`
	FinalMessage string `json:"finalMessage,omitempty"`
}

type QueryResultHeader struct {
	// QueryID is a unique ID, provided for push queries only
	QueryID string `json:"queryID"`
	// ColumnNames is a list of column names
	ColumnNames []string `json:"columnNames"`
	// ColumnTypes is a list of the column types (e.g. 'BIGINT', 'STRING', 'BOOLEAN')
	ColumnTypes []string `json:"columnTypes"`
}

type QueryRows struct {
	// contains filtered or unexported fields
}

type QueryStrategy string

type QueryStreamPayload struct {
	// KSQL is the SELECT query to execute
	KSQL string `json:"sql"`
	// Properties is a map of optional properties for the query
	Properties map[string]string `json:"properties,omitempty"`
}

type QueryStreamRows struct {
	// contains filtered or unexported fields
}

type Result interface {
	// contains filtered or unexported methods
}

type Row struct {
	Columns []interface{} `json:"columns"`
}

type Rows interface {
	Columns() []string
	Close() error
	Next(dest []interface{}) error
}

type Schema struct {
	// The type the schema represents. One of INTEGER, BIGINT, BOOLEAN, DOUBLE, STRING, MAP, ARRAY, or STRUCT.
	Type string `json:"type"`
	// A schema object. For MAP and ARRAY types, contains the schema of the map values and array elements, respectively. For other types this field is not used and its value is undefined.
	MemberSchema map[string]interface{} `json:"memberSchema,omitempty"`
	// For STRUCT types, contains a list of field objects that describes each field within the struct. For other types this field is not used and its value is undefined.
	Fields []Field `json:"fields,omitempty"`
}

type SourceDescription struct {
	// Name of the stream or table.
	Name string `json:"name"`
	// ReadQueries is the list of queries reading from the stream or table.
	ReadQueries []Query `json:"readQueries"`
	// WriteQueries is the list of queries writing into the stream or table
	WriteQueries []Query `json:"writeQueries"`
	// Fields is a list of field objects that describes each field in the stream/table.
	Fields []Field `json:"fields"`
	// Type is either STREAM or TABLE.
	Type string `json:"type"`
	// Key is the name of the key column.
	Key string `json:"key"`
	// Timestamp is the name of the timestamp column.
	Timestamp string `json:"timestamp"`
	// Format is the serialization format of the data in the stream or table. One of JSON, AVRO, PROTOBUF, or DELIMITED.
	Format string `json:"format"`
	// Topic backing the stream or table.
	Topic string `json:"topic"`
	// Extended indicates if this is an extended description.
	Extended bool `json:"extended"`
	// Statistics about production and consumption to and from the backing topic (extended only).
	Statistics string `json:"statistics,omitempty"`
	// ErrorStats is a string about errors producing and consuming to and from the backing topic (extended only).
	ErrorStats string `json:"errorStats,omitempty"`
	// Replication factor of the backing topic (extended only).
	Replication int `json:"replication,omitempty"`
	// Partitions is the number of partitions in the backing topic (extended only).
	Partitions int `json:"partitions,omitempty"`
}

type Stream struct {
	// Name is the name of the stream
	Name string `json:"name"`
	// Topic is the associated Kafka topic
	Topic string `json:"topic"`
	// Format is the serialization format of the stream. One of JSON, AVRO, PROTOBUF, or DELIMITED.
	Format string `json:"format"`
	// Type is always 'STREAM'
	Type string `json:"type"`
}

type StreamsProperties map[string]string

type StreamsPropertiesOption func(StreamsProperties)

type Table struct {
	// Name of the table.
	Name string `json:"name"`
	// Topic backing the table.
	Topic string `json:"topic"`
	// The serialization format of the data in the table. One of JSON, AVRO, PROTOBUF, or DELIMITED.
	Format string `json:"format"`
	// The source type. Always returns 'TABLE'.
	Type string `json:"type"`
	// IsWindowed is true if the table provides windowed results; otherwise, false.
	IsWindowed bool `json:"isWindowed"`
}

type TerminateClusterPayload struct {
	// DeleteTopicList is an optional list of Kafka topics to delete
	DeleteTopicList []string `json:"deleteTopicList,omitempty"`
}

type Warning struct {
	Message string `json:"message"`
}