epadmin-adapter

epadmin-adapter target — Manages StreamBase embedded adapters.

SYNOPSIS

epadmin [globalparameters] command adapter [commandparameters]

DESCRIPTION

Use the adapter target to see information about adapters in a currently running EventFlow module, and to manage the state of adapters with stop, start, suspend, and resume commands. You can use these commands interactively during development of EventFlow modules and for administration purposes, but a production application is more likely to use the cluster awareness feature to start and stop adapters based on runtime conditions among nodes in the cluster.

The adapter target has five commands, each using the same command parameters:

The designation [sn|ad] in syntax examples is a reminder that this command requires either the global parameter ‑‑servicename or the ‑‑adminport and ‑‑hostname combination to identify the node or cluster of interest.

epadmin display adapter

Displays general information about adapters running in the current module and to confirm their current status. You can use the display command before and after one of the other adapter commands to confirm the success of the operation. For example: 

epadmin [sn|ad] display adapter --path=CSVWriter
Engine = com_tibco_sb_sample_adapter_csvwriter_CSVWriterTest0
Path = default.CSVWriter
Status = STARTED                                  <==
Adapter = TIBCO StreamBase CSV File Writer
Cluster Aware = Start with module

epadmin [sn|ad] suspend adapter --path=CSVWriter
epadmin [sn|ad] display adapter --path=CSVWriter
Engine = com_tibco_sb_sample_adapter_csvwriter_CSVWriterTest0
Path = default.CSVWriter
Status = SUSPENDED                                <==
Adapter = TIBCO StreamBase CSV File Writer
Cluster Aware = Start with module

epadmin [sn|ad] resume adapter --path=CSVWriter
epadmin [sn|ad] display adapter --path=CSVWriter
Engine = com_tibco_sb_sample_adapter_csvwriter_CSVWriterTest0
Path = default.CSVWriter
Status = STARTED                                  <==
Adapter = TIBCO StreamBase CSV File Writer
Cluster Aware = Start with module

epadmin stop adapter

You can safely compel many StreamBase adapters to be stop processing tuples, independent of their containing EventFlow module, which can be useful in administration or HA contexts. Confirm with the adapter's documentation whether it can be safely stopped. Use the --path option with this command to directly address the adapter of interest using StreamBase path notation, to avoid inadvertently stopping all adapters in a module. 

epadmin [sn|ad] stop adapter --path=CSVWriter

epadmin start adapter

If you stopped an adapter instance with stop adapter, you can restart it with epadmin start adapter. Confirm with the adapter's documentation what happens to incoming or outgoing data on restart. 

epadmin [sn|ad] start adapter --path=CSVWriter

epadmin suspend adapter

You can safely compel many StreamBase adapters to suspend processing, independent of their containing EventFlow module. Confirm with the adapter's documentation whether it can be suspended, and to learn whether tuples are queued or dropped during the adapter's suspended state. Use the --path option with this command to directly address the adapter of interest, to avoid inadvertently suspending all adapters in a module. 

epadmin [sn|ad] suspend adapter --path=CSVWriter

epadmin resume adapter

If you suspended an adapter instance with suspend adapter, you can restart it with epadmin resume adapter. In addition, many StreamBase adapters can be configured to suspend on startup of the containing EventFlow module to allow time for a connection to be established with an incoming or outgoing data feed, or to allow only one adapter at a time in an HA cluster to communicate with an external data source or sink. Confirm with the adapter's documentation what happens to incoming or outgoing data on resume. 

epadmin [sn|ad] resume adapter --path=CSVWriter

OPTIONS

Command Parameter Description Required Default
engine Restricts the command to the named engine. ‑‑engine=firstjvm No Operates on all adapters in all engines in the current node.
path Restricts the command to the adapter named in the provided StreamBase path. ‑‑path=default.submodule.cooladapter No Operates on all adapters at all paths in the current node.

SEE ALSO

Help System for epadmin
epadmin(1)
epadmin-globals(1)