Database Studio

Database Studio is where most system configurators do their day-to-day work. It is the main place to model collections, tune route behavior, shape record interfaces, and inspect staged data design.

Database Studio is fork-aware
If you have an active fork, Database Studio reflects the staged blueprint state for that fork rather than the current production checkpoint.

What You Do In Database Studio

Use Database Studio for four main jobs:

  • Design the collection schema
  • Configure route-level behavior
  • Shape the record interface
  • Review how records and related data will behave operationally

1. Schema Editor

The schema editor is where you define the structure of a collection.

Typical tasks include:

  • Adding or renaming columns
  • Choosing data types
  • Configuring linked records and relationships
  • Reviewing how the schema supports real workflows

Staging Workflow

Structural work should be treated as staged configuration, not a live edit.

  1. Open a fork.
  2. Make the schema changes there.
  3. Review issues and test the result.
  4. Merge the fork to apply the resulting schema changes to production.

2. Route Configuration

Each collection exposes five standard routes: list, view, create, update, and delete. Database Studio lets you define what those routes should do beyond the default CRUD behavior.

Database Studio lets you define:

  • Validation for mutation routes
  • Import configuration for create and update routes
  • Export configuration for list and view routes
  • Notification configuration for mutation routes

See Route Configuration for more detail.

3. The Interface Tab

The Interface tab controls the form used for record create, update, and view flows. This is where you edit the collection's form_codeblock.

If a collection does not yet have a form codeblock, you can generate a starter layout from the schema and then customize it.

4. Data Viewer

The data viewer helps you inspect how the collection behaves with real records.

  • Filter and sort records
  • Open record detail views
  • Validate how labels, interfaces, and permissions feel in practice
  • Verify that configured exports and mutation behavior match expectations
Check the user flow, not just the config form
Some route capabilities are configuration-level features first. Before rolling out a workflow, validate that the intended user-facing surface exposes the route behavior the way you expect.
  1. Model the collection in the schema editor.
  2. Set the interface so users can work with records cleanly.
  3. Add route behavior such as validation, export, and notifications.
  4. Use the data viewer to test the operational result.
Previous Collections Next Interface