Consultar datos mediante la API
La referencia completa de data_module, las formas de filtro y orden de dbs_read, y qué cambian realmente dbs_delete y dbs_restore.
Seis métodos de data_module cubren una tabla de principio a fin: los mismos seis que llama la cuadrícula de una
tabla, en Studio y en la pestaña Datos del panel, y los mismos que llama una app en
ejecución mediante xu.dbs_* (consulta JavaScript Framework). Con una clave de API
de cuenta se pueden alcanzar directamente; consulta
Consultar y escribir datos de una app para un recorrido práctico de
dbs_read / dbs_create con cuerpos de solicitud y de respuesta. Esta página es la referencia de los otros
cuatro y de las opciones de filtro, orden y archivo que acepta dbs_read.
Métodos
Todos ellos reciben table_id, el _id propio del nodo de la tabla, nunca su nombre visible, y toda escritura
pasa por las mismas conversiones de tipo de campo descritas en
Tablas y campos.
Actualizar una fila
DBS Update
Replaces the data of an existing record, identified by row_id, in the specified app table.
table_data se fusiona con los datos existentes de la fila por id de campo: solo cambian los campos que incluyes y
todos los demás campos que ya tenía la fila se dejan como estaban. Envía solo los campos que quieras cambiar; no
hace falta leer antes la fila para conservar el resto.
Eliminar y restaurar filas
DBS Delete
Soft-deletes (or permanently deletes when 'permanent' is set) the listed record IDs from an app table.
DBS Restore
Restores previously soft-deleted records, identified by their IDs, in the specified app table.
dbs_delete sin permanent no quita la fila, la pasa a archivada, el mismo estado en el que queda una fila
cuando alguien la archiva desde la cuadrícula. Una fila archivada deja de aparecer en un dbs_read normal, pero
sigue existiendo y sigue contando en la cifra de archivadas de get_table_counts, y dbs_restore la devuelve
directamente a su estado anterior. permanent: true se salta el paso de archivado y elimina la fila por
completo, algo que dbs_restore no puede deshacer.
Este es el estado propio active/archived de una fila, establecido con dbs_delete y dbs_restore y leído
con el indicador archived de dbs_read. No tiene relación con que una tabla entera se archive como nodo de
Studio, tratado en Tablas y campos.
Contar filas
Get Table Counts
Returns the number of records in a table: active records, or archived records when archived is true.
Devuelve los recuentos de filas activas y archivadas de una tabla, las mismas cifras que dbs_read ya adjunta a su
propia respuesta como total_table_count, útil por sí solo cuando quieres un recuento sin recorrer las filas
página a página para obtenerlo.
Filtrar una lectura
El campo query de dbs_read es un objeto indexado por id de campo, cuyo valor indica un tipo de filtro y un
operador:
Todos los campos nombrados en query se combinan con los demás mediante AND. Un solo campo también puede llevar
su propia lista de conditions con un operator OR o AND entre ellas, para "este campo
coincide con cualquiera de estos":
Ordenar y paginar
sortModel es una lista de pares { colId, sort } (sort es asc o desc), aplicados en el orden dado para
una ordenación por varias columnas. from y to son un rango de filas (from el desplazamiento, to - from el
tamaño de página), ambos opcionales; si los omites obtienes la página por defecto de la tabla.
Errores que conviene conocer
Se aplican a los seis métodos anteriores, no solo a una escritura: