Gå til indhold
Bekræftet

Forespørg og skriv app-data

Læs rækker fra en Studio-tabel, og tilføj en, udefra runtime, med de samme to metoder, en kørende app selv kalder.

dbs_read og dbs_create er de samme to kald, et javascript- eller api-program foretager under kørsel gennem xu.dbs_read(...) og xu.dbs_create(...), og de kan nås direkte med en konto-API-nøgle, så din egen backend kan læse og skrive et projekts Studio-tabel uden at gå gennem runtime overhovedet. Se JavaScript Framework for den side af de samme metoder, der ligger inde i projektet, og Udviklingsplatform for resten af data_module.

Sådan finder du et table_id

table_id er tabelnodens eget _id, aldrig dens visningsnavn. get_progs med menu_type: "table" lister alle tabeller i et projekt som {_id, properties: {menuName}}-par, den billigste måde at koble et navn, du kan læse, til det id, de to metoder skal bruge.

Metoder

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.

Gennemgang

Læs en side med rækker

from/to er et rækkeinterval (from er forskydningen, to - from er sidestørrelsen), og begge er valgfrie: udelad dem, og du får tabellens standardside. Alle andre filtre (row_id, query, sortModel, archived) er også valgfrie.

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. Tilføj en række

table_data er et almindeligt objekt med tabellens egne felt-id'er som nøgler, de kolonne-id'er, Studio tildelte, da tabellen blev bygget, ikke generiske navne. Læs først en række tilbage med trin 1, hvis du ikke er sikker på, hvad en given tabels felter hedder.

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'])

Svaret

dbs_read pakker tabellens plugin-resultat ind og lægger tabellens egen samlede optælling oveni:

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
  }
}

Hver række er { id, value }: id er rækkens eget dokument-id (det, row_id i et senere kald eller dbs_update/dbs_delete forventer), value er feltdataene med samme nøgler, som table_data blev sendt med. total_rows tæller denne side; total_table_count er hele tabellen (kun aktive rækker, medmindre archived: true blev sendt), det tal, en "Side 1 af N"-kontrol ville læse.

dbs_create svarer med skrivningen, ikke rækken:

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

Læs den nye række tilbage med dbs_read (row_id sat til data.id), hvis du har brug for dens gemte value, for dette kald giver den ikke tilbage. Hvis du sender et array som table_data i stedet for ét objekt, indsættes hvert element som sin egen række i ét kald, og id/rev kommer i så fald tilbage pr. række og ikke én gang.

Fejl

Næste