• Русский

      • nb api resource

      Выполнение универсальных CRUD-операций и агрегатных запросов для любых ресурсов NocoBase. Имя ресурса может быть как обычным ресурсом, например users, так и связанным ресурсом, например posts.comments.

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

      nb api resource <command>

      Подкоманды

      КомандаОписание
      nb api resource listСписок записей ресурса
      nb api resource getПолучение одной записи ресурса
      nb api resource createСоздание записи ресурса
      nb api resource updateОбновление записи ресурса
      nb api resource destroyУдаление записи ресурса
      nb api resource queryВыполнение агрегатных запросов

      Общие параметры

      ПараметрТипОписание
      --api-base-urlstringАдрес API NocoBase, например http://localhost:13000/api
      --verbosebooleanПоказать подробный прогресс
      --env, -estringИмя окружения
      --yes, -ybooleanЕсли явно переданный --env указывает на env, отличающуюся от текущей env, пропускает интерактивное подтверждение
      --rolestringПереопределение роли, отправляется как HTTP-заголовок X-Role
      --token, -tstringПереопределение API key
      --json-output, -j / --no-json-outputbooleanВыводить ли исходный JSON, по умолчанию включено
      --resourcestringИмя ресурса, обязательно, например users, orders, posts.comments
      --data-sourcestringКлюч источника данных, по умолчанию main

      Команды связанных ресурсов также можно сочетать с --source-id для указания ID исходной записи.

      Примеры

      nb api resource list --resource users
nb api resource get --resource users --filter-by-tk 1
nb api resource create --resource users --values '{"nickname":"Ada"}'
nb api resource list --resource posts.comments --source-id 1 --fields id --fields content

      Если вы явно передаёте --env, и она отличается от текущей env, CLI сначала запросит подтверждение. В неинтерактивных терминалах или сессиях AI-агента добавьте --yes самостоятельно либо сначала выполните nb env use <name>, а затем повторите попытку.

      Связанные команды