Documentation

Sapporta turns table definitions into a running database application: generated CRUD endpoints, record screens, row-scoped access, reports, and a CLI to operate the result. This page indexes every documentation page there is.

Coding agents can fetch the Markdown form of any page below by appending .md to its path — /docs/reference.md for the reference index, and so on. The Sapporta API reference names every exported symbol and the specifier that publishes it; llms.txt is the retrieval index for the whole site.

Getting Started

• Welcome to Sapporta
• Technical overview
• Create a Sapporta project
• Tour the generated project
• Develop with a coding agent

Guides

• Guides
• Choose an application interface

Model table-backed features

• Tables, columns, and schema metadata
• Relationships and lookup behavior
• Table search
  • Search table rows and relationships
  • Configure table search
  • Use table search
  • Relational search semantics and security
  • Index relational search paths
• Schema changes and migrations
• Generated record screens and forms
• Generated table APIs
  • Generated table APIs
  • Generated lookups and CSV export
  • Count visible rows
  • Filtering, sorting, search, and pagination

Build custom data interfaces

• Grid-first record workflows
• Registered-table Grid
  • Grid interaction and selection
  • Table-aware grids and customization
  • Low-level TGrid sessions
• Bounded GridCore projections
• Custom forms
  • Custom forms and cached table reads
  • Custom forms and validation
  • Cached table reads and refresh
  • Stage multi-row drafts in a Grid
• Custom screens
  • Custom frontend routes and screens
  • Custom workflow screens
  • Frontend routes, navigation, and layout

Build domain workflows

• Shared contracts and request validation
• Domain workflows and transactions
• Parent-detail transactions
• Custom API endpoints
• Endpoint patterns
  • Errors, uploads, and endpoint patterns
  • Expected errors and HTTP mapping
  • Multipart file uploads
  • Non-JSON and raw responses
• Typed API clients

Secure actions and data

• Authentication and abilities
• Workspaces, ownership, and row visibility
• Row-safe custom data
  • Row-safe custom endpoints and reports
  • Scoped table reads and writes
  • Immutable tables and trusted raw access
• Agent access and scoped tokens

Build reports

• Route-based reports
• Scoped report data
• Group and filter by day
• Report datasets and formatting
• Report screens and URL state
• Drill-through and cross-report links

Inspect and operate a running application

• OpenAPI and endpoint discovery
• Use the Sapporta CLI
• Use the agent data console

Configure and ship

• Application configuration
• Sample data and command-line scripts
• Email and runtime services
• Run migrations in deployed environments
• Production builds and deployment
• Troubleshoot startup, native modules, auth, and migrations

Reference

• Reference

Project and configuration

• Project file map
• Environment variables

Schema and tables

• Table definitions
• Table and column metadata
• Table validation
• Semantic values
  • Semantic value boundaries
  • Generated and client values
  • Server write values and contracts
• Schema metadata types
• Migrations

Generated HTTP surface

• Table endpoints
• Query syntax
• Metadata and SQL endpoints
• OpenAPI
• Authentication and token endpoints

Server APIs

• TsRestApi and route registration
• Auth and row security
• Days and time zones
• Row-scoped data
  • Row-scoped data helpers
  • Scoped CRUD and bounded reads
  • Scoped lookups and counts
  • Generated query resolvers
  • Table row-security guards
• Runtime services

Shared contracts and clients

• Contract helpers and wire types
• Typed client creation
• Serialization and API errors

Frontend APIs

• Column sizing
• App shell
  • App shell, routes, and navigation
  • Application routes and navigation
  • App shell layout and sidebar
• Generated record surfaces and form helpers
• Table lookups and record ids
• Table queries
  • Table query options
  • Table read functions and query options
  • Table query cache keys and ownership
• TGrid
  • TGrid
  • TGrid definitions, sessions, and queries
  • TGrid interactions, columns, and writes

Reports

• Report routes and registration
• GridDataset
• Report links
• Scoped report helpers

CLI

• CLI overview and global options
• Project and discovery commands
• Table, row, and report commands
• API and SQL commands
• Output formats and exit codes

Deployment and diagnostics

• Runtime and deployment contract
• Migration and startup invariants
• Error catalogue and diagnostics

Indexes

• Public symbols
• HTTP endpoints
• CLI commands
• Configuration

Sapporta Grid

• Sapporta Grid overview

Start

• Install and render the first grid
• Choose a grid layer

Guides

• Core model
• Columns and editors
• Data sources
• Editing and saving
• Keyboard and selection
• Copying grid data
• Hierarchical grids
• Advanced rows
  • Advanced rows
  • Summary rows and footers
  • Phantom rows and inserts
• Styling

Reference

• Grid reference
• GridCore
  • GridCore reference
  • Schema, rows, paths, and identity
  • GridRuntime
  • GridLevelRuntime
  • GridCore React APIs
  • Advanced Grid composition
• ColumnPreset
• Data sources
  • Data-source reference
  • Data-source contracts and state
  • Runtime data access
  • Data-source writes and reconciliation
  • In-memory and REST data sources
  • REST data-source helpers
• Clipboard API
• Interactions
  • Grid interactions
  • Interaction configuration and presets
  • Active rows and row activation
  • Row selection
• Grid DOM state contract