nb api resource

Menjalankan CRUD umum dan agregasi query pada resource NocoBase apapun. Nama resource dapat berupa resource biasa, misalnya users, atau resource asosiasi, misalnya posts.comments.

Penggunaan

nb api resource <command>

Subcommand

PerintahPenjelasan
nb api resource listMenampilkan daftar record resource
nb api resource getMengambil satu record resource
nb api resource createMembuat record resource
nb api resource updateMemperbarui record resource
nb api resource destroyMenghapus record resource
nb api resource queryMenjalankan agregasi query

Parameter Umum

ParameterTipePenjelasan
--api-base-urlstringAlamat API NocoBase, misalnya http://localhost:13000/api
--verbosebooleanMenampilkan progress detail
--env, -estringNama lingkungan
--yes, -ybooleanSaat --env yang diberikan secara eksplisit menargetkan env yang berbeda dari env saat ini, lewati konfirmasi interaktif
--rolestringOverride role, dikirim sebagai header X-Role
--token, -tstringOverride API key
--json-output, -j / --no-json-outputbooleanApakah menampilkan output JSON mentah, default aktif
--resourcestringNama resource, wajib diisi, misalnya users, orders, posts.comments
--data-sourcestringKey data source, default main

Perintah resource asosiasi juga dapat dikombinasikan dengan --source-id untuk menentukan ID record sumber.

Contoh

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

Jika Anda memberikan --env secara eksplisit dan nilainya berbeda dari env saat ini, CLI akan meminta konfirmasi terlebih dahulu. Pada terminal non-interaktif atau sesi AI agent, tambahkan --yes sendiri atau jalankan nb env use <name> terlebih dahulu lalu coba lagi.

Perintah Terkait