Установка SDK

Добавьте зависимости в Maven-проект, как описано в пункте "Install the SDK" файла readme.md в репозитории исходного кода.

Выполните команду из командной строки:

python3 -m pip install ydb

Если команда не выполнилась успешно, убедитесь, что в вашем окружении установлен Python3 версии 3.8 или более новой, со включенным пакетным менеджером pip.

npm install @ydbjs/core @ydbjs/query

Минимальная поддерживаемая версия Node.js® не ниже 20.19.

Пакеты Debian (Ubuntu 24.04)

Готовые .deb-пакеты для Ubuntu 24.04 (Noble), amd64 прикреплены к каждому релизу на GitHub. Скачайте и установите их локально:

# Замените <TAG> на тег релиза со страницы 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"
# Дополнительные плагины:
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

Доступные пакеты:

• yandex-googleapis-api-common-protos — обязательная зависимость protobuf;
• libydb-cpp-dev — основной SDK: статическая библиотека, публичные заголовки и файлы CMake-пакета;
• libydb-cpp-iam-dev — плагин IAM-аутентификации (опционально);
• libydb-cpp-otel-metrics-dev — плагин метрик OpenTelemetry (опционально);
• libydb-cpp-otel-tracing-dev — плагин трассировки OpenTelemetry (опционально; для заголовков и библиотек OTel требуется libydb-cpp-otel-metrics-dev).

Использование SDK в CMake

После установки пакетов подключите SDK в CMake-проекте:

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

При конфигурации проекта передайте -DCMAKE_PREFIX_PATH=/usr/share/yandex, так как пакеты устанавливаются в префикс Yandex.

Сборка из исходного кода

Склонируйте репозиторий ydb-cpp-sdk и выполните команду из командной строки:

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

• compiler — ваш компилятор (clang или gcc);
• ydb_install_dir — путь, по которому вы хотите установить SDK.

Перед выполнением команды убедитесь, что все зависимости установлены. Полный список зависимостей для сборки и инструкции см. в README репозитория.