9.19. Fonctions d'informations système

Le Tableau 9-39 présente diverses fonctions d'extraction d'informations relatives à la session et au système.

Tableau 9-39. Fonctions d'informations de session

NomType de retourDescription
current_database()nomnom de la base de données courante
current_schema()nomnom du schéma courant
current_schemas(boolean)nom[]nom des schémas dans le chemin de recherche, avec optionnellement les schémas implicites
current_usernomnom d'utilisateur du contexte d'exécution courant
inet_client_addr()inetadresse de la connexion distante
inet_client_port()int4port de la connexion distante
inet_server_addr()inetadresse de la connexion locale
inet_server_port()int4port de la connexion locale
session_usernamenom de l'utilisateur de la session
usernameéquivalent à current_user
version()textinformations de version de PostgreSQL

session_user est habituellement l'utilisateur qui a initié la connexion à la base de données ; mais les superutilisateurs peuvent modifier ce paramétrage avec SET SESSION AUTHORIZATION. current_user est l'identifiant de l'utilisateur, utilisable pour les vérifications de permissions. Il est habituellement identique à l'utilisateur de la session mais il change pendant l'exécution des fonctions comprenant l'attribut SECURITY DEFINER. Dans le vocable Unix, l'utilisateur de la session est le << real user >> (NdT : l'utilisateur réel) et l'utilisateur en cours est l'<< effective user >> (NdT : l'utilisateur effectif) .

Note : current_user, session_user et user ont un statut syntaxique spécial en SQL : ils doivent être appelés sans parenthèses à droite.

current_schema renvoie le nom du premier schéma dans le chemin de recherche (ou une valeur NULL si ce dernier est vide). C'est le schéma utilisé pour toute création de table ou autre objet nommé sans précision d'un schéma cible. current_schemas(boolean) renvoie un tableau qui contient les noms de tous les schémas du chemin de recherche. L'option booléenne indique si les schémas système implicitement inclus, comme pg_catalog, doivent être inclus dans le chemin de recherche retourné.

Note : Le chemin de recherche est modifiable à l'exécution. La commande est :

SET search_path TO schema [, schema, ...]

inet_client_addr renvoie l'adresse IP du client courant et inet_client_port le numéro du port. inet_server_addr renvoie l'adresse IP sur laquelle le serveur a accepté la connexion courante et inet_server_port le numéro du port. Toutes ces fonctions renvoient NULL si la connexion courante est établie via une socket de domaine Unix.

version() renvoie une chaîne qui décrit la version du serveur PostgreSQL.

Tableau 9-40 liste les fonctions qui permettent aux utilisateurs de consulter les privilèges d'accès. Voir la Section 5.7> pour plus d'informations sur les privilèges.

Tableau 9-40. Fonctions de consultation des privilèges d'accès

NomType de retourDescription
has_table_privilege(utilisateur, table, privilège) booleanutilisateur a-t-il le privilège privilège sur table
has_table_privilege(table, privilege) booleanl'utilisateur courant a-t-il le privilège privilège sur table
has_database_privilege (utilisateur, base, privilège) booleanutilisateur a-t-il le privilège privilège sur base
has_database_privilege (base, privilège) booleanl'utilisateur courant a-t-il le privilège privilège sur base
has_function_privilege (utilisateur, fonction, privilège) booleanutilisateur a-t-il le privilège privilège sur fonction
has_function_privilege (fonction, privilège) booleanl'utilisateur courant a-t-il e privilège privilège sur fonction
has_language_privilege (utilisateur, langage, privilège) booleanutilisateur a-t-il le privilège privilège sur langage
has_language_privilege (langage, droit) booleanl'utilisateur courant a-t-il le privilège privilège sur langage
has_schema_privilege(utilisateur, schéma, privilège) booleanutilisateur a-t-il le privilège privilège sur schéma
has_schema_privilege(schéma, privilège) booleanl'utilisateur courant a-t-il le privilège privilège sur schéma
has_tablespace_privilege (utilisateur, tablespace, privilège) booleanutilisateur a-t-il le privilège privilège sur tablespace
has_tablespace_privilege (tablespace, privilège) booleanl'utilisateur courant a-t-il le privilège privilège sur tablespace

has_table_privilege vérifie si l'utilisateur peut accéder à une table d'une façon particulière. L'utilisateur peut être spécifié par son nom ou par son ID (pg_user.usesysid). Si l'argument est omis, current_user est supposé. La table peut être spécifiée par nom ou par OID. (Du coup, il n'y a que six variantes de has_table_privilege pouvant être distingué par leur nombre et le types de leurs arguments.) En spécifiant un nom, il est possible de le qualifier par celui du schéma si nécessaire. Le type de droit d'accès désiré est spécifié par une chaîne de texte qui doit être évalué par une des valeurs SELECT, INSERT, UPDATE, DELETE, RULE, REFERENCES ou TRIGGER. (Néanmoins, la casse de la chaîne n'est pas significative.) Voici un exemple :

          SELECT has_table_privilege('mon_schema.ma_table', 'select');
        

has_database_privilege vérifie si l'utilisateur peut accéder à une base de données d'une façon particulière. Les possibilités pour ses arguments sont analogues à has_table_privilege. Le type de droit d'accès désiré doit être évalué à CREATE, TEMPORARY ou TEMP (ce qui est équivalent à TEMPORARY).

has_function_privilege vérifie si un utilisateur peut accéder à une fonction d'une façon particulière. Les possibilités pour ses arguments sont analogues à has_table_privilege. En spécifiant une fonction par une chaîne texte plutôt que par son OID, l'entrée autorisée est identique au type de données regprocedure (voir Section 8.12). Le type de droit d'accès désiré doit s'évaluer à EXECUTE. Voici un exemple :

          SELECT has_function_privilege('joeuser', 'myfunc(int, text)', 'execute');
        

has_language_privilege vérifie si un utilisateur peut accéder à un langage de procédures d'une façon particulière. Les possibilités pour ses arguments sont analogues à has_table_privilege. Le type de droit d'accès désiré doit s'évaluer à USAGE.

has_schema_privilege vérifie si un utilisateur peut accéder à un schéma d'une façon particulière. Les possibilités pour ses arguments sont analogues à has_table_privilege. Le type de droit d'accès désiré doit s'évaluer à CREATE ou USAGE.

has_tablespace_privilege vérifie si un utilisateur peut accéder à un tablespace d'une façon particulière. Les possibilités pour ses arguments sont analogues à has_table_privilege. Le type de droit d'accès désiré doit s'évaluer à CREATE.

Pour tester si un utilisateur détient une option grant sur le droit, ajoutez WITH GRANT OPTION au mot clé du droit ; par exemple 'UPDATE WITH GRANT OPTION'.

Tableau 9-41 affiche les fonctions qui déterminent si un certain objet est visible dans le chemin de recherche en cours. Une table est dite visible si son schéma contenant est dans le chemin de recherche et qu'aucune table du même nom apparaît avant dans le chemin de recherche. Ceci est équivalent à au fait que la table peut être référencée par nom sans qualification explicite de schéma. Par exemple, pour lister les noms de toutes les tables visibles :

          SELECT relname FROM pg_class WHERE pg_table_is_visible(oid);
        

Tableau 9-41. Fonctions de requêtes sur la visibilité du schéma

NomType de retourDescription
pg_table_is_visible(table_oid) booleanla table est-elle visible dans le chemin de recherche
pg_type_is_visible(type_oid) booleanle type (ou domaine) est-il visible dans le chemin de recherche
pg_function_is_visible (function_oid) booleanla fonction est-elle visible dans le chemin de recherche
pg_operator_is_visible (operator_oid) booleanl'opérateur est-il visible dans le chemin de recherche
pg_opclass_is_visible (opclass_oid) booleanla classe d'opérateur est-elle visible dans le chemin de recherche
pg_conversion_is_visible (conversion_oid) booleanla conversion est-elle visible dans le chemin de recherche

pg_table_is_visible réalise la vérification pour les tables (ou vues, ou tout autre type d'entrée dans pg_class). pg_type_is_visible, pg_function_is_visible, pg_operator_is_visible, pg_opclass_is_visible et pg_conversion_is_visible réalisent le même type de vérification de visibilité respectivement pour les types (et domaines), les fonctions, les opérators, les classes d'opérateurs et les conversions. Pour les fonctions et opérateurs, un objet dans le chemin de recherche est visible s'il n'y a aucun objet du même nom et de même type de données pour les arguments précédemment dans le chemin. Pour les classes d'opérateurs, les méthodes d'accès par le nom et par l'index associé sont considérées.

Toutes ces fonctions nécessitent que les OID des objets identifient l'objet à vérifier. Si vous voulez tester un objet par son nom, il est préférable d'utiliser les types d'alias d'OID (regclass, regtype, regprocedure ou regoperator), par exemple

  SELECT pg_type_is_visible('mon_schema.widget'::regtype);

Notez qu'il n'y aurait aucun sens à tester un nom non qualifié de cette façon — si le nom peut être reconnu, il doit être visible.

Tableau 9-42 liste les fonctions qui extraient des informations à partir des catalogues système.

Tableau 9-42. Fonctions d'information sur le catalogue système

NomType de retourDescription
format_type (type_oid, typemod)textobtient le nom SQL d'un type de données
pg_get_viewdef(view_name)textrécupère la commande CREATE VIEW de la vue (obsolète)
pg_get_viewdef (view_name, pretty_bool)textrécupère la commande CREATE VIEW pour la vue (obsolète)
pg_get_viewdef(view_oid)textrécupère la commande CREATE VIEW pour la vue
pg_get_viewdef (view_oid, pretty_bool)textrécupère la commande CREATE VIEW pour la vue
pg_get_ruledef(rule_oid)textgrécupère la commande CREATE RULE pour la règle
pg_get_ruledef (rule_oid, pretty_bool)textrécupère la commande CREATE RULE pour la règle
pg_get_indexdef (index_oid)textrécupère la commande CREATE INDEX pour l'index
pg_get_indexdef (index_oid, column_no, pretty_bool)textrécupère la commande CREATE INDEX pour l'index, ou une définition d'une seule colonne de l'index quand column_no est différent de zéro
pg_get_triggerdef(trigger_oid)textrécupère la commande CREATE [ CONSTRAINT ] TRIGGER pour le déclencheur
pg_get_constraintdef (constraint_oid)textrécupère la définition d'une contrainte
pg_get_constraintdef(constraint_oid, pretty_bool)textrécupère la définition d'une contrainte
pg_get_expr(expr_text, relation_oid)textdécompile la forme interne d'une expression, en supposant que toute Var compris en lui fait référence à la relation indiquée dans le deuxième paramètre
pg_get_expr(expr_text, relation_oid, pretty_bool)textdécompile la forme interne d'une expression, en supposant que toute Var compris en lui fait référence à la relation indiquée dans le deuxième paramètre
pg_get_userbyid(userid)namerécupère le nom de l'utilisateur suivant l'ID donné
pg_get_serial_sequence (table_name, column_name)textrécupère le nom de la séquence qu'une colonne serial ou bigserial utilise
pg_tablespace_databases (tablespace_oid)setof oidrécupère un ensemble d'OID de la base de données ayant des objets dans le tablespace

format_type renvoie le nom SQL d'un type de données qui est identifié par son OID de type et peut-être par un modificateur de type. Passez NULL au modificateur de type si aucun modificateur spécifique n'est connu.

pg_get_viewdef, pg_get_ruledef, pg_get_indexdef, pg_get_triggerdef et pg_get_constraintdef reconstruisent la commande de création pour, respectivement, une vue, une règle, un index, un déclencheur ou une contrainte. (Notez que ceci est une reconstruction décompilée, pas le texte original de la commande.) pg_get_expr décompile la forme interne d'une expression individuelle, comme la valeur par défaut d'une colonne. Cela pourrait être utilisé lors de l'examen du contenu des catalogues systèmes. La plupart de ces fonctions viennent en deux variantes, une qui peut << afficher joliment >> le résultat (en option). Ce format est plus lisible mais le format par défaut a plus de chances d'être interprété de la même façon par les versions futures de PostgreSQL ; évitez d'utiliser ce format pour réaliser des sauvegardes. Passer false pour le paramètre de joli affichage renvoie le même résultat que la variante qui n'a pas ce paramètre.

pg_get_userbyid extrait le nom d'un utilisateur à partir de son identifiant. pg_get_serial_sequence récupère le nom de la séquence associée avec une colonne de type serial ou bigserial. Le nom est convenablement formaté pour être passé aux fonctions sur les séquences (voir Section 9.12). NULL est renvoyé si la colonne n'a pas de séquence attachée.

pg_tablespace_databases autorise l'examen de l'usage d'un tablespace. Elle renverra un ensemble d'OID des bases de données contenant des objets dans le tablespace. Si cette fonction renvoie des lignes, le tablespace n'est pas vide et ne peux pas être supprimé. Pour afficher les objets spécifiques peuplant le tablespace, vous aurez besoin de vous connecter aux bases de données identifiées par pg_tablespace_databases et de demander leurs catalogues pg_class.

Les fonctions affichées dans Tableau 9-43 extraient des commentaires stockés précédemment avec la commande COMMENT. Une valeur NULL est renvoyée si aucun commentaire ne correspond aux paramètres spécifiés.

Tableau 9-43. Fonctions d'informations sur les commentaires

NomType de retourDescription
obj_description (object_oid, catalog_name)textrécupère un commentaire à partir d'un objet de la base de données
obj_description(object_oid)textrécupère un commentaire à partir d'un objet de la base de données (obsolète)
col_description (table_oid, column_number)textrécupère un commentaire sur une colonne d'une table

La forme à deux paramètres de obj_description renvoie le commentaire d'un objet de la base de données, spécifié par son OID et le nom du catalogue système le contenant. Par exemple, obj_description(123456,'pg_class') récupérerait le commentaire pour une table d'OID 123456. La forme à un paramètre de obj_description requiert seulement l'OID de l'objet. Elle est maintenant obsolète car il n'existe aucune garantie que les OID soient uniques au travers des différents catalogues système ; du coup, un mauvais commentaire pourrait être renvoyé.

col_description renvoie un commentaire pour une colonne de la table, spécifié par l'OID de la table et le numéro de la colonne. obj_description ne peut pas être utilisé pour les colonnes de table car les colonnes ne disposent d'OID.