Property Detail

• static final java.lang.String KSQLREGEX

  Class for interacting and normalizing behavior using the Confluent KSQL RESTful API.

• java.lang.String password

  The password for basic authentication for the KSQL server. If unspecified, Basic Authentication credentials are not provided.

• java.lang.String restUrl

  The base REST endpoint for the KSQL server. Defaults to 'http://localhost:8088', which is handy when developing against Confluent CLI.

• java.lang.String username

  The username for basic authentication for the KSQL server. If unspecified, Basic Authentication credentials are not provided.

Method Detail

• java.lang.Object createKsql(java.lang.String ksql, java.util.Map properties)

  Executes a KSQL statement using the KSQL RESTful API. Optimized for issuing CREATE TABLE/STREAM statements.

  Parameters:

  ksql - the KSQL statement to execute.

  properties - Any KSQL parameters to include with the KSQL execution.

  Returns:

  Map with meaningful elements returned in the REST call, plus a 'body' key with the full JSON payload.

• java.lang.Object createKsql(java.util.List ksql, java.util.Map properties)

  Executes a List of KSQL statements using the KSQL RESTful API. Optimized for issuing CREATE TABLE/STREAM statements.

  Parameters:

  ksql - the List of KSQL statements to execute.

  properties - Any KSQL parameters to include with the KSQL execution.

  Returns:

  Map with meaningful elements from the JSON payload elevated as attributes, plus a 'body' key will the full JSON payload.

• java.lang.Object createKsql(java.lang.String ksql, java.lang.Boolean earliest = false)

  Executes a KSQL statement using the KSQL RESTful API. Optimized for issuing CREATE TABLE/STREAM statements.

  Parameters:

  ksql - The KSQL statement to execute.

  earliest - Boolean dictating that the statement should set 'auto.offset.reset' to 'earliest'.

  Returns:

  Map with meaningful elements from the JSON payload elevated as attributes, plus a 'body' key will the full JSON payload.

• java.lang.Object createKsql(java.util.List ksql, java.lang.Boolean earliest = false)

  Executes a List of KSQL statements using the KSQL RESTful API. Optimized for issuing CREATE TABLE/STREAM statements.

  Parameters:

  ksql - the List of KSQL statements to execute.

  earliest - Boolean dictating that the statement should set 'auto.offset.reset' to 'earliest'.

  Returns:

  Map with meaningful elements from the JSON payload elevated as attributes, plus a 'body' key will the full JSON payload.

• java.lang.Object dropKsql(java.lang.String ksql, java.util.Map properties)

  Executes a KSQL DROP statement using the KSQL RESTful API. Manages issuing TERMINATE statements as part of the DROP, if desired.

  Parameters:

  ksql - the KSQL DROP statement to execute.

  properties - Any KSQL parameters to include with the KSQL execution.

  Returns:

  Map with meaningful elements from the JSON payload elevated as attributes, plus a 'body' key with the full JSON payload.

• java.lang.Object execKsql(java.lang.String ksql, java.util.Map properties)

  Executes a KSQL statement using the KSQL RESTful API.

  Parameters:

  ksql - the KSQL statement to execute.

  properties - Any KSQL parameters to include with the KSQL execution.

  Returns:

  Map with meaningful elements returned in the REST call, plus a 'body' key with the full JSON payload.

• java.lang.Object execKsql(java.util.List ksql, java.util.Map properties)

  Executes a List of KSQL statements using the KSQL RESTful API.

  Parameters:

  ksql - the List of KSQL statements to execute.

  properties - Any KSQL parameters to include with the KSQL execution.

  Returns:

  Map with meaningful elements from the JSON payload elevated as attributes, plus a 'body' key will the full JSON payload.

• java.lang.Object execKsql(java.lang.String ksql, java.lang.Boolean earliest = false)

  Executes a KSQL statement using the KSQL RESTful API.

  Parameters:

  ksql - The KSQL statement to execute.

  earliest - Boolean dictating that the statement should set 'auto.offset.reset' to 'earliest'.

  Returns:

  Map with meaningful elements from the JSON payload elevated as attributes, plus a 'body' key will the full JSON payload.

• java.lang.Object execKsql(java.util.List ksql, java.lang.Boolean earliest = false)

  Executes a List of KSQL statements using the KSQL RESTful API.

  Parameters:

  ksql - the List of KSQL statements to execute.

  earliest - Boolean dictating that the statement should set 'auto.offset.reset' to 'earliest'.

  Returns:

  Map with meaningful elements from the JSON payload elevated as attributes, plus a 'body' key will the full JSON payload.

• java.io.File getExtensionDir()

  Returns File object for the KSQL Server property value for 'ksql.extension.dir'.

  Returns:

  File object for the KSQL Server property value for 'ksql.extension.dir'.

• java.lang.String getExtensionPath()

  Returns KSQL Server property value for 'ksql.extension.dir'.

  Returns:

  KSQL Server property value for 'ksql.extension.dir'.

• java.lang.String getObjectName(java.lang.String sql)

  Returns the object type from a KSQL CREATE or DROP statement.

  Returns:

  Either 'table' or 'stream' or 'into' (the latter denotes it was an INSERT statement).

• java.lang.Object getProperties()

  Returns KSQL Server properties from the KSQL RESTful API using the 'LIST PROPERTIES' sql statement.

  Returns:

  All the KSQL properties. This is a helper method, used to return individual properties in other methods such as getExtensionPath and getSchemaRegistry.

• java.lang.String getProperty(java.lang.String property)

  Returns an individual KSQL server property using getProperties. This is a helper method, used to return individual properties in other methods such as getExtensionPath and getSchemaRegistry.

  Parameters:

  property - The individual property to return a value for.

  Returns:

  The value of the property specified in the 'property' parameter.

• java.lang.Object getQueryIds(java.lang.String object)

  Returns KSQL Server query IDs for all 'writeQueries' and 'readQueries' associated with a particular object.

  Returns:

  List of query IDs associated with a particular object.

• java.lang.Object getReadQueries(java.lang.String object)

  Returns KSQL Server 'readQueries' object, detailing all the queries currently reading a particular table or stream.

  Returns:

  readQueries object, generated by the KSQL 'DESCRIBE' command.

• java.lang.String getSchemaRegistry()

  Returns the KSQL Server property value for 'ksql.schema.registry.url'.

  Returns:

  The KSQL Server property value for 'ksql.schema.registry.url'.

• java.lang.Object getSourceDescription(java.lang.String object)

  Returns KSQL Server 'sourceDescription' object, containing the results of the 'DESCRIBE' command.

  Returns:

  sourceDescription object, generated by the KSQL 'DESCRIBE' command.

• java.lang.String getStatementType(java.lang.String sql)

  Returns the statement type from a KSQL CREATE or DROP statement.

  Returns:

  Either 'create' or 'drop' or 'insert'

• java.lang.Object getStreams()

  Return a list of stream objects

  Returns:

  List of KSQL stream objects

• java.lang.Object getTopics()

  Return a list of topic objects

  Returns:

  List of topic objects

• java.lang.Object getWriteQueries(java.lang.String object)

  Returns KSQL Server 'writeQueries' object, detailing all the queries currently writing to a particular table or stream.

  Returns:

  writeQueries object, generated by the KSQL 'DESCRIBE' command.