Sari la conținut
Verificat

Interoghează și scrie date de aplicație

Citește rânduri dintr-un tabel Studio și adaugă unul, din afara runtime-ului, cu aceleași două metode pe care le apelează o aplicație în execuție.

dbs_read și dbs_create sunt aceleași două apeluri pe care un program javascript sau api le face la runtime prin xu.dbs_read(...) și xu.dbs_create(...), accesibile direct cu o cheie API de cont, astfel încât propriul tău backend să poată citi și scrie un tabel Studio al unui proiect fără să treacă deloc prin runtime. Vezi JavaScript Framework pentru partea din interiorul proiectului a acelorași metode și Development platform pentru restul lui data_module.

Găsirea unui table_id

table_id este _id-ul propriu al nodului tabelului, niciodată numele afișat. get_progs cu menu_type: "table" listează fiecare tabel dintr-un proiect ca perechi {_id, properties: {menuName}}, cea mai ieftină cale de a asocia un nume pe care îl poți citi cu id-ul de care au nevoie aceste două metode.

Metode

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.

Parcurgere

Citește o pagină de rânduri

from/to este un interval de rânduri (from este decalajul, to - from este dimensiunea paginii), iar ambele sunt opționale, omite-le și primești pagina implicită a tabelului. Toate celelalte filtre (row_id, query, sortModel, archived) sunt de asemenea opționale.

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. Adaugă un rând

table_data este un obiect simplu având drept chei id-urile câmpurilor proprii ale tabelului, id-urile de coloană atribuite de Studio la construirea tabelului, nu nume generice. Citește mai întâi un rând cu pasul 1 dacă nu ești sigur cum se numesc câmpurile unui anumit tabel.

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

Răspunsul

dbs_read învelește rezultatul pluginului tabelului și adaugă deasupra numărul total propriu al tabelului:

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

Fiecare rând este { id, value }: id este id-ul documentului propriu al rândului (ce așteaptă row_id într-un apel ulterior sau dbs_update/dbs_delete), value este datele câmpurilor, cu aceleași chei cu care a fost trimis table_data. total_rows numără această pagină; total_table_count este întregul tabel (doar rândurile active, dacă nu s-a trimis archived: true), numărul pe care l-ar citi un control „Pagina 1 din N”.

dbs_create răspunde cu scrierea, nu cu rândul:

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

Citește rândul nou înapoi cu dbs_read (row_id setat la data.id) dacă ai nevoie de value-ul stocat, acest apel nu îl returnează. Dacă trimiți un șir pentru table_data în loc de un singur obiect, fiecare element este inserat ca rând propriu într-un singur apel, iar id/rev revin în acest caz pe fiecare rând, nu o singură dată.

Erori

Urmează