Preskočiť na obsah
Overené

Dotazovať a zapisovať dáta aplikácie

Čítajte riadky z tabuľky Studio a pridávajte ich zvonka runtime, tými istými dvoma metódami, aké volá samotná bežiaca aplikácia.

dbs_read a dbs_create sú tie isté dve volania, aké program javascript alebo api robí za behu cez xu.dbs_read(...) a xu.dbs_create(...), dostupné priamo s API kľúčom účtu, takže váš vlastný backend môže čítať a zapisovať do tabuľky Studio projektu bez toho, aby prechádzal runtime. Stranu tých istých metód vo vnútri projektu nájdete v časti JavaScript Framework a zvyšok data_module v časti Development platform.

Ako nájsť table_id

table_id je vlastné _id uzla tabuľky, nikdy nie jej zobrazovaný názov. get_progs s menu_type: "table" vypíše každú tabuľku v projekte ako dvojice {_id, properties: {menuName}}, čo je najlacnejší spôsob, ako priradiť čitateľný názov k ID, ktoré tieto dve metódy potrebujú.

Methods

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.

Walkthrough

Read a page of rows

from/to je rozsah riadkov (from je posun, to - from je veľkosť stránky) a obe sú voliteľné, ak ich vynecháte, dostanete predvolenú stránku tabuľky. Každý ďalší filter (row_id, query, sortModel, archived) je tiež voliteľný.

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. Add a row

table_data je obyčajný objekt s kľúčmi podľa vlastných ID polí tabuľky, teda ID stĺpcov, ktoré Studio pridelilo pri zostavení tabuľky, nie všeobecných názvov. Ak si nie ste istí, ako sa polia danej tabuľky volajú, najprv si prečítajte riadok späť krokom 1.

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

The response

dbs_read obalí výsledok pluginu tabuľky a navrch pridá vlastný celkový počet tabuľky:

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

Každý riadok je { id, value }: id je vlastné ID dokumentu riadku (čo očakáva row_id v neskoršom volaní alebo dbs_update/dbs_delete), value sú dáta polí s rovnakými kľúčmi, aké sa poslali v table_data. total_rows počíta túto stránku; total_table_count je celá tabuľka (len aktívne riadky, ak sa neposlalo archived: true), číslo, ktoré by čítal ovládací prvok „Strana 1 z N“.

dbs_create odpovie zápisom, nie riadkom:

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

Ak potrebujete uloženú value, prečítajte nový riadok späť cez dbs_read (row_id nastavené na data.id), toto volanie ju nevracia. Poslanie poľa v table_data namiesto jedného objektu vloží každý prvok ako samostatný riadok jedným volaním, id/rev sa v tom prípade vrátia na každý riadok, nie raz.

Errors

Next