trolldb.api package

This package contains the API capabilities for the pytroll-db package.

It provides functionality for interacting with the database via the FastAPI framework.

For more information and documentation, please refer to the following sub-packages and modules:

• trolldb.api.routes: The package which defines the API routes.

• trolldb.api.api: The module which defines the API server and how it is run via the given configuration.

Subpackages

• trolldb.api.routes package
  • Submodules
    • trolldb.api.routes.common module
      • check_database()
      • check_collection()
      • get_distinct_items_in_collection()
      • CheckCollectionDependency
      • CheckDataBaseDependency
    • trolldb.api.routes.databases module
      • database_names()
      • collection_names()
      • documents()
      • document_by_id()
    • trolldb.api.routes.datetime_ module
      • TimeModel
      • TimeEntry
      • ResponseModel
      • datetime()
    • trolldb.api.routes.platforms module
      • platform_names()
    • trolldb.api.routes.queries module
      • queries()
    • trolldb.api.routes.root module
      • root()
    • trolldb.api.routes.router module
    • trolldb.api.routes.sensors module
      • sensor_names()

Submodules

• trolldb.api.api module
  • run_server()
• trolldb.api.fastapi_app module
  • API_INFO
  • auto_handler_response_errors()
  • auto_handler_pydantic_validation_errors()