data_structures Module API
==========================

This section documents the core data structures used throughout datashard.

Enums
-----

FileFormat
^^^^^^^^^^

.. autoclass:: datashard.FileFormat
   :members:
   :undoc-members:
   :show-inheritance:

ManifestContent
^^^^^^^^^^^^^^^

.. autoclass:: datashard.ManifestContent
   :members:
   :undoc-members:
   :show-inheritance:

Classes
-------

Schema
^^^^^^

.. autoclass:: datashard.Schema
   :members:
   :undoc-members:
   :show-inheritance:

PartitionField
^^^^^^^^^^^^^^

.. autoclass:: datashard.PartitionField
   :members:
   :undoc-members:
   :show-inheritance:

PartitionSpec
^^^^^^^^^^^^^

.. autoclass:: datashard.PartitionSpec
   :members:
   :undoc-members:
   :show-inheritance:

SortField
^^^^^^^^^

.. autoclass:: datashard.SortField
   :members:
   :undoc-members:
   :show-inheritance:

SortOrder
^^^^^^^^^

.. autoclass:: datashard.SortOrder
   :members:
   :undoc-members:
   :show-inheritance:

DataFile
^^^^^^^^

.. autoclass:: datashard.DataFile
   :members:
   :undoc-members:
   :show-inheritance:

DeleteFile
^^^^^^^^^^

.. autoclass:: datashard.DeleteFile
   :members:
   :undoc-members:
   :show-inheritance:

ManifestFile
^^^^^^^^^^^^

.. autoclass:: datashard.ManifestFile
   :members:
   :undoc-members:
   :show-inheritance:

Snapshot
^^^^^^^^

.. autoclass:: datashard.Snapshot
   :members:
   :undoc-members:
   :show-inheritance:

HistoryEntry
^^^^^^^^^^^^

.. autoclass:: datashard.HistoryEntry
   :members:
   :undoc-members:
   :show-inheritance:

TableMetadata
^^^^^^^^^^^^^

.. autoclass:: datashard.TableMetadata
   :members:
   :undoc-members:
   :show-inheritance: