aboutsummaryrefslogtreecommitdiff
path: root/Documentation/usage/commands/timetables.rst
diff options
context:
space:
mode:
authorAlban Gruin2018-04-25 21:18:25 +0200
committerAlban Gruin2018-04-25 21:18:25 +0200
commit1789cbf1dcf555b35785e47237fb0a1f95720a45 (patch)
treee1645a307ee790bdd50751c8bde5694890e0257b /Documentation/usage/commands/timetables.rst
parent81046d1e44380fd961efbc308a85d134f33d2bab (diff)
parent4c82869e3a590c982c43958e3e4b0f9fad440678 (diff)
Merge branch 'futur'
Diffstat (limited to 'Documentation/usage/commands/timetables.rst')
-rw-r--r--Documentation/usage/commands/timetables.rst44
1 files changed, 44 insertions, 0 deletions
diff --git a/Documentation/usage/commands/timetables.rst b/Documentation/usage/commands/timetables.rst
new file mode 100644
index 0000000..723b5aa
--- /dev/null
+++ b/Documentation/usage/commands/timetables.rst
@@ -0,0 +1,44 @@
+==============
+``timetables``
+==============
+
+``timetables`` met à jour les emplois du temps présents dans la base
+de données.
+
+Il est fortement recommandé d’exécuter régulièrement cette commande
+:ref:`à l’aide d’une tâche cron <ref-cron>`.
+
+Utilisation
+===========
+.. code:: shell
+
+ $ ./manage.py timetables [--all] [--force] [--week week] [--year year]
+
+Par défaut, ``timetables`` met à jour seulement la semaine courante ou
+à venir le week-end, et ne met pas à jour si la dernière mise à jour
+présente dans la base de données est plus récente que celle présente
+dans la source. Les différents paramètres permettent de contrôler ce
+comportement :
+
+``--all`` permet de mettre à jour toutes les semaines présentes dans
+la source.
+
+``--force`` force la mise à jour, même si la dernière mise à jour des
+emplois du temps présente dans la base de données est plus récente que
+celle présente dans la source.
+
+``--week`` permet de spécifier la semaine à mettre à jour.
+
+``--year`` permet de spécifier l’année à mettre à jour.
+
+Comportement
+============
+Pour chaque emploi du temps, ``timetables`` récupère la source,
+supprime les cours sur la période couverte par cette mise à jour,
+parse la source et insère les cours dans la base de données.
+
+Cette mise à jour est effectuée de manière transactionnelle : si la
+mise à jour d’une source échoue au milieu du processus, les données
+supprimées au début seront entièrement restaurées, les données
+rajoutées seront supprimées, et une erreur sera affichée. Cela
+n’affecte pas la mise à jour des autres emplois du temps.