# Flutter InstantDB

> Flutter SDK for InstantDB — a real-time, offline-first, local-first database with reactive bindings. Type-safe InstaQL queries, optimistic InstaML transactions, WebSocket sync, auth, presence/rooms, file storage, and reactive widgets for iOS, Android, Web, macOS, Windows, and Linux.

## Overview

- [Flutter InstantDB](https://flutter-instantdb.vercel.app/docs): Real-time, offline-first database for Flutter with reactive bindings, type-safe queries and code generation.

## Advanced

- [Migration Strategies](https://flutter-instantdb.vercel.app/docs/advanced/migration): Upgrading Flutter InstantDB and handling data migrations
- [Offline Functionality](https://flutter-instantdb.vercel.app/docs/advanced/offline): Building offline-first applications with Flutter InstantDB
- [Performance Optimization](https://flutter-instantdb.vercel.app/docs/advanced/performance): Optimizing Flutter InstantDB applications for best performance
- [Schema CLI (TS ⇆ Dart)](https://flutter-instantdb.vercel.app/docs/advanced/schema-cli): Convert instant.schema.ts to and from Dart @InstantModel classes
- [Files & Storage](https://flutter-instantdb.vercel.app/docs/advanced/storage): Upload, download, and delete files with db.storage and the $files namespace
- [Troubleshooting](https://flutter-instantdb.vercel.app/docs/advanced/troubleshooting): Common issues and debugging techniques for Flutter InstantDB

## Api

- [InstantDB API](https://flutter-instantdb.vercel.app/docs/api/instantdb): Complete API reference for the core InstantDB class
- [Presence API](https://flutter-instantdb.vercel.app/docs/api/presence-api): Complete API reference for InstantDB presence and real-time collaboration
- [Queries API](https://flutter-instantdb.vercel.app/docs/api/queries): Complete API reference for InstantDB queries and InstaQL syntax
- [Transactions API](https://flutter-instantdb.vercel.app/docs/api/transactions): Complete API reference for InstantDB transactions and operations
- [Types Reference](https://flutter-instantdb.vercel.app/docs/api/types): Complete type definitions and interfaces for Flutter InstantDB
- [Flutter Widgets](https://flutter-instantdb.vercel.app/docs/api/widgets): Complete reference for Flutter InstantDB reactive widgets

## Auth

- [Permissions & Access Control](https://flutter-instantdb.vercel.app/docs/auth/permissions): Role-based access control and permission management in Flutter InstantDB
- [Session Management](https://flutter-instantdb.vercel.app/docs/auth/sessions): Managing user sessions, tokens, and authentication persistence in Flutter InstantDB
- [User Management](https://flutter-instantdb.vercel.app/docs/auth/users): Authentication and user management with Flutter InstantDB

## Concepts

- [Database Initialization](https://flutter-instantdb.vercel.app/docs/concepts/database): How to initialize and configure InstantDB
- [Schema Definition](https://flutter-instantdb.vercel.app/docs/concepts/schema): Define and validate data structures with Flutter InstantDB schemas

## Flutter

- [Flutter Widgets](https://flutter-instantdb.vercel.app/docs/flutter/widgets): Reactive widgets for Flutter InstantDB

## Getting Started

- [Installation](https://flutter-instantdb.vercel.app/docs/getting-started/installation): How to install Flutter InstantDB
- [Quick Start](https://flutter-instantdb.vercel.app/docs/getting-started/quick-start): Build your first real-time app with InstantDB Flutter

## Queries

- [Aggregations](https://flutter-instantdb.vercel.app/docs/queries/aggregations): Count, sum, average, min, and max over your data with db.count and db.aggregate
- [Basic Queries](https://flutter-instantdb.vercel.app/docs/queries/basics): Learn how to query data with Flutter InstantDB
- [Query Operators](https://flutter-instantdb.vercel.app/docs/queries/operators): String matching, negation, logical combinators, and dot-notation in where clauses
- [Pagination & Fields](https://flutter-instantdb.vercel.app/docs/queries/pagination): Cursor pagination, pageInfo, field projection, and infinite queries

## Realtime

- [Collaborative Features](https://flutter-instantdb.vercel.app/docs/realtime/collaboration): Build multi-user collaborative experiences with Flutter InstantDB
- [Presence System](https://flutter-instantdb.vercel.app/docs/realtime/presence): Real-time collaboration with cursors, typing indicators, and reactions
- [WebSocket Synchronization](https://flutter-instantdb.vercel.app/docs/realtime/sync): Real-time data synchronization with Flutter InstantDB

## Typed

- [Code Generation](https://flutter-instantdb.vercel.app/docs/typed/codegen): Generate typed tables from annotated models with flutter_instantdb_generator
- [Typed Layer Overview](https://flutter-instantdb.vercel.app/docs/typed/overview): Compile-time-safe queries and writes over the same InstantDB engine
- [Typed Query DSL](https://flutter-instantdb.vercel.app/docs/typed/query-dsl): Build compile-time-safe InstaQL queries with Col, Filter, Order and TypedQuery
- [Typed Relations](https://flutter-instantdb.vercel.app/docs/typed/relations): Model relations with @InstantLink, typed includes, and recursively-typed fromRow
- [Typed Transactions](https://flutter-instantdb.vercel.app/docs/typed/transactions): Compile-time-safe writes with db.txFor, fluent set, whole-model writes, and typed relations

## Full text

- [Complete docs](https://flutter-instantdb.vercel.app/llms-full.txt)