Przejdź do treści
Zweryfikowano

Zapytania o dane przez API

Pełna dokumentacja data_module, kształty filtrów i sortowania w dbs_read oraz to, co naprawdę przełączają dbs_delete i dbs_restore.

Sześć metod w data_module obsługuje tabelę od początku do końca: te same sześć, które wywołuje siatka tabeli, w Studio i na karcie Dane w panelu, i te same, które działająca aplikacja wywołuje przez xu.dbs_* (zobacz JavaScript Framework). Z kluczem API konta są dostępne bezpośrednio, a przykład krok po kroku z dbs_read / dbs_create z treściami żądania i odpowiedzi znajdziesz w Odpytywanie i zapisywanie danych aplikacji. Ta strona jest dokumentacją pozostałych czterech metod oraz opcji filtrowania, sortowania i archiwizacji, które przyjmuje dbs_read.

Metody

Każda z nich przyjmuje table_id, czyli własny _id węzła tabeli, nigdy jej nazwę wyświetlaną, a każdy zapis przechodzi przez te same rzutowania typów pól, które opisano w Tabelach i polach.

Aktualizacja wiersza

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 jest scalane z istniejącymi danymi wiersza według identyfikatora pola, zmieniają się tylko pola, które uwzględnisz, a każde inne pole wiersza zostaje takie, jakie było. Wyślij tylko pola, które chcesz zmienić, nie trzeba najpierw czytać wiersza, żeby zachować resztę.

Usuwanie i przywracanie wierszy

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 bez permanent nie usuwa wiersza, tylko przełącza go na zarchiwizowany, czyli w ten sam stan, w jaki wiersz trafia, gdy ktoś zarchiwizuje go z siatki. Zarchiwizowany wiersz przestaje się pokazywać w zwykłym dbs_read, ale nadal istnieje i nadal liczy się do zarchiwizowanej liczby w get_table_counts, a dbs_restore przełącza go od razu z powrotem. permanent: true pomija krok archiwizacji i usuwa wiersz na stałe, czego dbs_restore nie cofnie.

Archiwum wiersza, nie tabeli

To własny stan active/archived wiersza, ustawiany przez dbs_delete i dbs_restore i odczytywany flagą archived w dbs_read. Nie ma związku z archiwizacją całej tabeli jako węzła Studio, opisaną w Tabelach i polach.

Liczenie wierszy

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.

Zwraca liczbę aktywnych i zarchiwizowanych wierszy jednej tabeli, te same wartości, które dbs_read dołącza już do własnej odpowiedzi jako total_table_count, przydatne osobno, gdy chcesz poznać liczbę bez przeglądania wierszy stronami.

Filtrowanie odczytu

Pole query w dbs_read to obiekt indeksowany identyfikatorem pola, w którym każda wartość nazywa typ filtra i operator:

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

Każde pole wymienione w query jest łączone z pozostałymi przez AND. Pojedyncze pole może też mieć własną listę conditions z operatorem OR lub AND między nimi, dla "to pole pasuje do jednej z tych wartości":

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

Sortowanie i stronicowanie

sortModel to lista par { colId, sort } (sort to asc albo desc), stosowanych w podanej kolejności przy sortowaniu po wielu kolumnach. from i to to zakres wierszy (from to przesunięcie, to - from to rozmiar strony), oba opcjonalne. Jeśli je pominiesz, dostaniesz domyślną stronę tabeli.

Błędy, które warto znać

Dotyczą wszystkich sześciu powyższych metod, nie tylko zapisu: