httk.optimade.endpoints.partial_data
====================================

.. py:module:: httk.optimade.endpoints.partial_data

.. autoapi-nested-parse::

   The partial data endpoint, streaming large property values as JSON Lines.

   See the OPTIMADE specification appendix "OPTIMADE JSON Lines partial data
   format". A backend exposes a large or sliceable property value as a
   :class:`~httk.optimade.backend.partial.PartialValue`; this endpoint fetches it
   in chunks of ``config.partial_data_chunk_size`` outer items and emits the
   JSON Lines document, with a next-marker when more data remains.



Functions
---------

.. autoapisummary::

   httk.optimade.endpoints.partial_data.generate_partial_data_reply


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

.. py:function:: generate_partial_data_reply(request: httk.optimade.model.request.ValidatedRequest, config: httk.optimade.model.config.OptimadeConfig, query_function: httk.optimade.model.results.QueryFunction, schema: httk.optimade.schema.served.ServedSchema) -> httk.optimade.model.request.EndpointResponse

   Produce the JSON Lines partial data reply for a single property value.