Siirry sisältöön
Tarkistettu

Kysele ja kirjoita sovellusdataa

Lue rivejä Studio-taulukosta ja lisää yksi suorituksen ulkopuolelta samoilla kahdella metodilla, joita käynnissä oleva sovellus itse kutsuu.

dbs_read ja dbs_create ovat samat kaksi kutsua, joita javascript- tai api-ohjelma tekee suorituksen aikana kutsuilla xu.dbs_read(...) ja xu.dbs_create(...). Ne ovat tavoitettavissa suoraan tilin API-avaimella, jotta oma taustajärjestelmäsi voi lukea ja kirjoittaa projektin Studio-taulukkoa kulkematta suorituksen läpi lainkaan. Katso JavaScript Framework, miten samat metodit näkyvät projektin sisällä, ja Kehitysalusta data_module:n loppuosalle.

table_id:n löytäminen

table_id on taulukkosolmun oma _id, ei koskaan sen näyttönimi. get_progs arvolla menu_type: "table" listaa jokaisen projektin taulukon {_id, properties: {menuName}}-pareina, halvin tapa yhdistää lukemasi nimi tunnukseen, jota nämä kaksi metodia tarvitsevat.

Metodit

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.

Läpikäynti

Lue sivu rivejä

from/to on rivialue (from on siirtymä, to - from on sivun koko), ja molemmat ovat valinnaisia: jätä ne pois, niin saat taulukon oletussivun. Kaikki muut suodattimet (row_id, query, sortModel, archived) ovat myös valinnaisia.

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. Lisää rivi

table_data on tavallinen objekti, jonka avaimet ovat taulukon omat kenttätunnukset, sarakkeiden tunnukset, jotka Studio antoi taulukkoa rakennettaessa, ei yleisiä nimiä. Lue ensin rivi takaisin vaiheella 1, jos et ole varma, mitä tietyn taulukon kenttiä kutsutaan.

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

Vastaus

dbs_read kietoo taulukon lisäosan tuloksen ja lisää sen päälle taulukon oman kokonaismäärän:

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

Jokainen rivi on { id, value }: id on rivin oma dokumenttitunnus (sitä myöhempi row_id tai dbs_update/dbs_delete odottaa), value on kenttädata samoilla avaimilla kuin table_data lähetettiin. total_rows laskee tämän sivun; total_table_count on koko taulukko (vain aktiiviset rivit, ellei archived: true lähetetty), luku, jonka "Sivu 1 / N" -ohjain lukisi.

dbs_create vastaa kirjoituksella, ei rivillä:

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

Lue uusi rivi takaisin dbs_read:lla (row_id asetettuna arvoon data.id), jos tarvitset sen tallennetun value:n, sillä tämä kutsu ei kaiuta sitä. Jos lähetät table_data:ksi objektin sijaan taulukon, jokainen alkio lisätään omana rivinään yhdellä kutsulla, ja id/rev palaavat tällöin rivikohtaisesti eikä kerran.

Virheet

Seuraavaksi