Gestion des liens links--relation-between-tables
Un lien décrit l'association d’une table vers une autre table.
Les types d’associations, également appelés cardinalités, sont répertoriés ci-dessous.
- cardinalité 1-1 : à une occurrence de la table source peut correspondre au plus une occurrence de la table cible,
- cardinalité 1-N : à une occurrence de la table source peuvent correspondre plusieurs occurrences de la table cible, mais à une occurrence de la table cible peut correspondre au plus une occurrence de la table source,
- cardinalité N-N : à une occurrence de la table source peuvent correspondre plusieurs occurrences de la table cible et vice versa.
Dans l’interface utilisateur, les cardinalités sont représentées par une icône spécifique.
Pour les relations de jointure avec une table/base de données de campagne :
-
-
-
Pour les relations de jointure utilisant Federated Database Access (FDA) :
-
-
Pour plus d’informations sur les tables FDA, voir la section Accès à une base de données externe.
Un lien doit être déclaré dans le schéma possédant la clé étrangère de la table liée à partir de l'élément principal :
<element name="name_of_link" type="link" target="key_of_destination_schema">
<join xpath-dst="xpath_of_field1_destination_table" xpath-src="xpath_of_field1_source_table"/>
<join xpath-dst="xpath_of_field2_destination_table" xpath-src="xpath_of_field2_source_table"/>
...
</element>
Les liens suivent les règles suivantes :
-
La définition d'un lien est renseignée sur un
<element>de type link avec les attributs suivants :-
name : nom du lien à partir de la table source
-
target : nom du schéma cible
-
label : libellé du lien
-
revLink (optionnel) : nom du lien inverse à partir du schéma cible (déduit automatiquement par défaut)
-
integrity (optionnel) : intégrité référentielle de l’occurrence de la table source par rapport à l’occurrence de la table cible.
Les valeurs possibles sont les suivantes :- define : la suppression de l’occurrence source est possible si elle n’est plus référencée par une occurrence cible
- normal : la suppression de l’occurrence source initialise les clés du lien sur l’occurrence cible (mode par défaut), ce type d’intégrité initialise toutes les clés étrangères
- own : la suppression de l’occurrence source entraîne la suppression de l’occurrence cible
- owncopy : semblable à own (en cas de suppression) ou duplique les occurrences (en cas de duplication)
- neutral : aucun comportement spécifique
-
revIntegrity (optionnel) : intégrité sur le schéma cible (optionnel, « normal » par défaut)
-
revCardinality (optionnel) : avec la valeur « Single », renseigne la cardinalité de type 1-1 (par défaut 1-N)
-
externalJoin (optionnel) : force la jointure externe
-
revExternalJoin (optionnel) : force la jointure externe sur le lien reverse
-
-
Un lien fait référence à un ou plusieurs champs de la table source vers la table de destination. Il n’est pas nécessaire de renseigner les champs constituant l’élément
<join>, car ils sont automatiquement déduits par défaut à l’aide de la clé interne du schéma cible. -
Un index sur la clé étrangère du lien est automatiquement ajouté dans le schéma étendu.
-
Un lien est composé de deux demi-liens, le premier est déclaré à partir du schéma source et le second est créé automatiquement dans le schéma étendu du schéma cible.
-
La jointure d’un lien peut être externe ("external join") en ajoutant l’attribut externalJoin avec la valeur "true" (supporté sous PostgreSQL).
Exemple : lien inverse example-1
Dans l’exemple ci-dessous, nous déclarons une relation 1-N à la table de schémas « cus:company » :
<srcSchema name="recipient" namespace="cus">
<element name="recipient">
...
<element label="Company" name="company" revIntegrity="define" revLabel="Contact" target="cus:company" type="link"/>
</element>
</srcSchema>
Le schéma généré :
<schema mappingType="sql" name="recipient" namespace="cus" xtkschema="xtk:schema">
<element name="recipient" sqltable="CusRecipient">
<dbindex name="companyId">
<keyfield xpath="@company-id"/>
</dbindex>
...
<element label="Company" name="company" revLink="recipient" target="cus:company" type="link">
<join xpath-dst="@id" xpath-src="@company-id"/>
</element>
<attribute advanced="true" label="Foreign key of 'Company' link (field 'id')" name="company-id" sqlname="iCompanyId" type="long"/>
</element>
</schema>
La définition du lien est complétée avec les champs composant la jointure, c’est-à-dire la clé primaire avec son XPath (« @id ») dans le schéma destination et la clé étrangère avec son XPath (« @company-id ») dans le schéma.
La clé étrangère est ajoutée automatiquement dans un élément reprenant les même caractéristiques que le champ associé dans la table destination avec comme convention de nommage le nom du schéma cible suivi du nom du champ associé ("company-id" dans notre exemple).
Le schéma étendu de la cible ("cus:company") :
<schema mappingType="sql" name="company" namespace="cus" xtkschema="xtk:schema">
<element name="company" sqltable="CusCompany" autopk="true">
<dbindex name="id" unique="true">
<keyfield xpath="@id"/>
</dbindex>
<key internal="true" name="id">
<keyfield xpath="@id"/>
</key>
...
<attribute desc="Internal primary key" label="Primary key" name="id" sqlname="iCompanyId" type="long"/>
...
<element belongsTo="cus:recipient" integrity="define" label="Contact" name="recipient" revLink="company" target="nms:recipient" type="link" unbound="true">
<join xpath-dst="@company-id" xpath-src="@id"/>
</element>
</element>
</schema>
Un lien réverse vers la table "cus:recipient" a été ajouté avec les paramètres suivant :
- name : déduit automatiquement avec le nom du schéma source (peut être forcé avec l'attribut "revLink" dans la définition du lien sur le schéma source)
- revLink : nom du lien réverse
- target : clé du schéma lié (schéma "cus:recipient")
- unbound : le lien est déclaré comme élément de collection pour une cardinalité 1-N (par défaut)
- integrity : par défaut "define" (peut être forcée avec l'attribut "revIntegrity" dans la définition du lien sur le schéma source)
Exemple : lien simple example-2
Dans cet exemple, nous déclarons un lien vers la table de schémas « nms:address ». La jointure est externe et est renseignée explicitement avec l’adresse e-mail de la personne destinataire et le champ « @address » de la table liée (« nms:address »).
<srcSchema name="recipient" namespace="cus">
<element name="recipient">
...
<element integrity="neutral" label="Info about email" name="emailInfo" revIntegrity="neutral" revLink="recipient" target="nms:address" type="link" externalJoin="true">
<join xpath-dst="@address" xpath-src="@email"/>
</element>
</element>
</srcSchema>
Exemple : cardinalité unique example-3
Dans cet exemple, nous créons une relation 1-1 avec la table de schémas « cus:extension » :
<element integrity="own" label="Extension" name="extension" revCardinality="single" revLink="recipient" target="cus:extension" type="link"/>
Exemple : lien vers un dossier example-4
Dans cet exemple, nous déclarons un lien vers un dossier (schéma « xtk:folder ») :
<element default="DefaultFolder('nmsFolder')" label="Folder" name="folder" revDesc="Recipients in the folder" revIntegrity="own" revLabel="Recipients" target="xtk:folder" type="link"/>
La valeur par défaut renvoie l’identifiant du premier dossier éligible de type du paramètre renseigné dans la fonction « DefaultFolder('nmsFolder') ».
Exemple : créer une clé sur un lien example-5
Dans cet exemple, on souhaite créer une clé sur un lien (« company » vers le schéma « cus:company ») avec l’attribut xlink et un champ de la table (« email ») :
<srcSchema name="recipient" namespace="cus">
<element name="recipient">
<key name="companyEmail">
<keyfield xpath="@email"/>
<keyfield xlink="company"/>
</key>
<attribute name="email" type="string" length="80" label="Email" desc="Recipient email"/>
<element label="Company" name="company" revIntegrity="define" revLabel="Contact" target="cus:company" type="link"/>
</element>
</srcSchema>
Le schéma généré :
<schema mappingType="sql" name="recipient" namespace="cus" xtkschema="xtk:schema">
<element name="recipient" sqltable="CusRecipient">
<dbindex name="companyId">
<keyfield xpath="@company-id"/>
</dbindex>
<dbindex name="companyEmail" unique="true">
<keyfield xpath="@email"/>
<keyfield xpath="@company-id"/>
</dbindex>
<key name="companyEmail">
<keyfield xpath="@email"/>
<keyfield xpath="@company-id"/>
</key>
<attribute desc="Email address of recipient" label="Email" length="80" name="email" sqlname="sEmail" type="string"/>
<element label="Company" name="company" revLink="recipient" target="sfa:company" type="link">
<join xpath-dst="@id" xpath-src="@company-id"/>
</element>
<attribute advanced="true" label="Foreign key of link 'Company' (field 'id')" name="company-id" sqlname="iCompanyId" type="long"/>
</element>
</schema>
La définition de la clé de nom "companyEmail" a été entendue avec la clé étrangère du lien "company", cette clé engendre un index unique sur les deux champs.