SurrealDB

Enter a search query

SurrealDB SurrealQL Surrealist UI Cloud Extensions

SDKs

Rust

JavaScript

Node.js

WebAssembly

Java

Golang

Python

.NET

PHP

Examples

Lab Examples

Lab Tutorials

Education

Quick tour

Fundamentals

Book

Movie database

Sidekick assistant

Sidekick assistant

Navigation

Enter a search query

SurrealDB SurrealQL Surrealist UI Cloud Extensions

SDKs

Rust

JavaScript

Node.js

WebAssembly

Java

Golang

Python

.NET

PHP

Examples

Lab Examples

Lab Tutorials

Education

Quick tour

Fundamentals

Book

Movie database

Sidekick assistant

Sidekick assistant

Table of Contents

Introduction

Introduction Getting started Concepts Architecture

Installation

Introduction Install on macOS Install on Linux Install on Windows Install the Nightly

Run with Docker Run a disk based server Run an in memory server Run a multi node server

Upgrading from 1.x to 2.x Upgrading from 2.x to 3.x

Migrating

Introduction Migrating from Neo4j Migrating from PostgreSQL Migrating from MongoDB Migrating from MySQL Importing CSV data Importing JSON Lines data Importing Kafka data

Querying

Introduction Querying via SDKs

SurrealQL via Surrealist SurrealQL via HTTP SurrealQL via CLI

GraphQL via HTTP GraphQL via Bruno (Coming soon) GraphQL via Surrealist

Data Models

Introduction Document Graph and record links Vector Text and full-text search Time series Geospatial

CLI and database serving

Introduction Environment variables Start command SQL command Export command Fix command Help command Import command Isready command ML command Module command Upgrade command Validate command Version command

Extensions

Introduction Quick tutorial Further examples

Security

Introduction Summary Authentication Capabilities Troubleshooting Best practices

Deployment

Introduction Deploy on SurrealDB Cloud Deploy on Kubernetes Deploy on Amazon EKS Deploy on Google GKE Deploy on Azure AKS

Embedding

Introduction Embedding SurrealDB in Rust Embedding SurrealDB in JavaScript Embedding SurrealDB in Python Embedding SurrealDB in .NET

Accessing

Introduction SDKs HTTP & Rest RPC Protocol CBOR Protocol

Reference Guides

Introduction Performance best practices Schema best practices Real-time and events Sample industry schemas Observability

FAQs

Introduction Known Issues

surrealdb/surrealdb

Copy page

Copy as Markdown Copy page content for LLMs

Open in ChatGPT Ask questions about this page

Open in Claude Ask questions about this page

Deployment

Getting started with SurrealDB is quick and easy. All of SurrealDB’s functionality for starting a server, and importing and exporting data, is enabled through the command-line tool, packaged and distributed as a single executable file, which can be downloaded, installed, or run from within Docker.

SurrealDB Cloud

Learn how to deploy a single-node instance of SurrealDB on SurrealDB Cloud .

Kubernetes

Learn how to deploy a multi-node instance of SurrealDB on Kubernetes.

Google EKS

Learn how to deploy a multi-node instance of SurrealDB on Google Cloud Platform.

Amazon EKS

Learn how to deploy a multi-node instance of SurrealDB on Amazon Web Services.

Azure AKS

Learn how to deploy a multi-node instance of SurrealDB on Microsoft Azure.

Best practices
Deploy on SurrealDB Cloud

Last updated: Loading...

Was this page helpful?

What did you like?

AccurateEasy to understandSolved my problemHelped me decide to use the productOther

What went wrong?

Hard to understandIncorrect informationMissing the informationOther

© SurrealDB 2026 • GitHub • Discord • Community • Cloud • Features • Releases • Install