All Classes and Interfaces
Class
Description
Detail kind constants for already-exists errors.
Duplicate resource (table, record, namespace, database, session).
The Array class represents a native array structure and provides methods to
interact with and retrieve values from the array.
Detail kind constants for authentication errors.
Credential that authenticates the session with an existing access token (e.g.
Detail kind constants for configuration errors.
Feature or configuration not supported (e.g.
Detail kind constants for connection errors.
Base type for all authentication credentials used with
Surreal.signin(Credential).Database-level credentials for signing into a SurrealDB database.
Entry represents a key-value pair entry in a native data structure.
EntryIterator is a specialized iterator for traversing entries.
Machine-readable error kind, aligned with the SurrealDB Rust SDK's
ErrorDetails enum.Reference to a file stored in a SurrealDB bucket.
The Id class represents a unique identifier that can be either a long value
or a string.
The InsertRelation class represents a relationship between entities in a
graph database.
Unexpected or unknown internal error.
A single notification from a live query (CREATE, UPDATE, or DELETE).
Blocking iterator over live query notifications.
Namespace-level credentials for signing into a SurrealDB namespace.
Base for types backed by a native pointer.
Detail kind constants for not-allowed errors.
Permission denied, method not allowed, function or scripting blocked.
Detail kind constants for not-found errors.
Resource not found (table, record, namespace, database, RPC method, session).
Holds the current namespace and database after a
Surreal.useNs(String), Surreal.useDb(String), or
Surreal.useDefaults() call.The Object class implements the Iterable interface for Entry objects.
Detail kind constants for query errors.
Query execution failure (not executed, timed out, cancelled).
Credentials for signing up or signing in as a record user (record access
method).
The RecordId class represents a unique identifier for a record in a database.
Represents a range of record IDs on a table for range queries (e.g.
The Relation class represents a relationship between two records within a
database.
The Response class is a specialized wrapper for handling responses from
SurrealDB.
Root-level credentials (username and password) for signing into SurrealDB.
Detail kind constants for serialization errors.
Serialization or deserialization error.
Base class for all exceptions originating from the SurrealDB server.
Deprecated.
The
Surreal class provides methods to interact with a Surreal
database.The SurrealException class is a custom RuntimeException used to signal
exceptional conditions.
User-thrown error (e.g.
Authentication tokens returned by signin and signup.
Client-side transaction.
Enumeration to represent the type of update operations.
Detail kind constants for validation errors.
Invalid input: parse error, invalid request or parameters, bad input values.
The Value class represents a general-purpose wrapper for different types of
values.
The ValueIterator class provides an iterator for the Value type, allowing
iteration over a collection of Value objects, typically used within the
context of array structures that extend the functionality provided by the
library.
CredentialandSurreal.signin(Credential)instead.