Aller au contenu
Vérifié

Table

La définition d'une entité de données, ses colonnes et ses index, stockée via un pilote de base de données interchangeable.

Une Table définit une entité de données : ses colonnes, les index servant à retrouver les lignes et le pilote de base de données qui la stocke. Contrairement à un programme, une Table ne porte ni workflow, ni événements, ni interface : son schéma est tout le contrat. Chaque lecture et écriture d'une application Xuda finit par pointer vers une Table, via Obtenir des données, Définir des données, Lot ou la source de données d'un Composant.

Propriétés

La table se trouve sous studio_meta.parentId: "database" (ou un dossier imbriqué sous celui-ci).

tableFields

Préfixez les colonnes avec un code de table

Une table nommée « ORD - Orders » préfixe chaque colonne : ORD_Id, ORD_Total, ORD_Status. Cela garde les noms de champs sans ambiguïté dès que plusieurs tables figurent dans la même expression, et c'est la convention que suivent toutes les tables existantes d'un projet.

tableIndexes

Une table a besoin d'au moins un champ avant de pouvoir porter un index. Un index n'est obligatoire que pour les tables sur un pilote de base de données non natif ; le moteur propre à la plateforme (@xuda.io/xuda-dbs-plugin-xuda) accepte une table sans aucun index, même si en pratique toute table qu'un Composant ou un programme set_data peut lier à un enregistrement unique a besoin d'un index unique <TBL>_Id pour le faire.

Utiliser une table

  • Lire ou écrire une ligne : le progDataSource.dataSourceTableId d'un programme Obtenir des données, Définir des données ou Lot désigne le _id de cette table.
  • Lier directement un Composant : la même paire dataSourceTableId / dataSourceIndexId, intégrée au Composant plutôt qu'à un programme séparé.
  • Depuis un script : xu.dbs_create, xu.dbs_read, xu.dbs_update, xu.dbs_delete, appelés avec le _id de la table, jamais son nom.

Exemple concret

Modélisez les colonnes

Une table par entité, un préfixe de 3 lettres par table : STU_Student_Id, STU_Full_Name.

Ajoutez un index unique sur l'identifiant

Donnez à chaque table un index unique sur son champ <TBL>_Id. Les Composants qui lient un seul enregistrement par clé, et les programmes set_data en mode mise à jour ou suppression, retrouvent la ligne cible via cet index.

Pointez une source de données dessus

Le dataSourceTableId d'un programme Obtenir des données ou Définir des données désigne le _id de cette table ; dataSourceIndexId désigne l'un des identifiants de tableIndexes.

Sous Base de données dans l'arborescence de Studio, ajoutez une table, puis ajoutez des lignes à sa grille Champs (id, type, obligatoire) et à sa grille Index (nom, clés, unique). L'onglet Données du même nœud affiche et modifie directement les lignes.

json
{
  "id": "student_profiles_table",
  "menuTitle": "Student Profiles Table",
  "fields": [
    { "field_id": "student_id", "type": "string" },
    { "field_id": "full_name", "type": "string" },
    { "field_id": "campus", "type": "string" }
  ],
  "indexes": [
    { "id": "student_idx", "name": "Student", "keys": ["student_id"] },
    { "id": "campus_idx", "name": "Campus", "keys": ["campus"] }
  ]
}

Une table n'a pas de forme source .xu : les projets xuda-cli la déclarent plutôt dans un fichier .table.json5 (ceci est ce fichier, présenté en JSON).

json
{
  "properties": {
    "menuType": "table",
    "menuName": "STU - Students",
    "databaseSocket": "@xuda.io/xuda-dbs-plugin-xuda"
  },
  "tableFields": [
    { "id": "b2c3d4e5-…", "data": { "field_id": "STU_Student_Id" }, "props": { "fieldType": "string", "mandatory": true } },
    { "id": "c3d4e5f6-…", "data": { "field_id": "STU_Full_Name" }, "props": { "fieldType": "string", "mandatory": true } }
  ],
  "tableIndexes": [
    { "id": "a1b2c3d4-…", "data": { "name": "Index_0", "unique": true, "keys": ["STU_Student_Id"] } }
  ]
}