Hoppa till innehållet
Verifierad

Fråga och skriv appdata

Läs rader från en Studio-tabell, och lägg till en, utanför körmiljön, med samma två metoder som en körande app själv anropar.

dbs_read och dbs_create är samma två anrop som ett javascript- eller api-program gör under körning genom xu.dbs_read(...) och xu.dbs_create(...), nåbara direkt med en API-nyckel för kontot så att din egen backend kan läsa och skriva ett projekts Studio-tabell utan att gå via körmiljön alls. Se JavaScript Framework för sidan inuti projektet av samma metoder, och Utvecklingsplattform för resten av data_module.

Hitta ett table_id

table_id är tabellnodens eget _id, aldrig dess visningsnamn. get_progs med menu_type: "table" listar varje tabell i ett projekt som par av {_id, properties: {menuName}}, det billigaste sättet att koppla ett namn du kan läsa till det id som de här två metoderna behöver.

Metoder

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.

Genomgång

Läs en sida med rader

from/to är ett radintervall (from är förskjutningen, to - from är sidstorleken), och båda är valfria, utelämna dem så får du tabellens standardsida. Alla andra filter (row_id, query, sortModel, archived) är också valfria.

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. Lägg till en rad

table_data är ett vanligt objekt med tabellens egna fält-id som nycklar, de kolumn-id som Studio tilldelade när tabellen byggdes, inte generiska namn. Läs tillbaka en rad med steg 1 först om du inte är säker på vad en viss tabells fält heter.

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

Svaret

dbs_read omsluter tabellens pluginresultat och lägger till tabellens eget totala antal ovanpå:

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

Varje rad är { id, value }: id är radens eget dokument-id (det som row_id i ett senare anrop, eller dbs_update/dbs_delete, förväntar sig), value är fältdatan med samma nycklar som table_data skickades med. total_rows räknar den här sidan; total_table_count är hela tabellen (bara aktiva rader, om inte archived: true skickades), det tal som en kontroll av typen "Sida 1 av N" skulle läsa.

dbs_create svarar med skrivningen, inte raden:

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

Läs tillbaka den nya raden med dbs_read (row_id satt till data.id) om du behöver dess sparade value, det här anropet ekar den inte. Om du skickar en array för table_data i stället för ett objekt läggs varje element in som en egen rad i ett anrop, och då kommer id/rev tillbaka per rad i stället för en gång.

Fel

Nästa