aboutsummaryrefslogtreecommitdiff
path: root/readme.rst
diff options
context:
space:
mode:
Diffstat (limited to 'readme.rst')
-rw-r--r--readme.rst46
1 files changed, 33 insertions, 13 deletions
diff --git a/readme.rst b/readme.rst
index 0e1c956..b14e98b 100644
--- a/readme.rst
+++ b/readme.rst
@@ -145,16 +145,22 @@ Fichier de configuration
Les informations générales
--------------------------
-version
+dataset
+ Il s’agit d’un chemin vers un fichier listant tous les fichiers à utiliser.
+ Quand cet clef est définie, l’application ira chercher les fichier aux
+ emplacements définis ici, et il n’est plus nécessaire de définir les clef
+ `file` dans le reste de la configuration.
- Il s’agit de la version de la syntaxe du fichier de configuration. Valeur par
- défaut : `1`
+ Son utilité prend son sens quand un nouveau jeu de données doit être traité,
+ et plusieurs règles doivent être exécutées : il suffit alors de changer les
+ chemins dans le dataset et uniquement dans ce fichier.
source
La clef `source` indique quel est le fichier source : pour chaque ligne
présente dans ce fichier, une ligne sera générée en sortie.
- :file: le fichier à charger
+ :file: le fichier à charger. Ce champ peut être ignoré si le dataset est
+ renseigné
:tab: optionnellement l’onglet concerné
:name: le nom sous lequel le fichier sera associé.
@@ -186,7 +192,8 @@ fichier :
intern_key
Il s’agit de la colonne servant à faire la liaison dans la source.
file
- Le fichier à charger
+ Le fichier à charger. Ce champ peut être ignoré si le dataset est
+ renseigné.
tab
optionnellement l’onglet concerné
extern_key
@@ -198,6 +205,13 @@ allow_missing
Cette clef optionnelle indique s’il faut autoriser les valeurs manquantes
lors dans une liaison. Déclarer `allow_missing` va également autoriser les
doublons sur les valeurs de clef.
+filters
+ Il s’agit d’une liste d’expression devant être validées pour que la ligne
+ soit prise en compte.
+
+ .. include:: examples/externals_filters.toml
+ :code: toml
+ :class: collapse
Une fois la dépendance vers un fichier externe déclaré, il est possible
d’utiliser les colonnes de ce fichier en les référençant directement. Cela
@@ -208,16 +222,15 @@ afin de construire des chemins sur plusieurs niveaux :
.. code:: toml
- [externals.acheteur_annuaire]
+ [externals.annuaire]
intern_key = ":I"
- extern_key = ":A"
file = "ANNUAIRE.xlsx"
-
- [externals.acheteur_societe]
- intern_key = ":acheteur_annuaire.BJ"
extern_key = ":A"
- file = "SOCIETES.xlsx"
+ [externals.country]
+ intern_key = ":annuaire.BJ"
+ file = "referentials.xlsx"
+ extern_key = ":A"
Les valeurs présentes dans ces colonnes sont pré-traitées pour éviter les
erreurs générales lors des imports : les espaces en fin de texte sont
@@ -331,6 +344,10 @@ résultat selon que l’on filtre :
colonne B ≠ 0
2. d’abord sur la colonne B ≠ 0, puis la plus grande valeur de la colonne A.
+.. include:: examples/importer_groupe.toml
+ :code: toml
+ :class: collapse
+
Exemple complet
===============
@@ -396,10 +413,13 @@ partir de plusieurs tables.
# La table des immatriculations.
# Seules les lignes avec la colonne D = 4 nous intéressent
[externals.immat]
- intern_key = ":A ^ '_4'"
+ intern_key = ":A"
file = "20220222_SO_IMMATRICULATION.xlsx"
- extern_key = ":B ^ '_' ^ :D"
+ extern_key = ":B"
allow_missing = true
+ filters = [
+ ":D = 4"
+ ]
[sheet]
columns = [