Value

The Value class is the untyped representation of any SurrealDB value. It provides methods to check the underlying type and extract the value as a native Java type or SDK class. You can also convert a Value to a Java POJO using .get(Class<T>).

Source: surrealdb.java

Type Checking Methods

Each method returns true when the Value holds the corresponding SurrealDB type.

Getter Methods

Each getter extracts the underlying value. Call the corresponding type check method first to avoid unexpected results.

POJO Conversion

.get(type)

Converts the value to a Java POJO. The target class must have a public no-argument constructor. Fields are matched by name between the SurrealDB object and the Java class.

<T> T get(Class<T> type)

Returns: T

public class Person {
    public RecordId id;
    public String name;
    public long age;
}

Response response = db.query("SELECT * FROM person:tobie");
Value value = response.take(0);
Person person = value.get(Person.class);

Array

The Array class represents a SurrealDB array value. It implements Iterable<Value> and provides both untyped and typed iteration.

Methods

.get(idx)

Returns the value at the specified index.

array.get(idx)

Returns: Value

.len()

Returns the number of elements in the array.

array.len()

Returns: int

.iterator()

Returns an iterator over the array elements as Value instances.

array.iterator()

Returns: Iterator<Value>

.iterator(clazz)

Returns a typed iterator that deserializes each element into the specified class.

array.iterator(clazz)

Returns: Iterator<T>

.synchronizedIterator()

Returns a thread-safe iterator over the array elements.

array.synchronizedIterator()

Returns: Iterator<Value>

.synchronizedIterator(clazz)

Returns a thread-safe typed iterator that deserializes each element into the specified class.

array.synchronizedIterator(clazz)

Returns: Iterator<T>

Response response = db.query("SELECT * FROM person");
Value result = response.take(0);
Array array = result.getArray();

for (Value item : array) {
    String name = item.getObject().get("name").getString();
}

Iterator<Person> people = array.iterator(Person.class);
while (people.hasNext()) {
    Person person = people.next();
}

Object

The Object class represents a SurrealDB object value. It implements Iterable<Entry> and provides key-based access to its fields.

Methods

.get(key)

Returns the value associated with the specified key.

object.get(key)

Returns: Value

.len()

Returns the number of key-value pairs in the object.

object.len()

Returns: int

.iterator()

Returns an iterator over the object's key-value pairs as Entry instances.

object.iterator()

Returns: Iterator<Entry>

.synchronizedIterator()

Returns a thread-safe iterator over the object's key-value pairs.

object.synchronizedIterator()

Returns: Iterator<Entry>

Response response = db.query("SELECT * FROM person:tobie");
Value result = response.take(0);
Object obj = result.getObject();

Value name = obj.get("name");
int fieldCount = obj.len();

for (Entry entry : obj) {
    String key = entry.getKey();
    Value value = entry.getValue();
}

Entry

The Entry class represents a key-value pair in a SurrealDB object.

Methods

.getKey()

Returns the field name of this entry.

entry.getKey()

Returns: String

.getValue()

Returns the value of this entry.

entry.getValue()

Returns: Value

See Also

• Value types — Type mapping overview

• RecordId — Record identifiers

• SurrealQL data model — SurrealDB data types and structures