9.20. Fonctions d'administration système

La fonction current_setting renvoie la valeur courante du paramètre nom_paramètre . Elle correspond à la commande SQL SHOW . Un exemple :

SELECT current_setting('datestyle');

 current_setting
-----------------
ISO, MDY
(1 row)

set_config configure le paramètre nom_paramètre avec nouvelle_valeur . Si est_locale vaut true, la nouvelle valeur s'appliquera seulement à la transaction en cours. Si vous voulez que la nouvelle valeur s'applique à la session en cours, utilisez false à la place. La fonction correspond à la commande SQL SET . Un exemple :

SELECT set_config('log_statement_stats', 'off', false);

 set_config
------------
off
(1 row)

Chacune de ces fonctions renvoient true en cas de succès, false en cas d'échec.

pg_cancel_backend envoie un signal demandant l'annulation de la requête (SIGINT) à un processus serveur identifié par l'ID du processus. L'identifiant du processus d'un serveur actif peut se trouver à partir de la colonne procpid dans la vue pg_stat_activity ou en listant les processus postgres sur le serveur avec ps.

pg_reload_conf envoie un signal SIGHUP au serveur impliquant un nouveau chargement des fichiers de configuration pour tous les processus serveur.

pg_rotate_logfile signale au gestionnaire de journaux de trace de basculer immédiatement vers un nouveau fichier de sortie. Ceci fonctionne seulement quand redirect_stderr est utilisé pour les traces, sinon il n'y a pas de sous-processus de gestion des traces.

pg_start_backup accepte un seul paramètre qui est un label défini arbitrairement par l'utilisateur pour la sauvegarde (typiquement, cela sera le nom sous lequel le fichier de sauvegarde sera stocké). La fonction écrit un fichier label dans le répertoire de données du groupe, puis renvoie le décalage du journal de transactions de début de sauvegarde au format texte (l'utilisateur n'a pas besoin de faire attention à la valeur du résultat mais il est fourni au cas où il pourrait être utile).

postgres=# select pg_start_backup('label_goes_here');
 pg_start_backup
-----------------
 0/D4445B8
(1 row)

pg_stop_backup supprime le fichier label créé par pg_start_backup et crée, à la place, un fichier historique dans l'emplacement des archives des journaux de transactions. Ce fichier inclut le label donné à pg_start_backup, les emplacements de début et de fin des journaux de transactions pour la sauvegarde ainsi que les heures de début et de fin de la sauvegarde. La valeur en retour est l'emplacement du journal de transactions de fin (qui a de nouveau peu d'intérêt). Après avoir noté l'emplacement de fin, le point d'insertion du journal de transactions actuel est automatiquement avancé au prochain journal de transactions, de façon à ce que le journal de transactions en fin de vie puisse être archivé immédiatement pour terminer la sauvegarde.

pg_column_size affiche l'espace utilisé pour stocker toute valeur individuelle.

pg_database_size et pg_tablespace_size acceptent l'OID ou le nom d'une base de données ou d'un tablespace, et renvoient l'espace disque total utilisé.

pg_relation_size accepte l'OID ou le nom d'une table, d'un index ou d'une table toast, et renvoie la taille en octet.

pg_size_pretty peut être utilisé pour formater le résultat d'une des autres fonctions d'une façon lisible par un être humain, c'est-à-dire en utilisant kB, MB, GB ou TB lorsque cela est approprié.

pg_total_relation_size accepte l'OID ou le nom d'une table ou d'une table toast, et renvoie la taille en octets des données et de tous les index et tables toast associées.

pg_ls_dir renvoie tous les noms du répertoire spécifié sauf les entrées spéciales «  .  » et «  ..  ».

pg_read_file renvoie une partie d'un fichier texte, débutant au décalage indiqué, renvoyant au plus longueur octets (moins si la fin du fichier est atteinte avant). Si le décalage est négatif, il est relatif à la fin du fichier.

pg_stat_file renvoie un enregistrement contenant la taille du fichier, la date et heure du dernier accès, la date et heure de la dernière modification, la date et heure du dernier changement de statut (plateformes Unix seulement), la date et heure de création (Windows seulement) et un booléen indiquant s'il s'agit d'un répertoire. Les usages typiques incluent :

SELECT * FROM pg_stat_file('nomfichier');
SELECT (pg_stat_file('nomfichier')).modification;

pg_advisory_lock verrouille une ressource définie par l'application qui peut être identifiée soit par une valeur de clé sur 64 bits soit par deux valeurs de clé sur 32 bits (notez que les deux espaces de clé ne se surchargent pas). Si une autre session détient déjà un verrou sur la même ressource, la fonction attendra jusqu'à ce que la ressource devienne disponible. Le verrou est exclusif. Les demandes de verrous s'empilent pour que, si une même ressource est verrouillée trois fois, elle doit être déverrouillée trois fois pour être disponible par les autres sessions.

pg_advisory_lock_shared fonctionne de façon identique à pg_advisory_lock sauf que le verrou peut être partagé avec d'autres sessions qui réclament des verrous partagés. Seuls les demandes de verrous exclusifs sont bloqués.

pg_try_advisory_lock est similaire à pg_advisory_lock sauf que la fonction n'attendra pas la disponibilité du verrou. Soit il obtiendra le verrou immédiatement et renverra true, soit il ne l'obtiendra pas et il renverra false.

pg_try_advisory_lock_shared fonctionne de la même façon que pg_try_advisory_lock sauf s'il tente d'acquérir un verrou partagé au lieu d'un verrou exclusif.

pg_advisory_unlock lâchera un verrou informatif exclusif précédemment acquis. Il renverra true si le verrou est relaché avec succès. Si le verrou n'était pas détenu, false sera renvoyé. De plus, un message d'avertissement SQL sera émis par le serveur.

pg_advisory_unlock_shared fonctionne de la même façon que pg_advisory_unlock sauf pour relacher un verrou informatif partagé.

pg_advisory_unlock_all relachera tous les verrous informatifs détenus par la session courante. (Cette fonction est appelée implicitement à la fin de la session, même si le client se déconnecte d'une mauvaise façon.)