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

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




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

Classes
~~~~~~~

.. autoapisummary::

   flow.record.adapter.split.SplitWriter




Attributes
~~~~~~~~~~

.. autoapisummary::

   flow.record.adapter.split.DEFAULT_RECORD_COUNT
   flow.record.adapter.split.DEFAULT_SUFFIX_LENGTH
   flow.record.adapter.split.__usage__


.. py:data:: DEFAULT_RECORD_COUNT
   :value: 1000


.. py:data:: DEFAULT_SUFFIX_LENGTH
   :value: 2


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

   .. raw:: html

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

   .. code-block:: python

      """
      Record split adapter, splits records into multiple destination files (writer only)
      ---
      Write usage: rdump -w split://[PATH]?count=[COUNT]&suffix-length=[SUFFIX-LENGTH]
      [PATH]: output path or uri
      [COUNT]: maximum record count per file (default: 1000)
      [SUFFIX-LENGTH]: length of suffix (default: 2)
      """

   .. raw:: html

      </details>



.. py:class:: SplitWriter(path: str | pathlib.Path, **kwargs)

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


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



   .. py:attribute:: path
      :value: ''



   .. py:attribute:: kwargs


   .. py:attribute:: written
      :value: 0



   .. py:attribute:: count


   .. py:attribute:: suffix_length


   .. py:attribute:: file_count
      :value: 0



   .. py:attribute:: is_stdout


   .. 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.