• 简体中文

      • nb api resource

      对任意 NocoBase 资源执行通用 CRUD 和聚合查询。资源名可以是普通资源，例如 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-urlstringNocoBase API 地址，例如 http://localhost:13000/api
      --verboseboolean显示详细进度
      --env, -estring环境名称
      --yes, -yboolean当显式 --env 指向的 env 与当前 env 不一致时，跳过交互确认
      --rolestring角色覆盖，作为 X-Role 请求头发送
      --token, -tstringAPI key 覆盖
      --json-output, -j / --no-json-outputboolean是否输出原始 JSON，默认开启
      --resourcestring资源名称，必填，例如 users、orders、posts.comments
      --data-sourcestring数据源 key，默认 main

      关联资源命令还可以配合 --source-id 指定源记录 ID。

      只有在你显式传入 --env 时，CLI 才会检查它是否与当前 env 一致。如果显式指定了不同的 env，交互终端会先确认；在非交互终端或 AI agent 场景下，需要由你自己显式追加 --yes，或者先执行 nb env use <name> 再重试。

      示例

      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

      相关命令