Ugrás a tartalomhoz
Ellenőrizve

Adatok lekérdezése az API-n keresztül

A teljes data_module referencia, a dbs_read szűrő- és rendezési alakjai, és mit billent át valójában a dbs_delete és a dbs_restore.

A data_module hat metódusa végigvisz egy táblát az elejétől a végéig: ugyanaz a hat, amelyet a tábla rácsa hív a Studióban és az irányítópult Adatok lapján, és ugyanezeket hívja a futó alkalmazás az xu.dbs_* hívásokon keresztül (lásd JavaScript keretrendszer). Fiók API-kulccsal közvetlenül elérhetők, a kérés- és válaszszövegekkel kidolgozott dbs_read / dbs_create bemutatóért lásd a Alkalmazásadatok lekérdezése és írása oldalt. Ez az oldal a másik négy referenciája, valamint a dbs_read által elfogadott szűrő-, rendezési és archiválási lehetőségeké.

Metódusok

Mindegyik a table_id értéket várja, a tábla csomópontjának saját _id azonosítóját, soha nem a megjelenített nevét, és minden írás ugyanazokon a mezőtípus-átalakításokon megy át, amelyeket a Táblák és mezők oldal ismertet.

Sor frissítése

POST/cpi/dbs_update
admin

DBS Update

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

A table_data mezőazonosító szerint olvad be a sor meglévő adataiba, csak a megadott mezők változnak, a sor minden más mezője úgy marad, ahogy volt. Csak azokat a mezőket küldje, amelyeket módosítani szán, nem kell előbb beolvasnia a sort a többi megőrzéséhez.

Sorok törlése és visszaállítása

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.

A dbs_delete a permanent nélkül nem távolítja el a sort, hanem archiváltra billenti, ugyanabba az állapotba, amelybe a sor kerül, ha valaki a rácsból archiválja. Az archivált sor nem jelenik meg a szokásos dbs_read eredményében, de még létezik, és még beleszámít a get_table_counts archivált számába, a dbs_restore pedig azonnal visszabillenti. A permanent: true kihagyja az archiválási lépést, és a sort végleg törli, amit a dbs_restore nem tud visszavonni.

Sorarchiválás, nem táblaarchiválás

Ez a sor saját active/archived állapota, amelyet a dbs_delete és a dbs_restore állít be, és a dbs_read archived jelzője olvas vissza. Nincs köze ahhoz, hogy egy egész táblát Studio-csomópontként archiválnak, ezt a Táblák és mezők oldal tárgyalja.

Sorok megszámlálása

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.

Egy tábla aktív és archivált sorszámát adja vissza, ugyanazokat a számokat, amelyeket a dbs_read már total_table_count néven csatol a saját válaszához, önmagában akkor hasznos, ha számra van szüksége anélkül, hogy sorokon lapozna.

Olvasás szűrése

A dbs_read query mezője egy mezőazonosító szerint kulcsolt objektum, minden érték egy szűrőtípust és műveletet nevez meg:

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

A query-ben megnevezett minden mező ÉS kapcsolattal kapcsolódik a többihez. Egy mező saját conditions listát is hordozhat, köztük OR vagy AND operator értékkel, a "ez a mező megfelel akár az egyiknek, akár a másiknak" esetre:

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

Rendezés és lapozás

A sortModel { colId, sort } párok listája (a sort értéke asc vagy desc), többoszlopos rendezésnél a megadott sorrendben alkalmazva. A from és a to egy sortartomány (a from az eltolás, a to - from az oldalméret), mindkettő elhagyható. Ha kihagyja őket, a tábla alapértelmezett oldalát kapja.

Hibák, amelyeket érdemes ismerni

Ezek mind a hat fenti metódusra érvényesek, nemcsak az írásra: