• Deutsch

      • nb api resource

      Führt generisches CRUD und Aggregationsabfragen für beliebige NocoBase-Ressourcen aus. Der Ressourcenname kann eine gewöhnliche Ressource sein, z. B. users, oder eine assoziierte Ressource, z. B. posts.comments.

      Verwendung

      nb api resource <command>

      Unterbefehle

      BefehlBeschreibung
      nb api resource listDatensätze einer Ressource auflisten
      nb api resource getEinen einzelnen Datensatz abrufen
      nb api resource createDatensatz erstellen
      nb api resource updateDatensatz aktualisieren
      nb api resource destroyDatensatz löschen
      nb api resource queryAggregationsabfrage ausführen

      Allgemeine Parameter

      ParameterTypBeschreibung
      --api-base-urlstringNocoBase-API-Adresse, z. B. http://localhost:13000/api
      --verbosebooleanDetaillierten Fortschritt anzeigen
      --env, -estringUmgebungsname
      --yes, -ybooleanWenn ein explizit übergebenes --env auf eine andere env als die aktuelle env zeigt, die interaktive Bestätigung überspringen
      --rolestringRollen-Override, wird als X-Role-Header gesendet
      --token, -tstringAPI-key-Override
      --json-output, -j / --no-json-outputbooleanOb rohes JSON ausgegeben wird, standardmäßig aktiviert
      --resourcestringRessourcenname, erforderlich, z. B. users, orders, posts.comments
      --data-sourcestringkey der Datenquelle, Standard main

      Befehle für assoziierte Ressourcen können zusätzlich mit --source-id die Quell-Datensatz-ID angeben.

      Beispiele

      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

      Wenn Sie --env explizit übergeben und es sich von der aktuellen env unterscheidet, fragt die CLI zuerst nach einer Bestätigung. In nicht interaktiven Terminals oder AI-Agent-Sitzungen fügen Sie --yes selbst hinzu oder führen zuerst nb env use <name> aus und versuchen es dann erneut.

      Verwandte Befehle