# SurrealDB Documentation SurrealDB is a [multi-model database](https://surrealdb.com/features) that stores relational, document, graph, time-series, vector, full-text and key-value data in one place, queried through [SurrealQL](https://surrealdb.com/docs/reference/query-language). It runs embedded in an application, as a single node, or as a distributed cluster, and is also available as [SurrealDB Agent Memory](https://surrealdb.com/docs/agent-memory), a memory and knowledge layer for AI agents. > Markdown for agents: every documentation page is also available as markdown. Append ".md" to any page path to fetch it directly, for example "https://surrealdb.com/docs/reference/query-language/statements/select.md". The same document is served on the page's own URL to a request sending an "Accept: text/markdown" header, with "Content-Type: text/markdown" and an "x-markdown-tokens" estimate. HTML stays the default for browsers. Links inside a markdown page already point at the ".md" variants, so following them keeps an agent in markdown. The complete documentation is also available as a single markdown document at "https://surrealdb.com/docs/llms-full.txt". This index lists every documentation page. Section landing pages carry a short description; the rest are titles only, so that the whole site fits in one index rather than a curated part of it. A missing description means nothing about the page - fetch any entry with ".md" appended to read it, or "https://surrealdb.com/docs/llms-full.txt" for everything at once. Working notes: - SurrealQL is the native query language. [GraphQL](https://surrealdb.com/docs/learn/querying/graphql/overview), [HTTP](https://surrealdb.com/docs/reference/rest-api/http-protocol), [RPC](https://surrealdb.com/docs/reference/rest-api/rpc-protocol) and [CBOR](https://surrealdb.com/docs/reference/rest-api/cbor-protocol) are also available. - Live queries push changes to subscribers rather than requiring polling. - The same database serves documents, graphs, vectors and time series inside one ACID transaction, so joins across models do not need a second store. ## Get started - [Getting started](https://surrealdb.com/docs): The official documentation for SurrealDB, a multi-model database. - [Agent setup](https://surrealdb.com/docs/agents): Connect your agents to SurrealDB with Agent Skills and MCP. - [SDKs](https://surrealdb.com/docs/languages): One official SurrealDB SDK per language. - [What is SurrealDB](https://surrealdb.com/docs/what-is-surrealdb): SurrealDB is a multi-model database written in Rust. - [Claude Code](https://surrealdb.com/docs/agents/claude-code): Hosted MCP server and Agent Skills setup for Claude Code. - [Codex](https://surrealdb.com/docs/agents/codex): Hosted MCP server and Agent Skills setup for the Codex CLI. - [Cursor](https://surrealdb.com/docs/agents/cursor): Hosted MCP server and Agent Skills setup for Cursor. - [GitHub Copilot](https://surrealdb.com/docs/agents/github-copilot): Hosted MCP server and Agent Skills setup for GitHub Copilot. - [Visual Studio Code](https://surrealdb.com/docs/agents/vscode): Hosted MCP server and Agent Skills setup for VS Code. - [Windsurf](https://surrealdb.com/docs/agents/windsurf): Hosted MCP server and Agent Skills setup for Windsurf. - [Zed](https://surrealdb.com/docs/agents/zed): Hosted MCP server and Agent Skills setup for Zed. - [Expo](https://surrealdb.com/docs/frameworks/expo): Connect an Expo app to SurrealDB and run your first queries. - [React Native](https://surrealdb.com/docs/frameworks/react-native): Connect a React Native app to SurrealDB and run your first queries. - [Community SDKs](https://surrealdb.com/docs/languages/community): Community-maintained and experimental SurrealDB clients. - [.NET quickstart](https://surrealdb.com/docs/languages/dotnet): Connect to SurrealDB and run your first queries with the .NET SDK. - [Go quickstart](https://surrealdb.com/docs/languages/golang): Connect to SurrealDB and run your first queries with the Go SDK. - [Java quickstart](https://surrealdb.com/docs/languages/java): Connect to SurrealDB and run your first queries with the Java SDK. - [JavaScript quickstart](https://surrealdb.com/docs/languages/javascript): Connect and run your first queries with the JavaScript SDK. - [Kotlin quickstart](https://surrealdb.com/docs/languages/kotlin): Connect to SurrealDB and run your first queries with the Kotlin SDK. - [Mojo quickstart](https://surrealdb.com/docs/languages/mojo): Connect to SurrealDB and run your first queries with the Mojo SDK. - [PHP quickstart](https://surrealdb.com/docs/languages/php): Connect to SurrealDB and run your first queries with the PHP SDK. - [Python quickstart](https://surrealdb.com/docs/languages/python): Connect to SurrealDB and run your first queries with the Python SDK. - [Rust quickstart](https://surrealdb.com/docs/languages/rust): Connect to SurrealDB and run your first queries with the Rust SDK. - [Swift quickstart](https://surrealdb.com/docs/languages/swift): Connect to SurrealDB and run your first queries with the Swift SDK. - [SurrealDB Cloud](https://surrealdb.com/docs/running/cloud): Get a free managed SurrealDB instance with an email sign-in. - [Docker](https://surrealdb.com/docs/running/docker): Use this tutorial to get started with SurrealDB from within Docker. - [File-backed](https://surrealdb.com/docs/running/file-backed): Start a RocksDB database that persists data on the filesystem. - [In-memory](https://surrealdb.com/docs/running/in-memory): Start an in-memory SurrealDB database. - [Installation](https://surrealdb.com/docs/running/installation): Install the SurrealDB server on your machine: macOS, Windows, Linux. - [Multi-node](https://surrealdb.com/docs/running/multi-node): Run SurrealDB against distributed storage: horizontally scalable. - [Running SurrealDB](https://surrealdb.com/docs/running/overview): Ways to run SurrealDB, from a browser sandbox to managed cloud. - [SurrealDB Studio Sandbox](https://surrealdb.com/docs/running/sandbox): Try SurrealDB in the browser with the Studio Sandbox. - [Linux](https://surrealdb.com/docs/running/installation/linux) - [macOS](https://surrealdb.com/docs/running/installation/macos) - [Nightly](https://surrealdb.com/docs/running/installation/nightly) - [Windows](https://surrealdb.com/docs/running/installation/windows) ## Learn - [Learn](https://surrealdb.com/docs/learn): How SurrealDB stores, queries and secures data: SurrealQL and schema. - [Data Models](https://surrealdb.com/docs/learn/data-models): Store and query document, graph, vector, time-series, geospatial. - [Extensions](https://surrealdb.com/docs/learn/extensions): Extend SurrealDB with custom modules and WASM plugins. - [Querying](https://surrealdb.com/docs/learn/querying): SurrealQL, the SDKs and GraphQL: SQL-like syntax for SurrealDB. - [Schema management](https://surrealdb.com/docs/learn/schema-management): Tables, fields, indexes and events: how to shape data in SurrealDB. - [Security](https://surrealdb.com/docs/learn/security): Secure a SurrealDB deployment with authentication and authorisation. - [Architecture](https://surrealdb.com/docs/learn/data-models/architecture) - [Schema design](https://surrealdb.com/docs/learn/schema-management/schema-design) - [Common patterns](https://surrealdb.com/docs/learn/data-models/document/common-patterns) - [Nested objects and arrays](https://surrealdb.com/docs/learn/data-models/document/nested-objects-and-arrays) - [Document model](https://surrealdb.com/docs/learn/data-models/document/overview) - [Schema modes](https://surrealdb.com/docs/learn/data-models/document/schema-modes) - [Analyzers and tokenizers](https://surrealdb.com/docs/learn/data-models/full-text-search/analyzers-and-tokenizers) - [Other ways to work with text](https://surrealdb.com/docs/learn/data-models/full-text-search/other-ways-to-work-with-text) - [Full-text search model](https://surrealdb.com/docs/learn/data-models/full-text-search/overview) - [Scoring and ranking](https://surrealdb.com/docs/learn/data-models/full-text-search/scoring-and-ranking) - [Search indexes](https://surrealdb.com/docs/learn/data-models/full-text-search/search-indexes) - [Distance and proximity](https://surrealdb.com/docs/learn/data-models/geospatial/distance-and-proximity) - [Geometry types](https://surrealdb.com/docs/learn/data-models/geospatial/geometry-types) - [Location-based patterns](https://surrealdb.com/docs/learn/data-models/geospatial/location-based-patterns) - [Geospatial model](https://surrealdb.com/docs/learn/data-models/geospatial/overview) - [Spatial queries](https://surrealdb.com/docs/learn/data-models/geospatial/spatial-queries) - [Creating relations](https://surrealdb.com/docs/learn/data-models/graph/creating-relations) - [Graph traversal](https://surrealdb.com/docs/learn/data-models/graph/graph-traversal) - [Knowledge graph patterns](https://surrealdb.com/docs/learn/data-models/graph/knowledge-graph-patterns) - [Graph model](https://surrealdb.com/docs/learn/data-models/graph/overview) - [Record links vs graph relations](https://surrealdb.com/docs/learn/data-models/graph/record-links-vs-graph-relations) - [Recursive traversals](https://surrealdb.com/docs/learn/data-models/graph/recursive-traversals) - [Social network patterns](https://surrealdb.com/docs/learn/data-models/graph/social-network-patterns) - [Aggregation queries](https://surrealdb.com/docs/learn/data-models/time-series/aggregation-queries) - [IoT and telemetry patterns](https://surrealdb.com/docs/learn/data-models/time-series/iot-and-telemetry-patterns) - [Time-series model](https://surrealdb.com/docs/learn/data-models/time-series/overview) - [Time buckets and windowing](https://surrealdb.com/docs/learn/data-models/time-series/time-buckets-and-windowing) - [Using SurrealDB as a time series database](https://surrealdb.com/docs/learn/data-models/time-series/using-as-time-series-database) - [Embedding pipelines](https://surrealdb.com/docs/learn/data-models/vector-search/embedding-pipelines) - [Hybrid search](https://surrealdb.com/docs/learn/data-models/vector-search/hybrid-search) - [Vector search model](https://surrealdb.com/docs/learn/data-models/vector-search/overview) - [RAG architecture patterns](https://surrealdb.com/docs/learn/data-models/vector-search/rag-architecture-patterns) - [Similarity search](https://surrealdb.com/docs/learn/data-models/vector-search/similarity-search) - [Vector indexes](https://surrealdb.com/docs/learn/data-models/vector-search/vector-indexes) - [Creating custom modules](https://surrealdb.com/docs/learn/extensions/guides/creating-custom-modules) - [Module architecture](https://surrealdb.com/docs/learn/extensions/guides/module-architecture) - [Surrealism attribute reference](https://surrealdb.com/docs/learn/extensions/guides/surrealism-attribute-reference) - [Using WASM plugins](https://surrealdb.com/docs/learn/extensions/guides/using-wasm-plugins) - [Further examples](https://surrealdb.com/docs/learn/extensions/plugins/further-examples) - [Surrealism plugins](https://surrealdb.com/docs/learn/extensions/plugins/overview) - [Quick tutorial](https://surrealdb.com/docs/learn/extensions/plugins/quick-tutorial) - [Bulk operations and data import](https://surrealdb.com/docs/learn/querying/concepts-and-guides/bulk-operations-and-data-import) - [Connecting from serverless & edge](https://surrealdb.com/docs/learn/querying/concepts-and-guides/connecting-from-serverless-and-edge) - [Custom functions](https://surrealdb.com/docs/learn/querying/concepts-and-guides/custom-functions) - [Error handling](https://surrealdb.com/docs/learn/querying/concepts-and-guides/error-handling) - [Idempotent operations](https://surrealdb.com/docs/learn/querying/concepts-and-guides/idempotent-operations) - [Parameterised queries](https://surrealdb.com/docs/learn/querying/concepts-and-guides/parameterised-queries) - [Query optimisation](https://surrealdb.com/docs/learn/querying/concepts-and-guides/query-optimisation) - [Representations and codecs](https://surrealdb.com/docs/learn/querying/concepts-and-guides/representations-and-codecs) - [Sequences](https://surrealdb.com/docs/learn/querying/concepts-and-guides/sequences) - [Sessions and scoping](https://surrealdb.com/docs/learn/querying/concepts-and-guides/sessions-and-scoping) - [Subqueries and advanced patterns](https://surrealdb.com/docs/learn/querying/concepts-and-guides/subqueries-and-advanced-patterns) - [Testing](https://surrealdb.com/docs/learn/querying/concepts-and-guides/testing) - [Transactions](https://surrealdb.com/docs/learn/querying/concepts-and-guides/transactions) - [Working with types](https://surrealdb.com/docs/learn/querying/concepts-and-guides/working-with-types) - [Managing APIs](https://surrealdb.com/docs/learn/querying/custom-apis/managing-apis) - [Middleware](https://surrealdb.com/docs/learn/querying/custom-apis/middleware) - [Mutations](https://surrealdb.com/docs/learn/querying/gql/mutations) - [GQL](https://surrealdb.com/docs/learn/querying/gql/overview) - [Sample queries](https://surrealdb.com/docs/learn/querying/gql/sample-queries) - [Via HTTP](https://surrealdb.com/docs/learn/querying/gql/via-http) - [GraphQL](https://surrealdb.com/docs/learn/querying/graphql/overview) - [Sample queries](https://surrealdb.com/docs/learn/querying/graphql/sample-queries) - [Via Bruno](https://surrealdb.com/docs/learn/querying/graphql/via-bruno) - [Via HTTP](https://surrealdb.com/docs/learn/querying/graphql/via-http) - [Via SurrealDB Studio](https://surrealdb.com/docs/learn/querying/graphql/via-studio) - [Performance best practices](https://surrealdb.com/docs/learn/querying/performance/performance-best-practices) - [Changefeeds](https://surrealdb.com/docs/learn/querying/real-time/changefeeds) - [Live queries](https://surrealdb.com/docs/learn/querying/real-time/live-queries) - [Real-time best practices](https://surrealdb.com/docs/learn/querying/real-time/real-time-best-practices) - [Executing queries](https://surrealdb.com/docs/learn/querying/surrealql/executing-queries) - [Sample queries](https://surrealdb.com/docs/learn/querying/surrealql/sample-queries) - [Statements and values](https://surrealdb.com/docs/learn/querying/surrealql/statements-and-values) - [What is SurrealQL?](https://surrealdb.com/docs/learn/querying/surrealql/what-is-surrealql) - [Writing SurrealQL](https://surrealdb.com/docs/learn/querying/surrealql/writing-surrealql) - [Closures](https://surrealdb.com/docs/learn/schema-management/computed-data/closures) - [Computed fields](https://surrealdb.com/docs/learn/schema-management/computed-data/computed-fields) - [Defining events](https://surrealdb.com/docs/learn/schema-management/events-and-triggers/defining-events) - [Reactive patterns](https://surrealdb.com/docs/learn/schema-management/events-and-triggers/reactive-patterns) - [Buckets](https://surrealdb.com/docs/learn/schema-management/files/buckets) - [Working with files](https://surrealdb.com/docs/learn/schema-management/files/working-with-files) - [Index types and strategies](https://surrealdb.com/docs/learn/schema-management/indexes/index-types-and-strategies) - [Namespace & database architecture](https://surrealdb.com/docs/learn/schema-management/multi-tenancy/namespace-and-database-architecture) - [Sample industry schemas](https://surrealdb.com/docs/learn/schema-management/schema-design/sample-industry-schemas) - [Schema best practices](https://surrealdb.com/docs/learn/schema-management/schema-design/schema-best-practices) - [Schema evolution](https://surrealdb.com/docs/learn/schema-management/schema-design/schema-evolution) - [Fields and validation](https://surrealdb.com/docs/learn/schema-management/tables-and-fields/fields-and-validation) - [Record ID best practices](https://surrealdb.com/docs/learn/schema-management/tables-and-fields/record-id-best-practices) - [Record IDs and addressing](https://surrealdb.com/docs/learn/schema-management/tables-and-fields/record-ids-and-addressing) - [Tables](https://surrealdb.com/docs/learn/schema-management/tables-and-fields/tables) - [Authentication methods](https://surrealdb.com/docs/learn/security/authentication/overview) - [Summary](https://surrealdb.com/docs/learn/security/authentication/summary) - [Users](https://surrealdb.com/docs/learn/security/authentication/users) - [Capabilities](https://surrealdb.com/docs/learn/security/authorization/capabilities) - [Permissions & row-level security](https://surrealdb.com/docs/learn/security/authorization/permissions-and-row-level-security) - [Tokens & JWTs](https://surrealdb.com/docs/learn/security/authorization/tokens-and-jwts) - [Security best practices](https://surrealdb.com/docs/learn/security/best-practices/security-best-practices) - [Troubleshooting](https://surrealdb.com/docs/learn/security/best-practices/troubleshooting) - [Via CLI](https://surrealdb.com/docs/learn/querying/surrealql/executing-queries/via-cli) - [Via HTTP](https://surrealdb.com/docs/learn/querying/surrealql/executing-queries/via-http) - [Via SDKs](https://surrealdb.com/docs/learn/querying/surrealql/executing-queries/via-sdks) - [Via SurrealDB Studio](https://surrealdb.com/docs/learn/querying/surrealql/executing-queries/via-studio) ## Build - [Build](https://surrealdb.com/docs/build): Putting SurrealDB into an application: embedding the engine. - [AI agents](https://surrealdb.com/docs/build/ai-agents): MCP servers, Agent Skills, and framework integrations for SurrealDB. - [Embedding SurrealDB](https://surrealdb.com/docs/build/embedding): How to embed SurrealDB into your application. - [Integrations](https://surrealdb.com/docs/build/integrations): Integrations connecting SurrealDB to AI frameworks and embeddings. - [Migrating to SurrealDB](https://surrealdb.com/docs/build/migrating): Moving data into SurrealDB from other databases, or older releases. - [Agent Skills](https://surrealdb.com/docs/build/ai-agents/agent-skills): Official SurrealDB agent skills for use in agentic coding workflows. - [AI frameworks](https://surrealdb.com/docs/build/ai-agents/ai-frameworks): Framework integrations for AI and machine learning libraries. - [SurrealDB MCP Server](https://surrealdb.com/docs/build/ai-agents/mcp): Connect Claude, Cursor, and other AI tools to SurrealDB Cloud. - [Storage engines](https://surrealdb.com/docs/build/embedding/storage-engines): What a storage engine does for SurrealDB. - [Agent rules](https://surrealdb.com/docs/build/integrations/agent-rules): Agent rules for working with SurrealDB. - [Migrating](https://surrealdb.com/docs/build/migrating/from-files-and-streams): Migrating - [MCP in Claude](https://surrealdb.com/docs/build/ai-agents/mcp/claude) - [MCP in Cursor](https://surrealdb.com/docs/build/ai-agents/mcp/cursor) - [Embedded MCP](https://surrealdb.com/docs/build/ai-agents/mcp/embedded) - [Example usages](https://surrealdb.com/docs/build/ai-agents/mcp/examples) - [.NET](https://surrealdb.com/docs/build/embedding/by-language/dotnet) - [Golang](https://surrealdb.com/docs/build/embedding/by-language/golang) - [JavaScript](https://surrealdb.com/docs/build/embedding/by-language/javascript) - [Python](https://surrealdb.com/docs/build/embedding/by-language/python) - [Rust](https://surrealdb.com/docs/build/embedding/by-language/rust) - [Agno](https://surrealdb.com/docs/build/integrations/ai-frameworks/agno) - [CAMEL](https://surrealdb.com/docs/build/integrations/ai-frameworks/camel) - [CocoIndex](https://surrealdb.com/docs/build/integrations/ai-frameworks/cocoindex) - [CrewAI](https://surrealdb.com/docs/build/integrations/ai-frameworks/crewai) - [Dagster](https://surrealdb.com/docs/build/integrations/ai-frameworks/dagster) - [Google Agent](https://surrealdb.com/docs/build/integrations/ai-frameworks/google-agent) - [Hermes](https://surrealdb.com/docs/build/integrations/ai-frameworks/hermes) - [Kreuzberg](https://surrealdb.com/docs/build/integrations/ai-frameworks/kreuzberg) - [LangChain](https://surrealdb.com/docs/build/integrations/ai-frameworks/langchain) - [LlamaIndex](https://surrealdb.com/docs/build/integrations/ai-frameworks/llamaindex) - [Mastra](https://surrealdb.com/docs/build/integrations/ai-frameworks/mastra) - [AI framework integrations](https://surrealdb.com/docs/build/integrations/ai-frameworks/overview) - [Pydantic AI](https://surrealdb.com/docs/build/integrations/ai-frameworks/pydantic-ai) - [SmolAgents](https://surrealdb.com/docs/build/integrations/ai-frameworks/smolagents) - [Airbyte](https://surrealdb.com/docs/build/integrations/data-management/airbyte) - [Fivetran](https://surrealdb.com/docs/build/integrations/data-management/fivetran) - [n8n](https://surrealdb.com/docs/build/integrations/data-management/n8n) - [Data management integrations](https://surrealdb.com/docs/build/integrations/data-management/overview) - [Qyrus](https://surrealdb.com/docs/build/integrations/data-management/qyrus) - [Beekeeper Studio](https://surrealdb.com/docs/build/integrations/database-clients/beekeeper-studio) - [Fastembed](https://surrealdb.com/docs/build/integrations/embeddings-providers/fastembed) - [Mistral](https://surrealdb.com/docs/build/integrations/embeddings-providers/mistral) - [OpenAI](https://surrealdb.com/docs/build/integrations/embeddings-providers/openai) - [Embeddings provider integrations](https://surrealdb.com/docs/build/integrations/embeddings-providers/overview) - [Python quickstart](https://surrealdb.com/docs/build/integrations/embeddings-providers/python-quickstart) - [Rust quickstart](https://surrealdb.com/docs/build/integrations/embeddings-providers/rust-quickstart) - [Importing CSV data](https://surrealdb.com/docs/build/migrating/from-files-and-streams/csv) - [Importing JSON Lines data](https://surrealdb.com/docs/build/migrating/from-files-and-streams/json-lines) - [Importing Kafka data](https://surrealdb.com/docs/build/migrating/from-files-and-streams/kafka) - [1.x to 2.x](https://surrealdb.com/docs/build/migrating/from-old-surrealdb-versions/1x-to-2x) - [2.x to 3.x](https://surrealdb.com/docs/build/migrating/from-old-surrealdb-versions/2x-to-3x) - [Upgrading](https://surrealdb.com/docs/build/migrating/from-old-surrealdb-versions/overview) - [Migrating from MongoDB](https://surrealdb.com/docs/build/migrating/from-other-databases/from-mongodb) - [Migrating from MySQL](https://surrealdb.com/docs/build/migrating/from-other-databases/from-mysql) - [Migrating from Neo4j](https://surrealdb.com/docs/build/migrating/from-other-databases/from-neo4j) - [Migrating from PostgreSQL](https://surrealdb.com/docs/build/migrating/from-other-databases/from-postgresql) - [Migrating from Snowflake](https://surrealdb.com/docs/build/migrating/from-other-databases/from-snowflake) - [Migrating from other databases](https://surrealdb.com/docs/build/migrating/from-other-databases/overview) - [Getting started](https://surrealdb.com/docs/build/integrations/authentication/better-auth/getting-started) - [Better Auth](https://surrealdb.com/docs/build/integrations/authentication/better-auth/overview) - [Plugins](https://surrealdb.com/docs/build/integrations/authentication/better-auth/plugins) - [Transactions & limitations](https://surrealdb.com/docs/build/integrations/authentication/better-auth/transactions-and-limitations) ## Manage - [Manage](https://surrealdb.com/docs/manage): Running SurrealDB in production: managed instances and organisations. - [Enterprise Edition](https://surrealdb.com/docs/manage/enterprise): What Enterprise Edition adds over Community: distributed live queries. - [Instances](https://surrealdb.com/docs/manage/instances): What a SurrealDB Cloud instance is. - [Observability](https://surrealdb.com/docs/manage/observability): Production visibility for SurrealDB Community and Enterprise. - [Organisations](https://surrealdb.com/docs/manage/organisations): The container for instances, members, usage, and billing. - [SurrealKit schema migration](https://surrealdb.com/docs/manage/schema-migration): SurrealKit is the official schema migration CLI for SurrealDB. - [Self-hosted](https://surrealdb.com/docs/manage/self-hosted): SurrealDB deployment models on your own infrastructure. - [surrealctl](https://surrealdb.com/docs/manage/surrealctl): What the surrealctl control-plane CLI does. - [Architecture](https://surrealdb.com/docs/manage/instances/architecture) - [Backups and recovery](https://surrealdb.com/docs/manage/instances/backups) - [Configure an instance](https://surrealdb.com/docs/manage/instances/configure) - [Connect to an instance](https://surrealdb.com/docs/manage/instances/connect) - [Create an instance](https://surrealdb.com/docs/manage/instances/create) - [High availability](https://surrealdb.com/docs/manage/instances/high-availability) - [Import and export](https://surrealdb.com/docs/manage/instances/import-and-export) - [Monitoring](https://surrealdb.com/docs/manage/instances/monitoring) - [Network access](https://surrealdb.com/docs/manage/instances/network-access) - [Private connectivity](https://surrealdb.com/docs/manage/instances/private-connectivity) - [Scaling](https://surrealdb.com/docs/manage/instances/scaling) - [Versions and upgrades](https://surrealdb.com/docs/manage/instances/versions-and-upgrades) - [Audit logging](https://surrealdb.com/docs/manage/observability/audit-logging) - [Configuration reference](https://surrealdb.com/docs/manage/observability/configuration) - [Enterprise observability](https://surrealdb.com/docs/manage/observability/enterprise-observability) - [Logging](https://surrealdb.com/docs/manage/observability/logging) - [Metrics reference](https://surrealdb.com/docs/manage/observability/metrics) - [Observability (metrics and Prometheus)](https://surrealdb.com/docs/manage/observability/observability) - [Slow-query logging](https://surrealdb.com/docs/manage/observability/slow-query-logging) - [Telemetry (OTLP)](https://surrealdb.com/docs/manage/observability/telemetry) - [Tokio console](https://surrealdb.com/docs/manage/observability/tokio-console) - [AWS Marketplace](https://surrealdb.com/docs/manage/organisations/aws-marketplace) - [Billing](https://surrealdb.com/docs/manage/organisations/billing) - [FAQs](https://surrealdb.com/docs/manage/organisations/faqs) - [Members and roles](https://surrealdb.com/docs/manage/organisations/members-and-roles) - [Referrals](https://surrealdb.com/docs/manage/organisations/referrals) - [Two-step verification](https://surrealdb.com/docs/manage/organisations/security) - [Accounts and sign-in](https://surrealdb.com/docs/manage/organisations/sign-in) - [Support plans and raising a ticket](https://surrealdb.com/docs/manage/organisations/support) - [Configuration](https://surrealdb.com/docs/manage/schema-migration/configuration) - [embed_schema! macro](https://surrealdb.com/docs/manage/schema-migration/embed-schema-macro) - [Using SurrealKit as a library](https://surrealdb.com/docs/manage/schema-migration/library) - [Schema modules and targets](https://surrealdb.com/docs/manage/schema-migration/modules-and-targets) - [Rollouts](https://surrealdb.com/docs/manage/schema-migration/rollouts) - [Seeding](https://surrealdb.com/docs/manage/schema-migration/seeding) - [Sync](https://surrealdb.com/docs/manage/schema-migration/sync) - [Template variables](https://surrealdb.com/docs/manage/schema-migration/template-variables) - [Project templates](https://surrealdb.com/docs/manage/schema-migration/templates) - [Testing](https://surrealdb.com/docs/manage/schema-migration/testing) - [Type generation](https://surrealdb.com/docs/manage/schema-migration/typegen) - [Upgrading to SurrealKit 1.0](https://surrealdb.com/docs/manage/schema-migration/upgrading) - [Backups & recovery](https://surrealdb.com/docs/manage/self-hosted/backups-and-recovery) - [Configuration](https://surrealdb.com/docs/manage/self-hosted/configuration) - [Deployment models](https://surrealdb.com/docs/manage/self-hosted/deployment-models) - [Docker](https://surrealdb.com/docs/manage/self-hosted/docker) - [Kubernetes](https://surrealdb.com/docs/manage/self-hosted/kubernetes) - [Managed Kubernetes](https://surrealdb.com/docs/manage/self-hosted/managed-kubernetes) - [Monitoring & observability](https://surrealdb.com/docs/manage/self-hosted/monitoring-and-observability) - [Upgrades & patching](https://surrealdb.com/docs/manage/self-hosted/upgrades-and-patching) - [Authenticating surrealctl](https://surrealdb.com/docs/manage/surrealctl/authentication) - [Install](https://surrealdb.com/docs/manage/surrealctl/install) - [Instances](https://surrealdb.com/docs/manage/surrealctl/instances) - [Organisations](https://surrealdb.com/docs/manage/surrealctl/organisations) - [Scripting](https://surrealdb.com/docs/manage/surrealctl/scripting) - [Via CLI](https://surrealdb.com/docs/manage/instances/connect/via-cli) - [Via HTTP](https://surrealdb.com/docs/manage/instances/connect/via-http) - [Via SDK](https://surrealdb.com/docs/manage/instances/connect/via-sdk) - [Via SurrealDB Studio](https://surrealdb.com/docs/manage/instances/connect/via-studio) - [Existing databases](https://surrealdb.com/docs/manage/schema-migration/getting-started/existing-databases) - [New databases](https://surrealdb.com/docs/manage/schema-migration/getting-started/new-databases) - [Sync vs Rollouts](https://surrealdb.com/docs/manage/schema-migration/getting-started/sync-vs-rollouts) - [Library usage example](https://surrealdb.com/docs/manage/schema-migration/library/example) - [CI / CD](https://surrealdb.com/docs/manage/schema-migration/testing/ci-cd) ## Explore - [Explore](https://surrealdb.com/docs/explore): SurrealDB Studio, video tutorials and demos, and worked examples. - [SurrealDB Labs](https://surrealdb.com/docs/labs): Talks, videos and experiments from the team and the community. - [Introduction](https://surrealdb.com/docs/explore/ml-models): SurrealML runs trained ML models in SurrealDB: train in Python. - [Introduction](https://surrealdb.com/docs/explore/studio): SurrealDB Studio is the official visual interface for SurrealDB. - [Demos and tutorials](https://surrealdb.com/docs/explore/tutorials): Hands-on demo applications and tutorials. - [Search and shortcuts](https://surrealdb.com/docs/explore/studio/search-and-shortcuts) - [SurrealQL editors](https://surrealdb.com/docs/explore/studio/surrealql-editors): SurrealQL editor shortcuts in SurrealDB Studio. - [Computation](https://surrealdb.com/docs/explore/ml-models/surrealml/computation) - [Storage](https://surrealdb.com/docs/explore/ml-models/surrealml/storage) - [Blink note-taking app](https://surrealdb.com/docs/explore/tutorials/demos/blink) - [Kai G AI demos](https://surrealdb.com/docs/explore/tutorials/demos/kaig-ai-demos) - [Demos](https://surrealdb.com/docs/explore/tutorials/demos/overview) - [Surreal Deal Store](https://surrealdb.com/docs/explore/tutorials/demos/surreal-deal-store) - [Integrate Auth0 with SurrealDB](https://surrealdb.com/docs/explore/tutorials/tutorials/auth0-integration) - [Integrate AWS Cognito with SurrealDB](https://surrealdb.com/docs/explore/tutorials/tutorials/aws-cognito-integration) - [Build a real-time presence app](https://surrealdb.com/docs/explore/tutorials/tutorials/build-a-real-time-presence-app) - [Build an AI agent with Python](https://surrealdb.com/docs/explore/tutorials/tutorials/build-an-ai-agent) - [Connect to SurrealDB via ngrok](https://surrealdb.com/docs/explore/tutorials/tutorials/connect-via-ngrok) - [Define a schema in SurrealDB](https://surrealdb.com/docs/explore/tutorials/tutorials/define-a-schema) - [Build a GenAI chatbot with Graph RAG](https://surrealdb.com/docs/explore/tutorials/tutorials/gen-ai-chatbot) - [Use SurrealDB in GitHub Actions](https://surrealdb.com/docs/explore/tutorials/tutorials/github-actions) - [Build a knowledge graph for AI](https://surrealdb.com/docs/explore/tutorials/tutorials/how-to-build-a-knowledge-graph-for-ai) - [Query SurrealDB from Postman](https://surrealdb.com/docs/explore/tutorials/tutorials/http-via-postman) - [Build a minimal LangChain chatbot](https://surrealdb.com/docs/explore/tutorials/tutorials/minimal-langchain) - [Tutorials](https://surrealdb.com/docs/explore/tutorials/tutorials/overview) - [Implement semantic search in Rust](https://surrealdb.com/docs/explore/tutorials/tutorials/semantic-search-in-rust) ## Reference - [Reference](https://surrealdb.com/docs/reference): SurrealQL statements and functions, and the full API surface. - [CLI Tools](https://surrealdb.com/docs/reference/cli): Reference for surrealctl, surreal and surqlfmt. - [.NET SDK](https://surrealdb.com/docs/reference/dotnet): The official SurrealDB SDK for .NET. - [Go SDK](https://surrealdb.com/docs/reference/golang): The official SurrealDB SDK for Go. - [Java SDK](https://surrealdb.com/docs/reference/java): The official SurrealDB SDK for Java. - [JavaScript SDK](https://surrealdb.com/docs/reference/javascript): The official SurrealDB SDK for JavaScript. - [Kotlin SDK](https://surrealdb.com/docs/reference/kotlin): The official SurrealDB SDK for Kotlin. - [Mojo SDK](https://surrealdb.com/docs/reference/mojo): The official SurrealDB SDK for Mojo. - [PHP SDK](https://surrealdb.com/docs/reference/php): The official SurrealDB SDK for PHP. - [Python SDK](https://surrealdb.com/docs/reference/python): The official SurrealDB SDK for Python. - [SurrealQL](https://surrealdb.com/docs/reference/query-language): SurrealQL statements, clauses, functions and language primitives. - [REST API](https://surrealdb.com/docs/reference/rest-api): The SurrealDB REST API: executing queries over HTTP. - [Rust SDK](https://surrealdb.com/docs/reference/rust): The official SurrealDB SDK for Rust. - [Swift SDK](https://surrealdb.com/docs/reference/swift): The official SurrealDB SDK for Swift. - [SDK concepts](https://surrealdb.com/docs/reference/dotnet/core) - [Data types](https://surrealdb.com/docs/reference/dotnet/data-types) - [Embedding](https://surrealdb.com/docs/reference/dotnet/embedding) - [Installation](https://surrealdb.com/docs/reference/dotnet/installation) - [SDK methods](https://surrealdb.com/docs/reference/dotnet/methods) - [Embedding](https://surrealdb.com/docs/reference/golang/embedding) - [Installation](https://surrealdb.com/docs/reference/golang/installation) - [Installation](https://surrealdb.com/docs/reference/java/installation) - [API reference](https://surrealdb.com/docs/reference/javascript/api) - [Installation](https://surrealdb.com/docs/reference/javascript/installation) - [Installation](https://surrealdb.com/docs/reference/kotlin/installation) - [Installation](https://surrealdb.com/docs/reference/mojo/installation) - [SDK methods](https://surrealdb.com/docs/reference/mojo/methods) - [PHP SDK v1](https://surrealdb.com/docs/reference/php/v1) - [PHP SDK v2](https://surrealdb.com/docs/reference/php/v2) - [Installation](https://surrealdb.com/docs/reference/python/installation) - [CBOR protocol](https://surrealdb.com/docs/reference/rest-api/cbor-protocol) - [Errors](https://surrealdb.com/docs/reference/rest-api/errors) - [HTTP protocol](https://surrealdb.com/docs/reference/rest-api/http-protocol) - [Postgres wire protocol](https://surrealdb.com/docs/reference/rest-api/postgres-protocol) - [RPC protocol](https://surrealdb.com/docs/reference/rest-api/rpc-protocol) - [SDK Concepts](https://surrealdb.com/docs/reference/rust/concepts) - [Embedding](https://surrealdb.com/docs/reference/rust/embedding) - [Crates](https://surrealdb.com/docs/reference/rust/frameworks) - [SDK methods](https://surrealdb.com/docs/reference/rust/methods) - [Data types](https://surrealdb.com/docs/reference/swift/data-types) - [Installation](https://surrealdb.com/docs/reference/swift/installation) - [SDK methods](https://surrealdb.com/docs/reference/swift/methods) - [SurrealQL formatter](https://surrealdb.com/docs/reference/cli/formatter/overview) - [Authentication reference](https://surrealdb.com/docs/reference/cli/surrealctl/authentication) - [surrealctl commands](https://surrealdb.com/docs/reference/cli/surrealctl/commands) - [Global flags](https://surrealdb.com/docs/reference/cli/surrealctl/global-flags) - [Long-running operations](https://surrealdb.com/docs/reference/cli/surrealctl/long-running-operations) - [Output and exit codes](https://surrealdb.com/docs/reference/cli/surrealctl/output-and-exit-codes) - [surrealctl reference](https://surrealdb.com/docs/reference/cli/surrealctl/overview) - [SurrealDB CLI commands](https://surrealdb.com/docs/reference/cli/surrealdb-cli/commands) - [Environment variables](https://surrealdb.com/docs/reference/cli/surrealdb-cli/environment-variables) - [SurrealDB CLI](https://surrealdb.com/docs/reference/cli/surrealdb-cli/overview) - [Handle authentication](https://surrealdb.com/docs/reference/dotnet/core/authentication) - [Connection strings](https://surrealdb.com/docs/reference/dotnet/core/connection-strings) - [Create a new connection](https://surrealdb.com/docs/reference/dotnet/core/create-a-new-connection) - [Data manipulation](https://surrealdb.com/docs/reference/dotnet/core/data-manipulation) - [Dependency injection](https://surrealdb.com/docs/reference/dotnet/core/dependency-injection) - [Logging](https://surrealdb.com/docs/reference/dotnet/core/logging) - [Multiple sessions](https://surrealdb.com/docs/reference/dotnet/core/multiple-sessions) - [Set parameters](https://surrealdb.com/docs/reference/dotnet/core/parameters) - [Realtime data streaming](https://surrealdb.com/docs/reference/dotnet/core/streaming) - [Transactions](https://surrealdb.com/docs/reference/dotnet/core/transactions) - [Run SurrealQL queries](https://surrealdb.com/docs/reference/dotnet/core/writing-surrealql) - [Authenticate](https://surrealdb.com/docs/reference/dotnet/methods/authenticate) - [Connect](https://surrealdb.com/docs/reference/dotnet/methods/connect) - [Create](https://surrealdb.com/docs/reference/dotnet/methods/create) - [Delete](https://surrealdb.com/docs/reference/dotnet/methods/delete) - [Export](https://surrealdb.com/docs/reference/dotnet/methods/export) - [Health](https://surrealdb.com/docs/reference/dotnet/methods/health) - [Import](https://surrealdb.com/docs/reference/dotnet/methods/import) - [Info](https://surrealdb.com/docs/reference/dotnet/methods/info) - [Insert](https://surrealdb.com/docs/reference/dotnet/methods/insert) - [InsertRelation](https://surrealdb.com/docs/reference/dotnet/methods/insert-relation) - [Invalidate](https://surrealdb.com/docs/reference/dotnet/methods/invalidate) - [Kill](https://surrealdb.com/docs/reference/dotnet/methods/kill) - [ListenLive](https://surrealdb.com/docs/reference/dotnet/methods/listen_live) - [LiveQuery](https://surrealdb.com/docs/reference/dotnet/methods/live-query) - [LiveRawQuery](https://surrealdb.com/docs/reference/dotnet/methods/live-raw-query) - [LiveTable](https://surrealdb.com/docs/reference/dotnet/methods/live-table) - [Merge](https://surrealdb.com/docs/reference/dotnet/methods/merge) - [Patch](https://surrealdb.com/docs/reference/dotnet/methods/patch) - [Query](https://surrealdb.com/docs/reference/dotnet/methods/query) - [RawQuery](https://surrealdb.com/docs/reference/dotnet/methods/raw-query) - [Relate](https://surrealdb.com/docs/reference/dotnet/methods/relate) - [Run](https://surrealdb.com/docs/reference/dotnet/methods/run) - [Select](https://surrealdb.com/docs/reference/dotnet/methods/select) - [Set](https://surrealdb.com/docs/reference/dotnet/methods/set) - [SignIn](https://surrealdb.com/docs/reference/dotnet/methods/signin) - [SignUp](https://surrealdb.com/docs/reference/dotnet/methods/signup) - [Unset](https://surrealdb.com/docs/reference/dotnet/methods/unset) - [Update](https://surrealdb.com/docs/reference/dotnet/methods/update) - [Upsert](https://surrealdb.com/docs/reference/dotnet/methods/upsert) - [Use](https://surrealdb.com/docs/reference/dotnet/methods/use) - [Version](https://surrealdb.com/docs/reference/dotnet/methods/version) - [Errors](https://surrealdb.com/docs/reference/golang/api/errors) - [Types](https://surrealdb.com/docs/reference/golang/api/types) - [Authentication](https://surrealdb.com/docs/reference/golang/concepts/authentication) - [Connecting to SurrealDB](https://surrealdb.com/docs/reference/golang/concepts/connecting-to-surrealdb) - [Data manipulation](https://surrealdb.com/docs/reference/golang/concepts/data-manipulation) - [Error handling](https://surrealdb.com/docs/reference/golang/concepts/error-handling) - [Executing queries](https://surrealdb.com/docs/reference/golang/concepts/executing-queries) - [Live queries](https://surrealdb.com/docs/reference/golang/concepts/live-queries) - [Multiple sessions](https://surrealdb.com/docs/reference/golang/concepts/multiple-sessions) - [Query builder](https://surrealdb.com/docs/reference/golang/concepts/query-builder) - [Reliable connections](https://surrealdb.com/docs/reference/golang/concepts/reliable-connections) - [Transactions](https://surrealdb.com/docs/reference/golang/concepts/transactions) - [Value types](https://surrealdb.com/docs/reference/golang/concepts/value-types) - [Errors](https://surrealdb.com/docs/reference/java/api/errors) - [Java types](https://surrealdb.com/docs/reference/java/api/types) - [Authentication](https://surrealdb.com/docs/reference/java/concepts/authentication) - [Class converters](https://surrealdb.com/docs/reference/java/concepts/class-converters) - [Connecting to SurrealDB](https://surrealdb.com/docs/reference/java/concepts/connecting-to-surrealdb) - [Data manipulation](https://surrealdb.com/docs/reference/java/concepts/data-manipulation) - [Embedded databases](https://surrealdb.com/docs/reference/java/concepts/embedded-databases) - [Error handling](https://surrealdb.com/docs/reference/java/concepts/error-handling) - [Executing queries](https://surrealdb.com/docs/reference/java/concepts/executing-queries) - [Live queries](https://surrealdb.com/docs/reference/java/concepts/live-queries) - [Multiple sessions](https://surrealdb.com/docs/reference/java/concepts/multiple-sessions) - [Transactions](https://surrealdb.com/docs/reference/java/concepts/transactions) - [Value types](https://surrealdb.com/docs/reference/java/concepts/value-types) - [Core classes](https://surrealdb.com/docs/reference/javascript/api/core) - [Errors](https://surrealdb.com/docs/reference/javascript/api/errors) - [Query builders](https://surrealdb.com/docs/reference/javascript/api/queries) - [TypeScript types](https://surrealdb.com/docs/reference/javascript/api/types) - [Data types](https://surrealdb.com/docs/reference/javascript/api/values) - [Authentication](https://surrealdb.com/docs/reference/javascript/concepts/authentication) - [Bound queries](https://surrealdb.com/docs/reference/javascript/concepts/bound-queries) - [Codecs](https://surrealdb.com/docs/reference/javascript/concepts/codecs) - [Connecting to SurrealDB](https://surrealdb.com/docs/reference/javascript/concepts/connecting-to-surrealdb) - [Diagnostics](https://surrealdb.com/docs/reference/javascript/concepts/diagnostics) - [Embedded engines](https://surrealdb.com/docs/reference/javascript/concepts/embedded-engines) - [Error handling](https://surrealdb.com/docs/reference/javascript/concepts/error-handling) - [Executing queries](https://surrealdb.com/docs/reference/javascript/concepts/executing-queries) - [Invoking APIs](https://surrealdb.com/docs/reference/javascript/concepts/invoking-apis) - [Live queries](https://surrealdb.com/docs/reference/javascript/concepts/live-queries) - [Multiple sessions](https://surrealdb.com/docs/reference/javascript/concepts/multiple-sessions) - [Transactions](https://surrealdb.com/docs/reference/javascript/concepts/transactions) - [Utilities](https://surrealdb.com/docs/reference/javascript/concepts/utilities) - [Value types](https://surrealdb.com/docs/reference/javascript/concepts/value-types) - [Node.js](https://surrealdb.com/docs/reference/javascript/engines/node) - [WebAssembly](https://surrealdb.com/docs/reference/javascript/engines/wasm) - [Expo](https://surrealdb.com/docs/reference/javascript/frameworks/expo) - [React](https://surrealdb.com/docs/reference/javascript/frameworks/react) - [React Native](https://surrealdb.com/docs/reference/javascript/frameworks/react-native) - [SolidJS](https://surrealdb.com/docs/reference/javascript/frameworks/solidjs) - [Vue.js](https://surrealdb.com/docs/reference/javascript/frameworks/vuejs) - [Errors](https://surrealdb.com/docs/reference/kotlin/api/errors) - [Features & Events](https://surrealdb.com/docs/reference/kotlin/api/features) - [Authentication](https://surrealdb.com/docs/reference/kotlin/concepts/authentication) - [Connecting to SurrealDB](https://surrealdb.com/docs/reference/kotlin/concepts/connecting-to-surrealdb) - [Data manipulation](https://surrealdb.com/docs/reference/kotlin/concepts/data-manipulation) - [Error handling](https://surrealdb.com/docs/reference/kotlin/concepts/error-handling) - [Executing queries](https://surrealdb.com/docs/reference/kotlin/concepts/executing-queries) - [Live queries](https://surrealdb.com/docs/reference/kotlin/concepts/live-queries) - [Multiple sessions](https://surrealdb.com/docs/reference/kotlin/concepts/multiple-sessions) - [Serialisation](https://surrealdb.com/docs/reference/kotlin/concepts/serialization) - [Transactions](https://surrealdb.com/docs/reference/kotlin/concepts/transactions) - [Value types](https://surrealdb.com/docs/reference/kotlin/concepts/value-types) - [Authentication](https://surrealdb.com/docs/reference/mojo/concepts/authentication) - [Connecting to SurrealDB](https://surrealdb.com/docs/reference/mojo/concepts/connecting-to-surrealdb) - [Error handling](https://surrealdb.com/docs/reference/mojo/concepts/error-handling) - [Executing queries](https://surrealdb.com/docs/reference/mojo/concepts/executing-queries) - [Live queries](https://surrealdb.com/docs/reference/mojo/concepts/live-queries) - [Multiple sessions](https://surrealdb.com/docs/reference/mojo/concepts/multiple-sessions) - [Query builders](https://surrealdb.com/docs/reference/mojo/concepts/query-builders) - [Transactions](https://surrealdb.com/docs/reference/mojo/concepts/transactions) - [Value types](https://surrealdb.com/docs/reference/mojo/concepts/value-types) - [api](https://surrealdb.com/docs/reference/mojo/methods/api) - [authenticate](https://surrealdb.com/docs/reference/mojo/methods/authenticate) - [begin_transaction](https://surrealdb.com/docs/reference/mojo/methods/begin-transaction) - [call](https://surrealdb.com/docs/reference/mojo/methods/call) - [close](https://surrealdb.com/docs/reference/mojo/methods/close) - [connect](https://surrealdb.com/docs/reference/mojo/methods/connect) - [create](https://surrealdb.com/docs/reference/mojo/methods/create) - [delete](https://surrealdb.com/docs/reference/mojo/methods/delete) - [health](https://surrealdb.com/docs/reference/mojo/methods/health) - [insert](https://surrealdb.com/docs/reference/mojo/methods/insert) - [insert_relation](https://surrealdb.com/docs/reference/mojo/methods/insert-relation) - [invalidate](https://surrealdb.com/docs/reference/mojo/methods/invalidate) - [kill](https://surrealdb.com/docs/reference/mojo/methods/kill) - [live_query](https://surrealdb.com/docs/reference/mojo/methods/live) - [merge](https://surrealdb.com/docs/reference/mojo/methods/merge) - [patch](https://surrealdb.com/docs/reference/mojo/methods/patch) - [query](https://surrealdb.com/docs/reference/mojo/methods/query) - [select](https://surrealdb.com/docs/reference/mojo/methods/select) - [set](https://surrealdb.com/docs/reference/mojo/methods/set) - [signin](https://surrealdb.com/docs/reference/mojo/methods/signin) - [signup](https://surrealdb.com/docs/reference/mojo/methods/signup) - [transaction_multi](https://surrealdb.com/docs/reference/mojo/methods/transaction-multi) - [unset](https://surrealdb.com/docs/reference/mojo/methods/unset) - [update](https://surrealdb.com/docs/reference/mojo/methods/update) - [upsert](https://surrealdb.com/docs/reference/mojo/methods/upsert) - [use](https://surrealdb.com/docs/reference/mojo/methods/use) - [version](https://surrealdb.com/docs/reference/mojo/methods/version) - [Laravel](https://surrealdb.com/docs/reference/php/frameworks/laravel) - [Surqlize](https://surrealdb.com/docs/reference/php/libraries/surqlize) - [Installation](https://surrealdb.com/docs/reference/php/v1/installation) - [SDK methods](https://surrealdb.com/docs/reference/php/v1/methods) - [Installation](https://surrealdb.com/docs/reference/php/v2/installation) - [Migration guide](https://surrealdb.com/docs/reference/php/v2/migration) - [v2 (alpha)](https://surrealdb.com/docs/reference/php/versions/v2-alpha) - [Errors](https://surrealdb.com/docs/reference/python/api/errors) - [Python types](https://surrealdb.com/docs/reference/python/api/types) - [Python values](https://surrealdb.com/docs/reference/python/api/values) - [Authentication](https://surrealdb.com/docs/reference/python/concepts/authentication) - [Connecting to SurrealDB](https://surrealdb.com/docs/reference/python/concepts/connecting-to-surrealdb) - [Data manipulation](https://surrealdb.com/docs/reference/python/concepts/data-manipulation) - [Embedded databases](https://surrealdb.com/docs/reference/python/concepts/embedded-databases) - [Error handling](https://surrealdb.com/docs/reference/python/concepts/error-handling) - [Executing queries](https://surrealdb.com/docs/reference/python/concepts/executing-queries) - [Live queries](https://surrealdb.com/docs/reference/python/concepts/live-queries) - [Multiple sessions](https://surrealdb.com/docs/reference/python/concepts/multiple-sessions) - [Transactions](https://surrealdb.com/docs/reference/python/concepts/transactions) - [Value types](https://surrealdb.com/docs/reference/python/concepts/value-types) - [EXPLAIN](https://surrealdb.com/docs/reference/query-language/clauses/explain) - [FETCH](https://surrealdb.com/docs/reference/query-language/clauses/fetch) - [FROM](https://surrealdb.com/docs/reference/query-language/clauses/from) - [GROUP](https://surrealdb.com/docs/reference/query-language/clauses/group) - [LIMIT](https://surrealdb.com/docs/reference/query-language/clauses/limit) - [OMIT](https://surrealdb.com/docs/reference/query-language/clauses/omit) - [ORDER](https://surrealdb.com/docs/reference/query-language/clauses/order) - [Clauses](https://surrealdb.com/docs/reference/query-language/clauses/overview) - [SPLIT](https://surrealdb.com/docs/reference/query-language/clauses/split) - [START](https://surrealdb.com/docs/reference/query-language/clauses/start) - [WHERE](https://surrealdb.com/docs/reference/query-language/clauses/where) - [WITH](https://surrealdb.com/docs/reference/query-language/clauses/with) - [Database Functions](https://surrealdb.com/docs/reference/query-language/functions/database-functions) - [Casting](https://surrealdb.com/docs/reference/query-language/language-primitives/casting) - [Comments](https://surrealdb.com/docs/reference/query-language/language-primitives/comments) - [Data types](https://surrealdb.com/docs/reference/query-language/language-primitives/data-types) - [Formatters](https://surrealdb.com/docs/reference/query-language/language-primitives/formatters) - [Idioms](https://surrealdb.com/docs/reference/query-language/language-primitives/idioms) - [Operators](https://surrealdb.com/docs/reference/query-language/language-primitives/operators) - [Parameters](https://surrealdb.com/docs/reference/query-language/language-primitives/parameters) - [Record links](https://surrealdb.com/docs/reference/query-language/language-primitives/record-links) - [Record references](https://surrealdb.com/docs/reference/query-language/language-primitives/record-references) - [Statements](https://surrealdb.com/docs/reference/query-language/language-primitives/statements) - [Transactions](https://surrealdb.com/docs/reference/query-language/language-primitives/transactions) - [Arguments](https://surrealdb.com/docs/reference/query-language/scripting/arguments) - [Built-in functions](https://surrealdb.com/docs/reference/query-language/scripting/built-in-functions) - [Function context](https://surrealdb.com/docs/reference/query-language/scripting/function-context) - [Scripting functions overview](https://surrealdb.com/docs/reference/query-language/scripting/overview) - [SurrealQL functions](https://surrealdb.com/docs/reference/query-language/scripting/surrealql-functions) - [Type conversion](https://surrealdb.com/docs/reference/query-language/scripting/type-conversion) - [ACCESS](https://surrealdb.com/docs/reference/query-language/statements/access) - [BEGIN](https://surrealdb.com/docs/reference/query-language/statements/begin) - [BREAK](https://surrealdb.com/docs/reference/query-language/statements/break) - [CANCEL](https://surrealdb.com/docs/reference/query-language/statements/cancel) - [COMMIT](https://surrealdb.com/docs/reference/query-language/statements/commit) - [CONTINUE](https://surrealdb.com/docs/reference/query-language/statements/continue) - [CREATE](https://surrealdb.com/docs/reference/query-language/statements/create) - [DELETE](https://surrealdb.com/docs/reference/query-language/statements/delete) - [EXPLAIN](https://surrealdb.com/docs/reference/query-language/statements/explain) - [FOR](https://surrealdb.com/docs/reference/query-language/statements/for) - [IF ELSE](https://surrealdb.com/docs/reference/query-language/statements/if-else) - [INFO](https://surrealdb.com/docs/reference/query-language/statements/info) - [INSERT](https://surrealdb.com/docs/reference/query-language/statements/insert) - [KILL](https://surrealdb.com/docs/reference/query-language/statements/kill) - [LET](https://surrealdb.com/docs/reference/query-language/statements/let) - [LIVE SELECT](https://surrealdb.com/docs/reference/query-language/statements/live-select) - [Statements](https://surrealdb.com/docs/reference/query-language/statements/overview) - [REBUILD](https://surrealdb.com/docs/reference/query-language/statements/rebuild) - [RELATE](https://surrealdb.com/docs/reference/query-language/statements/relate) - [REMOVE](https://surrealdb.com/docs/reference/query-language/statements/remove) - [RETURN](https://surrealdb.com/docs/reference/query-language/statements/return) - [SELECT](https://surrealdb.com/docs/reference/query-language/statements/select) - [SHOW](https://surrealdb.com/docs/reference/query-language/statements/show) - [SLEEP](https://surrealdb.com/docs/reference/query-language/statements/sleep) - [THROW](https://surrealdb.com/docs/reference/query-language/statements/throw) - [UPDATE](https://surrealdb.com/docs/reference/query-language/statements/update) - [UPSERT](https://surrealdb.com/docs/reference/query-language/statements/upsert) - [USE](https://surrealdb.com/docs/reference/query-language/statements/use) - [Authenticating users](https://surrealdb.com/docs/reference/rust/concepts/authenticating-users) - [Concurrency](https://surrealdb.com/docs/reference/rust/concepts/concurrency) - [Error handling](https://surrealdb.com/docs/reference/rust/concepts/error-handling) - [Fetching linked records](https://surrealdb.com/docs/reference/rust/concepts/fetch) - [Flexible typing](https://surrealdb.com/docs/reference/rust/concepts/flexible-typing) - [Live queries](https://surrealdb.com/docs/reference/rust/concepts/live) - [Multi-tenancy](https://surrealdb.com/docs/reference/rust/concepts/multi-tenancy) - [SurrealValue attributes](https://surrealdb.com/docs/reference/rust/concepts/surrealvalue-attributes) - [Manual transactions](https://surrealdb.com/docs/reference/rust/concepts/transaction) - [Vector embeddings](https://surrealdb.com/docs/reference/rust/concepts/vector-embeddings) - [Working with types](https://surrealdb.com/docs/reference/rust/concepts/working-with-types) - [Actix](https://surrealdb.com/docs/reference/rust/frameworks/actix) - [Axum](https://surrealdb.com/docs/reference/rust/frameworks/axum) - [Egui](https://surrealdb.com/docs/reference/rust/frameworks/egui) - [Rocket](https://surrealdb.com/docs/reference/rust/frameworks/rocket) - [authenticate](https://surrealdb.com/docs/reference/rust/methods/authenticate) - [begin](https://surrealdb.com/docs/reference/rust/methods/begin) - [connect](https://surrealdb.com/docs/reference/rust/methods/connect) - [create](https://surrealdb.com/docs/reference/rust/methods/create) - [delete](https://surrealdb.com/docs/reference/rust/methods/delete) - [export](https://surrealdb.com/docs/reference/rust/methods/export) - [get](https://surrealdb.com/docs/reference/rust/methods/get) - [health](https://surrealdb.com/docs/reference/rust/methods/health) - [import](https://surrealdb.com/docs/reference/rust/methods/import) - [init](https://surrealdb.com/docs/reference/rust/methods/init) - [insert](https://surrealdb.com/docs/reference/rust/methods/insert) - [invalidate](https://surrealdb.com/docs/reference/rust/methods/invalidate) - [new](https://surrealdb.com/docs/reference/rust/methods/new) - [query](https://surrealdb.com/docs/reference/rust/methods/query) - [run](https://surrealdb.com/docs/reference/rust/methods/run) - [select](https://surrealdb.com/docs/reference/rust/methods/select) - [select_live](https://surrealdb.com/docs/reference/rust/methods/select-live) - [set](https://surrealdb.com/docs/reference/rust/methods/set) - [signin](https://surrealdb.com/docs/reference/rust/methods/signin) - [signup](https://surrealdb.com/docs/reference/rust/methods/signup) - [unset](https://surrealdb.com/docs/reference/rust/methods/unset) - [update](https://surrealdb.com/docs/reference/rust/methods/update) - [upsert](https://surrealdb.com/docs/reference/rust/methods/upsert) - [use_ns and use_db](https://surrealdb.com/docs/reference/rust/methods/use) - [use_defaults](https://surrealdb.com/docs/reference/rust/methods/use-defaults) - [version](https://surrealdb.com/docs/reference/rust/methods/version) - [wait_for](https://surrealdb.com/docs/reference/rust/methods/wait-for) - [Authentication](https://surrealdb.com/docs/reference/swift/concepts/authentication) - [Connecting to SurrealDB](https://surrealdb.com/docs/reference/swift/concepts/connecting) - [Live queries](https://surrealdb.com/docs/reference/swift/concepts/live-queries) - [Models](https://surrealdb.com/docs/reference/swift/concepts/models) - [Predicates](https://surrealdb.com/docs/reference/swift/concepts/predicates) - [Query DSL](https://surrealdb.com/docs/reference/swift/concepts/query-dsl) - [authenticate](https://surrealdb.com/docs/reference/swift/methods/authenticate) - [connect](https://surrealdb.com/docs/reference/swift/methods/connect) - [create](https://surrealdb.com/docs/reference/swift/methods/create) - [delete](https://surrealdb.com/docs/reference/swift/methods/delete) - [invalidate](https://surrealdb.com/docs/reference/swift/methods/invalidate) - [kill](https://surrealdb.com/docs/reference/swift/methods/kill) - [live](https://surrealdb.com/docs/reference/swift/methods/live) - [query](https://surrealdb.com/docs/reference/swift/methods/query) - [queryRaw](https://surrealdb.com/docs/reference/swift/methods/query-raw) - [select](https://surrealdb.com/docs/reference/swift/methods/select) - [signin](https://surrealdb.com/docs/reference/swift/methods/signin) - [signup](https://surrealdb.com/docs/reference/swift/methods/signup) - [update](https://surrealdb.com/docs/reference/swift/methods/update) - [upsert](https://surrealdb.com/docs/reference/swift/methods/upsert) - [use](https://surrealdb.com/docs/reference/swift/methods/use) - [auth](https://surrealdb.com/docs/reference/cli/surrealctl/commands/auth) - [catalog](https://surrealdb.com/docs/reference/cli/surrealctl/commands/catalog) - [config](https://surrealdb.com/docs/reference/cli/surrealctl/commands/config) - [context](https://surrealdb.com/docs/reference/cli/surrealctl/commands/context) - [instance](https://surrealdb.com/docs/reference/cli/surrealctl/commands/instance) - [invite](https://surrealdb.com/docs/reference/cli/surrealctl/commands/invite) - [Other commands](https://surrealdb.com/docs/reference/cli/surrealctl/commands/misc) - [org](https://surrealdb.com/docs/reference/cli/surrealctl/commands/org) - [spectron](https://surrealdb.com/docs/reference/cli/surrealctl/commands/spectron) - [team](https://surrealdb.com/docs/reference/cli/surrealctl/commands/team) - [token](https://surrealdb.com/docs/reference/cli/surrealctl/commands/token) - [export](https://surrealdb.com/docs/reference/cli/surrealdb-cli/commands/export) - [fix](https://surrealdb.com/docs/reference/cli/surrealdb-cli/commands/fix) - [help](https://surrealdb.com/docs/reference/cli/surrealdb-cli/commands/help) - [import](https://surrealdb.com/docs/reference/cli/surrealdb-cli/commands/import) - [isready](https://surrealdb.com/docs/reference/cli/surrealdb-cli/commands/isready) - [mcp](https://surrealdb.com/docs/reference/cli/surrealdb-cli/commands/mcp) - [ml](https://surrealdb.com/docs/reference/cli/surrealdb-cli/commands/ml) - [module](https://surrealdb.com/docs/reference/cli/surrealdb-cli/commands/module) - [sql](https://surrealdb.com/docs/reference/cli/surrealdb-cli/commands/sql) - [start](https://surrealdb.com/docs/reference/cli/surrealdb-cli/commands/start) - [upgrade](https://surrealdb.com/docs/reference/cli/surrealdb-cli/commands/upgrade) - [validate](https://surrealdb.com/docs/reference/cli/surrealdb-cli/commands/validate) - [version](https://surrealdb.com/docs/reference/cli/surrealdb-cli/commands/version) - [DB](https://surrealdb.com/docs/reference/golang/api/core/db) - [Session](https://surrealdb.com/docs/reference/golang/api/core/session) - [Transaction](https://surrealdb.com/docs/reference/golang/api/core/transaction) - [CustomDateTime](https://surrealdb.com/docs/reference/golang/api/values/datetime) - [CustomDuration](https://surrealdb.com/docs/reference/golang/api/values/duration) - [Geometry](https://surrealdb.com/docs/reference/golang/api/values/geometry) - [Range](https://surrealdb.com/docs/reference/golang/api/values/range) - [RecordID](https://surrealdb.com/docs/reference/golang/api/values/record-id) - [Table](https://surrealdb.com/docs/reference/golang/api/values/table) - [UUID](https://surrealdb.com/docs/reference/golang/api/values/uuid) - [LiveStream](https://surrealdb.com/docs/reference/java/api/core/live-stream) - [Response](https://surrealdb.com/docs/reference/java/api/core/response) - [Surreal](https://surrealdb.com/docs/reference/java/api/core/surreal) - [Transaction](https://surrealdb.com/docs/reference/java/api/core/transaction) - [Datetime](https://surrealdb.com/docs/reference/java/api/values/datetime) - [Duration](https://surrealdb.com/docs/reference/java/api/values/duration) - [FileRef](https://surrealdb.com/docs/reference/java/api/values/file-ref) - [Geometry](https://surrealdb.com/docs/reference/java/api/values/geometry) - [Range](https://surrealdb.com/docs/reference/java/api/values/range) - [RecordId](https://surrealdb.com/docs/reference/java/api/values/record-id) - [Table](https://surrealdb.com/docs/reference/java/api/values/table) - [Value](https://surrealdb.com/docs/reference/java/api/values/value) - [Surreal](https://surrealdb.com/docs/reference/javascript/api/core/surreal) - [SurrealApi](https://surrealdb.com/docs/reference/javascript/api/core/surreal-api) - [SurrealQueryable](https://surrealdb.com/docs/reference/javascript/api/core/surreal-queryable) - [SurrealSession](https://surrealdb.com/docs/reference/javascript/api/core/surreal-session) - [SurrealTransaction](https://surrealdb.com/docs/reference/javascript/api/core/surreal-transaction) - [ApiPromise](https://surrealdb.com/docs/reference/javascript/api/queries/api-promise) - [CreatePromise](https://surrealdb.com/docs/reference/javascript/api/queries/create-promise) - [DeletePromise](https://surrealdb.com/docs/reference/javascript/api/queries/delete-promise) - [InsertPromise](https://surrealdb.com/docs/reference/javascript/api/queries/insert-promise) - [LivePromise](https://surrealdb.com/docs/reference/javascript/api/queries/live-promise) - [Query](https://surrealdb.com/docs/reference/javascript/api/queries/query) - [RelatePromise](https://surrealdb.com/docs/reference/javascript/api/queries/relate-promise) - [RunPromise](https://surrealdb.com/docs/reference/javascript/api/queries/run-promise) - [SelectPromise](https://surrealdb.com/docs/reference/javascript/api/queries/select-promise) - [UpdatePromise](https://surrealdb.com/docs/reference/javascript/api/queries/update-promise) - [UpsertPromise](https://surrealdb.com/docs/reference/javascript/api/queries/upsert-promise) - [BoundQuery](https://surrealdb.com/docs/reference/javascript/api/utilities/bound-query) - [equals](https://surrealdb.com/docs/reference/javascript/api/utilities/equals) - [Escape functions](https://surrealdb.com/docs/reference/javascript/api/utilities/escape) - [expr](https://surrealdb.com/docs/reference/javascript/api/utilities/expr) - [isRetryableConflict](https://surrealdb.com/docs/reference/javascript/api/utilities/is-retryable-conflict) - [surql](https://surrealdb.com/docs/reference/javascript/api/utilities/surql) - [DateTime](https://surrealdb.com/docs/reference/javascript/api/values/datetime) - [Decimal](https://surrealdb.com/docs/reference/javascript/api/values/decimal) - [Duration](https://surrealdb.com/docs/reference/javascript/api/values/duration) - [FileRef](https://surrealdb.com/docs/reference/javascript/api/values/file-ref) - [Geometry](https://surrealdb.com/docs/reference/javascript/api/values/geometry) - [Range](https://surrealdb.com/docs/reference/javascript/api/values/range) - [RecordId](https://surrealdb.com/docs/reference/javascript/api/values/record-id) - [Table](https://surrealdb.com/docs/reference/javascript/api/values/table) - [Uuid](https://surrealdb.com/docs/reference/javascript/api/values/uuid) - [SurrealClientConfig](https://surrealdb.com/docs/reference/kotlin/api/core/client-config) - [LiveQuerySubscription](https://surrealdb.com/docs/reference/kotlin/api/core/live-subscription) - [Query builders](https://surrealdb.com/docs/reference/kotlin/api/core/query-builder) - [SurrealSession](https://surrealdb.com/docs/reference/kotlin/api/core/session) - [SurrealClient](https://surrealdb.com/docs/reference/kotlin/api/core/surreal-client) - [SurrealTransaction](https://surrealdb.com/docs/reference/kotlin/api/core/transaction) - [RecordId](https://surrealdb.com/docs/reference/kotlin/api/values/record-id) - [RecordIdRange](https://surrealdb.com/docs/reference/kotlin/api/values/record-id-range) - [Table](https://surrealdb.com/docs/reference/kotlin/api/values/table) - [Value (JSON model)](https://surrealdb.com/docs/reference/kotlin/api/values/value) - [Configuration](https://surrealdb.com/docs/reference/php/frameworks/laravel/configuration) - [Container and facades](https://surrealdb.com/docs/reference/php/frameworks/laravel/container-and-facades) - [Installation](https://surrealdb.com/docs/reference/php/frameworks/laravel/installation) - [Queries and transactions](https://surrealdb.com/docs/reference/php/frameworks/laravel/queries-and-transactions) - [Schema commands](https://surrealdb.com/docs/reference/php/frameworks/laravel/schema-commands) - [Testing](https://surrealdb.com/docs/reference/php/frameworks/laravel/testing) - [Code generation and CLI](https://surrealdb.com/docs/reference/php/libraries/surqlize/code-generation-and-cli) - [Connections](https://surrealdb.com/docs/reference/php/libraries/surqlize/connections) - [Edges and graph](https://surrealdb.com/docs/reference/php/libraries/surqlize/edges-and-graph) - [Installation](https://surrealdb.com/docs/reference/php/libraries/surqlize/installation) - [Models](https://surrealdb.com/docs/reference/php/libraries/surqlize/models) - [Mutations](https://surrealdb.com/docs/reference/php/libraries/surqlize/mutations) - [Querying](https://surrealdb.com/docs/reference/php/libraries/surqlize/querying) - [Schema](https://surrealdb.com/docs/reference/php/libraries/surqlize/schema) - [Search, vector, and geometry](https://surrealdb.com/docs/reference/php/libraries/surqlize/search-vector-geometry) - [Transactions](https://surrealdb.com/docs/reference/php/libraries/surqlize/transactions) - [Authentication](https://surrealdb.com/docs/reference/php/v1/concepts/authentication) - [Connecting to SurrealDB](https://surrealdb.com/docs/reference/php/v1/concepts/connecting) - [Data types](https://surrealdb.com/docs/reference/php/v1/concepts/data-types) - [Executing queries](https://surrealdb.com/docs/reference/php/v1/concepts/executing-queries) - [authenticate](https://surrealdb.com/docs/reference/php/v1/methods/authenticate) - [close](https://surrealdb.com/docs/reference/php/v1/methods/close) - [connect](https://surrealdb.com/docs/reference/php/v1/methods/connect) - [create](https://surrealdb.com/docs/reference/php/v1/methods/create) - [delete](https://surrealdb.com/docs/reference/php/v1/methods/delete) - [export](https://surrealdb.com/docs/reference/php/v1/methods/export) - [health](https://surrealdb.com/docs/reference/php/v1/methods/health) - [import](https://surrealdb.com/docs/reference/php/v1/methods/import) - [info](https://surrealdb.com/docs/reference/php/v1/methods/info) - [insert](https://surrealdb.com/docs/reference/php/v1/methods/insert) - [insertRelation](https://surrealdb.com/docs/reference/php/v1/methods/insert-relation) - [invalidate](https://surrealdb.com/docs/reference/php/v1/methods/invalidate) - [let](https://surrealdb.com/docs/reference/php/v1/methods/let) - [merge](https://surrealdb.com/docs/reference/php/v1/methods/merge) - [patch](https://surrealdb.com/docs/reference/php/v1/methods/patch) - [query](https://surrealdb.com/docs/reference/php/v1/methods/query) - [queryRaw](https://surrealdb.com/docs/reference/php/v1/methods/query-raw) - [run](https://surrealdb.com/docs/reference/php/v1/methods/run) - [select](https://surrealdb.com/docs/reference/php/v1/methods/select) - [signin](https://surrealdb.com/docs/reference/php/v1/methods/signin) - [signup](https://surrealdb.com/docs/reference/php/v1/methods/signup) - [status](https://surrealdb.com/docs/reference/php/v1/methods/status) - [unset](https://surrealdb.com/docs/reference/php/v1/methods/unset) - [update](https://surrealdb.com/docs/reference/php/v1/methods/update) - [upsert](https://surrealdb.com/docs/reference/php/v1/methods/upsert) - [use](https://surrealdb.com/docs/reference/php/v1/methods/use) - [version](https://surrealdb.com/docs/reference/php/v1/methods/version) - [Core classes](https://surrealdb.com/docs/reference/php/v2/api/core) - [Data types](https://surrealdb.com/docs/reference/php/v2/api/data-types) - [Query builders](https://surrealdb.com/docs/reference/php/v2/api/query-builders) - [Utilities](https://surrealdb.com/docs/reference/php/v2/api/utilities) - [Authentication](https://surrealdb.com/docs/reference/php/v2/concepts/authentication) - [Connecting to SurrealDB](https://surrealdb.com/docs/reference/php/v2/concepts/connecting-to-surrealdb) - [Data types](https://surrealdb.com/docs/reference/php/v2/concepts/data-types) - [Error handling](https://surrealdb.com/docs/reference/php/v2/concepts/error-handling) - [Events](https://surrealdb.com/docs/reference/php/v2/concepts/events) - [Executing queries](https://surrealdb.com/docs/reference/php/v2/concepts/executing-queries) - [Live queries](https://surrealdb.com/docs/reference/php/v2/concepts/live-queries) - [Middleware](https://surrealdb.com/docs/reference/php/v2/concepts/middleware) - [Observability](https://surrealdb.com/docs/reference/php/v2/concepts/observability) - [Runtimes and workers](https://surrealdb.com/docs/reference/php/v2/concepts/runtimes) - [Sessions](https://surrealdb.com/docs/reference/php/v2/concepts/sessions) - [Transactions](https://surrealdb.com/docs/reference/php/v2/concepts/transactions) - [Surreal](https://surrealdb.com/docs/reference/python/api/core/surreal) - [SurrealSession](https://surrealdb.com/docs/reference/python/api/core/surreal-session) - [SurrealTransaction](https://surrealdb.com/docs/reference/python/api/core/surreal-transaction) - [Datetime](https://surrealdb.com/docs/reference/python/api/values/datetime) - [Duration](https://surrealdb.com/docs/reference/python/api/values/duration) - [Geometry](https://surrealdb.com/docs/reference/python/api/values/geometry) - [Range](https://surrealdb.com/docs/reference/python/api/values/range) - [RecordID](https://surrealdb.com/docs/reference/python/api/values/record-id) - [Table](https://surrealdb.com/docs/reference/python/api/values/table) - [API](https://surrealdb.com/docs/reference/query-language/functions/database-functions/api) - [Array](https://surrealdb.com/docs/reference/query-language/functions/database-functions/array) - [Bytes](https://surrealdb.com/docs/reference/query-language/functions/database-functions/bytes) - [Count](https://surrealdb.com/docs/reference/query-language/functions/database-functions/count) - [Crypto](https://surrealdb.com/docs/reference/query-language/functions/database-functions/crypto) - [Duration](https://surrealdb.com/docs/reference/query-language/functions/database-functions/duration) - [Encoding](https://surrealdb.com/docs/reference/query-language/functions/database-functions/encoding) - [Eval](https://surrealdb.com/docs/reference/query-language/functions/database-functions/eval) - [File](https://surrealdb.com/docs/reference/query-language/functions/database-functions/file) - [Geo](https://surrealdb.com/docs/reference/query-language/functions/database-functions/geo) - [HTTP](https://surrealdb.com/docs/reference/query-language/functions/database-functions/http) - [Math](https://surrealdb.com/docs/reference/query-language/functions/database-functions/math) - [Not](https://surrealdb.com/docs/reference/query-language/functions/database-functions/not) - [Object](https://surrealdb.com/docs/reference/query-language/functions/database-functions/object) - [Parse](https://surrealdb.com/docs/reference/query-language/functions/database-functions/parse) - [Rand functions](https://surrealdb.com/docs/reference/query-language/functions/database-functions/rand) - [Record](https://surrealdb.com/docs/reference/query-language/functions/database-functions/record) - [Search](https://surrealdb.com/docs/reference/query-language/functions/database-functions/search) - [Sequence](https://surrealdb.com/docs/reference/query-language/functions/database-functions/sequence) - [Session](https://surrealdb.com/docs/reference/query-language/functions/database-functions/session) - [Set](https://surrealdb.com/docs/reference/query-language/functions/database-functions/set) - [Sleep](https://surrealdb.com/docs/reference/query-language/functions/database-functions/sleep) - [String](https://surrealdb.com/docs/reference/query-language/functions/database-functions/string) - [Time](https://surrealdb.com/docs/reference/query-language/functions/database-functions/time) - [Type](https://surrealdb.com/docs/reference/query-language/functions/database-functions/type) - [Value](https://surrealdb.com/docs/reference/query-language/functions/database-functions/value) - [Vector](https://surrealdb.com/docs/reference/query-language/functions/database-functions/vector) - [ML functions](https://surrealdb.com/docs/reference/query-language/functions/ml-functions/functions) - [Arrays](https://surrealdb.com/docs/reference/query-language/language-primitives/data-types/arrays) - [Booleans](https://surrealdb.com/docs/reference/query-language/language-primitives/data-types/booleans) - [Bytes](https://surrealdb.com/docs/reference/query-language/language-primitives/data-types/bytes) - [Closures](https://surrealdb.com/docs/reference/query-language/language-primitives/data-types/closures) - [Datetimes](https://surrealdb.com/docs/reference/query-language/language-primitives/data-types/datetimes) - [Durations](https://surrealdb.com/docs/reference/query-language/language-primitives/data-types/durations) - [Files](https://surrealdb.com/docs/reference/query-language/language-primitives/data-types/files) - [Futures](https://surrealdb.com/docs/reference/query-language/language-primitives/data-types/futures) - [Geometries](https://surrealdb.com/docs/reference/query-language/language-primitives/data-types/geometries) - [Literals](https://surrealdb.com/docs/reference/query-language/language-primitives/data-types/literals) - [None and Null](https://surrealdb.com/docs/reference/query-language/language-primitives/data-types/none-and-null) - [Numbers](https://surrealdb.com/docs/reference/query-language/language-primitives/data-types/numbers) - [Objects](https://surrealdb.com/docs/reference/query-language/language-primitives/data-types/objects) - [Ranges](https://surrealdb.com/docs/reference/query-language/language-primitives/data-types/ranges) - [Record IDs](https://surrealdb.com/docs/reference/query-language/language-primitives/data-types/record-ids) - [Regex](https://surrealdb.com/docs/reference/query-language/language-primitives/data-types/regex) - [Sets](https://surrealdb.com/docs/reference/query-language/language-primitives/data-types/sets) - [Strings](https://surrealdb.com/docs/reference/query-language/language-primitives/data-types/strings) - [UUIDs](https://surrealdb.com/docs/reference/query-language/language-primitives/data-types/uuids) - [Values](https://surrealdb.com/docs/reference/query-language/language-primitives/data-types/values) - [ALTER ACCESS](https://surrealdb.com/docs/reference/query-language/statements/alter/access) - [ALTER ANALYZER](https://surrealdb.com/docs/reference/query-language/statements/alter/analyzer) - [ALTER API](https://surrealdb.com/docs/reference/query-language/statements/alter/api) - [ALTER BUCKET](https://surrealdb.com/docs/reference/query-language/statements/alter/bucket) - [ALTER CONFIG](https://surrealdb.com/docs/reference/query-language/statements/alter/config) - [ALTER DATABASE](https://surrealdb.com/docs/reference/query-language/statements/alter/database) - [ALTER EVENT](https://surrealdb.com/docs/reference/query-language/statements/alter/event) - [ALTER FIELD](https://surrealdb.com/docs/reference/query-language/statements/alter/field) - [ALTER FUNCTION](https://surrealdb.com/docs/reference/query-language/statements/alter/function) - [ALTER INDEX](https://surrealdb.com/docs/reference/query-language/statements/alter/indexes) - [ALTER NAMESPACE](https://surrealdb.com/docs/reference/query-language/statements/alter/namespace) - [ALTER](https://surrealdb.com/docs/reference/query-language/statements/alter/overview) - [ALTER PARAM](https://surrealdb.com/docs/reference/query-language/statements/alter/param) - [ALTER SEQUENCE](https://surrealdb.com/docs/reference/query-language/statements/alter/sequence) - [ALTER SYSTEM](https://surrealdb.com/docs/reference/query-language/statements/alter/system) - [ALTER TABLE](https://surrealdb.com/docs/reference/query-language/statements/alter/table) - [ALTER USER](https://surrealdb.com/docs/reference/query-language/statements/alter/user) - [DEFINE ACCESS](https://surrealdb.com/docs/reference/query-language/statements/define/access) - [DEFINE ANALYZER](https://surrealdb.com/docs/reference/query-language/statements/define/analyzer) - [DEFINE API](https://surrealdb.com/docs/reference/query-language/statements/define/api) - [DEFINE BUCKET](https://surrealdb.com/docs/reference/query-language/statements/define/bucket) - [DEFINE CONFIG](https://surrealdb.com/docs/reference/query-language/statements/define/config) - [DEFINE DATABASE](https://surrealdb.com/docs/reference/query-language/statements/define/database) - [DEFINE EVENT](https://surrealdb.com/docs/reference/query-language/statements/define/event) - [DEFINE FIELD](https://surrealdb.com/docs/reference/query-language/statements/define/field) - [DEFINE FUNCTION](https://surrealdb.com/docs/reference/query-language/statements/define/function) - [DEFINE INDEX](https://surrealdb.com/docs/reference/query-language/statements/define/indexes) - [DEFINE MODULE](https://surrealdb.com/docs/reference/query-language/statements/define/module) - [DEFINE NAMESPACE](https://surrealdb.com/docs/reference/query-language/statements/define/namespace) - [DEFINE](https://surrealdb.com/docs/reference/query-language/statements/define/overview) - [DEFINE PARAM](https://surrealdb.com/docs/reference/query-language/statements/define/param) - [DEFINE SCOPE](https://surrealdb.com/docs/reference/query-language/statements/define/scope) - [DEFINE SEQUENCE](https://surrealdb.com/docs/reference/query-language/statements/define/sequence) - [DEFINE TABLE](https://surrealdb.com/docs/reference/query-language/statements/define/table) - [DEFINE TOKEN](https://surrealdb.com/docs/reference/query-language/statements/define/token) - [DEFINE USER](https://surrealdb.com/docs/reference/query-language/statements/define/user) - [BEARER](https://surrealdb.com/docs/reference/query-language/statements/define/access/bearer) - [JWT](https://surrealdb.com/docs/reference/query-language/statements/define/access/jwt) - [RECORD](https://surrealdb.com/docs/reference/query-language/statements/define/access/record) ## Agent Memory - [Agent Memory](https://surrealdb.com/docs/agent-memory): Memory and knowledge for AI agents on SurrealDB. - [Cookbooks](https://surrealdb.com/docs/agent-memory/cookbooks): Opinionated recipes and migration guides. - [Agent Memory integrations](https://surrealdb.com/docs/agent-memory/integrations): SDKs, the MCP server, AI SDKs and agent frameworks. - [Memory & knowledge](https://surrealdb.com/docs/agent-memory/memory-and-knowledge): Ingest, retrieve, reason, and tune agent memory. - [Agent Memory reference](https://surrealdb.com/docs/agent-memory/reference): Complete API and configuration reference for SurrealDB Agent Memory. - [Coherence, retrieval, and cost tiers](https://surrealdb.com/docs/agent-memory/architecture/coherence-retrieval-and-tiers): Five coherence dimensions and hybrid structural retrieval. - [Eight pillars and six categories](https://surrealdb.com/docs/agent-memory/architecture/eight-pillars-and-categories): The primitives SurrealDB Agent Memory operationalises. - [Agent Memory glossary](https://surrealdb.com/docs/agent-memory/architecture/glossary): Alphabetical definitions of SurrealDB Agent Memory terms. - [Principles and goals](https://surrealdb.com/docs/agent-memory/architecture/principles-and-goals): What SurrealDB Agent Memory deliberately is and is not. - [Surface, models, and security](https://surrealdb.com/docs/agent-memory/architecture/surface-security-and-models): HTTP ingest and read verbs, integrations, and model hooks. - [Traces and memory evolution](https://surrealdb.com/docs/agent-memory/architecture/traces-and-evolution): Graph-resident traces, reflection, elaboration, consolidation. - [Tri-temporal model](https://surrealdb.com/docs/agent-memory/architecture/tri-temporal-model): System and valid time, supersession, ageing, and explicit forget. - [Contexts and scope](https://surrealdb.com/docs/agent-memory/mental-model/contexts-and-scope): How scope tags partition memory, and how Contexts isolate tenants. - [Memory categories](https://surrealdb.com/docs/agent-memory/mental-model/memory-categories): Episodic raw turns plus five extracted experiential categories. - [Supersession, decay, and forget](https://surrealdb.com/docs/agent-memory/mental-model/memory-lifecycle): Three mechanisms for how beliefs change, fade, and are removed. - [Provenance and traceability](https://surrealdb.com/docs/agent-memory/mental-model/provenance-and-traceability): The source object carried on every record. - [Sessions and turns](https://surrealdb.com/docs/agent-memory/mental-model/sessions-and-turns): How conversations map to sessions, turns, and provenance. - [Unified substrate and authority](https://surrealdb.com/docs/agent-memory/mental-model/two-layer-architecture): One SurrealDB graph for authoritative and experiential knowledge. - [Forgetting memories](https://surrealdb.com/docs/agent-memory/operations/forget): Default forget, purge, and scoped erasure. - [Profiles](https://surrealdb.com/docs/agent-memory/operations/profiles): Auto-maintained entity profiles aggregated from memory and knowledge. - [Reflection](https://surrealdb.com/docs/agent-memory/operations/reflect): Synthesise insights from patterns across stored memories. - [Embedded library quickstart](https://surrealdb.com/docs/agent-memory/quickstarts/embedded): Integration surfaces for SurrealDB Agent Memory. - [Hosted quickstart](https://surrealdb.com/docs/agent-memory/quickstarts/hosted): Get SurrealDB Agent Memory running in five minutes. - [Agent Memory on SurrealDB Cloud](https://surrealdb.com/docs/agent-memory/quickstarts/surrealdb-cloud): How contexts, authentication and the APIs work on SurrealDB Cloud. - [Authority when pillars meet](https://surrealdb.com/docs/agent-memory/reasoning/authority-hierarchy): How the Authoritative and Experiential pillars interact. - [Cross-layer linking](https://surrealdb.com/docs/agent-memory/reasoning/cross-layer-linking): How authoritative documents and experiential facts relate. - [Extraction pipeline](https://surrealdb.com/docs/agent-memory/reasoning/extraction-pipeline): How structured memory is extracted from conversation turns. - [Instructions and uncertainties](https://surrealdb.com/docs/agent-memory/reasoning/instructions-and-uncertainties): How behavioural directives are captured and tracked. - [Reconciliation and supersession](https://surrealdb.com/docs/agent-memory/reasoning/reconciliation-and-supersession): How entities are deduplicated and conflicts detected. - [Temporal validity](https://surrealdb.com/docs/agent-memory/reasoning/temporal-validity): How SurrealDB Agent Memory tracks when facts were true. - [Agent guide (AGENTS.md)](https://surrealdb.com/docs/agent-memory/reference/agents): Copy these into your Cursor rules or agent skills. - [CLI](https://surrealdb.com/docs/agent-memory/reference/cli): Command-line interface reference. - [Configuration](https://surrealdb.com/docs/agent-memory/reference/configuration): Context config, models, and limits. - [Data model and schema](https://surrealdb.com/docs/agent-memory/reference/data-model-and-schema): Tables, relations, and indexes in SurrealDB. - [Errors](https://surrealdb.com/docs/agent-memory/reference/errors): Error codes and troubleshooting. - [Glossary](https://surrealdb.com/docs/agent-memory/reference/glossary): Terminology used across SurrealDB Agent Memory docs. - [Management API](https://surrealdb.com/docs/agent-memory/reference/management-api): Contexts, keys, and operator lifecycle. - [MCP tools](https://surrealdb.com/docs/agent-memory/reference/mcp-tools): Tool payloads and ACL alignment. - [REST API](https://surrealdb.com/docs/agent-memory/reference/rest-api): End-user HTTP endpoints on the unified substrate. - [JavaScript SDK reference](https://surrealdb.com/docs/agent-memory/reference/sdk-javascript): Package layout and configuration for @surrealdb/memory. - [Kotlin SDK reference](https://surrealdb.com/docs/agent-memory/reference/sdk-kotlin): The SurrealDB Agent Memory Kotlin client. - [Python SDK reference](https://surrealdb.com/docs/agent-memory/reference/sdk-python): The SurrealDB Agent Memory client inside the surrealdb package. - [Swift SDK reference](https://surrealdb.com/docs/agent-memory/reference/sdk-swift): The SurrealDB Agent Memory Swift client. - [Graph traversal](https://surrealdb.com/docs/agent-memory/retrieve/graph-traversal): Structural edges in the knowledge layer and how retrieval uses them. - [Hybrid search](https://surrealdb.com/docs/agent-memory/retrieve/hybrid-search): Vector, BM25, and graph-density retrieval modes. - [Keywords and BM25](https://surrealdb.com/docs/agent-memory/retrieve/keywords-and-bm25): Keyword extraction and full-text search. - [Recalling memories](https://surrealdb.com/docs/agent-memory/retrieve/recall): Unified retrieval over facts and document passages. - [Adding turns](https://surrealdb.com/docs/agent-memory/sessions/adding-turns): How to add conversation turns. - [Chat sessions](https://surrealdb.com/docs/agent-memory/sessions/chat-sessions): Using chat() for conversation loops managed by SurrealDB Agent Memory. - [Creating sessions](https://surrealdb.com/docs/agent-memory/sessions/creating-sessions): How to create and manage conversation sessions. - [State and diffs](https://surrealdb.com/docs/agent-memory/sessions/state-and-diffs): Reading structured memory state. - [Caching and invalidation](https://surrealdb.com/docs/agent-memory/tuning/caching-and-invalidation): How the semantic response cache works. - [Models per stage](https://surrealdb.com/docs/agent-memory/tuning/models-per-stage): Configure which LLM runs at each processing stage. - [Extraction vocabulary](https://surrealdb.com/docs/agent-memory/tuning/ontology-grounding): How entity names and attribute keys stay consistent. - [The accuracy promise](https://surrealdb.com/docs/agent-memory/welcome/accuracy-promise): Defensible correctness in SurrealDB Agent Memory. - [How it works in five minutes](https://surrealdb.com/docs/agent-memory/welcome/how-it-works): From a message to structured substrate state. - [What is SurrealDB Agent Memory?](https://surrealdb.com/docs/agent-memory/welcome/what-is-surrealdb-agent-memory): A memory and knowledge layer for AI agents. - [Why agentic memory?](https://surrealdb.com/docs/agent-memory/welcome/why-agentic-memory): Why conversational agents need structured memory. - [Coding agent with project memory](https://surrealdb.com/docs/agent-memory/cookbooks/build/coding-agent-with-project-memory) - [Customer support agent](https://surrealdb.com/docs/agent-memory/cookbooks/build/customer-support-agent) - [Long-running research agent](https://surrealdb.com/docs/agent-memory/cookbooks/build/long-running-research-agent) - [Multi-agent shared memory](https://surrealdb.com/docs/agent-memory/cookbooks/build/multi-agent-shared-memory) - [Personal AI assistant](https://surrealdb.com/docs/agent-memory/cookbooks/build/personal-ai-assistant) - [Migrate from LangMem](https://surrealdb.com/docs/agent-memory/cookbooks/migrate/from-langmem) - [Migrate from Mem0](https://surrealdb.com/docs/agent-memory/cookbooks/migrate/from-mem0) - [Migrate from a vector store](https://surrealdb.com/docs/agent-memory/cookbooks/migrate/from-vector-store) - [Migrate from Zep](https://surrealdb.com/docs/agent-memory/cookbooks/migrate/from-zep) - [Adding memory to an existing app](https://surrealdb.com/docs/agent-memory/cookbooks/patterns/adding-memory-to-existing-app) - [Event-driven game client](https://surrealdb.com/docs/agent-memory/cookbooks/patterns/event-driven-game-client) - [Historical and archaeological data](https://surrealdb.com/docs/agent-memory/cookbooks/patterns/historical-and-archaeological-data) - [Knowledge-grounded agents](https://surrealdb.com/docs/agent-memory/cookbooks/patterns/knowledge-grounded-agents) - [Reflection loops](https://surrealdb.com/docs/agent-memory/cookbooks/patterns/reflection-loops) - [Spoiler-safe narrative memory](https://surrealdb.com/docs/agent-memory/cookbooks/patterns/spoiler-safe-narrative-memory) - [Stateful workflows](https://surrealdb.com/docs/agent-memory/cookbooks/patterns/stateful-workflows) - [User memory in chat](https://surrealdb.com/docs/agent-memory/cookbooks/patterns/user-memory-in-chat) - [Bulk import](https://surrealdb.com/docs/agent-memory/ingest/authoritative/bulk-import) - [Structured fact ingest](https://surrealdb.com/docs/agent-memory/ingest/authoritative/knowledge-nodes) - [Multimodal content](https://surrealdb.com/docs/agent-memory/ingest/authoritative/multimodal-content) - [Uploading documents](https://surrealdb.com/docs/agent-memory/ingest/authoritative/uploading-documents) - [Storing memories](https://surrealdb.com/docs/agent-memory/ingest/experiential/remember) - [Cloudflare Workers AI](https://surrealdb.com/docs/agent-memory/integrations/ai-sdks/cloudflare-workers-ai) - [TanStack AI](https://surrealdb.com/docs/agent-memory/integrations/ai-sdks/tanstack-ai) - [Vercel AI SDK](https://surrealdb.com/docs/agent-memory/integrations/ai-sdks/vercel-ai-sdk) - [n8n](https://surrealdb.com/docs/agent-memory/integrations/automation/n8n) - [Zo Computer](https://surrealdb.com/docs/agent-memory/integrations/automation/zo-computer) - [Agno](https://surrealdb.com/docs/agent-memory/integrations/frameworks/agno) - [AutoGen](https://surrealdb.com/docs/agent-memory/integrations/frameworks/autogen) - [Camel AI](https://surrealdb.com/docs/agent-memory/integrations/frameworks/camel-ai) - [CrewAI](https://surrealdb.com/docs/agent-memory/integrations/frameworks/crewai) - [Eve](https://surrealdb.com/docs/agent-memory/integrations/frameworks/eve) - [Google ADK](https://surrealdb.com/docs/agent-memory/integrations/frameworks/google-adk) - [Hermes Agent](https://surrealdb.com/docs/agent-memory/integrations/frameworks/hermes) - [LangChain](https://surrealdb.com/docs/agent-memory/integrations/frameworks/langchain) - [LlamaIndex](https://surrealdb.com/docs/agent-memory/integrations/frameworks/llamaindex) - [Mastra](https://surrealdb.com/docs/agent-memory/integrations/frameworks/mastra) - [OpenAI Agents SDK](https://surrealdb.com/docs/agent-memory/integrations/frameworks/openai-agents) - [OpenClaw](https://surrealdb.com/docs/agent-memory/integrations/frameworks/openclaw) - [Pydantic AI](https://surrealdb.com/docs/agent-memory/integrations/frameworks/pydantic-ai) - [Strands Agents](https://surrealdb.com/docs/agent-memory/integrations/frameworks/strands-agents) - [Installing the MCP server](https://surrealdb.com/docs/agent-memory/integrations/mcp-server/install) - [MCP tools reference](https://surrealdb.com/docs/agent-memory/integrations/mcp-server/tools-reference) - [AgentOps](https://surrealdb.com/docs/agent-memory/integrations/observability/agentops) - [Respan](https://surrealdb.com/docs/agent-memory/integrations/observability/respan) - [Dart SDK](https://surrealdb.com/docs/agent-memory/integrations/sdks/dart) - [Elixir SDK](https://surrealdb.com/docs/agent-memory/integrations/sdks/elixir) - [Go SDK](https://surrealdb.com/docs/agent-memory/integrations/sdks/go) - [Haskell SDK](https://surrealdb.com/docs/agent-memory/integrations/sdks/haskell) - [JavaScript and TypeScript SDK](https://surrealdb.com/docs/agent-memory/integrations/sdks/javascript-and-typescript) - [Kotlin SDK](https://surrealdb.com/docs/agent-memory/integrations/sdks/kotlin) - [Python SDK](https://surrealdb.com/docs/agent-memory/integrations/sdks/python) - [Swift SDK](https://surrealdb.com/docs/agent-memory/integrations/sdks/swift) - [Embedded library](https://surrealdb.com/docs/agent-memory/integrations/surfaces/embedded-library) - [Filesystem view](https://surrealdb.com/docs/agent-memory/integrations/surfaces/filesystem-view) - [REST API](https://surrealdb.com/docs/agent-memory/integrations/surfaces/rest) - [ElevenLabs](https://surrealdb.com/docs/agent-memory/integrations/voice/elevenlabs) - [Gradium](https://surrealdb.com/docs/agent-memory/integrations/voice/gradium) - [LiveKit](https://surrealdb.com/docs/agent-memory/integrations/voice/livekit) - [Antigravity](https://surrealdb.com/docs/agent-memory/integrations/mcp-server/coding-assistants/antigravity) - [Claude](https://surrealdb.com/docs/agent-memory/integrations/mcp-server/coding-assistants/claude-desktop-and-code) - [Codex](https://surrealdb.com/docs/agent-memory/integrations/mcp-server/coding-assistants/codex) - [Cursor](https://surrealdb.com/docs/agent-memory/integrations/mcp-server/coding-assistants/cursor) - [JetBrains](https://surrealdb.com/docs/agent-memory/integrations/mcp-server/coding-assistants/jetbrains) - [JetBrains Air](https://surrealdb.com/docs/agent-memory/integrations/mcp-server/coding-assistants/jetbrains-air) - [OpenCode](https://surrealdb.com/docs/agent-memory/integrations/mcp-server/coding-assistants/opencode) - [VS Code](https://surrealdb.com/docs/agent-memory/integrations/mcp-server/coding-assistants/vscode) - [Windsurf](https://surrealdb.com/docs/agent-memory/integrations/mcp-server/coding-assistants/windsurf) - [Zed](https://surrealdb.com/docs/agent-memory/integrations/mcp-server/coding-assistants/zed)