nb api resource

Thực hiện CRUD và truy vấn tổng hợp trên bất kỳ tài nguyên NocoBase nào. Tên tài nguyên có thể là tài nguyên thường, ví dụ users, hoặc tài nguyên quan hệ, ví dụ posts.comments.

Cách dùng

nb api resource <command>

Lệnh con

LệnhMô tả
nb api resource listLiệt kê các bản ghi tài nguyên
nb api resource getLấy một bản ghi tài nguyên
nb api resource createTạo bản ghi tài nguyên
nb api resource updateCập nhật bản ghi tài nguyên
nb api resource destroyXóa bản ghi tài nguyên
nb api resource queryThực hiện truy vấn tổng hợp

Tham số chung

Tham sốKiểuMô tả
--api-base-urlstringĐịa chỉ API NocoBase, ví dụ http://localhost:13000/api
--verbosebooleanHiển thị tiến trình chi tiết
--env, -estringTên môi trường
--yes, -ybooleanKhi --env được truyền tường minh và trỏ tới env khác với env hiện tại, bỏ qua bước xác nhận tương tác
--rolestringGhi đè role, gửi đi qua header X-Role
--token, -tstringGhi đè API key
--json-output, -j / --no-json-outputbooleanCó output JSON gốc hay không, mặc định bật
--resourcestringTên tài nguyên, bắt buộc, ví dụ users, orders, posts.comments
--data-sourcestringKey của data source, mặc định main

Các lệnh tài nguyên quan hệ còn có thể kết hợp với --source-id để chỉ định ID bản ghi nguồn.

Ví dụ

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

Nếu bạn truyền --env một cách tường minh và nó khác env hiện tại, CLI sẽ yêu cầu xác nhận trước. Trong terminal không tương tác hoặc phiên AI agent, hãy tự thêm --yes hoặc chạy nb env use <name> trước rồi thử lại.

Lệnh liên quan