Welcome to JamDB’s documentation!

JamDB is a schema-less, immutable database that can optionally enforce a schema and stores provenance. It supports efficient full-text search, filtering by nested keys, and is accessible a REST API.

It has pluggable storage backends. It defaults to using both MongoDB and Elasticsearch.

The full BDD test suite lives in the features directory and describes in human-readable prose how each endpoint works. What it’s expecting for input and what it expects for output.

Contents:

• Prerequisites
• Installing JamDB
  • Steps
• Namespaces
  • Creating a namespace
  • Authorizing against a namespace
  • Investigating a namespace
  • Namespace Permissions
• Collections
  • Creating a collection
  • Adding collection permissions
• Documents
  • Creating Documents
  • Filtering, Pagination, and Sorting
    • Filtering
    • Page size
    • Sorting
  • Searching
• Authentication
  • Authenticating
    • OSF
  • Authorizing
  • User Ids
    • Type
    • Provider
    • Id
  • User Selectors
    • User Selectors
• Data Modeling
• Permissions
• Contributing
• Limitations
  • Imposed by JamDB
  • Elasticsearch
  • MongoDB
• API Semantics
  • Notes
  • Routes list
  • Extensions
    • JSONPatch
      • Deviations
    • Bulk
      • Deviations

Indices and tables

• Index
• Module Index
• Search Page