Hopp til innholdet
Bekreftet

Spør og skriv appdata

Les rader fra en Studio-tabell, og legg til en, utenfra kjøretidsmiljøet, med de samme to metodene en kjørende app selv kaller.

dbs_read og dbs_create er de samme to kallene et javascript- eller api-program gjør under kjøring gjennom xu.dbs_read(...) og xu.dbs_create(...), nåbare direkte med en API-nøkkel på kontoen, slik at din egen backend kan lese og skrive et prosjekts Studio-tabell uten å gå via kjøretidsmiljøet i det hele tatt. Se JavaScript-rammeverk for siden i prosjektet av de samme metodene, og Utviklingsplattform for resten av data_module.

Finn en table_id

table_id er tabellnodens egen _id, aldri visningsnavnet. get_progs med menu_type: "table" lister hver tabell i et prosjekt som {_id, properties: {menuName}}-par, den billigste måten å koble et navn du kan lese til id-en disse to metodene trenger.

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.

Gjennomgang

Les en side med rader

from/to er et radområde (from er forskyvningen, to - from er sidestørrelsen), og begge er valgfrie: utelater du dem, får du 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. Legg til en rad

table_data er et vanlig objekt med tabellens egne felt-id-er som nøkler, kolonne-id-ene Studio ga da tabellen ble bygd, ikke generiske navn. Les en rad tilbake med trinn 1 først hvis du ikke er sikker på hva feltene i en gitt tabell heter.

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 inn tabellens plugin-resultat og legger tabellens egen totalsum på toppen:

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 rad er { id, value }: id er radens eget dokument-id (det row_id i et senere kall, eller dbs_update/dbs_delete, forventer), value er feltdataene med nøkler på samme måte som table_data ble sendt. total_rows teller denne siden, total_table_count er hele tabellen (bare aktive rader, med mindre archived: true ble sendt), tallet en «Side 1 av N»-kontroll ville lest.

dbs_create svarer med skrivingen, ikke raden:

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

Les den nye raden tilbake med dbs_read (row_id satt til data.id) hvis du trenger den lagrede value, dette kallet gjentar den ikke. Sender du en liste som table_data i stedet for ett objekt, settes hvert element inn som sin egen rad i ett kall, og id/rev kommer da tilbake per rad og ikke bare én gang.

Feil

Neste