epicsarchiver.retrieval.command
===============================

.. py:module:: epicsarchiver.retrieval.command

.. autoapi-nested-parse::

   Command module.



Attributes
----------

.. autoapisummary::

   epicsarchiver.retrieval.command.LOG
   epicsarchiver.retrieval.command.DATE_FORMATS
   epicsarchiver.retrieval.command.AlignedPVEvents


Functions
---------

.. autoapisummary::

   epicsarchiver.retrieval.command.get
   epicsarchiver.retrieval.command._table_title
   epicsarchiver.retrieval.command._create_multi_table
   epicsarchiver.retrieval.command._to_local_timestamp_str
   epicsarchiver.retrieval.command._val_to_str
   epicsarchiver.retrieval.command._create_singular_table
   epicsarchiver.retrieval.command._align_events
   epicsarchiver.retrieval.command._fetch_events


Module Contents
---------------

.. py:data:: LOG
   :type:  logging.Logger

.. py:data:: DATE_FORMATS
   :value: ['%Y-%m-%d', '%Y-%m-%dT%H:%M:%S', '%Y-%m-%d %H:%M:%S', '%Y-%m-%dT%H:%M:%S.%f', '%Y-%m-%d %H:%M:%S.%f']


.. py:data:: AlignedPVEvents

.. py:function:: get(ctx: click.core.Context, pvs: tuple[str], start: datetime.datetime, end: datetime.datetime, processor_name: str | None, bin_size: int | None, debug: bool) -> None

   Print out data from an archiver cluster.

   ARGUMENT pvs What pvs to get data of.

   Example usage:

   .. code-block:: console

       epicsarchiver --hostname archiver-01.example.com get PV_NAME1 PV_NAME2



.. py:function:: _table_title(pvs: tuple[str], start: datetime.datetime, end: datetime.datetime, processor: epicsarchiver.retrieval.archiver_retrieval.processor.Processor | None) -> str

.. py:function:: _create_multi_table(pvs: tuple[str], title: str, events: AlignedPVEvents) -> rich.table.Table

.. py:function:: _to_local_timestamp_str(timestamp: pandas.Timestamp) -> str

.. py:function:: _val_to_str(event: epicsarchiver.retrieval.archive_event.ArchiveEvent | None) -> str

.. py:function:: _create_singular_table(pv: str, title: str, events: AlignedPVEvents) -> rich.table.Table

.. py:function:: _align_events(all_events: dict[str, list[epicsarchiver.retrieval.archive_event.ArchiveEvent]]) -> AlignedPVEvents

   Align events from multiple PVs by timestamp.

   :param all_events: Events per PV with PV name as key
   :type all_events: dict[str, list[ArchiveEvent]]

   :returns: List of pairs, (timestamp, dict[pv_name, pv_value])
   :rtype: AlignedPVEvents


.. py:function:: _fetch_events(archiver: epicsarchiver.epicsarchiver.ArchiverAppliance, pvs: list[str], start: datetime.datetime, end: datetime.datetime, processor: epicsarchiver.retrieval.archiver_retrieval.processor.Processor | None) -> AlignedPVEvents
   :async: