Подключение к базе данных Yandex Managed Service for YDB из функции Cloud Functions на Node.js

Статья создана

Подготовьте облако к работе
- Необходимые платные ресурсы
Подготовьте окружение
Создайте сервисный аккаунт
Создайте базу данных YDB
Создайте таблицу в базе данных
Создайте функцию
Протестируйте функцию

В этом сценарии вы создадите функцию с приложением на Node.js, которое выполняет простой запрос к базе данных YDB. Развертывание приложения осуществляется с помощью Bash-скриптов, для компиляции используется команда tcs.

Функция с привязанным сервисным аккаунтом авторизуется в YDB через сервис метаданных.

Приложение создает драйвер подключения к базе YDB, сессию, транзакцию и выполняет запрос, используя библиотеку ydb. Эта библиотека устанавливается как зависимость при создании версии функции. Параметры подключения к базе данных передаются в приложение через переменные окружения.

Подготовьте облако к работе

Перед работой нужно зарегистрироваться в Yandex Cloud и создать платежный аккаунт:

Перейдите в консоль управления, затем войдите в Yandex Cloud или зарегистрируйтесь, если вы еще не зарегистрированы.
На странице биллинга убедитесь, что у вас подключен платежный аккаунт, и он находится в статусе ACTIVE или TRIAL_ACTIVE. Если платежного аккаунта нет, создайте его.

Если у вас есть активный платежный аккаунт, вы можете создать или выбрать каталог, в котором будет работать ваша инфраструктура, на странице облака.

Подробнее об облаках и каталогах.

Необходимые платные ресурсы

В стоимость поддержки инфраструктуры для этого сценария входит:

плата за использование функции (см. тарифы Yandex Cloud Functions);
плата за выполнение запросов к базе данных (см. тарифы Yandex Managed Service for YDB).

Подготовьте окружение

Клонируйте репозиторий examples с помощью Git.
Установите и инициализируйте следующие программы:
- интерфейс командной строки Yandex Cloud;
- jq;
- Node.js;
- npm и npx.
Установите зависимости, выполнив команду:
```
npm install
```

Создайте сервисный аккаунт

Консоль управления

В консоли управления выберите каталог, в котором хотите создать сервисный аккаунт.
Выберите вкладку Сервисные аккаунты.
Нажмите кнопку Создать сервисный аккаунт.
Введите имя сервисного аккаунта, например sa-function. Требования к имени:
- Длина — от 3 до 63 символов.
- Может содержать строчные буквы латинского алфавита, цифры и дефисы.
- Первый символ — буква. Последний символ — не дефис.
Нажмите Добавить роль и выберите editor.
Нажмите кнопку Создать.

Создайте базу данных YDB

Консоль управления

В консоли управления выберите каталог, в котором хотите создать базу данных.
В списке сервисов выберите Managed Service for YDB.
Нажмите кнопку Создать базу данных.
Введите имя базы. Требования к имени:
- Длина — от 3 до 63 символов.
- Может содержать строчные буквы латинского алфавита, цифры и дефисы.
- Первый символ — буква. Последний символ — не дефис.
В блоке Тип базы данных выберите опцию Serverless.
Нажмите кнопку Создать базу данных.

Дождитесь запуска базы данных. В процессе создания база будет иметь статус Provisioning. Когда база станет готова к использованию, статус сменится на Running.
Нажмите на имя созданной БД.
Сохраните значения следующих полей:
- Эндпоинт и База данных из блока YDB эндпоинт;
- Эндпоинт из блока Document API эндпоинт.
Они понадобятся на следующем шаге.

Создайте таблицу в базе данных

Консоль управления

В консоли управления выберите каталог, в котором находится база данных.
В списке сервисов выберите Managed Service for YDB.
Выберите базу данных.
Перейдите на вкладку Навигация.
В правом верхнем углу нажмите Создать. Затем в появившемся меню нажмите Таблицу.
В поле Имя укажите series. Остальные поля заполните произвольно.
Нажмите Создать таблицу.

Создайте функцию

Отредактируйте файл main.env:
- FUNCTION_NAME — имя функции.
- FOLDER_ID — идентификатор каталога.
- SERVICE_ACCOUNT_ID — идентификатор сервисного аккаунта.
- DOCUMENT_API_ENDPOINT — значение поля Эндпоинт из блока Document API эндпоинт.
- DATABASENAME — значение поля База данных из блока YDB эндпоинт.
- ENTRYPOINT — строка вида <протокол>://<значение поля Эндпоинт из блока YDB эндпоинт>. Например, если протокол grpcs, а эндпоинт ydb.serverless.yandexcloud.net:2135, введите grpcs://ydb.serverless.yandexcloud.net:2135.
- YDB_SDK_LOGLEVEL — уровень логирования. Возможные значения: fatal, error, warn, info, debug и trace.
Создайте функцию:
```
./first-setup-func.sh
```
Создайте версию функции:
```
./deploy.sh
```

Протестируйте функцию

Консоль управления

В консоли управления выберите каталог, в котором находится функция.
В списке сервисов выберите Cloud Functions.
Выберите функцию.
Перейдите на вкладку Обзор.
В блоке Общая информация нажмите на ссылку для вызова.

При успешном подключении к БД на странице появится описание полей таблицы series в формате JSON. Например:

{
  "driver": true,
  "tableDef": {
    "info": "Describe table  series",
    "columns": [
      {
        "name": "series_id",
        "type": 4
      },
      {
        "name": "title",
        "type": 4608
      },
      {
        "name": "series_info",
        "type": 4608
      },
      {
        "name": "release_date",
        "type": 48
      }
    ]
  }
}

Подключение к базе данных Yandex Managed Service for YDB из функции Cloud Functions на Node.js

Подготовьте облако к работе

Необходимые платные ресурсы

Подготовьте окружение

Создайте сервисный аккаунт

Создайте базу данных YDB

Создайте таблицу в базе данных

Создайте функцию

Протестируйте функцию

Была ли статья полезна?