epicsarchiver.write.export_format
=================================

.. py:module:: epicsarchiver.write.export_format

.. autoapi-nested-parse::

   Export format writers for machine-readable output of archived events.



Classes
-------

.. autoapisummary::

   epicsarchiver.write.export_format.Format


Functions
---------

.. autoapisummary::

   epicsarchiver.write.export_format.write_events


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

.. py:class:: Format(*args, **kwds)

   Bases: :py:obj:`enum.Enum`


   Supported machine-readable output formats for the export command.


   .. py:attribute:: JSON


   .. py:attribute:: CSV


   .. py:attribute:: ARROW


   .. py:attribute:: PARQUET


   .. py:attribute:: PB


.. py:function:: write_events(dest: IO[Any], fmt: Format, events: list[epicsarchiver.retrieval.archive_event.ArchiveEvent], meta: dict[int, epicsarchiver.retrieval.archive_event.ArchiveEventsMeta] | None) -> None

   Write events to dest in the given format. Requires the [polars] extra.

   :param dest: Binary destination to write to.
   :param fmt: Output format (JSON, CSV, ARROW, or PARQUET).
   :param events: Events to write.
   :param meta: Optional per-year metadata.

   :raises ValueError: If fmt is not a supported event format (e.g. PB).