This repository is deprecated.

The actual repository is available here https://github.com/ydb-platform/ydb-java-sdk, you can use the Migration Guide to update

Java SDK for Yandex Database (YDB)

The Java SDK for YDB enables Java developers to work with Yandex Database.

• Yandex Database Documentation
• YDB SDK Documentation

Getting Started

Connection setup

Before you begin, you need to create a database and setup authorization. Please see the Prerequisites section of the connection guide in documentation for information on how to do that.

Minimum requirements

To use YDB Java SDK you will need Java 1.8+.

Install the SDK

The recommended way to use the YDB Java SDK in your project is to consume it from Maven. Specify the SDK Maven modules that your project needs in the dependencies:

<dependencies>
    <dependency>
        <groupId>com.yandex.ydb</groupId>
        <artifactId>ydb-sdk-core</artifactId>
        <version>1.14.12</version>
    </dependency>
    <dependency>
        <groupId>com.yandex.ydb</groupId>
        <artifactId>ydb-sdk-table</artifactId>
        <version>1.14.12</version>
    </dependency>
    <dependency>
        <groupId>com.yandex.ydb</groupId>
        <artifactId>ydb-sdk-auth-iam</artifactId>
        <version>1.14.12</version>
    </dependency>
</dependencies>

Examples

Using Maven

In examples/basic_example folder there is simple example application that uses YDB Java SDK from Maven. See the Connect to a database section of the documentation for an instruction on how to setup and launch it.

Generic examples

In examples folder you can find more example applications with YDB Java SDK usage.