HeapTableRepo - CRUD API

Для чтения и записи данных в heap-таблицу следует использовать объект-репозиторий, который возвращается функцией Heap.Table. Ниже перечислены все доступные методы и свойства репозитория:

Методы чтения

• getById — возвращает heap-запись (или heap-объект) по переданному уникальному идентификатору. Бросает ошибку, если записи с таким идентификатором не существует.

  • findById — возвращает heap-объект по переданному уникальному идентификатору. В отличие от getById, в случае отсутствия записи возвращает null.
  • findByIds — возвращает массив heap-объектов по переданному списку уникальных идентификаторов.

• findAll — универсальный способ запросить объекты heap-таблицы. Возвращает либо все записи, либо с заданной фильтрацией, сортировкой и ограничениями количества (where, order, limit, offset).

  • findBy — "сокращённый" вариант findAll, поддерживет только фильтрацию.
  • findOneBy — возвращает только первую запись из отфильтрованного списка или null.

• countBy — возвращает количество записей, удовлетворяющих заданному фильтру.

Методы записи

• create — создаёт новую запись в таблице.
• update — изменяет/редактирует существующую запись в таблице по заданному
  • updateAll — массово изменяет/редактирует существующие записи в таблице по заданному идентификатору. Бросает ошибку, если такой записи не существует.
  • updateMaybe — изменяет/редактирует существующую запись в таблице по заданному идентификатору. В отличие от update, ничего не делает, если такой записи нет.
• createOrUpdateBy — создаёт новую либо изменяет существующую запись определяемую по значению заданного поля.
• delete — удаляет запись с заданным уникальным идентификатором.
  • deleteAll — массово удаляет записи с заданным уникальным идентификатором.

Другие методы

• isMyRecord — помогает определить, принадлежит ли переданная запись этой таблице.

Свойства

• type — строковой "тип" таблицы. Отличается от названия таблицы и служит идентификатором таблицы в пространстве аккаунта.

• schema — JSON-схема соответствующая структуре таблицы и используемая для её валидации. Обладает рядом дополнительных нестандартных свойств, помогающих анализировать мета-информацию таблицы.