Saltar para o conteúdo
Verificado

Tabela

A definição de uma entidade de dados, as suas colunas e os seus índices, guardada através de um controlador de base de dados modular.

Uma Tabela define uma entidade de dados: as suas colunas, os índices utilizados para procurar linhas e o controlador de base de dados que a guarda. Ao contrário de um programa, uma Tabela não tem fluxo de trabalho, eventos nem interface, o seu esquema é todo o contrato. Todas as leituras e escritas numa aplicação Xuda acabam por apontar para uma Tabela através de uma fonte de dados de Obter Dados, Definir Dados, Lote ou Componente.

Propriedades

A tabela fica em studio_meta.parentId: "database" (ou numa pasta aninhada nele).

tableFields

Prefixe as colunas com um código de tabela

Uma tabela chamada "ORD - Orders" prefixa todas as colunas: ORD_Id, ORD_Total, ORD_Status. Mantém os nomes dos campos inequívocos quando várias tabelas estão na mesma expressão, e é a convenção que todas as tabelas existentes num projeto seguem.

tableIndexes

Uma tabela precisa de pelo menos um campo antes de poder ter um índice. Um índice só é obrigatório em si para tabelas num controlador de base de dados não nativo, o motor da própria plataforma (@xuda.io/xuda-dbs-plugin-xuda) aceita uma tabela com zero índices, embora, na prática, toda a tabela a que um Componente ou um programa set_data possa associar um único registo precise de um índice <TBL>_Id único para o fazer.

Utilizar uma tabela

  • Ler ou escrever uma linha: o progDataSource.dataSourceTableId de um programa Obter Dados, Definir Dados ou Lote indica o _id desta tabela.
  • Associar diretamente um Componente: o mesmo par dataSourceTableId / dataSourceIndexId, incorporado no Componente em vez de num programa separado.
  • A partir de um script: xu.dbs_create, xu.dbs_read, xu.dbs_update, xu.dbs_delete, chamados com o _id da tabela, nunca com o seu nome.

Exemplo prático

Modele as colunas

Uma tabela por entidade, um prefixo de 3 letras por tabela: STU_Student_Id, STU_Full_Name.

Adicione um índice único no id

Dê a cada tabela um índice único no seu campo <TBL>_Id. Os Componentes que associam um único registo por chave, e os programas set_data em modo de atualização ou de eliminação, resolvem a linha de destino através deste índice.

Aponte uma fonte de dados para ela

O dataSourceTableId de um programa Obter Dados ou Definir Dados indica o _id desta tabela; dataSourceIndexId indica um dos ids de tableIndexes.

Em Base de dados, na árvore do Studio, adicione uma tabela e depois adicione linhas à sua grelha de Campos (id, tipo, obrigatório) e à sua grelha de Índices (nome, chaves, único). O separador Dados no mesmo nó mostra e edita as linhas diretamente.

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

Uma tabela não tem forma de código-fonte .xu, os projetos xuda-cli declaram-na antes como um ficheiro .table.json5 (este é esse ficheiro, mostrado como 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"] } }
  ]
}