Contents Menu Expand Light mode Dark mode Auto light/dark, in light mode Auto light/dark, in dark mode Skip to content
httk-store 2.1.0 documentation
httk-store 2.1.0 documentation

Documentation

  • Data management
  • Backend storage
  • MongoDB storage
  • Federated stores
  • Migrating from httk v1
  • Test tiers
  • ClickHouse testing
  • PostgreSQL testing
  • Reference
    • httk.store
      • httk.store.backend
        • httk.store.backend.clickhouse
          • httk.store.backend.clickhouse.engine
          • httk.store.backend.clickhouse.support
        • httk.store.backend.codecs
        • httk.store.backend.duckdb
          • httk.store.backend.duckdb.engine
          • httk.store.backend.duckdb.hooks
        • httk.store.backend.mongo
          • httk.store.backend.mongo.database
          • httk.store.backend.mongo.documents
          • httk.store.backend.mongo.entry_provider
          • httk.store.backend.mongo.evaluator
          • httk.store.backend.mongo.fsck
          • httk.store.backend.mongo.leases
          • httk.store.backend.mongo.mapping
          • httk.store.backend.mongo.optimade
          • httk.store.backend.mongo.results
          • httk.store.backend.mongo.searcher
          • httk.store.backend.mongo.store
          • httk.store.backend.mongo.stored_properties
        • httk.store.backend.postgresql
          • httk.store.backend.postgresql.compiler
          • httk.store.backend.postgresql.engine
          • httk.store.backend.postgresql.hooks
        • httk.store.backend.schema
        • httk.store.backend.sql
          • httk.store.backend.sql.bulk
          • httk.store.backend.sql.bulk_deferred
          • httk.store.backend.sql.bulk_parallel
          • httk.store.backend.sql.engine
          • httk.store.backend.sql.entry_provider
          • httk.store.backend.sql.fsck
          • httk.store.backend.sql.graph
          • httk.store.backend.sql.layout
          • httk.store.backend.sql.mapping
          • httk.store.backend.sql.optimade
          • httk.store.backend.sql.paging
          • httk.store.backend.sql.provenance_edges
          • httk.store.backend.sql.results
          • httk.store.backend.sql.rows
          • httk.store.backend.sql.searcher
          • httk.store.backend.sql.store
          • httk.store.backend.sql.stored_federation
          • httk.store.backend.sql.stored_properties
        • httk.store.backend.sqlite
          • httk.store.backend.sqlite.engine
          • httk.store.backend.sqlite.hooks
      • httk.store.entry_providers
      • httk.store.export
      • httk.store.federated_store
      • httk.store.id_ledger
      • httk.store.query
        • httk.store.query.optimade_filters
        • httk.store.query.paging_tokens
        • httk.store.query.portable
        • httk.store.query.protocols
        • httk.store.query.slicer
      • httk.store.served_specs
      • httk.store.storage_layout
      • httk.store.store_common
      • httk.store.store_timestamp
      • 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
    • Pandas-style slicer indexing over a store
    • Storing frozen dataclasses in a database, exactly
  • Examples

Details

  • Backend storage in detail
    • Declaring, storing, and fetching records
    • Entry families and schema layout
    • Record replacement and lineages
    • Weak links and provenance
    • Store timestamps
    • Permanentization, degraded writes, and fsck
    • Bulk ingestion
    • Searching and exact values
    • Serving through OPTIMADE
  • MongoDB storage in detail
  • Migrating from httk v1 in detail
  • API Reference
    • httk.store
      • httk.store.backend
        • httk.store.backend.clickhouse
          • httk.store.backend.clickhouse.engine
          • httk.store.backend.clickhouse.support
        • httk.store.backend.codecs
        • httk.store.backend.duckdb
          • httk.store.backend.duckdb.engine
          • httk.store.backend.duckdb.hooks
        • httk.store.backend.mongo
          • httk.store.backend.mongo.database
          • httk.store.backend.mongo.documents
          • httk.store.backend.mongo.entry_provider
          • httk.store.backend.mongo.evaluator
          • httk.store.backend.mongo.fsck
          • httk.store.backend.mongo.leases
          • httk.store.backend.mongo.mapping
          • httk.store.backend.mongo.optimade
          • httk.store.backend.mongo.results
          • httk.store.backend.mongo.searcher
          • httk.store.backend.mongo.store
          • httk.store.backend.mongo.stored_properties
        • httk.store.backend.postgresql
          • httk.store.backend.postgresql.compiler
          • httk.store.backend.postgresql.engine
          • httk.store.backend.postgresql.hooks
        • httk.store.backend.schema
        • httk.store.backend.sql
          • httk.store.backend.sql.bulk
          • httk.store.backend.sql.bulk_deferred
          • httk.store.backend.sql.bulk_parallel
          • httk.store.backend.sql.engine
          • httk.store.backend.sql.entry_provider
          • httk.store.backend.sql.fsck
          • httk.store.backend.sql.graph
          • httk.store.backend.sql.layout
          • httk.store.backend.sql.mapping
          • httk.store.backend.sql.optimade
          • httk.store.backend.sql.paging
          • httk.store.backend.sql.provenance_edges
          • httk.store.backend.sql.results
          • httk.store.backend.sql.rows
          • httk.store.backend.sql.searcher
          • httk.store.backend.sql.store
          • httk.store.backend.sql.stored_federation
          • httk.store.backend.sql.stored_properties
        • httk.store.backend.sqlite
          • httk.store.backend.sqlite.engine
          • httk.store.backend.sqlite.hooks
      • httk.store.entry_providers
      • httk.store.export
      • httk.store.federated_store
      • httk.store.id_ledger
      • httk.store.query
        • httk.store.query.optimade_filters
        • httk.store.query.paging_tokens
        • httk.store.query.portable
        • httk.store.query.protocols
        • httk.store.query.slicer
      • httk.store.served_specs
      • httk.store.storage_layout
      • httk.store.store_common
      • httk.store.store_timestamp
      • httk.store.validation
    • httk.registry.cli.store
    • httk.registry.entries.store
Back to top
Copyright © 2026, The httk-store AUTHORS
Made with Sphinx and @pradyunsg's Furo