Przejdź do treści
Zweryfikowano

Zapytaj o dane aplikacji i zapisz je

Odczytaj wiersze z tabeli Studio i dodaj jeden, spoza środowiska uruchomieniowego, tymi samymi dwiema metodami, które wywołuje działająca aplikacja.

dbs_read i dbs_create to te same dwa wywołania, które program javascript lub api wykonuje w czasie działania przez xu.dbs_read(...) i xu.dbs_create(...), osiągalne bezpośrednio kluczem API konta, żeby Twój własny backend mógł czytać i zapisywać tabelę Studio projektu w ogóle bez przechodzenia przez środowisko uruchomieniowe. Zobacz Framework JavaScript, żeby poznać stronę tych samych metod wewnątrz projektu, oraz Platforma programistyczna, żeby poznać resztę data_module.

Jak znaleźć table_id

table_id to własne _id węzła tabeli, nigdy jej nazwa wyświetlana. get_progs z menu_type: "table" wylistuje każdą tabelę w projekcie jako pary {_id, properties: {menuName}}, najtańszy sposób, żeby przełożyć czytelną nazwę na identyfikator, którego potrzebują te dwie metody.

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.

Krok po kroku

Odczytaj stronę wierszy

from/to to zakres wierszy (from to przesunięcie, to - from to rozmiar strony), a oba są opcjonalne: pomiń je, a dostaniesz domyślną stronę tabeli. Każdy inny filtr (row_id, query, sortModel, archived) też jest opcjonalny.

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. Dodaj wiersz

table_data to zwykły obiekt kluczowany własnymi identyfikatorami pól tabeli, identyfikatorami kolumn, które Studio przypisało przy budowaniu tabeli, a nie ogólnymi nazwami. Jeśli nie jesteś pewien, jak nazywają się pola danej tabeli, najpierw odczytaj wiersz krokiem 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'])

Odpowiedź

dbs_read opakowuje wynik wtyczki tabeli i dodaje na wierzchu łączną liczbę wierszy samej tabeli:

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żdy wiersz to { id, value }: id to własny identyfikator dokumentu wiersza (tego oczekuje row_id w późniejszym wywołaniu albo dbs_update/dbs_delete), value to dane pól kluczowane tak samo, jak wysłano table_data. total_rows zlicza tę stronę; total_table_count to cała tabela (tylko aktywne wiersze, chyba że wysłano archived: true), liczba, którą odczytałby element „Strona 1 z N".

dbs_create odpowiada zapisem, a nie wierszem:

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

Odczytaj nowy wiersz z powrotem przez dbs_read (row_id ustawione na data.id), jeśli potrzebujesz jego zapisanej wartości value, bo to wywołanie jej nie zwraca. Wysłanie tablicy w table_data zamiast jednego obiektu wstawia każdy element jako osobny wiersz w jednym wywołaniu, a id/rev wracają wtedy dla każdego wiersza, a nie raz.

Błędy

Dalej