How get-convex/convex-backend works
Convex is a reactive database platform for web applications: clients invoke server functions and subscribe to live query results, while the backend executes functions against consistent database state. The repository also includes file storage, snapshot import/export, search and vector indexing, and external data connectors. The map follows the client-to-function-to-database product shape and retains these documented capability branches. Several backend entry-point relationships are architectural rather than visible in the sampled excerpts, so those links are marked unverified.
Main entry points: client.ts Convex client · router.rs Backend serving edge · transaction.rs Reactive database · server.rs Function runner
Components 22
Client libraries
- Convex client
npm-packages/convex/src/browser/sync/client.ts - WebSocket transport
npm-packages/convex/src/browser/sync/web_socket_manager.ts - Client authentication
npm-packages/convex/src/browser/sync/authentication_manager.ts - Sync protocol
npm-packages/convex/src/browser/sync/protocol.ts - Paginated subscriptions
npm-packages/convex/src/browser/sync/paginated_query_client.ts - Value and validators
npm-packages/convex/src/values/validators.ts
Function runtime
- Backend serving edge
crates/local_backend/src/router.rs - Function runner
crates/function_runner/src/server.rs - JavaScript execution
crates/isolate/src/environment/mod.rs - Request context
crates/isolate/src/request_scope.rs
Database and indexes
- Reactive database
crates/database/src/transaction.rs - Text search
crates/search/src/query.rs - Text index manager
crates/search/src/text_index_manager.rs - Vector indexing
crates/vector/src/vector_index_manager.rs
Storage and transfer
- File storage
crates/file_storage/src/core.rs - Storage syscalls
crates/isolate/src/environment/action/storage.rs - Snapshot import
crates/application/src/snapshot_import/mod.rs - Import parsing
crates/application/src/snapshot_import/parse.rs - Snapshot export
crates/exports/src/export_storage.rs
Integrations
- S3 object storage
crates/aws_s3/src/storage.rs - Fivetran connectors
crates/fivetran_destination/src/application.rs
Other components
- Web app developer
Connections 23
- Web app developer → Convex client: uses client
README.md - Convex client → WebSocket transport: manages connection
npm-packages/convex/src/browser/sync/client.ts - Convex client → Client authentication: uses auth
npm-packages/convex/src/browser/sync/client.ts - Convex client → Sync protocol: uses protocol
npm-packages/convex/src/browser/sync/client.ts - Convex client → Value and validators: uses values
npm-packages/convex/src/browser/sync/client.ts - Convex client → Backend serving edge: sends function requests
- Convex client → Paginated subscriptions: creates paginated queries
npm-packages/convex/src/browser/sync/paginated_query_client.ts - Backend serving edge → Function runner: dispatches functions
- Function runner → JavaScript execution: executes functions
- JavaScript execution → Request context: uses request context
crates/isolate/src/ops/storage.rs - JavaScript execution → File storage: performs storage operations
- Function runner → Reactive database: runs database functions
- Backend serving edge → Snapshot import: supports snapshot import
- Snapshot import → Import parsing: parses import file
crates/application/src/snapshot_import/mod.rs - Snapshot import → Reactive database: imports records
crates/application/src/snapshot_import/mod.rs - Backend serving edge → Snapshot export: supports snapshot export
- Snapshot export → File storage: reads stored files
crates/exports/src/export_storage.rs - Snapshot export → S3 object storage: uploads archive
- Text index manager → Text search: uses query engine
crates/search/src/text_index_manager.rs - Text search → Reactive database: queries indexed data
- Reactive database → Vector indexing: supports vector indexes
- File storage → S3 object storage: stores objects
- Fivetran connectors → Backend serving edge: connects data