surrealdb-driver/uk.gibby.driver/Surreal

Surreal

class Surreal(host: String, port: Int = 8000)

SurrealDB driver

The entry point for connection to SurrealDB.

Parameters

host

SurrealDB host (e.g. localhost)

port

SurrealDB port

Constructors

Surreal

constructor(host: String, port: Int = 8000)

Functions

authenticate

suspend fun Surreal.authenticate(token: String)

Authenticate

connect

suspend fun connect()

Connects to SurrealDB and removes the existing connection if one exists.

create

fun Surreal.create(table: String): CreateBuilder

fun Surreal.create(table: String, id: String): CreateIdBuilder

Create

delete

suspend fun Surreal.delete(table: String)

suspend fun Surreal.delete(id: Thing<*>)

suspend fun Surreal.delete(table: String, id: String)

Delete

info

inline suspend fun <T> Surreal.info(): T

Info

infoAsJson

@JvmName(name = "JsonInfo")

suspend fun Surreal.infoAsJson(): JsonElement

Info

insert

fun Surreal.insert(table: String): InsertBuilder

invalidate

suspend fun Surreal.invalidate()

Invalidate

kill

suspend fun Surreal.kill(liveQueryId: String)

Kill

let

inline suspend fun <T> Surreal.let(name: String, value: T)

@JvmName(name = "letJson")

suspend fun Surreal.let(name: String, value: JsonElement)

Let

live

suspend fun Surreal.live(table: String): String

Live

observeLiveQuery

inline suspend fun <T> Surreal.observeLiveQuery(table: String): LiveQueryFlow<T>

Observe live query

observeLiveQueryAsJson

@JvmName(name = "observeJson")

suspend fun Surreal.observeLiveQueryAsJson(table: String): LiveQueryFlow<JsonElement>

Observe live query as json

query

suspend fun Surreal.query(queryText: String, vararg bindings: Bind): List<QueryResponse>

suspend fun Surreal.query(queryText: String, bindings: List<Bind>): List<QueryResponse>

Query

select

inline suspend fun <T> Surreal.select(table: String): List<T>

inline suspend fun <T> Surreal.select(id: Thing<T>): T

inline suspend fun <T> Surreal.select(table: String, id: String): T

Select

selectAsJson

suspend fun Surreal.selectAsJson(table: String): JsonArray

suspend fun Surreal.selectAsJson(id: Thing<*>): JsonObject

suspend fun Surreal.selectAsJson(table: String, id: String): JsonObject

Select

signin

suspend fun Surreal.signin(user: String, pass: String)

suspend fun Surreal.signin(ns: String, db: String, scope: String, vararg params: Bind): String

suspend fun Surreal.signin(ns: String, db: String, scope: String, params: List<Bind>): String

Signin

signup

suspend fun Surreal.signup(ns: String, db: String, scope: String, vararg params: Bind): String

suspend fun Surreal.signup(ns: String, db: String, scope: String, params: List<Bind>): String

Signup

inline fun <T> subscribe(liveQueryId: String): Flow<LiveQueryAction<T>>

subscribeAsJson

fun subscribeAsJson(liveQueryId: String): Flow<LiveQueryAction<JsonElement>>

unset

suspend fun Surreal.unset(name: String)

Unset

unsubscribe

fun unsubscribe(liveQueryId: String)

update

fun Surreal.update(table: String): UpdateBuilder

fun Surreal.update(id: Thing<*>): UpdateIdBuilder

fun Surreal.update(table: String, id: String): UpdateIdBuilder

Update

use

suspend fun Surreal.use(ns: String, db: String)

Use