Vai al contenuto
Verificata

Leggere e scrivere i dati dell'app

Leggi le righe di una tabella di Studio e aggiungine una, dall'esterno del runtime, con gli stessi due metodi che una app in esecuzione chiama da sé.

dbs_read e dbs_create sono le stesse due chiamate che un programma javascript o api fa a runtime tramite xu.dbs_read(...) e xu.dbs_create(...), raggiungibili direttamente con una chiave API dell'account, così il tuo backend può leggere e scrivere una tabella di Studio di un progetto senza passare affatto dal runtime. Vedi Framework JavaScript per il lato interno al progetto degli stessi metodi, e Piattaforma di sviluppo per il resto di data_module.

Trovare un table_id

table_id è l'_id del nodo tabella stesso, mai il suo nome visualizzato. get_progs con menu_type: "table" elenca ogni tabella di un progetto come coppie {_id, properties: {menuName}}, il modo più economico per trasformare un nome leggibile nell'id che questi due metodi richiedono.

Metodi

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.

Procedura

Leggi una pagina di righe

from/to è un intervallo di righe (from è l'offset, to - from è la dimensione della pagina) ed entrambi sono facoltativi: se li ometti ottieni la pagina predefinita della tabella. Anche tutti gli altri filtri (row_id, query, sortModel, archived) sono facoltativi.

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. Aggiungi una riga

table_data è un semplice oggetto con chiavi gli id dei campi della tabella, gli id di colonna che Studio ha assegnato quando la tabella è stata creata, non nomi generici. Se non sei sicuro di come si chiamino i campi di una data tabella, rileggi prima una riga con il passo 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'])

La risposta

dbs_read incapsula il risultato del plugin della tabella e vi aggiunge il conteggio totale della tabella:

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

Ogni riga è { id, value }: id è l'id di documento della riga stessa (ciò che si aspettano row_id in una chiamata successiva, oppure dbs_update/dbs_delete), value sono i dati dei campi con le stesse chiavi con cui è stato inviato table_data. total_rows conta questa pagina; total_table_count è l'intera tabella (solo righe attive, a meno che sia stato inviato archived: true), il numero che leggerebbe un controllo "Pagina 1 di N".

dbs_create risponde con la scrittura, non con la riga:

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

Rileggi la nuova riga con dbs_read (con row_id impostato su data.id) se ti serve il suo value salvato: questa chiamata non lo restituisce. Se invii un array come table_data invece di un solo oggetto, ogni elemento viene inserito come riga a sé in una sola chiamata, e in quel caso id/rev tornano per ogni riga invece che una volta sola.

Errori

Passi successivi