Ugrás a tartalomhoz
Ellenőrizve

Alkalmazásadatok lekérdezése és írása

Olvasson sorokat egy Studio táblából, és adjon hozzá egyet, a futtatókörnyezeten kívülről, ugyanazzal a két metódussal, amelyet egy futó alkalmazás maga is hív.

A dbs_read és a dbs_create ugyanaz a két hívás, amelyet egy javascript vagy api program futásidőben az xu.dbs_read(...) és xu.dbs_create(...) hívásokon keresztül végez, és fiók-API-kulccsal közvetlenül elérhető, így a saját háttérrendszere a futtatókörnyezet megkerülésével olvashatja és írhatja egy projekt Studio tábláját. Ugyanezen metódusok projekten belüli oldalát lásd a JavaScript Framework oldalon, a data_module többi részét pedig a Development platform oldalon.

A table_id megkeresése

A table_id a táblacsomópont saját _id értéke, soha nem a megjelenített neve. A get_progs a menu_type: "table" értékkel a projekt minden tábláját {_id, properties: {menuName}} párokként sorolja fel, ez a legolcsóbb módja annak, hogy az olvasható nevet leképezze arra az azonosítóra, amelyre e két metódusnak szüksége van.

Metódusok

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.

Végigvezető

Sorok egy oldalának olvasása

A from/to egy sortartomány (a from az eltolás, a to - from az oldalméret), mindkettő nem kötelező, ha kihagyja őket, a tábla alapértelmezett oldalát kapja. Minden más szűrő (row_id, query, sortModel, archived) szintén nem kötelező.

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. Sor hozzáadása

A table_data egyszerű objektum, amelyet a tábla saját mezőazonosítói kulcsolnak, azok az oszlopazonosítók, amelyeket a Studio a tábla építésekor rendelt hozzá, nem általános nevek. Ha nem biztos benne, hogyan hívják egy adott tábla mezőit, előbb olvasson vissza egy sort az 1. lépéssel.

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

A válasz

A dbs_read becsomagolja a tábla bővítményének eredményét, és hozzáadja a tábla saját teljes darabszámát:

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

Minden sor { id, value }: az id a sor saját dokumentumazonosítója (amit egy későbbi hívás row_id értéke, vagy a dbs_update/dbs_delete vár), a value a mezőadatok, ugyanúgy kulcsolva, ahogyan a table_data küldve lett. A total_rows ezt az oldalt számolja; a total_table_count az egész tábla (csak aktív sorok, hacsak nem archived: true lett küldve), az a szám, amelyet egy „1. oldal / N" vezérlő olvasna.

A dbs_create az írással válaszol, nem a sorral:

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

Ha szüksége van a tárolt value értékre, olvassa vissza az új sort a dbs_read hívással (a row_id értéke data.id), ez a hívás nem adja vissza. Ha a table_data értékeként egyetlen objektum helyett tömböt küld, minden elem külön sorként kerül be egy hívásban, ilyenkor az id/rev soronként jön vissza, nem egyszer.

Hibák

Következő