Usa psql no terminal

A extensão PostgreSQL para o Visual Studio Code permite-lhe abrir sessões psql que ficam automaticamente ligadas às suas bases de dados e executar ficheiros .sql através de psql. Tens acesso total a funcionalidades nativas, incluindo comandos de barra invertida, fluxos de trabalho COPY e criação interativa de scripts, sem sair do editor.

A extensão passa automaticamente os detalhes da ligação (host, porta, base de dados, utilizador e palavra-passe psql ), para que possa começar a trabalhar imediatamente após abrir uma sessão.

Pré-requisitos

• Extensão PostgreSQL para Visual Studio Code instalada.
• Uma ligação ativa a um servidor PostgreSQL. Para os passos de configuração, veja Quickstart: Connect and consult PostgreSQL.
• O cliente de linha de comandos psql está instalado no seu sistema.
• Abra uma pasta de espaço de trabalho no Visual Studio Code.

Escolha entre psql e o editor de consultas

A maioria dos fluxos de trabalho PostgreSQL utiliza ambas as ferramentas em momentos diferentes:

Abra um terminal ligado

Abra uma psql sessão que seja automaticamente ligada a uma base de dados específica. A extensão inicia psql com as opções -h, -p, -d e -U e define a variável de ambiente PGPASSWORD, pelo que não precisa de introduzir manualmente os detalhes de ligação.

1. Na árvore Conexões , clique com o botão direito num nó da base de dados.
2. Selecionar Ligar com PSQL.

Abre-se um terminal de tarefas do Visual Studio Code com psql ligado à base de dados selecionada. O separador do terminal tem o nome PSQL: <nome do perfil>.

Também pode executar este comando a partir da Paleta de Comandos (Ctrl+Shift+P / Cmd+Shift+P): procure por PGSQL: Conectar-se com PSQL.

Executar um ficheiro SQL

Executa um ficheiro .sql através de psql, usando a ligação do editor ativo. A saída aparece num terminal de tarefas do Visual Studio Code.

1. Abre um .sql ficheiro no editor.
2. Liga o editor a uma base de dados se ainda não estiver ligado.
3. Clique com o botão direito no editor e selecione Executar ficheiro com PSQL.

A extensão guarda o ficheiro e depois corre psql -f <filepath> contra a ligação ativa. Um terminal de tarefa abre-se para mostrar a saída da execução. O diretório de trabalho é definido como a pasta que contém o ficheiro, para que os caminhos relativos do script sejam corretamente resolvidos.

Configurar o caminho binário psql

A extensão procura psql em três locais, por esta ordem:

1. Binários agrupados: Ferramentas cliente PostgreSQL que vêm com a extensão, organizadas por versão.
2. Caminho do Sistema: diretórios listados na variável de ambiente do PATH seu sistema operativo.
3. Diretórios personalizados: caminhos que adicionas ao pgsql.pgBinaryDirs cenário.

Quando são encontradas várias versões, psql a extensão seleciona a versão que melhor corresponde à versão PostgreSQL do seu servidor. Se não existir uma correspondência exata, usa a versão disponível mais próxima.

Para adicionar um diretório binário personalizado:

1. Definições Abertas (Ctrl+, / Cmd+,).
2. Procure por pgsql.pgBinaryDirs.
3. Selecione Adicionar Item e introduza o caminho absoluto para o diretório que contém o psql binário.
4. Reinicie o Visual Studio Code para que a alteração tenha efeito.

Como a extensão inicia o psql

Quando seleciona Ligar com PSQL ou Executar ficheiro com PSQL, a extensão constrói a psql invocação da seguinte forma:

A extensão funciona psql como uma tarefa do Visual Studio Code, que se abre no painel do Terminal. O terminal de tarefas mantém-se aberto após psql sair para que possas rever a saída.

Casos de uso

O psql terminal é útil quando precisas de capacidades para além do editor de consultas incorporado:

• Sessões SQL interativas: Execute comandos ad hoc e inspecione resultados num ambiente familiar psql .
• Importação/exportação de grandes volumes de dados: Utilize os comandos \copy ou COPY para carregamento de dados de elevado desempenho.
• Tarefas administrativas: Gerir funções, permissões e configuração do servidor com acesso total psql .
• Teste de scripts: Valide .sql scripts nativos psql antes de os implementar.
• Comandos de barra invertida: Use \dt, \d+, \timing, \x e outros comandos que não estão disponíveis no editor gráfico de consultas.

Tarefas comuns psql

Inspecionar objetos da base de dados

Use psql comandos de barra inversa para uma inspeção rápida do esquema:

\dt
\d+ public.orders
\dn

Estes comandos listam tabelas, mostram definições detalhadas de objetos e listam esquemas.

Ativar o tempo e a saída expandida

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

\timing Mostra a duração da consulta após cada instrução. A saída expandida (\x) torna as linhas largas mais fáceis de ler.

Carregar ou exportar dados com \copy

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

Use \copy para importação ou exportação em massa orientada a terminais, reutilizando o contexto de ligação gerido pela extensão.

Solucionar problemas

psql não encontrado

Se a extensão mostrar o erro "Não foi possível encontrar executável psql", experimente estes passos:

1. Instale as ferramentas clientes do PostgreSQL para o seu sistema operativo a partir da página de downloads do PostgreSQL.
2. Verifica se está psql disponível correndo psql --version num terminal de sistema.
3. Se psql estiver instalado num local não padrão, adicione o diretório à pgsql.pgBinaryDirs definição. Veja Configurar o caminho binário psql.
4. Reiniciar o Visual Studio Code.

Abrir uma pasta de espaço de trabalho

A extensão requer uma pasta de workspace aberta para iniciar psql. Se uma mensagem disser que tem de abrir uma pasta de espaço de trabalho, abre uma pasta com Ficheiro>Abrir Pasta e tenta novamente.

Autenticação ou falhas de ligação

Se psql abrir mas a ligação falhar:

• Confirma se o host, a porta e a base de dados estão corretos no teu perfil de ligação. Ver Ligações e identidade.
• Para a autenticação do Microsoft Entra ID, verifique se a sua conta ainda tem a sessão iniciada. A extensão atualiza os tokens automaticamente, mas sessões expiradas podem exigir reautenticação.
• Se usar SSL ou um túnel SSH, teste novamente a mesma ligação a partir do diálogo de ligação antes de reabrir psql.

As alterações no ficheiro não são executadas

Quando executas um ficheiro com Run file com PSQL, a extensão guarda o ficheiro no disco antes da execução. Se a gravação falhar, a extensão cancela a operação. Guarde o ficheiro com sucesso antes de rever a saída.

Conteúdo relacionado

• Início Rápido: Ligue e consulte o PostgreSQL
• Editor de consultas e IntelliSense
• Explorador de objetos
• Ligações e identidade