Adapter for Apache Kafka 9.6 | webMethods Adapter for Apache Kafka Documentation | webMethods Adapter for Apache Kafka Installation and User’s Documentation | Built-In Services | wm.adapter.wmkafka.ksql.admin:create
 
wm.adapter.wmkafka.ksql.admin:create
The wm.adapter.wmkafka.ksql.admin:create allows the user to create a stream or a table with the specified columns from an underlying Kafka topic.
Input Parameters
$connectionName(string)
Name of the KSQL connection.
type(string)
Type of source: STREAM or TABLE.
name(string)
Name of the stream or table to be created.
topic(string)
Name of the Kafka topic that supports the source. The topic must exist in Kafka.
messageFormat(string)
Specifies the serialization format of the message value in the topic. Supported formats are JSON, DELIMITED (comma-separated value), and AVRO.
windowType(string)
By default, the topic is assumed to contain non-windowed data.
If the data is windowed, that is, if the data is created using KSQL query, that contains a WINDOW clause. use thewindowType property to provide the type of window. Valid values are SESSION, HOPPING, and TUMBLING.
columns(document)
List of columns(name and type) present in stream or table.
keyColumn(string)
Determines if repartitioning can be avoided when performing aggregations and joins.
Note:
Do not set the KEY property, unless you have validated that your stream does not need to be repartitioned for the future joins. If you set the KEY property and your record key does not meet partitioning requirements, you will need to repartition explicitly.
timestampColumn(string)
Overrides the ROWTIME with the contents of the specified field or column within the Kafka message value (similar to timestamp extractors in Kafka's Streams API).
By default, the implicit ROWTIME column is the timestamp of the message in Kafka topic. Timestamps have a millisecond accuracy. Time-based operations, such as windowing, will process a record according to the timestamp in ROWTIME.
timestampFormat(string)
Used in conjunction with timestampColumn.
If this parameter is set, the TIMESTAMP field must be of type varchar and have a format that can be parsed with the Java DateTimeFormatter. If your timestamp format has characters requiring single quotes, you can escape them with successive single quotes, '', for example: 'yyyy-MM-dd''T''HH:mm:ssX'.
If the value is not set, timestampFormat will assume that the TIMESTAMP field is a BIGINT.
Output Parameter
The resulting output documents consists of the following fields:
commandId(string)
Identifies the requested operation. You can use this ID to poll the result of the operation using the status endpoint.
commandStatus.status(string)
QUEUED, PARSING, EXECUTING, TERMINATED, SUCCESS, or ERROR.
commandStatus.message(string)
Provides a detailed message regarding the status of the execution statement.
commandSequenceNumber(string)
Indicates the sequence number of the requested operation in the command queue, or -1 if the operation was unsuccessful.