epicsarchiver.write.export_format

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

Classes

Format

Supported machine-readable output formats for the export command.

Functions

write_events(→ None)

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

Module Contents

class epicsarchiver.write.export_format.Format(*args, **kwds)[source]

Bases: enum.Enum

Supported machine-readable output formats for the export command.

JSON[source]
CSV[source]
ARROW[source]
PARQUET[source]
PB[source]
epicsarchiver.write.export_format.write_events(dest: IO[Any], fmt: Format, events: list[epicsarchiver.retrieval.archive_event.ArchiveEvent], meta: dict[int, epicsarchiver.retrieval.archive_event.ArchiveEventsMeta] | None) → None[source]

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

Parameters:

  • dest – Binary destination to write to.

  • fmt – Output format (JSON, CSV, ARROW, or PARQUET).

  • events – Events to write.

  • meta – Optional per-year metadata.

Raises:

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