• 日本語

      • 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 と異なる場合、対話確認をスキップします
      --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 を指定することもできます。

      使用例

      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> を実行してから再試行してください。

      関連コマンド