דילוג לתוכן
אומת

שאילתות נתונים דרך ה-API

מדריך ה-data_module המלא, צורות הסינון והמיון של dbs_read, ומה בעצם dbs_delete ו-dbs_restore הופכים.

שש שיטות ב-data_module מכסות טבלה מקצה לקצה: אותן שש שהרשת של טבלה קוראת להן, ב-Studio ובמסך לשונית הנתונים בדשבורד, ואותן שאפליקציה רצה קוראת להן דרך xu.dbs_* (ראו JavaScript Framework). עם מפתח API של חשבון אפשר להגיע אליהן ישירות. ראו שאילתה וכתיבה של נתוני אפליקציה למעבר מלא על dbs_read / dbs_create עם גופי בקשה ותשובה. הדף הזה הוא המדריך לארבע האחרות, ולאפשרויות הסינון, המיון והארכיון ש-dbs_read מקבלת.

שיטות

כל אחת מהן מקבלת table_id, ה-_id של צומת הטבלה עצמו, אף פעם לא שם התצוגה שלו, וכל כתיבה עוברת דרך אותן המרות סוג שדה שמתוארות בטבלאות ושדות.

עדכון שורה

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 ממוזג לנתוני השורה הקיימים לפי מזהה שדה: רק השדות שכללתם משתנים, וכל שדה אחר שכבר בשורה נשאר כמו שהיה. שולחים רק את השדות שרוצים לשנות. אין צורך לקרוא קודם את השורה כדי לשמר את השאר.

מחיקה ושחזור של שורות

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 בלי permanent לא מסירה את השורה, היא הופכת אותה לשורה בארכיון, אותו מצב שבו שורה נוחתת כשמישהו מעביר אותה לארכיון מהרשת. שורה בארכיון מפסיקה להופיע ב-dbs_read רגיל, אבל עדיין קיימת ועדיין נספרת בנתון הארכיון של get_table_counts, ו-dbs_restore מחזירה אותה מיד. permanent: true מדלג על שלב הארכיון ומוחק את השורה לגמרי, ו-dbs_restore לא יכולה לבטל זאת.

ארכיון שורה, לא ארכיון טבלה

זה מצב active/archived של שורה עצמה, שנקבע עם dbs_delete ו-dbs_restore ונקרא בחזרה עם הדגל archived של dbs_read. הוא לא קשור להעברת טבלה שלמה לארכיון כצומת ב-Studio, שמוסברת בטבלאות ושדות.

ספירת שורות

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.

מחזירה את מספר השורות הפעילות ואת מספר השורות בארכיון של טבלה אחת, אותם נתונים ש-dbs_read כבר מצרפת לתשובה שלה בתור total_table_count, שימושי בפני עצמו כשרוצים ספירה בלי לדפדף בשורות כדי לקבל אחת.

סינון קריאה

השדה query של dbs_read הוא אובייקט שהמפתחות שלו הם מזהי שדות, וכל ערך מציין סוג מסנן ואופרטור:

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

כל שדה שמופיע ב-query משולב עם האחרים ב-AND. שדה אחד יכול גם לשאת רשימה משלו של conditions עם operator של OR או AND ביניהם, ל"השדה הזה תואם לאחד מאלה":

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

מיון ודפדוף

sortModel היא רשימה של זוגות { colId, sort } (sort הוא asc או desc), שמוחלים לפי הסדר שניתן, במיון על כמה עמודות. from ו-to הם טווח שורות (from הוא ההיסט, to - from הוא גודל העמוד), שניהם אופציונליים. אם משמיטים אותם מקבלים את עמוד ברירת המחדל של הטבלה.

שגיאות ששווה להכיר

אלה חלות על כל שש השיטות שלמעלה, לא רק על כתיבה: