psql

Si le format de sortie de la table courante n'est pas aligné, le transforme en aligné. Et l'inverse pour le rendre non aligné. Cette commande est conservée pour des raisons de compatibilité d'arrière-plan. Voir \pset pour une solution générale.

Change le répertoire de travail courant en répertoire. Sans argument, change le répertoire home de l'utilisateur courant.

Pour afficher votre répertoire de travail courant, utilisez \!pwd.

Place le titre de certaines tables comme le résultat affiché d'une requête ou enlève ces titres. Cette commande est équivalente à \pset titre titre. (Le nom de cette commande vient de "caption", et était seulement utilisée précédemment pour placer l'en-tête (caption) dans une table HTML).

Etablit une connexion à une nouvelle base et/ou sous un nom d'utilisateur. La connexion précédente est fermée. Si dbname est - le nom de la base courante est supposé.

Si username est omis le nom de l'utilisateur courant est supposé.

Comme règle spéciale, \connect sans autre argument se connectera à la base par défaut comme à l'utilisateur par défaut (ceux que vous aurez donné au lancement de psql sans autres arguments).

Si la tentative de connexion échoue (mauvais nom d'utilisateur, accès interdit, etc.), la connexion précédente est conservée si et seulement si psql est en mode interactif. En mode de script non-interactif, l'exécution stoppera immédiatement avec une erreur. Cette distinction fut choisie pour des raisons de commodité utilisateur.

Exécute une copie cliente. C'est une opération qui lance une commande SQL COPY, mais au lieu de la lecture ou de l'écriture du fichier spécifique par le serveur, et en conséquence nécessitant des accès au serveur et des droits d'utilisateur spécial, aussi bien qu'étant limité au fichier système accessible par le serveur, psql lit ou écrit le fichier et route les données entre le serveur et le fichier système local.

La syntaxe de la commande est similaire à la commande SQL COPY (voir sa description pour les détails). Notez que, à cause de ça, des règles d'analyse spéciales s'appliquent à la commande \copy. En particulier, les règles de substitution variables et les backslashes d'échappement ne s'appliquent pas.

Cette opération n'est pas aussi efficace que la commande SQL COPY car toutes les données doivent passer à travers une connexion IP client/serveur ou socket. Pour de gros volumes de données l'autre technique peut être préférable.

Notez la différence dans l'interprétation de stdin et stdout entre les copies du serveur et du client : dans une copie cliente elle se réfère toujours aux entrées/sorties de psql. Sur une copie serveur stdin la commande COPY provient de n'importe où (par exemple, un script lancé avec l'option -f), et stdout se réfère à la sortie de la requête (voir la meta-commande \o plus bas).

Affiche le copyright et les termes de distribution de PostgreSQL.

Affiche toutes les colonnes de la relation (laquelle peut être une table, une vue, un index ou une séquence), leurs types, et certains attributs spéciaux comme NOT NULL. Si la relation est, en fait, une table, certains indexes définis, les clés primaires, les contraintes uniques et les vérification de contrainte sont aussi affichées. Si la relation est une vue, la définition de la vue est aussi affichée.

La commande \d+ est identique, mais certains commentaires associés aux colonnes de la table sont également affichés.

Si \d est appelé sans aucun argument, c'est équivalent à \dtvs lequel affichera une liste de toutes les tables, vues et séquences. Ceci est une mesure de pur confort.

Liste toutes les fonctions agrégat disponibles, avec les types opérant ensemble. Si pattern (une expression régulière) est spécifié, seuls les agrégats appariés sont indiqués.

Affiche les descriptions de object (lequel peut être une expression régulière), ou tous les objets si aucun argument n'est fourni. ("Object" couvre les agrégats, fonctions, operateurs, types, relations (tables, vues, indexes, séquences, objets longs), règles, et déclencheurs). Par exemple :

=> \dd version
              Object descriptions
  Name   |   What   |        Description
---------+----------+---------------------------
 version | function | PostgreSQL version string
(1 row)

Les descriptions des objets peuvent être générées par la commande SQL COMMENT ON.

PostgreSQL stocke les descriptions d'objets dans la table système pg_description.

Affiche les fonctions disponibles, avec leur argument et les types retour. Si pattern (une expression régulière) est spécifié, seules les fonctions appariées sont affichées. Si la forme \df+ est utilisée, des informations supplémentaires sur chaque fonction, incluant langage et description, sont affichées.

Ce n'est pas le nom de commande actuel : les lettres i, s, t, v, S correspondent à index, séquence, table, vue et table système respectivement. Vous pouvez en spécifier certains ou tous afin d'en obtenir une liste, avec le propriétaire.

Si pattern est spécifié, c'est une expression régulière qui restreint l'affichage aux objets dont le nom s'apparie. Si un "+" est joint au nom de commande, chaque objet est affiché avec sa description associée, s'il y a lieu.

C'est un alias pour \lo_list, qui affiche une liste d'objets longs.

Affiche les opérateurs disponibles avec leurs opérandes et types retour. Si name est spécifié, seuls les opérateurs avec ce nom seront affichés.

C'est un alias pour \z lequel fut inclu pour sa forte valeur mnémonique ("affiche les droits").

Affiche tous les types ou seulement ceux qui apparient pattern. La commande \dT+ affiche des informations supplémentaires.

Affiche tous les utilisateurs configurés ou seulement ceux qui apparient pattern.

Si nom de fichier est spécifié, le fichier est édité; ensuite son contenu est copié vers le tampon de requête. Si aucun argument n'est donné, le tampon de requête courant est copié vers un fichier temporaire qui est alors édité de la même façon.

le nouveau tampon de requête est alors re-analysé selon les règles normales de psql, où le tampon complet est traité sur une seule ligne. (Ainsi vous ne pouvez réaliser des scripts de cette façon. Utilisez \i pour ça). Ceci indique aussi que si la requête se termine avec (ou au moins contient) un point-virgule, elle sera immédiatement exécutée. Dans d'autres cas elle sera tout simplement en attente dans le tampon de requête.

psql recherche les variables d'environnement PSQL_EDITOR, EDITOR, et VISUAL (dans cet ordre) pour usage d'édition. Si aucune n'est placée /bin/vi est lancé.

Affiche les arguments vers la sortie standard, séparés par un espace et suivis par un saut de ligne. Ceci peut être utile pour l'information entremêlée dans la sortie des scripts. Par exemple :

=> \echo `date`
Tue Oct 26 21:40:57 CEST 1999

Si vous utilisez la commande \o pour rediriger les sorties de vos requêtes, vous pourrez vouloir utiliser \qecho au lieu de cette commande.

Place le client d'encodage, si vous utilisez l'encodage multi-octets. Sans argument, cette commande affiche l'encodage courant.

Place le séparateur de champ pour les sorties de requêtes non alignées. Par défaut c'est un pipe (|). Voir aussi \pset pour un moyen générique de placement des options de sortie.

Envoie le tampon d'entrée de requête courante au serveur et optionnellement sauvegarde les sorties dans nom de fichier ou pipe les sorties dans un shell Unix séparé pour exécuter la commande. Un \g nu est virtuellement équivalent à un point-virgule. Un \g avec argument est une alternative à "coup sûr" à la commande \o.

Fournit la syntaxe d'aide sur la commande SQL spécifiée. Si commande n'est pas spécifiée, psql affichera toutes les commandes pour lesquelles la syntaxe d'aide est disponible. Si commande est un astérisque ("*"), la syntaxe d'aide sur toutes les commandes SQL est affichée.

Pour simplifier la frappe, les commandes consistant en plusieurs mots n'ont pas à être entre guillemets. Ainsi il est pratique de taper \help alter table.

Passe le format de sortie de la requête en HTML. Si le format HTML est déja en place, il est transformé en format text. Cette commande existe pour des raisons de compatibilité et de confort, mais voir \pset à propos des autres options de sortie.

Lit l'entrée depuis le fichier filename et l'exécute pour autant qu'il ait été tapé au clavier.

Si vous voulez voir les lignes à l'écran telles qu'elles ont été lues vous devez placer la variable ECHO à all.

Affiche toutes les bases sur le serveur ainsi que leur propriétaire. Ajoutez un "+" à la commande pour voir la description des bases. Si votre installation PostgreSQL a été compilée avec le support d'encodage multi-octets, le schéma d'encodage de chaque base est indiqué.

Lit les objets longs avec OID loid depuis la base et écrit vers nom de fichier. Notez la subtile différence avec la fonction serveur lo_export, laquelle agit avec les droits de l'utilisateur que le serveur lance et sur le système de fichiers du serveur.

Utilisez \lo_list pour trouver les OID des objets longs.

Voir la description de la variable LO_TRANSACTION pour information importante concernant toutes les opérations sur les objets longs.

Stocke le fichier dans un "objet long" PostgreSQL. Optionellement, il associe le commentaire donné avec l'objet. Exemple:

foo=> \lo_import '/home/peter/pictures/photo.xcf' 'a picture of me'
lo_import 152801

Notez que cette commande est différente du côté serveur lo_import car elle agit comme l'utilisateur local sur le système de fichier local, d'avantage que l'utilisateur du serveur et le fichier système.

Voir la description de la variable LO_TRANSACTION pour information importante concernant toutes les opérations sur les objets longs.

Affiche la liste de tous les "objets longs" PostgreSQL stockés dans la base, avec les commentaires.

Supprime les objets longs avec l'OID loid de la base.

Utilise \lo_list pour découvrir l'OID des objets longs.

Voir la description de la variable LO_TRANSACTION pour information importante concernant toutes les opérations sur les objets longs.

Sauvegarde les futurs résultats des requêtes dans un fichier ou pipe les futurs résultats dans un shell Unix séparé pour exécuter la commande. Si uncun argument n'est spécifié, la sortie de la requête sera envoyée vers stdout.

Les "résultats de requête" incluent toutes les tables, les réponses aux commandes, et les notifications obtenues du serveur de la base, aussi bien que les sorties de divers commandes backslash qui questionnent la base (comme \d), mais pas les messages d'erreur.

Pour intercaler des sorties texte entre des résultats de requêtes, utilisez \qecho.

Affiche le tampon de requête courant sur la sortie standard.

Cette commande place les options affectant les sorties des résultats de requêtes sur les tables. paramètre décrit quelle option doit être placée.

Les options d'affichage ajustables sont :

Il y a diverses commandes de raccourcis pour \pset. Voir \a, \C, \H, \t, \T, et \x.

C'est une erreur d'appeler \pset sans arguments. Dans le futur cet appel pourrait indiquer le status des options d'impression.

Quitte le programme psql.

Cette commande est identique à \echosauf que toutes les sorties devront être écrites vers le canal de sortie de requête, comme placé par \o.

Réinitialise le tampon de requête.

Imprime ou sauvegarde l'histoqrique de la ligne de commande vers nom de fichier. Si nom de fichier est omis l'historique est écrit dans la sortie standard. Cette option est seulement disponible si psql est configuré pour utiliser la bibliothèque GNU history.

Dans cette version, il n'est pas nécessaire de seuvegarder la commande historique, ce sera fait automatiquement en fin de programme. L'historique est aussi chargé automatiquement à chaque démarrage de psql.

Place la variable interne name à value ou, si plus d'une valeur est donnée, à la concaténation de toutes celles-ci. Si aucun second argument n'est donné, la variable est simplement placée sans valeur. Pour enlever une variable, utilisez la commande \unset.

Les noms de variables valides peuvent contenir des caractères, des chiffres et des soulignés. VOir la section sur les variables psql pour les détails.

Bien que nous puissions placer des variables comme nous le souhaitons, psql traite certaines variables de façon particulière. Elles sont documentées dans la section sur les variables.

Cette commande est totalement séparée de la commande SQL SET.

Bascule l'affichage des en-têtes de colonnes en compteur en pied de ligne. Cette commande est équivalente à \pset tuples_only et est fournie pour raison de confort.

Vous permet de spécifier les options à placer dans table en sortie mode table HTML. Cette commande est équivalente à \pset tableattr table_options.

Envoi du tampon de requête en cours vers le fichier nom de fichier ou pipe vers la commande Unix commande.

Bascule le mode format de ligne étendu. Équivalent à \pset expanded.

Produit une liste de toutes les tables de la base avec leur privilèges d'accès. Si un argument est donné il est pris comme expression régulière qui limite l'affichage des tables qui s'apparient à lui.

test=> \z
Access permissions for database "test"
 Relation |           Access permissions
----------+-------------------------------------
 my_table | {"=r","joe=arwR", "group staff=ar"}
(1 row )

• "=r": PUBLIC en lecture (SELECT) sur la table.

• "joe=arwR": L'utilisateur joe peut lire, écrire (UPDATE, DELETE), "append" (INSERT), et peut aussi créer des règles sur la table.

• "group staff=ar": Le groupe staff a les droits SELECT et INSERT .

Les commandes GRANT et REVOKE sont utilisées pour placer les droits d'accès.

Échappement vers un shell Unix séparé ou exécute la commande Unix commande. Les arguments ne sont plus interprétés.

Apporte de l'aide sur les commandes backslash ("\").

Affiche toutes les lignes à l'écran comme elles sont lues. C'est plus pratique pour l'exécution de scripts que le mode interactif. C'est équivalent à placer la variable ECHO à all.

Permute en mode sortie non aligné. (Le mode par défaut est aligné).

Spécifie que psql exécute une chaîne de requête, query, et s'arrête. C'est pratique pour les scripts shell.

query doit être soit une chaîne de requête complètement analysable par le serveur (i.e., elle ne contient pas de fonctionnalités spécifiques à psql), soit une commande backslash simple. Ainsi, vous ne pouvez pas mélanger des meta-commandes SQL et psql. Pour finir, vous pouvez faire un pipe de la chaîne dans psql, comme ça : echo "\x \\ select * from foo;" | psql.

Spécifie le nom de la base à laquelle se connecter. Ce qui est équivalent à spécifier dbname comme premier argument non-optionnel de la ligne de commande.

Indique toutes les requêtes envoyées au serveur. Ce qui est équivalent à placer la variable ECHO aux queries.

Fait un écho des requêtes actuelles générées par \d et autres commandes backslash. Vous pouvez l'utiliser si vous voulez inclure des fonctionnalités similaires dans vos propres programmes. Ce qui est équivalent à placer la variable ECHO_HIDDEN depuis psql.

Utilise le fichier filename comme source des requêtes au lieu de lire les requêtes de façon interactive. Une fois le fichier traité, psql s'arrête. Équivalent à la commande interne \i.

Si filename est - (trait d'union), la sortie standard est lue.

Utiliser cette option est subtilement différent d'écrire psql < filename. En règle générale, les deux feront ce que vous attendez, mais utiliser -f permet certaines fonctionnalités pratiques comme les messages d'erreur avec le numéro de ligne. Il y a aussi une faible chance pour que l'utilisation de cette option réduise le temps de démarrage. D'un autre côté, la variante utilisant la redirection d'entrée shell est (en théorie) garantie pour produire exactement la même sortie que vous aurez obtenue si vous aviez tout rentré à la main.

Utilisez separator comme séparateur de champ. Équivalent à \pset fieldsep ou \f.

Spécifie le nom d'hôte de la machine sur laquelle le postmaster tourne. Si l'hôte commence avec un slash, il est utilisé comme répertoire de socket de domaine Unix.

Passe en sortie table HTML. Équivalent à \pset format html ou à la commande \H.

Liste toutes les bases disponibles. Les autres options de non-connexion sont ignorées. Ceci est similaire à la commande interne \list.

Place toutes les sorties de requêtes dans un fichier filename. Équivalent à la commande \o.

Spécifie le port TCP/IP ou, par omission, l'extension de fichier du socket de domaine local Unix sur lequel le postmaster est en attente de connexions. Par défaut c'est la valeur de la variable d'environnement PGPORT ou, si elle n'est pas placée, au port spécifié à la compilation, habituellement 5432.

Vous permet de spécifier les options d'impression dans le style de \pset en ligne de commande. Notez que ici vous aurez à séparer nom et valeur avec un signe égal au lieu d'un espace. Ainsi, pour placer le format de sortie en LaTeX, vous écrirez -P format=latex.

Spécifie que psql travaillera en silence. Par défaut, il affiche un message de bienvenue et autres informations. Si cette option est utilisée, rien n'apparaît. C'est pratique avec l'option -c. Dans psql vous pouvez aussi placer la variable QUIET pour obtenir le même effet.

Utilisez separator comme séparateur d'enregistrement. Équivalent à la commande \pset recordsep.

Tourne en mode étape-par-étape. Ce qui veut dire que l'utilisateur est questionné avant chaque requête envoyée au serveur, avec l'option d'annuler l'exécution. Utilisez ceci pour débuguer les scripts.

Tourne en mode ligne-unique où un saut de ligne termine la requête, comme le fait un point-virgule.

Ce mode est fourni pour ceux qui insisteraient, mais vous n'êtes pas nécessairement encouragés à l'utiliser. En particulier, si vous mélangez SQL et meta-commandes sur une ligne l'ordre d'exécution peut ne pas toujours être clair pour les utilisateurs inexpérimentés.

Désactive l'affichage des noms de colonnes et le compteur en pied de ligne, etc. Complètement équivalent à la meta-commande \t.

Vous permet de spécifier les options à placer dans les tags de table HTML. Voir \pset pour les détails.

psql demandera le nom d'utilisateur et le mot-de-passe avant de se connecter à la base.

Cette option est déconseillée, car elle est conceptuellement défectueuse. (Questionner pour un nom d'utilisateur non par défaut et questionner pour un mot-de-passe parce que le serveur le nécessite sont deux choses réellement différentes). Vous êtes encouragés à regarder à la place les options -U et -W.

Connexion à la base comme utilisateur username au lieu de l'utilisateur par défaut. (Vous devez avoir les droits pour le faire, bien sûr).

Traite une affectation de variable, comme la commande interne \set. Notez que vous devez séparer nom et valeur, par un signe égal en ligne de commande. Pour enlever une variable, enlevez le signe égal. Pour placer simplement une variable sans une valeur, utilisez le signe égal mais sans valeur. Ces affectations sont faites très tôt lors du démarrage, ainsi les variables réservées pour des propos internes peuvent être utilisées plus tard.

Indique la version de psql.

psql demandera un mot-de-passe avant de se connecter à une base. Ceci fonctionnera pour la session entière, même si vous changez de connexion à une base avec la meta-ciommande \connect.

Dans cette version, psql affiche automatiquement un prompt pour le mot-de-passe chaque fois que le serveur demande une authentification par mot-de-passe. Si aucun prompt pour le mot-de-passe n'est affiché et que le serveur nécessite une authentification la connexion échouera.

Active le mode format de ligne étendu. Équivalent à la commande \x.

Ne lit pas le fichier de démarrage ~/.psqlrc.

Affiche l'aide sur les arguments en ligne de commande de psql