Доступ к данным¶

CRUD¶

model_accessor.count(type_name, filter[, options])¶

Вычисляет количество записей, соответствующих фильтру.

Параметры

• type_name (string) – тип объекта

• filter (table) – список условий-предикатов для выбора (фильтрации) объектов указанного типа

• options (table) – параметры для управления запросом

Результат

количество записей, соответствующих фильтру

Тип результата

number

model_accessor.find(type_name, filter, options, context)¶

Возвращает объекты, соответствующие заданным условиям. По умолчанию возвращаются первые 10 результатов. Пагинация осуществляется аналогично операциям программного интерфейса репозитория.

Параметры

• type_name (string) – тип объекта

• filter (table) – список условий-предикатов для выбора (фильтрации) объектов указанного типа

• options (table) –

  параметры для управления запросом. Доступные параметры:

  • first – количество элементов;

  • after – курсор пагинации на первый элемент;

  • version – версия объекта;

  • all_versions – указатель для поиска по всем версиям объекта, если задано значение true;

Результат

Тип результата

object

model_accessor.get(type_name, filter, options)¶

Получает кортеж по первичному ключу.

Параметры

• type_name (string) – тип объекта

• filter (table) – первичный ключ

• options (table) –

  параметры для управления запросом. Доступные параметры:

  • first – количество элементов;

  • after – курсор пагинации на первый элемент;

  • version – версия объекта;

  • all_versions – указатель для поиска по всем версиям объекта, если задано значение true;

Результат

кортеж

Тип результата

tuple

model_accessor.delete(type_name, filter, options)¶

Удаляет объекты, соответствующие заданным условиям.

Параметры

• type_name (string) – тип объекта

• filter (table) – список условий-предикатов для выбора (фильтрации) объектов указанного типа

• options (table) –

  параметры для управления запросом. Доступные параметры:

  • first – количество элементов для удаления;

  • after – курсор пагинации на первый элемент;

  • version – версия объекта для копирования в удаленное состояние;

  • only_if_version – проверка имеющейся версии перед вставкой;

  • all-versions – этот флаг для функции удаления (delete) нельзя использовать без флага permanent_delete;

  • permanent_delete – при установленном флаге (значение True) происходит физическое удаление информации об объекте из TDG. Используется вместе с флагом all-versions;

Результат

количество измененных строк

Тип результата

number

model_accessor.put(type_name, filter, options)¶

Вставляет новый или заменяет существующий объект, соответствующий заданным условиям.

Параметры

• type_name (string) – тип объекта

• filter (table) – список условий-предикатов для выбора (фильтрации) объектов указанного типа

• options (table) –

  параметры для управления запросом. Доступные параметры:

  • version – версия объекта;

  • only_if_version – проверка имеющейся версии перед вставкой;

Результат

количество измененных строк

Тип результата

number

model_accessor.update(type_name, filter, updaters, options)¶

Обновляет объекты, соответствующие заданным условиям.

Параметры

• type_name (string) – тип объекта

• filter (table) – список условий-предикатов для выбора (фильтрации) объектов указанного типа

• updaters (table) –

  список обновлений для объекта, состоящий из списка мутаторов {{mutator, path, new_value}, ...}, где:

  • mutator – имя мутатора, например:

    • set – устанавливает значение;

    • add – увеличивает значение на указанное число;

    • sub – уменьшает значение на указанное число;

  • path – строковый путь до поля объекта с точкой-разделителем (.). Путь до объекта(ов) массива должен включать индекс массива или символ * для захвата всех подобъектов;

  • new_value – новое значение;

• options (table) –

  параметры для управления запросом. Доступные параметры:

  • first – количество элементов для обновления;

  • after – курсор пагинации на первый элемент;

  • version – версия объекта;

  • only_if_version – проверка имеющейся версии перед вставкой;

  • dont_skip_deleted – использовать в поиске удаленные версии объектов;

Результат

количество измененных строк

Тип результата

number

Управление транзакциями¶

model_accessor.begin_transaction()¶

Начинает транзакцию. Аналог функции box.begin().

Результат

none

Тип результата

object

model_accessor.commit_transaction()¶

Завершает транзакцию и сохраняет все изменения. Аналог функции box.commit().

Результат

none

model_accessor.rollback_transaction()¶

Завершает транзакцию без сохранения изменений. Аналог функции box.rollback().

Результат

none

model_accessor.is_in_transaction()¶

Проверяет наличие активной транзакции. Аналог функции box.is_in_txn().

Результат

true при наличии активной транзакции, иначе – false

Тип результата

boolean

Утилиты¶

model_accessor.unflatten(type_name, tuple)¶

Преобразует плоский кортеж в Lua-таблицу.

Параметры

• type_name (string) – тип объекта

• tuple (table/tuple) – кортеж, который требуется преобразовать

Результат

Lua-таблица

Тип результата

table

model_accessor.is_read_only()¶

Возвращает значение параметра box.info.ro – true или false.

Результат

true, если экземпляр находится в режиме read-only или в статусе orphan, иначе false.

Тип результата

boolean

model_accessor.snapshot()¶

Создает снимок всех данных и сохраняет его. Аналог функции box.snapshot

Результат

результат выполнения операции – ok, если снимок создан успешно

Тип результата

string