DOCUMENT STORES
Complete documents
Choose where authoritative serialized documents live.
R2D1 / DOCS
Choose the backends. Then use one API.
Start with the two backend roles. A DocumentStore owns complete documents; an IndexStore owns the fields used for indexed lookup. After both are configured, the collection API is shared across every pairing.
INDEX STORES
Indexed lookup
Choose where document identifiers and indexed fields are projected.
COMMON API
The usage stays the same.
Getting Started
Set up both backend roles, define a document, and run the first indexed query.
Start the common path →Core Concepts
Understand collections, metadata, authoritative documents, indexes, and cursors.
Read Core Concepts →Querying
Filter indexed fields, apply one sort, and continue with opaque cursor pagination.
Read Querying →Consistency and Recovery
Handle partial failures and rebuild the derived index from authoritative documents.
Read Consistency →PUBLIC MODULES
The four published artifacts.
R2D1
dev.nexcraft:r2d1Common API plus R2 and D1 adapters.
Configuration →R2D1-JDBC
dev.nexcraft:r2d1-jdbcH2, HSQLDB, and local SQLite index support.
JDBC setup →R2D1-FILESYSTEM
dev.nexcraft:r2d1-filesystemCanonical local document files.
Filesystem setup →R2D1-MICRONAUT
dev.nexcraft:r2d1-micronautMicronaut 5 bean and resource integration.
Micronaut setup →DOCUMENTATION BOUNDARY
Examples follow the current code.
Backend pages explain vendor setup and ownership. The common API pages explain how to define, mutate, query, and recover collections without changing those backend choices.