• Português

      • nb api resource

      Executa CRUD genérico e consultas de agregação em qualquer recurso do NocoBase. O nome do recurso pode ser um recurso comum, por exemplo users, ou um recurso relacionado, por exemplo posts.comments.

      Uso

      nb api resource <command>

      Subcomandos

      ComandoDescrição
      nb api resource listLista os registros do recurso
      nb api resource getObtém um único registro do recurso
      nb api resource createCria um registro no recurso
      nb api resource updateAtualiza um registro do recurso
      nb api resource destroyRemove um registro do recurso
      nb api resource queryExecuta uma consulta de agregação

      Parâmetros gerais

      ParâmetroTipoDescrição
      --api-base-urlstringEndereço da API do NocoBase, por exemplo http://localhost:13000/api
      --verbosebooleanExibe progresso detalhado
      --env, -estringNome do ambiente
      --yes, -ybooleanQuando --env é passado explicitamente e aponta para uma env diferente da env atual, pula a confirmação interativa
      --rolestringSobrescrita do papel, enviada no cabeçalho X-Role
      --token, -tstringSobrescrita da API key
      --json-output, -j / --no-json-outputbooleanDefine se a saída JSON crua será exibida; habilitado por padrão
      --resourcestringNome do recurso, obrigatório, por exemplo users, orders, posts.comments
      --data-sourcestringKey da fonte de dados, padrão main

      Comandos de recursos relacionados podem ser combinados com --source-id para indicar o ID do registro de origem.

      Exemplos

      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

      Se você passar --env explicitamente e ele for diferente da env atual, a CLI pedirá confirmação primeiro. Em terminais não interativos ou sessões de agentes de IA, adicione --yes manualmente ou execute primeiro nb env use <name> e tente novamente.

      Comandos relacionados