# rsql

> Run isolated SQLite databases behind one HTTP service, with Go and TypeScript clients.

## Start

- [Overview](https://rsql.k2b.dev/en.md): Provision and operate isolated SQLite databases behind one HTTP service.
- [Quickstart](https://rsql.k2b.dev/en/quickstart.md): Start rsql and perform the first schema and row operations.

## Concepts

- [Namespaces](https://rsql.k2b.dev/en/concepts/namespaces.md): Understand rsql database isolation, lifecycle, and runtime limits.
- [Schema and rows](https://rsql.k2b.dev/en/concepts/schema-and-rows.md): Model tables, views, columns, indexes, and typed rows in rsql.
- [Query and realtime](https://rsql.k2b.dev/en/concepts/query-and-realtime.md): Use read-only SQL, SSE change events, and the schema changelog.

## Clients

- [Go](https://rsql.k2b.dev/en/clients/go.md): Use the concurrency-safe Go client for administration, data operations, streaming, and gateways.
- [TypeScript](https://rsql.k2b.dev/en/clients/typescript.md): Use the stateless hierarchical TypeScript client in Bun, Node, or browsers.

## Hosting

- [Multi-tenant](https://rsql.k2b.dev/en/hosting/multi-tenant.md): Place rsql behind an authenticated gateway and preserve namespace isolation.
- [Quotas and overview](https://rsql.k2b.dev/en/hosting/quotas-and-overview.md): Enforce namespace storage quotas and build tenant database dashboards.
- [Backups and scaling](https://rsql.k2b.dev/en/hosting/backups-and-scaling.md): Back up, restore, move, and shard namespace databases safely.

## API Reference

- [HTTP API](https://rsql.k2b.dev/en/reference/http-api.md): Navigate the complete rsql control-plane and data-plane HTTP API.
- [Namespaces](https://rsql.k2b.dev/en/reference/namespaces-api.md): Provision, configure, copy, import, export, and delete databases.
- [Schema](https://rsql.k2b.dev/en/reference/schema-api.md): Manage tables, views, columns, indexes, and FTS search.
- [Rows](https://rsql.k2b.dev/en/reference/rows-api.md): Insert, read, update, delete, bulk mutate, and export typed rows.
- [Filtering](https://rsql.k2b.dev/en/reference/filtering.md): Filter, search, order, select, aggregate, and paginate row results.
- [Query and events](https://rsql.k2b.dev/en/reference/query-events-api.md): Execute read-only SQL, subscribe to changes, inspect schema history, and read namespace health.
- [Errors and headers](https://rsql.k2b.dev/en/reference/errors-and-headers.md): Handle rsql authentication, request IDs, preferences, status codes, and stable error values.

## Operations

- [Installation](https://rsql.k2b.dev/en/operations/installation.md): Install and operate rsql as a native systemd service on Debian or Rocky Linux.
- [Configuration](https://rsql.k2b.dev/en/reference/configuration.md): Configure rsql through Cobra flags, environment variables, and dotenv files.
- [Metrics and profiling](https://rsql.k2b.dev/en/operations/metrics-and-profiling.md): Monitor rsql with Prometheus metrics, namespace overview data, and optional pprof.

## Project

- [Architecture](https://rsql.k2b.dev/en/project/architecture.md): Understand the rsql process, package boundaries, storage layout, and request flow.
- [Development](https://rsql.k2b.dev/en/project/development.md): Build, test, document, and validate changes to rsql.
- [Performance](https://rsql.k2b.dev/en/project/performance.md): Run deterministic fast and deep real-world rsql workloads.
- [Security](https://rsql.k2b.dev/en/project/security.md): Deploy rsql within its authentication, network, SQL, and resource boundaries.

## Full text

- [All pages in one file](https://rsql.k2b.dev/en/llms-full.txt)