Bureau

Console système

Exécuter un script Python ou une requête SQL en lecture depuis le bureau avec la console système, réservée aux responsables système.

Console système

La Console système exécute un script Python ou une requête SQL sur votre site, depuis le bureau. Elle sert au diagnostic et aux corrections ponctuelles de données.

Un script Python peut modifier ou supprimer des données de tout le site. Testez d'abord sans Ecrire dans la base de données, et faites une sauvegarde avant une correction.

Prérequis

  • Avoir le rôle Responsable système.
  • Pour le type Python : les scripts serveur doivent être activés sur le serveur (clé server_script_enabled dans common_site_config.json). Sinon, l'exécution s'arrête avec l'erreur « Server Scripts Disabled ». Voir Scripts Python.

Exécuter un script

  1. Ouvrez la recherche (Ctrl+K) et saisissez Console système.
  2. Choisissez le Type : Python (par défaut) ou SQL.
  3. Saisissez le code dans le champ Console.
  4. Cochez Ecrire dans la base de données si le script Python doit enregistrer ses modifications.
  5. Cliquez sur Exécuter, ou appuyez sur Maj+Entrée.

Le Résultat affiche ce que le script écrit avec print(), ou la trace de l'erreur. Pour le type SQL, le résultat s'affiche aussi sous forme de tableau.

Ce qu'il faut savoir

PointComportement
Environnement PythonLe même que celui des scripts Python : les imports sont interdits, seule l'API autorisée est disponible (frappe.get_doc, frappe.db.get_value…).
ÉcritureSans Ecrire dans la base de données, Dokos annule toutes les modifications à la fin du script. En cas d'erreur, il les annule toujours.
SQLLa requête s'exécute dans une transaction en lecture seule. Une requête UPDATE ou DELETE échoue.
HistoriqueChaque exécution crée un Journal de la console avec le script, le type et l'indication d'écriture.
ProcessusCochez Afficher la liste des processus pour voir les requêtes en cours dans la base de données.

La touche Maj+T ouvre une console déroulante, depuis n'importe quelle page du bureau, pour les utilisateurs qui peuvent modifier la console système.

Exemple

Exemple fictif. Vous voulez compter les clients sans adresse e-mail.

Avec le type SQL :

SELECT COUNT(*) AS total FROM `tabCustomer` WHERE IFNULL(email_id, '') = ''

Avec le type Python :

clients = frappe.get_all("Customer", filters={"email_id": ["is", "not set"]}, pluck="name")
print(len(clients))

Le Résultat affiche le nombre de clients concernés. Aucune donnée n'est modifiée.