Kotlin SDK | SurrealDB

The SurrealDB SDK for Kotlin is a coroutine-based, Kotlin Multiplatform client for querying a remote SurrealDB instance.

The SurrealDB SDK for Kotlin lets you connect to SurrealDB from any Kotlin application. It is a Kotlin Multiplatform library targeting the JVM, Android, and iOS, with a coroutine-based, suspend-friendly API. The SDK connects to remote instances over WebSocket or HTTP and provides methods for querying with SurrealQL, managing data, authentication, live queries, transactions, and multiple sessions. Its design closely mirrors the JavaScript SDK.

Note

The Kotlin SDK is currently in early development. The latest version is 0.1.0-SNAPSHOT, and it is not yet published to Maven Central. The coordinates and APIs documented here are provisional and may change before the first stable release.

Getting started

Installation

Add the SDK to your project using Gradle or Maven and import it.

Quickstart

Connect to SurrealDB and run your first queries in minutes.

Learn

Concepts

Understand how to connect, authenticate, query, and work with data types.

API Reference

Complete reference for the client, builders, types, and errors.

Contributing

To contribute to the SDK code, submit an Issue or Pull Request in the surrealdb.kotlin repository. To contribute to this documentation, submit an Issue or Pull Request in the docs.surrealdb.com repository.

Sources

GitHub repository