:py:mod:`flow.record.adapter.archive`
=====================================

.. py:module:: flow.record.adapter.archive




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

Classes
~~~~~~~

.. autoapisummary::

   flow.record.adapter.archive.ArchiveWriter
   flow.record.adapter.archive.ArchiveReader




Attributes
~~~~~~~~~~

.. autoapisummary::

   flow.record.adapter.archive.__usage__


.. py:data:: __usage__
   :value: Multiline-String

   .. raw:: html

      <details><summary>Show Value</summary>

   .. code-block:: python

      """
      Record archiver adapter, writes records to YYYY/mm/dd directories (writer only)
      ---
      Write usage: rdump -w archive://[PATH]
      [PATH]: path to folder
      """

   .. raw:: html

      </details>



.. py:class:: ArchiveWriter(path: str, **kwargs)

   Bases: :py:obj:`flow.record.adapter.AbstractWriter`


   .. py:attribute:: writer
      :value: None



   .. py:attribute:: path


   .. py:method:: write(r: flow.record.base.Record) -> None

      Write a record.



   .. py:method:: flush() -> None

      Flush any buffered writes.



   .. py:method:: close() -> None

      Close the Writer, no more writes will be possible.



.. py:class:: ArchiveReader(path: str, **kwargs)

   Bases: :py:obj:`flow.record.adapter.AbstractReader`