Click here to sign up to SurrealDB Cloud
Back to top

Documentation

SurrealDB makes building and scaling realtime apps dramatically quicker and easier. Get started by installing the server , and jump into our getting started guide to learn how to insert and query data in SurrealDB in minutes.

To quickly test out SurrealDB and SurrealQL functionality, we've included demo dataset which you can download and import into your SurrealDB instance.

The current version of SurrealDB is ...

Introduction

Get started with SurrealDB - understand the core concepts, features, releases, and frequently asked questions.

Installation

Learn how to install SurrealDB, and get started with running a single-node database or distributed cluster.

Deployment

Learn how to deploy SurrealDB to different environments.

Security

Understand how to secure your application, using the different authentication levels available in SurrealDB.

Embedding

Learn how to embed and query SurrealDB from within a Rust, Node.js, JavaScript, or Python application.

Integration

View the documentation for connecting to and querying SurrealDB from different languages and frameworks.

SurrealQL

Learn about the SurrealQL data model, and how to define schemas, query the database, manipulate data, and run functions.

CLI tool

View the commands that can be run with the command-line tool, including starting a server, and importing and exporting data.

FAQs

View some of the frequently asked questions regarding SurrealDB, SurrealQL, and SurrealKV.

Libraries

Connect your application to your database with one of our official libraries. The following libraries are officially supported by SurrealDB. They are actively maintained, support new SurrealDB features, and receive bug fixes, performance enhancements, and security patches.

Server side libraries

Rust icon Rust Available

Nodejs icon Node.js Available

Golang icon Golang Available

Deno icon Deno Available

Python icon Python Available

C icon C Coming soon

Java icon Java Available

Dotnet icon .NET Available

Ruby icon Ruby Coming soon

Php icon PHP Coming soon

Swift icon Swift Coming soon

R icon R Coming soon

Dart icon Dart Coming soon

Erlang icon Erlang Coming soon

Client side libraries

Javascript icon JavaScript Available

Emberjs icon Ember.js Coming soon

Reactjs icon React.js Coming soon

Angular icon Angular Coming soon

Vuejs icon Vue.js Coming soon

Nextjs icon Next.js Coming soon

Nuxtjs icon Nuxt.js Coming soon

Nestjs icon Nest.js Coming soon

Svelte icon Svelte Coming soon

Flutter icon Flutter Coming soon