Se o formato de saída de tabela corrente for não alinhado, será alterado para alinhado. Se for alinhado, será alterado para não alinhado. Este comando é mantido para manter a compatibilidade com as versões anteriores. Veja uma solução mais geral em \pset.

Define os parâmetros de consulta para a próxima execução da consulta, com os parâmetros especificados passados ​​para quaisquer sinalizador de parâmetro ($1 etc.).

Exemplo:

INSERT INTO tbl1 VALUES ($1, $2) \bind 'primeiro valor' 'segundo valor' \g

Isto também funciona para comandos de execução de consultas além de \g, tais como \gx e \gset.

Este comando faz com que seja usado o protocolo de consulta estendido (veja Seção 54.1.2), diferentemente da operação normal do psql, que usa o protocolo de consulta simples. Portanto, este comando pode ser útil para testar o protocolo de consulta estendido do psql. (O protocolo de consulta estendido é utilizado mesmo que a consulta não tenha parâmetros e este comando especifique zero parâmetros.) Este comando afeta apenas a próxima consulta executada; todas as consultas subsequentes usarão o protocolo de consulta simples por padrão.

\bind_named é equivalente a \bind, exceto por receber o nome de uma instrução preparada existente como primeiro parâmetro. Uma cadeia de caracteres vazia indica uma instrução preparada sem nome.

Exemplo:

INSERT INTO tbls1 VALUES ($1, $2) \parse stmt1
\bind_named stmt1 'primeiro valor' 'segundo valor' \g

Este comando faz com que seja usado o protocolo de consulta estendido (veja Seção 54.1.2), diferentemente da operação normal do psql, que usa o protocolo de consulta simples. Portanto, este comando pode ser útil para testar o protocolo de consulta estendido do psql.

Estabelece uma nova conexão com o servidor PostgreSQL. Os parâmetros de conexão a serem usados podem ser especificados usando a sintaxe posicional (um ou mais de nome do banco de dados, usuário, hospedeiro e porta), ou usando a cadeia de caracteres de conexão informação_da_conexão, conforme detalhado em Cadeias de caracteres de conexão. Se não for fornecido nenhum argumento, a nova conexão será feita usando os mesmos parâmetros da anterior.

Especificar nome_do_banco_de_dados, nome_do_usuário, hospedeiro, ou porta como -, equivale a omitir este parâmetro.

A nova conexão pode reutilizar os parâmetros de conexão da conexão anterior; não apenas o nome do banco de dados, usuário, hospedeiro e porta, mas outras configurações, como modo_ssl. Por padrão, os parâmetros são reutilizados na sintaxe posicional, mas não quando é fornecida a cadeia de caracteres de informação_da_conexão. Passar o primeiro argumento como -reuse-previous=on, ou -reuse-previous=off, prevalece sobre este padrão. Se os parâmetros forem reutilizados, então qualquer parâmetro não explicitamente especificado como parâmetro posicional, ou na cadeia de caracteres de informação_da_conexão, será trazido dos parâmetros da conexão existente. Uma exceção é que, se a configuração de hospedeiro for alterada de seu valor anterior usando a sintaxe posicional, qualquer configuração de endereço_do_hospedeiro presente nos parâmetros da conexão existente é eliminada. Além disso, qualquer senha usada para a conexão existente será reutilizada apenas se as configurações de usuário, hospedeiro e porta não forem alteradas. Quando o comando não especifica nem reutiliza um determinado parâmetro, é usado o padrão da libpq.

Se a nova conexão for estabelecida com sucesso, a conexão anterior será fechada. Se a tentativa de conexão falhar (nome de usuário errado, acesso negado, etc.), a conexão anterior será mantida se o psql estiver no modo interativo. Mas ao executar um script não interativo, a conexão antiga é fechada, e é relatado um erro. Isto pode ou não encerrar o script; se não encerrar, todos os comandos de acesso ao banco de dados vão falhar até que outro comando \connect seja executado com sucesso. Esta distinção foi escolhida como uma conveniência do usuário contra erros de digitação, por um lado, e um mecanismo de segurança para que os scripts não atuem acidentalmente no banco de dados errado, por outro lado. Note que sempre que o comando \connect tenta reutilizar parâmetros, os valores reutilizados são aqueles da última conexão bem-sucedida, não de quaisquer tentativas malsucedidas feitas posteriormente. Entretanto, no caso de falha de um \connect não interativo, nenhum parâmetro poderá ser reutilizado posteriormente, porque o script provavelmente estaria esperando os valores do \connect falhado para serem reutilizados.

Exemplos:

\c mydb myuser host.dom 6432
\c service=foo
\c "host=localhost port=5432 dbname=mydb connect_timeout=10 sslmode=disable"
\c -reuse-previous=on sslmode=require    -- muda apenas sslmode
\c postgresql://tom@localhost/mydb?application_name=myapp

Define o título de quaisquer tabelas que estão sendo mostradas como resultado de uma consulta, ou desativa o título. Equivale a \pset title título. (O nome desse comando vem de “caption”, porque anteriormente era usado apenas para definir o título em uma tabela HTML.)

Muda o diretório de trabalho corrente para diretório. Sem argumento, muda para o diretório raiz do usuário corrente. Para obter detalhes sobre como encontrar diretórios raiz, veja O arquivo de senhas.

Fecha a instrução preparada especificada. Uma cadeia de caracteres vazia representa uma instrução preparada sem nome. Se não existir nenhuma instrução preparada com este nome, a operação não terá efeito.

Exemplo:

SELECT $1 \parse stmt1
\close_prepared stmt1

Este comando faz com que seja usado o protocolo de consulta estendido (veja Seção 54.1.2), diferentemente da operação normal do psql, que usa o protocolo de consulta simples. Portanto, este comando pode ser útil para testar o protocolo de consulta estendido do psql.

Mostra informações sobre a conexão corrente com o banco de dados, incluindo informações relacionadas ao SSL, caso esteja em uso.

Note que o campo Client User mostra o usuário no momento da conexão, enquanto o campo Superuser indica se o usuário corrente (no contexto de execução corrente) possui privilégios de superusuário. Estes usuários geralmente são os mesmos, mas podem ser diferentes, por exemplo, se o usuário corrente foi alterado com o comando SET ROLE.

Executa uma operação de cópia no lado do cliente. Esta é uma operação que executa o comando COPY do SQL, mas em vez de o servidor ler ou escrever o arquivo especificado, o psql lê ou escreve o arquivo e roteia os dados entre o servidor e o sistema de arquivos local. Isto significa que o acesso e os privilégios dos arquivos são os do usuário local, não do servidor, e não são necessários privilégios de superusuário.

Quando é especificado program, o comando é executado pelo psql e os dados passados pelo ou para o comando são roteados entre o servidor e o cliente. Novamente, os privilégios de execução são os do usuário local, não do servidor, e não são necessários privilégios de superusuário.

Para \copy ... from stdin, as linhas de dados são lidas da mesma fonte que emitiu o comando, continuando até que seja lida uma linha contendo apenas \., ou o fluxo atinge EOF. Esta opção é útil para preencher tabelas diretamente em um arquivo de script SQL. Para \copy ... to stdout, a saída é enviada para o mesmo local que a saída do comando psql, e o estado de saída comando COPY contador não é mostrado (já que pode ser confundido com uma linha de dados). Para ler/escrever a entrada ou saída padrão do psql independentemente da fonte de comando corrente ou da opção \o, deve ser escrito from pstdin ou to pstdout.

A sintaxe deste comando é semelhante à do comando COPY do SQL. Todas as opções, exceto a origem/destino dos dados, estão em conformidade com as especificadas para comando COPY. Por este motivo, são aplicadas regras especiais de análise no meta-comando \copy. Ao contrário da maioria dos outros meta-comandos, o restante da linha é sempre considerado como argumentos do comando \copy, e nem a interpolação de variáveis ​​nem a expansão de acentos grave (`) são realizadas nos argumentos.

Mostra os termos de direitos autorais e de distribuição do PostgreSQL.

Executa o buffer de consulta corrente (como \g), e mostra os resultados em uma grade de tabulação cruzada ^[187]. A consulta deve retornar ao menos três colunas. A coluna de saída identificada por colV torna-se o cabeçalho vertical, e a coluna de saída identificada por colH torna-se o cabeçalho horizontal. colD identifica a coluna de saída a ser mostrada na grade. sortcolH identifica a coluna de classificação opcional para o cabeçalho horizontal.

Cada especificação de coluna pode ser um número de coluna (começando em 1), ou um nome de coluna. As regras usuais de conversão de maiúsculas em minúsculas e de delimitação do SQL se aplicam aos nomes das colunas. Se omitido, colV é tomado como a coluna 1, e colH como a coluna 2. colH deve ser diferente de colV. Se colD não for especificado, então deve haver exatamente três colunas no resultado da consulta, e a coluna que não é colV nem colH é considerada como colD .

O cabeçalho vertical, mostrado como a coluna mais à esquerda, contém os valores encontrados na coluna colV, na mesma ordem dos resultados da consulta, mas com as duplicidades removidas.

O cabeçalho horizontal, mostrado como a primeira linha, contém os valores encontrados na coluna colH, com as duplicidades removidas. Por padrão, aparecem na mesma ordem dos resultados da consulta. Mas se for fornecido o argumento opcional sortcolH, será identificada uma coluna onde os valores devem ser números inteiros, e os valores de colH aparecerão no cabeçalho horizontal classificados segundo os valores de sortcolH correspondentes.

Dentro da grade de tabulação cruzada, para cada valor distinto x de colH, e cada valor distinto y de colV, a célula localizada na interseção (x,y) conterá o valor da coluna colD na linha do resultado da consulta, para a qual o valor de colH é x, e o valor de colV é y. Se esta linha não existir, a célula ficará vazia. Havendo várias dessas linhas, será relatado erro.

Para cada relação (tabela, visão, visão materializada, índice, sequência ou tabela estrangeira) ou tipo de dados composto correspondendo ao padrão, mostra todas as colunas, seus tipos de dados, o espaço de tabelas (se não for o padrão), e quaisquer atributos especiais como NOT NULL ou valor padrão. Também são mostrados os índices, restrições, regras e gatilhos associados. Para tabelas estrangeiras, também é mostrado o servidor estrangeiro associado. (“Correspondendo ao padrão” é definido em Padrões abaixo.)

Para alguns tipos de relação, \d mostra informações adicionais para cada coluna: valores de coluna para sequências, expressões indexadas para índices, e opções do empacotador de dados estrangeiros para tabelas estrangeiras.

A forma do comando \d+ é idêntica, exceto por serem mostradas mais informações: são mostrados quaisquer comentários associados às colunas da tabela, assim como a presença de OIDs na tabela, a definição da visão se a relação for uma visão, uma configuração de identidade da réplica diferente do padrão, e o nome do método de acesso se a relação tiver um método de acesso.

Por padrão, são mostrados apenas os objetos criados pelo usuário; deve ser fornecido um padrão, ou o modificador S, para incluir os objetos do sistema.

Lista as funções de agregação, com seus tipos de dados retornado e os tipos de dados em que operam. Se o padrão for especificado, serão listadas apenas as agregações onde os nomes correspondem ao padrão. Por padrão, são listados apenas os objetos criados pelo usuário; deve ser fornecido um padrão, ou o modificador S, para incluir os objetos do sistema. Se for apensado o modificador x ao nome do comando, os resultados serão listados no modo expandido.

Lista os métodos de acesso. Se o padrão for especificado, serão listados somente os métodos de acesso onde os nomes correspondem ao padrão. Se for apensado o modificador x ao nome do comando, os resultados serão listados no modo expandido. Se for apensado o modificador + ao nome do comando, cada método de acesso será mostrado com sua função tratadora associada e sua descrição.

Lista as classes de operador (veja Métodos de índice e classes de operador). Se o padrão-de-método-de-acesso for especificado, serão listadas somente as classes de operador associadas a métodos de acesso onde os nomes correspondem a este padrão. Se o padrão-de-tipo-de-entrada for especificado, serão listadas somente as classes de operador associadas a tipos de dados de entrada onde os nomes correspondem a este padrão. Se for apensado o modificador x ao nome do comando, os resultados serão listados no modo expandido. Se for apensado o modificador + ao nome do comando, cada classe de operador será mostrada com sua respectiva família de operador e seu dono.

Lista as famílias de operador (veja Classes de operador e famílias de operador). Se o padrão-de-método-de-acesso for especificado, serão listadas apenas as famílias de operador associadas a métodos de acesso onde os nomes correspondem a este padrão. Se o padrão-de-tipo-de-entrada for especificado, serão listadas apenas as famílias de operador associadas a tipos de dados de entrada onde os nomes correspondem a este padrão. Se for apensado o modificador x ao nome do comando, os resultados serão listados no modo expandido. Se for apensado o modificador + ao nome do comando, cada família de operador será mostrada com o seu dono.

Lista os operadores associados às famílias de operador (veja Estratégias de método de índice). Se o padrão-de-método-de-acesso for especificado, serão listados apenas os membros de famílias de operador associados a métodos de acesso onde os nomes correspondem a este padrão. Se o padrão-de-família-de-operador for especificado, serão listados apenas os membros das famílias de operador onde os nomes correspondem a este padrão. Se for apensado o modificador x ao nome do comando, os resultados serão listados no modo expandido. Se for apensado o modificador + ao nome do comando, cada operador será mostrado com sua família de operador de ordenação (se for um operador de ordenação), e se sua função subjacente é à prova de vazamentos (leakproof).

Lista as funções de suporte associadas às famílias de operador (veja Rotinas de suporte a método de índice). Se o padrão-de-método-de-acesso for especificado, serão listadas apenas as funções de famílias de operador associadas a métodos de acesso onde os nomes correspondem a este padrão. Se o padrão-de-família-de-operador for especificado, serão listadas apenas as funções das famílias de operador onde os nomes correspondem a este padrão. Se for apensado o modificador x ao nome do comando, os resultados serão listados no modo expandido. Se for apensado o modificador + ao nome do comando, as funções serão mostradas na forma expandida, com suas respectivas listas de parâmetros.

Lista os espaços de tabelas. Se o padrão for especificado, serão listados somente os espaços de tabelas onde os nomes correspondem ao padrão. Se for apensado o modificador x ao nome do comando, os resultados serão listados no modo expandido. Se for apensado o modificador + ao nome do comando, cada espaço de tabelas será mostrado com suas opções associadas, tamanho em disco, permissões e descrição.

Lista as conversões entre as codificações do conjunto de caracteres. Se o padrão for especificado, serão listadas apenas as conversões onde os nomes correspondem ao padrão. Por padrão, são listados apenas os objetos criados pelo usuário; deve ser fornecido um padrão, ou o modificador S, para incluir os objetos do sistema. Se for apensado o modificador x ao nome do comando, os resultados serão listados no modo expandido. Se for apensado o modificador + ao nome do comando, cada objeto será mostrado com sua respectiva descrição.

Lista os parâmetros de configuração do servidor e seus respectivos valores. Se o padrão for especificado, serão listados apenas os parâmetros onde os nomes correspondem ao padrão. Sem o padrão, somente serão listados os parâmetros que estão definidos com valores diferentes do padrão. (Deve ser usado \dconfig * para listar todos os parâmetros.) Se for apensado o modificador x ao nome do comando, os resultados serão listados no modo expandido. Se for apensado o modificador + ao nome do comando, cada parâmetro será mostrado com seu tipo de dados, contexto em que pode ser definido e privilégios de acesso (se tiverem sido concedidos privilégios de acesso personalizados).

Lista as conversões de tipos de dados. Se o padrão for especificado, serão listadas apenas as conversões onde os tipos de dados de origem ou de destino correspondem ao padrão. Se for apensado o modificador x ao nome do comando, os resultados serão listados no modo expandido. Se for apensado o modificador + ao nome do comando, serão mostradas informações adicionais sobre cada conversão, incluindo se sua função subjacente é à prova de vazamentos (leakproof) e a descrição da conversão.

Lista as descrições dos objetos do tipo constraint (restrição), operator class (classe de operador), operator family (família de operador), rule (regra) e trigger (gatilho). Todos os outros comentários podem ser vistos pelos respectivos comandos de contrabarra para estes tipos de objeto.

\dd mostra as descrições dos objetos que correspondem ao padrão, ou dos objetos visíveis do tipo apropriado se não for fornecido nenhum argumento. Mas nos dois casos, apenas os objetos que possuem descrição serão listados. Por padrão, são listados apenas os objetos criados pelo usuário; deve ser fornecido um padrão, ou o modificador S, para incluir os objetos do sistema. Se for apensado o modificador x ao nome do comando, os resultados serão listados no modo expandido.

As descrições para os objetos podem ser criadas pelo comando COMMENT do SQL.

Lista os domínios. Se o padrão for especificado, serão listados apenas os domínios onde os nomes correspondem ao padrão. Por padrão, são listados apenas os objetos criados pelo usuário; deve ser fornecido um padrão, ou o modificador S, para incluir os objetos do sistema. Se for apensado o modificador x ao nome do comando, os resultados serão listados no modo expandido. Se for apensado o modificador + ao nome do comando, cada objeto será mostrado com suas respectivas permissões e descrição.

Lista as definições de privilégio de acesso padrão. É mostrada uma entrada para cada função de banco de dados (role) (e esquema, se aplicável) para as quais as definições de privilégio padrão foram alteradas em relação às definições padrão integradas. Se o padrão for especificado, serão listadas apenas as entradas onde o nome da função de banco de dados, ou nome do esquema, correspondem ao padrão. Se for apensado o modificador x ao nome do comando, os resultados serão listados no modo expandido.

É usado o comando ALTER DEFAULT PRIVILEGES para definir os privilégios de acesso padrão. O significado dos privilégios listados é explicado em Privilégios.

Neste grupo de comandos, as letras E, i, m, s, t, e v, representam tabela estrangeira, índice, visão materializada, sequência, tabela e visão, respectivamente. Pode-se especificar qualquer uma, ou todas estas letras, em qualquer ordem, para obter uma lista de objetos desses tipos. Por exemplo, \dti lista tabelas e índices. Se for apensado o modificador x ao nome do comando, os resultados serão listados no modo expandido. Se for apensado o modificador + ao nome do comando, cada objeto será mostrado com seu status de persistência (permanente, temporário, ou não rastreado), tamanho físico no disco, e descrição associada, se houver. Se o padrão for especificado, serão listados apenas os objetos onde os nomes correspondem ao padrão. Por padrão, são listados apenas os objetos criados pelo usuário; deve ser fornecido um padrão, ou o modificador S, para incluir os objetos do sistema.

Lista os servidores estrangeiros (mnemônico: external servers). Se o padrão for especificado, serão listados apenas os servidores onde os nomes corresponde ao padrão. Se for apensado o modificador x ao nome do comando, os resultados serão listados no modo expandido. Se for apensado o modificador + ao nome do comando, será mostrada uma descrição completa de cada servidor, incluindo os privilégios de acesso, tipo, versão, opções e descrição do servidor.

Lista as tabelas estrangeiras (mnemônico: external tables). Se o padrão for especificado, serão listadas apenas as entradas onde o nome da tabela, ou nome do esquema, correspondem ao padrão. Se for apensado o modificador x ao nome do comando, os resultados serão listados no modo expandido. Se for apensado o modificador + ao nome do comando, também serão mostradas as opções genéricas e a descrição da tabela estrangeira.

Lista os mapeamentos de usuários (mnemônico: external users). Se o padrão for especificado, serão listados apenas os mapeamentos onde os nomes de usuário correspondem ao padrão. Se for apensado o modificador x ao nome do comando, os resultados serão listados no modo expandido. Se for apensado o modificador + ao nome do comando, serão mostradas informações adicionais sobre cada mapeamento.

Lista os empacotadores de dados estrangeiros (mnemônico: external wrappers). Se o padrão for especificado, serão listados apenas os empacotadores de dados estrangeiros onde os nomes correspondem ao padrão. Se for apensado o modificador x ao nome do comando, os resultados serão listados no modo expandido. Se for apensado o modificador + ao nome do comando, também serão mostrados os privilégios de acesso, as opções e a descrição do empacotador de dados estrangeiros.

Lista as funções, junto com seus tipos de dados do resultado, tipos de dados dos argumentos, e tipos de função, classificados como “agg” (agregação), “normal”, “procedure” (procedimento), “trigger” (gatilho), ou “window” (janela). Para mostrar apenas as funções de tipo(s) específico(s), devem ser adicionadas as letras correspondentes a, n, p, t, ou w, ao comando. Se o padrão for especificado, serão listadas apenas as funções onde os nomes correspondem ao padrão. Quaisquer argumentos adicionais são padrões de nome de tipo de dados, que correspondem aos nomes do tipo de dados do primeiro, segundo, e assim por diante, argumentos da função. (As funções correspondentes podem ter mais argumentos do que o especificado. Para evitar isto, deve ser escrito um hífen - como o último padrão_de_argumento.) Por padrão, são mostrados apenas os objetos criados pelo usuário; deve ser fornecido um padrão, ou o modificador S, para incluir os objetos do sistema. Se for apensado o modificador x ao nome do comando, os resultados serão listados no modo expandido. Se for apensado o modificador + ao nome do comando, serão mostradas informações adicionais sobre cada função, incluindo volatilidade, segurança quanto ao paralelismo, dono, classificação de segurança, se é à prova de vazamentos ( leakproof), privilégios de acesso, linguagem, nome interno (para a linguagem C e funções internas apenas) e descrição. O código-fonte de uma função específica pode ser visto usando \sf.

Lista as configurações de procura de texto completo. Se o padrão for especificado, serão listadas apenas as configurações onde os nomes correspondem ao padrão. Se for apensado o modificador x ao nome do comando, os resultados serão listados no modo expandido. Se for apensado o modificador + ao nome do comando, será mostrada uma descrição completa de cada configuração, incluindo o analisador de procura de texto subjacente e a lista de dicionários para cada tipo de chave (token) do analisador.

Lista os dicionários de procura de texto completo. Se o padrão for especificado, serão listados apenas os dicionários onde os nomes correspondem ao padrão. Se for apensado o modificador x ao nome do comando, os resultados serão listados no modo expandido. Se for apensado o modificador + ao nome do comando, serão mostradas informações adicionais sobre cada dicionário selecionado, incluindo o modelo de procura de texto subjacente e os valores das opções.

Lista os analisadores de procura de texto completo. Se o padrão for especificado, serão listados apenas os analisadores onde os nomes correspondem ao padrão. Se for apensado o modificador x ao nome do comando, os resultados serão listados no modo expandido. Se for apensado o modificador + ao nome do comando, será mostrada uma descrição completa de cada analisador, incluindo as funções subjacentes e a lista de tipos de chave (token) reconhecidos.

Lista os modelos de procura de texto completo. Se o padrão for especificado, serão listados apenas os modelos onde os nomes correspondem ao padrão. Se for apensado o modificador x ao nome do comando, os resultados serão listados no modo expandido. Se for apensado o modificador + ao nome do comando, serão mostradas informações adicionais sobre cada modelo, incluindo os nomes das funções subjacentes.

Lista as funções de banco de dados (roles). (Uma vez que os conceitos de “usuários” e “grupos” foram unificados em “funções de banco de dados”, este comando agora equivale a \du.) Por padrão, são listadas apenas as funções de banco de dados criadas pelo usuário; deve ser fornecido um padrão, ou o modificador S, para incluir as funções de banco de dados do sistema. Se o padrão for especificado, serão mostradas apenas as funções de banco de dados onde os nomes correspondem ao padrão. Se for apensado o modificador x ao nome do comando, os resultados serão listados no modo expandido. Se for apensado o modificador + ao nome do comando, serão mostradas informações adicionais sobre cada função de banco de dados; no momento, isto adiciona um comentário para cada função.

Este é um alias para \lo_list, que mostra a lista dos objetos grandes. Se for apensado o modificador x ao nome do comando, os resultados serão listados no modo expandido. Se for apensado o modificador + ao nome do comando, cada objeto grande será mostrado com suas respectivas permissões, se houver.

Lista as linguagens procedurais. Se o padrão for especificado, serão listadas apenas as linguagens onde os nomes correspondem ao padrão. Por padrão, são listadas apenas as linguagens criadas pelo usuário; deve ser fornecido o modificador S para incluir as linguagens do sistema. Se for apensado o modificador x ao nome do comando, os resultados serão listados no modo expandido. Se for apensado o modificador + ao nome do comando, cada linguagem será mostrada com seu tratador de chamadas, validador, privilégios de acesso, e se é um objeto do sistema.

Lista os esquemas (espaços de nomes). Se o padrão for especificado, serão mostrados apenas os esquemas onde os nomes correspondem ao padrão. Por padrão, são listados apenas os objetos criados pelo usuário; deve ser fornecido um padrão, ou o modificador S, para incluir os objetos do sistema. Se for apensado o modificador x ao nome do comando, os resultados serão listados no modo expandido. Se for apensado o modificador + ao nome do comando, cada objeto será mostrado com suas respectivas permissões e descrição, se houver.

Lista os operadores com seus tipos de dados de operandos e resultado. Se o padrão for especificado, serão listados apenas os operadores onde os nomes correspondem ao padrão. Se for especificado apenas o padrão_de_argumento, serão listados apenas os operadores de prefixo, onde o nome do tipo de dados do argumento à direita corresponde a este padrão. Se forem especificados dois padrão_de_argumento, serão listados apenas os operadores binários, onde os nomes dos tipos de dados dos argumentos correspondem a estes padrões. (Como alternativa, pode ser escrito um hífen (-) para o argumento não utilizado de um operador unário.) Por padrão, são listados apenas os objetos criados pelo usuário; deve ser fornecido um padrão, ou o modificador S, para incluir os objetos do sistema. Se for apensado o modificador x ao nome do comando, os resultados serão listados no modo expandido. Se for apensado o modificador + ao nome do comando, serão mostradas informações adicionais sobre cada operador, incluindo o nome da função subjacente e se ela é à prova de vazamentos (leakproof).

Lista as ordenações (collations). Se o padrão for especificado, serão listadas apenas as ordenações onde os nomes correspondem ao padrão. Por padrão, são listados apenas os objetos criados pelo usuário; deve ser fornecido um padrão, ou o modificador S, para incluir os objetos do sistema. Se for apensado o modificador x ao nome do comando, os resultados serão listados no modo expandido. Se for apensado o modificador + ao nome do comando, cada ordenação será mostrada com a sua descrição associada, se houver. Note que serão listadas apenas as ordenações utilizáveis com a codificação do banco de dados corrente, portanto, os resultados podem variar entre diferentes bancos de dados da mesma instância.

Lista as tabelas, visões e sequências, com seus privilégios de acesso associados. Se o padrão for especificado, serão listadas apenas as tabelas, visões e sequências onde os nomes correspondem ao padrão. Por padrão, são mostrados apenas os objetos criados pelo usuário; deve ser fornecido o padrão ou o modificador S para incluir objetos do sistema. Se for apensado o modificador x ao nome do comando, os resultados serão listados no modo expandido.

São usados os comandos GRANT e REVOKE para definir os privilégios de acesso. O significado do privilégio mostrado é explicado em Privilégios.

Lista as relações particionadas. Se o padrão for especificado, serão listadas apenas as entradas onde os nomes correspondem ao padrão. Podem ser apensados ao comando os modificadores t (tabelas) e i (índices), para filtrar o tipo de relação a ser listada. Por padrão, são listados tabelas e índices particionados.

Se for usado o modificador n (“nested/aninhado”), ou for especificado um padrão, então serão incluídas as relações particionadas não-raiz, e será mostrada uma coluna contendo o ancestral de cada relação particionada.

Se for apensado o modificador x ao nome do comando, os resultados serão listados no modo expandido. Se for apensado o modificador + ao nome do comando, também será mostrada a soma dos tamanhos das partições de cada relação, com a descrição da relação. Se n for combinado com +, serão mostrados dois tamanhos: um incluindo o tamanho total das partições folha diretamente conectadas, e o outro mostrando o tamanho total de todas as partições, incluindo as subpartições indiretamente conectadas.

Lista os parâmetros de configuração definidos. Estas configurações podem ser específicas da função de banco de dados (role), específicas do banco de dados, ou ambas. São usados padrão_de_função_bd e padrão_de_banco_de_dados para selecionar as funções de banco de dados e os bancos de dados específicos a serem mostrados, respectivamente. Se omitido, ou se for especificado *, serão mostradas todas as configurações, incluindo aquelas não específicas da função de banco de dados ou do banco de dados, respectivamente. Se for apensado o modificador x ao nome do comando, os resultados serão listados no modo expandido.

São usados os comandos ALTER ROLE e ALTER DATABASE para definir os parâmetros de configuração por função de banco de dados e por banco de dados.

Lista informações sobre cada função de banco de dados concedida, incluindo opções atribuídas (ADMIN, INHERIT e/ou SET) e o concedente. Veja o comando GRANT para obter informações sobre a participação em funções de banco de dados.

Por padrão, são listadas apenas as concessões para funções de banco de dados criadas pelo usuário; deve ser fornecido o modificador S para incluir as funções de banco de dados do sistema. Se o padrão for especificado, serão listadas apenas as concessões para as funções de banco de dados onde os nomes correspondem ao padrão. Se for apensado o modificador x ao nome do comando, os resultados serão listados no modo expandido.

Lista as publicações de replicação. Se o padrão for especificado, serão listadas apenas as publicações onde os nomes correspondem ao padrão. Se for apensado o modificador x ao nome do comando, os resultados serão listados no modo expandido. Se for apensado o modificador + ao nome do comando, também serão mostradas as tabelas e os esquemas associados a cada publicação.

Lista as subscrições de replicação. Se o padrão for especificado, serão mostradas apenas as subscrições onde os nomes correspondem ao padrão. Se for apensado o modificador x ao nome do comando, os resultados serão listados no modo expandido. Se for apensado o modificador + ao nome do comando, serão mostradas propriedades adicionais das subscrições.

Lista os tipos de dados. Se o padrão for especificado, serão listados apenas os tipos de dados onde os nomes correspondem ao padrão. Se for apensado o modificador x ao nome do comando, os resultados serão listados no modo expandido. Se for apensado o modificador + ao nome do comando, cada tipo de dados será mostrado com seu nome interno e tamanho, seus valores permitidos se for um tipo de dados enum, e suas permissões associadas. Por padrão, apenas os objetos criados pelo usuário são listados; deve ser fornecido um padrão ou o modificador S para incluir os objetos do sistema.

Lista as funções do banco de dados (roles). (Uma vez que os conceitos de “usuários” e “grupos” foram unificados em “funções de banco de dados”, este comando agora equivale a \dg.) Por padrão, são listadas apenas as funções de banco de dados criadas pelo usuário; deve ser fornecido o modificador S, para incluir as funções de banco de dados do sistema. Se o padrão for especificado, serão listadas apenas as funções de banco de dados onde os nomes correspondem ao padrão. Se for apensado o modificador x ao nome do comando, os resultados serão listados no modo expandido. Se for apensado o modificador + ao nome do comando, serão mostradas informações adicionais sobre cada função de banco de dados; no momento, isto adiciona um comentário para cada função de banco de dados.

Lista as extensões instaladas. Se o padrão for especificado, serão listadas apenas as extensões onde os nomes correspondem ao padrão. Se for apensado o modificador x ao nome do comando, os resultados serão listados no modo expandido. Se for apensado o modificador + ao nome do comando, serão mostrados todos os objetos pertencentes a cada extensão correspondente.

Lista as estatísticas estendidas. Se o padrão for especificado, serão listadas apenas as estatísticas estendidas onde os nomes correspondem ao padrão. Se for apensado o modificador x ao nome do comando, os resultados serão listados no modo expandido.

O status de cada tipo de estatística estendida é mostrado em uma coluna com o nome de seu tipo de estatística (por exemplo, Ndistinct). defined significa que foi solicitado ao criar as estatísticas, e NULL significa que não foi solicitado. Pode-se usar pg_stats_ext se for desejado saber se o ANALYZE foi executado, e se as estatísticas estão disponíveis para o planejador.

Lista os gatilhos de eventos. Se o padrão for especificado, serão listados apenas os gatilhos de evento onde os nomes correspondem ao padrão. Se for apensado o modificador x ao nome do comando, os resultados serão listados no modo expandido. Se for apensado o modificador + ao nome do comando, cada objeto será mostrado com sua respectiva descrição.

Se o nome_do_arquivo for especificado, o arquivo será editado; e depois que o editor for fechado, o conteúdo do arquivo será copiado para o buffer de consulta corrente. Se o nome_do_arquivo não for fornecido, o buffer de consulta corrente será copiado para um arquivo temporário e editado da mesma maneira. Ou, se o buffer de consulta corrente estiver vazio, será copiada a consulta executada mais recentemente para um arquivo temporário, e editada da mesma maneira.

Se for editado um arquivo ou consulta anterior, e fechado o editor sem modificar o arquivo, o buffer de consulta será limpo. Caso contrário, o novo conteúdo do buffer de consulta será analisado novamente conforme as regras normais do psql, tratando todo o buffer como uma única linha. Quaisquer consultas completas serão executadas imediatamente; ou seja, se o buffer de consulta contiver ou terminar com um ponto e vírgula, tudo até este ponto será executado e removido do buffer de consulta. Tudo que restar no buffer de consulta será mostrado novamente. Deve ser digitado um ponto-e-vírgula ou \g para executar, ou \r para cancelar limpando o buffer de consulta.

Tratar o buffer como uma única linha afeta principalmente os meta-comandos: tudo o que estiver no buffer após o meta-comando será considerado argumento(s) para o meta-comando, mesmo que ocupe várias linhas. (Portanto, não se pode fazer scripts usando meta-comandos dessa maneira. Deve ser usado \i para isto.)

Se for especificado o número da linha, o psql irá posicionar o cursor na linha especificada do arquivo ou do buffer de consulta. Note que, se for fornecido um único argumento com somente dígitos, o psql assume que é um número de linha, e não um nome de arquivo.

Envia os argumentos avaliados para a saída padrão, separados por espaços, e seguidos por uma nova linha. Pode servir para intercalar informações na saída de scripts. Por exemplo:

\echo `date`
sex 17 abr 2026 15:08:02 -03

Se o primeiro argumento for -n não delimitado, o caractere de nova-linha à direita não será escrito (nem o primeiro argumento).

Este comando busca e edita a definição da função ou procedimento especificado, na forma de um comando CREATE OR REPLACE FUNCTION ou CREATE OR REPLACE PROCEDURE. A edição é feita da mesma forma que para \edit. Se o editor for fechado sem salvar, a instrução será descartada. Se salvar e sair do editor, o comando atualizado será executado imediatamente se for adicionado um ponto e vírgula a ele. Caso contrário, será mostrado novamente; deve ser digitado um ponto e vírgula ou \g para executar, ou \r para cancelar.

A função de destino pode ser especificada apenas pelo nome, ou pelo nome e argumentos, por exemplo, foo(integer, text). Devem ser fornecidos os tipos dos argumentos, se houver mais de uma função com o mesmo nome.

Se não for especificada nenhuma função, um modelo de CREATE FUNCTION em branco será mostrado para edição.

Se for especificado o número da linha, o psql irá posicionar o cursor na linha especificada do corpo da função. (Note que o corpo da função normalmente não começa na primeira linha do arquivo.)

Ao contrário da maioria dos outros meta-comandos, o restante da linha é sempre considerado argumento(s) de \ef, e nem a interpolação de variáveis nem a expansão de acentos grave (`) são executadas nos argumentos.

Define a codificação do conjunto de caracteres do cliente. Sem um argumento, este comando mostra a codificação corrente.

Repete a mensagem de erro mais recente do servidor com a verbosidade máxima, como se VERBOSITY estivesse definido como verbose, e SHOW_CONTEXT estivesse definido como always.

Este comando busca e edita a definição da visão especificada, na forma do comando CREATE OR REPLACE VIEW. A edição é feita da mesma forma que para \edit. Se salvar e sair do editor, o comando atualizado será executado imediatamente se for adicionado um ponto e vírgula a ele. Caso contrário, será mostrado novamente; deve ser digitado um ponto e vírgula ou \g para executar, ou \r para cancelar.

Se não for especificada nenhuma visão, será mostrado um modelo de CREATE VIEW em branco para edição.

Se for especificado o número da linha, o psql irá posicionar o cursor na linha especificada da definição da visão.

Ao contrário da maioria dos outros meta-comandos, o restante da linha é sempre considerado argumento(s) de \ev, e nem a interpolação de variáveis nem a expansão de acentos grave (`) são executadas nos argumentos.

Define o separador de campos para a saída não alinhada da consulta. O padrão é a barra vertical (|). Equivale a \pset fieldsep.

Envia o buffer de consulta corrente para o servidor para ser executado.

Se forem colocados parênteses após o \g, eles irão envolver uma lista de cláusulas de opção de formatação, separadas por espaço, contendo opção=valor, que serão interpretadas da mesma forma que comandos \pset opção valor, mas com efeito apenas durante esta consulta. Nesta lista, não são permitidos espaços ao redor dos sinais de =, mas são necessários entre as cláusulas de opção. Se for omitido =valor, a opção especificada é alterada da mesma forma que em \pset opção sem um valor indicado.

Se for especificado o nome_do_arquivo, ou o argumento |comando, a saída da consulta será escrita no arquivo especificado, ou canalizada (pipe) para o comando fornecido, em vez de mostrada como de costume. O arquivo ou comando será escrito apenas se a consulta retornar zero ou mais tuplas com êxito, mas não se a consulta falhar, ou for um comando SQL sem retorno de dados.

Se o buffer de consulta corrente estiver vazio, será executada novamente a consulta enviada mais recentemente. Exceto por este comportamento, \g sem nenhum argumento é essencialmente equivalente ao ponto e vírgula. Com argumentos, \g fornece uma alternativa “de uma única vez” ao comando \o, e adicionalmente permite ajustes de uma única vez das opções de formatação de saída normalmente definidas por \pset.

Quando o último argumento começa com |, o restante da linha é considerado o comando a ser executado, e nem a interpolação de variáveis, nem a expansão acentos grave (`), são executadas no comando. O restante da linha é simplesmente passado literalmente para o interpretador de comandos (shell).

Mostra a descrição (isto é, os nomes das colunas e os tipos de dados) do resultado do buffer de consulta corrente. A consulta não é realmente executada; porém, se contiver algum tipo de erro de sintaxe, este erro será relatado normalmente.

Se o buffer de consulta corrente estiver vazio, será descrita a consulta enviada mais recentemente.

Obtém o valor da variável de ambiente env_var e atribui à variável do psql psql_var. Se env_var não estiver definido no ambiente do processo psql, então psql_var não será alterada. Exemplo:

\getenv home HOME
\echo :home
/var/lib/postgresql

Envia o buffer de consulta corrente para o servidor, tratando cada coluna de cada linha da saída da consulta (se houver) como uma instrução SQL a ser executada. Por exemplo, para criar um índice em cada coluna de minha_tabela

SELECT format('create index on minha_tabela(%I)', attname)
FROM pg_attribute
WHERE attrelid = 'minha_tabela'::regclass AND attnum > 0
ORDER BY attnum
\gexec
CREATE INDEX
CREATE INDEX
CREATE INDEX
CREATE INDEX

As consultas geradas são executadas na ordem em que as linhas são retornadas, e da esquerda para a direita dentro de cada linha, se houver mais de uma coluna. Os campos NULL são ignorados. As consultas geradas são enviadas literalmente ao servidor para execução, portanto, não podem ser meta-comandos do psql, nem conter referências a variáveis do psql. Se qualquer consulta individual falhar, a execução das consultas restantes prossegue, a menos que seja definido ON_ERROR_STOP. A execução de cada consulta está sujeita ao processamento de ECHO. (Definir ECHO como all ou queries geralmente é aconselhável ao usar \gexec.) Registro de consulta, modo de etapa única, tempo, e outros recursos de execução de consulta também se aplicam a cada consulta gerada.

Se o buffer de consulta corrente estiver vazio, será executada novamente a consulta enviada mais recentemente.

Envia o buffer de consulta corrente para o servidor, e armazena a saída da consulta em variáveis do psql (veja Variáveis abaixo). A consulta a ser executada deve retornar exatamente uma linha. Cada coluna da linha é armazenada em uma variável separada, com o mesmo nome da coluna. Por exemplo:

SELECT 'hello' AS var1, 10 AS var2
\gset
\echo :var1 :var2
hello 10

Se o prefixo for especificado, esta cadeia de caracteres será anexada aos nomes das colunas da consulta para criar os nomes das variáveis a serem usadas:

SELECT 'hello' AS var1, 10 AS var2
\gset result_
\echo :result_var1 :result_var2
hello 10

Se o resultado da coluna for NULL, a variável correspondente terá sua definição removida, em vez de ser definida.

Se a consulta falhar, ou não retornar uma linha, nenhuma variável será alterada.

Se o buffer de consulta corrente estiver vazio, será executada novamente a consulta enviada mais recentemente.

\gx equivale a \g, exceto por forçar o modo de saída expandido para esta consulta, como se expanded=on estivesse incluído na lista de opções de \pset. Veja também \x.

Fornece ajuda de sintaxe para o comando SQL especificado. Se não for especificado o comando, o psql irá listar todos os comandos para os quais está disponível ajuda de sintaxe. Se o comando for um asterisco (*), será mostrada a ajuda de sintaxe para todos os comandos SQL.

Ao contrário da maioria dos outros meta-comandos, o restante da linha é sempre considerado argumento(s) de \help, e nem a interpolação de variáveis, nem a expansão de acentos grave (`), são executadas nos argumentos.

Ativa o formato HTML de saída de consulta. Se o formato HTML já estiver ativo, ele retornará ao formato de texto alinhado padrão. Este comando é mantido para compatibilidade e conveniência, mas deve ser consultado \pset sobre a configuração de outras opções de saída.

Lê a entrada no arquivo nome_do_arquivo, e a executa como se tivesse sido digitada no teclado.

Se o nome_do_arquivo for um - (hífen), então a entrada padrão será lida até uma indicação de EOF ou o meta-comando \q. Pode servir para intercalar a entrada interativa com a entrada por arquivos. Note que o comportamento de Readline será usado apenas se estiver ativo no nível mais externo.

Este grupo de comandos implementa blocos condicionais aninhados. Um bloco condicional deve começar com \if e terminar com \endif. No meio pode haver qualquer número de cláusulas \elif, que podem ser opcionalmente seguidas por uma única cláusula \else. Consultas comuns e outros tipos de comandos de contrabarra podem aparecer (e geralmente aparecem) entre os comandos que formam o bloco condicional.

Os comandos \if e \elif leem seu(s) argumento(s) e os avalia como uma expressão booleana. Se a expressão resultar em true, o processamento continuará normalmente; caso contrário, as linhas serão saltadas até que um \elif, \else, ou \endif correspondente seja alcançado. Uma vez que um teste de \if ou \elif tenha sido bem-sucedido, os argumentos dos comandos \elif posteriores no mesmo bloco não serão avaliados, sendo tratados como falsos. As linhas que seguem o \else são processadas somente se nenhum \if ou \elif correspondente anterior foi bem-sucedido.

O argumento expressão de um comando \if ou \elif está sujeito a interpolação de variáveis e a expansão de acentos grave (`), assim como qualquer outro argumento de comando de contrabarra. Após isto é avaliado como o valor de uma variável de opção on/off. Portanto, um valor válido é qualquer correspondência inequívoca que não diferencie letras maiúsculas de minúsculas para um entre: true, false, 1, 0, on, off, yes, no. Por exemplo, t, T e tR serão todos considerados true.

As expressões que não forem avaliadas corretamente como verdade ou falso vão gerar uma advertência, e serão tratadas como falsas.

As linhas saltadas são analisadas normalmente para identificar consultas e comandos de contrabarra, mas as consultas não são enviadas para o servidor, e os comandos de contrabarra diferentes dos condicionais (\if, \elif, \else, e \endif), são ignorados. Os comandos condicionais são verificados apenas quanto a aninhamento válido. As referências a variáveis nas linhas saltadas não são expandidas, e a expansão de acentos grave (`) também não é executada.

Todos os comandos de contrabarra de um determinado bloco condicional devem aparecer no mesmo arquivo-fonte. Se for alcançado o EOF no arquivo de entrada principal, ou em um arquivo \include, antes que todos os blocos \if locais tenham sido fechados, então o psql irá relatar um erro.

A seguir está um exemplo:

-- verificar a existência de dois registros separados no banco de dados
-- e armazenar os resultados em variáveis do psql separadas
SELECT
    EXISTS(SELECT 1 FROM customer WHERE customer_id = 123) as is_customer,
    EXISTS(SELECT 1 FROM employee WHERE employee_id = 456) as is_employee
\gset
\if :is_customer
    SELECT * FROM customer WHERE customer_id = 123;
\elif :is_employee
    \echo 'não é cliente mas é funcionário'
    SELECT * FROM employee WHERE employee_id = 456;
\else
    \if yes
        \echo 'não é cliente ou funcionário'
    \else
        \echo 'isto nunca será mostrado'
    \endif
\endif

O meta-comando \ir é semelhante ao \i, mas resolve os nomes de arquivos relativos de maneira diferente. Ao executar no modo interativo, os dois comandos se comportam de forma idêntica. Entretanto, quando chamado a partir de um script, \ir interpreta os nomes dos arquivos relativamente ao diretório onde o script está localizado, em vez do diretório de trabalho corrente.

Lista os bancos de dados no servidor, mostrando seus nomes, donos, codificações dos conjuntos de caracteres, e privilégios de acesso. Se o padrão for especificado, serão mostrados apenas os bancos de dados onde os nomes correspondem ao padrão. Se for apensado o modificador x ao nome do comando, os resultados serão listados no modo expandido. Se for apensado o modificador + ao nome do comando, também serão mostrados os tamanhos dos bancos de dados, os espaços de tabela padrão e as descrições. (As informações de tamanho estão disponíveis apenas para os bancos de dados aos quais o usuário corrente pode se conectar.)

Lê o objeto grande com o OID igual a oid_de_objeto_grande no banco de dados, e escreve no nome_do_arquivo. Note que é sutilmente diferente da função do servidor lo_export, que atua com as permissões do usuário com o qual o servidor de banco de dados executa, e no sistema de arquivos do servidor.

Armazena o arquivo em um objeto grande do PostgreSQL. Opcionalmente, associa o comentário fornecido ao objeto. Por exemplo:

\lo_import '/home/peter/pictures/photo.xcf' 'uma foto minha'
lo_import 152801

A resposta indica que o objeto grande recebeu o ID de objeto 152801, que poderá ser usado para acessar o objeto grande recém-criado no futuro. Por uma questão de legibilidade, é recomendável sempre associar um comentário legível por humanos a cada objeto. Os OIDs e os comentários podem ser vistos usando o meta-comando \lo_list.

Note que este meta-comando é sutilmente diferente da função do servidor lo_import, porque atua como o usuário local no sistema de arquivos local, em vez do usuário e sistema de arquivos do servidor.

Mostra a lista de todos os objetos grandes do PostgreSQL armazenados no banco de dados, com quaisquer comentários fornecidos para eles. Se for apensado o modificador x ao nome do comando, os resultados serão listados no modo expandido. Se for apensado o modificador + ao nome do comando, cada objeto grande será listado com suas respectivas permissões, se houver.

Exclui do banco de dados o objeto grande com o OID igual a oid_de_objeto_grande.

Prepara para salvar os resultados das futuras consultas no arquivo nome_do_arquivo, ou canalizar os resultados futuros para o comando do interpretador de comandos (shell) comando. Se não for especificado nenhum argumento, a saída da consulta será redefinida para a saída padrão.

Se o argumento começar com |, então o restante da linha será considerado o comando a ser executado, e nem a interpolação de variáveis nem a expansão de acentos grave (`) serão realizadas nele. O restante da linha é simplesmente passado literalmente para o interpretador de comandos.

Os “resultados da consulta” incluem todas as tabelas, respostas de comando, e avisos obtidos do servidor de banco de dados, bem como a saída de vários comandos de contrabarra que consultam o banco de dados (tal como \d); mas nenhuma mensagem de erro.

Mostra o buffer de consulta corrente na saída padrão. Se o buffer de consulta corrente estiver vazio, será mostrada a consulta executada mais recentemente.

Cria uma instrução preparada a partir do buffer de consulta corrente, com base no nome de um objeto de instrução preparada de destino. Uma cadeia de caracteres vazia representa a instrução preparada sem nome.

Exemplo:

SELECT $1 \parse stmt1

Este comando faz com que seja usado o protocolo de consulta estendido, diferentemente da operação normal do psql, que usa o protocolo de consulta simples. Uma mensagem Parse (F) será emitida por este comando, portanto, pode ser útil para testar o protocolo de consulta estendido a partir do psql. Este comando afeta apenas a próxima consulta executada; todas as consultas subsequentes usarão o protocolo de consulta simples por padrão.

Altera a senha do usuário especificado (por padrão, o usuário corrente). Este comando solicita a nova senha, encripta, e a envia ao servidor como um comando ALTER ROLE. Isto garante que a nova senha não apareça como texto não encriptado no histórico de comandos, no registro do servidor, ou em outro lugar.

Pede que o usuário forneça o texto a ser atribuído à variável nome_da_variável. Pode ser especificada a cadeia de caracteres opcional texto, mostrada no pedido. (Para cadeias de caracteres de várias palavras, o texto deve ser colocado entre apóstrofos.)

=> \prompt 'Digite seu sobrenome', sobrenome    -- Exemplo do tradutor
Digite seu sobrenome,Fagundes Telles
=> \echo :sobrenome
Fagundes Telles

Por padrão, o \prompt usa o terminal para entrada e saída. No entanto, se for usada a opção de linha de comando -f, o \prompt usará a entrada e saída padrão.

Este meta-comando define as opções que afetam a saída das tabelas de resultados da consulta. A opção indica qual opção deve ser definida. A semântica do valor varia dependendo da opção selecionada. Para algumas opções, omitir o valor faz com que a opção seja alternada ou perca a definição, conforme descrito na opção específica. Se este comportamento não for mencionado, a omissão do valor apenas fará com que seja mostrada a configuração corrente.

\pset sem nenhum argumento exibe o status corrente de todas as opções de exibição.

As opções de exibição ajustáveis são:

Ilustrações de como estes diferentes formatos se parecem podem ser vistas em Exemplos, abaixo.

Sai do programa psql. Em um arquivo de script, apenas a execução desse script é encerrada.

Este comando é idêntico ao \echo, exceto que a saída será escrita no canal de saída da consulta, conforme definido por \o.

Redefine (limpa) o buffer de consulta.

Entre no modo “restrito” com a chave fornecida. Neste modo, o único meta-comando permitido é \unrestrict, para sair do modo restrito. A chave pode conter apenas caracteres alfanuméricos.

Este comando destina-se principalmente ao uso em exportações de texto-puro geradas pelo pg_dump, pg_dumpall e pg_restore, mas pode ser útil em outros contextos.

Escreve o histórico da linha de comando do psql no nome_do_arquivo. Se for omitido o nome_do_arquivo, o histórico será mostrado na saída padrão (usando o paginador, se apropriado). Este meta-comando não estará disponível se o psql tiver sido construído sem suporte a Readline.

Define a variável nome_da_variável do psql com o valor, ou se mais de um valor for fornecido, como a concatenação de todos eles. Se for fornecido apenas um argumento, a variável será definida com um valor de cadeia de caracteres vazia. Para remover a definição de uma variável, deve ser usado o comando \unset.

\set sem nenhum argumento mostra os nomes e valores de todas as variáveis do psql definidas no momento.

Os nomes de variáveis válidos podem conter letras, dígitos e sublinhados. Veja Variáveis abaixo para obter detalhes. Os nomes das variáveis diferenciam letras maiúsculas de minúsculas.

Certas variáveis são especiais, porque controlam o comportamento do psql, ou são definidas automaticamente para refletir o estado da conexão. Estas variáveis estão documentadas em Variáveis abaixo.

Define a variável de ambiente nome_da_variável com o valor, ou se não for fornecido o valor, remove a definição da variável de ambiente.

\setenv PAGER less
\setenv LESS -imx4F

Este meta-comando busca e mostra a definição da função ou procedimento especificado, na forma de um comando CREATE OR REPLACE FUNCTION ou CREATE OR REPLACE PROCEDURE. A definição é escrita no canal corrente de saída de consulta, conforme definido por \o.

A função de destino pode ser especificada apenas pelo nome, ou pelo nome e argumentos, por exemplo, foo(integer, text). Devem ser fornecidos os tipos dos argumentos se houver mais de uma função com o mesmo nome.

Se for apensado o modificador + ao nome do comando, as linhas de saída serão numeradas, com a primeira linha do corpo da função sendo a linha 1.

Ao contrário da maioria dos outros meta-comandos, o restante da linha é sempre considerado argumento(s) de \sf, e nem a interpolação de variáveis nem a expansão de acentos grave (`) são realizadas nos argumentos.

Este meta-comando busca e mostra a definição da visão especificada, na forma de um comando CREATE OR REPLACE VIEW. A definição é escrita no canal de saída de consulta corrente, conforme definido por \o.

Se for apensado o modificador + ao nome do comando, então as linhas de saída serão numeradas a partir de 1.

Ao contrário da maioria dos outros meta-comandos, o restante da linha é sempre considerado argumento(s) de \sv, e nem a interpolação de variáveis nem a expansão de acentos grave (`) são realizadas nos argumentos.

Este grupo de comandos implementa um fluxo de instruções SQL. O fluxo deve começar por \startpipeline e terminar por \endpipeline. Entre eles pode haver qualquer número de comandos \syncpipeline, que enviam uma mensagem de sincronização sem interromper o fluxo de dados em andamento e descarregando o buffer de envio. No modo de fluxo, as instruções são enviadas ao servidor sem esperar pelos resultados das instruções anteriores. Veja Pipeline Mode para obter mais informações.

Todas as consultas executadas enquanto o fluxo está em andamento utilizam o protocolo de consulta estendido. As consultas são apensadas ao fluxo quando terminam com um ponto e vírgula. Os meta-comandos \bind, \bind_named, \close_prepared e \parse pode ser usados em um fluxo em andamento. Enquanto o fluxo está em andamento, \sendpipeline irá apensar o buffer de consulta corrente ao fluxo. Outros meta-comandos como \g, \gx ou \gdesc não são permitidos no modo de fluxo.

\flushrequest apensa um comando de descarga ao fluxo, permitindo a leitura de resultados com \getresults sem executar uma sincronização ou encerrar o fluxo. \getresults enviará automaticamente os dados ainda não enviados para o servidor. \flush pode ser usado para enviar manualmente os dados ainda não enviados.

\getresults aceita o parâmetro opcional número_de_resultados. Se fornecido, apenas os primeiros número_de_resultados resultados pendentes serão lidos. Se não for fornecido ou for 0, todos os resultados pendentes serão lidos.

Quando o modo de fluxo está ativo, uma variável de aviso de comando (prompt) dedicada fica disponível para informar o status do fluxo. Veja %P para obter mais informações.

COPY não tem suporte no modo de fluxo.

Exemplo:

\startpipeline
SELECT * FROM pg_class;
SELECT 1 \bind \sendpipeline
\flushrequest
\getresults
\endpipeline

Alterna a exibição de cabeçalhos de nome de coluna de saída, e rodapé de contagem de linha. Equivale a \pset tuples_only, sendo fornecido apenas por conveniência.

Especifica os atributos a serem colocados no marcador table no formato de saída HTML. Equivale a \pset tableattr opções_de_tabela.

Com um parâmetro, ativa ou desativa a exibição de quanto tempo cada instrução SQL levou para executar. Sem parâmetro, alterna a exibição entre ativada e desativada. A exibição é em milissegundos; intervalos maiores que 1 segundo também são mostrados no formato minutos:segundos, com campos de horas e dias adicionados, se necessário.

Sair do modo “restrito” (ou seja, onde todos os outros meta-comandos estão bloqueados), desde que a chave especificada corresponda àquela fornecida em \restrict quando o modo restrito foi ativado.

Este comando destina-se principalmente ao uso em exportações de texto-puro geradas pelo pg_dump, pg_dumpall e pg_restore, mas pode ser útil em outros contextos.

Remove a definição da variável (exclui) nome_da_variável do psql.

Grande parte das variáveis que controlam o comportamento do psql não podem perder sua definição; sendo assim, o comando \unset é interpretado como as configurando para seus valores padrão. Veja Variáveis abaixo.

Escreve o buffer de consulta corrente no arquivo nome_do_arquivo, ou canaliza para o comando do interpretador de comandos (shell). Se o buffer de consulta corrente estiver vazio, será escrita a consulta executada mais recentemente.

Se o argumento começar com uma barra vertical (|), então o restante da linha será considerado o comando a ser executado, e nem a interpolação de variáveis nem a expansão de acentos grave (`) são executadas nesta parte. O restante da linha é simplesmente passado literalmente para o interpretador de comandos.

Este comando é idêntico ao \echo, exceto que a saída é escrita no canal de erro padrão do psql, em vez de na saída padrão.

Executa repetidamente o buffer de consulta corrente (como \g faz) até ser interrompido, ou a consulta falhar, ou o limite de contagem de execuções (se houver) for atingido, ou a consulta deixar de retornar o número mínimo de linhas. Aguarda o número de segundos especificado (por padrão 2) entre as execuções. O tempo de espera padrão pode ser alterado pela variável WATCH_INTERVAL. Para manter a compatibilidade com as versões anteriores, segundos pode ser especificado com ou sem o prefixo interval=". Cada resultado da consulta é mostrado com um cabeçalho que inclui a cadeia de caracteres \pset title (se houver), a hora de início da consulta e o intervalo de atraso.

Se o buffer de consulta corrente estiver vazio, será executada novamente a consulta enviada mais recentemente.

Define ou alterna o modo expandido de formatação de tabela. Como tal, equivale a \pset expanded.

Lista as tabelas, visões e sequências, com seus privilégios de acesso associados. Se o padrão for especificado, serão listadas apenas as tabelas, visões e sequências onde os nomes correspondem ao padrão. Por padrão, apenas os objetos criados pelo usuário são mostrados; Deve ser fornecido o padrão ou o modificador S para incluir os objetos do sistema. Se for apensado o modificador x ao nome do comando, os resultados serão listados no modo expandido.

Este é um alias para \dp (“display privileges”).

Sem argumento, sai para uma sub-shell (interpretador de comandos); O psql retorna quando a sub-shell é encerrada. Com um argumento, executa o comando do interpretador de comandos.

Ao contrário da maioria dos outros meta-comandos, o restante da linha é sempre considerado argumento(s) de \!, e nem a interpolação de variáveis nem a expansão de acentos grave (`) são executadas nos argumentos. O restante da linha é simplesmente passado literalmente para o interpretador de comandos.

Mostra informações de ajuda. O parâmetro opcional tópico (por padrão commands) seleciona qual parte do psql é explicada: commands descreve os meta-comandos de contrabarra do psql; options descreve as opções de linha de comando que podem ser passadas para o psql; e variables mostra ajuda sobre a configuração das variáveis do psql.

Contrabarra ponto-e-vírgula não é um meta-comando da mesma forma que os comandos anteriores; em vez disso, simplesmente faz com que um ponto e vírgula seja adicionado ao buffer de consulta sem nenhum processamento adicional.

Normalmente, o psql envia o comando SQL para o servidor assim que atinge o ponto e vírgula no final do comando, mesmo que existam mais entradas na linha corrente. Assim, por exemplo, entrar com

select 1; select 2; select 3;

irá resultar no envio individual dos três comandos SQL ao servidor, com os resultados de cada um sendo mostrado antes de prosseguir para o próximo comando. Entretanto, o ponto-e-vírgula inserido como \; não aciona o processamento do comando, de modo que o comando antes dele e o seguinte possam ser efetivamente combinados e enviados ao servidor em uma única requisição. Então, por exemplo,

select 1\; select 2\; select 3;

resulta no envio dos três comandos SQL para o servidor em uma única requisição, quando o ponto e vírgula sem contrabarra é atingido. O servidor executa esta requisição como uma única transação, a menos que haja comandos BEGIN/COMMIT explícitos incluídos na cadeia de caracteres para dividi-la em várias transações. (Veja Seção 54.2.2.1 para obter mais detalhes sobre como o servidor lida com cadeia de caracteres de várias consultas.)