Command Line Examples
Get Interface
!arch-retrieval get --help
Usage: arch-retrieval get [OPTIONS] PVS...
Print out data from an archiver cluster as a table.
ARGUMENT pvs What pvs to get data of.
Example usage:
.. code-block:: console
arch-retrieval --hostname archiver-01.example.com get PV_NAME1 PV_NAME2
Options:
--debug Turn on debug logging
-s, --start [%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]
Start time of query [default: 30 seconds
ago]
-e, --end [%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]
End time of query, [default: now]
-p, --processor-name [firstsample|lastsample|firstfill|lastfill|mean|min|max|count|ncount|nth|median|std|jitter|ignoreflyers|flyers|variance|popvariance|kurtosis|skewness|linear|loess|optimized|optimlastsample|caplotbinning|deadband|errorbar]
PreProcessor to use
Docs at https://epicsarchiver.readthedocs.io/en/latest/user/userguide.html#processing-of-data
-b, --bin-size INTEGER Bin size (mostly in seconds) for
preprocessor.
--help Show this message and exit.
!arch-retrieval --hostname localhost get EXAMPLE:TEMPERATURE
EXAMPLE:TEMPERATURE Period 2026-06-04 13:31:09 - 2026-06-04 13:31:39
┏━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━┳━━━━━━━━┳━━━━━━━━━━┓
┃ PV ┃ Time ┃ Value ┃ Status ┃ Severity ┃
┡━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━╇━━━━━━━━╇━━━━━━━━━━┩
│ EXAMPLE:TEMPERAT… │ 2026-04-11 │ 28.0 │ 4 │ 1 │
│ │ 00:00:00+00:00 │ │ │ │
│ EXAMPLE:TEMPERAT… │ 2026-04-11 │ 28.1947091711543… │ 4 │ 1 │
│ │ 00:00:10.841470… │ │ │ │
│ EXAMPLE:TEMPERAT… │ 2026-04-11 │ 28.35867804544976 │ 4 │ 1 │
│ │ 00:00:20.909297… │ │ │ │
│ EXAMPLE:TEMPERAT… │ 2026-04-11 │ 28.4660195429836… │ 4 │ 1 │
│ │ 00:00:30.141120… │ │ │ │
│ EXAMPLE:TEMPERAT… │ 2026-04-11 │ 28.4997868015207… │ 4 │ 1 │
│ │ 00:00:40.756802… │ │ │ │
│ EXAMPLE:TEMPERAT… │ 2026-04-11 │ 28.45464871341284 │ 4 │ 1 │
│ │ 00:00:50.958924… │ │ │ │
│ EXAMPLE:TEMPERAT… │ 2026-04-11 │ 28.3377315902755… │ 4 │ 1 │
│ │ 00:01:00.279415… │ │ │ │
│ EXAMPLE:TEMPERAT… │ 2026-04-11 │ 28.1674940750779… │ 4 │ 1 │
│ │ 00:01:10.656986… │ │ │ │
│ EXAMPLE:TEMPERAT… │ 2026-04-11 │ 27.97081292828621 │ 4 │ 1 │
│ │ 00:01:20.989358… │ │ │ │
│ EXAMPLE:TEMPERAT… │ 2026-04-11 │ 27.7787397783525… │ 4 │ 1 │
│ │ 00:01:30.412118… │ │ │ │
│ EXAMPLE:TEMPERAT… │ 2026-04-11 │ 27.6215987523460… │ 4 │ 1 │
│ │ 00:01:40.544021… │ │ │ │
│ EXAMPLE:TEMPERAT… │ 2026-04-11 │ 27.52419896305524 │ 4 │ 1 │
│ │ 00:01:50.999990… │ │ │ │
│ EXAMPLE:TEMPERAT… │ 2026-04-11 │ 27.50191769558208 │ 4 │ 1 │
│ │ 00:02:00.536572… │ │ │ │
│ EXAMPLE:TEMPERAT… │ 2026-04-11 │ 27.5582726721399… │ 4 │ 1 │
│ │ 00:02:10.420167… │ │ │ │
│ EXAMPLE:TEMPERAT… │ 2026-04-11 │ 27.68436668106384 │ 4 │ 1 │
│ │ 00:02:20.990607… │ │ │ │
│ EXAMPLE:TEMPERAT… │ 2026-04-11 │ 27.8602922509005… │ 4 │ 1 │
│ │ 00:02:30.650287… │ │ │ │
│ EXAMPLE:TEMPERAT… │ 2026-04-11 │ 28.0582746024252… │ 4 │ 1 │
│ │ 00:02:40.287903… │ │ │ │
│ EXAMPLE:TEMPERAT… │ 2026-04-11 │ 28.2470566755693… │ 4 │ 1 │
│ │ 00:02:50.961397… │ │ │ │
│ EXAMPLE:TEMPERAT… │ 2026-04-11 │ 28.3968339319245… │ 4 │ 1 │
│ │ 00:03:00.750987… │ │ │ │
│ EXAMPLE:TEMPERAT… │ 2026-04-11 │ 28.4839598360157… │ 4 │ 1 │
│ │ 00:03:10.149877… │ │ │ │
│ EXAMPLE:TEMPERAT… │ 2026-04-11 │ 28.49467912331169 │ 4 │ 1 │
│ │ 00:03:20.912945… │ │ │ │
│ EXAMPLE:TEMPERAT… │ 2026-04-11 │ 28.42729945404414 │ 4 │ 1 │
│ │ 00:03:30.836655… │ │ │ │
│ EXAMPLE:TEMPERAT… │ 2026-04-11 │ 28.29245859644588 │ 4 │ 1 │
│ │ 00:03:40.008851… │ │ │ │
│ EXAMPLE:TEMPERAT… │ 2026-04-11 │ 28.11144495705012 │ 4 │ 1 │
│ │ 00:03:50.846220… │ │ │ │
│ EXAMPLE:TEMPERAT… │ 2026-04-11 │ 27.91283660938851 │ 4 │ 1 │
│ │ 00:04:00.905578… │ │ │ │
│ EXAMPLE:TEMPERAT… │ 2026-04-11 │ 27.7279894445553… │ 4 │ 1 │
│ │ 00:04:10.132351… │ │ │ │
│ EXAMPLE:TEMPERAT… │ 2026-04-11 │ 27.5860867654571… │ 4 │ 1 │
│ │ 00:04:20.762558… │ │ │ │
│ EXAMPLE:TEMPERAT… │ 2026-04-11 │ 27.5095318849667… │ 4 │ 1 │
│ │ 00:04:30.956375… │ │ │ │
│ EXAMPLE:TEMPERAT… │ 2026-04-11 │ 27.51041113542434 │ 4 │ 1 │
│ │ 00:04:40.270905… │ │ │ │
│ EXAMPLE:TEMPERAT… │ 2026-04-11 │ 27.5885857025156… │ 4 │ 1 │
│ │ 00:04:50.663633… │ │ │ │
└───────────────────┴──────────────────┴───────────────────┴────────┴──────────┘
Field Values 2026
!arch-retrieval --hostname localhost get EXAMPLE:TEMPERATURE -p min -b 5
EXAMPLE:TEMPERATURE Period 2026-06-04 13:31:09 - 2026-06-04 13:31:39 Processor
ProcessorName.MIN, 5 seconds
┏━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━┳━━━━━━━━┳━━━━━━━━━━┓
┃ PV ┃ Time ┃ Value ┃ Status ┃ Severity ┃
┡━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━╇━━━━━━━━╇━━━━━━━━━━┩
│ min_5(EXAMPLE:TE… │ 2026-04-11 │ 28.0 │ 4 │ 1 │
│ │ 00:00:00+00:00 │ │ │ │
│ min_5(EXAMPLE:TE… │ 2026-04-11 │ 28.1947091711543… │ 4 │ 1 │
│ │ 00:00:10.841470… │ │ │ │
│ min_5(EXAMPLE:TE… │ 2026-04-11 │ 28.35867804544976 │ 4 │ 1 │
│ │ 00:00:20.909297… │ │ │ │
│ min_5(EXAMPLE:TE… │ 2026-04-11 │ 28.4660195429836… │ 4 │ 1 │
│ │ 00:00:30.141120… │ │ │ │
│ min_5(EXAMPLE:TE… │ 2026-04-11 │ 28.4997868015207… │ 4 │ 1 │
│ │ 00:00:40.756802… │ │ │ │
│ min_5(EXAMPLE:TE… │ 2026-04-11 │ 28.45464871341284 │ 4 │ 1 │
│ │ 00:00:50.958924… │ │ │ │
│ min_5(EXAMPLE:TE… │ 2026-04-11 │ 28.3377315902755… │ 4 │ 1 │
│ │ 00:01:00.279415… │ │ │ │
│ min_5(EXAMPLE:TE… │ 2026-04-11 │ 28.1674940750779… │ 4 │ 1 │
│ │ 00:01:10.656986… │ │ │ │
│ min_5(EXAMPLE:TE… │ 2026-04-11 │ 27.97081292828621 │ 4 │ 1 │
│ │ 00:01:20.989358… │ │ │ │
│ min_5(EXAMPLE:TE… │ 2026-04-11 │ 27.7787397783525… │ 4 │ 1 │
│ │ 00:01:30.412118… │ │ │ │
│ min_5(EXAMPLE:TE… │ 2026-04-11 │ 27.6215987523460… │ 4 │ 1 │
│ │ 00:01:40.544021… │ │ │ │
│ min_5(EXAMPLE:TE… │ 2026-04-11 │ 27.52419896305524 │ 4 │ 1 │
│ │ 00:01:50.999990… │ │ │ │
│ min_5(EXAMPLE:TE… │ 2026-04-11 │ 27.50191769558208 │ 4 │ 1 │
│ │ 00:02:00.536572… │ │ │ │
│ min_5(EXAMPLE:TE… │ 2026-04-11 │ 27.5582726721399… │ 4 │ 1 │
│ │ 00:02:10.420167… │ │ │ │
│ min_5(EXAMPLE:TE… │ 2026-04-11 │ 27.68436668106384 │ 4 │ 1 │
│ │ 00:02:20.990607… │ │ │ │
│ min_5(EXAMPLE:TE… │ 2026-04-11 │ 27.8602922509005… │ 4 │ 1 │
│ │ 00:02:30.650287… │ │ │ │
│ min_5(EXAMPLE:TE… │ 2026-04-11 │ 28.0582746024252… │ 4 │ 1 │
│ │ 00:02:40.287903… │ │ │ │
│ min_5(EXAMPLE:TE… │ 2026-04-11 │ 28.2470566755693… │ 4 │ 1 │
│ │ 00:02:50.961397… │ │ │ │
│ min_5(EXAMPLE:TE… │ 2026-04-11 │ 28.3968339319245… │ 4 │ 1 │
│ │ 00:03:00.750987… │ │ │ │
│ min_5(EXAMPLE:TE… │ 2026-04-11 │ 28.4839598360157… │ 4 │ 1 │
│ │ 00:03:10.149877… │ │ │ │
│ min_5(EXAMPLE:TE… │ 2026-04-11 │ 28.49467912331169 │ 4 │ 1 │
│ │ 00:03:20.912945… │ │ │ │
│ min_5(EXAMPLE:TE… │ 2026-04-11 │ 28.42729945404414 │ 4 │ 1 │
│ │ 00:03:30.836655… │ │ │ │
│ min_5(EXAMPLE:TE… │ 2026-04-11 │ 28.29245859644588 │ 4 │ 1 │
│ │ 00:03:40.008851… │ │ │ │
│ min_5(EXAMPLE:TE… │ 2026-04-11 │ 28.11144495705012 │ 4 │ 1 │
│ │ 00:03:50.846220… │ │ │ │
│ min_5(EXAMPLE:TE… │ 2026-04-11 │ 27.91283660938851 │ 4 │ 1 │
│ │ 00:04:00.905578… │ │ │ │
│ min_5(EXAMPLE:TE… │ 2026-04-11 │ 27.7279894445553… │ 4 │ 1 │
│ │ 00:04:10.132351… │ │ │ │
│ min_5(EXAMPLE:TE… │ 2026-04-11 │ 27.5860867654571… │ 4 │ 1 │
│ │ 00:04:20.762558… │ │ │ │
│ min_5(EXAMPLE:TE… │ 2026-04-11 │ 27.5095318849667… │ 4 │ 1 │
│ │ 00:04:30.956375… │ │ │ │
│ min_5(EXAMPLE:TE… │ 2026-04-11 │ 27.51041113542434 │ 4 │ 1 │
│ │ 00:04:40.270905… │ │ │ │
│ min_5(EXAMPLE:TE… │ 2026-04-11 │ 27.5885857025156… │ 4 │ 1 │
│ │ 00:04:50.663633… │ │ │ │
└───────────────────┴──────────────────┴───────────────────┴────────┴──────────┘
Field Values 2026
!arch-retrieval --hostname localhost get EXAMPLE:TEMPERATURE -p ncount
EXAMPLE:TEMPERATURE Period 2026-06-04 13:31:10 - 2026-06-04 13:31:40 Processor
ProcessorName.NCOUNT
┏━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━┳━━━━━━━━┳━━━━━━━━━━┓
┃ PV ┃ Time ┃ Value ┃ Status ┃ Severity ┃
┡━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━╇━━━━━━━━╇━━━━━━━━━━┩
│ ncount(EXAMPLE:T… │ 2026-04-11 │ 28.0 │ 4 │ 1 │
│ │ 00:00:00+00:00 │ │ │ │
│ ncount(EXAMPLE:T… │ 2026-04-11 │ 28.1947091711543… │ 4 │ 1 │
│ │ 00:00:10.841470… │ │ │ │
│ ncount(EXAMPLE:T… │ 2026-04-11 │ 28.35867804544976 │ 4 │ 1 │
│ │ 00:00:20.909297… │ │ │ │
│ ncount(EXAMPLE:T… │ 2026-04-11 │ 28.4660195429836… │ 4 │ 1 │
│ │ 00:00:30.141120… │ │ │ │
│ ncount(EXAMPLE:T… │ 2026-04-11 │ 28.4997868015207… │ 4 │ 1 │
│ │ 00:00:40.756802… │ │ │ │
│ ncount(EXAMPLE:T… │ 2026-04-11 │ 28.45464871341284 │ 4 │ 1 │
│ │ 00:00:50.958924… │ │ │ │
│ ncount(EXAMPLE:T… │ 2026-04-11 │ 28.3377315902755… │ 4 │ 1 │
│ │ 00:01:00.279415… │ │ │ │
│ ncount(EXAMPLE:T… │ 2026-04-11 │ 28.1674940750779… │ 4 │ 1 │
│ │ 00:01:10.656986… │ │ │ │
│ ncount(EXAMPLE:T… │ 2026-04-11 │ 27.97081292828621 │ 4 │ 1 │
│ │ 00:01:20.989358… │ │ │ │
│ ncount(EXAMPLE:T… │ 2026-04-11 │ 27.7787397783525… │ 4 │ 1 │
│ │ 00:01:30.412118… │ │ │ │
│ ncount(EXAMPLE:T… │ 2026-04-11 │ 27.6215987523460… │ 4 │ 1 │
│ │ 00:01:40.544021… │ │ │ │
│ ncount(EXAMPLE:T… │ 2026-04-11 │ 27.52419896305524 │ 4 │ 1 │
│ │ 00:01:50.999990… │ │ │ │
│ ncount(EXAMPLE:T… │ 2026-04-11 │ 27.50191769558208 │ 4 │ 1 │
│ │ 00:02:00.536572… │ │ │ │
│ ncount(EXAMPLE:T… │ 2026-04-11 │ 27.5582726721399… │ 4 │ 1 │
│ │ 00:02:10.420167… │ │ │ │
│ ncount(EXAMPLE:T… │ 2026-04-11 │ 27.68436668106384 │ 4 │ 1 │
│ │ 00:02:20.990607… │ │ │ │
│ ncount(EXAMPLE:T… │ 2026-04-11 │ 27.8602922509005… │ 4 │ 1 │
│ │ 00:02:30.650287… │ │ │ │
│ ncount(EXAMPLE:T… │ 2026-04-11 │ 28.0582746024252… │ 4 │ 1 │
│ │ 00:02:40.287903… │ │ │ │
│ ncount(EXAMPLE:T… │ 2026-04-11 │ 28.2470566755693… │ 4 │ 1 │
│ │ 00:02:50.961397… │ │ │ │
│ ncount(EXAMPLE:T… │ 2026-04-11 │ 28.3968339319245… │ 4 │ 1 │
│ │ 00:03:00.750987… │ │ │ │
│ ncount(EXAMPLE:T… │ 2026-04-11 │ 28.4839598360157… │ 4 │ 1 │
│ │ 00:03:10.149877… │ │ │ │
│ ncount(EXAMPLE:T… │ 2026-04-11 │ 28.49467912331169 │ 4 │ 1 │
│ │ 00:03:20.912945… │ │ │ │
│ ncount(EXAMPLE:T… │ 2026-04-11 │ 28.42729945404414 │ 4 │ 1 │
│ │ 00:03:30.836655… │ │ │ │
│ ncount(EXAMPLE:T… │ 2026-04-11 │ 28.29245859644588 │ 4 │ 1 │
│ │ 00:03:40.008851… │ │ │ │
│ ncount(EXAMPLE:T… │ 2026-04-11 │ 28.11144495705012 │ 4 │ 1 │
│ │ 00:03:50.846220… │ │ │ │
│ ncount(EXAMPLE:T… │ 2026-04-11 │ 27.91283660938851 │ 4 │ 1 │
│ │ 00:04:00.905578… │ │ │ │
│ ncount(EXAMPLE:T… │ 2026-04-11 │ 27.7279894445553… │ 4 │ 1 │
│ │ 00:04:10.132351… │ │ │ │
│ ncount(EXAMPLE:T… │ 2026-04-11 │ 27.5860867654571… │ 4 │ 1 │
│ │ 00:04:20.762558… │ │ │ │
│ ncount(EXAMPLE:T… │ 2026-04-11 │ 27.5095318849667… │ 4 │ 1 │
│ │ 00:04:30.956375… │ │ │ │
│ ncount(EXAMPLE:T… │ 2026-04-11 │ 27.51041113542434 │ 4 │ 1 │
│ │ 00:04:40.270905… │ │ │ │
│ ncount(EXAMPLE:T… │ 2026-04-11 │ 27.5885857025156… │ 4 │ 1 │
│ │ 00:04:50.663633… │ │ │ │
└───────────────────┴──────────────────┴───────────────────┴────────┴──────────┘
Field Values 2026
!arch-retrieval --hostname localhost get EXAMPLE:TEMPERATURE2 EXAMPLE:TEMPERATURE3 -s 2024-12-01T12:00:00 -e 2024-12-16T12:10:10.10 -p MEDIAN -b 6000
Period 2024-12-01 12:00:00 - 2024-12-16 12:10:10.100000 Processor
ProcessorName.MEDIAN, 6000 seconds
┏━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━┳━━━━━━━━┳━━━━━━━━━━┓
┃ PV ┃ Time ┃ Value ┃ Status ┃ Severity ┃
┡━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━╇━━━━━━━━╇━━━━━━━━━━┩
│ median_6000(EXAM… │ 2026-04-11 │ 28.0 │ 4 │ 1 │
│ │ 00:00:00+00:00 │ │ │ │
│ median_6000(EXAM… │ 2026-04-11 │ 28.0 │ 4 │ 1 │
│ │ 00:00:00+00:00 │ │ │ │
│ median_6000(EXAM… │ 2026-04-11 │ 28.1947091711543… │ 4 │ 1 │
│ │ 00:00:10.841470… │ │ │ │
│ median_6000(EXAM… │ 2026-04-11 │ 28.1947091711543… │ 4 │ 1 │
│ │ 00:00:10.841470… │ │ │ │
│ median_6000(EXAM… │ 2026-04-11 │ 28.35867804544976 │ 4 │ 1 │
│ │ 00:00:20.909297… │ │ │ │
│ median_6000(EXAM… │ 2026-04-11 │ 28.35867804544976 │ 4 │ 1 │
│ │ 00:00:20.909297… │ │ │ │
│ median_6000(EXAM… │ 2026-04-11 │ 28.4660195429836… │ 4 │ 1 │
│ │ 00:00:30.141120… │ │ │ │
│ median_6000(EXAM… │ 2026-04-11 │ 28.4660195429836… │ 4 │ 1 │
│ │ 00:00:30.141120… │ │ │ │
│ median_6000(EXAM… │ 2026-04-11 │ 28.4997868015207… │ 4 │ 1 │
│ │ 00:00:40.756802… │ │ │ │
│ median_6000(EXAM… │ 2026-04-11 │ 28.4997868015207… │ 4 │ 1 │
│ │ 00:00:40.756802… │ │ │ │
│ median_6000(EXAM… │ 2026-04-11 │ 28.45464871341284 │ 4 │ 1 │
│ │ 00:00:50.958924… │ │ │ │
│ median_6000(EXAM… │ 2026-04-11 │ 28.45464871341284 │ 4 │ 1 │
│ │ 00:00:50.958924… │ │ │ │
│ median_6000(EXAM… │ 2026-04-11 │ 28.3377315902755… │ 4 │ 1 │
│ │ 00:01:00.279415… │ │ │ │
│ median_6000(EXAM… │ 2026-04-11 │ 28.3377315902755… │ 4 │ 1 │
│ │ 00:01:00.279415… │ │ │ │
│ median_6000(EXAM… │ 2026-04-11 │ 28.1674940750779… │ 4 │ 1 │
│ │ 00:01:10.656986… │ │ │ │
│ median_6000(EXAM… │ 2026-04-11 │ 28.1674940750779… │ 4 │ 1 │
│ │ 00:01:10.656986… │ │ │ │
│ median_6000(EXAM… │ 2026-04-11 │ 27.97081292828621 │ 4 │ 1 │
│ │ 00:01:20.989358… │ │ │ │
│ median_6000(EXAM… │ 2026-04-11 │ 27.97081292828621 │ 4 │ 1 │
│ │ 00:01:20.989358… │ │ │ │
│ median_6000(EXAM… │ 2026-04-11 │ 27.7787397783525… │ 4 │ 1 │
│ │ 00:01:30.412118… │ │ │ │
│ median_6000(EXAM… │ 2026-04-11 │ 27.7787397783525… │ 4 │ 1 │
│ │ 00:01:30.412118… │ │ │ │
│ median_6000(EXAM… │ 2026-04-11 │ 27.6215987523460… │ 4 │ 1 │
│ │ 00:01:40.544021… │ │ │ │
│ median_6000(EXAM… │ 2026-04-11 │ 27.6215987523460… │ 4 │ 1 │
│ │ 00:01:40.544021… │ │ │ │
│ median_6000(EXAM… │ 2026-04-11 │ 27.52419896305524 │ 4 │ 1 │
│ │ 00:01:50.999990… │ │ │ │
│ median_6000(EXAM… │ 2026-04-11 │ 27.52419896305524 │ 4 │ 1 │
│ │ 00:01:50.999990… │ │ │ │
│ median_6000(EXAM… │ 2026-04-11 │ 27.50191769558208 │ 4 │ 1 │
│ │ 00:02:00.536572… │ │ │ │
│ median_6000(EXAM… │ 2026-04-11 │ 27.50191769558208 │ 4 │ 1 │
│ │ 00:02:00.536572… │ │ │ │
│ median_6000(EXAM… │ 2026-04-11 │ 27.5582726721399… │ 4 │ 1 │
│ │ 00:02:10.420167… │ │ │ │
│ median_6000(EXAM… │ 2026-04-11 │ 27.5582726721399… │ 4 │ 1 │
│ │ 00:02:10.420167… │ │ │ │
│ median_6000(EXAM… │ 2026-04-11 │ 27.68436668106384 │ 4 │ 1 │
│ │ 00:02:20.990607… │ │ │ │
│ median_6000(EXAM… │ 2026-04-11 │ 27.68436668106384 │ 4 │ 1 │
│ │ 00:02:20.990607… │ │ │ │
│ median_6000(EXAM… │ 2026-04-11 │ 27.8602922509005… │ 4 │ 1 │
│ │ 00:02:30.650287… │ │ │ │
│ median_6000(EXAM… │ 2026-04-11 │ 27.8602922509005… │ 4 │ 1 │
│ │ 00:02:30.650287… │ │ │ │
│ median_6000(EXAM… │ 2026-04-11 │ 28.0582746024252… │ 4 │ 1 │
│ │ 00:02:40.287903… │ │ │ │
│ median_6000(EXAM… │ 2026-04-11 │ 28.0582746024252… │ 4 │ 1 │
│ │ 00:02:40.287903… │ │ │ │
│ median_6000(EXAM… │ 2026-04-11 │ 28.2470566755693… │ 4 │ 1 │
│ │ 00:02:50.961397… │ │ │ │
│ median_6000(EXAM… │ 2026-04-11 │ 28.2470566755693… │ 4 │ 1 │
│ │ 00:02:50.961397… │ │ │ │
│ median_6000(EXAM… │ 2026-04-11 │ 28.3968339319245… │ 4 │ 1 │
│ │ 00:03:00.750987… │ │ │ │
│ median_6000(EXAM… │ 2026-04-11 │ 28.3968339319245… │ 4 │ 1 │
│ │ 00:03:00.750987… │ │ │ │
│ median_6000(EXAM… │ 2026-04-11 │ 28.4839598360157… │ 4 │ 1 │
│ │ 00:03:10.149877… │ │ │ │
│ median_6000(EXAM… │ 2026-04-11 │ 28.4839598360157… │ 4 │ 1 │
│ │ 00:03:10.149877… │ │ │ │
│ median_6000(EXAM… │ 2026-04-11 │ 28.49467912331169 │ 4 │ 1 │
│ │ 00:03:20.912945… │ │ │ │
│ median_6000(EXAM… │ 2026-04-11 │ 28.49467912331169 │ 4 │ 1 │
│ │ 00:03:20.912945… │ │ │ │
│ median_6000(EXAM… │ 2026-04-11 │ 28.42729945404414 │ 4 │ 1 │
│ │ 00:03:30.836655… │ │ │ │
│ median_6000(EXAM… │ 2026-04-11 │ 28.42729945404414 │ 4 │ 1 │
│ │ 00:03:30.836655… │ │ │ │
│ median_6000(EXAM… │ 2026-04-11 │ 28.29245859644588 │ 4 │ 1 │
│ │ 00:03:40.008851… │ │ │ │
│ median_6000(EXAM… │ 2026-04-11 │ 28.29245859644588 │ 4 │ 1 │
│ │ 00:03:40.008851… │ │ │ │
│ median_6000(EXAM… │ 2026-04-11 │ 28.11144495705012 │ 4 │ 1 │
│ │ 00:03:50.846220… │ │ │ │
│ median_6000(EXAM… │ 2026-04-11 │ 28.11144495705012 │ 4 │ 1 │
│ │ 00:03:50.846220… │ │ │ │
│ median_6000(EXAM… │ 2026-04-11 │ 27.91283660938851 │ 4 │ 1 │
│ │ 00:04:00.905578… │ │ │ │
│ median_6000(EXAM… │ 2026-04-11 │ 27.91283660938851 │ 4 │ 1 │
│ │ 00:04:00.905578… │ │ │ │
│ median_6000(EXAM… │ 2026-04-11 │ 27.7279894445553… │ 4 │ 1 │
│ │ 00:04:10.132351… │ │ │ │
│ median_6000(EXAM… │ 2026-04-11 │ 27.7279894445553… │ 4 │ 1 │
│ │ 00:04:10.132351… │ │ │ │
│ median_6000(EXAM… │ 2026-04-11 │ 27.5860867654571… │ 4 │ 1 │
│ │ 00:04:20.762558… │ │ │ │
│ median_6000(EXAM… │ 2026-04-11 │ 27.5860867654571… │ 4 │ 1 │
│ │ 00:04:20.762558… │ │ │ │
│ median_6000(EXAM… │ 2026-04-11 │ 27.5095318849667… │ 4 │ 1 │
│ │ 00:04:30.956375… │ │ │ │
│ median_6000(EXAM… │ 2026-04-11 │ 27.5095318849667… │ 4 │ 1 │
│ │ 00:04:30.956375… │ │ │ │
│ median_6000(EXAM… │ 2026-04-11 │ 27.51041113542434 │ 4 │ 1 │
│ │ 00:04:40.270905… │ │ │ │
│ median_6000(EXAM… │ 2026-04-11 │ 27.51041113542434 │ 4 │ 1 │
│ │ 00:04:40.270905… │ │ │ │
│ median_6000(EXAM… │ 2026-04-11 │ 27.5885857025156… │ 4 │ 1 │
│ │ 00:04:50.663633… │ │ │ │
│ median_6000(EXAM… │ 2026-04-11 │ 27.5885857025156… │ 4 │ 1 │
│ │ 00:04:50.663633… │ │ │ │
└───────────────────┴──────────────────┴───────────────────┴────────┴──────────┘
Export Data
The export command writes a single PV’s data to stdout in a machine-readable format: json (default), csv, arrow, parquet, or pb (the raw Archiver Appliance protobuf). The csv/arrow/parquet formats require the [polars] extra. Redirect stdout to a file to save the result.
!arch-retrieval export --help
Usage: arch-retrieval export [OPTIONS] PV
Export PV data to stdout in a machine-readable format.
ARGUMENT pv PV name to export data for.
Example usage:
.. code-block:: console
arch-retrieval --hostname archiver.example.com export --format json
MY_PV arch-retrieval --hostname archiver.example.com export --format
pb MY_PV > out.pb
Raises: UsageError: When a polars-backed format is requested without the
[polars] extra.
Options:
--debug Turn on debug logging
-s, --start [%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]
Start time of query [default: 30 seconds
ago]
-e, --end [%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]
End time of query, [default: now]
-p, --processor-name [firstsample|lastsample|firstfill|lastfill|mean|min|max|count|ncount|nth|median|std|jitter|ignoreflyers|flyers|variance|popvariance|kurtosis|skewness|linear|loess|optimized|optimlastsample|caplotbinning|deadband|errorbar]
PreProcessor to use.
-b, --bin-size INTEGER Bin size (mostly in seconds) for
preprocessor.
--format [json|csv|arrow|parquet|pb]
Output format, written to stdout. [default:
JSON]
--help Show this message and exit.
!arch-retrieval --hostname localhost export --format csv EXAMPLE:TEMPERATURE | head
date,pv,val,severity,status,field_values,headers
2026-04-11T00:00:00.000000000+0000,EXAMPLE:TEMPERATURE,28.0,1,4,"[{""name"": ""EGU"", ""value"": ""degC""}, {""name"": ""PREC"", ""value"": ""2""}]",[]
2026-04-11T00:00:10.841470984+0000,EXAMPLE:TEMPERATURE,28.194709171154326,1,4,"[{""name"": ""EGU"", ""value"": ""degC""}, {""name"": ""PREC"", ""value"": ""2""}]",[]
2026-04-11T00:00:20.909297426+0000,EXAMPLE:TEMPERATURE,28.35867804544976,1,4,"[{""name"": ""EGU"", ""value"": ""degC""}, {""name"": ""PREC"", ""value"": ""2""}]",[]
2026-04-11T00:00:30.141120008+0000,EXAMPLE:TEMPERATURE,28.466019542983613,1,4,"[{""name"": ""EGU"", ""value"": ""degC""}, {""name"": ""PREC"", ""value"": ""2""}]",[]
2026-04-11T00:00:40.756802495+0000,EXAMPLE:TEMPERATURE,28.499786801520752,1,4,"[{""name"": ""EGU"", ""value"": ""degC""}, {""name"": ""PREC"", ""value"": ""2""}]",[]
2026-04-11T00:00:50.958924274+0000,EXAMPLE:TEMPERATURE,28.45464871341284,1,4,"[{""name"": ""EGU"", ""value"": ""degC""}, {""name"": ""PREC"", ""value"": ""2""}]",[]
2026-04-11T00:01:00.279415498+0000,EXAMPLE:TEMPERATURE,28.337731590275574,1,4,"[{""name"": ""EGU"", ""value"": ""degC""}, {""name"": ""PREC"", ""value"": ""2""}]",[]
2026-04-11T00:01:10.656986598+0000,EXAMPLE:TEMPERATURE,28.167494075077954,1,4,"[{""name"": ""EGU"", ""value"": ""degC""}, {""name"": ""PREC"", ""value"": ""2""}]",[]
2026-04-11T00:01:20.989358246+0000,EXAMPLE:TEMPERATURE,27.97081292828621,1,4,"[{""name"": ""EGU"", ""value"": ""degC""}, {""name"": ""PREC"", ""value"": ""2""}]",[]
!arch-retrieval --hostname localhost export --format pb EXAMPLE:TEMPERATURE > example.pb
Search for PV Names
The search command looks up PV names matching a regex pattern. Optionally pass -s/-e to only return PVs that recorded data in a time range, and -l to change the result limit.
!arch-retrieval search --help
Usage: arch-retrieval search [OPTIONS] QUERY
Search for PV names using regex search patterns.
Optionally specify start and/or end times to only return PVs that recorded
data in the specified time range.
ARGUMENT query PV name regex search pattern.
Example usage:
.. code-block:: console
arch-retrieval --hostname archiver-01.example.com search
"PBI-APTM02:Ctrl-ECAT-100:.*Temp1[2-4].*"
arch-retrieval --hostname archiver-01.example.com search
"PBI-APTM02:.*" -s "2026-01-06 02:50:00"
arch-retrieval --hostname archiver-01.example.com search
"(?i)mbl-060RFC:.*:tempambient" -s "2026-01-05" -e "2026-01-06"
Options:
-s, --start [%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]
Start time of query
-e, --end [%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]
End time of query
-l, --limit INTEGER Limit of PV names to return for each search
string given. To get all the PV names,
(potentially in the millions), set limit to
-1. [default: 500]
--debug Turn on debug logging
--help Show this message and exit.
!arch-retrieval --hostname localhost search "EXAMPLE:.*"
Found 3 PVs
┏━━━━━━━━━━━━━━━━━━━━━━┓
┃ PV name ┃
┡━━━━━━━━━━━━━━━━━━━━━━┩
│ EXAMPLE:TEMPERATURE │
│ EXAMPLE:TEMPERATURE2 │
│ EXAMPLE:PRESSURE │
└──────────────────────┘
Read a Local PB File
The read-pb command displays the events stored in a local Archiver Appliance .pb file (for example one written by export --format pb above) as a table, without contacting a server.
!arch-retrieval read-pb --help
Usage: arch-retrieval read-pb [OPTIONS] FILE
Display events from a local PB file.
ARGUMENT file Path to the .pb file to read.
Example usage:
.. code-block:: console
arch-retrieval read-pb MY_PV_2026.pb
Options:
--debug Turn on debug logging
--help Show this message and exit.
!arch-retrieval --hostname localhost read-pb example.pb
EXAMPLE:TEMPERATURE Period 2026-04-11 00:00:00+00:00 - 2026-04-11
00:04:50.663633+00:00
┏━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━┳━━━━━━━━┳━━━━━━━━━━┓
┃ PV ┃ Time ┃ Value ┃ Status ┃ Severity ┃
┡━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━╇━━━━━━━━╇━━━━━━━━━━┩
│ EXAMPLE:TEMPERAT… │ 2026-04-11 │ 28.0 │ 4 │ 1 │
│ │ 00:00:00+00:00 │ │ │ │
│ EXAMPLE:TEMPERAT… │ 2026-04-11 │ 28.1947091711543… │ 4 │ 1 │
│ │ 00:00:10.841470… │ │ │ │
│ EXAMPLE:TEMPERAT… │ 2026-04-11 │ 28.35867804544976 │ 4 │ 1 │
│ │ 00:00:20.909297… │ │ │ │
│ EXAMPLE:TEMPERAT… │ 2026-04-11 │ 28.4660195429836… │ 4 │ 1 │
│ │ 00:00:30.141120… │ │ │ │
│ EXAMPLE:TEMPERAT… │ 2026-04-11 │ 28.4997868015207… │ 4 │ 1 │
│ │ 00:00:40.756802… │ │ │ │
│ EXAMPLE:TEMPERAT… │ 2026-04-11 │ 28.45464871341284 │ 4 │ 1 │
│ │ 00:00:50.958924… │ │ │ │
│ EXAMPLE:TEMPERAT… │ 2026-04-11 │ 28.3377315902755… │ 4 │ 1 │
│ │ 00:01:00.279415… │ │ │ │
│ EXAMPLE:TEMPERAT… │ 2026-04-11 │ 28.1674940750779… │ 4 │ 1 │
│ │ 00:01:10.656986… │ │ │ │
│ EXAMPLE:TEMPERAT… │ 2026-04-11 │ 27.97081292828621 │ 4 │ 1 │
│ │ 00:01:20.989358… │ │ │ │
│ EXAMPLE:TEMPERAT… │ 2026-04-11 │ 27.7787397783525… │ 4 │ 1 │
│ │ 00:01:30.412118… │ │ │ │
│ EXAMPLE:TEMPERAT… │ 2026-04-11 │ 27.6215987523460… │ 4 │ 1 │
│ │ 00:01:40.544021… │ │ │ │
│ EXAMPLE:TEMPERAT… │ 2026-04-11 │ 27.52419896305524 │ 4 │ 1 │
│ │ 00:01:50.999990… │ │ │ │
│ EXAMPLE:TEMPERAT… │ 2026-04-11 │ 27.50191769558208 │ 4 │ 1 │
│ │ 00:02:00.536572… │ │ │ │
│ EXAMPLE:TEMPERAT… │ 2026-04-11 │ 27.5582726721399… │ 4 │ 1 │
│ │ 00:02:10.420167… │ │ │ │
│ EXAMPLE:TEMPERAT… │ 2026-04-11 │ 27.68436668106384 │ 4 │ 1 │
│ │ 00:02:20.990607… │ │ │ │
│ EXAMPLE:TEMPERAT… │ 2026-04-11 │ 27.8602922509005… │ 4 │ 1 │
│ │ 00:02:30.650287… │ │ │ │
│ EXAMPLE:TEMPERAT… │ 2026-04-11 │ 28.0582746024252… │ 4 │ 1 │
│ │ 00:02:40.287903… │ │ │ │
│ EXAMPLE:TEMPERAT… │ 2026-04-11 │ 28.2470566755693… │ 4 │ 1 │
│ │ 00:02:50.961397… │ │ │ │
│ EXAMPLE:TEMPERAT… │ 2026-04-11 │ 28.3968339319245… │ 4 │ 1 │
│ │ 00:03:00.750987… │ │ │ │
│ EXAMPLE:TEMPERAT… │ 2026-04-11 │ 28.4839598360157… │ 4 │ 1 │
│ │ 00:03:10.149877… │ │ │ │
│ EXAMPLE:TEMPERAT… │ 2026-04-11 │ 28.49467912331169 │ 4 │ 1 │
│ │ 00:03:20.912945… │ │ │ │
│ EXAMPLE:TEMPERAT… │ 2026-04-11 │ 28.42729945404414 │ 4 │ 1 │
│ │ 00:03:30.836655… │ │ │ │
│ EXAMPLE:TEMPERAT… │ 2026-04-11 │ 28.29245859644588 │ 4 │ 1 │
│ │ 00:03:40.008851… │ │ │ │
│ EXAMPLE:TEMPERAT… │ 2026-04-11 │ 28.11144495705012 │ 4 │ 1 │
│ │ 00:03:50.846220… │ │ │ │
│ EXAMPLE:TEMPERAT… │ 2026-04-11 │ 27.91283660938851 │ 4 │ 1 │
│ │ 00:04:00.905578… │ │ │ │
│ EXAMPLE:TEMPERAT… │ 2026-04-11 │ 27.7279894445553… │ 4 │ 1 │
│ │ 00:04:10.132351… │ │ │ │
│ EXAMPLE:TEMPERAT… │ 2026-04-11 │ 27.5860867654571… │ 4 │ 1 │
│ │ 00:04:20.762558… │ │ │ │
│ EXAMPLE:TEMPERAT… │ 2026-04-11 │ 27.5095318849667… │ 4 │ 1 │
│ │ 00:04:30.956375… │ │ │ │
│ EXAMPLE:TEMPERAT… │ 2026-04-11 │ 27.51041113542434 │ 4 │ 1 │
│ │ 00:04:40.270905… │ │ │ │
│ EXAMPLE:TEMPERAT… │ 2026-04-11 │ 27.5885857025156… │ 4 │ 1 │
│ │ 00:04:50.663633… │ │ │ │
└───────────────────┴──────────────────┴───────────────────┴────────┴──────────┘
Field Values 2026