Přeskočit na obsah
Ověřeno

Dotazování na data aplikace a jejich zápis

Čtěte řádky tabulky Studia a přidejte jeden, mimo runtime, stejnými dvěma metodami, které volá běžící aplikace sama.

dbs_read a dbs_create jsou tytéž dvě volání, která program javascript nebo api provádí za běhu přes xu.dbs_read(...) a xu.dbs_create(...), dosažitelná přímo s klíčem API účtu, takže váš vlastní backend může číst a zapisovat tabulku Studia projektu, aniž by procházel runtimem. Stranu uvnitř projektu týchž metod najdete v části JavaScript Framework a zbytek data_module v části Vývojářská platforma.

Jak najít table_id

table_id je vlastní _id uzlu tabulky, nikdy její zobrazovaný název. get_progs s menu_type: "table" vypíše každou tabulku projektu jako dvojice {_id, properties: {menuName}}, což je nejlevnější způsob, jak převést čitelný název na ID, které tyto dvě metody potřebují.

Metody

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.

Postup

Přečíst stránku řádků

from/to je rozsah řádků (from je posun, to - from je velikost stránky) a obě jsou volitelné, vynechte je a dostanete výchozí stránku tabulky. Každý další filtr (row_id, query, sortModel, archived) je také volitelný.

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. Přidat řádek

table_data je prostý objekt s klíči podle vlastních ID polí tabulky, ID sloupců, která Studio přidělilo, když byla tabulka vytvořena, ne obecných názvů. Nejste-li si jisti, jak se pole dané tabulky jmenují, nejprve si přečtěte řádek krokem 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'])

Odpověď

dbs_read obalí výsledek pluginu tabulky a navrch přidá celkový počet tabulky:

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

Každý řádek je { id, value }: id je ID dokumentu řádku (to, co očekává row_id v pozdějším volání nebo dbs_update/dbs_delete), value jsou data polí s klíči stejně, jak byla odeslána v table_data. total_rows počítá tuto stránku; total_table_count je celá tabulka (jen aktivní řádky, pokud nebylo odesláno archived: true), číslo, které by četl ovladač „Stránka 1 z N“.

dbs_create odpovídá zápisem, ne řádkem:

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

Potřebujete-li uloženou value nového řádku, přečtěte ho zpět přes dbs_read (row_id nastavte na data.id), toto volání ji nevrací. Pošlete-li pro table_data místo jednoho objektu pole, vloží se každý prvek jako samostatný řádek jedním voláním a id/rev se v tom případě vrací po řádcích, ne jednou.

Chyby

Dále