SurrealDB Docs Logo

Enter a search query

SurrealDB
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.

Getting Started

To start using SurrealDB with its SDKs, first install the appropriate SDK for your programming language, then initialize a connection to your SurrealDB instance using the provided connection methods and authentication credentials.

Icon

Icon

Icon

Icon

Icon

Icon

Icon

Icon

Icon

Icon

Client Libraries

RustRust

available

A native async-friendly SDK for Rust with bi-directional, binary communication over WebSocket or HTTP, and support for SurrealDB embedded in-memory and on-disk.

JavaScriptJavaScript

available

A native SDK for JavaScript with bi-directional, binary communication over WebSockets or HTTP, and support for SurrealDB embedded in-memory and on-disk using SurrealKV.

TypeScriptTypeScript

available

Full support for TypeScript definitions from within the JavaScript SDK, for working with strongly-typed data with both locally embedded and remote databases.

Node.jsNode.js

available

A native Node.js engine for use with the JavaScript SDK in server-side environments, enabling in-memory or on-disk deployments using SurrealKV.

WebAssemblyWebAssembly

available

A native WebAssembly engine for use with the JavaScript SDK for web browsers, enabling in-memory or persisted deployments using IndexedDB.

JavaJava

available

An SDK for Java with binary communication over WebSocket or HTTP, and support for SurrealDB embedded in-memory and on-disk using SurrealKV.

GolangGolang

available

An SDK for Golang with binary communication over WebSocket or HTTP, and support for SurrealDB embedded in-memory and on-disk using SurrealKV.

PythonPython

coming soon

An SDK for sync or async Python, with binary communication over WebSocket or HTTP, and support for SurrealDB embedded in-memory and on-disk using SurrealKV.

.NET.NET

available

A native SDK for .NET with bi-directional, binary communication over WebSockets or HTTP.

PHPPHP

available

A native SDK for PHP with bi-directional, binary communication over WebSockets or HTTP.

© SurrealDB GitHub Discord Community Cloud Features Releases Install