YDBDocument
Статья создана
Обновлена 26 февраля 2025 г.
Взаимодействие с документными таблицами в базе данных Yandex Managed Service for YDB. Поля get, put, update и scan — взаимоисключающие, можно использовать только одно из них.
| Имя поля | Тип | Обязательное | Значение по умолчанию | Поддерживается шаблонизация | Описание |
|---|---|---|---|---|---|
database |
string |
Да | Нет | Нет | Идентификатор базы данных. |
tableName |
string |
Да | Нет | Нет | Имя таблицы. |
get |
YdbDocumentGet | Нет | Нет | Нет | Конфигурация действия get — получение записи из таблицы. |
put |
YdbDocumentPut | Нет | Нет | Нет | Конфигурация действия put — добавление записи в таблицу. |
update |
YdbDocumentUpdate | Нет | Нет | Нет | Конфигурация действия update — обновление записи в таблице. |
scan |
YdbDocumentScan | Нет | Нет | Нет | Конфигурация действия scan — получение списка записей из таблицы. |
YdbDocumentGet
| Имя поля | Тип | Обязательное | Значение по умолчанию | Поддерживается шаблонизация | Описание |
|---|---|---|---|---|---|
key |
string |
Да | Нет | Да | Значение первичного ключа элемента в базе данных. |
YdbDocumentPut
| Имя поля | Тип | Обязательное | Значение по умолчанию | Поддерживается шаблонизация | Описание |
|---|---|---|---|---|---|
item |
string |
Да | Нет | Да | Элемент данных для добавления в таблицу, сериализованный в JSON-строку. |
YdbDocumentUpdate
| Имя поля | Тип | Обязательное | Значение по умолчанию | Поддерживается шаблонизация | Описание |
|---|---|---|---|---|---|
key |
string |
Да | Нет | Да | Значение первичного ключа элемента в базе данных. |
expression |
string |
Да | Нет | Да | Выражение, описывающее обновления атрибутов элемента в базе данных. Подробнее см. UpdateExpression. |
expressionAttributeValues |
string |
Нет | "" |
Да | Значения атрибутов, используемых в выражении. Подробнее см. ExpressionAttributeValues. |
YdbDocumentScan
| Имя поля | Тип | Обязательное | Значение по умолчанию | Поддерживается шаблонизация | Описание |
|---|---|---|---|---|---|
limit |
string |
Нет | Нет | Да | Максимальное количество элементов в списке. |
exclusive_start_key |
string |
Нет | Нет | Да | Значение первичного ключа элемента в базе данных, с которого начнется поиск. |