nb api resource list

指定したリソースのレコードを一覧表示します。--filter--fields--sort--page などのパラメータでクエリを制御できます。

使い方

nb api resource list --resource <resource> [flags]

パラメータ

パラメータ説明
--resourcestringリソース名(必須)
--data-sourcestringデータソース key。デフォルトは main です
--source-idstringリレーションリソースのソースレコード ID
--filterstringJSON オブジェクト形式のフィルタ条件
--fieldsstring[]クエリフィールド。複数回指定するか、JSON 配列で渡せます
--appendsstring[]追加で取得するリレーションフィールド。複数回指定するか、JSON 配列で渡せます
--exceptstring[]除外するフィールド。複数回指定するか、JSON 配列で渡せます
--sortstring[]ソートフィールド(例:-createdAt)。複数回指定するか、JSON 配列で渡せます
--pageintegerページ番号
--page-sizeinteger1 ページあたりの件数
--paginate / --no-paginatebooleanページネーションを行うかどうか

nb api resource の共通接続パラメータもサポートしています。

使用例

nb api resource list --resource users
nb api resource list --resource posts.comments --source-id 1 --fields id --fields content
nb api resource list --resource users --filter '{"status":"active"}' --sort=-createdAt

関連コマンド