Aller au contenu
Vérifié

Interroger et écrire les données d'une application

Lisez des lignes d'une table Studio et ajoutez-en une, depuis l'extérieur du runtime, avec les deux mêmes méthodes qu'une application en cours d'exécution appelle elle-même.

dbs_read et dbs_create sont les deux mêmes appels qu'un programme javascript ou api effectue à l'exécution via xu.dbs_read(...) et xu.dbs_create(...), accessibles directement avec une clé API de compte pour que votre propre backend puisse lire et écrire une table Studio d'un projet sans passer du tout par le runtime. Consultez JavaScript Framework pour le côté intégré au projet des mêmes méthodes, et Plateforme de développement pour le reste de data_module.

Trouver un table_id

table_id est le _id du nœud de la table, jamais son nom d'affichage. get_progs avec menu_type: "table" liste chaque table d'un projet sous forme de paires {_id, properties: {menuName}}, le moyen le plus économique de passer d'un nom que vous savez lire à l'identifiant dont ces deux méthodes ont besoin.

Méthodes

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.

Pas à pas

Lire une page de lignes

from/to est une plage de lignes (from est le décalage, to - from est la taille de la page), et les deux sont facultatifs : omettez-les et vous obtenez la page par défaut de la table. Tous les autres filtres (row_id, query, sortModel, archived) sont aussi facultatifs.

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. Ajouter une ligne

table_data est un objet simple indexé par les propres identifiants de champ de la table, les identifiants de colonne que Studio a attribués à la création de la table, et non des noms génériques. Relisez d'abord une ligne avec l'étape 1 si vous ne savez pas comment s'appellent les champs d'une table donnée.

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 réponse

dbs_read enveloppe le résultat du plugin de la table et y ajoute le total de lignes de la table :

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
  }
}

Chaque ligne est { id, value } : id est l'identifiant de document propre à la ligne (ce qu'attend row_id dans un appel ultérieur, ou dbs_update/dbs_delete), value est la donnée des champs indexée de la même façon que table_data a été envoyé. total_rows compte cette page ; total_table_count compte toute la table (lignes actives seulement, sauf si archived: true a été envoyé), le nombre que lirait un contrôle « Page 1 sur N ».

dbs_create répond avec l'écriture, pas avec la ligne :

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

Relisez la nouvelle ligne avec dbs_read (row_id défini sur data.id) si vous avez besoin de sa value enregistrée : cet appel ne la renvoie pas. Envoyer un tableau pour table_data au lieu d'un seul objet insère chaque élément comme sa propre ligne en un seul appel ; id/rev reviennent alors par ligne et non une seule fois.

Erreurs

Suite