• Español

      • nb api resource

      Ejecuta operaciones CRUD genéricas y consultas agregadas sobre cualquier recurso de NocoBase. El nombre del recurso puede ser un recurso simple, por ejemplo users, o un recurso asociado, por ejemplo posts.comments.

      Uso

      nb api resource <command>

      Subcomandos

      ComandoDescripción
      nb api resource listListar registros del recurso
      nb api resource getObtener un único registro del recurso
      nb api resource createCrear un registro en el recurso
      nb api resource updateActualizar registros del recurso
      nb api resource destroyEliminar registros del recurso
      nb api resource queryEjecutar consultas agregadas

      Parámetros generales

      ParámetroTipoDescripción
      --api-base-urlstringDirección de la API de NocoBase, por ejemplo http://localhost:13000/api
      --verbosebooleanMostrar el progreso detallado
      --env, -estringNombre del entorno
      --yes, -ybooleanCuando un --env pasado explícitamente apunta a una env distinta de la env actual, omite la confirmación interactiva
      --rolestringSobrescritura del rol; se envía como cabecera X-Role
      --token, -tstringSobrescritura de la API key
      --json-output, -j / --no-json-outputbooleanSi devolver JSON sin procesar; activado por defecto
      --resourcestringNombre del recurso; obligatorio, por ejemplo users, orders, posts.comments
      --data-sourcestringClave de la fuente de datos; por defecto main

      Los comandos sobre recursos asociados también pueden combinarse con --source-id para indicar el ID del registro origen.

      Ejemplos

      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

      Si pasa --env explícitamente y es diferente de la env actual, la CLI pedirá confirmación primero. En terminales no interactivos o sesiones de agentes de IA, agregue --yes usted mismo o ejecute antes nb env use <name> y vuelva a intentarlo.

      Comandos relacionados