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

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


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

Classes
~~~~~~~

.. autoapisummary::

   flow.record.adapter.avro.AvroWriter
   flow.record.adapter.avro.AvroReader



Functions
~~~~~~~~~

.. autoapisummary::
   :nosignatures:

   flow.record.adapter.avro.descriptor_to_schema
   flow.record.adapter.avro.schema_to_descriptor
   flow.record.adapter.avro.avro_type_to_flow_type



Attributes
~~~~~~~~~~

.. autoapisummary::

   flow.record.adapter.avro.__usage__
   flow.record.adapter.avro.AVRO_TYPE_MAP
   flow.record.adapter.avro.RECORD_TYPE_MAP
   flow.record.adapter.avro.EPOCH


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

    .. raw:: html

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

    .. code-block:: python

        """
        Apache AVRO adapter
        ---
        Write usage: rdump -w avro://[PATH]
        Read usage: rdump avro://[PATH]
        [PATH]: path to file. Leave empty or "-" to output to stdout
        """

    .. raw:: html

        </details>

   

.. py:data:: AVRO_TYPE_MAP

   

.. py:data:: RECORD_TYPE_MAP

   

.. py:data:: EPOCH

   

.. py:class:: AvroWriter(path, key=None, **kwargs)


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

   .. py:attribute:: fp

      

   .. py:attribute:: writer

      

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

      Write a record.


   .. py:method:: flush()

      Flush any buffered writes.


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

      Close the Writer, no more writes will be possible.



.. py:class:: AvroReader(path, selector=None, **kwargs)


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

   .. py:attribute:: fp

      

   .. py:method:: __iter__() -> Iterator[flow.record.Record]

      Return a record iterator.


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

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



.. py:function:: descriptor_to_schema(desc: flow.record.RecordDescriptor) -> dict[str, Any]


.. py:function:: schema_to_descriptor(schema: dict) -> flow.record.RecordDescriptor


.. py:function:: avro_type_to_flow_type(ftype: list) -> str