# superapp Documentation

> A thin, secure data layer between your frontend and any database — with authentication, row-level permissions, and type safety built in.

This file lists all 87 documentation pages. For the full content, see llms-full.txt.

- [Introduction](/docs/index.md): A thin, secure data layer between your frontend and any database.
- [Installation](/docs/getting-started/installation.md): Install the server engine and client SDK.
- [Quick Start](/docs/getting-started/quick-start.md): Get running in 5 minutes.
- [Overview](/docs/backend/overview.md): What @superapp/backend does, how it works, and what routes it exposes.
- [Configuration](/docs/backend/configuration.md): Configure and initialize the superapp backend engine with connections, auth, permissions, and more.
- [Overview](/docs/backend/admin-ui/index.md): Visual dashboard to configure connections, permissions, actions, limits, security, and audit logging — all from the browser.
- [Connections](/docs/backend/admin-ui/connections.md): Manage database connections — add, remove, and monitor connection health from the admin dashboard.
- [Permissions & Roles](/docs/backend/admin-ui/permissions-roles.md): Visual permission editor and role access matrix — manage who can access what, down to the row and column level.
- [Actions](/docs/backend/admin-ui/actions.md): Browse registered server-side actions, view typed schemas, and test them from the built-in playground.
- [Limits & Security](/docs/backend/admin-ui/limits-security.md): Configure rate limits, query constraints, JWT validation, CORS policies, and audit logging.
- [Audit Log](/docs/backend/admin-ui/audit-log.md): Filter and inspect every query that passes through the engine — by operation, status, user, and more.
- [Databases](/docs/backend/databases/index.md): Connect to any database with Drizzle-compatible adapters.
- [Supported Databases](/docs/backend/databases/supported-databases.md): Every database supported through Drizzle ORM adapters.
- [PostgreSQL](/docs/backend/databases/postgres.md): Connect to PostgreSQL databases.
- [MySQL](/docs/backend/databases/mysql.md): Connect to MySQL databases.
- [SQLite](/docs/backend/databases/sqlite.md): Connect to SQLite databases.
- [Neon Serverless](/docs/backend/databases/neon-serverless.md): Connect to Neon via WebSocket or HTTP.
- [Supabase](/docs/backend/databases/supabase.md): Connect to Supabase Postgres.
- [PlanetScale](/docs/backend/databases/planetscale.md): Connect to PlanetScale serverless MySQL.
- [Vercel Postgres](/docs/backend/databases/vercel-postgres.md): Connect via Vercel's managed Postgres.
- [LibSQL / Turso](/docs/backend/databases/libsql.md): Connect to Turso or LibSQL databases.
- [Cloudflare D1](/docs/backend/databases/d1.md): Connect to Cloudflare D1 SQLite.
- [Postgres.js](/docs/backend/databases/postgres-js.md): Connect with the postgres.js driver.
- [PGlite](/docs/backend/databases/pglite.md): In-browser and in-process Postgres via WASM.
- [AWS Data API](/docs/backend/databases/aws-data-api.md): Connect to Aurora Serverless via AWS RDS Data API.
- [Bun SQLite](/docs/backend/databases/bun-sqlite.md): Connect using Bun's native SQLite driver.
- [SingleStore](/docs/backend/databases/singlestore.md): Connect to SingleStore databases.
- [Expo SQLite](/docs/backend/databases/expo-sqlite.md): Connect from React Native using Expo SQLite.
- [Xata](/docs/backend/databases/xata.md): Connect to Xata serverless database.
- [TiDB Cloud](/docs/backend/databases/tidb.md): Connect to TiDB Cloud serverless.
- [sql.js](/docs/backend/databases/sql-js.md): In-browser SQLite via WASM.
- [Gel](/docs/backend/databases/gel.md): Connect to Gel (formerly EdgeDB).
- [CSV](/docs/backend/databases/csv.md): Query CSV files as tables.
- [Custom Providers](/docs/backend/databases/custom-provider.md): Build a Drizzle-compatible provider for any data source.
- [Authentication](/docs/backend/auth/index.md): How auth providers work, the resolveSession interface, and session enrichment.
- [better-auth](/docs/backend/auth/better-auth.md): Set up the default authentication provider with better-auth, user table config, and session enrichment.
- [Custom Provider](/docs/backend/auth/custom-provider.md): Implement a custom authentication provider using the AuthProvider interface.
- [Where Clauses](/docs/backend/permissions/where.md): Restrict which rows users can read, update, and delete — grouped by operation.
- [Validate](/docs/backend/permissions/validate.md): Validate data on insert and update operations before it reaches the database.
- [Defaults & Overwrite](/docs/backend/permissions/defaults.md): Automatically fill missing values with default or force values with overwrite on insert and update.
- [Operators](/docs/backend/permissions/operators.md): Complete reference of MongoDB-style operators available in where clauses, validate rules, and defaults.
- [Raw SQL](/docs/backend/permissions/sql.md): Write advanced WHERE clauses with raw SQL for cases that standard operators cannot express.
- [Middleware](/docs/backend/permissions/middleware.md): Run custom TypeScript before and after query execution — modify where clauses, transform input, restrict columns, and run side effects.
- [Actions](/docs/backend/actions.md): Typed server-side functions callable by the client, with full access to the database, user session, and any table.
- [Hono](/docs/backend/adapters/hono.md): Deploy the superapp backend with Hono, the recommended adapter for Node.js and edge runtimes.
- [Next.js](/docs/backend/adapters/nextjs.md): Integrate the superapp backend into a Next.js App Router project with a catch-all route handler.
- [Express](/docs/backend/adapters/express.md): Add the superapp backend to an existing Express application as a router middleware.
- [Generic (Workers/Deno/Bun)](/docs/backend/adapters/generic.md): Use the generic adapter for Cloudflare Workers, Deno, Bun, or any runtime with the Web Fetch API.
- [PostgreSQL Wire Protocol](/docs/backend/adapters/pg-wire.md): Expose the superapp engine as a PostgreSQL-compatible server using pg-gateway. Connect with psql, DBeaver, Metabase, or any PG driver.
- [Overview](/docs/client/overview.md): Drizzle ORM for the frontend — real Drizzle with a proxy driver that returns permission-filtered data.
- [Setup](/docs/client/setup.md): Configure the Drizzle ORM client with your superapp backend connection and generated schema.
- [Select](/docs/client/queries/select.md): Fetch rows with filtering, sorting, joins, pagination, and relational queries.
- [Insert](/docs/client/queries/insert.md): Insert one or more rows with type-safe values.
- [Update](/docs/client/queries/update.md): Update one or more rows matching a condition.
- [Delete](/docs/client/queries/delete.md): Delete one or more rows matching a condition.
- [Filter Operators](/docs/client/queries/filtering.md): All Drizzle ORM filter operators for building query conditions.
- [Aggregations](/docs/client/queries/aggregations.md): Count rows and compute sum, avg, min, max with Drizzle's aggregation functions.
- [Setup](/docs/client/auth/setup.md): Configure the auth client for session management and authentication in your frontend.
- [Session Management](/docs/client/auth/session.md): How sessions, tokens, and automatic refresh work in the client SDK.
- [Auth Provider](/docs/client/components/auth-provider.md): Root layout wrapper that provides auth context to all child components.
- [Auth Card](/docs/client/components/auth-card.md): Pre-built sign-in, sign-up, and forgot-password UI component.
- [User Button](/docs/client/components/user-button.md): Navbar dropdown component with user avatar and sign-out action.
- [Type Generation](/docs/client/type-generation.md): Generate TypeScript types from your database schema for fully type-safe queries.
- [Architecture](/docs/advanced/architecture.md): "How the pieces fit together."
- [Request Pipeline](/docs/advanced/request-pipeline.md): The complete 9-step request pipeline from incoming request to JSON response.
- [Engine Modes](/docs/advanced/engine-modes.md): "Programmatic vs Interactive mode."
- [Multi-Database Querying](/docs/advanced/multi-database.md): "Connect to Postgres, MySQL, SQLite, and CSV simultaneously."
- [Audit Logging](/docs/advanced/audit-logging.md): Track every query with user context, parameters, duration, and automatic retention policies.
- [Overview](/docs/advanced/security/overview.md): Defense-in-depth security architecture.
- [Session Isolation](/docs/advanced/security/session-isolation.md): Every request gets an isolated database connection.
- [JWT Validation](/docs/advanced/security/jwt-validation.md): Algorithm allowlists and claims verification.
- [Encryption](/docs/advanced/security/encryption.md): Connection secret encryption with AES-256-GCM.
- [Request Limits](/docs/advanced/security/request-limits.md): Rate limiting and query constraints.
- [Orders Dashboard](/docs/examples/orders-dashboard.md): Full CRUD example with auth, validation, and row-level security.
- [Multi-Tenant SaaS](/docs/examples/multi-tenant-saas.md): Organization-scoped permissions setup.
- [createEngine Options](/docs/reference/server-api/create-engine.md): "Complete configuration reference."
- [Permission Object](/docs/reference/server-api/permission-object.md): "Complete permission shape reference."
- [AuthProvider Interface](/docs/reference/server-api/auth-provider.md): "Build custom auth providers."
- [drizzle() Options](/docs/reference/client-api/create-client.md): "Drizzle client configuration reference."
- [Query Methods](/docs/reference/client-api/query-methods.md): "All Drizzle query methods available through the superapp client."
- [Filter Operators](/docs/reference/client-api/filter-operators.md): "Complete Drizzle filter operator reference."
- ["POST /data"](/docs/reference/http-api/data-endpoint.md): "Query endpoint request and response format."
- [Auth Endpoints](/docs/reference/http-api/auth-endpoints.md): "Authentication API routes."
- ["GET /schema"](/docs/reference/http-api/schema-endpoint.md): "Schema introspection endpoint."
- [create-app](/docs/reference/cli/create-app.md): Scaffold a new project.
- [generate](/docs/reference/cli/generate.md): Generate TypeScript types from your engine.
- [llms.txt](/docs/llms-txt.md): Machine-readable documentation for AI agents and LLMs.