Saltar al contenido
Verificada

Consultar y escribir datos de la app

Lee filas de una tabla de Studio y añade una, desde fuera del runtime, con los mismos dos métodos que llama una app en ejecución.

dbs_read y dbs_create son las mismas dos llamadas que hace en tiempo de ejecución un programa javascript o api mediante xu.dbs_read(...) y xu.dbs_create(...), accesibles directamente con una clave de API de cuenta para que tu propio backend pueda leer y escribir en una tabla de Studio de un proyecto sin pasar por el runtime. Consulta Framework JavaScript para ver la parte dentro del proyecto de los mismos métodos, y Plataforma de desarrollo para el resto de data_module.

Cómo encontrar un table_id

table_id es el propio _id del nodo de la tabla, nunca su nombre visible. get_progs con menu_type: "table" lista todas las tablas de un proyecto como pares {_id, properties: {menuName}}, la forma más barata de convertir un nombre que puedes leer en el id que necesitan estos dos métodos.

Métodos

POST/cpi/dbs_read
user_access

DBS Read

Reads records from an app table with optional row range, single-row lookup, sorting, filtering, and archived-record selection.

POST/cpi/dbs_create
admin

DBS Create

Creates a new record in the specified app table from the provided key-value table data.

Paso a paso

Lee una página de filas

from/to es un rango de filas (from es el desplazamiento, to - from es el tamaño de página), y ambos son opcionales: si los omites obtienes la página predeterminada de la tabla. Todos los demás filtros (row_id, query, sortModel, archived) también son opcionales.

curl -s https://xuda.ai/cpi/dbs_read \
  -H 'content-type: application/json' \
  -d '{"api_key":"YOUR_API_KEY","app_id":"YOUR_APP_ID","table_id":"YOUR_TABLE_ID","from":0,"to":50}'
const res = await fetch('https://xuda.ai/cpi/dbs_read', {
  method: 'POST',
  headers: { 'content-type': 'application/json' },
  body: JSON.stringify({
    api_key: 'YOUR_API_KEY',
    app_id: 'YOUR_APP_ID',
    table_id: 'YOUR_TABLE_ID',
    from: 0,
    to: 50,
  }),
});
const { code, data } = await res.json();
if (code > 0) for (const row of data.rows) console.log(row.id, row.value);
import requests

res = requests.post(
    'https://xuda.ai/cpi/dbs_read',
    json={'api_key': 'YOUR_API_KEY', 'app_id': 'YOUR_APP_ID', 'table_id': 'YOUR_TABLE_ID', 'from': 0, 'to': 50},
)
body = res.json()
if body['code'] > 0:
    for row in body['data']['rows']:
        print(row['id'], row['value'])

2. Añade una fila

table_data es un objeto simple con las claves de los propios ids de campo de la tabla, los ids de columna que Studio asignó al construirla, no nombres genéricos. Si no estás seguro de cómo se llaman los campos de una tabla, lee antes una fila con el paso 1.

curl -s https://xuda.ai/cpi/dbs_create \
  -H 'content-type: application/json' \
  -d '{
    "api_key": "YOUR_API_KEY",
    "app_id": "YOUR_APP_ID",
    "table_id": "YOUR_TABLE_ID",
    "table_data": { "CNT_Name": "Priya Shah", "CNT_Email": "[email protected]" }
  }'
const res = await fetch('https://xuda.ai/cpi/dbs_create', {
  method: 'POST',
  headers: { 'content-type': 'application/json' },
  body: JSON.stringify({
    api_key: 'YOUR_API_KEY',
    app_id: 'YOUR_APP_ID',
    table_id: 'YOUR_TABLE_ID',
    table_data: { CNT_Name: 'Priya Shah', CNT_Email: '[email protected]' },
  }),
});
const { code, data } = await res.json();
if (code > 0) console.log(data.id, data.rev);
import requests

res = requests.post(
    'https://xuda.ai/cpi/dbs_create',
    json={
        'api_key': 'YOUR_API_KEY',
        'app_id': 'YOUR_APP_ID',
        'table_id': 'YOUR_TABLE_ID',
        'table_data': {'CNT_Name': 'Priya Shah', 'CNT_Email': '[email protected]'},
    },
)
body = res.json()
if body['code'] > 0:
    print(body['data']['id'], body['data']['rev'])

La respuesta

dbs_read envuelve el resultado del plugin de la tabla y añade encima el recuento total de la propia tabla:

json
{
  "code": 1,
  "data": {
    "rows": [
      {
        "id": "dbs-392_tbl_a91f0e_7c2b9a11",
        "value": { "CNT_Name": "Priya Shah", "CNT_Email": "[email protected]" }
      }
    ],
    "total_rows": 1,
    "opt": { "...": "the query options this read actually ran, echoed back for reference" },
    "total_table_count": 42
  }
}

Cada fila es { id, value }: id es el id de documento propio de la fila (lo que esperan row_id en una llamada posterior, o dbs_update/dbs_delete), value son los datos de los campos con las mismas claves con las que se envió table_data. total_rows cuenta esta página; total_table_count es la tabla entera (solo filas activas, salvo que se enviara archived: true), el número que leería un control "Página 1 de N".

dbs_create responde con la escritura, no con la fila:

json
{
  "code": 1,
  "data": {
    "ok": true,
    "id": "dbs-392_tbl_a91f0e_7c2b9a11",
    "rev": "1-9f8e7d6c5b4a3f2e1d0c"
  }
}

Vuelve a leer la fila nueva con dbs_read (con row_id igual a data.id) si necesitas su value guardado; esta llamada no lo devuelve. Si envías un array en table_data en lugar de un objeto, se inserta cada elemento como una fila propia en una sola llamada, y en ese caso id/rev vuelven por fila en lugar de una sola vez.

Errores

Siguiente