İçeriğe geç
Doğrulandı

API ile veri sorgulama

data_module başvurusunun tamamı, dbs_read'in süzgeç ve sıralama biçimleri ve dbs_delete ile dbs_restore'un gerçekte neyi değiştirdiği.

data_module üzerindeki altı yöntem bir tabloyu baştan sona kapsar: Studio'da ve panelin Veri sekmesi'nde bir tablonun ızgarasının çağırdığı altı yöntemle aynıdır ve çalışan bir uygulamanın xu.dbs_* üzerinden çağırdıklarıyla da aynıdır (JavaScript Framework sayfasına bakın). Bir hesap API anahtarıyla doğrudan erişilebilirler; istek ve yanıt gövdeleriyle işlenmiş bir dbs_read / dbs_create örneği için Uygulama verilerini sorgulama ve yazma sayfasına bakın. Bu sayfa diğer dört yöntemin ve dbs_read'in kabul ettiği süzgeç, sıralama ve arşiv seçeneklerinin başvurusudur.

Yöntemler

Hepsi table_id alır; bu, tablo düğümünün kendi _id değeridir, hiçbir zaman görünen adı değildir ve her yazma, Tablolar ve alanlar sayfasında anlatılan aynı alan türü dönüşümlerinden geçer.

Bir satırı güncelleme

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, satırın mevcut verisiyle alan kimliğine göre birleştirilir; yalnızca eklediğiniz alanlar değişir, satırdaki diğer her alan olduğu gibi kalır. Yalnızca değiştirmek istediğiniz alanları gönderin; geri kalanını korumak için önce satırı okumanız gerekmez.

Satırları silme ve geri yükleme

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.

permanent olmadan dbs_delete satırı kaldırmaz, arşivlenmiş duruma çevirir; bu, birinin satırı ızgaradan arşivlediğinde düştüğü durumla aynıdır. Arşivlenmiş bir satır sıradan bir dbs_read içinde görünmez ama hâlâ vardır ve get_table_counts'ın arşivlenmiş sayısına dahil edilmeye devam eder; dbs_restore onu doğrudan geri çevirir. permanent: true arşiv adımını atlar ve satırı tümüyle siler; bunu dbs_restore geri alamaz.

Satır arşivi, tablo arşivi değil

Bu, bir satırın kendi active/archived durumudur; dbs_delete ve dbs_restore ile ayarlanır ve dbs_read'in archived bayrağıyla geri okunur. Bir tablonun Studio düğümü olarak tümüyle arşivlenmesiyle ilgisi yoktur; o, Tablolar ve alanlar sayfasında anlatılır.

Satırları sayma

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.

Bir tablonun etkin ve arşivlenmiş satır sayılarını döndürür; dbs_read'in kendi yanıtına zaten total_table_count olarak eklediği rakamlarla aynıdır. Satırlar arasında sayfa sayfa gezmeden bir sayı istediğinizde tek başına işe yarar.

Bir okumayı süzme

dbs_read'in query alanı, alan kimliğine göre anahtarlanmış bir nesnedir; her değer bir süzgeç türü ve işleç belirtir:

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

query içinde adı geçen her alan diğerleriyle AND ile birleştirilir. Tek bir alan, "bu alan ikisinden birine uyuyor" için aralarında OR veya AND operator bulunan kendi conditions listesini de taşıyabilir:

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

Sıralama ve sayfalama

sortModel, { colId, sort } çiftlerinin bir listesidir (sort, asc veya desc); çok sütunlu bir sıralamada verilen sırayla uygulanır. from ve to bir satır aralığıdır (from başlangıç noktası, to - from sayfa boyutu); ikisi de isteğe bağlıdır, atlarsanız tablonun varsayılan sayfasını alırsınız.

Bilinmesi gereken hatalar

Bunlar yalnızca bir yazma için değil, yukarıdaki altı yöntemin tümü için geçerlidir: