Index

A B C D E F G H I L M N O P Q R S T U V
All Classes and Interfaces|All Packages|Serialized Form

A

Array - Class in com.surrealdb

The Array class represents a native array structure and provides methods to interact with and retrieve values from the array.

authenticate(String) - Method in class com.surrealdb.Surreal

Authenticates the current connection with a JWT token (e.g.

B

BearerCredential - Class in com.surrealdb.signin

Credential that authenticates the session with an existing access token (e.g.

BearerCredential(String) - Constructor for class com.surrealdb.signin.BearerCredential

Creates a bearer credential with the given access token.

beginTransaction() - Method in class com.surrealdb.Surreal

Starts a client-side transaction.

C

cancel() - Method in class com.surrealdb.Transaction

Cancels (rolls back) the transaction.

close() - Method in class com.surrealdb.LiveStream

Releases the live query and stops receiving notifications.

close() - Method in class com.surrealdb.Surreal

Closes and releases any resources associated with this instance.

com.surrealdb - package com.surrealdb

com.surrealdb.signin - package com.surrealdb.signin

commit() - Method in class com.surrealdb.Transaction

Commits the transaction.

connect(String) - Method in class com.surrealdb.Surreal

Establishes a connection to the Surreal database using the provided connection string.

CONTENT - Enum constant in enum class com.surrealdb.UpType

Represents a content update operation.

create(RecordId, T) - Method in class com.surrealdb.Surreal

Creates a record in the database with the given `RecordID` as the key and the provided content as the value.

create(Class<T>, RecordId, T) - Method in class com.surrealdb.Surreal

Creates a record in the database with the given `RecordID` as the key and the provided content as the value.

create(Class<T>, String, T...) - Method in class com.surrealdb.Surreal

Creates records in the database with the given table and the provided contents as the values.

create(String, T...) - Method in class com.surrealdb.Surreal

Creates records in the database with the given table and the provided contents as the values.

createArray(Array) - Static method in class com.surrealdb.ValueMut

createArray(List<ValueMut>) - Static method in class com.surrealdb.ValueMut

createBigDecimal(BigDecimal) - Static method in class com.surrealdb.ValueMut

createBoolean(boolean) - Static method in class com.surrealdb.ValueMut

createDatetime(ZonedDateTime) - Static method in class com.surrealdb.ValueMut

createDouble(double) - Static method in class com.surrealdb.ValueMut

createDuration(Duration) - Static method in class com.surrealdb.ValueMut

createFile(String, String) - Static method in class com.surrealdb.ValueMut

createId(Id) - Static method in class com.surrealdb.ValueMut

createLong(long) - Static method in class com.surrealdb.ValueMut

createNone() - Static method in class com.surrealdb.ValueMut

createNull() - Static method in class com.surrealdb.ValueMut

createObject(Object) - Static method in class com.surrealdb.ValueMut

createObject(List<EntryMut>) - Static method in class com.surrealdb.ValueMut

createRecordId(RecordId) - Static method in class com.surrealdb.ValueMut

createString(String) - Static method in class com.surrealdb.ValueMut

createTable(String) - Static method in class com.surrealdb.ValueMut

createUuid(UUID) - Static method in class com.surrealdb.ValueMut

Credential - Interface in com.surrealdb.signin

Base type for all authentication credentials used with Surreal.signin(Credential).

D

DatabaseCredential - Class in com.surrealdb.signin

Database-level credentials for signing into a SurrealDB database.

DatabaseCredential(String, String, String, String) - Constructor for class com.surrealdb.signin.DatabaseCredential

delete(RecordId) - Method in class com.surrealdb.Surreal

Deletes a record identified by the provided RecordId.

delete(RecordId...) - Method in class com.surrealdb.Surreal

Deletes the specified records.

delete(RecordIdRange) - Method in class com.surrealdb.Surreal

Deletes all records in the given record ID range.

delete(String) - Method in class com.surrealdb.Surreal

Deletes the specified target.

E

Entry - Class in com.surrealdb

Entry represents a key-value pair entry in a native data structure.

EntryIterator - Class in com.surrealdb

EntryIterator is a specialized iterator for traversing entries.

EntryMut - Class in com.surrealdb

equals(Object) - Method in class com.surrealdb.InsertRelation

equals(Object) - Method in class com.surrealdb.Native

equals(Object) - Method in class com.surrealdb.Relation

export(String) - Method in class com.surrealdb.Surreal

Exports the database to a file.

F

FileRef - Class in com.surrealdb

Reference to a file stored in a SurrealDB bucket.

finalize() - Method in class com.surrealdb.Native

from(long) - Static method in class com.surrealdb.Id

from(String) - Static method in class com.surrealdb.Id

from(UUID) - Static method in class com.surrealdb.Id

G

Geometry - Class in com.surrealdb

get(int) - Method in class com.surrealdb.Array

get(Class<T>) - Method in class com.surrealdb.Value

get(String) - Method in class com.surrealdb.Object

getAccess() - Method in class com.surrealdb.signin.RecordCredential

getAccess() - Method in class com.surrealdb.signin.Token

Returns the access token (JWT) used for authenticating requests.

getAction() - Method in class com.surrealdb.LiveNotification

The action that caused this notification: "CREATE", "UPDATE", or "DELETE".

getArray() - Method in class com.surrealdb.Id

getArray() - Method in class com.surrealdb.Value

getBigDecimal() - Method in class com.surrealdb.Value

getBoolean() - Method in class com.surrealdb.Value

getBucket() - Method in class com.surrealdb.FileRef

Returns the bucket name.

getBytes() - Method in class com.surrealdb.Value

getDatabase() - Method in class com.surrealdb.NsDb

Returns the current database.

getDatabase() - Method in class com.surrealdb.signin.DatabaseCredential

getDatabase() - Method in class com.surrealdb.signin.RecordCredential

getDatabase() - Method in class com.surrealdb.Surreal

Returns the current database set by the last Surreal.useNs(String), Surreal.useDb(String), or Surreal.useDefaults() call (from the server response).

getDateTime() - Method in class com.surrealdb.Value

getDouble() - Method in class com.surrealdb.Value

getDuration() - Method in class com.surrealdb.Value

getEnd() - Method in class com.surrealdb.RecordIdRange

Upper bound (inclusive), or null if unbounded.

getFile() - Method in class com.surrealdb.Value

getGeometry() - Method in class com.surrealdb.Value

getId() - Method in class com.surrealdb.RecordId

getKey() - Method in class com.surrealdb.Entry

getKey() - Method in class com.surrealdb.FileRef

Returns the file key (path within the bucket).

getLong() - Method in class com.surrealdb.Id

getLong() - Method in class com.surrealdb.Value

getNamespace() - Method in class com.surrealdb.NsDb

Returns the current namespace.

getNamespace() - Method in class com.surrealdb.signin.NamespaceCredential

getNamespace() - Method in class com.surrealdb.signin.RecordCredential

getNamespace() - Method in class com.surrealdb.Surreal

Returns the current namespace set by the last Surreal.useNs(String), Surreal.useDb(String), or Surreal.useDefaults() call (from the server response).

getObject() - Method in class com.surrealdb.Id

getObject() - Method in class com.surrealdb.Value

getParams() - Method in class com.surrealdb.signin.RecordCredential

getPassword() - Method in class com.surrealdb.signin.RootCredential

getPoint() - Method in class com.surrealdb.Geometry

getQueryId() - Method in class com.surrealdb.LiveNotification

The live query UUID this notification belongs to.

getRangeEnd() - Method in class com.surrealdb.Value

End bound of the range (included or excluded), or empty if unbounded.

getRangeStart() - Method in class com.surrealdb.Value

Start bound of the range (included or excluded), or empty if unbounded.

getRecordId() - Method in class com.surrealdb.Value

getRefresh() - Method in class com.surrealdb.signin.Token

Returns the refresh token if the server provided one, otherwise null.

getStart() - Method in class com.surrealdb.RecordIdRange

Lower bound (inclusive), or null if unbounded.

getString() - Method in class com.surrealdb.Id

getString() - Method in class com.surrealdb.Value

getTable() - Method in class com.surrealdb.RecordId

getTable() - Method in class com.surrealdb.RecordIdRange

getTable() - Method in class com.surrealdb.Value

Table name when this value is a table type.

getToken() - Method in class com.surrealdb.signin.BearerCredential

Returns the access token.

getToken() - Method in class com.surrealdb.signin.Token

Returns the access token.

getUsername() - Method in class com.surrealdb.signin.RootCredential

getUuid() - Method in class com.surrealdb.Id

getUuid() - Method in class com.surrealdb.Value

getValue() - Method in class com.surrealdb.Entry

getValue() - Method in class com.surrealdb.LiveNotification

The record value (content) for this notification.

H

hashCode() - Method in class com.surrealdb.InsertRelation

hashCode() - Method in class com.surrealdb.Native

hashCode() - Method in class com.surrealdb.Relation

hasNext() - Method in class com.surrealdb.EntryIterator

hasNext() - Method in class com.surrealdb.ValueIterator

health() - Method in class com.surrealdb.Surreal

Performs a health check against the server.

I

id - Variable in class com.surrealdb.InsertRelation

id - Variable in class com.surrealdb.Relation

Id - Class in com.surrealdb

The Id class represents a unique identifier that can be either a long value or a string.

import_(String) - Method in class com.surrealdb.Surreal

Imports the database from a file.

in - Variable in class com.surrealdb.InsertRelation

in - Variable in class com.surrealdb.Relation

insert(Class<T>, String, T...) - Method in class com.surrealdb.Surreal

Insert records in the database with the given table and the provided contents as the values.

insert(String, T...) - Method in class com.surrealdb.Surreal

Insert records in the database with the given table and the provided contents as the values.

insertRelation(Class<T>, String, T) - Method in class com.surrealdb.Surreal

Inserts a relation of the specified type and table with the provided content.

insertRelation(String, T) - Method in class com.surrealdb.Surreal

Inserts a relation to the specified table using the provided content.

InsertRelation - Class in com.surrealdb

The InsertRelation class represents a relationship between entities in a graph database.

InsertRelation() - Constructor for class com.surrealdb.InsertRelation

InsertRelation(Id, RecordId, RecordId) - Constructor for class com.surrealdb.InsertRelation

insertRelations(Class<T>, String, T...) - Method in class com.surrealdb.Surreal

Inserts multiple relations of a specified type into the target.

insertRelations(String, T...) - Method in class com.surrealdb.Surreal

Inserts relations into the specified table with the provided contents.

invalidate() - Method in class com.surrealdb.Surreal

Invalidates the authentication for the current connection.

isArray() - Method in class com.surrealdb.Id

isArray() - Method in class com.surrealdb.Value

isBigDecimal() - Method in class com.surrealdb.Value

isBoolean() - Method in class com.surrealdb.Value

isBytes() - Method in class com.surrealdb.Value

isDateTime() - Method in class com.surrealdb.Value

isDouble() - Method in class com.surrealdb.Value

isDuration() - Method in class com.surrealdb.Value

isFile() - Method in class com.surrealdb.Value

isGeometry() - Method in class com.surrealdb.Value

isLong() - Method in class com.surrealdb.Id

isLong() - Method in class com.surrealdb.Value

isNone() - Method in class com.surrealdb.Value

isNull() - Method in class com.surrealdb.Value

isObject() - Method in class com.surrealdb.Id

isObject() - Method in class com.surrealdb.Value

isPoint() - Method in class com.surrealdb.Geometry

isRange() - Method in class com.surrealdb.Value

isRecordId() - Method in class com.surrealdb.Value

isString() - Method in class com.surrealdb.Id

isString() - Method in class com.surrealdb.Value

isTable() - Method in class com.surrealdb.Value

isUuid() - Method in class com.surrealdb.Id

isUuid() - Method in class com.surrealdb.Value

iterator() - Method in class com.surrealdb.Array

iterator() - Method in class com.surrealdb.Object

iterator(Class<T>) - Method in class com.surrealdb.Array

L

len() - Method in class com.surrealdb.Array

len() - Method in class com.surrealdb.Object

LiveNotification - Class in com.surrealdb

A single notification from a live query (CREATE, UPDATE, or DELETE).

LiveNotification(String, long, String) - Constructor for class com.surrealdb.LiveNotification

Called from native code only.

LiveStream - Class in com.surrealdb

Blocking iterator over live query notifications.

M

MERGE - Enum constant in enum class com.surrealdb.UpType

Represents a merge update operation.

N

NamespaceCredential - Class in com.surrealdb.signin

Namespace-level credentials for signing into a SurrealDB namespace.

NamespaceCredential(String, String, String) - Constructor for class com.surrealdb.signin.NamespaceCredential

Native - Class in com.surrealdb

Base for types backed by a native pointer.

newEntry(String, ValueMut) - Static method in class com.surrealdb.EntryMut

newSession() - Method in class com.surrealdb.Surreal

Creates a new session that shares the same connection but has its own namespace, database, and authentication state.

next() - Method in class com.surrealdb.EntryIterator

next() - Method in class com.surrealdb.LiveStream

Blocks until the next notification is available, or the stream ends.

next() - Method in class com.surrealdb.ValueIterator

NsDb - Class in com.surrealdb

Holds the current namespace and database after a Surreal.useNs(String), Surreal.useDb(String), or Surreal.useDefaults() call.

NsDb(String, String) - Constructor for class com.surrealdb.NsDb

Creates an NsDb with the given namespace and database (both may be null).

O

Object - Class in com.surrealdb

The Object class implements the Iterable interface for Entry objects.

out - Variable in class com.surrealdb.InsertRelation

out - Variable in class com.surrealdb.Relation

P

PATCH - Enum constant in enum class com.surrealdb.UpType

Represents a patch update operation.

Q

query(String) - Method in class com.surrealdb.Surreal

Executes a SurrealQL query on the database.

query(String) - Method in class com.surrealdb.Transaction

Runs a SurrealQL query within this transaction.

queryBind(String, Map<String, ?>) - Method in class com.surrealdb.Surreal

Executes a parameterized SurrealQL query on the database.

R

RecordCredential - Class in com.surrealdb.signin

Credentials for signing up or signing in as a record user (record access method).

RecordCredential(String, Object) - Constructor for class com.surrealdb.signin.RecordCredential

Creates record credentials using the current session namespace and database.

RecordCredential(String, String, String, Object) - Constructor for class com.surrealdb.signin.RecordCredential

Creates record credentials with explicit namespace and database.

RecordId - Class in com.surrealdb

The RecordId class represents a unique identifier for a record in a database.

RecordId(String, long) - Constructor for class com.surrealdb.RecordId

RecordId(String, Array) - Constructor for class com.surrealdb.RecordId

Creates a RecordId with an array key (e.g.

RecordId(String, Object) - Constructor for class com.surrealdb.RecordId

Creates a RecordId with an object key.

RecordId(String, String) - Constructor for class com.surrealdb.RecordId

RecordId(String, UUID) - Constructor for class com.surrealdb.RecordId

RecordIdRange - Class in com.surrealdb

Represents a range of record IDs on a table for range queries (e.g.

RecordIdRange(String, Id, Id) - Constructor for class com.surrealdb.RecordIdRange

Creates a range over the given table with optional start and end bounds.

relate(RecordId, String, RecordId) - Method in class com.surrealdb.Surreal

Establishes a relation between two records identified by `from` and `to` within a specified table.

relate(RecordId, String, RecordId, T) - Method in class com.surrealdb.Surreal

Establishes a relationship between two records within a specified table, attaching the provided content to this relationship.

relate(Class<R>, RecordId, String, RecordId, T) - Method in class com.surrealdb.Surreal

Establishes a relation between two records and retrieves it based on the specified relation type.

relate(Class<T>, RecordId, String, RecordId) - Method in class com.surrealdb.Surreal

Establishes and retrieves a relation of a specified type between two records.

Relation - Class in com.surrealdb

The Relation class represents a relationship between two records within a database.

Relation() - Constructor for class com.surrealdb.Relation

Relation(RecordId, RecordId, RecordId) - Constructor for class com.surrealdb.Relation

Response - Class in com.surrealdb

The Response class is a specialized wrapper for handling responses from SurrealDB.

RootCredential - Class in com.surrealdb.signin

Root-level credentials (username and password) for signing into SurrealDB.

RootCredential(String, String) - Constructor for class com.surrealdb.signin.RootCredential

run(String, Object...) - Method in class com.surrealdb.Surreal

Runs a SurrealDB function by name with the given arguments (e.g.

S

select(RecordId) - Method in class com.surrealdb.Surreal

Selects a record by its RecordId and retrieves the corresponding Value.

select(RecordId...) - Method in class com.surrealdb.Surreal

Selects values based on the provided RecordIds.

select(RecordIdRange) - Method in class com.surrealdb.Surreal

Selects all records in the given record ID range.

select(Class<T>, RecordId) - Method in class com.surrealdb.Surreal

Selects an instance of the specified type from a record identified by the given RecordId.

select(Class<T>, RecordId...) - Method in class com.surrealdb.Surreal

Selects and retrieves a list of objects of the specified type based on the given record IDs.

select(Class<T>, RecordIdRange) - Method in class com.surrealdb.Surreal

Selects records in the given range and maps them to the specified type.

select(Class<T>, String) - Method in class com.surrealdb.Surreal

Selects and retrieves an iterator of specified type for given targets.

select(String) - Method in class com.surrealdb.Surreal

Selects and returns an iterator over the values corresponding to the given targets.

selectLive(String) - Method in class com.surrealdb.Surreal

Starts a live query on the given table.

selectSync(Class<T>, String) - Method in class com.surrealdb.Surreal

Selects and returns a thread-safe iterator over a collection of objects of the specified type from the given targets.

selectSync(String) - Method in class com.surrealdb.Surreal

Selects and returns a thread-safe iterator to traverse values associated with the given targets.

signin(Credential) - Method in class com.surrealdb.Surreal

Signs in with the given credential.

Signin - Interface in com.surrealdb.signin

Deprecated.

Use Credential and Surreal.signin(Credential) instead.

signup(RecordCredential) - Method in class com.surrealdb.Surreal

Signs up a record user with the given record access credentials.

size() - Method in class com.surrealdb.Response

Surreal - Class in com.surrealdb

The Surreal class provides methods to interact with a Surreal database.

Surreal() - Constructor for class com.surrealdb.Surreal

Constructs a new Surreal object.

SurrealException - Exception Class in com.surrealdb

The SurrealException class is a custom RuntimeException used to signal exceptional conditions.

synchronizedIterator() - Method in class com.surrealdb.Array

synchronizedIterator() - Method in class com.surrealdb.Object

synchronizedIterator(Class<T>) - Method in class com.surrealdb.Array

T

take(int) - Method in class com.surrealdb.Response

take(Class<T>, int) - Method in class com.surrealdb.Response

Token - Class in com.surrealdb.signin

Authentication tokens returned by signin and signup.

Token(String) - Constructor for class com.surrealdb.signin.Token

Legacy constructor: single token string as access token, no refresh.

Token(String, String) - Constructor for class com.surrealdb.signin.Token

Creates a token with access and optional refresh token.

toString() - Method in class com.surrealdb.InsertRelation

toString() - Method in class com.surrealdb.Native

toString() - Method in class com.surrealdb.Relation

Transaction - Class in com.surrealdb

Client-side transaction.

U

update(RecordIdRange, UpType, T) - Method in class com.surrealdb.Surreal

Updates all records in the given record ID range with the given content.

update(RecordId, UpType, T) - Method in class com.surrealdb.Surreal

Updates the value of a record with the specified content and update type.

update(Class<T>, RecordId, UpType, T) - Method in class com.surrealdb.Surreal

Updates a record of the specified type and returns the updated record.

update(Class<T>, String[], UpType, T) - Method in class com.surrealdb.Surreal

Updates the specified tables with the given content and returns an iterator over the updated elements of the specified type.

update(Class<T>, String, UpType, T) - Method in class com.surrealdb.Surreal

Updates the specified table with the provided content and returns an iterator for the updated values.

update(String[], UpType, T) - Method in class com.surrealdb.Surreal

Updates the specified tables with the given content.

update(String, UpType, T) - Method in class com.surrealdb.Surreal

Updates the table with the given content based on the specified update type.

updateSync(Class<T>, String[], UpType, T) - Method in class com.surrealdb.Surreal

Updates the provided tables with the provided content and returns an iterator for the updated values.

updateSync(Class<T>, String, UpType, T) - Method in class com.surrealdb.Surreal

Updates the table with the provided content.

updateSync(String[], UpType, T) - Method in class com.surrealdb.Surreal

Updates the tables using the provided content and update type.

updateSync(String, UpType, T) - Method in class com.surrealdb.Surreal

Updates the specified table with the provided content.

upsert(RecordIdRange, UpType, T) - Method in class com.surrealdb.Surreal

Upserts all records in the given record ID range with the given content.

upsert(RecordId, UpType, T) - Method in class com.surrealdb.Surreal

Inserts a new record or updates an existing record with the given content.

upsert(Class<T>, RecordId, UpType, T) - Method in class com.surrealdb.Surreal

Upserts a record and returns the updated or inserted entity.

upsert(Class<T>, String[], UpType, T) - Method in class com.surrealdb.Surreal

Updates or inserts the provided content based on the specified tables and update type.

upsert(Class<T>, String, UpType, T) - Method in class com.surrealdb.Surreal

Inserts or updates a record of the specified type with the given content.

upsert(String[], UpType, T) - Method in class com.surrealdb.Surreal

Inserts or updates values in the given tables.

upsert(String, UpType, T) - Method in class com.surrealdb.Surreal

Performs an upsert operation on the specified table with the provided content.

upsertSync(Class<T>, String[], UpType, T) - Method in class com.surrealdb.Surreal

Performs an upsert operation with the specified content on the given tables.

upsertSync(Class<T>, String, UpType, T) - Method in class com.surrealdb.Surreal

Inserts or updates a record and returns an iterator over the result.

upsertSync(String[], UpType, T) - Method in class com.surrealdb.Surreal

Performs an upsert (update or insert) operation on the specified tables.

upsertSync(String, UpType, T) - Method in class com.surrealdb.Surreal

Inserts or updates the table with the provided content and returns a thread-safe iterator over the resulting values.

UpType - Enum Class in com.surrealdb

Enumeration to represent the type of update operations.

useDb(String) - Method in class com.surrealdb.Surreal

Sets the database for the current instance.

useDefaults() - Method in class com.surrealdb.Surreal

Sets the default namespace and database.

useNs(String) - Method in class com.surrealdb.Surreal

Sets the namespace for the Surreal instance.

V

Value - Class in com.surrealdb

The Value class represents a general-purpose wrapper for different types of values.

ValueIterator - Class in com.surrealdb

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.

ValueMut - Class in com.surrealdb

valueOf(String) - Static method in enum class com.surrealdb.UpType

Returns the enum constant of this class with the specified name.

values() - Static method in enum class com.surrealdb.UpType

Returns an array containing the constants of this enum class, in the order they are declared.

version() - Method in class com.surrealdb.Surreal

Returns the server version (semantic version string, e.g.

A B C D E F G H I L M N O P Q R S T U V
All Classes and Interfaces|All Packages|Serialized Form