Μετάβαση στο περιεχόμενο
Επαληθεύτηκε

Ερωτήματα δεδομένων μέσω του 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 με έναν τελεστή 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 το μέγεθος της σελίδας), και τα δύο προαιρετικά: αν τα παραλείψετε παίρνετε την προεπιλεγμένη σελίδα του πίνακα.

Σφάλματα που αξίζει να γνωρίζετε

Αυτά ισχύουν σε όλες τις έξι παραπάνω μεθόδους, όχι μόνο σε μια εγγραφή: