evtctxlist

Retrieves the list of event contexts stored in the in-memory store. You can filter by topic.

Command properties

Item	Description
Command type	Driver query
Required permission	None
License usage	Not counted
Parallel execution	Not supported
Distributed execution	Not supported

Syntax

evtctxlist [topic=STR]

Options

topic=STR: Topic name of the event contexts to retrieve. When specified, retrieves only event contexts for that topic. If not specified, retrieves all event contexts.

Output fields

Field	Type	Description
`topic`	string	Event topic name
`key`	string	Event context key
`host`	string	External clock host name. Null if not set.
`counter`	integer	Cumulative number of events matched to the event context
`created`	timestamp	Event context creation time
`expire_at`	timestamp	Scheduled expiration time. Null if no expiration time is set.
`timeout_at`	timestamp	Scheduled timeout time. Null if no timeout is set.
`maxrows`	integer	Maximum number of rows that can be stored in the event context
`vars`	object	List of variables set in the event context
`rows`	array	List of rows stored in the event context

Error codes

Parse errors

N/A

Runtime errors

N/A

Description

The evtctxlist command retrieves event contexts stored in the in-memory store and outputs the topic, key, counter, creation time, expiration and timeout information, variables, and stored rows for each event context. Use this command to check the status of event contexts created by the evtctxadd command.

Event contexts are retrieved in batches of 5,000 records.

Examples

Retrieve all event contexts
```
evtctxlist
```
Retrieves all event contexts stored in the in-memory store.
Retrieve event contexts for a specific topic
```
evtctxlist topic=login_fail
```
Retrieves only event contexts for the login_fail topic.
Count event contexts by topic
```
evtctxlist | stats count by topic
```
Counts the number of event contexts per topic.