Utiliser psql dans le terminal

L’extension PostgreSQL pour Visual Studio Code vous permet d’ouvrir psql des sessions qui sont automatiquement connectées à vos bases de données et d’exécuter des .sql fichiers via psql. Vous bénéficiez d’un accès complet aux fonctionnalités natives psql, notamment les commandes avec barre oblique inverse, les flux de travail COPY et les scripts interactifs, sans quitter l’éditeur.

L’extension transmet automatiquement les détails de connexion (hôte, port, base de données, utilisateur et mot de passe) psql pour commencer à travailler immédiatement après l’ouverture d’une session.

Prerequisites

• Extension PostgreSQL pour Visual Studio Code installée.
• Connexion active à un serveur PostgreSQL. Pour connaître les étapes de configuration, consultez Démarrage rapide : Se connecter et interroger PostgreSQL.
• Client psql de ligne de commande installé sur votre système.
• Ouvrez un dossier d’espace de travail dans Visual Studio Code.

Choisir entre psql et l’éditeur de requête

La plupart des workflows PostgreSQL utilisent les deux outils à différents moments :

Ouvrir un terminal connecté

Ouvrez une psql session qui est automatiquement connectée à une base de données spécifique. L’extension lance psql avec les indicateurs -h, -p, -d et -U, et définit la variable d’environnement PGPASSWORD, vous n’avez donc pas besoin de saisir manuellement les paramètres de connexion.

1. Dans l’arborescence Connexions , cliquez avec le bouton droit sur un nœud de base de données.
2. Sélectionnez Se connecter avec PSQL.

Un terminal de tâche Visual Studio Code s’ouvre, avec psql connecté à la base de données sélectionnée. L’onglet terminal est nommé PSQL : <nom> du profil.

Vous pouvez également exécuter cette commande à partir de la palette de commandes (Ctrl+Shift+P / Cmd+Shift+P) : recherchez PGSQL : Se connecter avec PSQL.

Exécuter un fichier SQL

Exécutez un fichier .sql via psql en utilisant la connexion de l’éditeur actif. La sortie s’affiche dans un terminal de tâches Visual Studio Code.

1. Ouvrez un .sql fichier dans l’éditeur.
2. Connectez l’éditeur à une base de données si elle n’est pas déjà connectée.
3. Cliquez avec le bouton droit dans l’éditeur et sélectionnez Exécuter le fichier avec PSQL.

L’extension enregistre le fichier, puis exécute psql -f <filepath> sur la connexion active. Un terminal de tâches s’ouvre pour afficher la sortie d’exécution. Le répertoire de travail est défini comme le dossier contenant le fichier, de sorte que les chemins relatifs dans votre script puissent être résolus correctement.

Configurer le chemin binaire psql

L’extension recherche psql dans trois emplacements, dans cet ordre :

1. Fichiers binaires groupés : outils clients PostgreSQL fournis avec l’extension, organisés par version.
2. CHEMIN du système : répertoires répertoriés dans la variable d’environnement de PATH votre système d’exploitation.
3. Répertoires personnalisés : chemins que vous ajoutez au pgsql.pgBinaryDirs paramètre.

Lorsque plusieurs versions sont psql trouvées, l’extension sélectionne la version qui correspond le mieux à la version PostgreSQL de votre serveur. Si aucune correspondance exacte n’existe, elle utilise la version la plus proche disponible.

Pour ajouter un répertoire binaire personnalisé :

1. Ouvrez Paramètres (Ctrl+, / Cmd+,).
2. Recherchez pgsql.pgBinaryDirs.
3. Sélectionnez Ajouter un élément et entrez le chemin absolu du répertoire qui contient le psql fichier binaire.
4. Redémarrez Visual Studio Code pour que la modification prenne effet.

Comment l’extension lance psql

Lorsque vous sélectionnez Se connecter avec PSQL ou Exécuter un fichier avec PSQL, l’extension assemble l’appel psql comme suit :

L’extension s’exécute psql en tant que tâche Visual Studio Code, qui s’ouvre dans le panneau Terminal. Le terminal de la tâche reste ouvert après la fermeture de psql, afin que vous puissiez consulter la sortie.

Cas d’utilisation

Le psql terminal est utile lorsque vous avez besoin de fonctionnalités au-delà de l’éditeur de requête intégré :

• Sessions SQL interactives : exécutez des commandes ad hoc et inspectez les résultats dans un environnement familier psql .
• Import/export de données en masse : utilisez les commandes \copy ou COPY pour un chargement de données haute performance.
• Tâches administratives : gérer les rôles, les autorisations et la configuration du serveur avec un accès total psql .
• Test de script : validez les .sql scripts en mode natif psql avant de les déployer.
• Commandes avec barre oblique inverse : utilisez \dt, \d+, \timing, \x et d’autres commandes qui ne sont pas disponibles dans l’éditeur graphique de requêtes.

Tâches courantes psql

Inspecter les objets de base de données

Utilisez psql des commandes avec barre oblique inverse pour inspecter rapidement le schéma :

\dt
\d+ public.orders
\dn

Ces commandes répertorient les tables, affichent les définitions détaillées des objets et répertorient les schémas.

Activer le minutage et la sortie développée

\timing on
\x on
SELECT * FROM public.orders LIMIT 5;

\timing affiche la durée de la requête après chaque instruction. La sortie développée (\x) facilite la lecture des lignes larges.

Charger ou exporter des données avec \copy

\copy public.customers FROM '/Users/example/customers.csv' WITH (FORMAT csv, HEADER true)

Utiliser \copy pour l’importation ou l’exportation en bloc orientée terminal lors de la réutilisation du contexte de connexion géré par l’extension.

Troubleshoot

psql introuvable

Si l’extension affiche l’erreur « Impossible de trouver l’exécutable psql », procédez comme suit :

1. Installez les outils clients PostgreSQL pour votre système d’exploitation à partir de la page de téléchargements PostgreSQL.
2. Vérifiez que psql est disponible en exécutant psql --version dans un terminal système.
3. Si psql est installé dans un emplacement non standard, ajoutez le répertoire au paramètre pgsql.pgBinaryDirs. Consultez Configurer le chemin binaire psql.
4. Redémarrez Visual Studio Code.

Ouvrir un dossier d’espace de travail

L’extension nécessite un dossier d’espace de travail ouvert pour lancer psql. Si un message indique qu’un dossier d’un espace de travail doit être ouvert, ouvrez un dossier avec Fichier>Ouvrir un dossier, puis réessayez.

Échecs d’authentification ou de connexion

Si psql s’ouvre, mais que la connexion échoue :

• Vérifiez que l’hôte, le port et la base de données sont corrects dans votre profil de connexion. Consultez Connexions et identité.
• Pour Microsoft Entra ID authentification, vérifiez que votre compte est toujours connecté. L’extension actualise automatiquement les jetons, mais les sessions expirées peuvent nécessiter une réauthentification.
• Si vous utilisez SSL ou un tunnel SSH, retestez la même connexion à partir de la boîte de dialogue de connexion avant de psqlrouvrir.

Les modifications de fichier ne s’exécutent pas

Lorsque vous exécutez un fichier avec un fichier d’exécution avec PSQL, l’extension enregistre le fichier sur le disque avant l’exécution. Si l’enregistrement échoue, l’extension annule l’opération. Enregistrez le fichier correctement avant de passer en revue la sortie.

Contenu connexe

• Démarrage rapide : Se connecter et interroger PostgreSQL
• Éditeur de requête et IntelliSense
• Explorateur d’objets
• Connexions et identités