relations

Relations Example

What This Teaches

Use this when local data files need related records but you still want plain ids in JSON. It demonstrates to-one relation metadata, explicit REST expand, and nested select.

Files To Inspect

• db/users.schema.jsonc: target collection.
• db/posts.schema.jsonc: authorId declares a relation to users.id.
• db.config.js: default mirror setup using defineConfig.

Run It

From the repository root, use the repo-internal CLI path:

pnpm run db -- sync --cwd ./examples/relations
pnpm run db -- serve --cwd ./examples/relations

Open the local data explorer:

http://127.0.0.1:7331/__db

Expected Result

The local data explorer lists posts and users. The posts schema shows an author relation derived from authorId.

REST Request To Try

Leave serve running and run this from another terminal:

curl 'http://127.0.0.1:7331/db/posts.json?expand=author&select=id,title,author.name'

Relation expansion is intentionally explicit and depth 1 in this version.

Features To Notice

• Relationship expansion
• Nested select fields
• Schema relation metadata
• File-backed .json REST routes

Cleanup

Generated .db/ output is ignored by git and can be removed whenever you want a fresh mirror.

More Docs

• Data Files And Schemas
• Server And Local Data Explorer