Value (JSON model)

The Kotlin SDK models all data — beyond the dedicated record types — using kotlinx.serialization JSON types. Read methods return a JsonElement; write methods accept a JsonObject.

Source: surrealdb.kotlin

import kotlinx.serialization.json.JsonElement
import kotlinx.serialization.json.buildJsonObject
import kotlinx.serialization.json.put

Building values

Construct objects with buildJsonObject.

val data = buildJsonObject {
    put("name", "Ada")
    put("age", 36)
}

Decoding values

Rather than navigating raw JsonElement trees, decode results into your own @Serializable types with .queryAs<T>(), .awaitAs<T>(), or .decode<T>().

val people: List<Person> = client.queryAs("SELECT * FROM person")

Learn more

• •

  Value types

• •

  Serialization