httk.optimade.endpoints.partial_data

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

generate_partial_data_reply(...)

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

Module Contents

httk.optimade.endpoints.partial_data.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[source]

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