API reference

This is a curated map of public interfaces. It does not embed implementation source, runtime configuration or automatically collected docstring examples.

Interface	Purpose	Guide
SharedData.SharedData.SharedData	Main container interface	Quick start
SharedData.SharedNumpy.SharedNumpy	Structured record array returned by table()	Tables
SharedData.TableDisk.TableDisk	Local table file and publication operations	Tables
SharedData.TimeseriesContainer.TimeseriesContainer	Time-series tags and indexes	Time series
SharedData.TimeSeriesDisk.TimeSeriesDisk	One time-series matrix	Time series
SharedData.CollectionMongoDB.CollectionMongoDB	MongoDB-backed documents	HTTP API
SharedData.CacheRedis.CacheRedis	Redis-backed entity state	Redis caches
SharedData.StreamKafka.StreamKafka	Kafka-backed streams	Advanced usage
SharedData.IO.ClientAPI.ClientAPI	Authenticated remote data operations	HTTP API
SharedData.Logger.Logger	Application logging	Logging
SharedData.Routines.WorkerPool.WorkerPool	Tracked execution and jobs	Batch jobs

Return values

SharedData.table() returns a SharedNumpy; its .table attribute refers to the disk object. SharedData.timeseries(..., tag=...) returns a pandas DataFrame view; without a tag it returns the source container. Structural operations can invalidate retained views.

Remote API

The matching server serves its OpenAPI document at /apidocs. Use that deployed version's specification for request fields and response schemas. The public website does not proxy a running API or provide access to a deployment's containers.