Java SDK

The SurrealDB SDK for Java enables simple and advanced querying of a remote or embedded database.

The SurrealDB SDK for Java lets you connect to SurrealDB from any Java application. It supports connecting to remote instances over WebSocket or HTTP, and running embedded databases in-process. The SDK provides methods for querying with SurrealQL, managing data, authentication, live queries, and transactions. It uses JNI to call native Rust code for high performance.

Note

The latest version of the SDK is java.
The SDK works with SurrealDB versions v2.0.0 to , ensuring compatibility with the latest version.

Getting started

Installation

Install the SDK using Gradle or Maven and import it into your project.

Quickstart

Connect to SurrealDB and perform your first queries in minutes.

Learn

Concepts

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

API Reference

Complete reference for all classes, methods, types, and errors.

Contributing

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

Getting started

Learn

Contributing

Sources