Répertoire où sera écrit la sortie. pg_basebackup créera le répertoire et tous les sous-répertoires si nécessaire. Le répertoire peut déjà exister mais doit être vide. Dans le cas contraire, une erreur est renvoyée.

Quand la sauvegarde est en mode tar et que le répertoire est spécifié avec un tiret (-), le fichier tar sera écrit sur stdout.

Cette option est requise.

Sélectionne le format de sortie. format peut valoir :

Le taux maximum de transfert de données avec le serveur. Les valeurs sont en kilo-octets par seconde. Le suffixe M indique des méga-octets par seconde. Un suffixe k est aussi accepté mais n'a pas d'effet supplémentaire. Les valeurs valides vont de 32 ko/s à 1024 Mo/s.

Le but est de limiter l'impact de pg_basebackup sur le serveur.

Cette option affecte le transfert du répertoire de données. Le transfert des journaux de transactions est seulement affecté si la méthode de récupération est fetch.

Écrit un fichier de configuration recovery.conf minimal dans le répertoire en sortie (ou dans le fichier d'archive du répertoire principal des données lors de l'utilisation du format tar) pour faciliter la configuration d'un serveur standby. Le fichier recovery.conf enregistrera les paramètres de connexion et, si indiqué, le slot de réplication utilisé par pg_basebackup, pour que la réplication en flux utilise la même configuration.

Transfère le tablespace du répertoire ancien_repertoire vers le répertoire nouveau_repertoire pendant la sauvegarde. Pour bien fonctionner, ancien_repertoire doit correspondre exactement à la spécification du tablespace tel qu'il est actuellement défini. (Mais il n'y a pas d'erreur s'il n'y a aucun tablespace dans ancien_repertoire contenu dans la sauvegarde.) ancien_repertoire et nouveau_repertoire doivent être des chemins absolus. Si un chemin survient pour contenir un signe =, échappez-le avec un anti-slash. Cette option peut être spécifiée plusieurs fois pour différents tablespaces. Voir les exemples ci-dessus.

Si un tablespace est transféré de cette façon, les liens symboliques à l'intérieur du répertoire de données principal sont mis à jour pour pointer vers le nouvel emplacement. Du coup, le nouveau répertoire de données est prêt à être utilisé sur la nouvelle instance avec tous les tablespaces dans les emplacements mis à jour.

Actuellement, cette option ne fonctionne qu'avec le format de sortie plain. Elle est ignorée sur le format tar est sélectionné.

Indique l'emplacement du répertoire des journaux de transactions. rep_wal doit être un chemin absolu. Le répertoire des journaux de transactions peut seulement être spécifié quand la sauvegarde est en mode plain.

Inclut les journaux de transactions requis (fichiers WAL) dans la sauvegarde. Cela inclura toutes les transactions intervenues pendant la sauvegarde. À moins que la méthode none ne soit spécifiée, il est possible de lancer un postmaster directement sur le répertoire extrait sans avoir besoin de consulter les archives des journaux, ce qui rend la sauvegarde complètement autonome.

Les méthodes suivantes sont supportées pour récupérer les journaux de transactions :

Active la compression gzip de l'archive tar en sortie, avec le niveau de compression par défaut. La compression est disponible seulement lors de l'utilisation du format tar, et le suffixe .gz sera automatiquement ajouté à tous les noms de fichier tar.

Active la compression gzip du fichier tar en sortie, et précise le niveau de compression (de 0 à 9, 0 pour sans compression, 9 correspondant à la meilleure compression). La compression est seulement disponible lors de l'utilisation du format tar, et le suffixe .gz sera automatiquement ajouté à tous les noms de fichier tar.

Configure le mode du checkpoint à immédiat (fast) ou en attente (spread, la valeur par défaut). Voir Section 25.3.3.

Cette option cause la création d'un slot de réplication nommé par l'option --slot avant le début de la sauvegarde. Dans ce cas, une erreur est levée si le slot existe déjà.

Configure le label de la sauvegarde. Sans indication, une valeur par défaut, « pg_basebackup base backup » sera utilisée.

Par défaut, quand pg_basebackup échoue en erreur, il supprime tout répertoire qu'il aurait pu créer avant de découvrir qu'il ne peut pas terminer le travail (par exemple, le répertoire de données et le répertoire des journaux de transactions). Cette option empêche le nettoyage et est donc pratique pour le débogage.

Remarquez que les répertoires des tablespaces ne sont pas supprimés non plus.

Par défaut, pg_basebackup attendra que tous les fichiers soient écrits de manière sûre sur disque. Cette option demande à pg_basebackup de renvoyer la main sans attendre, ce qui est plus rapide, mais signifie qu'un arrêt brutal du serveur survenant après la sauvegarde peut laisser la sauvegarde des bases dans un état corrompu. De manière générale, cette option est utile durant les tests mais ne devrait pas être utilisée dans un environnement de production.

Active l'indicateur de progression. Activer cette option donnera un rapport de progression approximatif lors de la sauvegarde. Comme la base de données peut changer pendant la sauvegarde, ceci est seulement une approximation et pourrait ne pas se terminer à exactement 100%. En particulier, lorsque les journaux de transactions sont inclus dans la sauvegarde, la quantité totale de données ne peut pas être estimée à l'avance et, dans ce cas, la taille cible estimée va augmenter quand il dépasse l'estimation totale sans les journaux de transactions.

Quand cette option est activée, le serveur commencera par calculer la taille totale des bases de données, puis enverra leur contenu. Du coup, cela peut rendre la sauvegarde plus longue, en particulier plus longue avant l'envoi de la première donnée.

Cette option peut seulement être utilisée avec l'option -X stream. Elle fait en sorte que l'envoi des journaux dans le flux de réplication utilise le slot de réplication indiqué. Si la sauvegarde de base doit être utilisée pour un serveur standby avec un slot de réplication, elle devrait alors utiliser le même nom pour le slot de réplication dans le fichier recovery.conf. Ainsi, il est certain que le serveur ne supprimera pas les journaux nécessaires entre la fin de la sauvegarde et le début du lancement de la réplication en flux.

Le slot de réplication spécifié doit exister sauf si l'option -C est aussi utilisée.

Si cette option n'est pas spécifiée et que le serveur supporte les slots de réplication temporaires (version 10 et supérieures), alors un slot de réplication temporaire sera automatiquement utilisé pour le transfert des WAL par flux.

Active le mode verbeux, qui affichera les étapes supplémentaires pendant le démarrage et l'arrêt ainsi que le nom de fichier exact qui est en cours de traitement si le rapport de progression est aussi activé.

Cette option empêche la création d'un slot de réplication temporaire pendant la sauvegarde même si cela est supporté par le serveur.

Les slots de réplication temporaires sont crées par défaut si aucun nom de slot n'est précisé avec l'option -S quand l'envoi des journaux de transactions par flux est utilisé.

Le but principal de cette option est d'autoriser la réalisation d'une sauvegarde des bases quand le serveur ne dispose plus de slot de réplication libre. Utiliser les slots de réplication est presque toujours la meilleure solution, car cela empêche le serveur de supprimer pendant la sauvegarde les WAL nécessaires.

Désactive la vérification des sommes de contrôles, si elles sont activées sur le serveur sur lequel la sauvegarde est réalisée.

Par défaut, les sommes de contrôles sont vérifiées et les erreurs produiront un code de sortie différent de zéro. Cependant, la sauvegarde ne sera pas supprimée même dans ce cas, comme si l'option --no-clean avait été utilisée.

Indique les paramètres utilisés pour se connecter au serveur sous la forme d'une chaîne de connexion ; elles surchargeront les options en ligne de commande conflictuelles.

Cette option est appelée --dbname par cohérence avec les autres applications clientes mais comme pg_basebackup ne se connecte à aucune base de données particulière dans l'instance, le nom de la base de données dans la chaîne de connexion est ignorée.

Indique 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. La valeur par défaut est fournie par la variable d'environnement PGHOST, si elle est initialisée. Dans le cas contraire, une connexion sur la socket de domaine Unix est tentée.

Indique 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.

Spécifie le rythme en secondes de l'envoi des paquets au serveur informant de l'état en cours. Ceci permet une supervision plus facile du progrès à partir du serveur. Une valeur de zéro désactive complètement les mises à jour périodiques de statut, bien qu'une mise à jour sera toujours envoyée lorsqu'elle est demandée par le serveur, pour éviter une déconnexion suite au dépassement d'un délai. La valeur par défaut est de 10 secondes.

Le nom d'utilisateur utilisé pour la connexion.

Ne demande jamais un mot de passe. Si le serveur en réclame un pour l'authentification et qu'un mot de passe n'est pas disponible d'une autre façon (par exemple avec le fichier .pgpass), la tentative de connexion échouera. Cette option peut être utile pour les scripts où aucun utilisateur n'est présent pour saisir un mot de passe.

Force pg_basebackup à demander un mot de passe avant la connexion à une base de données.

Cette option n'est jamais nécessaire car pg_basebackup demande automatiquement un mot de passe si le serveur exige une authentification par mot de passe. Néanmoins, pg_basebackup perd une tentative de connexion pour tester si le serveur demande un mot de passe. Dans certains cas, il est préférable d'ajouter l'option -W pour éviter la tentative de connexion.

Affiche la version de pg_basebackup puis quitte.

Affiche l'aide sur les arguments en ligne de commande de pg_basebackup, puis quitte