Key-Value Store Component

Stores in RAM memory pairs of key-value data obtained either from Series or any other component. With the combination of another Key-Value Store it can perform an aggregation operations. See: Query Operations section.

To create a Key-Value Store component, right-click the DataStructures section in the system tree and select Add Key-Value Store.

All the data stored in Key-Value Store is not persistent and will disappear after unloading the system.

Properties for a Key-Value Store component are listed below in each of the sections, and include a description of how the component can be used and/or some of the possible values for each property.

Key-Value Store Name - Specifies the unique name of a Key-Value Store component.

Enabled - Specifies if the component will repond to any called actions and produce events.

Allow Repeated Keys - Specifies if per every Key-Value pair the keys should be unique for this component. If this setting is set to False, no repeating Key values are allowed. When inserting new Key-Value pair if a given Key exists the existing Value will be updated.

Series Auto Update - If a Series is attached as a source to this component, this value needs to be True in order to automatically send all the new values to the series. Only inserts are being propagated, NOT: updates, deletes.

Component - Specifies whether the component is attached as a source to another component. See section Relations for more information.

Information about all the insert\delete\update actions performed on the component.

Description - Specifies a user-defined description for the associated component. For example, use this property to describe the purpose of the component, when the component was created, who created the component, and so forth.

Referenced By - Specifies all of the components that reference (or use) this component. Components shown in a lighter shade are disabled. To create a new associated Event or Action, select from the items shown from the drop-down buttons on the right.

Double-click an entry to navigate directly to the related component. Right-click to enable/disable the selected component

Create an action and call ItemInsert(Key, Value). If you use the function ItemInsert(Value) the Key will be generated automatically.

Any row that will be added to Series0 will be automatically pushed to Key-Value_Store-0. In the Mapping table you can choose which field of the series is mapped to key and/or value. The repeating keys are updating the corresponding values automatically if Allow Repeated Keys is set to False.

In the similar manner you can attach to any other component, except other Key-Value Store.

Attaching to another Key-Value Store as a parent will not copy any data between two components. Please refer to Query Operations section for urther information.

In the first example the Key-Value Store is attached to the properties of TCP Server. Those are the properties we could see when we are attaching TCP Server to fields' of a Series.

In the second example the Key-Value Store is attached in the similar fasion to the properties of the HTTP Server.

If one Key-Value Store is attached to another one, the second one (in this case Key-Value_store-Aggregate) is not storing any values itself. After calling function Key-Value_store-Aggregate.CopyToSeries() a specified aggregation operation is being executed on attached Key-Value Store (in this case Key-Value_Store-0) and proper set of Key-Value pair are send to an attached series.
To build the full scenario the following steps must be fulfilled:

In the following example trigger all the actions manually and observe the contents of the series ResultSeries.
All the steps are depicted on the screenshots below and the example system can be downloaded here.

Key-Value Store Component

See Also