Sari la conținut
Verificat

Interogarea datelor prin API

Referința completă data_module, formele de filtrare și sortare ale lui dbs_read și ce comută de fapt dbs_delete și dbs_restore.

Șase metode din data_module acoperă un tabel de la un capăt la altul: aceleași șase pe care le apelează grila unui tabel, în Studio și în fila Date din dashboard, și aceleași pe care le apelează o aplicație care rulează prin xu.dbs_* (vezi Framework JavaScript). Cu o cheie API de cont, sunt accesibile direct; vezi Interoghează și scrie datele aplicației pentru un exemplu complet dbs_read / dbs_create, cu corpuri de cerere și de răspuns. Această pagină este referința pentru celelalte patru și pentru opțiunile de filtrare, sortare și arhivare pe care le acceptă dbs_read.

Metode

Fiecare dintre ele primește table_id, propriul _id al nodului tabelului, niciodată numele lui afișat, iar fiecare scriere trece prin aceleași conversii de tip de câmp descrise în Tabele și câmpuri.

Actualizarea unui rând

POST/cpi/dbs_update
admin

DBS Update

Replaces the data of an existing record, identified by row_id, in the specified app table.

table_data se îmbină în datele existente ale rândului după id-ul câmpului: doar câmpurile pe care le incluzi se schimbă, fiecare alt câmp deja existent în rând rămâne cum era. Trimite doar câmpurile pe care vrei să le schimbi; nu e nevoie să citești mai întâi rândul pentru a-l păstra pe restul.

Ștergerea și restaurarea rândurilor

POST/cpi/dbs_delete
admin

DBS Delete

Soft-deletes (or permanently deletes when 'permanent' is set) the listed record IDs from an app table.

POST/cpi/dbs_restore
admin

DBS Restore

Restores previously soft-deleted records, identified by their IDs, in the specified app table.

dbs_delete fără permanent nu elimină rândul, ci îl comută în starea arhivat, aceeași stare în care ajunge un rând când cineva îl arhivează din grilă. Un rând arhivat nu mai apare într-un dbs_read obișnuit, dar încă există și încă se numără în cifra de arhivate din get_table_counts, iar dbs_restore îl comută direct înapoi. permanent: true sare peste pasul de arhivare și șterge rândul definitiv, ceea ce dbs_restore nu poate anula.

Arhivarea rândului, nu a tabelului

Aceasta este starea proprie active/archived a unui rând, setată cu dbs_delete și dbs_restore și citită înapoi cu indicatorul archived al lui dbs_read. Nu are legătură cu arhivarea unui întreg tabel ca nod Studio, descrisă în Tabele și câmpuri.

Numărarea rândurilor

POST/cpi/get_table_counts
admin

Get Table Counts

Returns the number of records in a table: active records, or archived records when archived is true.

Returnează numărul de rânduri active și arhivate pentru un tabel, aceleași cifre pe care dbs_read le atașează deja propriului răspuns ca total_table_count, utile și separat când vrei un număr fără să parcurgi rândurile pentru a-l obține.

Filtrarea unei citiri

Câmpul query al lui dbs_read este un obiect indexat după id-ul câmpului, fiecare valoare indicând un tip de filtru și un operator:

json
{
  "query": {
    "STU_Campus": { "filterType": "text", "type": "equals", "filter": "Downtown" },
    "STU_Age": { "filterType": "number", "type": "greaterThanOrEqual", "filter": 18 }
  }
}

Fiecare câmp numit în query se combină cu celelalte prin AND. Un singur câmp poate purta și propria listă de conditions, cu un operator OR sau AND între ele, pentru „acest câmp se potrivește cu oricare dintre acestea":

json
{
  "query": {
    "STU_Campus": {
      "operator": "OR",
      "conditions": [
        { "filterType": "text", "type": "equals", "filter": "Downtown" },
        { "filterType": "text", "type": "equals", "filter": "Uptown" }
      ]
    }
  }
}

Sortare și paginare

sortModel este o listă de perechi { colId, sort } (sort este asc sau desc), aplicate în ordinea dată pentru o sortare pe mai multe coloane. from și to sunt un interval de rânduri (from este decalajul, to - from este dimensiunea paginii), ambele opționale; dacă le omiți, primești pagina implicită a tabelului.

Erori bune de știut

Acestea se aplică tuturor celor șase metode de mai sus, nu doar unei scrieri: