DOCUMENTATION EN LIGNE
DE WINDEVWEBDEV ET WINDEV MOBILE

Aide / WLangage / Gestion des bases de données / HFSQL / Types de variables HFSQL
  • Propriétés spécifiques à la description de rubriques par programmation
  • Comment décrire des fichiers de données par programmation ?
  • Manipulation des rubriques d'un fichier de données décrit par programmation
  • Journalisation
WINDEV
WindowsLinuxUniversal Windows 10 AppJavaEtats et RequêtesCode Utilisateur (MCU)
WEBDEV
WindowsLinuxPHPWEBDEV - Code Navigateur
WINDEV Mobile
AndroidWidget AndroidiPhone/iPadWidget IOSApple WatchMac CatalystUniversal Windows 10 App
Autres
Procédures stockées
Une variable de type Description de Rubrique permet de décrire par programmation une ou plusieurs rubriques d'un fichier de données. La description de chaque rubrique est validée par la fonction HDécritRubrique.
Après cette validation :
  • Cette rubrique pourra être manipulée comme n'importe quelle rubrique décrite dans l'analyse.
  • La variable de type "Description de Rubrique" est réinitialisée et pourra être utilisée pour décrire par programmation une autre rubrique de fichier de données.
Exemple
MaRubrique est une Description de Rubrique
MaRubrique1, MaRubrique2 sont des Descriptions de Rubrique
// Description du fichier UnFichier
...

// Description de la rubrique "NOM"
MaRubrique est une Description de Rubrique
MaRubrique.Nom = "NOM"
MaRubrique.Type = hRubTexte
MaRubrique.Taille = 40
MaRubrique.TypeClé = hCléUnique

// Validation de la description de la rubrique "NOM"
HDécritRubrique(UnFichier, MaRubrique)

// Validation de la description du fichier UnFichier
...
Syntaxe

Déclarer une ou plusieurs descriptions de rubrique Masquer les détails

<Nom de la variable> est une Description de Rubrique
<Nom de la variable 1>, <Nom de la variable 2> sont des Descriptions de Rubriques
<Nom de la variable> :
Nom de la variable de type "Description de Rubrique" à déclarer.
Remarque : Les mots-clés une et des ne sont pas obligatoires : ce sont des mots d'agrément.

Décrire une variable de type "Description de Rubrique" Masquer les détails

Pour décrire une variable de type "Description de Rubrique" :
utilisez les propriétés du WLangage spécifiques aux descriptions de rubriques. Pour plus de détails, consultez les remarques.

Pour valider une description de variable de type "Description de Rubrique" :
utilisez la fonction HDécritRubrique.
Remarques

Propriétés spécifiques à la description de rubriques par programmation

Les propriétés spécifiques à la description de rubriques sont les suivantes :
Remarque : Les propriétés en gras suivies d'un astérisque doivent obligatoirement être initialisées lors de la description d'une rubrique par programmation.
Nom de la propriétéEffet
ComposanteModifier une composante d'une clé composée
DescriptionTypeSpécifier le type associé à une rubrique de type Enumération ou Combinaison.
FormuleCléDéfinir les composantes d'une clé composée.
FormuleRubriqueCalculéeDéfinir la formule SQL donnant la valeur d'une rubrique calculée (rubrique de type Formule).
HauteurMaxVignetteDéfinir la hauteur maximale d'une vignette d'une rubrique.
LangueDéfinir les paramètres de la langue utilisée pour les comparaisons et le tri dans le cas d'une rubrique Unicode.
LangueDécritDéfinir les paramètres de la langue utilisée pour les comparaisons et le tri dans le cas d'une rubrique Unicode.
LargeurMaxVignetteDéfinir la largeur maximale d'une vignette d'une rubrique.
mdpsDérivationDéfinir l'algorithme de dérivation de clé utilisé pour le hachage (rubrique de type "Mot de passe").
mdpsHashDéfinir l'algorithme utilisé pour le salage (rubrique de type "Mot de passe").
mdpsNombreItérationDéfinir le nombre d'itérations de l'algorithme de hachage (rubrique de type "Mot de passe").
mdpsTailleDéfinir la taille de la clé après hachage (rubrique de type "Mot de passe").
NbElémentTableauNombre d'éléments d'une rubrique tableau.
Nom ( * )Nom de la rubrique.
NullPrise en compte de l'option "NULL par défaut" pour la rubrique.
NullAutoriséDéfinir si la valeur NULL est autorisée ou non pour la rubrique.
PartieDécimaleDéfinir le nombre de chiffres de la partie décimale d'une rubrique de type Numérique.
PartieEntièreDéfinir le nombre de chiffres de la partie entière d'une rubrique de type Numérique.
PersistanceRubriqueCalculéeDéfinir si la valeur d'un rubrique calculée (de type Formule) est mémorisée dans le fichier de données.
RGPDDéfinir si la rubrique est concernée par le RGPD.
SensibleAccentuationPrise en compte de l'accentuation dans les différentes recherches effectuées sur la rubrique
SensibleCassePrise en compte de la casse (majuscules/minuscules) dans les différentes recherches effectuées sur la rubrique
SensiblePonctuationPrise en compte de la ponctuation (virgule, point, ...) dans les différentes recherches effectuées sur la rubrique
Taille (* obligatoire selon le type spécifié)Taille d'une rubrique de type texte (chaîne de caractères, mémo texte, caractère)
Taille d'une rubrique Heure.
TailleCléTaille de la partie à indexer du mémo texte.
TimestampTypeDéfinir le type d'horodatage de la rubrique.
TimestampUTCDéfinir si l'heure d'une rubrique de type horodatage est UTC ou non.
Type (* )Identifie et modifie le type d'une rubrique.
TypeCléCaractéristiques d'une rubrique de type clé.
TypeTriCaractéristiques de tri sur une rubrique.
ValeurParDéfautValeur par défaut d'une rubrique.
ValeurParDéfautCalculéeDéfinir la formule SQL donnant la valeur par défaut de la rubrique.

Cas particulier : Décrire une clé composée
Lors de la description d'une clé composée par programmation, la propriété Type n'est pas obligatoire. Par contre, il est nécessaire d'utiliser la propriété FormuleClé pour décrire la composition de la clé composée.
Cas particulier : Décrire une clé primaire :
  • Il est nécessaire de spécifier avec la propriété TypeClé que la rubrique est une clé primaire.
  • Si la rubrique peut être nulle (propriété NullAutorisé à Vrai) et clé primaire, alors la propriété NullAutorisé de la rubrique sera automatiquement mise à Faux.
Cas particulier : Décrire une rubrique Combinaison ou Enumération :
  • Il est nécessaire d'utiliser la propriété DescriptionType pour définir le type utilisé par la rubrique.
  • Il est nécessaire de spécifier le type avec la propriété Type avant d'indiquer la valeur par défaut avec la propriété ValeurParDéfaut.
Cas particulier : Décrire une rubrique Horodatage :
  • La rubrique doit être de type DateHeure, Date ou Heure.
  • Il est nécessaire de spécifier le type d'horodatage avec la propriété TimestampType.
Cas particulier : Décrire une rubrique Formule :
Lors de la description d'une rubrique de type Formule par programmation, la propriété Type ne doit pas être utilisée. Il est nécessaire d'utiliser la propriété FormuleRubriqueCalculée pour décrire la formule de calcul.

Comment décrire des fichiers de données par programmation ?

Pour décrire des fichiers de données par programmation, il faut :
  1. Pour chaque fichier de données :
  2. Décrire si nécessaire les caractéristiques des liaisons grâce aux propriétés HFSQL.
  3. Valider si nécessaire la description de chaque liaison (fonction HDécritLiaison).

Manipulation des rubriques d'un fichier de données décrit par programmation

Lors de la création d'un fichier de données sous l'éditeur d'analyses, les noms du fichier de données et de ses rubriques sont automatiquement reconnus par le compilateur.
Lors de la création d'un fichier de données à l'aide d'une variable de type "Description de Fichier", les noms du fichier de données et de ses rubriques sont définis grâce à la propriété Nom. Ces noms ne sont pas automatiquement reconnus par le compilateur. L'utilisation de ces noms pour désigner le fichier de données ou ses rubriques provoque une erreur de compilation.
Pour que les noms du fichier de données décrit par programmation et de ses rubriques soient reconnus par le compilateur, il est nécessaire de déclarer le nom du fichier de données en tant que source de données. Ce fichier de données et ses rubriques pourront alors être manipulés par leur nom sous l'éditeur de code.
Par exemple :
UnFichier est une Description de Fichier
...
UnFichier.Nom = "CLIENT"
...
HDécritFichier("CLIENT")
...
CLIENT est une Source de Données
...
HLitPremier(CLIENT, "NOMCLI")
Remarque : Il est également possible de déclarer le nom du fichier de données avec le mot-clé Externe. Cependant, la vitesse d'exécution du traitement sera ralentie.

Journalisation

Lors de la description du fichier de données par programmation :
  • si le fichier de données est journalé et si aucune rubrique n'est journalée, toutes les rubriques (sauf les clés composées) sont automatiquement passées en journalées.
  • si le fichier de données est journalé et si au moins une rubrique est journalée, les autres rubriques ne sont pas modifiées.
Version minimum requise
  • Version 9
Documentation également disponible pour…
Commentaires
Cliquez sur [Ajouter] pour publier un commentaire

Dernière modification : 04/07/2023

Signaler une erreur ou faire une suggestion | Aide en ligne locale