Installing the YDB SDK

Add dependencies to the Maven project as described in the "Install the SDK" step of the readme.md file in the source code repository.

Run the command from the command line:

python3 -m pip install ydb

If the command fails, make sure your environment has Python 3.8 or newer installed with the pip package manager enabled.

npm install @ydbjs/core @ydbjs/query

The minimum supported Node.js® version is 20.19.

Add to Cargo.toml last version of ydb crate.

Debian packages (Ubuntu 24.04)

Pre-built .deb packages for Ubuntu 24.04 (Noble), amd64 are attached to each GitHub release. Download and install them locally:

# Replace <TAG> with a release tag from GitHub releases
TAG=<TAG>
BASE="https://github.com/ydb-platform/ydb-cpp-sdk/releases/download/${TAG}"

wget "${BASE}/yandex-googleapis-api-common-protos-1.0.0-Linux.deb"
wget "${BASE}/libydb-cpp-dev_${TAG#v}_amd64.deb"
# Optional plugins:
wget "${BASE}/libydb-cpp-iam-dev_${TAG#v}_amd64.deb"
wget "${BASE}/libydb-cpp-otel-metrics-dev_${TAG#v}_amd64.deb"
wget "${BASE}/libydb-cpp-otel-tracing-dev_${TAG#v}_amd64.deb"

sudo apt-get update
sudo apt-get install -y \
    ./yandex-googleapis-api-common-protos-*.deb \
    ./libydb-cpp-dev_*.deb ./libydb-cpp-iam-dev_*.deb \
    ./libydb-cpp-otel-metrics-dev_*.deb ./libydb-cpp-otel-tracing-dev_*.deb

Available packages:

• yandex-googleapis-api-common-protos — required protobuf dependency;
• libydb-cpp-dev — core SDK: static library, public headers, and CMake package files;
• libydb-cpp-iam-dev — IAM credentials plugin (optional);
• libydb-cpp-otel-metrics-dev — OpenTelemetry metrics plugin (optional);
• libydb-cpp-otel-tracing-dev — OpenTelemetry tracing plugin (optional; requires libydb-cpp-otel-metrics-dev for OTel headers and libraries).

Using the SDK in CMake

After installing the packages, use the SDK in your CMake project:

find_package(ydb-cpp-sdk REQUIRED COMPONENTS Driver Table Topic)
target_link_libraries(myapp PRIVATE YDB-CPP-SDK::Driver YDB-CPP-SDK::Table)

Pass -DCMAKE_PREFIX_PATH=/usr/share/yandex when configuring your project, since the packages install under the Yandex prefix.

Build from source

Clone the ydb-cpp-sdk repository and run the following commands from the command line:

cmake --preset release-${compiler} -D YDB_SDK_INSTALL=On
cmake --build --preset default
cmake --install build --prefix ${ydb_install_dir}

• compiler — your compiler (clang or gcc);
• ydb_install_dir — the path where you want to install the SDK.

Make sure all dependencies are installed before running the commands. See the README in the source repository for the full list of build dependencies and instructions.