Start
Learn
Build
Manage
Explore
Reference
Sign In
Search the docs
Ctrl
K
Overview
Getting started
What is SurrealDB
Architecture
Concepts
Self-hosted
SurrealDB
Self-hosted
Installation
Linux
macOS
Windows
Nightly
In-memory
File-backed
Docker
Multi-node
Languages
SDK languages
.NET
.NET SDK
Installation
Quick start
Data Types
Embedding
Concepts
Create a new connection
Handle authentication
Set parameters
Data Manipulation
Realtime data streaming
Run SurrealQL queries
Connection Strings
Dependency Injection
Logging
Methods
Authenticate
Connect
Create
Delete
Export
Health
Import
Info
InsertRelation
Insert
Invalidate
Kill
ListenLive
LiveQuery
LiveRawQuery
LiveTable
Merge
Patch
Query
RawQuery
Relate
Run
Select
Set
SignIn
SignUp
Unset
Update
Upsert
Use
Version
Go
Go SDK
Installation
Quickstart
Embedding
Concepts
Connecting to SurrealDB
Authentication
Executing queries
Data manipulation
Live queries
Error handling
Value types
Multiple sessions
Transactions
Reliable connections
Query builder
API Reference
Core
DB
Session
Transaction
Values
RecordID
Table
UUID
CustomDateTime
CustomDuration
Geometry
Range
Errors
Types
Java
Java SDK
Installation
Quickstart
Concepts
Connecting to SurrealDB
Authentication
Executing queries
Data manipulation
Value types
Live queries
Transactions
Error handling
Multiple sessions
Embedded databases
Class converters
API Reference
Core
Surreal
Transaction
Response
LiveStream
Errors
Java Types
Data Types
RecordId
Value
Geometry
Datetime
Duration
Table
Range
FileRef
JavaScript
JavaScript SDK
JavaScript SDK
Start
Installation
Concepts
Connecting to SurrealDB
Authentication
Error handling
Executing queries
Live queries
Invoking APIs
Bound queries
Multiple sessions
Transactions
Embedded engines
Diagnostics
Value types
Utilities
Engines
Node.js
WebAssembly
Frameworks
React
SolidJS
Vue.js
API Reference
Core Classes
Surreal
SurrealSession
SurrealQueryable
SurrealTransaction
SurrealApi
Query Builders
SelectPromise
CreatePromise
UpdatePromise
InsertPromise
UpsertPromise
DeletePromise
RelatePromise
Query
LivePromise
RunPromise
ApiPromise
Data Types
RecordId
DateTime
Duration
Decimal
Uuid
Table
Geometry
FileRef
Range
Utilities
expr
surql
BoundQuery
equals
Escape Functions
Errors
TypeScript Types
PHP
PHP SDK
Getting started
Language Starter
Initialization
Authentication
Data Querying
Data Types
Methods
authenticate
close
connect
create
delete
export
health
import
info
insert
insertRelation
invalidate
let
merge
patch
query
queryRaw
run
select
signin
signup
status
unset
update
upsert
use
version
Python
Python SDK
Installation
Quickstart
Concepts
Connecting to SurrealDB
Authentication
Executing queries
Data manipulation
Value types
Live queries
Transactions
Error handling
Multiple sessions
Embedded databases
API Reference
Core
Surreal
SurrealSession
SurrealTransaction
Errors
Python Types
Values
RecordID
Table
Datetime
Duration
Range
Geometry
Rust
Rust SDK
Rust SDK
Quick start
Embedding
Concepts
Fetching linked records
Manual transactions
Flexible typing
Live queries
Authenticating users
Concurrency
Vector embeddings
Types after 3.0
Multi-tenancy in 3.0
Methods
authenticate
connect
create
delete
export
get
import
init
insert
invalidate
new
query
run
select_live
select
set
signin
signup
unset
update
upsert
use_ns and use_db
version
wait_for
Frameworks
Actix
Axum
Rocket
Egui
Frameworks
Languages
/
Python
/
API Reference
/
Core
Core
Copy page
Was this page helpful?
Yes
No
Edit page
Report an issue
