.. _step-ReadFromCache:


ReadFromCache
=============

Step reads data from cache using save_key, sets the returned data for next step.

.. versionadded:: 1.0.0

* **Friendly name:** ``Cache Read``
* **Step class:** ``base_steps_syncpack.steps.ReadFromCache.ReadFromCache``
* **Step version:** ``1.4.0``
* **Required parameters:** ``save_key``, ``lookup_type``

Parameters
----------

.. list-table::
   :header-rows: 1
   :widths: 22 16 8 16 38

   * - Name
     - Type
     - Required
     - Default
     - Description
   * - ``save_key``
     - string
     - yes
     - --
     - The key with which to read from the cache Example: ``keyA``
   * - ``lookup_type``
     - enum
     - yes
     - ``like``
     - How to perform the search from cache. Can either be 'equals', or 'like'
   * - ``merge_results``
     - boolean
     - no
     - ``True``
     - Try to combine the results into a single list
   * - ``default_value``
     - string
     - no
     - --
     - Value to return if None Example: ``True``

Every step also accepts the platform parameters common to all steps --
see :ref:`platform-parameters`.

Dependencies
------------

* **Inherits from:** ``ReadFromCache`` -> ``BaseStep`` -> ``Serializable``
* **External packages:** ``couchbase``, ``ipaascommon``, ``ipaascore``, ``isbaseutils``

.. include:: /_step_notes/ReadFromCache.rst

API
---

.. autoclass:: base_steps_syncpack.steps.ReadFromCache.ReadFromCache
   :members:
   :show-inheritance: