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

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


Submodules
----------
.. toctree::
   :titlesonly:
   :maxdepth: 1

   archive/index.rst
   avro/index.rst
   broker/index.rst
   csvfile/index.rst
   duckdb/index.rst
   elastic/index.rst
   jsonfile/index.rst
   line/index.rst
   mongo/index.rst
   split/index.rst
   splunk/index.rst
   sqlite/index.rst
   stream/index.rst
   text/index.rst
   xlsx/index.rst




Package Contents
----------------

Classes
~~~~~~~

.. autoapisummary::

   flow.record.adapter.AbstractWriter
   flow.record.adapter.AbstractReader




Attributes
~~~~~~~~~~

.. autoapisummary::

   flow.record.adapter.__path__


.. py:data:: __path__

.. py:class:: AbstractWriter

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


      Write a record.



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


      Flush any buffered writes.



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


      Close the Writer, no more writes will be possible.



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


   .. py:method:: __enter__() -> AbstractWriter


   .. py:method:: __exit__(*args) -> None


.. py:class:: AbstractReader

   .. py:method:: __iter__() -> collections.abc.Iterator[flow.record.base.Record]
      :abstractmethod:


      Return a record iterator.



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

      Close the Reader, can be overriden to properly free resources.



   .. py:method:: __enter__() -> AbstractReader


   .. py:method:: __exit__(*args) -> None