---
title: "Documentation"
description: "Index of every Sapporta documentation page: getting started, the guides, the reference, and the standalone Sapporta Grid."
canonical: "https://sapporta.com/docs/"
---

> Documentation index: https://sapporta.com/llms.txt

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](/api-reference/llms.txt) names every exported symbol
and the specifier that publishes it; [llms.txt](/llms.txt) is the retrieval
index for the whole site.

## Getting Started

- [Welcome to Sapporta](/docs/getting-started/introduction.md)
- [Technical overview](/docs/technical-overview.md)
- [Create a Sapporta project](/docs/getting-started/create-a-project.md)
- [Tour the generated project](/docs/getting-started/tour-the-generated-project.md)
- [Develop with a coding agent](/docs/guides/discovery/develop-with-a-coding-agent.md)

## Guides

- [Guides](/docs/guides.md)
- [Choose an application interface](/docs/guides/discovery/choose-an-application-interface.md)

### Model table-backed features

- [Tables, columns, and schema metadata](/docs/guides/model-data/tables-columns-and-schema-metadata.md)
- [Relationships and lookup behavior](/docs/guides/model-data/relationships-and-lookup-behavior.md)
- [Show a table as a tree](/docs/guides/model-data/show-a-table-as-a-tree.md)
- [Computed fields and row captions](/docs/guides/model-data/computed-fields-and-row-captions.md)
- **Table search**
  - [Search table rows and relationships](/docs/guides/model-data/search-indexes-and-display-metadata.md)
  - [Configure table search](/docs/guides/model-data/configure-table-search.md)
  - [Use table search](/docs/guides/model-data/use-table-search.md)
  - [Relational search semantics and security](/docs/guides/model-data/relational-search-semantics-and-security.md)
  - [Index relational search paths](/docs/guides/model-data/index-relational-search-paths.md)
- [Schema changes and migrations](/docs/guides/model-data/schema-changes-and-migrations.md)
- [Generated record screens and forms](/docs/guides/generated-surfaces/record-screens-and-forms.md)
- **Generated table APIs**
  - [Generated table APIs](/docs/guides/generated-surfaces/generated-table-apis.md)
  - [Generated lookups and CSV export](/docs/guides/generated-surfaces/generated-lookups-and-csv-export.md)
  - [Count visible rows](/docs/guides/generated-surfaces/count-visible-rows.md)
  - [Filtering, sorting, search, and pagination](/docs/guides/generated-surfaces/filtering-sorting-search-and-pagination.md)

### Build custom data interfaces

- [Grid-first record workflows](/docs/guides/generated-surfaces/grid-first-record-workflows.md)
- [Show rows with their captions and display slots](/docs/guides/generated-surfaces/row-captions-and-display-slots.md)
- **Registered-table Grid**
  - [Grid interaction and selection](/docs/guides/generated-surfaces/grid-interaction-and-selection.md)
  - [Table-aware grids and customization](/docs/guides/generated-surfaces/table-aware-grids-and-customization.md)
  - [Low-level TGrid sessions](/docs/guides/generated-surfaces/low-level-tgrid-sessions.md)
- [Bounded GridCore projections](/docs/guides/application-code/bounded-gridcore-projections.md)
- **Custom forms**
  - [Custom forms and cached table reads](/docs/guides/application-code/custom-forms-and-table-queries.md)
  - [Custom forms and validation](/docs/guides/application-code/custom-forms-and-validation.md)
  - [Cached table reads and refresh](/docs/guides/application-code/cached-table-reads-and-refresh.md)
  - [Stage multi-row drafts in a Grid](/docs/guides/application-code/staged-multi-row-drafts.md)
- **Custom screens**
  - [Custom frontend routes and screens](/docs/guides/application-code/custom-frontend-routes-and-screens.md)
  - [Custom workflow screens](/docs/guides/application-code/custom-workflow-screens.md)
  - [Frontend routes, navigation, and layout](/docs/guides/application-code/frontend-routes-navigation-and-layout.md)

### Build domain workflows

- [Shared contracts and request validation](/docs/guides/application-code/shared-contracts-and-request-validation.md)
- [Domain workflows and transactions](/docs/guides/application-code/domain-workflows-and-transactions.md)
- [Parent-detail transactions](/docs/guides/application-code/parent-detail-transactions.md)
- [Custom API endpoints](/docs/guides/application-code/custom-api-endpoints.md)
- **Endpoint patterns**
  - [Errors, uploads, and endpoint patterns](/docs/guides/application-code/errors-uploads-and-endpoint-patterns.md)
  - [Expected errors and HTTP mapping](/docs/guides/application-code/expected-errors-and-http-mapping.md)
  - [Multipart file uploads](/docs/guides/application-code/multipart-file-uploads.md)
  - [Non-JSON and raw responses](/docs/guides/application-code/non-json-and-raw-responses.md)
- [Typed API clients](/docs/guides/application-code/typed-api-clients.md)

### Secure actions and data

- [Authentication and abilities](/docs/guides/security/authentication-and-abilities.md)
- [Workspaces, ownership, and row visibility](/docs/guides/security/workspaces-ownership-and-row-visibility.md)
- **Row-safe custom data**
  - [Row-safe custom endpoints and reports](/docs/guides/security/row-safe-custom-endpoints-and-reports.md)
  - [Scoped table reads and writes](/docs/guides/security/scoped-table-reads-and-writes.md)
  - [Immutable tables and trusted raw access](/docs/guides/security/immutable-tables-and-trusted-raw-access.md)
- [Agent access and scoped tokens](/docs/guides/security/agent-access-and-scoped-tokens.md)

### Build reports

- [Route-based reports](/docs/guides/reports/route-based-reports.md)
- [Scoped report data](/docs/guides/reports/scoped-report-data.md)
- [Group and filter by day](/docs/guides/reports/group-and-filter-by-day.md)
- [Report datasets and formatting](/docs/guides/reports/report-datasets-and-formatting.md)
- [Name table rows in report cells](/docs/guides/reports/report-reference-columns.md)
- [Report screens and URL state](/docs/guides/reports/report-screens-and-url-state.md)
- [Drill-through and cross-report links](/docs/guides/reports/drill-through-and-cross-report-links.md)

### Inspect and operate a running application

- [OpenAPI and endpoint discovery](/docs/guides/discovery/openapi-and-endpoint-discovery.md)
- [Use the Sapporta CLI](/docs/guides/discovery/use-the-sapporta-cli.md)
- [Use the agent data console](/docs/guides/discovery/use-the-agent-data-console.md)

### Configure and ship

- [Application configuration](/docs/guides/operations/application-configuration.md)
- [Sample data and command-line scripts](/docs/guides/operations/sample-data-and-scripts.md)
- [Email and runtime services](/docs/guides/operations/email-and-runtime-services.md)
- [Run migrations in deployed environments](/docs/guides/operations/run-migrations-in-deployed-environments.md)
- [Production builds and deployment](/docs/guides/operations/production-builds-and-deployment.md)
- [Troubleshoot startup, native modules, auth, and migrations](/docs/guides/operations/troubleshooting.md)

## Reference

- [Reference](/docs/reference.md)

### Project and configuration

- [Project file map](/docs/reference/project/project-files.md)
- [Environment variables](/docs/reference/project/environment-variables.md)

### Schema and tables

- [Table definitions](/docs/reference/schema/table-definitions.md)
- [Table and column metadata](/docs/reference/schema/table-and-column-metadata.md)
- [Table validation](/docs/reference/schema/table-validation.md)
- **Semantic values**
  - [Semantic value boundaries](/docs/reference/schema/semantic-value-boundaries.md)
  - [Generated and client values](/docs/reference/schema/semantic-values/generated-and-client-values.md)
  - [Server write values and contracts](/docs/reference/schema/semantic-values/server-write-values-and-contracts.md)
- [Schema metadata types](/docs/reference/schema/schema-metadata-types.md)
- [Migrations](/docs/reference/schema/migrations.md)

### Generated HTTP surface

- [Table endpoints](/docs/reference/http/table-endpoints.md)
- [Query syntax](/docs/reference/http/query-syntax.md)
- [Metadata and SQL endpoints](/docs/reference/http/metadata-and-sql-endpoints.md)
- [OpenAPI](/docs/reference/http/openapi.md)
- [Authentication and token endpoints](/docs/reference/http/authentication-and-token-endpoints.md)

### Server APIs

- [TsRestApi and route registration](/docs/reference/server/ts-rest-api-and-route-registration.md)
- [Auth and row security](/docs/reference/server/auth-and-row-security.md)
- [Days and time zones](/docs/reference/server/days-and-time-zones.md)
- **Row-scoped data**
  - [Row-scoped data helpers](/docs/reference/server/row-scoped-data-helpers.md)
  - [Scoped CRUD and bounded reads](/docs/reference/server/row-scoped-data/scoped-crud-and-bounded-reads.md)
  - [Scoped lookups and counts](/docs/reference/server/row-scoped-data/lookups-and-counts.md)
  - [Generated query resolvers](/docs/reference/server/row-scoped-data/generated-query-resolvers.md)
  - [Table row-security guards](/docs/reference/server/row-scoped-data/table-row-security-guards.md)
  - [Computed fields and tree paths](/docs/reference/server/row-scoped-data/computed-fields-and-tree-paths.md)
- [Runtime services](/docs/reference/server/runtime-services.md)

### Shared contracts and clients

- [Contract helpers and wire types](/docs/reference/contracts/contract-helpers-and-wire-types.md)
- [Typed client creation](/docs/reference/contracts/typed-client-creation.md)
- [Serialization and API errors](/docs/reference/contracts/serialization-and-api-errors.md)

### Frontend APIs

- [Column sizing](/docs/reference/column-sizing.md)
- **App shell**
  - [App shell, routes, and navigation](/docs/reference/frontend/app-shell-routes-and-navigation.md)
  - [Application routes and navigation](/docs/reference/frontend/app-shell/application-routes-and-navigation.md)
  - [App shell layout and sidebar](/docs/reference/frontend/app-shell/layout-and-sidebar.md)
- [Theme tokens and scales](/docs/reference/frontend/theme-tokens-and-scales.md)
- [Generated record surfaces and form helpers](/docs/reference/frontend/generated-record-surfaces.md)
- [Table lookups and record ids](/docs/reference/frontend/lookups.md)
- **Table queries**
  - [Table query options](/docs/reference/frontend/table-query-options.md)
  - [Table read functions and query options](/docs/reference/frontend/table-queries/read-functions-and-options.md)
  - [Table query cache keys and ownership](/docs/reference/frontend/table-queries/cache-keys-and-ownership.md)
- **TGrid**
  - [TGrid](/docs/reference/frontend/tgrid.md)
  - [TGrid definitions, sessions, and queries](/docs/reference/frontend/tgrid/definitions-sessions-and-queries.md)
  - [TGrid interactions, columns, and writes](/docs/reference/frontend/tgrid/interactions-columns-and-writes.md)

### Reports

- [Report routes and registration](/docs/reference/reports/report-routes-and-registration.md)
- [GridDataset](/docs/reference/reports/grid-dataset.md)
- [Report links](/docs/reference/reports/report-links.md)
- [Scoped report helpers](/docs/reference/reports/scoped-report-helpers.md)

### CLI

- [CLI overview and global options](/docs/reference/cli/overview-and-global-options.md)
- [Project and discovery commands](/docs/reference/cli/project-and-discovery-commands.md)
- [Table, row, and report commands](/docs/reference/cli/table-row-and-report-commands.md)
- [API and SQL commands](/docs/reference/cli/api-and-sql-commands.md)
- [Output formats and exit codes](/docs/reference/cli/output-formats-and-exit-codes.md)

### Deployment and diagnostics

- [Runtime and deployment contract](/docs/reference/operations/runtime-and-deployment-contract.md)
- [Migration and startup invariants](/docs/reference/operations/migration-and-startup-invariants.md)
- [Error catalogue and diagnostics](/docs/reference/operations/error-catalogue-and-diagnostics.md)

### Indexes

- [Public symbols](/docs/reference/indexes/public-symbols.md)
- [HTTP endpoints](/docs/reference/indexes/http-endpoints.md)
- [CLI commands](/docs/reference/indexes/cli-commands.md)
- [Configuration](/docs/reference/indexes/configuration.md)

## Sapporta Grid

- [Sapporta Grid overview](/grid/)

### Start

- [Install and render the first grid](/grid/start/install-and-render-the-first-grid.md)
- [Choose a grid layer](/grid/start/choose-a-grid-layer.md)

### Guides

- [Core model](/grid/guides/core-model.md)
- [Columns and editors](/grid/guides/columns-and-editors.md)
- [Data sources](/grid/guides/data-sources.md)
- [Editing and saving](/grid/guides/editing-and-saving.md)
- [Keyboard and selection](/grid/guides/keyboard-and-selection.md)
- [Copying grid data](/grid/guides/copying-grid-data.md)
- [Hierarchical grids](/grid/guides/hierarchical-grids.md)
- **Advanced rows**
  - [Advanced rows](/grid/guides/advanced-rows.md)
  - [Summary rows and footers](/grid/guides/advanced-rows/summary-rows-and-footers.md)
  - [Phantom rows and inserts](/grid/guides/advanced-rows/phantom-rows-and-inserts.md)
- [Styling](/grid/guides/styling.md)

### Reference

- [Grid reference](/grid/reference.md)
- **GridCore**
  - [GridCore reference](/grid/reference/grid-core.md)
  - [Schema, rows, paths, and identity](/grid/reference/grid-core/schema-rows-and-identity.md)
  - [GridRuntime](/grid/reference/grid-core/grid-runtime.md)
  - [GridLevelRuntime](/grid/reference/grid-core/level-runtime.md)
  - [GridCore React APIs](/grid/reference/grid-core/react-api.md)
  - [Advanced Grid composition](/grid/reference/grid-core/advanced-composition.md)
- [ColumnPreset](/grid/reference/column-preset.md)
- **Data sources**
  - [Data-source reference](/grid/reference/data-sources.md)
  - [Data-source contracts and state](/grid/reference/data-sources/contracts-and-state.md)
  - [Runtime data access](/grid/reference/data-sources/runtime-data-access.md)
  - [Data-source writes and reconciliation](/grid/reference/data-sources/writes-and-reconciliation.md)
  - [In-memory and REST data sources](/grid/reference/data-sources/in-memory-and-rest-sources.md)
  - [REST data-source helpers](/grid/reference/rest-helpers.md)
- [Clipboard API](/grid/reference/clipboard.md)
- **Interactions**
  - [Grid interactions](/grid/reference/interactions.md)
  - [Interaction configuration and presets](/grid/reference/interactions/configuration-and-presets.md)
  - [Active rows and row activation](/grid/reference/interactions/active-row-and-activation.md)
  - [Row selection](/grid/reference/interactions/row-selection.md)
- [Grid DOM state contract](/grid/reference/dom-and-styling-contract.md)