Naar de inhoud springen
Geverifieerd

App-data opvragen en schrijven

Lees rijen uit een Studio-tabel en voeg er een toe, van buiten de runtime, met dezelfde twee methoden die een draaiende app zelf aanroept.

dbs_read en dbs_create zijn dezelfde twee aanroepen die een javascript- of api-programma tijdens de runtime doet via xu.dbs_read(...) en xu.dbs_create(...). Ze zijn direct bereikbaar met een API-sleutel van een account, zodat je eigen backend een Studio-tabel van een project kan lezen en beschrijven zonder helemaal door de runtime te gaan. Zie JavaScript Framework voor de kant binnen het project van dezelfde methoden en Development platform voor de rest van data_module.

Een table_id vinden

table_id is de eigen _id van het tabelknooppunt, nooit zijn weergavenaam. get_progs met menu_type: "table" toont elke tabel in een project als paren {_id, properties: {menuName}}: de goedkoopste manier om een naam die je kunt lezen om te zetten in de id die deze twee methoden nodig hebben.

Methoden

POST/cpi/dbs_read
user_access

DBS Read

Reads records from an app table with optional row range, single-row lookup, sorting, filtering, and archived-record selection.

POST/cpi/dbs_create
admin

DBS Create

Creates a new record in the specified app table from the provided key-value table data.

Stappenplan

Lees een pagina met rijen

from/to is een rijbereik (from is de offset, to - from is de paginagrootte), en beide zijn optioneel: laat je ze weg, dan krijg je de standaardpagina van de tabel. Alle andere filters (row_id, query, sortModel, archived) zijn ook optioneel.

curl -s https://xuda.ai/cpi/dbs_read \
  -H 'content-type: application/json' \
  -d '{"api_key":"YOUR_API_KEY","app_id":"YOUR_APP_ID","table_id":"YOUR_TABLE_ID","from":0,"to":50}'
const res = await fetch('https://xuda.ai/cpi/dbs_read', {
  method: 'POST',
  headers: { 'content-type': 'application/json' },
  body: JSON.stringify({
    api_key: 'YOUR_API_KEY',
    app_id: 'YOUR_APP_ID',
    table_id: 'YOUR_TABLE_ID',
    from: 0,
    to: 50,
  }),
});
const { code, data } = await res.json();
if (code > 0) for (const row of data.rows) console.log(row.id, row.value);
import requests

res = requests.post(
    'https://xuda.ai/cpi/dbs_read',
    json={'api_key': 'YOUR_API_KEY', 'app_id': 'YOUR_APP_ID', 'table_id': 'YOUR_TABLE_ID', 'from': 0, 'to': 50},
)
body = res.json()
if body['code'] > 0:
    for row in body['data']['rows']:
        print(row['id'], row['value'])

2. Voeg een rij toe

table_data is een gewoon object met de eigen veld-id's van de tabel als sleutels: de kolom-id's die Studio toekende toen de tabel werd gebouwd, geen algemene namen. Lees eerst een rij terug met stap 1 als je niet zeker weet hoe de velden van een bepaalde tabel heten.

curl -s https://xuda.ai/cpi/dbs_create \
  -H 'content-type: application/json' \
  -d '{
    "api_key": "YOUR_API_KEY",
    "app_id": "YOUR_APP_ID",
    "table_id": "YOUR_TABLE_ID",
    "table_data": { "CNT_Name": "Priya Shah", "CNT_Email": "[email protected]" }
  }'
const res = await fetch('https://xuda.ai/cpi/dbs_create', {
  method: 'POST',
  headers: { 'content-type': 'application/json' },
  body: JSON.stringify({
    api_key: 'YOUR_API_KEY',
    app_id: 'YOUR_APP_ID',
    table_id: 'YOUR_TABLE_ID',
    table_data: { CNT_Name: 'Priya Shah', CNT_Email: '[email protected]' },
  }),
});
const { code, data } = await res.json();
if (code > 0) console.log(data.id, data.rev);
import requests

res = requests.post(
    'https://xuda.ai/cpi/dbs_create',
    json={
        'api_key': 'YOUR_API_KEY',
        'app_id': 'YOUR_APP_ID',
        'table_id': 'YOUR_TABLE_ID',
        'table_data': {'CNT_Name': 'Priya Shah', 'CNT_Email': '[email protected]'},
    },
)
body = res.json()
if body['code'] > 0:
    print(body['data']['id'], body['data']['rev'])

Het antwoord

dbs_read verpakt het resultaat van de tabelplugin en voegt daar het eigen totaal van de tabel aan toe:

json
{
  "code": 1,
  "data": {
    "rows": [
      {
        "id": "dbs-392_tbl_a91f0e_7c2b9a11",
        "value": { "CNT_Name": "Priya Shah", "CNT_Email": "[email protected]" }
      }
    ],
    "total_rows": 1,
    "opt": { "...": "the query options this read actually ran, echoed back for reference" },
    "total_table_count": 42
  }
}

Elke rij is { id, value }: id is de eigen document-id van de rij (wat row_id bij een latere aanroep, of dbs_update/dbs_delete, verwacht), value is de veldgegevens met dezelfde sleutels als waarmee table_data werd verstuurd. total_rows telt deze pagina; total_table_count is de hele tabel (alleen actieve rijen, tenzij archived: true werd gestuurd), het getal dat een besturing "Pagina 1 van N" zou lezen.

dbs_create antwoordt met de schrijfactie, niet met de rij:

json
{
  "code": 1,
  "data": {
    "ok": true,
    "id": "dbs-392_tbl_a91f0e_7c2b9a11",
    "rev": "1-9f8e7d6c5b4a3f2e1d0c"
  }
}

Lees de nieuwe rij terug met dbs_read (row_id gezet op data.id) als je zijn opgeslagen value nodig hebt: deze aanroep geeft hem niet terug. Als je voor table_data een array stuurt in plaats van één object, wordt elk element als eigen rij ingevoegd in één aanroep. id/rev komen dan per rij terug in plaats van één keer.

Fouten

Volgende stap