Esta web utiliza cookies propias y de terceros para su funcionamiento. ¿Aceptas? Leer más
Los modelos

La definición de la estructura de la tabla

FacturaScripts utiliza archivos XML para definir las estructuras de las tablas de la base de datos. De esta forma, el núcleo revisa las tablas y:

  • Si no existe la tabla, la crea.
  • Si existe la tabla, comprueba si tiene todas las columnas necesarias, si no, las crea.
  • Si tiene más columnas de las necesarias, no hace nada.

Los archivos XML de las tablas se deben alojar en la carpeta Table de tu plugin. Y cada archivo debe llamarse igual que la tabla.

Ejemplo: projects.xml

<?xml version="1.0" encoding="UTF-8"?>
<table>
    <column>
        <name>name</name>
        <type>character varying(100)</type>
        <null>NO</null>
    </column>
    <column>
        <name>codproject</name>
        <type>character varying(8)</type>
        <null>NO</null>
    </column>
    <constraint>
        <name>projects_pkey</name>
        <type>PRIMARY KEY (codproject)</type>
    </constraint>
</table>

Podemos ver como hay una etiqueta column para cada una de las columnas de la tabla, que puede contener a su vez las siguientes etiquetas:

  • name: para el nombre de la tabla. Importante, no utilices mayúsculas para los nombres de las tablas.
  • type: para indicar el tipo de dato que almacena la tabla.
  • null: YES si la columna admite null. NO si la columna no admite valores null. Si no hay etiqueta null, se interpreta como YES.
  • default: para indicar el valor por defecto a asignar en caso de no proporcionar uno, por ejemplo, cuando ya hay registros en esa tabla y justo se añade esta nueva columna. En ese caso se utiliza default para rellenar en los registros antiguos. Pero para el día a día, los valores por defecto hay que definirlos en el método clear() del modelo, no aquí.

Tipos soportados:

FacturaScripts fué desarrollador originalmente para usar PostgreSQL, por lo que los nombres de los tipos de datos son en su mayoría los de PostgreSQL. Aquí tienes la lista en detalle:

  • serial: este es un entero autoincremental. Es el que debes utilizar para las claves primarias numéricas.
  • integer: entero, el de toda la vida.
  • double precision: para números con decimales.
  • boolean: para valores lógicos, true o false.
  • character varying(100): para texto de hasta 100 caracteres. Para usar más o menos caracteres, simplemente cambia el número.
  • text: para texto de hasta 4000 caracteres.
  • date: para fechas.
  • time without time zone, para guardar horas.

Clave primaria, claves ajenas, etc...

La clave primaria, así como las claves ajenas y otras restricciones se definen con etiquetas constraint. Cada una de estas restricciones tiene un nombre, que debe ser único, y que se utiliza para comprobar en la tabla.

  • Si no se encuentra una restricción con ese nombre en la tabla, se crea.
  • Si ya existe una restricción con ese nombre en la tabla, no se hace nada.
  • Si le cambias el nombre a la restricción, se elimina la que hay en la tabla y se crea la nueva.

Ejemplo de clave ajena:

<constraint>
    <name>ca_albaranesprov_series</name>
    <type>FOREIGN KEY (codserie) REFERENCES series (codserie) ON DELETE RESTRICT ON UPDATE CASCADE</type>
</constraint>

En este ejemplo se está indicando:

  • Que la columna codserie de esta tabla, se corresponde con la columna codserie de la tabla series.
  • Que en caso de eliminación en la tabla series, se bloquee.
  • Que en caso de modificación en la tabla series, se propague el cambio a la columna en esta tabla.

Ejemplo de restricción para no repetir valores en una o varias columnas:

<constraint>
    <name>uniq_codigo_albaranesprov</name>
    <type>UNIQUE (codigo,idempresa)</type>
</constraint>

En este ejemplo se está indicando que no se debe repetir un conjunto codigo + idempresa.