Striim 3.9.7 documentation

Console commands

If Striim is installed in /opt, the command to run the console is:

/opt/Striim/bin/console.sh -c <cluster name>

In Windows, if Striim is installed in c:\striim, the command to run the console is:

\striim\bin\console -c <cluster name>

Note

For the Windows command prompt, set the font to Consola, Lucida Console, or another monospace font that has box-drawing characters.

The following switches may be used:

-c <cluster name>: the name of the cluster to connect to (if omitted, will default to the current user name)

-f <path><file name>.tql: a TQL file containing commands to run when console starts (if not specified from root, path is relative to the Striim program directory)

-i <IP address>: the IP address of the Striim server to connect to

-p <password>: the password to use to log in (if omitted, you will be prompted after the console connects)

-u <user name>: the user to log in as (if omitted, you will be prompted after the console connects)

The following commands are intended primarily for use at the command line rather than in .tql application files. DDL and component reference and ad-hoc queries may also be entered at the command line.

@

@<path>/<file name>.tql;

Run the commands in the specified TQL file (typically all the commands required to create an application). If not specified from root, path is relative to the Striim program directory. Note that if the file contains DDL defining an application, the name will be defined by the CREATE APPLICATION statement, not the TQL file name.

DESCRIBE

DESCRIBE { APPLICATION | CQ | DG | FLOW | ROLE | SOURCE | STREAM | TARGET | TYPE | USER |
WACTIONSTORE | WINDOW } <namespace>.<object name>;

Returns all properties of the specified component, application, or flow. DESCRIBE CLUSTER; returns the cluster name, information about the metadata repository, and license details. 

DEPLOY

Deploys an application in the Created state. See Managing deployment groups.

EXPORT

See Reading a Kafka stream with an external Kafka consumer.

HISTORY

HISTORY;

Lists all commands previously entered in the current console session.

LIST

LIST { APPLICATIONS | CQS | DGS | FLOWS | ROLES | SOURCES | STREAMS | TARGETS | TYPES | 
USERS | WACTIONSTORES | WINDOWS };

Returns a list of all objects of the specified type.

LOAD / UNLOAD

See Loading standalone sources, caches, and WActionStores, Loading and importing a custom function, or Creating an open processor component.

MONITOR

See Using the MON command.

PREVIEW

PREVIEW <namespace>.<CQ name> { INPUT | OUTPUT | INPUTOUTPUT } [LIMIT <maximum number of events>]

Returns current input and/or output events for the specified CQ. If you do not specify value for LIMIT, the command will return a maximum of 1000 input events and/or 1000 output events.

Note

The CQ must be running before you execute the PREVIEW command.

Each event in the command's output includes:

  • Source: name of the component that emitted the event (either one of the components in the FROM clause of the CQ or the CQ itself)

  • IO: I for input or O for output

  • Action: added or removed

  • Server: name of the server executing the specified CQ

  • Data: the event payload

For example, the command PREVIEW Samples.PosData5Minutes inputoutput limit 1; will return something similar to:

Processing - preview samples.CsvToPosData inputoutput limit 1
Source:"Samples.CsvStream",IO:"I",Action:"added",Server:"S192_168_7_91",
Data:"[[COMPANY 366761, 9XGDirhiN2UPnJ9w5GqmISM2QXe1Coav3Fq, 0558659360821268472, 6, 
20130312174714, 0615, USD, 8.42, 8641415475152637, 61064, Polo], 
{FileOffset=0, RecordEnd=49798966, RecordOffset=49798836, FileName=posdata.csv, 
RecordStatus=VALID_RECORD}]"
Source:"Samples.CsvToPosData",IO:"O",Action:"added",Server:"S192_168_7_91",
Data:"[9XGDirhiN2UPnJ9w5GqmISM2QXe1Coav3Fq, 2013-03-12T17:47:14.000-07:00, 17, 8.42, 61064];"

QUIESCE

QUIESCE <application name>;
  1. Pauses all sources.

  2. Flushes out all data in process. This can result in partial batches of events, such as a 100-event window emitting a batch of only 20 events, or a five-minute window emitting a one-minute batch, which may result in functions such as COUNT and SUM returning anomalous results outside of the normal range. Pattern matching CQs may also return anomalous results.

  3. After all data is flushed, records all information required for recovery, if it is enabled (see Recovering applications).

  4. Stops the application.

The primary uses for QUIESCE are to flush out remaining data at the end of a data set and to create a recovery checkpoint with no data in process prior to using ALTER on an application with recovery enabled (see ALTER and RECOMPILE).

Due to long-running open transactions, OracleReader may be unable to pause, in which case the application and all its sources will resume as if the QUIESCE command had not been issued.

To support QUIESCE with OracleReader, see Creating the quiescemarker table.

REPORT

Seee Using the REPORT START / STOP command.

RESUME

When an application is in the CRASHED state and the condition that caused it to crash has been corrected, RESUME <application name>; will attempt to resume operation from the point where the application crashed.

SELECT

Queries a WActionStore. See Browsing data with ad-hoc queries.

SHOW

SHOW <stream name>;

Returns the output of a stream. Press Ctrl-D to end.

SHOW <source or target name> LINEAGE
 [LIMIT <count>] 
 [-status '{CREATED|COMPLETED|CRASHED}']
  [-start  'yyyy-mm-dd']
  [-end  'yyyy-mm-dd']
 [{ASC|DESC}];

For file-based readers and writers, returns a list of files read or created. For example:

Screen_Shot_2017-11-27_at_10_50_45_AM.png

By default, the most recent ten files are listed. You can change that number by adding the LIMIT option to the command: for example, LIMIT 25. To see the oldest files instead of the newest, add the DESC option. Use the -status-start, and/or -end options to show only a specified subset of the files.

For OracleReader see File lineage in Oracle.

By default, this feature is disabled. See Enabling file lineage.

With OracleReader, SHOW can also be used for Viewing open transactions.

START

START <application name>;

Starts the application.

STATUS

STATUS <application name>;

Returns the status of the specified application:

  • CRASH

  • CREATED: ready to deploy

  • DEPLOYED: ready to start or undeploy (previous status was DEPLOYING)

  • DEPLOYING: transitional state between CREATED and DEPLOYED

  • NOT ENOUGH SERVERS: see CREATE DG (deployment group)

  • QUIESCED

  • QUIESCING: transitional state between RUNNING and QUIESCED

  • RECOVERING SOURCES: see Recovering applications

  • RUNNING

  • STARTING: transitional state between DEPLOYED and RUNNING

  • STARTING SOURCES: application has started but sources are not running yet

  • STOPPED: ready to start or undeploy (previous status was STOPPING)

  • STOPPING: transitional state between RUNNING and STOPPED

STOP

STOP <application name>;

Stops a running application and, if recovery is enabled, writes recovery checkpoints. If recovery is enabled and  the application was not dropped after it was stopped, recoverable sources will restart from the point immediately after the last written events (see Recovering applications). If recovery is not enabled, any data currently being processed will be lost.

The Stop command is also available when an application is in the Starting state. This can be useful when an application is stuck in the Starting state and you want to stop and debug it rather than waiting for it to time out and revert to the Deployed state.

UNDEPLOY

Undeploys a deployed application. See Managing deployment groups.

The Undeploy command is also available when an application is in the Deploying state. This can be useful when an application is stuck in the Deploying state and you want to stop and debug it rather than waiting for it to time out and revert to the Created state.

UNLOAD

See LOAD / UNLOAD, above.

USAGE

USAGE [<application name>];

Lists sources and how much total data each has acquired. If you do not specify an application name, USAGE; lists all sources for all applications.