The SurrealDB SDK for Java is the primary SDK for interacting with SurrealDB from client or server-side applications, systems, and APIs. You can use the Java SDK to interact with your SurrealDB database instances, or to run SurrealDB as an embedded database within your Java application, with functionality for executing queries, managing data, running database functions, and authenticating to the database. When connecting to remote database instances, connections automatically reconnect when terminated.
ImportantThe SDK requires Java JDK version
8or greater, and is available as a Maven package.
NoteThe SDK works seamlessly with SurrealDB versions
v2.0.0tov2.3.3, ensuring compatibility with the latest version.
WarningThis API is not yet fully stabilized and may be subject to change until the SDK reaches
1.0.0.
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.
You can find example repositories that demonstrate how to integrate SurrealDB in a number of different environments:
