Configuring the key-value store
These settings are optional.
If you don’t need the features offered by Butler’s key-value store, just disable it and leave the default values in the config as they are.
Do note though that Butler expects the configuration properties below to exist in the config file, but will ignore their values if the related features are disabled.
The key-value has several use cases:
- Pass parameters between apps in a reload chain
- Share state or other data between app reloads
- Share state between extensions, mashups or other web apps.
- Store data with a time-to-live property. Can be used to create timeouts in app reload chains.,
How it works
The data in the key-value store is not persisted to disk, which means that key-value data will be lost if Butler is restarted.
This behaviour could possibly changed if there is a need, please open a GitHub ticket if key-value persistence is of interest.
Key-value data is manipulated using Butler’s REST API.
The Reference docs section has more information about the key-value store.
Settings in main config file
--- Butler: ... ... # Key-value store keyValueStore: enable: false # Should Butler's key-value store be enabled? maxKeysPerNamespace: 1000 # Max keys that can be stored per namespace. Defaults to 1000 if not specified in this file. ... ...
Was this page helpful?
Glad to hear it! Please tell us how we can improve.
Sorry to hear that. Please tell us how we can improve.