Documentation Frappe Framework
Frappe Framework
Bench : référence des commandes
Ce chapitre est la référence des commandes bench : new-site, drop-site, migrate, backup, restore, set-config, execute, trim-database, fichiers PO, etc.
Contenu du chapitre
Ce chapitre est la référence des commandes bench : new-site, drop-site, migrate, backup, restore, set-config, execute, trim-database, fichiers PO, etc.
Pages de ce chapitre, dans l’ordre de la documentation officielle :
- Référence des commandes
- bench new-site
- bench drop-site
- bench migrate
- bench backup
- bench reinstall
- bench list-apps
- bench uninstall-app
- bench show-config
- bench set-config
- bench execute
- bench restore
- bench partial-restore
- bench version
- bench transform-database
- bench trim-database
- bench trim-tables
- bench generate-pot-file
- bench migrate-csv-to-po
- bench update-po-files
- bench compile-po-to-mo
Dans ce chapitre
- 01Référence des commandesCette page classe les commandes accessibles par le CLI : sites, utilitaires, base de données et traductions.
- 02bench new-siteLa commande crée un dossier sous sites et une base avec les modules Frappe. En cas d’échec, on peut annuler dossier, base et utilisateur.
- 03bench drop-siteLa commande supprime la base, déplace le dossier du site vers archived_sites et prend d’abord une sauvegarde complète.
- 04bench migrateLa commande aligne le site sur les applications disponibles : patches, schéma, fixtures, traductions, puis les hooks de fin de migration.
- 05bench backupLa commande sauvegarde le site indiqué, ou le site courant. Le dump va dans private/backups, sauf chemin contraire.
- 06bench reinstallLa commande efface les données d’un site MariaDB et le réinstalle avec les applications actuelles. Une confirmation est demandée.
- 07bench list-appsLa commande liste les applications installées sur un site, ou sur tous les sites, à partir du DocType Installed Applications.
- 08bench uninstall-appLa commande retire une application du site et les DocTypes et modules liés. L’application n’a pas besoin d’être installée sur le bench.
- 09bench show-configLa commande montre les valeurs frappe.conf appliquées à un site, en texte ou en JSON, après fusion des deux fichiers de configuration.
- 10bench set-configLa commande insère ou met à jour une clé de configuration du site ou du bench. Le type de la valeur dépend de l’écriture et de --parse.
- 11bench executeSuccès : commit et valeur en JSON. Erreur : rollback et code de sortie. N’importe quelle fonction part, pas seulement celles en liste blanche.
- 12bench restoreLa commande recharge la base depuis un fichier sql ou sql.gz. Les archives de fichiers sont en tar, ou en tgz depuis la version 13.
- 13bench partial-restoreLa commande restaure un site à partir d’un fichier SQL partiel, gzip ou texte, en ne rechargeant que les tables sauvegardées.
- 14bench versionLa commande résume les applications installées dans le répertoire bench : version, branche et commit, en texte, tableau ou JSON.
- 15bench transform-databaseLa commande change le moteur ou le format de ligne de tables MariaDB. Elle sert surtout à quitter ROW_FORMAT COMPRESSED.
- 16bench trim-databaseLa commande supprime les tables restées en base après la disparition d’un DocType. Elle tente une sauvegarde partielle avant de les détruire.
- 17bench trim-tablesLa commande nettoie les colonnes laissées en base quand un champ a été retiré d’un DocType. Elle sauvegarde toute la base avant de modifier le schéma.
- 18bench generate-pot-fileLa commande produit le modèle de traduction d’une application : toutes les chaînes traduisibles, aucune traduction, dans locale/main.pot.
- 19bench migrate-csv-to-poLa commande sert une seule fois, au passage de l’ancien système CSV vers les fichiers PO. Un fichier POT doit déjà exister.
- 20bench update-po-filesLa commande resynchronise les fichiers de traduction PO avec le modèle POT, après une régénération des chaînes traduisibles.
- 21bench compile-po-to-moLes traductions lisibles des fichiers PO deviennent des fichiers binaires MO. La commande saute la compilation si le MO est déjà plus récent.