LiveQuerySubscription

LiveQuerySubscription is returned by .live(). It exposes a coroutine Flow of notifications and a method to stop the subscription. See Live queries for the concept.

Source: surrealdb.kotlin

Import

import com.surrealdb.kotlin.live.LiveQuerySubscription

Members

`id`

The server-assigned live query ID.

Type: String

`events`

A flow of SurrealLiveNotification events for this subscription.

**Type:** `Flow`

Example

subscription.events.collect { event ->
    println("${event.action}: ${event.result}")
}

`.cancel()`

Stops the subscription and kills the underlying live query on the server.

Method Syntax

subscription.cancel()

Returns: Unit

`SurrealLiveNotification`

The payload emitted on the events flow.

Import

import com.surrealdb.kotlin.model.SurrealLiveNotification

Field	Type	Description
`action`	`String`	The change kind: `"CREATE"` , `"UPDATE"` , or `"DELETE"` .
`liveQueryId`	`String`	The ID of the originating live query.
`result`	`JsonElement`	The changed record or diff.

Field

Type

Description

action

String

The change kind:

"CREATE"

"UPDATE"

, or

"DELETE"

liveQueryId

String

The ID of the originating live query.

result

JsonElement

The changed record or diff.

Learn more

Live queries
SurrealClient API reference for .live() and .kill()