Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions docs/source/actions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -543,6 +543,32 @@ For example:
else:
self.logger.error('Action failed...')

Datastore
~~~~~~~~~

Actions can utilize the datastore to store data between executions.

The datastore service provides the same methods available on the sensor service.
More detail can be found in the :ref:`sensor datastore management documentation<ref-sensors-datastore-management-operations>`.

Example storing a dict as JSON:

.. sourcecode:: python

def run(self):
data = {'somedata': 'foobar'}

# Add a value to the datastore
self.datastore.set_value(name='cache', value=json.dumps(data))

# Retrieve a value
value = self.datastore.get_value('cache')
retrieved_data = json.loads(value)

# Delete a value
self.datastore.delete_value('cache')


Pre-defined actions
^^^^^^^^^^^^^^^^^^^

Expand Down
2 changes: 2 additions & 0 deletions docs/source/sensors.rst
Original file line number Diff line number Diff line change
Expand Up @@ -116,6 +116,8 @@ For example:
self._logger = self._sensor_service.get_logger(name=self.__class__.__name__)
self._logger.debug('Polling 3rd party system for information')

.. _ref-sensors-datastore-management-operations:

Datastore management operations
-------------------------------

Expand Down