pg_isready

pg_isready — verifica o estado da conexão de um servidor PostgreSQL

Sinopse

pg_isready [opção_de_conexão...] [opção...]

Descrição

O pg_isready é um utilitário para verificar o estado da conexão de um servidor de banco de dados PostgreSQL. O código de saída especifica o resultado da verificação da conexão.

Opções

-d nome_do_banco_de_dados
--dbname=nome_do_banco_de_dados

Especifica o nome do banco de dados ao qual se conectar. O nome_do_banco_de_dados pode ser uma cadeia de caracteres de conexão. Neste caso, os parâmetros da cadeia de caracteres de conexão têm precedência sobre quaisquer opções de linha de comando conflitantes.

-h nome_do_hospedeiro
--host=nome_do_hospedeiro

Especifica o nome de hospedeiro da máquina na qual o servidor está sendo executado. Se começar com uma barra, será usado como o diretório para o soquete de domínio Unix.

-p porta
--port=porta

Especifica a porta TCP, ou a extensão de arquivo de soquete de domínio Unix local, na qual o servidor está aguardando conexões. O padrão é a variável de ambiente PGPORT, se definida, ou o padrão compilado, geralmente 5432.

-q
--quiet

Não mostra mensagem de status. É útil ao criar scripts.

-t segundos
--timeout=segundos

O número máximo de segundos a aguardar ao tentar a conexão antes de retornar que o servidor não está respondendo. Definir como 0 desativa. O valor padrão é de 3 segundos.

-U nome_do_usuário
--username=nome_do_usuário

Conecte ao banco de dados como o usuário nome_do_usuário, em vez do padrão.

-V
--version

Mostra a versão do utilitário pg_isready, e termina.

-?
--help

Mostra a ajuda sobre os argumentos da linha de comando do utilitário pg_isready, e termina.

Código de saída

O utilitário pg_isready irá retornar 0 para o interpretador de comandos se o servidor estiver aceitando conexões normalmente, 1 se o servidor estiver rejeitando conexões (por exemplo, durante a carga), 2 se não houve resposta à tentativa de conexão, e 3 se nenhuma tentativa foi feita (por exemplo, devido a parâmetros inválidos).

Variáveis de ambiente

O utilitário pg_isready, como a maioria dos outros utilitários do PostgreSQL, também usa as variáveis de ambiente com suporte pela libpq (veja Variáveis ​​de ambiente).

A variável de ambiente PG_COLOR especifica se devem ser usadas cores nas mensagens de diagnóstico. Os valores possíveis são always, auto e never.

Notas

Não é necessário fornecer valores corretos de nome de usuário, senha ou nome do banco de dados para obter o status do servidor; entretanto, se forem fornecidos valores incorretos, o servidor irá registrar uma tentativa de conexão com falha.

Exemplos

Uso padrão:

$ pg_isready
/var/run/postgresql:5432 - aceitando conexões
$ echo $?
0

Execução com parâmetros de conexão para uma instância do PostgreSQL que se encontra carregando:

$ pg_isready -h localhost -p 5433
localhost:5433 - rejeitando conexões
$ echo $?
1

Execução com parâmetros de conexão para uma instância do PostgreSQL que não responde:

$ pg_isready -h 192.168.100.41 -p 5432
192.168.100.41:5432 - nenhuma resposta
$ echo $?
2