Reference

Exhaustive material, organised for lookup rather than for reading through. Every SurrealQL statement, every built-in function, every protocol message and every SDK method is documented here. For the explanations behind them, see Learn.

Core

SurrealQL

Statements, functions, operators, data types and language primitives.

APIs and protocols

REST, HTTP, RPC, CBOR and Postgres wire protocols, and the shared error format.

CLI tools

Command reference for surrealctl, surreal and surqlfmt.

SDKs

Each SDK page covers installation, connecting, authentication and the full method list for that language.

Rust

JavaScript

Python

Go

.NET

Java

Kotlin

PHP

Swift

Mojo

Community SDKs cover further languages and runtimes, and the Expo and React Native guides cover mobile.

Markdown for agents

Every page in this section is also served as markdown: append .md to any path, or send Accept: text/markdown. The whole corpus is available at llms-full.txt, and the page index at llms.txt.