Contents Menu Expand Light mode Dark mode Auto light/dark, in light mode Auto light/dark, in dark mode Skip to content
Development documentation (dev:main) — content may differ from any release.
httk-store dev:main documentation
httk-store dev:main documentation

Documentation

  • Data management
  • Database storage
  • MongoDB storage
  • Federated stores
  • Migrating from httk v1
  • Test tiers
  • ClickHouse testing
  • Reference
    • httk.store
      • httk.store.db
        • httk.store.db.bulk
        • httk.store.db.bulk_deferred
        • httk.store.db.bulk_parallel
        • httk.store.db.clickhouse
        • httk.store.db.codecs
        • httk.store.db.engine
        • httk.store.db.entry_provider
        • httk.store.db.fsck
        • httk.store.db.graph
        • httk.store.db.layout
        • httk.store.db.mapping
        • httk.store.db.optimade
        • httk.store.db.paging
        • httk.store.db.results
        • httk.store.db.rows
        • httk.store.db.schema
        • httk.store.db.searcher
        • httk.store.db.store
        • httk.store.db.stored_federation
        • httk.store.db.stored_properties
      • httk.store.entry_providers
      • httk.store.federated_store
      • httk.store.mongo
        • httk.store.mongo.database
        • httk.store.mongo.documents
        • httk.store.mongo.entry_provider
        • httk.store.mongo.evaluator
        • httk.store.mongo.fsck
        • httk.store.mongo.leases
        • httk.store.mongo.mapping
        • httk.store.mongo.optimade
        • httk.store.mongo.results
        • httk.store.mongo.searcher
        • httk.store.mongo.store
        • httk.store.mongo.stored_properties
      • httk.store.query
        • httk.store.query.optimade_filters
        • httk.store.query.paging_tokens
        • httk.store.query.portable
        • httk.store.query.protocols
      • httk.store.served_specs
      • httk.store.storage_layout
      • httk.store.store_common
      • httk.store.validation
  • Examples
    • Serving records and validating them against their OPTIMADE definitions
    • Querying stored dataclasses with OPTIMADE filter strings
    • Querying a store with the search DSL
    • Serving a database as an OPTIMADE API
    • Storing frozen dataclasses in a database, exactly
  • Examples

Details

  • Database storage in detail
  • MongoDB storage in detail
  • Migrating from httk v1 in detail
  • API Reference
    • httk.store
      • httk.store.db
        • httk.store.db.bulk
        • httk.store.db.bulk_deferred
        • httk.store.db.bulk_parallel
        • httk.store.db.clickhouse
        • httk.store.db.codecs
        • httk.store.db.engine
        • httk.store.db.entry_provider
        • httk.store.db.fsck
        • httk.store.db.graph
        • httk.store.db.layout
        • httk.store.db.mapping
        • httk.store.db.optimade
        • httk.store.db.paging
        • httk.store.db.results
        • httk.store.db.rows
        • httk.store.db.schema
        • httk.store.db.searcher
        • httk.store.db.store
        • httk.store.db.stored_federation
        • httk.store.db.stored_properties
      • httk.store.entry_providers
      • httk.store.federated_store
      • httk.store.mongo
        • httk.store.mongo.database
        • httk.store.mongo.documents
        • httk.store.mongo.entry_provider
        • httk.store.mongo.evaluator
        • httk.store.mongo.fsck
        • httk.store.mongo.leases
        • httk.store.mongo.mapping
        • httk.store.mongo.optimade
        • httk.store.mongo.results
        • httk.store.mongo.searcher
        • httk.store.mongo.store
        • httk.store.mongo.stored_properties
      • httk.store.query
        • httk.store.query.optimade_filters
        • httk.store.query.paging_tokens
        • httk.store.query.portable
        • httk.store.query.protocols
      • httk.store.served_specs
      • httk.store.storage_layout
      • httk.store.store_common
      • httk.store.validation
    • httk.registry.entries.store
Back to top
View this page

Reference¶

This section documents the supported public API.

  • httk.store
    • StandardEntryProvider
    • Submodules
    • Attributes
    • Exceptions
    • Classes
    • Functions
    • Package Contents
Next
httk.store
Previous
ClickHouse testing
Copyright © 2026, The httk-store AUTHORS
Made with Sphinx and @pradyunsg's Furo