Skip to content

Bots From Extension: nats

NATS Messaging - Stream and Write data to a NATS Subject

This extension provides 4 bots.





Bot @nats:read-stream

Bot Position In Pipeline: Source

Read messages from a specified NATS Subject

This bot expects a Restricted CFXQL.

Each parameter may be specified using '=' operator and AND logical operation
Following are the parameters expected for this Bot

Parameter Name Type Default Value Description
subject* Text NATS subject in dotted format
max_messages Text 0 If max_messages is > 0, will terminate the stream after max_messages have been received
max_wait_time Text 0 Max wait time in seconds. If specified, will terminate the stream after max_wait_time seconds
have elapsed
group Text NATS queue group name. If specified, must be a valid group name without any spaces.
data_mode Text text Data mode. 'text' or 'bytes' or json'. If specified as 'text', will return raw text content
of each message. If type is 'json' each message is expected to a JSON object







Bot @nats:requests

Bot Position In Pipeline: Sink

Write each row as a request, with subject and data columns to NATS. Output response in a 'response' column

This bot expects a Restricted CFXQL.

Each parameter may be specified using '=' operator and AND logical operation
Following are the parameters expected for this Bot

Parameter Name Type Default Value Description
subject_column Text subject NATS subject column name in the input dataframe
data_column Text data Data column name in the input dataframe
response_column Text response Output response column
timeout Text 10.0 Timeout in seconds







Bot @nats:write-stream-data

Bot Position In Pipeline: Sink

Write each row as a message, with subject and data columns to NATS

This bot expects a Restricted CFXQL.

Each parameter may be specified using '=' operator and AND logical operation
Following are the parameters expected for this Bot

Parameter Name Type Default Value Description
subject_column Text subject NATS subject column name in the input dataframe
data_column Text data Data column name in the input dataframe







Bot @nats:write-stream-json

Bot Position In Pipeline: Sink

Write input dataframe as messages to a specified NATS Subject. Each row is encoded as a JSON object

This bot expects a Restricted CFXQL.

Each parameter may be specified using '=' operator and AND logical operation
Following are the parameters expected for this Bot

Parameter Name Type Default Value Description
subject* Text NATS subject in dotted format