pg_isready — vérifier le statut de connexion d'un serveur PostgreSQL
pg_isready [option-connexion...] [option...]
pg_isready est un outil qui vérifie le statut de connexion d'un serveur PostgreSQL. Le code de sortie indique le résultat de la vérification.
-d nom_base--dbname=nom_baseIndique le nom de la base de données de connexion. Ce nom de base peut être remplacé par une chaîne de connexion. Dans ce cas, les paramètres de la chaîne de connexion surchargeront toutes les options en ligne de commande conflictuelles.
-h hôte--host=hôteSpécifie le nom d'hôte de la machine sur laquelle le serveur de bases de données est exécuté. Si la valeur commence par une barre oblique (/), elle est utilisée comme répertoire pour le socket de domaine Unix.
-p port--port=port
Spécifie le port TCP ou l'extension du fichier local de socket de
domaine Unix sur lequel le serveur écoute les connexions. La valeur par
défaut est fournie par la variable d'environnement
PGPORT, si elle est initialisée. Dans le cas contraire,
il s'agit de la valeur fournie à la compilation, habituellement 5432.
-q--quietN'affiche pas de message de statut. Ceci est utile pour son utilisation dans un script.
-t secondes--timeout=secondesLe nombre maximum de secondes à attendre lors d'une tentative de connexion et que le serveur ne répond pas. Le configurer à 0 désactive l'attente. Par défaut, la valeur est de trois secondes.
-U nom_utilisateur--username=nom_utilisateur
Se connecter à la base en tant que l'utilisateur nom_utilisateur à la place du défaut.
-V--versionAffiche la version de pg_isready, puis quitte.
-?--helpAffiche l'aide sur les arguments en ligne de commande de pg_isready, puis quitte.
pg_isready renvoie 0 au shell
si le serveur accepte normalement les connexions, 1 si
le serveur rejette les connexions (par exemple lors du démarrage),
2 s'il n'y a pas de réponse une fois passé le délai
d'attente et 3 si aucune tentative n'a eu lieu (par
exemple à cause de paramètres invalides).
pg_isready, comme la majorité des outils
PostgreSQL, utilise les variables
d'environnement supportées par libpq (voir Section 34.15).
La variable d'environnement PG_COLOR indique s'il faut
utiliser les couleurs dans les messages de diagnostic. Les valeurs
possibles sont always, auto,
never.
Il n'est pas nécessaire de fournir un nom d'utilisateur, un mot de passe ou une base de données valides pour obtenir le statut du serveur. Néanmoins, si des valeurs incorrectes sont fournies, le serveur tracera une tentative échouée de connexion.
Usage standard :
$pg_isready/tmp:5432 - accepting connections$echo $?0
Exécuter avec les paramètres de connexion vers une instance PostgreSQL en cours de démarrage :
$pg_isready -h localhost -p 5433localhost:5433 - rejecting connections$echo $?1
Exécuter avec les paramètres de connexion vers une instance PostgreSQL qui ne répond pas :
$pg_isready -h someremotehostsomeremotehost:5432 - no response$echo $?2