Les commandes sont utilisées pour exécuter les différentes fonctionnalités de pgBackRest. Ici, les options de commande sont énumérées de manière détaillée, autrement dit, chaque option applicable à une commande est énumérée avec cette commande, même si elle s'applique à une ou plusieurs autres commandes. Cela inclut toutes les options qui peuvent également être configurées dans pgbackrest.conf.
Les options non booléennes configurées dans pgbackrest.conf peuvent être réinitialisées à la valeur par défaut lors de l'appel en ligne de commande en utilisant le préfixe reset-. Cette fonctionnalité peut être utilisée afin de restaurer une sauvegarde directement sur le serveur du dépôt. Normalement, pgBackRest sera en erreur car il detectera que l'hôte de la base de données est distant et que la restauration ne peut pas être faites à distance. En ajoutant --reset-pg1-host sur la ligne de commande, pgBackRest ignorera l'hôte de base de données distant et restaurera localement. Il peut être nécessaire de passer un nouveau --pg-path pour forcer la restauration à se faire dans un chemin spécifique, c'est-à-dire pas le chemin utilisé sur l'hôte d'instance de la base de données.
Le préfixe no- peut être utilisé pour définir une option booléenne à false (faux) sur la ligne de commande.
Toute option peut être définie dans une variable d'environnement en utilisant le préfixe PGBACKREST_ et le nom de l'option en toutes lettres majuscules en remplaçant - par _, par exemple, pg1-path devient PGBACKREST_PG1_PATH et stanza devient PGBACKREST_STANZA. Les options booléennes sont représentées comme elles le seraient dans un fichier de configuration, par exemple PGBACKREST_COMPRESS="n", et les variantes reset-* ne sont pas autorisées. Les options qui peuvent être spécifiées plusieurs fois sur la ligne de commande ou dans un fichier de configuration peuvent être représentées en séparant les valeurs par des deux points, par exemple PGBACKREST_DB_INCLUDE="db1:db2".
Les options de la ligne de commande écrasent les options de l'environnement qui écrasent, elles, les options du fichier de configuration.
Les segments WAL sont nécessaires pour restaurer une instance PostgreSQL ou pour maintenir une réplication.
Pousser et obtenir des segments WAL de manière asynchrone.
Permet d'activer un fonctionnement asynchrone pour les commandes archive-push et archive-get.
Le fonctionnement asynchrone est plus performant car il permet de réutiliser les connexions et de tirer parti du parallélisme. Consultez les options spool-path, archive-get-queue-max, et archive-push-queue-max pour plus d'informations.
default: n
example: --archive-async
Taille maximale de la file d'attente pgBackRest archive-get.
Spécifie la taille maximale de la file d'attente archive-get lorsque archive-async est activée. La file d'attente est stockée sur l'emplacement définit par spool-path et est utilisée pour accélérer la réception des données de WAL par PostgreSQL.
La taille peut être saisie en octets (par défaut) ou en KB, MB, GB, TB ou PB où le multiplicateur est une puissance de 1024.
default: 134217728
allowed: 0-4503599627370496
example: --archive-get-queue-max=1073741824
Délai d'attente de l'archivage (archive timeout).
Définit le temps maximum, en secondes, à attendre pour que chaque segment WAL atteigne le dépôt d'archives de pgBackRest. Le délai s'applique aux commandes check et backup lorsqu'on attend que les segments WAL nécessaires à la cohérence de la sauvegarde soient archivés.
default: 60
allowed: 0.1-86400
example: --archive-timeout=30
Taille de la mémoire tampon pour les opérations sur les fichiers.
Définissez la taille de la mémoire tampon utilisée pour les opérations de copie, de compression et de décompression. Un maximum de 3 tampons seront utilisés à la fois par processus. Un maximum supplémentaire de 256K par processus peut être utilisé pour les tampons zlib.
La taille peut être saisie en octets (par défaut) ou en KB, MB, GB, TB, ou PB où le multiplicateur est une puissance de 1024. Par exemple, la valeur insensible à la casse 32k (ou 32KB) peut être utilisée au lieu de 32768.
Les valeurs autorisées, en octets, sont16384, 32768, 65536, 131072, 262144, 524288, 1048576, 2097152, 4194304, 8388608, et 16777216.
default: 1048576
example: --buffer-size=32K
Chemin d'accès à l'exécutable du client ssh.
Utilisez un client SSH spécifique lorsqu'une alternative est nécessaire ou lorsque l'exécutable ssh n'est pas dans $PATH.
default: ssh
example: --cmd-ssh=/usr/bin/ssh
Niveau de compression du réseau.
Définit le niveau de compression sur le réseau, lorsque compress-type=none et que la commande n'est pas exécutée sur le même hôte que le dépôt. La compression est utilisée pour réduire le trafic réseau mais peut être désactivée en définissant compress-level-network=0. Lorsque compress-type n'est pas égal à none, le paramètre compress-level-network est ignoré et compress-level est utilisé à la place de sorte que le fichier ne soit compressé qu'une seule fois. La compression SSH est toujours désactivée.
default: 3
allowed: 0-9
example: --compress-level-network=1
Fichier de configuration pgBackRest.
Utiliser cette option pour spécifier un fichier de configuration différent de celui par défaut.
default: /etc/pgbackrest/pgbackrest.conf
example: --config=/conf/pgbackrest/pgbackrest.conf
Emplacement des fichiers de configuration pgBackRest supplémentaires..
Les fichiers de configuration existant à l'emplacement spécifié avec l'extension .conf seront concaténés avec le fichier de configuration pgBackRest, ce qui donne un seul fichier de configuration.
default: /etc/pgbackrest/conf.d
example: --config-include-path=/conf/pgbackrest/conf.d
Emplacement du répertoire de racine de pgBackRest des fichiers de configuration.
Ce paramètre est utilisé pour écraser le chemin racine par défaut pour les options --config et --config-include-path à moins qu'elles ne soient explicitement définies sur la ligne de commande.
Par exemple, en utilisant uniquement --config-path=/conf/pgbackrest, la valeur par défaut de --config est /conf/pgbackrest/pgbackrest.conf et la valeur par défaut de --config-include-path est /conf/pgbackrest/conf.d.
default: /etc/pgbackrest
example: --config-path=/conf/pgbackrest
Délai d'attente des requêtes à la base de données.
Définit le délai d'attente, en secondes, pour les interrogations de la base de données. Cela inclut les fonctions
pg_start_backup() et
pg_stop_backup() qui peuvent chacune prendre un temps considérable. C'est pourquoi le délai d'attente doit être maintenu à un niveau élevé, sauf si vous savez que ces fonctions retourneront rapidement (c'est-à-dire si vous avez défini
startfast=y et que vous savez que l'instance de base de données ne générera pas beaucoup de segments WAL pendant la sauvegarde).
NOTE:
L'option db-timeout doit être inférieure à l'option protocol-timeout.
default: 1800
allowed: 0.1-604800
example: --db-timeout=600
Délai d'attente E/S.
Délai d'attente, en secondes, utilisé pour les connexions et les opérations de lecture/écriture.
Notez que l'ensemble de l'opération de lecture/écriture n'a pas besoin de se terminer dans ce délai mais une progression doit être constatée, même s'il ne s'agit que d'un seul octet.
default: 60
allowed: 0.1-3600
example: --io-timeout=120
Chemin d'accès où sont stockés les fichiers de verrouillage.
Le chemin de verrouillage fournit l'emplacement à pgBackRest pour créer des fichiers de verrouillage afin d'éviter que des opérations en conflictuelles ne soient exécutées simultanément.
default: /tmp/pgbackrest
example: --lock-path=/backup/db/lock
Utilisation d'un umask
neutre
Définit l'umask à 0000 pour que les modes dans le dépôt de sauvegarde soient créés de manière appropriée. Le mode par défaut du répertoire est 0750 et le mode par défaut du fichier est 0640. Pour les répertoires lock et log, les modes de répertoire et de fichier sont respectivement fixés à 0770 et 0660.
Pour utiliser l'umask de l'utilisateur en cours d'exécution, spécifiez plutôt neutral-umask=n dans le fichier de configuration ou --no-neutral-umask sur la ligne de commande.
default: y
example: --no-neutral-umask
Nombre de processus maximal lors utilisé lors de la compression et du transfert.
Chaque processus effectuera une compression et un transfert pour que la commande s'exécute plus rapidement, mais ne réglez pas process-max à un niveau si élevé que cela affecte les performances de la base de données.
default: 1
allowed: 1-999
example: --process-max=4
Délai d'attente du protocole.
Définit le délai, en secondes, durant lequel le processus local ou distant attendra qu'un nouveau message soit reçu au niveau de la couche protocole. Cela permet d'éviter que les processus n'attendent indéfiniment un message.
NOTE:
L'option protocol-timeout doit être supérieure à celle de db-timeout option.
default: 1830
allowed: 0.1-604800
example: --protocol-timeout=630
Activation de la fonction de keep-alive (maintien en vie).
Activation des messages de keep-alive (maintien en vie) sur les connexions réseaux.
default: y
example: --no-sck-keep-alive
Chemin où les données transitoires sont stockées.
Ce chemin est utilisé pour stocker les données nécessaires à la commande asynchrone archive-push et archive-get.
La commande asynchrone archive-push enregistre des accusés de réception dans le chemin du spool lorsqu'elle a stocké avec succès le WAL dans l'archive (et des erreurs en cas d'échec) afin que le processus de premier plan puisse rapidement notifier PostgreSQL. Les fichiers d'accusés de réception sont très petits (zéro octets en cas de succès et quelques centaines d'octets en cas d'erreur).
La commande asynchrone archive-get met en file d'attente le WAL dans le chemin du spool afin qu'il puisse être fourni très rapidement lorsque PostgreSQL le demande. Le déplacement de fichiers vers PostgreSQL est plus efficace lorsque le chemin du spool se trouve sur le même système de fichiers que pg_xlog/pg_wal.
Les données stockées dans le chemin du spool ne sont pas réellement temporaires puisqu'elles peuvent et doivent survivre à un redémarrage. Cependant, la perte des données dans le chemin du spool n'est pas un problème. pgBackRest va simplement revérifier chaque segment WAL pour s'assurer qu'il est bien archivé pour archive-push et reconstruire la file d'attente pour archive-get.
Le chemin du spool est destiné à être situé sur un système de fichiers local compatible Posix, et non sur un système de fichiers distant tel que NFS ou CIFS.
default: /var/spool/pgbackrest
example: --spool-path=/backup/db/spool
Defines the stanza.
Un stanza est la configuration de la sauvegarde d'une instance PostgreSQL où est définit l'endroit où il se trouve, la façon dont il sera sauvegardé, les options d'archivage, etc... La plupart des serveurs de base de données n'auront qu'une seule instance PostgreSQL et donc un stanza alors que les serveurs de sauvegarde auront un stanza pour chaque instance de base de données qui doit être sauvegardé.
Il est tentant de nommer le stanza en référence à l'instance primaire, mais un meilleur nom décrirait les bases de données contenues dans l'instance : comme le nom du stanza sera utilisé pour le primaire et tous les secondaire, il est plus approprié de choisir un nom qui décrit la fonction réelle du groupe d'instances, comme app ou dw, plutôt que le nom local de l'instance, comme main ou prod.
example: --stanza=main
Compteur Keep-alive.
Spécifie le nombre de messages TCP à garder en mémoire qui peuvent être perdus avant que la connexion ne soit considérée comme morte.
Cette option n'est disponible que sur les systèmes qui prennent en charge l'option réseau TCP_KEEPCNT.
allowed: 1-32
example: --tcp-keep-alive-count=3
Temps d'inactivité du keepalive.
Spécifie la durée (en secondes) sans activité du réseau après laquelle le système d'exploitation doit envoyer un message TCP de maintien en activité (keep-alive).
Cette option n'est disponible que sur les systèmes qui prennent en charge l'option réseau TCP_KEEPIDLE.
allowed: 1-3600
example: --tcp-keep-alive-idle=60
Temps d'intervalle de maintien en vie (keep-alive).
Spécifie le temps (en secondes) après lequel un message TCP de maintien en activité (keep-alive) non acquitté doit être retransmis.
Cette option n'est disponible que sur les systèmes qui prennent en charge l'option réseau TCP_KEEPINTVL.
allowed: 1-900
example: --tcp-keep-alive-interval=30
Niveau de journalisation en sortie sur la console.
Les niveaux de traces suivants sont pris en charge:
- off - Pas de journal de traces (non recommandé)
- error - Journaliser uniquement les erreurs
- warn - Journaliser les avertissements et les erreurs
- info - Journaliser les messages d'information, les avertissements et les erreurs
- detail - Journaliser les détails, les messages d'information, les avertissements et les erreurs
- debug - Journaliser les message de Débogage, les détails, les messages d'information, les avertissements et les erreurs
- trace - Journaliser les traces (un débogage très verbeux), les message de Débogage, les détails, les messages d'information, les avertissements et les erreurs
default: warn
example: --log-level-console=error
Niveau d'enregistrement des traces lors de l'enregistrement sur fichier.
Les niveaux de traces suivants sont pris en charge:
- off - Pas de journal de traces (non recommandé)
- error - Journaliser uniquement les erreurs
- warn - Journaliser les avertissements et les erreurs
- info - Journaliser les messages d'information, les avertissements et les erreurs
- detail - Journaliser les détails, les messages d'information, les avertissements et les erreurs
- debug - Journaliser les message de Débogage, les détails, les messages d'information, les avertissements et les erreurs
- trace - Journaliser les traces (un débogage très verbeux), les message de Débogage, les détails, les messages d'information, les avertissements et les erreurs
default: info
example: --log-level-file=debug
Niveau de traces sur la sortie console stderr.
Spécifie les niveaux de traces qui sortiront en
stderr plutôt que
stdout (spécifié par
log-level-console). L'horodatage et le processus ne seront pas émis sur
stderr.
Les niveaux de traces suivants sont pris en charge:
- off - Pas de journal de traces (non recommandé)
- error - Journaliser uniquement les erreurs
- warn - Journaliser les avertissements et les erreurs
- info - Journaliser les messages d'information, les avertissements et les erreurs
- detail - Journaliser les détails, les messages d'information, les avertissements et les erreurs
- debug - Journaliser les message de Débogage, les détails, les messages d'information, les avertissements et les erreurs
- trace - Journaliser les traces (un débogage très verbeux), les message de Débogage, les détails, les messages d'information, les avertissements et les erreurs
default: warn
example: --log-level-stderr=error
Emplacement où les fichiers journaux de traces sont stockés.
Le chemin d'accès au journal fournit un emplacement pour pgBackRest pour stocker les fichiers journaux. Notez que si log-level-file=off alors aucun chemin pour l'emplacement des journaux de traces n'est nécessaire.
default: /var/log/pgbackrest
example: --log-path=/backup/db/log
Activer la journalisation des traces dans les sous-processus.
Activez la journalisation des traces dans les fichiers pour tous les sous-processus créés par ce processus en utilisant le niveau de journalisation spécifié par log-level-file.
default: n
example: --log-subprocess
Activer l'horodatage dans les traces.
Active l'horodatage dans la console et l'enregistrement des fichiers. Cette option est désactivée dans des situations particulières telles que la génération de documentation.
default: y
example: --no-log-timestamp
Chiffrement (cipher) utilisé pour chiffrer le dépôt.
Les types de chiffrement suivants sont pris en charge:
- none - Le dépôt n'est pas chiffré.
- aes-256-cbc - Advanced Encryption Standard avec une clef de 256 bit
À noter que le chiffrement est toujours effectué côté client même si le type de stockage (par exemple S3) supporte le chiffrement.
default: none
example: --repo1-cipher-type=aes-256-cbc
Hôte de dépôt dans le cas d'un fonctionnement à distance via SSH.
Assurez-vous que l'authentification SSH soit correctement approuvé entre l'hôte PostgreSQL et l'hôte du référentiel.
Ce paramètre n'est pas nécessaire pour la sauvegarde et l'archivage sur un système de fichiers monté localement.
example: --repo1-host=repo1.domain.com
Nom obsolète: backup-host
Chemin des binaires pgBackRest sur l'hôte du dépôt.
Nécessaire uniquement si le chemin d'accès à pgbackrest est différent entre les hôtes locaux et l'hote du dépôt. S'il n'est pas défini, le chemin des binaires sur l'hôte du dépôt sera le même que le chemin des binaires locaux.
example: --repo1-host-cmd=/usr/lib/backrest/bin/pgbackrest
Nom obsolète: backup-cmd
Emplacement du fichier de configuration pgBackRest sur l'hôte du dépôt.
Définit l'emplacement du fichier de configuration sur l'hôte du dépôt. Ceci n'est nécessaire que si le fichier de configuration de l'hôte du dépôt se trouve dans un emplacement différent de celui du fichier de configuration local.
default: /etc/pgbackrest/pgbackrest.conf
example: --repo1-host-config=/conf/pgbackrest/pgbackrest.conf
Nom obsolète: backup-config
Chemin d'inclusion pgBackRest de la configuration de l'hôte du dépôt.
Définit l'emplacement du chemin d'inclusion de la configuration sur l'hôte du dépôt. Ceci n'est nécessaire que si le chemin d'inclusion de la configuration de l'hôte du dépôt se trouve à un endroit différent du chemin d'inclusion de la configuration locale.
default: /etc/pgbackrest/conf.d
example: --repo1-host-config-include-path=/conf/pgbackrest/conf.d
Chemin de configuration pgBackRest de l'hôte du dépôt.
Définit l'emplacement du chemin de configuration sur l'hôte du dépôt. Ceci n'est nécessaire que si le chemin de configuration de l'hôte du référentiel se trouve à un endroit différent du chemin de configuration local.
default: /etc/pgbackrest
example: --repo1-host-config-path=/conf/pgbackrest
Port de l'hôte du dépôt lorsque repo-host est défini.
Utilisez cette option pour spécifier un port non par défaut pour le protocole d'accès à l'hôte du dépôt. Actuellement, seul SSH est pris en charge
allowed: 0-65535
example: --repo1-host-port=25
Nom obsolète: backup-ssh-port
Utilisateur de l'hôte du dépôt lorsque repo-host est défini.
Définit l'utilisateur qui sera utilisé pour les opérations sur l'hôte du dépôt. De préférence, il ne s'agit pas de l'utilisateur postgres mais plutôt d'un autre utilisateur comme pgbackrest. Si PostgreSQL fonctionne sur l'hôte du dépôt, l'utilisateur postgres peut être placé dans le groupe pgbackrest afin qu'il ait les autorisations de lecture sur le dépôt sans pouvoir en endommager le contenu accidentellement.
default: pgbackrest
example: --repo1-host-user=repo-user
Nom obsolète: backup-user
Chemin d'accès où sont stockées les sauvegardes et les archives.
Le dépôt est l'endroit où pgBackRest stocke les sauvegardes et archive les segments des journaux de transaction (WAL).
Il peut être difficile d'estimer à l'avance l'espace dont vous aurez besoin. La meilleure chose à faire est de prendre quelques sauvegardes puis d'enregistrer la taille des différents types de sauvegardes (full/incr/diff) et de mesurer la quantité de WAL générée par jour. Cela vous donnera une idée générale de l'espace dont vous aurez besoin, même si, bien sûr, les besoins changeront probablement au fil du temps, à fur et à mesure de l'évolution de votre base de données.
default: /var/lib/pgbackrest
example: --repo1-path=/backup/db/backrest
S3 dépôt bucket.
Bucket S3 utilisé pour stocker le dépôt.
Les dépots pgBackRest peuvent être stockés à la racine du bucket en définissant repo-path=/ mais il est généralement préférable de spécifier un préfixe, comme par exemple /repo, afin que les logs et autres contenus générés par AWS puissent également être stockés dans le bucket.
example: --repo1-s3-bucket=pg-backup
Ficher SSL CA S3.
Utiliser un fichier CA autre que celui défini par défaut dans le système.
example: --repo1-s3-ca-file=/etc/pki/tls/certs/ca-bundle.crt
Chemin S3 SSL CA.
Utiliser un chemin pour le CA autre que celui défini par défaut dans le système.
example: --repo1-s3-ca-path=/etc/pki/tls/certs
Dépot S3 Point de terminaison (endpoint).
Le point de terminaison d'AWS doit être valable pour la région sélectionnée.
example: --repo1-s3-endpoint=s3.amazonaws.com
Hôte du dépot S3.
Conntecter sur un hôte différent du point de terminaison (endpoint). Il est généralement utilisé à des fins de test.
example: --repo1-s3-host=127.0.0.1
Port de connection au dépot S3.
Port à utiliser lors de la connexion au point de terminaison (ou à l'hôte si spécifié).
default: 443
allowed: 1-65535
example: --repo1-s3-port=9000
Région du dépôt S3.
La région d'AWS où le bucket a été créé.
example: --repo1-s3-region=us-east-1
S3 URI formats.
Les formats URI suivants sont pris en charge:
- host - Connexion à l'hôte bucket.endpoint.
- path - Connexion à l'hôte endpoint et ajout du bucket aux URIs.
default: host
example: --repo1-s3-uri-style=path
Vérifier le certificat du serveur S3.
Désactive la vérification du certificat du serveur S3. Cette fonction ne doit être utilisée que dans le cadre de tests ou dans le cas d'une utilisation avec un certificat a été auto-signé.
default: y
example: --no-repo1-s3-verify-tls
Nom obsolète: repo-s3-verify-ssl
Type de stockage utilisé pour le dépôt.
Les types de stockage suivants sont pris en charge :
- cifs - Comme posix, mais désactive les liens et les fsyncs sur les répertoires
- posix - Systèmes de fichiers conformes à Posix
- s3 - Service de stockage d'objet (AWS Simple Storage Service)
default: posix
example: --repo1-type=cifs
PostgreSQL data directory.
Ce paramètre doit être le même que le paramètre data_directory du fichier postgresql.conf. Même si cette valeur peut être lue à partir de postgresql.conf ou PostgreSQL, il est conseillé de la définir au cas où ces ressources ne seraient pas disponibles pendant un scénario de restauration ou de sauvegarde hors ligne.
L'option pg-path est testée par rapport à la valeur indiquée par PostgreSQL à chaque sauvegarde en ligne, elle doit donc toujours être à jour.
example: --pg1-path=/data/db
Nom obsolète: db-path
Un segment WAL peut être poussé immédiatement vers les archives ou stocké localement selon la valeur de archive-async
Pousser et obtenir des segments WAL de manière asynchrone.
Permet d'activer un fonctionnement asynchrone pour les commandes archive-push et archive-get.
Le fonctionnement asynchrone est plus performant car il permet de réutiliser les connexions et de tirer parti du parallélisme. Consultez les options spool-path, archive-get-queue-max, et archive-push-queue-max pour plus d'informations.
default: n
example: --archive-async
Taille maximale de la file d'attente PostgreSQL archive..
Une fois la limite atteinte, voici ce qui se produira :
- pgBackRest signalera à PostgreSQL que les journaux de transaction (WAL) ont été archivée avec succès, puis, LES SUPPRIMES.
- Un avertissement sera émis dans le journal de trace de PostgreSQL.
Si cela se produit, le flux d'archives sera interrompu et le PITR ne sera plus possible au-delà de ce moment. Une nouvelle sauvegarde est alors indispensable pour retrouver la fonctionnalité de restauration complète.
En mode asynchrone, la totalité de la file d'attente sera supprimée afin d'éviter que des flots de WAL ne passent avant que la limite de la file ne soit à nouveau dépassée.
Le but de cette fonction est d'éviter que le disque utilisé pour le stockage du journal (pg_wal ou pg_log) ne se remplisse, ce qui entraînerait l'arrêt complet de l'instance
PostgreSQL. Il est peut être préférable de perdre la sauvegarde que d'avoir
PostgreSQL s'arrêter.
La taille peut être saisie en octets (par défaut) ou en KB, MB, GB, TB ou PB où le multiplicateur est une puissance de 1024.
allowed: 0-4503599627370496
example: --archive-push-queue-max=1GB
Nom obsolète: archive-queue-max
Délai d'attente de l'archivage (archive timeout).
Définit le temps maximum, en secondes, à attendre pour que chaque segment WAL atteigne le dépôt d'archives de pgBackRest. Le délai s'applique aux commandes check et backup lorsqu'on attend que les segments WAL nécessaires à la cohérence de la sauvegarde soient archivés.
default: 60
allowed: 0.1-86400
example: --archive-timeout=30
Taille de la mémoire tampon pour les opérations sur les fichiers.
Définissez la taille de la mémoire tampon utilisée pour les opérations de copie, de compression et de décompression. Un maximum de 3 tampons seront utilisés à la fois par processus. Un maximum supplémentaire de 256K par processus peut être utilisé pour les tampons zlib.
La taille peut être saisie en octets (par défaut) ou en KB, MB, GB, TB, ou PB où le multiplicateur est une puissance de 1024. Par exemple, la valeur insensible à la casse 32k (ou 32KB) peut être utilisée au lieu de 32768.
Les valeurs autorisées, en octets, sont16384, 32768, 65536, 131072, 262144, 524288, 1048576, 2097152, 4194304, 8388608, et 16777216.
default: 1048576
example: --buffer-size=32K
Chemin d'accès à l'exécutable du client ssh.
Utilisez un client SSH spécifique lorsqu'une alternative est nécessaire ou lorsque l'exécutable ssh n'est pas dans $PATH.
default: ssh
example: --cmd-ssh=/usr/bin/ssh
Utilisez la compression de fichiers.
Les fichiers de sauvegarde sont compatibles avec les outils de compression en ligne de commande.
Cette option est désormais obsolète. L'option compress-type doit être utilisée à la place.
default: y
example: --no-compress
Niveau de compression des fichiers.
Définit le niveau à utiliser pour la compression des fichiers lorsque compress-type n'est pas égal à none ou compress=y (déprécié).
allowed: 0-9
example: --compress-level=9
Niveau de compression du réseau.
Définit le niveau de compression sur le réseau, lorsque compress-type=none et que la commande n'est pas exécutée sur le même hôte que le dépôt. La compression est utilisée pour réduire le trafic réseau mais peut être désactivée en définissant compress-level-network=0. Lorsque compress-type n'est pas égal à none, le paramètre compress-level-network est ignoré et compress-level est utilisé à la place de sorte que le fichier ne soit compressé qu'une seule fois. La compression SSH est toujours désactivée.
default: 3
allowed: 0-9
example: --compress-level-network=1
Type de compression pour les fichiers.
Les types de compression suivants sont pris en charge :
- bz2 - format de compression bzip2
- gz - format de compression gzip
- lz4 - format de compression lz4 (non disponible sur toutes les plateformes)
- zst - format de compression Zstandard (non disponible sur toutes les plateformes)
default: gz
example: --compress-type=n
Fichier de configuration pgBackRest.
Utiliser cette option pour spécifier un fichier de configuration différent de celui par défaut.
default: /etc/pgbackrest/pgbackrest.conf
example: --config=/conf/pgbackrest/pgbackrest.conf
Emplacement des fichiers de configuration pgBackRest supplémentaires..
Les fichiers de configuration existant à l'emplacement spécifié avec l'extension .conf seront concaténés avec le fichier de configuration pgBackRest, ce qui donne un seul fichier de configuration.
default: /etc/pgbackrest/conf.d
example: --config-include-path=/conf/pgbackrest/conf.d
Emplacement du répertoire de racine de pgBackRest des fichiers de configuration.
Ce paramètre est utilisé pour écraser le chemin racine par défaut pour les options --config et --config-include-path à moins qu'elles ne soient explicitement définies sur la ligne de commande.
Par exemple, en utilisant uniquement --config-path=/conf/pgbackrest, la valeur par défaut de --config est /conf/pgbackrest/pgbackrest.conf et la valeur par défaut de --config-include-path est /conf/pgbackrest/conf.d.
default: /etc/pgbackrest
example: --config-path=/conf/pgbackrest
Délai d'attente des requêtes à la base de données.
Définit le délai d'attente, en secondes, pour les interrogations de la base de données. Cela inclut les fonctions
pg_start_backup() et
pg_stop_backup() qui peuvent chacune prendre un temps considérable. C'est pourquoi le délai d'attente doit être maintenu à un niveau élevé, sauf si vous savez que ces fonctions retourneront rapidement (c'est-à-dire si vous avez défini
startfast=y et que vous savez que l'instance de base de données ne générera pas beaucoup de segments WAL pendant la sauvegarde).
NOTE:
L'option db-timeout doit être inférieure à l'option protocol-timeout.
default: 1800
allowed: 0.1-604800
example: --db-timeout=600
Délai d'attente E/S.
Délai d'attente, en secondes, utilisé pour les connexions et les opérations de lecture/écriture.
Notez que l'ensemble de l'opération de lecture/écriture n'a pas besoin de se terminer dans ce délai mais une progression doit être constatée, même s'il ne s'agit que d'un seul octet.
default: 60
allowed: 0.1-3600
example: --io-timeout=120
Chemin d'accès où sont stockés les fichiers de verrouillage.
Le chemin de verrouillage fournit l'emplacement à pgBackRest pour créer des fichiers de verrouillage afin d'éviter que des opérations en conflictuelles ne soient exécutées simultanément.
default: /tmp/pgbackrest
example: --lock-path=/backup/db/lock
Utilisation d'un umask
neutre
Définit l'umask à 0000 pour que les modes dans le dépôt de sauvegarde soient créés de manière appropriée. Le mode par défaut du répertoire est 0750 et le mode par défaut du fichier est 0640. Pour les répertoires lock et log, les modes de répertoire et de fichier sont respectivement fixés à 0770 et 0660.
Pour utiliser l'umask de l'utilisateur en cours d'exécution, spécifiez plutôt neutral-umask=n dans le fichier de configuration ou --no-neutral-umask sur la ligne de commande.
default: y
example: --no-neutral-umask
Nombre de processus maximal lors utilisé lors de la compression et du transfert.
Chaque processus effectuera une compression et un transfert pour que la commande s'exécute plus rapidement, mais ne réglez pas process-max à un niveau si élevé que cela affecte les performances de la base de données.
default: 1
allowed: 1-999
example: --process-max=4
Délai d'attente du protocole.
Définit le délai, en secondes, durant lequel le processus local ou distant attendra qu'un nouveau message soit reçu au niveau de la couche protocole. Cela permet d'éviter que les processus n'attendent indéfiniment un message.
NOTE:
L'option protocol-timeout doit être supérieure à celle de db-timeout option.
default: 1830
allowed: 0.1-604800
example: --protocol-timeout=630
Activation de la fonction de keep-alive (maintien en vie).
Activation des messages de keep-alive (maintien en vie) sur les connexions réseaux.
default: y
example: --no-sck-keep-alive
Chemin où les données transitoires sont stockées.
Ce chemin est utilisé pour stocker les données nécessaires à la commande asynchrone archive-push et archive-get.
La commande asynchrone archive-push enregistre des accusés de réception dans le chemin du spool lorsqu'elle a stocké avec succès le WAL dans l'archive (et des erreurs en cas d'échec) afin que le processus de premier plan puisse rapidement notifier PostgreSQL. Les fichiers d'accusés de réception sont très petits (zéro octets en cas de succès et quelques centaines d'octets en cas d'erreur).
La commande asynchrone archive-get met en file d'attente le WAL dans le chemin du spool afin qu'il puisse être fourni très rapidement lorsque PostgreSQL le demande. Le déplacement de fichiers vers PostgreSQL est plus efficace lorsque le chemin du spool se trouve sur le même système de fichiers que pg_xlog/pg_wal.
Les données stockées dans le chemin du spool ne sont pas réellement temporaires puisqu'elles peuvent et doivent survivre à un redémarrage. Cependant, la perte des données dans le chemin du spool n'est pas un problème. pgBackRest va simplement revérifier chaque segment WAL pour s'assurer qu'il est bien archivé pour archive-push et reconstruire la file d'attente pour archive-get.
Le chemin du spool est destiné à être situé sur un système de fichiers local compatible Posix, et non sur un système de fichiers distant tel que NFS ou CIFS.
default: /var/spool/pgbackrest
example: --spool-path=/backup/db/spool
Defines the stanza.
Un stanza est la configuration de la sauvegarde d'une instance PostgreSQL où est définit l'endroit où il se trouve, la façon dont il sera sauvegardé, les options d'archivage, etc... La plupart des serveurs de base de données n'auront qu'une seule instance PostgreSQL et donc un stanza alors que les serveurs de sauvegarde auront un stanza pour chaque instance de base de données qui doit être sauvegardé.
Il est tentant de nommer le stanza en référence à l'instance primaire, mais un meilleur nom décrirait les bases de données contenues dans l'instance : comme le nom du stanza sera utilisé pour le primaire et tous les secondaire, il est plus approprié de choisir un nom qui décrit la fonction réelle du groupe d'instances, comme app ou dw, plutôt que le nom local de l'instance, comme main ou prod.
example: --stanza=main
Compteur Keep-alive.
Spécifie le nombre de messages TCP à garder en mémoire qui peuvent être perdus avant que la connexion ne soit considérée comme morte.
Cette option n'est disponible que sur les systèmes qui prennent en charge l'option réseau TCP_KEEPCNT.
allowed: 1-32
example: --tcp-keep-alive-count=3
Temps d'inactivité du keepalive.
Spécifie la durée (en secondes) sans activité du réseau après laquelle le système d'exploitation doit envoyer un message TCP de maintien en activité (keep-alive).
Cette option n'est disponible que sur les systèmes qui prennent en charge l'option réseau TCP_KEEPIDLE.
allowed: 1-3600
example: --tcp-keep-alive-idle=60
Temps d'intervalle de maintien en vie (keep-alive).
Spécifie le temps (en secondes) après lequel un message TCP de maintien en activité (keep-alive) non acquitté doit être retransmis.
Cette option n'est disponible que sur les systèmes qui prennent en charge l'option réseau TCP_KEEPINTVL.
allowed: 1-900
example: --tcp-keep-alive-interval=30
Niveau de journalisation en sortie sur la console.
Les niveaux de traces suivants sont pris en charge:
- off - Pas de journal de traces (non recommandé)
- error - Journaliser uniquement les erreurs
- warn - Journaliser les avertissements et les erreurs
- info - Journaliser les messages d'information, les avertissements et les erreurs
- detail - Journaliser les détails, les messages d'information, les avertissements et les erreurs
- debug - Journaliser les message de Débogage, les détails, les messages d'information, les avertissements et les erreurs
- trace - Journaliser les traces (un débogage très verbeux), les message de Débogage, les détails, les messages d'information, les avertissements et les erreurs
default: warn
example: --log-level-console=error
Niveau d'enregistrement des traces lors de l'enregistrement sur fichier.
Les niveaux de traces suivants sont pris en charge:
- off - Pas de journal de traces (non recommandé)
- error - Journaliser uniquement les erreurs
- warn - Journaliser les avertissements et les erreurs
- info - Journaliser les messages d'information, les avertissements et les erreurs
- detail - Journaliser les détails, les messages d'information, les avertissements et les erreurs
- debug - Journaliser les message de Débogage, les détails, les messages d'information, les avertissements et les erreurs
- trace - Journaliser les traces (un débogage très verbeux), les message de Débogage, les détails, les messages d'information, les avertissements et les erreurs
default: info
example: --log-level-file=debug
Niveau de traces sur la sortie console stderr.
Spécifie les niveaux de traces qui sortiront en
stderr plutôt que
stdout (spécifié par
log-level-console). L'horodatage et le processus ne seront pas émis sur
stderr.
Les niveaux de traces suivants sont pris en charge:
- off - Pas de journal de traces (non recommandé)
- error - Journaliser uniquement les erreurs
- warn - Journaliser les avertissements et les erreurs
- info - Journaliser les messages d'information, les avertissements et les erreurs
- detail - Journaliser les détails, les messages d'information, les avertissements et les erreurs
- debug - Journaliser les message de Débogage, les détails, les messages d'information, les avertissements et les erreurs
- trace - Journaliser les traces (un débogage très verbeux), les message de Débogage, les détails, les messages d'information, les avertissements et les erreurs
default: warn
example: --log-level-stderr=error
Emplacement où les fichiers journaux de traces sont stockés.
Le chemin d'accès au journal fournit un emplacement pour pgBackRest pour stocker les fichiers journaux. Notez que si log-level-file=off alors aucun chemin pour l'emplacement des journaux de traces n'est nécessaire.
default: /var/log/pgbackrest
example: --log-path=/backup/db/log
Activer la journalisation des traces dans les sous-processus.
Activez la journalisation des traces dans les fichiers pour tous les sous-processus créés par ce processus en utilisant le niveau de journalisation spécifié par log-level-file.
default: n
example: --log-subprocess
Activer l'horodatage dans les traces.
Active l'horodatage dans la console et l'enregistrement des fichiers. Cette option est désactivée dans des situations particulières telles que la génération de documentation.
default: y
example: --no-log-timestamp
Chiffrement (cipher) utilisé pour chiffrer le dépôt.
Les types de chiffrement suivants sont pris en charge:
- none - Le dépôt n'est pas chiffré.
- aes-256-cbc - Advanced Encryption Standard avec une clef de 256 bit
À noter que le chiffrement est toujours effectué côté client même si le type de stockage (par exemple S3) supporte le chiffrement.
default: none
example: --repo1-cipher-type=aes-256-cbc
Hôte de dépôt dans le cas d'un fonctionnement à distance via SSH.
Assurez-vous que l'authentification SSH soit correctement approuvé entre l'hôte PostgreSQL et l'hôte du référentiel.
Ce paramètre n'est pas nécessaire pour la sauvegarde et l'archivage sur un système de fichiers monté localement.
example: --repo1-host=repo1.domain.com
Nom obsolète: backup-host
Chemin des binaires pgBackRest sur l'hôte du dépôt.
Nécessaire uniquement si le chemin d'accès à pgbackrest est différent entre les hôtes locaux et l'hote du dépôt. S'il n'est pas défini, le chemin des binaires sur l'hôte du dépôt sera le même que le chemin des binaires locaux.
example: --repo1-host-cmd=/usr/lib/backrest/bin/pgbackrest
Nom obsolète: backup-cmd
Emplacement du fichier de configuration pgBackRest sur l'hôte du dépôt.
Définit l'emplacement du fichier de configuration sur l'hôte du dépôt. Ceci n'est nécessaire que si le fichier de configuration de l'hôte du dépôt se trouve dans un emplacement différent de celui du fichier de configuration local.
default: /etc/pgbackrest/pgbackrest.conf
example: --repo1-host-config=/conf/pgbackrest/pgbackrest.conf
Nom obsolète: backup-config
Chemin d'inclusion pgBackRest de la configuration de l'hôte du dépôt.
Définit l'emplacement du chemin d'inclusion de la configuration sur l'hôte du dépôt. Ceci n'est nécessaire que si le chemin d'inclusion de la configuration de l'hôte du dépôt se trouve à un endroit différent du chemin d'inclusion de la configuration locale.
default: /etc/pgbackrest/conf.d
example: --repo1-host-config-include-path=/conf/pgbackrest/conf.d
Chemin de configuration pgBackRest de l'hôte du dépôt.
Définit l'emplacement du chemin de configuration sur l'hôte du dépôt. Ceci n'est nécessaire que si le chemin de configuration de l'hôte du référentiel se trouve à un endroit différent du chemin de configuration local.
default: /etc/pgbackrest
example: --repo1-host-config-path=/conf/pgbackrest
Port de l'hôte du dépôt lorsque repo-host est défini.
Utilisez cette option pour spécifier un port non par défaut pour le protocole d'accès à l'hôte du dépôt. Actuellement, seul SSH est pris en charge
allowed: 0-65535
example: --repo1-host-port=25
Nom obsolète: backup-ssh-port
Utilisateur de l'hôte du dépôt lorsque repo-host est défini.
Définit l'utilisateur qui sera utilisé pour les opérations sur l'hôte du dépôt. De préférence, il ne s'agit pas de l'utilisateur postgres mais plutôt d'un autre utilisateur comme pgbackrest. Si PostgreSQL fonctionne sur l'hôte du dépôt, l'utilisateur postgres peut être placé dans le groupe pgbackrest afin qu'il ait les autorisations de lecture sur le dépôt sans pouvoir en endommager le contenu accidentellement.
default: pgbackrest
example: --repo1-host-user=repo-user
Nom obsolète: backup-user
Chemin d'accès où sont stockées les sauvegardes et les archives.
Le dépôt est l'endroit où pgBackRest stocke les sauvegardes et archive les segments des journaux de transaction (WAL).
Il peut être difficile d'estimer à l'avance l'espace dont vous aurez besoin. La meilleure chose à faire est de prendre quelques sauvegardes puis d'enregistrer la taille des différents types de sauvegardes (full/incr/diff) et de mesurer la quantité de WAL générée par jour. Cela vous donnera une idée générale de l'espace dont vous aurez besoin, même si, bien sûr, les besoins changeront probablement au fil du temps, à fur et à mesure de l'évolution de votre base de données.
default: /var/lib/pgbackrest
example: --repo1-path=/backup/db/backrest
S3 dépôt bucket.
Bucket S3 utilisé pour stocker le dépôt.
Les dépots pgBackRest peuvent être stockés à la racine du bucket en définissant repo-path=/ mais il est généralement préférable de spécifier un préfixe, comme par exemple /repo, afin que les logs et autres contenus générés par AWS puissent également être stockés dans le bucket.
example: --repo1-s3-bucket=pg-backup
Ficher SSL CA S3.
Utiliser un fichier CA autre que celui défini par défaut dans le système.
example: --repo1-s3-ca-file=/etc/pki/tls/certs/ca-bundle.crt
Chemin S3 SSL CA.
Utiliser un chemin pour le CA autre que celui défini par défaut dans le système.
example: --repo1-s3-ca-path=/etc/pki/tls/certs
Dépot S3 Point de terminaison (endpoint).
Le point de terminaison d'AWS doit être valable pour la région sélectionnée.
example: --repo1-s3-endpoint=s3.amazonaws.com
Hôte du dépot S3.
Conntecter sur un hôte différent du point de terminaison (endpoint). Il est généralement utilisé à des fins de test.
example: --repo1-s3-host=127.0.0.1
Port de connection au dépot S3.
Port à utiliser lors de la connexion au point de terminaison (ou à l'hôte si spécifié).
default: 443
allowed: 1-65535
example: --repo1-s3-port=9000
Région du dépôt S3.
La région d'AWS où le bucket a été créé.
example: --repo1-s3-region=us-east-1
S3 URI formats.
Les formats URI suivants sont pris en charge:
- host - Connexion à l'hôte bucket.endpoint.
- path - Connexion à l'hôte endpoint et ajout du bucket aux URIs.
default: host
example: --repo1-s3-uri-style=path
Vérifier le certificat du serveur S3.
Désactive la vérification du certificat du serveur S3. Cette fonction ne doit être utilisée que dans le cadre de tests ou dans le cas d'une utilisation avec un certificat a été auto-signé.
default: y
example: --no-repo1-s3-verify-tls
Nom obsolète: repo-s3-verify-ssl
Type de stockage utilisé pour le dépôt.
Les types de stockage suivants sont pris en charge :
- cifs - Comme posix, mais désactive les liens et les fsyncs sur les répertoires
- posix - Systèmes de fichiers conformes à Posix
- s3 - Service de stockage d'objet (AWS Simple Storage Service)
default: posix
example: --repo1-type=cifs
PostgreSQL data directory.
Ce paramètre doit être le même que le paramètre data_directory du fichier postgresql.conf. Même si cette valeur peut être lue à partir de postgresql.conf ou PostgreSQL, il est conseillé de la définir au cas où ces ressources ne seraient pas disponibles pendant un scénario de restauration ou de sauvegarde hors ligne.
L'option pg-path est testée par rapport à la valeur indiquée par PostgreSQL à chaque sauvegarde en ligne, elle doit donc toujours être à jour.
example: --pg1-path=/data/db
Nom obsolète: db-path
pgBackRest n'a pas de planificateur de taches intégré, il est donc conseillé de l'exécuter à partir de cron ou d'un autre système de planification.
Contrôle que les segments WAL se trouvent bien dans les archives à la fin du processus de sauvegarde.
Contrôle que tous les segments de WAL nécessaires pour rendre la sauvegarde cohérente sont présents dans les archives de WAL. Il est conseillé de laisser ce paramètre par défaut, à moins que vous n'utilisiez une autre méthode d'archivage..
Cette option doit être activée si archive-copy est activé.
default: y
example: --no-archive-check
Copier tous les segments WAL nécessaires à la cohérence de la sauvegarde.
Cette option un peu parano protège contre la corruption dans les archives des segments WAL en stockant les segments WAL nécessaires à la cohérence directement dans la sauvegarde. Les segments WAL sont toujours stockés dans l'archive, donc cette option utilisera de l'espace supplémentaire.
Lors de la restauration, les segments WAL seront présents dans pg_xlog/pg_wal et PostgreSQL les utilisera de préférence plutôt que d'appeler la restore_command.
L'option archive-check doit être activée si archive-copy est activée
default: n
example: --archive-copy
Délai d'attente de l'archivage (archive timeout).
Définit le temps maximum, en secondes, à attendre pour que chaque segment WAL atteigne le dépôt d'archives de pgBackRest. Le délai s'applique aux commandes check et backup lorsqu'on attend que les segments WAL nécessaires à la cohérence de la sauvegarde soient archivés.
default: 60
allowed: 0.1-86400
example: --archive-timeout=30
Sauvegarde depuis l'instance standby secondaire.
Activer la sauvegarde depuis le secondaire en standby pour réduire la charge sur l'instance primaire. Cette option nécessite que les hôtes primary (primaire) et standby (secondaire en standby) soit correctement configurés.
default: n
example: --backup-standby
Validation des sommes de contrôle des pages de données (checksums).
Permet à pgBackRest de valider toutes les sommes de contrôle des pages de données pendant la sauvegarde de l'instance. Cette option est automatiquement activée lorsque les sommes de contrôle des pages de données sont activées sur l'instance.
Un échec dans la validation de la somme de contrôle n'annulera pas la sauvegarde. Au contraire, des avertissements seront émis dans le journal des traces (et par défaut sur la console); la liste des pages non valides sera stockée dans le manifeste de sauvegarde.
example: --no-checksum-page
Exclusion des chemins/fichiers de la sauvegarde..
Toutes les exclusions sont relatives à
$PGDATA. Si l'exclusion se termine par / alors seuls les fichiers du répertoire spécifié seront exclus, par exemple
--exclude=junk/ exclura tous les fichiers du répertoire
$PGDATA/junk mais inclura le répertoire lui-même. Si l'exclusion ne se termine pas par / alors le fichier peut correspondre exactement à l'exclusion ou correspondre à / apposé à l'exclusion, par exemple
--exclude=junk exclura le répertoire
$PGDATA/junk et tous les fichiers qu'il contient.
Soyez prudent en utilisant cette fonctionnalité : il est très rapide d'exclure quelque chose d'essentiel qui rendra la sauvegarde incohérente. Assurez-vous de tester vos restaurations !
Tous les fichiers exclus seront journalisés au niveau
info avec la règle d'exclusion.Veillez à vérifier la liste des fichiers exclus pour vous assurer que rien d'inattendu n'est exclu.
NOTE:
Les exclusions ne sont pas prises en compte lors des restaurations delta. Tout fichier/répertoire qui a été exclu par la sauvegarde sera supprimé lors de la restauration delta.
Cette option ne doit pas être utilisée pour exclure les journaux de traces
PostgreSQL d'une sauvegarde. Les journaux peuvent être déplacés hors du répertoire
PGDATA en utilisant le paramètre
PostgreSQL log_directory, ce qui présente l'avantage de permettre la préservation des journaux après une restauration.
Les exclusions multiples peuvent être spécifiées sur la ligne de commande ou dans le fichier de configuration.
example: --exclude=junk/
Forcer une sauvegarde hors ligne.
Lorsqu'il est utilisé avec --no-start-stop une sauvegarde sera exécutée même si pgBackRest pense que PostgreSQL est en cours d'exécution. Cette option doit être utilisée avec une extrême prudence car elle risque d'entraîner une sauvegarde incorrecte.
Il y quelques scénarios où une telle sauvegarde pourrait encore être utile dans ces conditions. Par exemple, si un serveur tombe en panne et que le volume de l'instance de base de données ne peut être monté qu'en lecture seule, il serait judicieux d'effectuer une sauvegarde même si postmaster.pid est présent. Dans ce cas, il serait plus intéressant de revenir à la sauvegarde précédente et de rejouer le WAL, mais il est possible qu'il y ait une transaction très importante dans un segment du WAL qui n'a pas été archivé.
default: n
example: --force
Seuil de déclenchement de la sauvegarde du manifeste lors de la sauvegarde.
Définit la fréquence à laquelle le manifeste sera sauvegardé lors d'une sauvegarde. La sauvegarde du manifeste est importante car elle permet de stocker les sommes de contrôle et de faire fonctionner efficacement la fonction de reprise. Le volume réel utilisé est de 1 % de la taille de la sauvegarde ou manifest-save-threshold, la valeur la plus élevée étant retenue.
La taille peut être saisie en octets (par défaut) ou en KB, MB, GB, TB, ou PB où le multiplicateur est une puissance de 1024.
default: 1073741824
allowed: 1-1099511627776
example: --manifest-save-threshold=5G
Effectuer une sauvegarde en ligne.
Le fait de spécifier --no-online empêche pgBackRest de lancer pg_start_backup() et pg_stop_backup() sur l'instance de la base de données. Pour que --no-online fonctionne, l'instance PostgreSQL doit être arrêté sinon pgBackRest générera une erreur.
L'objectif de cette option est de permettre des sauvegardes hors ligne. Le répertoire pg_xlog/pg_wal est copié tel quel et archive-check est automatiquement désactivé lors de la sauvegarde.
default: y
example: --no-online
Permettre la reprise d'une sauvegarde échoué
Définit si la fonctionnalité de reprise est activée. La reprise peut réduire considérablement le temps nécessaire pour exécuter une sauvegarde si une sauvegarde précédente du même type a échoué. Elle ajoute toutefois de la complexité, de sorte qu'il peut être conseillé de la désactiver dans les environnements qui n'ont pas besoin de cette fonction.
default: y
example: --no-resume
Forcer un point de contrôle (checkpoint) pour lancer plus rapidement la sauvegarde.
Force un point de contrôle (en passant le paramètre y à fast de pg_start_backup()) pour que la sauvegarde commence immédiatement. Sinon, la sauvegarde commencera après le prochain point de contrôle contrôle.
Cette fonction ne fonctionne qu'à partir de PostgreSQL version >= 8.4.
default: n
example: --start-fast
Arrêt d'une sauvegarde antérieure défaillante lors la nouvelle sauvegarde.
Cette opération ne sera effectuée que si un verrouillage consultatif exclusif peut être acquis afin de faire la preuve que le processus de sauvegarde antérieur ayant échoué s'est réellement arrêté.
Cette fonctionnalité repose sur pg_is_in_backup() et ne fonctionne donc qu'avec PostgreSQL >= 9.3.
Cette fonctionnalité n'est pas prise en charge pour PostgreSQL >= 9.6 car les sauvegardes sont exécutées en mode non exclusif.
Ce paramètre est désactivé par défaut car il suppose que pgBackRest est le seul processus qui effectue exclusivement des sauvegardes en ligne. Il se base sur un verrou consultatif que seul pgBackRest définit afin de pouvoir interrompre les autres processus qui effectuent des sauvegardes exclusives en ligne. Notez que base_backup et pg_dump sont sans risque avec ce paramétrage car ils n'appellent pas pg_start_backup() et ne sont donc pas exclusifs.
default: n
example: --stop-auto
Type de sauvegarde.
Les types de sauvegarde ci-dessous sont pris en charge:
- full - tous les fichiers de l'instance de bases de données seront copiés et il n'y aura aucune dépendance par rapport aux sauvegardes précédentes.
- incr - incrémentale basé sur la dernière sauvegarde complète réussit.
- diff - comme une sauvegarde incrémentale mais toujours basée sur la dernière sauvegarde complète.
default: incr
example: --type=full
Taille de la mémoire tampon pour les opérations sur les fichiers.
Définissez la taille de la mémoire tampon utilisée pour les opérations de copie, de compression et de décompression. Un maximum de 3 tampons seront utilisés à la fois par processus. Un maximum supplémentaire de 256K par processus peut être utilisé pour les tampons zlib.
La taille peut être saisie en octets (par défaut) ou en KB, MB, GB, TB, ou PB où le multiplicateur est une puissance de 1024. Par exemple, la valeur insensible à la casse 32k (ou 32KB) peut être utilisée au lieu de 32768.
Les valeurs autorisées, en octets, sont16384, 32768, 65536, 131072, 262144, 524288, 1048576, 2097152, 4194304, 8388608, et 16777216.
default: 1048576
example: --buffer-size=32K
Chemin d'accès à l'exécutable du client ssh.
Utilisez un client SSH spécifique lorsqu'une alternative est nécessaire ou lorsque l'exécutable ssh n'est pas dans $PATH.
default: ssh
example: --cmd-ssh=/usr/bin/ssh
Utilisez la compression de fichiers.
Les fichiers de sauvegarde sont compatibles avec les outils de compression en ligne de commande.
Cette option est désormais obsolète. L'option compress-type doit être utilisée à la place.
default: y
example: --no-compress
Niveau de compression des fichiers.
Définit le niveau à utiliser pour la compression des fichiers lorsque compress-type n'est pas égal à none ou compress=y (déprécié).
allowed: 0-9
example: --compress-level=9
Niveau de compression du réseau.
Définit le niveau de compression sur le réseau, lorsque compress-type=none et que la commande n'est pas exécutée sur le même hôte que le dépôt. La compression est utilisée pour réduire le trafic réseau mais peut être désactivée en définissant compress-level-network=0. Lorsque compress-type n'est pas égal à none, le paramètre compress-level-network est ignoré et compress-level est utilisé à la place de sorte que le fichier ne soit compressé qu'une seule fois. La compression SSH est toujours désactivée.
default: 3
allowed: 0-9
example: --compress-level-network=1
Type de compression pour les fichiers.
Les types de compression suivants sont pris en charge :
- bz2 - format de compression bzip2
- gz - format de compression gzip
- lz4 - format de compression lz4 (non disponible sur toutes les plateformes)
- zst - format de compression Zstandard (non disponible sur toutes les plateformes)
default: gz
example: --compress-type=n
Fichier de configuration pgBackRest.
Utiliser cette option pour spécifier un fichier de configuration différent de celui par défaut.
default: /etc/pgbackrest/pgbackrest.conf
example: --config=/conf/pgbackrest/pgbackrest.conf
Emplacement des fichiers de configuration pgBackRest supplémentaires..
Les fichiers de configuration existant à l'emplacement spécifié avec l'extension .conf seront concaténés avec le fichier de configuration pgBackRest, ce qui donne un seul fichier de configuration.
default: /etc/pgbackrest/conf.d
example: --config-include-path=/conf/pgbackrest/conf.d
Emplacement du répertoire de racine de pgBackRest des fichiers de configuration.
Ce paramètre est utilisé pour écraser le chemin racine par défaut pour les options --config et --config-include-path à moins qu'elles ne soient explicitement définies sur la ligne de commande.
Par exemple, en utilisant uniquement --config-path=/conf/pgbackrest, la valeur par défaut de --config est /conf/pgbackrest/pgbackrest.conf et la valeur par défaut de --config-include-path est /conf/pgbackrest/conf.d.
default: /etc/pgbackrest
example: --config-path=/conf/pgbackrest
Délai d'attente des requêtes à la base de données.
Définit le délai d'attente, en secondes, pour les interrogations de la base de données. Cela inclut les fonctions
pg_start_backup() et
pg_stop_backup() qui peuvent chacune prendre un temps considérable. C'est pourquoi le délai d'attente doit être maintenu à un niveau élevé, sauf si vous savez que ces fonctions retourneront rapidement (c'est-à-dire si vous avez défini
startfast=y et que vous savez que l'instance de base de données ne générera pas beaucoup de segments WAL pendant la sauvegarde).
NOTE:
L'option db-timeout doit être inférieure à l'option protocol-timeout.
default: 1800
allowed: 0.1-604800
example: --db-timeout=600
Restauration ou sauvegarde à l'aide de sommes de contrôle.
Lors d'une restauration, par défaut, les répertoires PostgreSQL data et tablespace sont censés être présents mais vides. Cette option effectue une restauration delta en utilisant des sommes de contrôle.
Lors d'une sauvegarde, cette option utilisera les sommes de contrôle au lieu des horodatages pour déterminer si les fichiers devront être copiés.
default: n
example: --delta
Délai d'attente E/S.
Délai d'attente, en secondes, utilisé pour les connexions et les opérations de lecture/écriture.
Notez que l'ensemble de l'opération de lecture/écriture n'a pas besoin de se terminer dans ce délai mais une progression doit être constatée, même s'il ne s'agit que d'un seul octet.
default: 60
allowed: 0.1-3600
example: --io-timeout=120
Chemin d'accès où sont stockés les fichiers de verrouillage.
Le chemin de verrouillage fournit l'emplacement à pgBackRest pour créer des fichiers de verrouillage afin d'éviter que des opérations en conflictuelles ne soient exécutées simultanément.
default: /tmp/pgbackrest
example: --lock-path=/backup/db/lock
Utilisation d'un umask
neutre
Définit l'umask à 0000 pour que les modes dans le dépôt de sauvegarde soient créés de manière appropriée. Le mode par défaut du répertoire est 0750 et le mode par défaut du fichier est 0640. Pour les répertoires lock et log, les modes de répertoire et de fichier sont respectivement fixés à 0770 et 0660.
Pour utiliser l'umask de l'utilisateur en cours d'exécution, spécifiez plutôt neutral-umask=n dans le fichier de configuration ou --no-neutral-umask sur la ligne de commande.
default: y
example: --no-neutral-umask
Nombre de processus maximal lors utilisé lors de la compression et du transfert.
Chaque processus effectuera une compression et un transfert pour que la commande s'exécute plus rapidement, mais ne réglez pas process-max à un niveau si élevé que cela affecte les performances de la base de données.
default: 1
allowed: 1-999
example: --process-max=4
Délai d'attente du protocole.
Définit le délai, en secondes, durant lequel le processus local ou distant attendra qu'un nouveau message soit reçu au niveau de la couche protocole. Cela permet d'éviter que les processus n'attendent indéfiniment un message.
NOTE:
L'option protocol-timeout doit être supérieure à celle de db-timeout option.
default: 1830
allowed: 0.1-604800
example: --protocol-timeout=630
Activation de la fonction de keep-alive (maintien en vie).
Activation des messages de keep-alive (maintien en vie) sur les connexions réseaux.
default: y
example: --no-sck-keep-alive
Defines the stanza.
Un stanza est la configuration de la sauvegarde d'une instance PostgreSQL où est définit l'endroit où il se trouve, la façon dont il sera sauvegardé, les options d'archivage, etc... La plupart des serveurs de base de données n'auront qu'une seule instance PostgreSQL et donc un stanza alors que les serveurs de sauvegarde auront un stanza pour chaque instance de base de données qui doit être sauvegardé.
Il est tentant de nommer le stanza en référence à l'instance primaire, mais un meilleur nom décrirait les bases de données contenues dans l'instance : comme le nom du stanza sera utilisé pour le primaire et tous les secondaire, il est plus approprié de choisir un nom qui décrit la fonction réelle du groupe d'instances, comme app ou dw, plutôt que le nom local de l'instance, comme main ou prod.
example: --stanza=main
Compteur Keep-alive.
Spécifie le nombre de messages TCP à garder en mémoire qui peuvent être perdus avant que la connexion ne soit considérée comme morte.
Cette option n'est disponible que sur les systèmes qui prennent en charge l'option réseau TCP_KEEPCNT.
allowed: 1-32
example: --tcp-keep-alive-count=3
Temps d'inactivité du keepalive.
Spécifie la durée (en secondes) sans activité du réseau après laquelle le système d'exploitation doit envoyer un message TCP de maintien en activité (keep-alive).
Cette option n'est disponible que sur les systèmes qui prennent en charge l'option réseau TCP_KEEPIDLE.
allowed: 1-3600
example: --tcp-keep-alive-idle=60
Temps d'intervalle de maintien en vie (keep-alive).
Spécifie le temps (en secondes) après lequel un message TCP de maintien en activité (keep-alive) non acquitté doit être retransmis.
Cette option n'est disponible que sur les systèmes qui prennent en charge l'option réseau TCP_KEEPINTVL.
allowed: 1-900
example: --tcp-keep-alive-interval=30
Niveau de journalisation en sortie sur la console.
Les niveaux de traces suivants sont pris en charge:
- off - Pas de journal de traces (non recommandé)
- error - Journaliser uniquement les erreurs
- warn - Journaliser les avertissements et les erreurs
- info - Journaliser les messages d'information, les avertissements et les erreurs
- detail - Journaliser les détails, les messages d'information, les avertissements et les erreurs
- debug - Journaliser les message de Débogage, les détails, les messages d'information, les avertissements et les erreurs
- trace - Journaliser les traces (un débogage très verbeux), les message de Débogage, les détails, les messages d'information, les avertissements et les erreurs
default: warn
example: --log-level-console=error
Niveau d'enregistrement des traces lors de l'enregistrement sur fichier.
Les niveaux de traces suivants sont pris en charge:
- off - Pas de journal de traces (non recommandé)
- error - Journaliser uniquement les erreurs
- warn - Journaliser les avertissements et les erreurs
- info - Journaliser les messages d'information, les avertissements et les erreurs
- detail - Journaliser les détails, les messages d'information, les avertissements et les erreurs
- debug - Journaliser les message de Débogage, les détails, les messages d'information, les avertissements et les erreurs
- trace - Journaliser les traces (un débogage très verbeux), les message de Débogage, les détails, les messages d'information, les avertissements et les erreurs
default: info
example: --log-level-file=debug
Niveau de traces sur la sortie console stderr.
Spécifie les niveaux de traces qui sortiront en
stderr plutôt que
stdout (spécifié par
log-level-console). L'horodatage et le processus ne seront pas émis sur
stderr.
Les niveaux de traces suivants sont pris en charge:
- off - Pas de journal de traces (non recommandé)
- error - Journaliser uniquement les erreurs
- warn - Journaliser les avertissements et les erreurs
- info - Journaliser les messages d'information, les avertissements et les erreurs
- detail - Journaliser les détails, les messages d'information, les avertissements et les erreurs
- debug - Journaliser les message de Débogage, les détails, les messages d'information, les avertissements et les erreurs
- trace - Journaliser les traces (un débogage très verbeux), les message de Débogage, les détails, les messages d'information, les avertissements et les erreurs
default: warn
example: --log-level-stderr=error
Emplacement où les fichiers journaux de traces sont stockés.
Le chemin d'accès au journal fournit un emplacement pour pgBackRest pour stocker les fichiers journaux. Notez que si log-level-file=off alors aucun chemin pour l'emplacement des journaux de traces n'est nécessaire.
default: /var/log/pgbackrest
example: --log-path=/backup/db/log
Activer la journalisation des traces dans les sous-processus.
Activez la journalisation des traces dans les fichiers pour tous les sous-processus créés par ce processus en utilisant le niveau de journalisation spécifié par log-level-file.
default: n
example: --log-subprocess
Activer l'horodatage dans les traces.
Active l'horodatage dans la console et l'enregistrement des fichiers. Cette option est désactivée dans des situations particulières telles que la génération de documentation.
default: y
example: --no-log-timestamp
Chiffrement (cipher) utilisé pour chiffrer le dépôt.
Les types de chiffrement suivants sont pris en charge:
- none - Le dépôt n'est pas chiffré.
- aes-256-cbc - Advanced Encryption Standard avec une clef de 256 bit
À noter que le chiffrement est toujours effectué côté client même si le type de stockage (par exemple S3) supporte le chiffrement.
default: none
example: --repo1-cipher-type=aes-256-cbc
Liens physiques (hardlink) des fichiers entre les sauvegardes dans le dépôt.
Activation la liaison physique des fichiers dans les sauvegardes différentielles et incrémentales avec leurs sauvegardes complètes. Cela donne l'impression que chaque sauvegarde est une sauvegarde complète au niveau du système de fichiers. Attention, cependant, car la modification de fichiers liés peut affecter toutes les sauvegardes de ce jeu.
default: n
example: --repo1-hardlink
Nom obsolète: hardlink
Chemin d'accès où sont stockées les sauvegardes et les archives.
Le dépôt est l'endroit où pgBackRest stocke les sauvegardes et archive les segments des journaux de transaction (WAL).
Il peut être difficile d'estimer à l'avance l'espace dont vous aurez besoin. La meilleure chose à faire est de prendre quelques sauvegardes puis d'enregistrer la taille des différents types de sauvegardes (full/incr/diff) et de mesurer la quantité de WAL générée par jour. Cela vous donnera une idée générale de l'espace dont vous aurez besoin, même si, bien sûr, les besoins changeront probablement au fil du temps, à fur et à mesure de l'évolution de votre base de données.
default: /var/lib/pgbackrest
example: --repo1-path=/backup/db/backrest
Nombre de sauvegardes correspondant à la valeur de WAL continue à conserver.
NOTE:
Les segments WAL nécessaires pour rendre une sauvegarde cohérente sont toujours conservés jusqu'à l'expiration de la sauvegarde, quelle que soit la configuration de cette option.
Si cette configuration n'est pas définie et que
repo-retention-full-type est positionné sur
count (valeur par défaut), alors l'expiration de l'archive sera par défaut à la valeur de
repo-retention-full si
repo-retention-archive-type est définit à
full (ou à
repo-retention-diff si
repo-retention-archive-type est définit à
diff ). Cela permet de garantir que le WAL n'expirera que pour les sauvegardes ayant déjà expirées. Si
repo-retention-full-type est positionné sur
time, avec cette valeur, par défaut, les archives qui sont antérieures à la plus ancienne sauvegarde complète conservée et satisfaisant au paramètre
repo-retention-full seront supprimés.
Cette option doit être définie si
repo-retention-archive-type est positionné sur
incr. Si l'espace disque est insuffisant, ce paramètre, associé à
repo-retention-archive-type, peut être utilisé pour faire expirer de manière agressive les segments WAL. Toutefois, cela annule la possibilité d'effectuer un PITR à partir des sauvegardes avec les WAL expirés et donc
n'est pas recommandé.
allowed: 1-9999999
example: --repo1-retention-archive=2
Nom obsolète: retention-archive
Type de sauvegarde pour la conservation des journaux de transaction (WAL).
Lorsque repo-retention-archive-type est positionné sur full pgBackRest conservera les journaux de trasnaction (WAL) pour le nombre de sauvegardes complètes défini par repo-retention-archive. S'il est positionné sur diff (différentiel) pgBackRest conservera les journaux de trasnaction (WAL) pour le nombre de sauvegardes complètes et différentielles défini par repo-retention-archive, ce qui signifie que si la dernière sauvegarde effectuée était une sauvegarde complète, elle sera comptée comme un différentiel pour les besoins de la retention du dépôt. S'il est positionné sur incr (incrémental) pgBackRest conservera les journaux de trasnaction (WAL) pour le nombre de sauvegardes complètes, différentielles et incrémentielles défini par repo-retention-archive. Il est recommandé de ne pas modifier ce paramètre par rapport à la valeur par défaut : expiration que lorsque les sauvegardes complètes auront expiré.
default: full
example: --repo1-retention-archive-type=diff
Nom obsolète: retention-archive-type
Nombre de sauvegardes différentielles à conserver.
Lorsqu'une sauvegarde différentielle expire, toutes les sauvegardes incrémentales associées à la sauvegarde différentielle expirent également. Lorsqu'elles ne sont pas définies, toutes les sauvegardes différentielles seront conservées jusqu'à ce que les sauvegardes complètes dont elles dépendent expirent.
allowed: 1-9999999
example: --repo1-retention-diff=3
Nom obsolète: retention-diff
Nombre ou temps de sauvegardes complètes à conserver.
Lorsqu'une sauvegarde complète expire, toutes les sauvegardes différentielles et incrémentielles associées à la sauvegarde complète expirent également. Lorsque l'option n'est pas définie, un avertissement sera émis. Si une conservation indéfinie est souhaitée, il faut alors définir l'option à la valeur maximale.
allowed: 1-9999999
example: --repo1-retention-full=2
Nom obsolète: retention-full
Type de conservation pour les sauvegardes complètes.
Détermine si le paramètre repo-retention-full représente une période de temps (jours) ou le nombre de sauvegardes complètes à conserver. Si le paramètre est réglé sur time les sauvegardes complètes plus anciennes que le paramètre repo-retention-full seront supprimées du dépôt si au moins une sauvegarde est égale ou supérieure au paramètre repo-retention-full. Par exemple, si repo-retention-full est de 30 (jours) et qu'il y a 2 sauvegardes complètes : une de 25 jours et une de 35 jours, aucune sauvegarde complète n'expirera puisque l'expiration de la sauvegarde de 35 jours ne laisserait que la sauvegarde de 25 jours; ce qui violerait la politique de conservation de 30 jours : à savoir, avoir au moins une sauvegarde de 30 jours avant qu'une plus ancienne puisse expirer. Les journaux de transactions archivés (WAL) plus anciennes que la sauvegarde complète la plus ancienne restante seront automatiquement expirées, à moins que les paramètres repo-retention-archive-type et repo-retention-archive ne soient explicitement définis.
default: count
example: --repo1-retention-full-type=30
S3 dépôt bucket.
Bucket S3 utilisé pour stocker le dépôt.
Les dépots pgBackRest peuvent être stockés à la racine du bucket en définissant repo-path=/ mais il est généralement préférable de spécifier un préfixe, comme par exemple /repo, afin que les logs et autres contenus générés par AWS puissent également être stockés dans le bucket.
example: --repo1-s3-bucket=pg-backup
Ficher SSL CA S3.
Utiliser un fichier CA autre que celui défini par défaut dans le système.
example: --repo1-s3-ca-file=/etc/pki/tls/certs/ca-bundle.crt
Chemin S3 SSL CA.
Utiliser un chemin pour le CA autre que celui défini par défaut dans le système.
example: --repo1-s3-ca-path=/etc/pki/tls/certs
Dépot S3 Point de terminaison (endpoint).
Le point de terminaison d'AWS doit être valable pour la région sélectionnée.
example: --repo1-s3-endpoint=s3.amazonaws.com
Hôte du dépot S3.
Conntecter sur un hôte différent du point de terminaison (endpoint). Il est généralement utilisé à des fins de test.
example: --repo1-s3-host=127.0.0.1
Port de connection au dépot S3.
Port à utiliser lors de la connexion au point de terminaison (ou à l'hôte si spécifié).
default: 443
allowed: 1-65535
example: --repo1-s3-port=9000
Région du dépôt S3.
La région d'AWS où le bucket a été créé.
example: --repo1-s3-region=us-east-1
S3 URI formats.
Les formats URI suivants sont pris en charge:
- host - Connexion à l'hôte bucket.endpoint.
- path - Connexion à l'hôte endpoint et ajout du bucket aux URIs.
default: host
example: --repo1-s3-uri-style=path
Vérifier le certificat du serveur S3.
Désactive la vérification du certificat du serveur S3. Cette fonction ne doit être utilisée que dans le cadre de tests ou dans le cas d'une utilisation avec un certificat a été auto-signé.
default: y
example: --no-repo1-s3-verify-tls
Nom obsolète: repo-s3-verify-ssl
Type de stockage utilisé pour le dépôt.
Les types de stockage suivants sont pris en charge :
- cifs - Comme posix, mais désactive les liens et les fsyncs sur les répertoires
- posix - Systèmes de fichiers conformes à Posix
- s3 - Service de stockage d'objet (AWS Simple Storage Service)
default: posix
example: --repo1-type=cifs
Hôte PostgreSQL pour les opérations à distance via SSH.
Utilisé pour les sauvegardes lorsque l'hôte PostgreSQL est différent de l'hôte du dépôt.
example: --pg1-host=db.domain.com
Nom obsolète: db-host
Emplacement des exécutable pgBackRest sur l'hôte PostgreSQL.
Uniquement requis si le chemin vers pgbackrest est différent sur le serveur local et PostgreSQL. S'il n'est pas défini, le chemin de l'pgbackrest de l'hôte de la base de données sera le même que le chemin de l'pgbackrest local.
example: --pg1-host-cmd=/usr/lib/backrest/bin/pgbackrest
Nom obsolète: db-cmd
pgBackRest database host configuration file.
Définit l'emplacement du fichier de configuration sur l'hôte PostgreSQL. Ceci n'est requis que si le fichier de configuration de l'hôte PostgreSQL se trouve dans un emplacement différent de celui du fichier de configuration local.
default: /etc/pgbackrest/pgbackrest.conf
example: --pg1-host-config=/conf/pgbackrest/pgbackrest.conf
Nom obsolète: db-config
Chemin d'inclusion de la configuration pgBackRest sur l'hôte.
Définit l'emplacement du chemin d'inclusion de la configuration sur l'hôte PostgreSQL. Ceci n'est requis que si le chemin d'inclusion de la configuration de l'hôte PostgreSQL se trouve à un endroit différent du chemin d'inclusion de la configuration locale.
default: /etc/pgbackrest/conf.d
example: --pg1-host-config-include-path=/conf/pgbackrest/conf.d
Chemin de configuration pgBackRest de l'hôte de base de données.
Définit l'emplacement du chemin de configuration sur l'hôte PostgreSQL. Ceci n'est requis que si le chemin de configuration de l'hôte PostgreSQL se trouve dans un emplacement différent du chemin de configuration local.
default: /etc/pgbackrest
example: --pg1-host-config-path=/conf/pgbackrest
Port de l'hôte PostgreSQL lorsque pg-host est configuré.
Utiliser cette option pour spécifier un port non par défaut pour le protocole hôte PostgreSQL. Actuellement, seul le protocole SSH est pris en charge
allowed: 0-65535
example: --pg1-host-port=25
Nom obsolète: db-ssh-port
Utilisateur de connexion PostgreSQL lorsque pg-host est défini.
Cet utilisateur sera également propriétaire du processus distant pgBackRest et initiera les connexions à PostgreSQL. Pour que cela puisse fonctionner correctement, l'utilisateur doit être le propriétaire de l'instance de base de données PostgreSQL, qui est généralement par défaut postgres.
default: postgres
example: --pg1-host-user=db_owner
Nom obsolète: db-user
PostgreSQL data directory.
Ce paramètre doit être le même que le paramètre data_directory du fichier postgresql.conf. Même si cette valeur peut être lue à partir de postgresql.conf ou PostgreSQL, il est conseillé de la définir au cas où ces ressources ne seraient pas disponibles pendant un scénario de restauration ou de sauvegarde hors ligne.
L'option pg-path est testée par rapport à la valeur indiquée par PostgreSQL à chaque sauvegarde en ligne, elle doit donc toujours être à jour.
example: --pg1-path=/data/db
Nom obsolète: db-path
Port PostgreSQL.
Port sur lequel PostgreSQL écoute. Il n'est généralement pas nécessaire de le préciser car la plupart des instances PostgreSQL fonctionnent sur le port par défaut.
default: 5432
allowed: 0-65535
example: --pg1-port=6543
Nom obsolète: db-port
Emplacement socket unix PostgreSQL.
Le répertoire de la socket unix qui a été spécifié au démarrage de PostgreSQL. pgBackRest trouvera automatiquement l'emplacement standard pour votre système d'exploitation, il n'est donc généralement pas nécessaire de spécifier ce paramètre, sauf si le répertoire des sockets a été explicitement modifié avec le paramètre unix_socket_directory dans postgresql.conf.
allowed: 0-65535
example: --pg1-socket-path=/var/run/postgresql
Nom obsolète: db-socket-path
Nom d'utilisateur de base de données PostgreSQL.
Le nom d'utilisateur de la base de données utilisé lors de la connexion à PostgreSQL. S'il n'est pas spécifié, pgBackRest se connectera avec l'utilisateur du système d'exploitation local ou PGUSER.
example: --pg1-user=backupuser
La commande check valide que pgBackRest et le paramétre archive_command sont configurés correctement pour l'archivage et les sauvegardes. Il détecte d'éventuelles erreurs de configuration, en particulier pour l'archivage. Une mauvaise configuration de l'archivage se traduit par des sauvegardes incomplètes : les segments WAL requis n'étant pas parvenus aux archives. La commande peut être exécutée sur le serveur de l'instance de la base de données ou sur le serveur du dépôt de sauvegarde. La commande peut également être exécutée sur l'hôte secondaire (standby), mais comme les commandes pg_switch_xlog()/pg_switch_wal() ne peut pas être exécuté sur une instance secondaire, la commande ne testera que la configuration du dépôt.
Notez que pg_create_restore_point('pgBackRest Archive Check') et pg_switch_xlog()/pg_switch_wal() sont appelés pour forcer PostgreSQL à archiver un segment WAL. Les points de restauration ne sont supportés que dans PostgreSQL >= 9.1; Pour les versions plus anciennes, la commande check peut échouer s'il n'y a pas eu d'activité d'écriture depuis la dernière rotation du journal, il est donc recommandé que l'activité soit générée par l'utilisateur s'il n'y a pas eu d'écriture depuis le dernier changement de WAL avant l'exécution de la commande check
Contrôle que les segments WAL se trouvent bien dans les archives à la fin du processus de sauvegarde.
Contrôle que tous les segments de WAL nécessaires pour rendre la sauvegarde cohérente sont présents dans les archives de WAL. Il est conseillé de laisser ce paramètre par défaut, à moins que vous n'utilisiez une autre méthode d'archivage..
Cette option doit être activée si archive-copy est activé.
default: y
example: --no-archive-check
Délai d'attente de l'archivage (archive timeout).
Définit le temps maximum, en secondes, à attendre pour que chaque segment WAL atteigne le dépôt d'archives de pgBackRest. Le délai s'applique aux commandes check et backup lorsqu'on attend que les segments WAL nécessaires à la cohérence de la sauvegarde soient archivés.
default: 60
allowed: 0.1-86400
example: --archive-timeout=30
Sauvegarde depuis l'instance standby secondaire.
Activer la sauvegarde depuis le secondaire en standby pour réduire la charge sur l'instance primaire. Cette option nécessite que les hôtes primary (primaire) et standby (secondaire en standby) soit correctement configurés.
default: n
example: --backup-standby
Taille de la mémoire tampon pour les opérations sur les fichiers.
Définissez la taille de la mémoire tampon utilisée pour les opérations de copie, de compression et de décompression. Un maximum de 3 tampons seront utilisés à la fois par processus. Un maximum supplémentaire de 256K par processus peut être utilisé pour les tampons zlib.
La taille peut être saisie en octets (par défaut) ou en KB, MB, GB, TB, ou PB où le multiplicateur est une puissance de 1024. Par exemple, la valeur insensible à la casse 32k (ou 32KB) peut être utilisée au lieu de 32768.
Les valeurs autorisées, en octets, sont16384, 32768, 65536, 131072, 262144, 524288, 1048576, 2097152, 4194304, 8388608, et 16777216.
default: 1048576
example: --buffer-size=32K
Chemin d'accès à l'exécutable du client ssh.
Utilisez un client SSH spécifique lorsqu'une alternative est nécessaire ou lorsque l'exécutable ssh n'est pas dans $PATH.
default: ssh
example: --cmd-ssh=/usr/bin/ssh
Niveau de compression du réseau.
Définit le niveau de compression sur le réseau, lorsque compress-type=none et que la commande n'est pas exécutée sur le même hôte que le dépôt. La compression est utilisée pour réduire le trafic réseau mais peut être désactivée en définissant compress-level-network=0. Lorsque compress-type n'est pas égal à none, le paramètre compress-level-network est ignoré et compress-level est utilisé à la place de sorte que le fichier ne soit compressé qu'une seule fois. La compression SSH est toujours désactivée.
default: 3
allowed: 0-9
example: --compress-level-network=1
Fichier de configuration pgBackRest.
Utiliser cette option pour spécifier un fichier de configuration différent de celui par défaut.
default: /etc/pgbackrest/pgbackrest.conf
example: --config=/conf/pgbackrest/pgbackrest.conf
Emplacement des fichiers de configuration pgBackRest supplémentaires..
Les fichiers de configuration existant à l'emplacement spécifié avec l'extension .conf seront concaténés avec le fichier de configuration pgBackRest, ce qui donne un seul fichier de configuration.
default: /etc/pgbackrest/conf.d
example: --config-include-path=/conf/pgbackrest/conf.d
Emplacement du répertoire de racine de pgBackRest des fichiers de configuration.
Ce paramètre est utilisé pour écraser le chemin racine par défaut pour les options --config et --config-include-path à moins qu'elles ne soient explicitement définies sur la ligne de commande.
Par exemple, en utilisant uniquement --config-path=/conf/pgbackrest, la valeur par défaut de --config est /conf/pgbackrest/pgbackrest.conf et la valeur par défaut de --config-include-path est /conf/pgbackrest/conf.d.
default: /etc/pgbackrest
example: --config-path=/conf/pgbackrest
Délai d'attente des requêtes à la base de données.
Définit le délai d'attente, en secondes, pour les interrogations de la base de données. Cela inclut les fonctions
pg_start_backup() et
pg_stop_backup() qui peuvent chacune prendre un temps considérable. C'est pourquoi le délai d'attente doit être maintenu à un niveau élevé, sauf si vous savez que ces fonctions retourneront rapidement (c'est-à-dire si vous avez défini
startfast=y et que vous savez que l'instance de base de données ne générera pas beaucoup de segments WAL pendant la sauvegarde).
NOTE:
L'option db-timeout doit être inférieure à l'option protocol-timeout.
default: 1800
allowed: 0.1-604800
example: --db-timeout=600
Délai d'attente E/S.
Délai d'attente, en secondes, utilisé pour les connexions et les opérations de lecture/écriture.
Notez que l'ensemble de l'opération de lecture/écriture n'a pas besoin de se terminer dans ce délai mais une progression doit être constatée, même s'il ne s'agit que d'un seul octet.
default: 60
allowed: 0.1-3600
example: --io-timeout=120
Utilisation d'un umask
neutre
Définit l'umask à 0000 pour que les modes dans le dépôt de sauvegarde soient créés de manière appropriée. Le mode par défaut du répertoire est 0750 et le mode par défaut du fichier est 0640. Pour les répertoires lock et log, les modes de répertoire et de fichier sont respectivement fixés à 0770 et 0660.
Pour utiliser l'umask de l'utilisateur en cours d'exécution, spécifiez plutôt neutral-umask=n dans le fichier de configuration ou --no-neutral-umask sur la ligne de commande.
default: y
example: --no-neutral-umask
Délai d'attente du protocole.
Définit le délai, en secondes, durant lequel le processus local ou distant attendra qu'un nouveau message soit reçu au niveau de la couche protocole. Cela permet d'éviter que les processus n'attendent indéfiniment un message.
NOTE:
L'option protocol-timeout doit être supérieure à celle de db-timeout option.
default: 1830
allowed: 0.1-604800
example: --protocol-timeout=630
Activation de la fonction de keep-alive (maintien en vie).
Activation des messages de keep-alive (maintien en vie) sur les connexions réseaux.
default: y
example: --no-sck-keep-alive
Defines the stanza.
Un stanza est la configuration de la sauvegarde d'une instance PostgreSQL où est définit l'endroit où il se trouve, la façon dont il sera sauvegardé, les options d'archivage, etc... La plupart des serveurs de base de données n'auront qu'une seule instance PostgreSQL et donc un stanza alors que les serveurs de sauvegarde auront un stanza pour chaque instance de base de données qui doit être sauvegardé.
Il est tentant de nommer le stanza en référence à l'instance primaire, mais un meilleur nom décrirait les bases de données contenues dans l'instance : comme le nom du stanza sera utilisé pour le primaire et tous les secondaire, il est plus approprié de choisir un nom qui décrit la fonction réelle du groupe d'instances, comme app ou dw, plutôt que le nom local de l'instance, comme main ou prod.
example: --stanza=main
Compteur Keep-alive.
Spécifie le nombre de messages TCP à garder en mémoire qui peuvent être perdus avant que la connexion ne soit considérée comme morte.
Cette option n'est disponible que sur les systèmes qui prennent en charge l'option réseau TCP_KEEPCNT.
allowed: 1-32
example: --tcp-keep-alive-count=3
Temps d'inactivité du keepalive.
Spécifie la durée (en secondes) sans activité du réseau après laquelle le système d'exploitation doit envoyer un message TCP de maintien en activité (keep-alive).
Cette option n'est disponible que sur les systèmes qui prennent en charge l'option réseau TCP_KEEPIDLE.
allowed: 1-3600
example: --tcp-keep-alive-idle=60
Temps d'intervalle de maintien en vie (keep-alive).
Spécifie le temps (en secondes) après lequel un message TCP de maintien en activité (keep-alive) non acquitté doit être retransmis.
Cette option n'est disponible que sur les systèmes qui prennent en charge l'option réseau TCP_KEEPINTVL.
allowed: 1-900
example: --tcp-keep-alive-interval=30
Niveau de journalisation en sortie sur la console.
Les niveaux de traces suivants sont pris en charge:
- off - Pas de journal de traces (non recommandé)
- error - Journaliser uniquement les erreurs
- warn - Journaliser les avertissements et les erreurs
- info - Journaliser les messages d'information, les avertissements et les erreurs
- detail - Journaliser les détails, les messages d'information, les avertissements et les erreurs
- debug - Journaliser les message de Débogage, les détails, les messages d'information, les avertissements et les erreurs
- trace - Journaliser les traces (un débogage très verbeux), les message de Débogage, les détails, les messages d'information, les avertissements et les erreurs
default: warn
example: --log-level-console=error
Niveau d'enregistrement des traces lors de l'enregistrement sur fichier.
Les niveaux de traces suivants sont pris en charge:
- off - Pas de journal de traces (non recommandé)
- error - Journaliser uniquement les erreurs
- warn - Journaliser les avertissements et les erreurs
- info - Journaliser les messages d'information, les avertissements et les erreurs
- detail - Journaliser les détails, les messages d'information, les avertissements et les erreurs
- debug - Journaliser les message de Débogage, les détails, les messages d'information, les avertissements et les erreurs
- trace - Journaliser les traces (un débogage très verbeux), les message de Débogage, les détails, les messages d'information, les avertissements et les erreurs
default: info
example: --log-level-file=debug
Niveau de traces sur la sortie console stderr.
Spécifie les niveaux de traces qui sortiront en
stderr plutôt que
stdout (spécifié par
log-level-console). L'horodatage et le processus ne seront pas émis sur
stderr.
Les niveaux de traces suivants sont pris en charge:
- off - Pas de journal de traces (non recommandé)
- error - Journaliser uniquement les erreurs
- warn - Journaliser les avertissements et les erreurs
- info - Journaliser les messages d'information, les avertissements et les erreurs
- detail - Journaliser les détails, les messages d'information, les avertissements et les erreurs
- debug - Journaliser les message de Débogage, les détails, les messages d'information, les avertissements et les erreurs
- trace - Journaliser les traces (un débogage très verbeux), les message de Débogage, les détails, les messages d'information, les avertissements et les erreurs
default: warn
example: --log-level-stderr=error
Emplacement où les fichiers journaux de traces sont stockés.
Le chemin d'accès au journal fournit un emplacement pour pgBackRest pour stocker les fichiers journaux. Notez que si log-level-file=off alors aucun chemin pour l'emplacement des journaux de traces n'est nécessaire.
default: /var/log/pgbackrest
example: --log-path=/backup/db/log
Activer la journalisation des traces dans les sous-processus.
Activez la journalisation des traces dans les fichiers pour tous les sous-processus créés par ce processus en utilisant le niveau de journalisation spécifié par log-level-file.
default: n
example: --log-subprocess
Activer l'horodatage dans les traces.
Active l'horodatage dans la console et l'enregistrement des fichiers. Cette option est désactivée dans des situations particulières telles que la génération de documentation.
default: y
example: --no-log-timestamp
Chiffrement (cipher) utilisé pour chiffrer le dépôt.
Les types de chiffrement suivants sont pris en charge:
- none - Le dépôt n'est pas chiffré.
- aes-256-cbc - Advanced Encryption Standard avec une clef de 256 bit
À noter que le chiffrement est toujours effectué côté client même si le type de stockage (par exemple S3) supporte le chiffrement.
default: none
example: --repo1-cipher-type=aes-256-cbc
Hôte de dépôt dans le cas d'un fonctionnement à distance via SSH.
Assurez-vous que l'authentification SSH soit correctement approuvé entre l'hôte PostgreSQL et l'hôte du référentiel.
Ce paramètre n'est pas nécessaire pour la sauvegarde et l'archivage sur un système de fichiers monté localement.
example: --repo1-host=repo1.domain.com
Nom obsolète: backup-host
Chemin des binaires pgBackRest sur l'hôte du dépôt.
Nécessaire uniquement si le chemin d'accès à pgbackrest est différent entre les hôtes locaux et l'hote du dépôt. S'il n'est pas défini, le chemin des binaires sur l'hôte du dépôt sera le même que le chemin des binaires locaux.
example: --repo1-host-cmd=/usr/lib/backrest/bin/pgbackrest
Nom obsolète: backup-cmd
Emplacement du fichier de configuration pgBackRest sur l'hôte du dépôt.
Définit l'emplacement du fichier de configuration sur l'hôte du dépôt. Ceci n'est nécessaire que si le fichier de configuration de l'hôte du dépôt se trouve dans un emplacement différent de celui du fichier de configuration local.
default: /etc/pgbackrest/pgbackrest.conf
example: --repo1-host-config=/conf/pgbackrest/pgbackrest.conf
Nom obsolète: backup-config
Chemin d'inclusion pgBackRest de la configuration de l'hôte du dépôt.
Définit l'emplacement du chemin d'inclusion de la configuration sur l'hôte du dépôt. Ceci n'est nécessaire que si le chemin d'inclusion de la configuration de l'hôte du dépôt se trouve à un endroit différent du chemin d'inclusion de la configuration locale.
default: /etc/pgbackrest/conf.d
example: --repo1-host-config-include-path=/conf/pgbackrest/conf.d
Chemin de configuration pgBackRest de l'hôte du dépôt.
Définit l'emplacement du chemin de configuration sur l'hôte du dépôt. Ceci n'est nécessaire que si le chemin de configuration de l'hôte du référentiel se trouve à un endroit différent du chemin de configuration local.
default: /etc/pgbackrest
example: --repo1-host-config-path=/conf/pgbackrest
Port de l'hôte du dépôt lorsque repo-host est défini.
Utilisez cette option pour spécifier un port non par défaut pour le protocole d'accès à l'hôte du dépôt. Actuellement, seul SSH est pris en charge
allowed: 0-65535
example: --repo1-host-port=25
Nom obsolète: backup-ssh-port
Utilisateur de l'hôte du dépôt lorsque repo-host est défini.
Définit l'utilisateur qui sera utilisé pour les opérations sur l'hôte du dépôt. De préférence, il ne s'agit pas de l'utilisateur postgres mais plutôt d'un autre utilisateur comme pgbackrest. Si PostgreSQL fonctionne sur l'hôte du dépôt, l'utilisateur postgres peut être placé dans le groupe pgbackrest afin qu'il ait les autorisations de lecture sur le dépôt sans pouvoir en endommager le contenu accidentellement.
default: pgbackrest
example: --repo1-host-user=repo-user
Nom obsolète: backup-user
Chemin d'accès où sont stockées les sauvegardes et les archives.
Le dépôt est l'endroit où pgBackRest stocke les sauvegardes et archive les segments des journaux de transaction (WAL).
Il peut être difficile d'estimer à l'avance l'espace dont vous aurez besoin. La meilleure chose à faire est de prendre quelques sauvegardes puis d'enregistrer la taille des différents types de sauvegardes (full/incr/diff) et de mesurer la quantité de WAL générée par jour. Cela vous donnera une idée générale de l'espace dont vous aurez besoin, même si, bien sûr, les besoins changeront probablement au fil du temps, à fur et à mesure de l'évolution de votre base de données.
default: /var/lib/pgbackrest
example: --repo1-path=/backup/db/backrest
S3 dépôt bucket.
Bucket S3 utilisé pour stocker le dépôt.
Les dépots pgBackRest peuvent être stockés à la racine du bucket en définissant repo-path=/ mais il est généralement préférable de spécifier un préfixe, comme par exemple /repo, afin que les logs et autres contenus générés par AWS puissent également être stockés dans le bucket.
example: --repo1-s3-bucket=pg-backup
Ficher SSL CA S3.
Utiliser un fichier CA autre que celui défini par défaut dans le système.
example: --repo1-s3-ca-file=/etc/pki/tls/certs/ca-bundle.crt
Chemin S3 SSL CA.
Utiliser un chemin pour le CA autre que celui défini par défaut dans le système.
example: --repo1-s3-ca-path=/etc/pki/tls/certs
Dépot S3 Point de terminaison (endpoint).
Le point de terminaison d'AWS doit être valable pour la région sélectionnée.
example: --repo1-s3-endpoint=s3.amazonaws.com
Hôte du dépot S3.
Conntecter sur un hôte différent du point de terminaison (endpoint). Il est généralement utilisé à des fins de test.
example: --repo1-s3-host=127.0.0.1
Port de connection au dépot S3.
Port à utiliser lors de la connexion au point de terminaison (ou à l'hôte si spécifié).
default: 443
allowed: 1-65535
example: --repo1-s3-port=9000
Région du dépôt S3.
La région d'AWS où le bucket a été créé.
example: --repo1-s3-region=us-east-1
S3 URI formats.
Les formats URI suivants sont pris en charge:
- host - Connexion à l'hôte bucket.endpoint.
- path - Connexion à l'hôte endpoint et ajout du bucket aux URIs.
default: host
example: --repo1-s3-uri-style=path
Vérifier le certificat du serveur S3.
Désactive la vérification du certificat du serveur S3. Cette fonction ne doit être utilisée que dans le cadre de tests ou dans le cas d'une utilisation avec un certificat a été auto-signé.
default: y
example: --no-repo1-s3-verify-tls
Nom obsolète: repo-s3-verify-ssl
Type de stockage utilisé pour le dépôt.
Les types de stockage suivants sont pris en charge :
- cifs - Comme posix, mais désactive les liens et les fsyncs sur les répertoires
- posix - Systèmes de fichiers conformes à Posix
- s3 - Service de stockage d'objet (AWS Simple Storage Service)
default: posix
example: --repo1-type=cifs
Hôte PostgreSQL pour les opérations à distance via SSH.
Utilisé pour les sauvegardes lorsque l'hôte PostgreSQL est différent de l'hôte du dépôt.
example: --pg1-host=db.domain.com
Nom obsolète: db-host
Emplacement des exécutable pgBackRest sur l'hôte PostgreSQL.
Uniquement requis si le chemin vers pgbackrest est différent sur le serveur local et PostgreSQL. S'il n'est pas défini, le chemin de l'pgbackrest de l'hôte de la base de données sera le même que le chemin de l'pgbackrest local.
example: --pg1-host-cmd=/usr/lib/backrest/bin/pgbackrest
Nom obsolète: db-cmd
pgBackRest database host configuration file.
Définit l'emplacement du fichier de configuration sur l'hôte PostgreSQL. Ceci n'est requis que si le fichier de configuration de l'hôte PostgreSQL se trouve dans un emplacement différent de celui du fichier de configuration local.
default: /etc/pgbackrest/pgbackrest.conf
example: --pg1-host-config=/conf/pgbackrest/pgbackrest.conf
Nom obsolète: db-config
Chemin d'inclusion de la configuration pgBackRest sur l'hôte.
Définit l'emplacement du chemin d'inclusion de la configuration sur l'hôte PostgreSQL. Ceci n'est requis que si le chemin d'inclusion de la configuration de l'hôte PostgreSQL se trouve à un endroit différent du chemin d'inclusion de la configuration locale.
default: /etc/pgbackrest/conf.d
example: --pg1-host-config-include-path=/conf/pgbackrest/conf.d
Chemin de configuration pgBackRest de l'hôte de base de données.
Définit l'emplacement du chemin de configuration sur l'hôte PostgreSQL. Ceci n'est requis que si le chemin de configuration de l'hôte PostgreSQL se trouve dans un emplacement différent du chemin de configuration local.
default: /etc/pgbackrest
example: --pg1-host-config-path=/conf/pgbackrest
Port de l'hôte PostgreSQL lorsque pg-host est configuré.
Utiliser cette option pour spécifier un port non par défaut pour le protocole hôte PostgreSQL. Actuellement, seul le protocole SSH est pris en charge
allowed: 0-65535
example: --pg1-host-port=25
Nom obsolète: db-ssh-port
Utilisateur de connexion PostgreSQL lorsque pg-host est défini.
Cet utilisateur sera également propriétaire du processus distant pgBackRest et initiera les connexions à PostgreSQL. Pour que cela puisse fonctionner correctement, l'utilisateur doit être le propriétaire de l'instance de base de données PostgreSQL, qui est généralement par défaut postgres.
default: postgres
example: --pg1-host-user=db_owner
Nom obsolète: db-user
PostgreSQL data directory.
Ce paramètre doit être le même que le paramètre data_directory du fichier postgresql.conf. Même si cette valeur peut être lue à partir de postgresql.conf ou PostgreSQL, il est conseillé de la définir au cas où ces ressources ne seraient pas disponibles pendant un scénario de restauration ou de sauvegarde hors ligne.
L'option pg-path est testée par rapport à la valeur indiquée par PostgreSQL à chaque sauvegarde en ligne, elle doit donc toujours être à jour.
example: --pg1-path=/data/db
Nom obsolète: db-path
Port PostgreSQL.
Port sur lequel PostgreSQL écoute. Il n'est généralement pas nécessaire de le préciser car la plupart des instances PostgreSQL fonctionnent sur le port par défaut.
default: 5432
allowed: 0-65535
example: --pg1-port=6543
Nom obsolète: db-port
Emplacement socket unix PostgreSQL.
Le répertoire de la socket unix qui a été spécifié au démarrage de PostgreSQL. pgBackRest trouvera automatiquement l'emplacement standard pour votre système d'exploitation, il n'est donc généralement pas nécessaire de spécifier ce paramètre, sauf si le répertoire des sockets a été explicitement modifié avec le paramètre unix_socket_directory dans postgresql.conf.
allowed: 0-65535
example: --pg1-socket-path=/var/run/postgresql
Nom obsolète: db-socket-path
Nom d'utilisateur de base de données PostgreSQL.
Le nom d'utilisateur de la base de données utilisé lors de la connexion à PostgreSQL. S'il n'est pas spécifié, pgBackRest se connectera avec l'utilisateur du système d'exploitation local ou PGUSER.
example: --pg1-user=backupuser
pgBackRest effectue la rotation des sauvegardes mais ne se préoccupe pas de savoir quand les sauvegardes ont été créées. Si deux sauvegardes complètes sont configurées pour être conservées, pgBackRest conservera deux sauvegardes complètes, qu'elles aient lieu à deux heures ou à deux semaines d'intervalle.
Definir l'expiration de la sauvegarde.
Le jeu de sauvegarde spécifié (c'est-à-dire l'étiquette de sauvegarde fournie et toutes ses sauvegardes dépendantes, le cas échéant) expirera quelles que soient les règles de conservation des sauvegardes, excepté qu'au moins une sauvegarde complète doit rester dans le dépôt.
WARNING:
Utilisez cette option avec une extrême prudence &mdash ; elle supprimera définitivement toutes les sauvegardes et archives non nécessaires pour effectuer une sauvegarde cohérente du dépôt de sauvegarde pgBackRest pour le jeu de sauvegarde spécifié. Ce processus peut empêcher l'exécution du PITR. Si les options --repo-retention-full et/ou --repo-retention-archive sont configurées, alors il est conseillé de remplacer ces options en définissant leurs valeurs au maximum lors de l'exécution de la commande d'expiration.
example: --set=20150131-153358F_20150131-153401I
Taille de la mémoire tampon pour les opérations sur les fichiers.
Définissez la taille de la mémoire tampon utilisée pour les opérations de copie, de compression et de décompression. Un maximum de 3 tampons seront utilisés à la fois par processus. Un maximum supplémentaire de 256K par processus peut être utilisé pour les tampons zlib.
La taille peut être saisie en octets (par défaut) ou en KB, MB, GB, TB, ou PB où le multiplicateur est une puissance de 1024. Par exemple, la valeur insensible à la casse 32k (ou 32KB) peut être utilisée au lieu de 32768.
Les valeurs autorisées, en octets, sont16384, 32768, 65536, 131072, 262144, 524288, 1048576, 2097152, 4194304, 8388608, et 16777216.
default: 1048576
example: --buffer-size=32K
Chemin d'accès à l'exécutable du client ssh.
Utilisez un client SSH spécifique lorsqu'une alternative est nécessaire ou lorsque l'exécutable ssh n'est pas dans $PATH.
default: ssh
example: --cmd-ssh=/usr/bin/ssh
Fichier de configuration pgBackRest.
Utiliser cette option pour spécifier un fichier de configuration différent de celui par défaut.
default: /etc/pgbackrest/pgbackrest.conf
example: --config=/conf/pgbackrest/pgbackrest.conf
Emplacement des fichiers de configuration pgBackRest supplémentaires..
Les fichiers de configuration existant à l'emplacement spécifié avec l'extension .conf seront concaténés avec le fichier de configuration pgBackRest, ce qui donne un seul fichier de configuration.
default: /etc/pgbackrest/conf.d
example: --config-include-path=/conf/pgbackrest/conf.d
Emplacement du répertoire de racine de pgBackRest des fichiers de configuration.
Ce paramètre est utilisé pour écraser le chemin racine par défaut pour les options --config et --config-include-path à moins qu'elles ne soient explicitement définies sur la ligne de commande.
Par exemple, en utilisant uniquement --config-path=/conf/pgbackrest, la valeur par défaut de --config est /conf/pgbackrest/pgbackrest.conf et la valeur par défaut de --config-include-path est /conf/pgbackrest/conf.d.
default: /etc/pgbackrest
example: --config-path=/conf/pgbackrest
Executer une commande en mode essai (dry-run).
L'option --dry-run est une option utilisable uniquement en ligne de commande et peut être utilisée lorsqu'il est nécessaire de déterminer les modifications qui seront apportées par la commande sans que celle-ci n'apporte réellement de modifications.
default: n
example: --dry-run
Délai d'attente E/S.
Délai d'attente, en secondes, utilisé pour les connexions et les opérations de lecture/écriture.
Notez que l'ensemble de l'opération de lecture/écriture n'a pas besoin de se terminer dans ce délai mais une progression doit être constatée, même s'il ne s'agit que d'un seul octet.
default: 60
allowed: 0.1-3600
example: --io-timeout=120
Chemin d'accès où sont stockés les fichiers de verrouillage.
Le chemin de verrouillage fournit l'emplacement à pgBackRest pour créer des fichiers de verrouillage afin d'éviter que des opérations en conflictuelles ne soient exécutées simultanément.
default: /tmp/pgbackrest
example: --lock-path=/backup/db/lock
Utilisation d'un umask
neutre
Définit l'umask à 0000 pour que les modes dans le dépôt de sauvegarde soient créés de manière appropriée. Le mode par défaut du répertoire est 0750 et le mode par défaut du fichier est 0640. Pour les répertoires lock et log, les modes de répertoire et de fichier sont respectivement fixés à 0770 et 0660.
Pour utiliser l'umask de l'utilisateur en cours d'exécution, spécifiez plutôt neutral-umask=n dans le fichier de configuration ou --no-neutral-umask sur la ligne de commande.
default: y
example: --no-neutral-umask
Activation de la fonction de keep-alive (maintien en vie).
Activation des messages de keep-alive (maintien en vie) sur les connexions réseaux.
default: y
example: --no-sck-keep-alive
Defines the stanza.
Un stanza est la configuration de la sauvegarde d'une instance PostgreSQL où est définit l'endroit où il se trouve, la façon dont il sera sauvegardé, les options d'archivage, etc... La plupart des serveurs de base de données n'auront qu'une seule instance PostgreSQL et donc un stanza alors que les serveurs de sauvegarde auront un stanza pour chaque instance de base de données qui doit être sauvegardé.
Il est tentant de nommer le stanza en référence à l'instance primaire, mais un meilleur nom décrirait les bases de données contenues dans l'instance : comme le nom du stanza sera utilisé pour le primaire et tous les secondaire, il est plus approprié de choisir un nom qui décrit la fonction réelle du groupe d'instances, comme app ou dw, plutôt que le nom local de l'instance, comme main ou prod.
example: --stanza=main
Compteur Keep-alive.
Spécifie le nombre de messages TCP à garder en mémoire qui peuvent être perdus avant que la connexion ne soit considérée comme morte.
Cette option n'est disponible que sur les systèmes qui prennent en charge l'option réseau TCP_KEEPCNT.
allowed: 1-32
example: --tcp-keep-alive-count=3
Temps d'inactivité du keepalive.
Spécifie la durée (en secondes) sans activité du réseau après laquelle le système d'exploitation doit envoyer un message TCP de maintien en activité (keep-alive).
Cette option n'est disponible que sur les systèmes qui prennent en charge l'option réseau TCP_KEEPIDLE.
allowed: 1-3600
example: --tcp-keep-alive-idle=60
Temps d'intervalle de maintien en vie (keep-alive).
Spécifie le temps (en secondes) après lequel un message TCP de maintien en activité (keep-alive) non acquitté doit être retransmis.
Cette option n'est disponible que sur les systèmes qui prennent en charge l'option réseau TCP_KEEPINTVL.
allowed: 1-900
example: --tcp-keep-alive-interval=30
Niveau de journalisation en sortie sur la console.
Les niveaux de traces suivants sont pris en charge:
- off - Pas de journal de traces (non recommandé)
- error - Journaliser uniquement les erreurs
- warn - Journaliser les avertissements et les erreurs
- info - Journaliser les messages d'information, les avertissements et les erreurs
- detail - Journaliser les détails, les messages d'information, les avertissements et les erreurs
- debug - Journaliser les message de Débogage, les détails, les messages d'information, les avertissements et les erreurs
- trace - Journaliser les traces (un débogage très verbeux), les message de Débogage, les détails, les messages d'information, les avertissements et les erreurs
default: warn
example: --log-level-console=error
Niveau d'enregistrement des traces lors de l'enregistrement sur fichier.
Les niveaux de traces suivants sont pris en charge:
- off - Pas de journal de traces (non recommandé)
- error - Journaliser uniquement les erreurs
- warn - Journaliser les avertissements et les erreurs
- info - Journaliser les messages d'information, les avertissements et les erreurs
- detail - Journaliser les détails, les messages d'information, les avertissements et les erreurs
- debug - Journaliser les message de Débogage, les détails, les messages d'information, les avertissements et les erreurs
- trace - Journaliser les traces (un débogage très verbeux), les message de Débogage, les détails, les messages d'information, les avertissements et les erreurs
default: info
example: --log-level-file=debug
Niveau de traces sur la sortie console stderr.
Spécifie les niveaux de traces qui sortiront en
stderr plutôt que
stdout (spécifié par
log-level-console). L'horodatage et le processus ne seront pas émis sur
stderr.
Les niveaux de traces suivants sont pris en charge:
- off - Pas de journal de traces (non recommandé)
- error - Journaliser uniquement les erreurs
- warn - Journaliser les avertissements et les erreurs
- info - Journaliser les messages d'information, les avertissements et les erreurs
- detail - Journaliser les détails, les messages d'information, les avertissements et les erreurs
- debug - Journaliser les message de Débogage, les détails, les messages d'information, les avertissements et les erreurs
- trace - Journaliser les traces (un débogage très verbeux), les message de Débogage, les détails, les messages d'information, les avertissements et les erreurs
default: warn
example: --log-level-stderr=error
Emplacement où les fichiers journaux de traces sont stockés.
Le chemin d'accès au journal fournit un emplacement pour pgBackRest pour stocker les fichiers journaux. Notez que si log-level-file=off alors aucun chemin pour l'emplacement des journaux de traces n'est nécessaire.
default: /var/log/pgbackrest
example: --log-path=/backup/db/log
Activer la journalisation des traces dans les sous-processus.
Activez la journalisation des traces dans les fichiers pour tous les sous-processus créés par ce processus en utilisant le niveau de journalisation spécifié par log-level-file.
default: n
example: --log-subprocess
Activer l'horodatage dans les traces.
Active l'horodatage dans la console et l'enregistrement des fichiers. Cette option est désactivée dans des situations particulières telles que la génération de documentation.
default: y
example: --no-log-timestamp
Chiffrement (cipher) utilisé pour chiffrer le dépôt.
Les types de chiffrement suivants sont pris en charge:
- none - Le dépôt n'est pas chiffré.
- aes-256-cbc - Advanced Encryption Standard avec une clef de 256 bit
À noter que le chiffrement est toujours effectué côté client même si le type de stockage (par exemple S3) supporte le chiffrement.
default: none
example: --repo1-cipher-type=aes-256-cbc
Chemin d'accès où sont stockées les sauvegardes et les archives.
Le dépôt est l'endroit où pgBackRest stocke les sauvegardes et archive les segments des journaux de transaction (WAL).
Il peut être difficile d'estimer à l'avance l'espace dont vous aurez besoin. La meilleure chose à faire est de prendre quelques sauvegardes puis d'enregistrer la taille des différents types de sauvegardes (full/incr/diff) et de mesurer la quantité de WAL générée par jour. Cela vous donnera une idée générale de l'espace dont vous aurez besoin, même si, bien sûr, les besoins changeront probablement au fil du temps, à fur et à mesure de l'évolution de votre base de données.
default: /var/lib/pgbackrest
example: --repo1-path=/backup/db/backrest
Nombre de sauvegardes correspondant à la valeur de WAL continue à conserver.
NOTE:
Les segments WAL nécessaires pour rendre une sauvegarde cohérente sont toujours conservés jusqu'à l'expiration de la sauvegarde, quelle que soit la configuration de cette option.
Si cette configuration n'est pas définie et que
repo-retention-full-type est positionné sur
count (valeur par défaut), alors l'expiration de l'archive sera par défaut à la valeur de
repo-retention-full si
repo-retention-archive-type est définit à
full (ou à
repo-retention-diff si
repo-retention-archive-type est définit à
diff ). Cela permet de garantir que le WAL n'expirera que pour les sauvegardes ayant déjà expirées. Si
repo-retention-full-type est positionné sur
time, avec cette valeur, par défaut, les archives qui sont antérieures à la plus ancienne sauvegarde complète conservée et satisfaisant au paramètre
repo-retention-full seront supprimés.
Cette option doit être définie si
repo-retention-archive-type est positionné sur
incr. Si l'espace disque est insuffisant, ce paramètre, associé à
repo-retention-archive-type, peut être utilisé pour faire expirer de manière agressive les segments WAL. Toutefois, cela annule la possibilité d'effectuer un PITR à partir des sauvegardes avec les WAL expirés et donc
n'est pas recommandé.
allowed: 1-9999999
example: --repo1-retention-archive=2
Nom obsolète: retention-archive
Type de sauvegarde pour la conservation des journaux de transaction (WAL).
Lorsque repo-retention-archive-type est positionné sur full pgBackRest conservera les journaux de trasnaction (WAL) pour le nombre de sauvegardes complètes défini par repo-retention-archive. S'il est positionné sur diff (différentiel) pgBackRest conservera les journaux de trasnaction (WAL) pour le nombre de sauvegardes complètes et différentielles défini par repo-retention-archive, ce qui signifie que si la dernière sauvegarde effectuée était une sauvegarde complète, elle sera comptée comme un différentiel pour les besoins de la retention du dépôt. S'il est positionné sur incr (incrémental) pgBackRest conservera les journaux de trasnaction (WAL) pour le nombre de sauvegardes complètes, différentielles et incrémentielles défini par repo-retention-archive. Il est recommandé de ne pas modifier ce paramètre par rapport à la valeur par défaut : expiration que lorsque les sauvegardes complètes auront expiré.
default: full
example: --repo1-retention-archive-type=diff
Nom obsolète: retention-archive-type
Nombre de sauvegardes différentielles à conserver.
Lorsqu'une sauvegarde différentielle expire, toutes les sauvegardes incrémentales associées à la sauvegarde différentielle expirent également. Lorsqu'elles ne sont pas définies, toutes les sauvegardes différentielles seront conservées jusqu'à ce que les sauvegardes complètes dont elles dépendent expirent.
allowed: 1-9999999
example: --repo1-retention-diff=3
Nom obsolète: retention-diff
Nombre ou temps de sauvegardes complètes à conserver.
Lorsqu'une sauvegarde complète expire, toutes les sauvegardes différentielles et incrémentielles associées à la sauvegarde complète expirent également. Lorsque l'option n'est pas définie, un avertissement sera émis. Si une conservation indéfinie est souhaitée, il faut alors définir l'option à la valeur maximale.
allowed: 1-9999999
example: --repo1-retention-full=2
Nom obsolète: retention-full
Type de conservation pour les sauvegardes complètes.
Détermine si le paramètre repo-retention-full représente une période de temps (jours) ou le nombre de sauvegardes complètes à conserver. Si le paramètre est réglé sur time les sauvegardes complètes plus anciennes que le paramètre repo-retention-full seront supprimées du dépôt si au moins une sauvegarde est égale ou supérieure au paramètre repo-retention-full. Par exemple, si repo-retention-full est de 30 (jours) et qu'il y a 2 sauvegardes complètes : une de 25 jours et une de 35 jours, aucune sauvegarde complète n'expirera puisque l'expiration de la sauvegarde de 35 jours ne laisserait que la sauvegarde de 25 jours; ce qui violerait la politique de conservation de 30 jours : à savoir, avoir au moins une sauvegarde de 30 jours avant qu'une plus ancienne puisse expirer. Les journaux de transactions archivés (WAL) plus anciennes que la sauvegarde complète la plus ancienne restante seront automatiquement expirées, à moins que les paramètres repo-retention-archive-type et repo-retention-archive ne soient explicitement définis.
default: count
example: --repo1-retention-full-type=30
S3 dépôt bucket.
Bucket S3 utilisé pour stocker le dépôt.
Les dépots pgBackRest peuvent être stockés à la racine du bucket en définissant repo-path=/ mais il est généralement préférable de spécifier un préfixe, comme par exemple /repo, afin que les logs et autres contenus générés par AWS puissent également être stockés dans le bucket.
example: --repo1-s3-bucket=pg-backup
Ficher SSL CA S3.
Utiliser un fichier CA autre que celui défini par défaut dans le système.
example: --repo1-s3-ca-file=/etc/pki/tls/certs/ca-bundle.crt
Chemin S3 SSL CA.
Utiliser un chemin pour le CA autre que celui défini par défaut dans le système.
example: --repo1-s3-ca-path=/etc/pki/tls/certs
Dépot S3 Point de terminaison (endpoint).
Le point de terminaison d'AWS doit être valable pour la région sélectionnée.
example: --repo1-s3-endpoint=s3.amazonaws.com
Hôte du dépot S3.
Conntecter sur un hôte différent du point de terminaison (endpoint). Il est généralement utilisé à des fins de test.
example: --repo1-s3-host=127.0.0.1
Port de connection au dépot S3.
Port à utiliser lors de la connexion au point de terminaison (ou à l'hôte si spécifié).
default: 443
allowed: 1-65535
example: --repo1-s3-port=9000
Région du dépôt S3.
La région d'AWS où le bucket a été créé.
example: --repo1-s3-region=us-east-1
S3 URI formats.
Les formats URI suivants sont pris en charge:
- host - Connexion à l'hôte bucket.endpoint.
- path - Connexion à l'hôte endpoint et ajout du bucket aux URIs.
default: host
example: --repo1-s3-uri-style=path
Vérifier le certificat du serveur S3.
Désactive la vérification du certificat du serveur S3. Cette fonction ne doit être utilisée que dans le cadre de tests ou dans le cas d'une utilisation avec un certificat a été auto-signé.
default: y
example: --no-repo1-s3-verify-tls
Nom obsolète: repo-s3-verify-ssl
Type de stockage utilisé pour le dépôt.
Les types de stockage suivants sont pris en charge :
- cifs - Comme posix, mais désactive les liens et les fsyncs sur les répertoires
- posix - Systèmes de fichiers conformes à Posix
- s3 - Service de stockage d'objet (AWS Simple Storage Service)
default: posix
example: --repo1-type=cifs
Hôte PostgreSQL pour les opérations à distance via SSH.
Utilisé pour les sauvegardes lorsque l'hôte PostgreSQL est différent de l'hôte du dépôt.
example: --pg1-host=db.domain.com
Nom obsolète: db-host
Emplacement des exécutable pgBackRest sur l'hôte PostgreSQL.
Uniquement requis si le chemin vers pgbackrest est différent sur le serveur local et PostgreSQL. S'il n'est pas défini, le chemin de l'pgbackrest de l'hôte de la base de données sera le même que le chemin de l'pgbackrest local.
example: --pg1-host-cmd=/usr/lib/backrest/bin/pgbackrest
Nom obsolète: db-cmd
pgBackRest database host configuration file.
Définit l'emplacement du fichier de configuration sur l'hôte PostgreSQL. Ceci n'est requis que si le fichier de configuration de l'hôte PostgreSQL se trouve dans un emplacement différent de celui du fichier de configuration local.
default: /etc/pgbackrest/pgbackrest.conf
example: --pg1-host-config=/conf/pgbackrest/pgbackrest.conf
Nom obsolète: db-config
Chemin d'inclusion de la configuration pgBackRest sur l'hôte.
Définit l'emplacement du chemin d'inclusion de la configuration sur l'hôte PostgreSQL. Ceci n'est requis que si le chemin d'inclusion de la configuration de l'hôte PostgreSQL se trouve à un endroit différent du chemin d'inclusion de la configuration locale.
default: /etc/pgbackrest/conf.d
example: --pg1-host-config-include-path=/conf/pgbackrest/conf.d
Chemin de configuration pgBackRest de l'hôte de base de données.
Définit l'emplacement du chemin de configuration sur l'hôte PostgreSQL. Ceci n'est requis que si le chemin de configuration de l'hôte PostgreSQL se trouve dans un emplacement différent du chemin de configuration local.
default: /etc/pgbackrest
example: --pg1-host-config-path=/conf/pgbackrest
Port de l'hôte PostgreSQL lorsque pg-host est configuré.
Utiliser cette option pour spécifier un port non par défaut pour le protocole hôte PostgreSQL. Actuellement, seul le protocole SSH est pris en charge
allowed: 0-65535
example: --pg1-host-port=25
Nom obsolète: db-ssh-port
Utilisateur de connexion PostgreSQL lorsque pg-host est défini.
Cet utilisateur sera également propriétaire du processus distant pgBackRest et initiera les connexions à PostgreSQL. Pour que cela puisse fonctionner correctement, l'utilisateur doit être le propriétaire de l'instance de base de données PostgreSQL, qui est généralement par défaut postgres.
default: postgres
example: --pg1-host-user=db_owner
Nom obsolète: db-user
Trois niveaux d'aide sont disponible. Si aucune commande n'est spécifiée, l'aide générale sera affichée. Si une commande est spécifiée, une description complète de la commande sera affichée ainsi qu'une liste des options valides, enfin si une option est spécifiée en plus de la commande, une description complète de l'option en question s'affichera.
La commande info fonctionne sur un ou plusieurs stanza. La sortie texte est la valeur par défaut et donne un résumé lisible par l'utilisateur des sauvegardes pour le ou les stanza demandées. Ce format est susceptible de changer à chaque version.
Pour une sortie lisible par machine (programme), utiliser l'option --output=json. La sortie JSON contient beaucoup plus d'informations que la sortie texte; elle reste stable à chaque version, à moins qu'un bogue ne soit trouvé.
Format de sortie.
Les sorties suivantes sont prises en charge:
- text - Résumé des informations de sauvegarde lisible par l'utilisateur.
- json - Informations exhaustives sur les sauvegardes au format JSON à destination de machine.
default: text
example: --output=json
Détail du jeu de sauvegarde.
Les détails comportent une liste des bases de données (avec leurs OID) dans le jeu de sauvegarde (à l'exclusion des bases de données modèles), les tablespaces (avec leurs OID) avec la destination où ils seront restaurés par défaut, et les liens symboliques avec la destination où ils seront restaurés lorsque --link-all est spécifié.
example: --set=20150131-153358F_20150131-153401I
Taille de la mémoire tampon pour les opérations sur les fichiers.
Définissez la taille de la mémoire tampon utilisée pour les opérations de copie, de compression et de décompression. Un maximum de 3 tampons seront utilisés à la fois par processus. Un maximum supplémentaire de 256K par processus peut être utilisé pour les tampons zlib.
La taille peut être saisie en octets (par défaut) ou en KB, MB, GB, TB, ou PB où le multiplicateur est une puissance de 1024. Par exemple, la valeur insensible à la casse 32k (ou 32KB) peut être utilisée au lieu de 32768.
Les valeurs autorisées, en octets, sont16384, 32768, 65536, 131072, 262144, 524288, 1048576, 2097152, 4194304, 8388608, et 16777216.
default: 1048576
example: --buffer-size=32K
Chemin d'accès à l'exécutable du client ssh.
Utilisez un client SSH spécifique lorsqu'une alternative est nécessaire ou lorsque l'exécutable ssh n'est pas dans $PATH.
default: ssh
example: --cmd-ssh=/usr/bin/ssh
Niveau de compression du réseau.
Définit le niveau de compression sur le réseau, lorsque compress-type=none et que la commande n'est pas exécutée sur le même hôte que le dépôt. La compression est utilisée pour réduire le trafic réseau mais peut être désactivée en définissant compress-level-network=0. Lorsque compress-type n'est pas égal à none, le paramètre compress-level-network est ignoré et compress-level est utilisé à la place de sorte que le fichier ne soit compressé qu'une seule fois. La compression SSH est toujours désactivée.
default: 3
allowed: 0-9
example: --compress-level-network=1
Fichier de configuration pgBackRest.
Utiliser cette option pour spécifier un fichier de configuration différent de celui par défaut.
default: /etc/pgbackrest/pgbackrest.conf
example: --config=/conf/pgbackrest/pgbackrest.conf
Emplacement des fichiers de configuration pgBackRest supplémentaires..
Les fichiers de configuration existant à l'emplacement spécifié avec l'extension .conf seront concaténés avec le fichier de configuration pgBackRest, ce qui donne un seul fichier de configuration.
default: /etc/pgbackrest/conf.d
example: --config-include-path=/conf/pgbackrest/conf.d
Emplacement du répertoire de racine de pgBackRest des fichiers de configuration.
Ce paramètre est utilisé pour écraser le chemin racine par défaut pour les options --config et --config-include-path à moins qu'elles ne soient explicitement définies sur la ligne de commande.
Par exemple, en utilisant uniquement --config-path=/conf/pgbackrest, la valeur par défaut de --config est /conf/pgbackrest/pgbackrest.conf et la valeur par défaut de --config-include-path est /conf/pgbackrest/conf.d.
default: /etc/pgbackrest
example: --config-path=/conf/pgbackrest
Délai d'attente E/S.
Délai d'attente, en secondes, utilisé pour les connexions et les opérations de lecture/écriture.
Notez que l'ensemble de l'opération de lecture/écriture n'a pas besoin de se terminer dans ce délai mais une progression doit être constatée, même s'il ne s'agit que d'un seul octet.
default: 60
allowed: 0.1-3600
example: --io-timeout=120
Chemin d'accès où sont stockés les fichiers de verrouillage.
Le chemin de verrouillage fournit l'emplacement à pgBackRest pour créer des fichiers de verrouillage afin d'éviter que des opérations en conflictuelles ne soient exécutées simultanément.
default: /tmp/pgbackrest
example: --lock-path=/backup/db/lock
Délai d'attente du protocole.
Définit le délai, en secondes, durant lequel le processus local ou distant attendra qu'un nouveau message soit reçu au niveau de la couche protocole. Cela permet d'éviter que les processus n'attendent indéfiniment un message.
NOTE:
L'option protocol-timeout doit être supérieure à celle de db-timeout option.
default: 1830
allowed: 0.1-604800
example: --protocol-timeout=630
Activation de la fonction de keep-alive (maintien en vie).
Activation des messages de keep-alive (maintien en vie) sur les connexions réseaux.
default: y
example: --no-sck-keep-alive
Defines the stanza.
Un stanza est la configuration de la sauvegarde d'une instance PostgreSQL où est définit l'endroit où il se trouve, la façon dont il sera sauvegardé, les options d'archivage, etc... La plupart des serveurs de base de données n'auront qu'une seule instance PostgreSQL et donc un stanza alors que les serveurs de sauvegarde auront un stanza pour chaque instance de base de données qui doit être sauvegardé.
Il est tentant de nommer le stanza en référence à l'instance primaire, mais un meilleur nom décrirait les bases de données contenues dans l'instance : comme le nom du stanza sera utilisé pour le primaire et tous les secondaire, il est plus approprié de choisir un nom qui décrit la fonction réelle du groupe d'instances, comme app ou dw, plutôt que le nom local de l'instance, comme main ou prod.
example: --stanza=main
Compteur Keep-alive.
Spécifie le nombre de messages TCP à garder en mémoire qui peuvent être perdus avant que la connexion ne soit considérée comme morte.
Cette option n'est disponible que sur les systèmes qui prennent en charge l'option réseau TCP_KEEPCNT.
allowed: 1-32
example: --tcp-keep-alive-count=3
Temps d'inactivité du keepalive.
Spécifie la durée (en secondes) sans activité du réseau après laquelle le système d'exploitation doit envoyer un message TCP de maintien en activité (keep-alive).
Cette option n'est disponible que sur les systèmes qui prennent en charge l'option réseau TCP_KEEPIDLE.
allowed: 1-3600
example: --tcp-keep-alive-idle=60
Temps d'intervalle de maintien en vie (keep-alive).
Spécifie le temps (en secondes) après lequel un message TCP de maintien en activité (keep-alive) non acquitté doit être retransmis.
Cette option n'est disponible que sur les systèmes qui prennent en charge l'option réseau TCP_KEEPINTVL.
allowed: 1-900
example: --tcp-keep-alive-interval=30
Niveau de journalisation en sortie sur la console.
Les niveaux de traces suivants sont pris en charge:
- off - Pas de journal de traces (non recommandé)
- error - Journaliser uniquement les erreurs
- warn - Journaliser les avertissements et les erreurs
- info - Journaliser les messages d'information, les avertissements et les erreurs
- detail - Journaliser les détails, les messages d'information, les avertissements et les erreurs
- debug - Journaliser les message de Débogage, les détails, les messages d'information, les avertissements et les erreurs
- trace - Journaliser les traces (un débogage très verbeux), les message de Débogage, les détails, les messages d'information, les avertissements et les erreurs
default: warn
example: --log-level-console=error
Niveau d'enregistrement des traces lors de l'enregistrement sur fichier.
Les niveaux de traces suivants sont pris en charge:
- off - Pas de journal de traces (non recommandé)
- error - Journaliser uniquement les erreurs
- warn - Journaliser les avertissements et les erreurs
- info - Journaliser les messages d'information, les avertissements et les erreurs
- detail - Journaliser les détails, les messages d'information, les avertissements et les erreurs
- debug - Journaliser les message de Débogage, les détails, les messages d'information, les avertissements et les erreurs
- trace - Journaliser les traces (un débogage très verbeux), les message de Débogage, les détails, les messages d'information, les avertissements et les erreurs
default: info
example: --log-level-file=debug
Niveau de traces sur la sortie console stderr.
Spécifie les niveaux de traces qui sortiront en
stderr plutôt que
stdout (spécifié par
log-level-console). L'horodatage et le processus ne seront pas émis sur
stderr.
Les niveaux de traces suivants sont pris en charge:
- off - Pas de journal de traces (non recommandé)
- error - Journaliser uniquement les erreurs
- warn - Journaliser les avertissements et les erreurs
- info - Journaliser les messages d'information, les avertissements et les erreurs
- detail - Journaliser les détails, les messages d'information, les avertissements et les erreurs
- debug - Journaliser les message de Débogage, les détails, les messages d'information, les avertissements et les erreurs
- trace - Journaliser les traces (un débogage très verbeux), les message de Débogage, les détails, les messages d'information, les avertissements et les erreurs
default: warn
example: --log-level-stderr=error
Emplacement où les fichiers journaux de traces sont stockés.
Le chemin d'accès au journal fournit un emplacement pour pgBackRest pour stocker les fichiers journaux. Notez que si log-level-file=off alors aucun chemin pour l'emplacement des journaux de traces n'est nécessaire.
default: /var/log/pgbackrest
example: --log-path=/backup/db/log
Activer la journalisation des traces dans les sous-processus.
Activez la journalisation des traces dans les fichiers pour tous les sous-processus créés par ce processus en utilisant le niveau de journalisation spécifié par log-level-file.
default: n
example: --log-subprocess
Activer l'horodatage dans les traces.
Active l'horodatage dans la console et l'enregistrement des fichiers. Cette option est désactivée dans des situations particulières telles que la génération de documentation.
default: y
example: --no-log-timestamp
Chiffrement (cipher) utilisé pour chiffrer le dépôt.
Les types de chiffrement suivants sont pris en charge:
- none - Le dépôt n'est pas chiffré.
- aes-256-cbc - Advanced Encryption Standard avec une clef de 256 bit
À noter que le chiffrement est toujours effectué côté client même si le type de stockage (par exemple S3) supporte le chiffrement.
default: none
example: --repo1-cipher-type=aes-256-cbc
Hôte de dépôt dans le cas d'un fonctionnement à distance via SSH.
Assurez-vous que l'authentification SSH soit correctement approuvé entre l'hôte PostgreSQL et l'hôte du référentiel.
Ce paramètre n'est pas nécessaire pour la sauvegarde et l'archivage sur un système de fichiers monté localement.
example: --repo1-host=repo1.domain.com
Nom obsolète: backup-host
Chemin des binaires pgBackRest sur l'hôte du dépôt.
Nécessaire uniquement si le chemin d'accès à pgbackrest est différent entre les hôtes locaux et l'hote du dépôt. S'il n'est pas défini, le chemin des binaires sur l'hôte du dépôt sera le même que le chemin des binaires locaux.
example: --repo1-host-cmd=/usr/lib/backrest/bin/pgbackrest
Nom obsolète: backup-cmd
Emplacement du fichier de configuration pgBackRest sur l'hôte du dépôt.
Définit l'emplacement du fichier de configuration sur l'hôte du dépôt. Ceci n'est nécessaire que si le fichier de configuration de l'hôte du dépôt se trouve dans un emplacement différent de celui du fichier de configuration local.
default: /etc/pgbackrest/pgbackrest.conf
example: --repo1-host-config=/conf/pgbackrest/pgbackrest.conf
Nom obsolète: backup-config
Chemin d'inclusion pgBackRest de la configuration de l'hôte du dépôt.
Définit l'emplacement du chemin d'inclusion de la configuration sur l'hôte du dépôt. Ceci n'est nécessaire que si le chemin d'inclusion de la configuration de l'hôte du dépôt se trouve à un endroit différent du chemin d'inclusion de la configuration locale.
default: /etc/pgbackrest/conf.d
example: --repo1-host-config-include-path=/conf/pgbackrest/conf.d
Chemin de configuration pgBackRest de l'hôte du dépôt.
Définit l'emplacement du chemin de configuration sur l'hôte du dépôt. Ceci n'est nécessaire que si le chemin de configuration de l'hôte du référentiel se trouve à un endroit différent du chemin de configuration local.
default: /etc/pgbackrest
example: --repo1-host-config-path=/conf/pgbackrest
Port de l'hôte du dépôt lorsque repo-host est défini.
Utilisez cette option pour spécifier un port non par défaut pour le protocole d'accès à l'hôte du dépôt. Actuellement, seul SSH est pris en charge
allowed: 0-65535
example: --repo1-host-port=25
Nom obsolète: backup-ssh-port
Utilisateur de l'hôte du dépôt lorsque repo-host est défini.
Définit l'utilisateur qui sera utilisé pour les opérations sur l'hôte du dépôt. De préférence, il ne s'agit pas de l'utilisateur postgres mais plutôt d'un autre utilisateur comme pgbackrest. Si PostgreSQL fonctionne sur l'hôte du dépôt, l'utilisateur postgres peut être placé dans le groupe pgbackrest afin qu'il ait les autorisations de lecture sur le dépôt sans pouvoir en endommager le contenu accidentellement.
default: pgbackrest
example: --repo1-host-user=repo-user
Nom obsolète: backup-user
Chemin d'accès où sont stockées les sauvegardes et les archives.
Le dépôt est l'endroit où pgBackRest stocke les sauvegardes et archive les segments des journaux de transaction (WAL).
Il peut être difficile d'estimer à l'avance l'espace dont vous aurez besoin. La meilleure chose à faire est de prendre quelques sauvegardes puis d'enregistrer la taille des différents types de sauvegardes (full/incr/diff) et de mesurer la quantité de WAL générée par jour. Cela vous donnera une idée générale de l'espace dont vous aurez besoin, même si, bien sûr, les besoins changeront probablement au fil du temps, à fur et à mesure de l'évolution de votre base de données.
default: /var/lib/pgbackrest
example: --repo1-path=/backup/db/backrest
S3 dépôt bucket.
Bucket S3 utilisé pour stocker le dépôt.
Les dépots pgBackRest peuvent être stockés à la racine du bucket en définissant repo-path=/ mais il est généralement préférable de spécifier un préfixe, comme par exemple /repo, afin que les logs et autres contenus générés par AWS puissent également être stockés dans le bucket.
example: --repo1-s3-bucket=pg-backup
Ficher SSL CA S3.
Utiliser un fichier CA autre que celui défini par défaut dans le système.
example: --repo1-s3-ca-file=/etc/pki/tls/certs/ca-bundle.crt
Chemin S3 SSL CA.
Utiliser un chemin pour le CA autre que celui défini par défaut dans le système.
example: --repo1-s3-ca-path=/etc/pki/tls/certs
Dépot S3 Point de terminaison (endpoint).
Le point de terminaison d'AWS doit être valable pour la région sélectionnée.
example: --repo1-s3-endpoint=s3.amazonaws.com
Hôte du dépot S3.
Conntecter sur un hôte différent du point de terminaison (endpoint). Il est généralement utilisé à des fins de test.
example: --repo1-s3-host=127.0.0.1
Port de connection au dépot S3.
Port à utiliser lors de la connexion au point de terminaison (ou à l'hôte si spécifié).
default: 443
allowed: 1-65535
example: --repo1-s3-port=9000
Région du dépôt S3.
La région d'AWS où le bucket a été créé.
example: --repo1-s3-region=us-east-1
S3 URI formats.
Les formats URI suivants sont pris en charge:
- host - Connexion à l'hôte bucket.endpoint.
- path - Connexion à l'hôte endpoint et ajout du bucket aux URIs.
default: host
example: --repo1-s3-uri-style=path
Vérifier le certificat du serveur S3.
Désactive la vérification du certificat du serveur S3. Cette fonction ne doit être utilisée que dans le cadre de tests ou dans le cas d'une utilisation avec un certificat a été auto-signé.
default: y
example: --no-repo1-s3-verify-tls
Nom obsolète: repo-s3-verify-ssl
Type de stockage utilisé pour le dépôt.
Les types de stockage suivants sont pris en charge :
- cifs - Comme posix, mais désactive les liens et les fsyncs sur les répertoires
- posix - Systèmes de fichiers conformes à Posix
- s3 - Service de stockage d'objet (AWS Simple Storage Service)
default: posix
example: --repo1-type=cifs
Création du bucket si l'option repo-type=s3.
POUR UN USAGE INTERNE UNIQUEMENT. NE PAS UTILISER EN PRODUCTION.
Taille de la mémoire tampon pour les opérations sur les fichiers.
Définissez la taille de la mémoire tampon utilisée pour les opérations de copie, de compression et de décompression. Un maximum de 3 tampons seront utilisés à la fois par processus. Un maximum supplémentaire de 256K par processus peut être utilisé pour les tampons zlib.
La taille peut être saisie en octets (par défaut) ou en KB, MB, GB, TB, ou PB où le multiplicateur est une puissance de 1024. Par exemple, la valeur insensible à la casse 32k (ou 32KB) peut être utilisée au lieu de 32768.
Les valeurs autorisées, en octets, sont16384, 32768, 65536, 131072, 262144, 524288, 1048576, 2097152, 4194304, 8388608, et 16777216.
default: 1048576
example: --buffer-size=32K
Chemin d'accès à l'exécutable du client ssh.
Utilisez un client SSH spécifique lorsqu'une alternative est nécessaire ou lorsque l'exécutable ssh n'est pas dans $PATH.
default: ssh
example: --cmd-ssh=/usr/bin/ssh
Fichier de configuration pgBackRest.
Utiliser cette option pour spécifier un fichier de configuration différent de celui par défaut.
default: /etc/pgbackrest/pgbackrest.conf
example: --config=/conf/pgbackrest/pgbackrest.conf
Emplacement des fichiers de configuration pgBackRest supplémentaires..
Les fichiers de configuration existant à l'emplacement spécifié avec l'extension .conf seront concaténés avec le fichier de configuration pgBackRest, ce qui donne un seul fichier de configuration.
default: /etc/pgbackrest/conf.d
example: --config-include-path=/conf/pgbackrest/conf.d
Emplacement du répertoire de racine de pgBackRest des fichiers de configuration.
Ce paramètre est utilisé pour écraser le chemin racine par défaut pour les options --config et --config-include-path à moins qu'elles ne soient explicitement définies sur la ligne de commande.
Par exemple, en utilisant uniquement --config-path=/conf/pgbackrest, la valeur par défaut de --config est /conf/pgbackrest/pgbackrest.conf et la valeur par défaut de --config-include-path est /conf/pgbackrest/conf.d.
default: /etc/pgbackrest
example: --config-path=/conf/pgbackrest
Délai d'attente des requêtes à la base de données.
Définit le délai d'attente, en secondes, pour les interrogations de la base de données. Cela inclut les fonctions
pg_start_backup() et
pg_stop_backup() qui peuvent chacune prendre un temps considérable. C'est pourquoi le délai d'attente doit être maintenu à un niveau élevé, sauf si vous savez que ces fonctions retourneront rapidement (c'est-à-dire si vous avez défini
startfast=y et que vous savez que l'instance de base de données ne générera pas beaucoup de segments WAL pendant la sauvegarde).
NOTE:
L'option db-timeout doit être inférieure à l'option protocol-timeout.
default: 1800
allowed: 0.1-604800
example: --db-timeout=600
Délai d'attente E/S.
Délai d'attente, en secondes, utilisé pour les connexions et les opérations de lecture/écriture.
Notez que l'ensemble de l'opération de lecture/écriture n'a pas besoin de se terminer dans ce délai mais une progression doit être constatée, même s'il ne s'agit que d'un seul octet.
default: 60
allowed: 0.1-3600
example: --io-timeout=120
Utilisation d'un umask
neutre
Définit l'umask à 0000 pour que les modes dans le dépôt de sauvegarde soient créés de manière appropriée. Le mode par défaut du répertoire est 0750 et le mode par défaut du fichier est 0640. Pour les répertoires lock et log, les modes de répertoire et de fichier sont respectivement fixés à 0770 et 0660.
Pour utiliser l'umask de l'utilisateur en cours d'exécution, spécifiez plutôt neutral-umask=n dans le fichier de configuration ou --no-neutral-umask sur la ligne de commande.
default: y
example: --no-neutral-umask
Délai d'attente du protocole.
Définit le délai, en secondes, durant lequel le processus local ou distant attendra qu'un nouveau message soit reçu au niveau de la couche protocole. Cela permet d'éviter que les processus n'attendent indéfiniment un message.
NOTE:
L'option protocol-timeout doit être supérieure à celle de db-timeout option.
default: 1830
allowed: 0.1-604800
example: --protocol-timeout=630
Activation de la fonction de keep-alive (maintien en vie).
Activation des messages de keep-alive (maintien en vie) sur les connexions réseaux.
default: y
example: --no-sck-keep-alive
Defines the stanza.
Un stanza est la configuration de la sauvegarde d'une instance PostgreSQL où est définit l'endroit où il se trouve, la façon dont il sera sauvegardé, les options d'archivage, etc... La plupart des serveurs de base de données n'auront qu'une seule instance PostgreSQL et donc un stanza alors que les serveurs de sauvegarde auront un stanza pour chaque instance de base de données qui doit être sauvegardé.
Il est tentant de nommer le stanza en référence à l'instance primaire, mais un meilleur nom décrirait les bases de données contenues dans l'instance : comme le nom du stanza sera utilisé pour le primaire et tous les secondaire, il est plus approprié de choisir un nom qui décrit la fonction réelle du groupe d'instances, comme app ou dw, plutôt que le nom local de l'instance, comme main ou prod.
example: --stanza=main
Compteur Keep-alive.
Spécifie le nombre de messages TCP à garder en mémoire qui peuvent être perdus avant que la connexion ne soit considérée comme morte.
Cette option n'est disponible que sur les systèmes qui prennent en charge l'option réseau TCP_KEEPCNT.
allowed: 1-32
example: --tcp-keep-alive-count=3
Temps d'inactivité du keepalive.
Spécifie la durée (en secondes) sans activité du réseau après laquelle le système d'exploitation doit envoyer un message TCP de maintien en activité (keep-alive).
Cette option n'est disponible que sur les systèmes qui prennent en charge l'option réseau TCP_KEEPIDLE.
allowed: 1-3600
example: --tcp-keep-alive-idle=60
Temps d'intervalle de maintien en vie (keep-alive).
Spécifie le temps (en secondes) après lequel un message TCP de maintien en activité (keep-alive) non acquitté doit être retransmis.
Cette option n'est disponible que sur les systèmes qui prennent en charge l'option réseau TCP_KEEPINTVL.
allowed: 1-900
example: --tcp-keep-alive-interval=30
Niveau de journalisation en sortie sur la console.
Les niveaux de traces suivants sont pris en charge:
- off - Pas de journal de traces (non recommandé)
- error - Journaliser uniquement les erreurs
- warn - Journaliser les avertissements et les erreurs
- info - Journaliser les messages d'information, les avertissements et les erreurs
- detail - Journaliser les détails, les messages d'information, les avertissements et les erreurs
- debug - Journaliser les message de Débogage, les détails, les messages d'information, les avertissements et les erreurs
- trace - Journaliser les traces (un débogage très verbeux), les message de Débogage, les détails, les messages d'information, les avertissements et les erreurs
default: warn
example: --log-level-console=error
Niveau d'enregistrement des traces lors de l'enregistrement sur fichier.
Les niveaux de traces suivants sont pris en charge:
- off - Pas de journal de traces (non recommandé)
- error - Journaliser uniquement les erreurs
- warn - Journaliser les avertissements et les erreurs
- info - Journaliser les messages d'information, les avertissements et les erreurs
- detail - Journaliser les détails, les messages d'information, les avertissements et les erreurs
- debug - Journaliser les message de Débogage, les détails, les messages d'information, les avertissements et les erreurs
- trace - Journaliser les traces (un débogage très verbeux), les message de Débogage, les détails, les messages d'information, les avertissements et les erreurs
default: info
example: --log-level-file=debug
Niveau de traces sur la sortie console stderr.
Spécifie les niveaux de traces qui sortiront en
stderr plutôt que
stdout (spécifié par
log-level-console). L'horodatage et le processus ne seront pas émis sur
stderr.
Les niveaux de traces suivants sont pris en charge:
- off - Pas de journal de traces (non recommandé)
- error - Journaliser uniquement les erreurs
- warn - Journaliser les avertissements et les erreurs
- info - Journaliser les messages d'information, les avertissements et les erreurs
- detail - Journaliser les détails, les messages d'information, les avertissements et les erreurs
- debug - Journaliser les message de Débogage, les détails, les messages d'information, les avertissements et les erreurs
- trace - Journaliser les traces (un débogage très verbeux), les message de Débogage, les détails, les messages d'information, les avertissements et les erreurs
default: warn
example: --log-level-stderr=error
Emplacement où les fichiers journaux de traces sont stockés.
Le chemin d'accès au journal fournit un emplacement pour pgBackRest pour stocker les fichiers journaux. Notez que si log-level-file=off alors aucun chemin pour l'emplacement des journaux de traces n'est nécessaire.
default: /var/log/pgbackrest
example: --log-path=/backup/db/log
Activer la journalisation des traces dans les sous-processus.
Activez la journalisation des traces dans les fichiers pour tous les sous-processus créés par ce processus en utilisant le niveau de journalisation spécifié par log-level-file.
default: n
example: --log-subprocess
Activer l'horodatage dans les traces.
Active l'horodatage dans la console et l'enregistrement des fichiers. Cette option est désactivée dans des situations particulières telles que la génération de documentation.
default: y
example: --no-log-timestamp
Chiffrement (cipher) utilisé pour chiffrer le dépôt.
Les types de chiffrement suivants sont pris en charge:
- none - Le dépôt n'est pas chiffré.
- aes-256-cbc - Advanced Encryption Standard avec une clef de 256 bit
À noter que le chiffrement est toujours effectué côté client même si le type de stockage (par exemple S3) supporte le chiffrement.
default: none
example: --repo1-cipher-type=aes-256-cbc
Hôte de dépôt dans le cas d'un fonctionnement à distance via SSH.
Assurez-vous que l'authentification SSH soit correctement approuvé entre l'hôte PostgreSQL et l'hôte du référentiel.
Ce paramètre n'est pas nécessaire pour la sauvegarde et l'archivage sur un système de fichiers monté localement.
example: --repo1-host=repo1.domain.com
Nom obsolète: backup-host
Chemin des binaires pgBackRest sur l'hôte du dépôt.
Nécessaire uniquement si le chemin d'accès à pgbackrest est différent entre les hôtes locaux et l'hote du dépôt. S'il n'est pas défini, le chemin des binaires sur l'hôte du dépôt sera le même que le chemin des binaires locaux.
example: --repo1-host-cmd=/usr/lib/backrest/bin/pgbackrest
Nom obsolète: backup-cmd
Emplacement du fichier de configuration pgBackRest sur l'hôte du dépôt.
Définit l'emplacement du fichier de configuration sur l'hôte du dépôt. Ceci n'est nécessaire que si le fichier de configuration de l'hôte du dépôt se trouve dans un emplacement différent de celui du fichier de configuration local.
default: /etc/pgbackrest/pgbackrest.conf
example: --repo1-host-config=/conf/pgbackrest/pgbackrest.conf
Nom obsolète: backup-config
Chemin d'inclusion pgBackRest de la configuration de l'hôte du dépôt.
Définit l'emplacement du chemin d'inclusion de la configuration sur l'hôte du dépôt. Ceci n'est nécessaire que si le chemin d'inclusion de la configuration de l'hôte du dépôt se trouve à un endroit différent du chemin d'inclusion de la configuration locale.
default: /etc/pgbackrest/conf.d
example: --repo1-host-config-include-path=/conf/pgbackrest/conf.d
Chemin de configuration pgBackRest de l'hôte du dépôt.
Définit l'emplacement du chemin de configuration sur l'hôte du dépôt. Ceci n'est nécessaire que si le chemin de configuration de l'hôte du référentiel se trouve à un endroit différent du chemin de configuration local.
default: /etc/pgbackrest
example: --repo1-host-config-path=/conf/pgbackrest
Port de l'hôte du dépôt lorsque repo-host est défini.
Utilisez cette option pour spécifier un port non par défaut pour le protocole d'accès à l'hôte du dépôt. Actuellement, seul SSH est pris en charge
allowed: 0-65535
example: --repo1-host-port=25
Nom obsolète: backup-ssh-port
Utilisateur de l'hôte du dépôt lorsque repo-host est défini.
Définit l'utilisateur qui sera utilisé pour les opérations sur l'hôte du dépôt. De préférence, il ne s'agit pas de l'utilisateur postgres mais plutôt d'un autre utilisateur comme pgbackrest. Si PostgreSQL fonctionne sur l'hôte du dépôt, l'utilisateur postgres peut être placé dans le groupe pgbackrest afin qu'il ait les autorisations de lecture sur le dépôt sans pouvoir en endommager le contenu accidentellement.
default: pgbackrest
example: --repo1-host-user=repo-user
Nom obsolète: backup-user
Chemin d'accès où sont stockées les sauvegardes et les archives.
Le dépôt est l'endroit où pgBackRest stocke les sauvegardes et archive les segments des journaux de transaction (WAL).
Il peut être difficile d'estimer à l'avance l'espace dont vous aurez besoin. La meilleure chose à faire est de prendre quelques sauvegardes puis d'enregistrer la taille des différents types de sauvegardes (full/incr/diff) et de mesurer la quantité de WAL générée par jour. Cela vous donnera une idée générale de l'espace dont vous aurez besoin, même si, bien sûr, les besoins changeront probablement au fil du temps, à fur et à mesure de l'évolution de votre base de données.
default: /var/lib/pgbackrest
example: --repo1-path=/backup/db/backrest
S3 dépôt bucket.
Bucket S3 utilisé pour stocker le dépôt.
Les dépots pgBackRest peuvent être stockés à la racine du bucket en définissant repo-path=/ mais il est généralement préférable de spécifier un préfixe, comme par exemple /repo, afin que les logs et autres contenus générés par AWS puissent également être stockés dans le bucket.
example: --repo1-s3-bucket=pg-backup
Ficher SSL CA S3.
Utiliser un fichier CA autre que celui défini par défaut dans le système.
example: --repo1-s3-ca-file=/etc/pki/tls/certs/ca-bundle.crt
Chemin S3 SSL CA.
Utiliser un chemin pour le CA autre que celui défini par défaut dans le système.
example: --repo1-s3-ca-path=/etc/pki/tls/certs
Dépot S3 Point de terminaison (endpoint).
Le point de terminaison d'AWS doit être valable pour la région sélectionnée.
example: --repo1-s3-endpoint=s3.amazonaws.com
Hôte du dépot S3.
Conntecter sur un hôte différent du point de terminaison (endpoint). Il est généralement utilisé à des fins de test.
example: --repo1-s3-host=127.0.0.1
Port de connection au dépot S3.
Port à utiliser lors de la connexion au point de terminaison (ou à l'hôte si spécifié).
default: 443
allowed: 1-65535
example: --repo1-s3-port=9000
Région du dépôt S3.
La région d'AWS où le bucket a été créé.
example: --repo1-s3-region=us-east-1
S3 URI formats.
Les formats URI suivants sont pris en charge:
- host - Connexion à l'hôte bucket.endpoint.
- path - Connexion à l'hôte endpoint et ajout du bucket aux URIs.
default: host
example: --repo1-s3-uri-style=path
Vérifier le certificat du serveur S3.
Désactive la vérification du certificat du serveur S3. Cette fonction ne doit être utilisée que dans le cadre de tests ou dans le cas d'une utilisation avec un certificat a été auto-signé.
default: y
example: --no-repo1-s3-verify-tls
Nom obsolète: repo-s3-verify-ssl
Type de stockage utilisé pour le dépôt.
Les types de stockage suivants sont pris en charge :
- cifs - Comme posix, mais désactive les liens et les fsyncs sur les répertoires
- posix - Systèmes de fichiers conformes à Posix
- s3 - Service de stockage d'objet (AWS Simple Storage Service)
default: posix
example: --repo1-type=cifs
Similaire à la commande unix cat mais les options sont différentes.
Ignorer le fichier source manquant.
Se termine avec un code de sortie à 1 si le fichier source est manquant mais n'affiche pas d'erreur.
default: n
example: --ignore-missing
Taille de la mémoire tampon pour les opérations sur les fichiers.
Définissez la taille de la mémoire tampon utilisée pour les opérations de copie, de compression et de décompression. Un maximum de 3 tampons seront utilisés à la fois par processus. Un maximum supplémentaire de 256K par processus peut être utilisé pour les tampons zlib.
La taille peut être saisie en octets (par défaut) ou en KB, MB, GB, TB, ou PB où le multiplicateur est une puissance de 1024. Par exemple, la valeur insensible à la casse 32k (ou 32KB) peut être utilisée au lieu de 32768.
Les valeurs autorisées, en octets, sont16384, 32768, 65536, 131072, 262144, 524288, 1048576, 2097152, 4194304, 8388608, et 16777216.
default: 1048576
example: --buffer-size=32K
Chemin d'accès à l'exécutable du client ssh.
Utilisez un client SSH spécifique lorsqu'une alternative est nécessaire ou lorsque l'exécutable ssh n'est pas dans $PATH.
default: ssh
example: --cmd-ssh=/usr/bin/ssh
Niveau de compression du réseau.
Définit le niveau de compression sur le réseau, lorsque compress-type=none et que la commande n'est pas exécutée sur le même hôte que le dépôt. La compression est utilisée pour réduire le trafic réseau mais peut être désactivée en définissant compress-level-network=0. Lorsque compress-type n'est pas égal à none, le paramètre compress-level-network est ignoré et compress-level est utilisé à la place de sorte que le fichier ne soit compressé qu'une seule fois. La compression SSH est toujours désactivée.
default: 3
allowed: 0-9
example: --compress-level-network=1
Fichier de configuration pgBackRest.
Utiliser cette option pour spécifier un fichier de configuration différent de celui par défaut.
default: /etc/pgbackrest/pgbackrest.conf
example: --config=/conf/pgbackrest/pgbackrest.conf
Emplacement des fichiers de configuration pgBackRest supplémentaires..
Les fichiers de configuration existant à l'emplacement spécifié avec l'extension .conf seront concaténés avec le fichier de configuration pgBackRest, ce qui donne un seul fichier de configuration.
default: /etc/pgbackrest/conf.d
example: --config-include-path=/conf/pgbackrest/conf.d
Emplacement du répertoire de racine de pgBackRest des fichiers de configuration.
Ce paramètre est utilisé pour écraser le chemin racine par défaut pour les options --config et --config-include-path à moins qu'elles ne soient explicitement définies sur la ligne de commande.
Par exemple, en utilisant uniquement --config-path=/conf/pgbackrest, la valeur par défaut de --config est /conf/pgbackrest/pgbackrest.conf et la valeur par défaut de --config-include-path est /conf/pgbackrest/conf.d.
default: /etc/pgbackrest
example: --config-path=/conf/pgbackrest
Délai d'attente des requêtes à la base de données.
Définit le délai d'attente, en secondes, pour les interrogations de la base de données. Cela inclut les fonctions
pg_start_backup() et
pg_stop_backup() qui peuvent chacune prendre un temps considérable. C'est pourquoi le délai d'attente doit être maintenu à un niveau élevé, sauf si vous savez que ces fonctions retourneront rapidement (c'est-à-dire si vous avez défini
startfast=y et que vous savez que l'instance de base de données ne générera pas beaucoup de segments WAL pendant la sauvegarde).
NOTE:
L'option db-timeout doit être inférieure à l'option protocol-timeout.
default: 1800
allowed: 0.1-604800
example: --db-timeout=600
Délai d'attente E/S.
Délai d'attente, en secondes, utilisé pour les connexions et les opérations de lecture/écriture.
Notez que l'ensemble de l'opération de lecture/écriture n'a pas besoin de se terminer dans ce délai mais une progression doit être constatée, même s'il ne s'agit que d'un seul octet.
default: 60
allowed: 0.1-3600
example: --io-timeout=120
Utilisation d'un umask
neutre
Définit l'umask à 0000 pour que les modes dans le dépôt de sauvegarde soient créés de manière appropriée. Le mode par défaut du répertoire est 0750 et le mode par défaut du fichier est 0640. Pour les répertoires lock et log, les modes de répertoire et de fichier sont respectivement fixés à 0770 et 0660.
Pour utiliser l'umask de l'utilisateur en cours d'exécution, spécifiez plutôt neutral-umask=n dans le fichier de configuration ou --no-neutral-umask sur la ligne de commande.
default: y
example: --no-neutral-umask
Délai d'attente du protocole.
Définit le délai, en secondes, durant lequel le processus local ou distant attendra qu'un nouveau message soit reçu au niveau de la couche protocole. Cela permet d'éviter que les processus n'attendent indéfiniment un message.
NOTE:
L'option protocol-timeout doit être supérieure à celle de db-timeout option.
default: 1830
allowed: 0.1-604800
example: --protocol-timeout=630
Ne pas transformer les données.
Ne pas transformer (c'est-à-dire crypter, décompresser, etc.) les données pour la commande en cours.
default: n
example: --raw
Activation de la fonction de keep-alive (maintien en vie).
Activation des messages de keep-alive (maintien en vie) sur les connexions réseaux.
default: y
example: --no-sck-keep-alive
Defines the stanza.
Un stanza est la configuration de la sauvegarde d'une instance PostgreSQL où est définit l'endroit où il se trouve, la façon dont il sera sauvegardé, les options d'archivage, etc... La plupart des serveurs de base de données n'auront qu'une seule instance PostgreSQL et donc un stanza alors que les serveurs de sauvegarde auront un stanza pour chaque instance de base de données qui doit être sauvegardé.
Il est tentant de nommer le stanza en référence à l'instance primaire, mais un meilleur nom décrirait les bases de données contenues dans l'instance : comme le nom du stanza sera utilisé pour le primaire et tous les secondaire, il est plus approprié de choisir un nom qui décrit la fonction réelle du groupe d'instances, comme app ou dw, plutôt que le nom local de l'instance, comme main ou prod.
example: --stanza=main
Compteur Keep-alive.
Spécifie le nombre de messages TCP à garder en mémoire qui peuvent être perdus avant que la connexion ne soit considérée comme morte.
Cette option n'est disponible que sur les systèmes qui prennent en charge l'option réseau TCP_KEEPCNT.
allowed: 1-32
example: --tcp-keep-alive-count=3
Temps d'inactivité du keepalive.
Spécifie la durée (en secondes) sans activité du réseau après laquelle le système d'exploitation doit envoyer un message TCP de maintien en activité (keep-alive).
Cette option n'est disponible que sur les systèmes qui prennent en charge l'option réseau TCP_KEEPIDLE.
allowed: 1-3600
example: --tcp-keep-alive-idle=60
Temps d'intervalle de maintien en vie (keep-alive).
Spécifie le temps (en secondes) après lequel un message TCP de maintien en activité (keep-alive) non acquitté doit être retransmis.
Cette option n'est disponible que sur les systèmes qui prennent en charge l'option réseau TCP_KEEPINTVL.
allowed: 1-900
example: --tcp-keep-alive-interval=30
Niveau de journalisation en sortie sur la console.
Les niveaux de traces suivants sont pris en charge:
- off - Pas de journal de traces (non recommandé)
- error - Journaliser uniquement les erreurs
- warn - Journaliser les avertissements et les erreurs
- info - Journaliser les messages d'information, les avertissements et les erreurs
- detail - Journaliser les détails, les messages d'information, les avertissements et les erreurs
- debug - Journaliser les message de Débogage, les détails, les messages d'information, les avertissements et les erreurs
- trace - Journaliser les traces (un débogage très verbeux), les message de Débogage, les détails, les messages d'information, les avertissements et les erreurs
default: warn
example: --log-level-console=error
Niveau d'enregistrement des traces lors de l'enregistrement sur fichier.
Les niveaux de traces suivants sont pris en charge:
- off - Pas de journal de traces (non recommandé)
- error - Journaliser uniquement les erreurs
- warn - Journaliser les avertissements et les erreurs
- info - Journaliser les messages d'information, les avertissements et les erreurs
- detail - Journaliser les détails, les messages d'information, les avertissements et les erreurs
- debug - Journaliser les message de Débogage, les détails, les messages d'information, les avertissements et les erreurs
- trace - Journaliser les traces (un débogage très verbeux), les message de Débogage, les détails, les messages d'information, les avertissements et les erreurs
default: info
example: --log-level-file=debug
Niveau de traces sur la sortie console stderr.
Spécifie les niveaux de traces qui sortiront en
stderr plutôt que
stdout (spécifié par
log-level-console). L'horodatage et le processus ne seront pas émis sur
stderr.
Les niveaux de traces suivants sont pris en charge:
- off - Pas de journal de traces (non recommandé)
- error - Journaliser uniquement les erreurs
- warn - Journaliser les avertissements et les erreurs
- info - Journaliser les messages d'information, les avertissements et les erreurs
- detail - Journaliser les détails, les messages d'information, les avertissements et les erreurs
- debug - Journaliser les message de Débogage, les détails, les messages d'information, les avertissements et les erreurs
- trace - Journaliser les traces (un débogage très verbeux), les message de Débogage, les détails, les messages d'information, les avertissements et les erreurs
default: warn
example: --log-level-stderr=error
Emplacement où les fichiers journaux de traces sont stockés.
Le chemin d'accès au journal fournit un emplacement pour pgBackRest pour stocker les fichiers journaux. Notez que si log-level-file=off alors aucun chemin pour l'emplacement des journaux de traces n'est nécessaire.
default: /var/log/pgbackrest
example: --log-path=/backup/db/log
Activer la journalisation des traces dans les sous-processus.
Activez la journalisation des traces dans les fichiers pour tous les sous-processus créés par ce processus en utilisant le niveau de journalisation spécifié par log-level-file.
default: n
example: --log-subprocess
Activer l'horodatage dans les traces.
Active l'horodatage dans la console et l'enregistrement des fichiers. Cette option est désactivée dans des situations particulières telles que la génération de documentation.
default: y
example: --no-log-timestamp
Chiffrement (cipher) utilisé pour chiffrer le dépôt.
Les types de chiffrement suivants sont pris en charge:
- none - Le dépôt n'est pas chiffré.
- aes-256-cbc - Advanced Encryption Standard avec une clef de 256 bit
À noter que le chiffrement est toujours effectué côté client même si le type de stockage (par exemple S3) supporte le chiffrement.
default: none
example: --repo1-cipher-type=aes-256-cbc
Hôte de dépôt dans le cas d'un fonctionnement à distance via SSH.
Assurez-vous que l'authentification SSH soit correctement approuvé entre l'hôte PostgreSQL et l'hôte du référentiel.
Ce paramètre n'est pas nécessaire pour la sauvegarde et l'archivage sur un système de fichiers monté localement.
example: --repo1-host=repo1.domain.com
Nom obsolète: backup-host
Chemin des binaires pgBackRest sur l'hôte du dépôt.
Nécessaire uniquement si le chemin d'accès à pgbackrest est différent entre les hôtes locaux et l'hote du dépôt. S'il n'est pas défini, le chemin des binaires sur l'hôte du dépôt sera le même que le chemin des binaires locaux.
example: --repo1-host-cmd=/usr/lib/backrest/bin/pgbackrest
Nom obsolète: backup-cmd
Emplacement du fichier de configuration pgBackRest sur l'hôte du dépôt.
Définit l'emplacement du fichier de configuration sur l'hôte du dépôt. Ceci n'est nécessaire que si le fichier de configuration de l'hôte du dépôt se trouve dans un emplacement différent de celui du fichier de configuration local.
default: /etc/pgbackrest/pgbackrest.conf
example: --repo1-host-config=/conf/pgbackrest/pgbackrest.conf
Nom obsolète: backup-config
Chemin d'inclusion pgBackRest de la configuration de l'hôte du dépôt.
Définit l'emplacement du chemin d'inclusion de la configuration sur l'hôte du dépôt. Ceci n'est nécessaire que si le chemin d'inclusion de la configuration de l'hôte du dépôt se trouve à un endroit différent du chemin d'inclusion de la configuration locale.
default: /etc/pgbackrest/conf.d
example: --repo1-host-config-include-path=/conf/pgbackrest/conf.d
Chemin de configuration pgBackRest de l'hôte du dépôt.
Définit l'emplacement du chemin de configuration sur l'hôte du dépôt. Ceci n'est nécessaire que si le chemin de configuration de l'hôte du référentiel se trouve à un endroit différent du chemin de configuration local.
default: /etc/pgbackrest
example: --repo1-host-config-path=/conf/pgbackrest
Port de l'hôte du dépôt lorsque repo-host est défini.
Utilisez cette option pour spécifier un port non par défaut pour le protocole d'accès à l'hôte du dépôt. Actuellement, seul SSH est pris en charge
allowed: 0-65535
example: --repo1-host-port=25
Nom obsolète: backup-ssh-port
Utilisateur de l'hôte du dépôt lorsque repo-host est défini.
Définit l'utilisateur qui sera utilisé pour les opérations sur l'hôte du dépôt. De préférence, il ne s'agit pas de l'utilisateur postgres mais plutôt d'un autre utilisateur comme pgbackrest. Si PostgreSQL fonctionne sur l'hôte du dépôt, l'utilisateur postgres peut être placé dans le groupe pgbackrest afin qu'il ait les autorisations de lecture sur le dépôt sans pouvoir en endommager le contenu accidentellement.
default: pgbackrest
example: --repo1-host-user=repo-user
Nom obsolète: backup-user
Chemin d'accès où sont stockées les sauvegardes et les archives.
Le dépôt est l'endroit où pgBackRest stocke les sauvegardes et archive les segments des journaux de transaction (WAL).
Il peut être difficile d'estimer à l'avance l'espace dont vous aurez besoin. La meilleure chose à faire est de prendre quelques sauvegardes puis d'enregistrer la taille des différents types de sauvegardes (full/incr/diff) et de mesurer la quantité de WAL générée par jour. Cela vous donnera une idée générale de l'espace dont vous aurez besoin, même si, bien sûr, les besoins changeront probablement au fil du temps, à fur et à mesure de l'évolution de votre base de données.
default: /var/lib/pgbackrest
example: --repo1-path=/backup/db/backrest
S3 dépôt bucket.
Bucket S3 utilisé pour stocker le dépôt.
Les dépots pgBackRest peuvent être stockés à la racine du bucket en définissant repo-path=/ mais il est généralement préférable de spécifier un préfixe, comme par exemple /repo, afin que les logs et autres contenus générés par AWS puissent également être stockés dans le bucket.
example: --repo1-s3-bucket=pg-backup
Ficher SSL CA S3.
Utiliser un fichier CA autre que celui défini par défaut dans le système.
example: --repo1-s3-ca-file=/etc/pki/tls/certs/ca-bundle.crt
Chemin S3 SSL CA.
Utiliser un chemin pour le CA autre que celui défini par défaut dans le système.
example: --repo1-s3-ca-path=/etc/pki/tls/certs
Dépot S3 Point de terminaison (endpoint).
Le point de terminaison d'AWS doit être valable pour la région sélectionnée.
example: --repo1-s3-endpoint=s3.amazonaws.com
Hôte du dépot S3.
Conntecter sur un hôte différent du point de terminaison (endpoint). Il est généralement utilisé à des fins de test.
example: --repo1-s3-host=127.0.0.1
Port de connection au dépot S3.
Port à utiliser lors de la connexion au point de terminaison (ou à l'hôte si spécifié).
default: 443
allowed: 1-65535
example: --repo1-s3-port=9000
Région du dépôt S3.
La région d'AWS où le bucket a été créé.
example: --repo1-s3-region=us-east-1
S3 URI formats.
Les formats URI suivants sont pris en charge:
- host - Connexion à l'hôte bucket.endpoint.
- path - Connexion à l'hôte endpoint et ajout du bucket aux URIs.
default: host
example: --repo1-s3-uri-style=path
Vérifier le certificat du serveur S3.
Désactive la vérification du certificat du serveur S3. Cette fonction ne doit être utilisée que dans le cadre de tests ou dans le cas d'une utilisation avec un certificat a été auto-signé.
default: y
example: --no-repo1-s3-verify-tls
Nom obsolète: repo-s3-verify-ssl
Type de stockage utilisé pour le dépôt.
Les types de stockage suivants sont pris en charge :
- cifs - Comme posix, mais désactive les liens et les fsyncs sur les répertoires
- posix - Systèmes de fichiers conformes à Posix
- s3 - Service de stockage d'objet (AWS Simple Storage Service)
default: posix
example: --repo1-type=cifs
Similaire à la commande unix ls mais les options et la sortie sont différentes. Seules les informations fournies par les pilotes de stockage du référentiel sont disponibles : name (nom), type(type), size (taille), time (date de modification), et destination (destination sur les système prennent en charge les liens).
Filtrer la sortie avec une expression régulière.
Le filtre est appliqué sur les noms de fichiers/chemins d'accès avant l'affichage sur la sortie.
example: --filter=(F|D|I)$
Format de sortie.
Les types de sortie suivants sont pris en charge:
- text - Liste simple avec un nom de fichier/lien/chemin sur chaque ligne.
- json - Informations détaillées sur les fichier/lien/dossier au format JSON.
default: text
example: --output=json
Inclure tous les sous-chemins dans la sortie.
Tous les sous-chemins et leurs fichiers seront inclus dans le résultat.
default: n
example: --recurse
Trier la sortie par ordre croissant, décroissant ou aucun.
Les types de tri suivants sont pris en charge:
- asc - tri croissant.
- desc - tri décroissant.
- none - pas de tri.
default: asc
example: --sort=desc
Taille de la mémoire tampon pour les opérations sur les fichiers.
Définissez la taille de la mémoire tampon utilisée pour les opérations de copie, de compression et de décompression. Un maximum de 3 tampons seront utilisés à la fois par processus. Un maximum supplémentaire de 256K par processus peut être utilisé pour les tampons zlib.
La taille peut être saisie en octets (par défaut) ou en KB, MB, GB, TB, ou PB où le multiplicateur est une puissance de 1024. Par exemple, la valeur insensible à la casse 32k (ou 32KB) peut être utilisée au lieu de 32768.
Les valeurs autorisées, en octets, sont16384, 32768, 65536, 131072, 262144, 524288, 1048576, 2097152, 4194304, 8388608, et 16777216.
default: 1048576
example: --buffer-size=32K
Chemin d'accès à l'exécutable du client ssh.
Utilisez un client SSH spécifique lorsqu'une alternative est nécessaire ou lorsque l'exécutable ssh n'est pas dans $PATH.
default: ssh
example: --cmd-ssh=/usr/bin/ssh
Niveau de compression du réseau.
Définit le niveau de compression sur le réseau, lorsque compress-type=none et que la commande n'est pas exécutée sur le même hôte que le dépôt. La compression est utilisée pour réduire le trafic réseau mais peut être désactivée en définissant compress-level-network=0. Lorsque compress-type n'est pas égal à none, le paramètre compress-level-network est ignoré et compress-level est utilisé à la place de sorte que le fichier ne soit compressé qu'une seule fois. La compression SSH est toujours désactivée.
default: 3
allowed: 0-9
example: --compress-level-network=1
Fichier de configuration pgBackRest.
Utiliser cette option pour spécifier un fichier de configuration différent de celui par défaut.
default: /etc/pgbackrest/pgbackrest.conf
example: --config=/conf/pgbackrest/pgbackrest.conf
Emplacement des fichiers de configuration pgBackRest supplémentaires..
Les fichiers de configuration existant à l'emplacement spécifié avec l'extension .conf seront concaténés avec le fichier de configuration pgBackRest, ce qui donne un seul fichier de configuration.
default: /etc/pgbackrest/conf.d
example: --config-include-path=/conf/pgbackrest/conf.d
Emplacement du répertoire de racine de pgBackRest des fichiers de configuration.
Ce paramètre est utilisé pour écraser le chemin racine par défaut pour les options --config et --config-include-path à moins qu'elles ne soient explicitement définies sur la ligne de commande.
Par exemple, en utilisant uniquement --config-path=/conf/pgbackrest, la valeur par défaut de --config est /conf/pgbackrest/pgbackrest.conf et la valeur par défaut de --config-include-path est /conf/pgbackrest/conf.d.
default: /etc/pgbackrest
example: --config-path=/conf/pgbackrest
Délai d'attente des requêtes à la base de données.
Définit le délai d'attente, en secondes, pour les interrogations de la base de données. Cela inclut les fonctions
pg_start_backup() et
pg_stop_backup() qui peuvent chacune prendre un temps considérable. C'est pourquoi le délai d'attente doit être maintenu à un niveau élevé, sauf si vous savez que ces fonctions retourneront rapidement (c'est-à-dire si vous avez défini
startfast=y et que vous savez que l'instance de base de données ne générera pas beaucoup de segments WAL pendant la sauvegarde).
NOTE:
L'option db-timeout doit être inférieure à l'option protocol-timeout.
default: 1800
allowed: 0.1-604800
example: --db-timeout=600
Délai d'attente E/S.
Délai d'attente, en secondes, utilisé pour les connexions et les opérations de lecture/écriture.
Notez que l'ensemble de l'opération de lecture/écriture n'a pas besoin de se terminer dans ce délai mais une progression doit être constatée, même s'il ne s'agit que d'un seul octet.
default: 60
allowed: 0.1-3600
example: --io-timeout=120
Utilisation d'un umask
neutre
Définit l'umask à 0000 pour que les modes dans le dépôt de sauvegarde soient créés de manière appropriée. Le mode par défaut du répertoire est 0750 et le mode par défaut du fichier est 0640. Pour les répertoires lock et log, les modes de répertoire et de fichier sont respectivement fixés à 0770 et 0660.
Pour utiliser l'umask de l'utilisateur en cours d'exécution, spécifiez plutôt neutral-umask=n dans le fichier de configuration ou --no-neutral-umask sur la ligne de commande.
default: y
example: --no-neutral-umask
Délai d'attente du protocole.
Définit le délai, en secondes, durant lequel le processus local ou distant attendra qu'un nouveau message soit reçu au niveau de la couche protocole. Cela permet d'éviter que les processus n'attendent indéfiniment un message.
NOTE:
L'option protocol-timeout doit être supérieure à celle de db-timeout option.
default: 1830
allowed: 0.1-604800
example: --protocol-timeout=630
Activation de la fonction de keep-alive (maintien en vie).
Activation des messages de keep-alive (maintien en vie) sur les connexions réseaux.
default: y
example: --no-sck-keep-alive
Defines the stanza.
Un stanza est la configuration de la sauvegarde d'une instance PostgreSQL où est définit l'endroit où il se trouve, la façon dont il sera sauvegardé, les options d'archivage, etc... La plupart des serveurs de base de données n'auront qu'une seule instance PostgreSQL et donc un stanza alors que les serveurs de sauvegarde auront un stanza pour chaque instance de base de données qui doit être sauvegardé.
Il est tentant de nommer le stanza en référence à l'instance primaire, mais un meilleur nom décrirait les bases de données contenues dans l'instance : comme le nom du stanza sera utilisé pour le primaire et tous les secondaire, il est plus approprié de choisir un nom qui décrit la fonction réelle du groupe d'instances, comme app ou dw, plutôt que le nom local de l'instance, comme main ou prod.
example: --stanza=main
Compteur Keep-alive.
Spécifie le nombre de messages TCP à garder en mémoire qui peuvent être perdus avant que la connexion ne soit considérée comme morte.
Cette option n'est disponible que sur les systèmes qui prennent en charge l'option réseau TCP_KEEPCNT.
allowed: 1-32
example: --tcp-keep-alive-count=3
Temps d'inactivité du keepalive.
Spécifie la durée (en secondes) sans activité du réseau après laquelle le système d'exploitation doit envoyer un message TCP de maintien en activité (keep-alive).
Cette option n'est disponible que sur les systèmes qui prennent en charge l'option réseau TCP_KEEPIDLE.
allowed: 1-3600
example: --tcp-keep-alive-idle=60
Temps d'intervalle de maintien en vie (keep-alive).
Spécifie le temps (en secondes) après lequel un message TCP de maintien en activité (keep-alive) non acquitté doit être retransmis.
Cette option n'est disponible que sur les systèmes qui prennent en charge l'option réseau TCP_KEEPINTVL.
allowed: 1-900
example: --tcp-keep-alive-interval=30
Niveau de journalisation en sortie sur la console.
Les niveaux de traces suivants sont pris en charge:
- off - Pas de journal de traces (non recommandé)
- error - Journaliser uniquement les erreurs
- warn - Journaliser les avertissements et les erreurs
- info - Journaliser les messages d'information, les avertissements et les erreurs
- detail - Journaliser les détails, les messages d'information, les avertissements et les erreurs
- debug - Journaliser les message de Débogage, les détails, les messages d'information, les avertissements et les erreurs
- trace - Journaliser les traces (un débogage très verbeux), les message de Débogage, les détails, les messages d'information, les avertissements et les erreurs
default: warn
example: --log-level-console=error
Niveau d'enregistrement des traces lors de l'enregistrement sur fichier.
Les niveaux de traces suivants sont pris en charge:
- off - Pas de journal de traces (non recommandé)
- error - Journaliser uniquement les erreurs
- warn - Journaliser les avertissements et les erreurs
- info - Journaliser les messages d'information, les avertissements et les erreurs
- detail - Journaliser les détails, les messages d'information, les avertissements et les erreurs
- debug - Journaliser les message de Débogage, les détails, les messages d'information, les avertissements et les erreurs
- trace - Journaliser les traces (un débogage très verbeux), les message de Débogage, les détails, les messages d'information, les avertissements et les erreurs
default: info
example: --log-level-file=debug
Niveau de traces sur la sortie console stderr.
Spécifie les niveaux de traces qui sortiront en
stderr plutôt que
stdout (spécifié par
log-level-console). L'horodatage et le processus ne seront pas émis sur
stderr.
Les niveaux de traces suivants sont pris en charge:
- off - Pas de journal de traces (non recommandé)
- error - Journaliser uniquement les erreurs
- warn - Journaliser les avertissements et les erreurs
- info - Journaliser les messages d'information, les avertissements et les erreurs
- detail - Journaliser les détails, les messages d'information, les avertissements et les erreurs
- debug - Journaliser les message de Débogage, les détails, les messages d'information, les avertissements et les erreurs
- trace - Journaliser les traces (un débogage très verbeux), les message de Débogage, les détails, les messages d'information, les avertissements et les erreurs
default: warn
example: --log-level-stderr=error
Emplacement où les fichiers journaux de traces sont stockés.
Le chemin d'accès au journal fournit un emplacement pour pgBackRest pour stocker les fichiers journaux. Notez que si log-level-file=off alors aucun chemin pour l'emplacement des journaux de traces n'est nécessaire.
default: /var/log/pgbackrest
example: --log-path=/backup/db/log
Activer la journalisation des traces dans les sous-processus.
Activez la journalisation des traces dans les fichiers pour tous les sous-processus créés par ce processus en utilisant le niveau de journalisation spécifié par log-level-file.
default: n
example: --log-subprocess
Activer l'horodatage dans les traces.
Active l'horodatage dans la console et l'enregistrement des fichiers. Cette option est désactivée dans des situations particulières telles que la génération de documentation.
default: y
example: --no-log-timestamp
Chiffrement (cipher) utilisé pour chiffrer le dépôt.
Les types de chiffrement suivants sont pris en charge:
- none - Le dépôt n'est pas chiffré.
- aes-256-cbc - Advanced Encryption Standard avec une clef de 256 bit
À noter que le chiffrement est toujours effectué côté client même si le type de stockage (par exemple S3) supporte le chiffrement.
default: none
example: --repo1-cipher-type=aes-256-cbc
Hôte de dépôt dans le cas d'un fonctionnement à distance via SSH.
Assurez-vous que l'authentification SSH soit correctement approuvé entre l'hôte PostgreSQL et l'hôte du référentiel.
Ce paramètre n'est pas nécessaire pour la sauvegarde et l'archivage sur un système de fichiers monté localement.
example: --repo1-host=repo1.domain.com
Nom obsolète: backup-host
Chemin des binaires pgBackRest sur l'hôte du dépôt.
Nécessaire uniquement si le chemin d'accès à pgbackrest est différent entre les hôtes locaux et l'hote du dépôt. S'il n'est pas défini, le chemin des binaires sur l'hôte du dépôt sera le même que le chemin des binaires locaux.
example: --repo1-host-cmd=/usr/lib/backrest/bin/pgbackrest
Nom obsolète: backup-cmd
Emplacement du fichier de configuration pgBackRest sur l'hôte du dépôt.
Définit l'emplacement du fichier de configuration sur l'hôte du dépôt. Ceci n'est nécessaire que si le fichier de configuration de l'hôte du dépôt se trouve dans un emplacement différent de celui du fichier de configuration local.
default: /etc/pgbackrest/pgbackrest.conf
example: --repo1-host-config=/conf/pgbackrest/pgbackrest.conf
Nom obsolète: backup-config
Chemin d'inclusion pgBackRest de la configuration de l'hôte du dépôt.
Définit l'emplacement du chemin d'inclusion de la configuration sur l'hôte du dépôt. Ceci n'est nécessaire que si le chemin d'inclusion de la configuration de l'hôte du dépôt se trouve à un endroit différent du chemin d'inclusion de la configuration locale.
default: /etc/pgbackrest/conf.d
example: --repo1-host-config-include-path=/conf/pgbackrest/conf.d
Chemin de configuration pgBackRest de l'hôte du dépôt.
Définit l'emplacement du chemin de configuration sur l'hôte du dépôt. Ceci n'est nécessaire que si le chemin de configuration de l'hôte du référentiel se trouve à un endroit différent du chemin de configuration local.
default: /etc/pgbackrest
example: --repo1-host-config-path=/conf/pgbackrest
Port de l'hôte du dépôt lorsque repo-host est défini.
Utilisez cette option pour spécifier un port non par défaut pour le protocole d'accès à l'hôte du dépôt. Actuellement, seul SSH est pris en charge
allowed: 0-65535
example: --repo1-host-port=25
Nom obsolète: backup-ssh-port
Utilisateur de l'hôte du dépôt lorsque repo-host est défini.
Définit l'utilisateur qui sera utilisé pour les opérations sur l'hôte du dépôt. De préférence, il ne s'agit pas de l'utilisateur postgres mais plutôt d'un autre utilisateur comme pgbackrest. Si PostgreSQL fonctionne sur l'hôte du dépôt, l'utilisateur postgres peut être placé dans le groupe pgbackrest afin qu'il ait les autorisations de lecture sur le dépôt sans pouvoir en endommager le contenu accidentellement.
default: pgbackrest
example: --repo1-host-user=repo-user
Nom obsolète: backup-user
Chemin d'accès où sont stockées les sauvegardes et les archives.
Le dépôt est l'endroit où pgBackRest stocke les sauvegardes et archive les segments des journaux de transaction (WAL).
Il peut être difficile d'estimer à l'avance l'espace dont vous aurez besoin. La meilleure chose à faire est de prendre quelques sauvegardes puis d'enregistrer la taille des différents types de sauvegardes (full/incr/diff) et de mesurer la quantité de WAL générée par jour. Cela vous donnera une idée générale de l'espace dont vous aurez besoin, même si, bien sûr, les besoins changeront probablement au fil du temps, à fur et à mesure de l'évolution de votre base de données.
default: /var/lib/pgbackrest
example: --repo1-path=/backup/db/backrest
S3 dépôt bucket.
Bucket S3 utilisé pour stocker le dépôt.
Les dépots pgBackRest peuvent être stockés à la racine du bucket en définissant repo-path=/ mais il est généralement préférable de spécifier un préfixe, comme par exemple /repo, afin que les logs et autres contenus générés par AWS puissent également être stockés dans le bucket.
example: --repo1-s3-bucket=pg-backup
Ficher SSL CA S3.
Utiliser un fichier CA autre que celui défini par défaut dans le système.
example: --repo1-s3-ca-file=/etc/pki/tls/certs/ca-bundle.crt
Chemin S3 SSL CA.
Utiliser un chemin pour le CA autre que celui défini par défaut dans le système.
example: --repo1-s3-ca-path=/etc/pki/tls/certs
Dépot S3 Point de terminaison (endpoint).
Le point de terminaison d'AWS doit être valable pour la région sélectionnée.
example: --repo1-s3-endpoint=s3.amazonaws.com
Hôte du dépot S3.
Conntecter sur un hôte différent du point de terminaison (endpoint). Il est généralement utilisé à des fins de test.
example: --repo1-s3-host=127.0.0.1
Port de connection au dépot S3.
Port à utiliser lors de la connexion au point de terminaison (ou à l'hôte si spécifié).
default: 443
allowed: 1-65535
example: --repo1-s3-port=9000
Région du dépôt S3.
La région d'AWS où le bucket a été créé.
example: --repo1-s3-region=us-east-1
S3 URI formats.
Les formats URI suivants sont pris en charge:
- host - Connexion à l'hôte bucket.endpoint.
- path - Connexion à l'hôte endpoint et ajout du bucket aux URIs.
default: host
example: --repo1-s3-uri-style=path
Vérifier le certificat du serveur S3.
Désactive la vérification du certificat du serveur S3. Cette fonction ne doit être utilisée que dans le cadre de tests ou dans le cas d'une utilisation avec un certificat a été auto-signé.
default: y
example: --no-repo1-s3-verify-tls
Nom obsolète: repo-s3-verify-ssl
Type de stockage utilisé pour le dépôt.
Les types de stockage suivants sont pris en charge :
- cifs - Comme posix, mais désactive les liens et les fsyncs sur les répertoires
- posix - Systèmes de fichiers conformes à Posix
- s3 - Service de stockage d'objet (AWS Simple Storage Service)
default: posix
example: --repo1-type=cifs
Similaire à la commande unix tee mais avec des options différentes.
POUR UN USAGE INTERNE UNIQUEMENT. NE PAS UTILISER EN PRODUCTION.
Taille de la mémoire tampon pour les opérations sur les fichiers.
Définissez la taille de la mémoire tampon utilisée pour les opérations de copie, de compression et de décompression. Un maximum de 3 tampons seront utilisés à la fois par processus. Un maximum supplémentaire de 256K par processus peut être utilisé pour les tampons zlib.
La taille peut être saisie en octets (par défaut) ou en KB, MB, GB, TB, ou PB où le multiplicateur est une puissance de 1024. Par exemple, la valeur insensible à la casse 32k (ou 32KB) peut être utilisée au lieu de 32768.
Les valeurs autorisées, en octets, sont16384, 32768, 65536, 131072, 262144, 524288, 1048576, 2097152, 4194304, 8388608, et 16777216.
default: 1048576
example: --buffer-size=32K
Chemin d'accès à l'exécutable du client ssh.
Utilisez un client SSH spécifique lorsqu'une alternative est nécessaire ou lorsque l'exécutable ssh n'est pas dans $PATH.
default: ssh
example: --cmd-ssh=/usr/bin/ssh
Niveau de compression du réseau.
Définit le niveau de compression sur le réseau, lorsque compress-type=none et que la commande n'est pas exécutée sur le même hôte que le dépôt. La compression est utilisée pour réduire le trafic réseau mais peut être désactivée en définissant compress-level-network=0. Lorsque compress-type n'est pas égal à none, le paramètre compress-level-network est ignoré et compress-level est utilisé à la place de sorte que le fichier ne soit compressé qu'une seule fois. La compression SSH est toujours désactivée.
default: 3
allowed: 0-9
example: --compress-level-network=1
Fichier de configuration pgBackRest.
Utiliser cette option pour spécifier un fichier de configuration différent de celui par défaut.
default: /etc/pgbackrest/pgbackrest.conf
example: --config=/conf/pgbackrest/pgbackrest.conf
Emplacement des fichiers de configuration pgBackRest supplémentaires..
Les fichiers de configuration existant à l'emplacement spécifié avec l'extension .conf seront concaténés avec le fichier de configuration pgBackRest, ce qui donne un seul fichier de configuration.
default: /etc/pgbackrest/conf.d
example: --config-include-path=/conf/pgbackrest/conf.d
Emplacement du répertoire de racine de pgBackRest des fichiers de configuration.
Ce paramètre est utilisé pour écraser le chemin racine par défaut pour les options --config et --config-include-path à moins qu'elles ne soient explicitement définies sur la ligne de commande.
Par exemple, en utilisant uniquement --config-path=/conf/pgbackrest, la valeur par défaut de --config est /conf/pgbackrest/pgbackrest.conf et la valeur par défaut de --config-include-path est /conf/pgbackrest/conf.d.
default: /etc/pgbackrest
example: --config-path=/conf/pgbackrest
Délai d'attente des requêtes à la base de données.
Définit le délai d'attente, en secondes, pour les interrogations de la base de données. Cela inclut les fonctions
pg_start_backup() et
pg_stop_backup() qui peuvent chacune prendre un temps considérable. C'est pourquoi le délai d'attente doit être maintenu à un niveau élevé, sauf si vous savez que ces fonctions retourneront rapidement (c'est-à-dire si vous avez défini
startfast=y et que vous savez que l'instance de base de données ne générera pas beaucoup de segments WAL pendant la sauvegarde).
NOTE:
L'option db-timeout doit être inférieure à l'option protocol-timeout.
default: 1800
allowed: 0.1-604800
example: --db-timeout=600
Délai d'attente E/S.
Délai d'attente, en secondes, utilisé pour les connexions et les opérations de lecture/écriture.
Notez que l'ensemble de l'opération de lecture/écriture n'a pas besoin de se terminer dans ce délai mais une progression doit être constatée, même s'il ne s'agit que d'un seul octet.
default: 60
allowed: 0.1-3600
example: --io-timeout=120
Utilisation d'un umask
neutre
Définit l'umask à 0000 pour que les modes dans le dépôt de sauvegarde soient créés de manière appropriée. Le mode par défaut du répertoire est 0750 et le mode par défaut du fichier est 0640. Pour les répertoires lock et log, les modes de répertoire et de fichier sont respectivement fixés à 0770 et 0660.
Pour utiliser l'umask de l'utilisateur en cours d'exécution, spécifiez plutôt neutral-umask=n dans le fichier de configuration ou --no-neutral-umask sur la ligne de commande.
default: y
example: --no-neutral-umask
Délai d'attente du protocole.
Définit le délai, en secondes, durant lequel le processus local ou distant attendra qu'un nouveau message soit reçu au niveau de la couche protocole. Cela permet d'éviter que les processus n'attendent indéfiniment un message.
NOTE:
L'option protocol-timeout doit être supérieure à celle de db-timeout option.
default: 1830
allowed: 0.1-604800
example: --protocol-timeout=630
Ne pas transformer les données.
Ne pas transformer (c'est-à-dire crypter, décompresser, etc.) les données pour la commande en cours.
default: n
example: --raw
Activation de la fonction de keep-alive (maintien en vie).
Activation des messages de keep-alive (maintien en vie) sur les connexions réseaux.
default: y
example: --no-sck-keep-alive
Defines the stanza.
Un stanza est la configuration de la sauvegarde d'une instance PostgreSQL où est définit l'endroit où il se trouve, la façon dont il sera sauvegardé, les options d'archivage, etc... La plupart des serveurs de base de données n'auront qu'une seule instance PostgreSQL et donc un stanza alors que les serveurs de sauvegarde auront un stanza pour chaque instance de base de données qui doit être sauvegardé.
Il est tentant de nommer le stanza en référence à l'instance primaire, mais un meilleur nom décrirait les bases de données contenues dans l'instance : comme le nom du stanza sera utilisé pour le primaire et tous les secondaire, il est plus approprié de choisir un nom qui décrit la fonction réelle du groupe d'instances, comme app ou dw, plutôt que le nom local de l'instance, comme main ou prod.
example: --stanza=main
Compteur Keep-alive.
Spécifie le nombre de messages TCP à garder en mémoire qui peuvent être perdus avant que la connexion ne soit considérée comme morte.
Cette option n'est disponible que sur les systèmes qui prennent en charge l'option réseau TCP_KEEPCNT.
allowed: 1-32
example: --tcp-keep-alive-count=3
Temps d'inactivité du keepalive.
Spécifie la durée (en secondes) sans activité du réseau après laquelle le système d'exploitation doit envoyer un message TCP de maintien en activité (keep-alive).
Cette option n'est disponible que sur les systèmes qui prennent en charge l'option réseau TCP_KEEPIDLE.
allowed: 1-3600
example: --tcp-keep-alive-idle=60
Temps d'intervalle de maintien en vie (keep-alive).
Spécifie le temps (en secondes) après lequel un message TCP de maintien en activité (keep-alive) non acquitté doit être retransmis.
Cette option n'est disponible que sur les systèmes qui prennent en charge l'option réseau TCP_KEEPINTVL.
allowed: 1-900
example: --tcp-keep-alive-interval=30
Niveau de journalisation en sortie sur la console.
Les niveaux de traces suivants sont pris en charge:
- off - Pas de journal de traces (non recommandé)
- error - Journaliser uniquement les erreurs
- warn - Journaliser les avertissements et les erreurs
- info - Journaliser les messages d'information, les avertissements et les erreurs
- detail - Journaliser les détails, les messages d'information, les avertissements et les erreurs
- debug - Journaliser les message de Débogage, les détails, les messages d'information, les avertissements et les erreurs
- trace - Journaliser les traces (un débogage très verbeux), les message de Débogage, les détails, les messages d'information, les avertissements et les erreurs
default: warn
example: --log-level-console=error
Niveau d'enregistrement des traces lors de l'enregistrement sur fichier.
Les niveaux de traces suivants sont pris en charge:
- off - Pas de journal de traces (non recommandé)
- error - Journaliser uniquement les erreurs
- warn - Journaliser les avertissements et les erreurs
- info - Journaliser les messages d'information, les avertissements et les erreurs
- detail - Journaliser les détails, les messages d'information, les avertissements et les erreurs
- debug - Journaliser les message de Débogage, les détails, les messages d'information, les avertissements et les erreurs
- trace - Journaliser les traces (un débogage très verbeux), les message de Débogage, les détails, les messages d'information, les avertissements et les erreurs
default: info
example: --log-level-file=debug
Niveau de traces sur la sortie console stderr.
Spécifie les niveaux de traces qui sortiront en
stderr plutôt que
stdout (spécifié par
log-level-console). L'horodatage et le processus ne seront pas émis sur
stderr.
Les niveaux de traces suivants sont pris en charge:
- off - Pas de journal de traces (non recommandé)
- error - Journaliser uniquement les erreurs
- warn - Journaliser les avertissements et les erreurs
- info - Journaliser les messages d'information, les avertissements et les erreurs
- detail - Journaliser les détails, les messages d'information, les avertissements et les erreurs
- debug - Journaliser les message de Débogage, les détails, les messages d'information, les avertissements et les erreurs
- trace - Journaliser les traces (un débogage très verbeux), les message de Débogage, les détails, les messages d'information, les avertissements et les erreurs
default: warn
example: --log-level-stderr=error
Emplacement où les fichiers journaux de traces sont stockés.
Le chemin d'accès au journal fournit un emplacement pour pgBackRest pour stocker les fichiers journaux. Notez que si log-level-file=off alors aucun chemin pour l'emplacement des journaux de traces n'est nécessaire.
default: /var/log/pgbackrest
example: --log-path=/backup/db/log
Activer la journalisation des traces dans les sous-processus.
Activez la journalisation des traces dans les fichiers pour tous les sous-processus créés par ce processus en utilisant le niveau de journalisation spécifié par log-level-file.
default: n
example: --log-subprocess
Activer l'horodatage dans les traces.
Active l'horodatage dans la console et l'enregistrement des fichiers. Cette option est désactivée dans des situations particulières telles que la génération de documentation.
default: y
example: --no-log-timestamp
Chiffrement (cipher) utilisé pour chiffrer le dépôt.
Les types de chiffrement suivants sont pris en charge:
- none - Le dépôt n'est pas chiffré.
- aes-256-cbc - Advanced Encryption Standard avec une clef de 256 bit
À noter que le chiffrement est toujours effectué côté client même si le type de stockage (par exemple S3) supporte le chiffrement.
default: none
example: --repo1-cipher-type=aes-256-cbc
Hôte de dépôt dans le cas d'un fonctionnement à distance via SSH.
Assurez-vous que l'authentification SSH soit correctement approuvé entre l'hôte PostgreSQL et l'hôte du référentiel.
Ce paramètre n'est pas nécessaire pour la sauvegarde et l'archivage sur un système de fichiers monté localement.
example: --repo1-host=repo1.domain.com
Nom obsolète: backup-host
Chemin des binaires pgBackRest sur l'hôte du dépôt.
Nécessaire uniquement si le chemin d'accès à pgbackrest est différent entre les hôtes locaux et l'hote du dépôt. S'il n'est pas défini, le chemin des binaires sur l'hôte du dépôt sera le même que le chemin des binaires locaux.
example: --repo1-host-cmd=/usr/lib/backrest/bin/pgbackrest
Nom obsolète: backup-cmd
Emplacement du fichier de configuration pgBackRest sur l'hôte du dépôt.
Définit l'emplacement du fichier de configuration sur l'hôte du dépôt. Ceci n'est nécessaire que si le fichier de configuration de l'hôte du dépôt se trouve dans un emplacement différent de celui du fichier de configuration local.
default: /etc/pgbackrest/pgbackrest.conf
example: --repo1-host-config=/conf/pgbackrest/pgbackrest.conf
Nom obsolète: backup-config
Chemin d'inclusion pgBackRest de la configuration de l'hôte du dépôt.
Définit l'emplacement du chemin d'inclusion de la configuration sur l'hôte du dépôt. Ceci n'est nécessaire que si le chemin d'inclusion de la configuration de l'hôte du dépôt se trouve à un endroit différent du chemin d'inclusion de la configuration locale.
default: /etc/pgbackrest/conf.d
example: --repo1-host-config-include-path=/conf/pgbackrest/conf.d
Chemin de configuration pgBackRest de l'hôte du dépôt.
Définit l'emplacement du chemin de configuration sur l'hôte du dépôt. Ceci n'est nécessaire que si le chemin de configuration de l'hôte du référentiel se trouve à un endroit différent du chemin de configuration local.
default: /etc/pgbackrest
example: --repo1-host-config-path=/conf/pgbackrest
Port de l'hôte du dépôt lorsque repo-host est défini.
Utilisez cette option pour spécifier un port non par défaut pour le protocole d'accès à l'hôte du dépôt. Actuellement, seul SSH est pris en charge
allowed: 0-65535
example: --repo1-host-port=25
Nom obsolète: backup-ssh-port
Utilisateur de l'hôte du dépôt lorsque repo-host est défini.
Définit l'utilisateur qui sera utilisé pour les opérations sur l'hôte du dépôt. De préférence, il ne s'agit pas de l'utilisateur postgres mais plutôt d'un autre utilisateur comme pgbackrest. Si PostgreSQL fonctionne sur l'hôte du dépôt, l'utilisateur postgres peut être placé dans le groupe pgbackrest afin qu'il ait les autorisations de lecture sur le dépôt sans pouvoir en endommager le contenu accidentellement.
default: pgbackrest
example: --repo1-host-user=repo-user
Nom obsolète: backup-user
Chemin d'accès où sont stockées les sauvegardes et les archives.
Le dépôt est l'endroit où pgBackRest stocke les sauvegardes et archive les segments des journaux de transaction (WAL).
Il peut être difficile d'estimer à l'avance l'espace dont vous aurez besoin. La meilleure chose à faire est de prendre quelques sauvegardes puis d'enregistrer la taille des différents types de sauvegardes (full/incr/diff) et de mesurer la quantité de WAL générée par jour. Cela vous donnera une idée générale de l'espace dont vous aurez besoin, même si, bien sûr, les besoins changeront probablement au fil du temps, à fur et à mesure de l'évolution de votre base de données.
default: /var/lib/pgbackrest
example: --repo1-path=/backup/db/backrest
S3 dépôt bucket.
Bucket S3 utilisé pour stocker le dépôt.
Les dépots pgBackRest peuvent être stockés à la racine du bucket en définissant repo-path=/ mais il est généralement préférable de spécifier un préfixe, comme par exemple /repo, afin que les logs et autres contenus générés par AWS puissent également être stockés dans le bucket.
example: --repo1-s3-bucket=pg-backup
Ficher SSL CA S3.
Utiliser un fichier CA autre que celui défini par défaut dans le système.
example: --repo1-s3-ca-file=/etc/pki/tls/certs/ca-bundle.crt
Chemin S3 SSL CA.
Utiliser un chemin pour le CA autre que celui défini par défaut dans le système.
example: --repo1-s3-ca-path=/etc/pki/tls/certs
Dépot S3 Point de terminaison (endpoint).
Le point de terminaison d'AWS doit être valable pour la région sélectionnée.
example: --repo1-s3-endpoint=s3.amazonaws.com
Hôte du dépot S3.
Conntecter sur un hôte différent du point de terminaison (endpoint). Il est généralement utilisé à des fins de test.
example: --repo1-s3-host=127.0.0.1
Port de connection au dépot S3.
Port à utiliser lors de la connexion au point de terminaison (ou à l'hôte si spécifié).
default: 443
allowed: 1-65535
example: --repo1-s3-port=9000
Région du dépôt S3.
La région d'AWS où le bucket a été créé.
example: --repo1-s3-region=us-east-1
S3 URI formats.
Les formats URI suivants sont pris en charge:
- host - Connexion à l'hôte bucket.endpoint.
- path - Connexion à l'hôte endpoint et ajout du bucket aux URIs.
default: host
example: --repo1-s3-uri-style=path
Vérifier le certificat du serveur S3.
Désactive la vérification du certificat du serveur S3. Cette fonction ne doit être utilisée que dans le cadre de tests ou dans le cas d'une utilisation avec un certificat a été auto-signé.
default: y
example: --no-repo1-s3-verify-tls
Nom obsolète: repo-s3-verify-ssl
Type de stockage utilisé pour le dépôt.
Les types de stockage suivants sont pris en charge :
- cifs - Comme posix, mais désactive les liens et les fsyncs sur les répertoires
- posix - Systèmes de fichiers conformes à Posix
- s3 - Service de stockage d'objet (AWS Simple Storage Service)
default: posix
example: --repo1-type=cifs
Similaire à la commande unix rm mais avec des options différentes.
POUR UN USAGE INTERNE UNIQUEMENT. NE PAS UTILISER EN PRODUCTION.
Supprimer tous les sous-fichiers/répertoire
Tous les sous-chemins et leurs fichiers seront supprimés.
default: n
example: --recurse
Taille de la mémoire tampon pour les opérations sur les fichiers.
Définissez la taille de la mémoire tampon utilisée pour les opérations de copie, de compression et de décompression. Un maximum de 3 tampons seront utilisés à la fois par processus. Un maximum supplémentaire de 256K par processus peut être utilisé pour les tampons zlib.
La taille peut être saisie en octets (par défaut) ou en KB, MB, GB, TB, ou PB où le multiplicateur est une puissance de 1024. Par exemple, la valeur insensible à la casse 32k (ou 32KB) peut être utilisée au lieu de 32768.
Les valeurs autorisées, en octets, sont16384, 32768, 65536, 131072, 262144, 524288, 1048576, 2097152, 4194304, 8388608, et 16777216.
default: 1048576
example: --buffer-size=32K
Chemin d'accès à l'exécutable du client ssh.
Utilisez un client SSH spécifique lorsqu'une alternative est nécessaire ou lorsque l'exécutable ssh n'est pas dans $PATH.
default: ssh
example: --cmd-ssh=/usr/bin/ssh
Fichier de configuration pgBackRest.
Utiliser cette option pour spécifier un fichier de configuration différent de celui par défaut.
default: /etc/pgbackrest/pgbackrest.conf
example: --config=/conf/pgbackrest/pgbackrest.conf
Emplacement des fichiers de configuration pgBackRest supplémentaires..
Les fichiers de configuration existant à l'emplacement spécifié avec l'extension .conf seront concaténés avec le fichier de configuration pgBackRest, ce qui donne un seul fichier de configuration.
default: /etc/pgbackrest/conf.d
example: --config-include-path=/conf/pgbackrest/conf.d
Emplacement du répertoire de racine de pgBackRest des fichiers de configuration.
Ce paramètre est utilisé pour écraser le chemin racine par défaut pour les options --config et --config-include-path à moins qu'elles ne soient explicitement définies sur la ligne de commande.
Par exemple, en utilisant uniquement --config-path=/conf/pgbackrest, la valeur par défaut de --config est /conf/pgbackrest/pgbackrest.conf et la valeur par défaut de --config-include-path est /conf/pgbackrest/conf.d.
default: /etc/pgbackrest
example: --config-path=/conf/pgbackrest
Délai d'attente des requêtes à la base de données.
Définit le délai d'attente, en secondes, pour les interrogations de la base de données. Cela inclut les fonctions
pg_start_backup() et
pg_stop_backup() qui peuvent chacune prendre un temps considérable. C'est pourquoi le délai d'attente doit être maintenu à un niveau élevé, sauf si vous savez que ces fonctions retourneront rapidement (c'est-à-dire si vous avez défini
startfast=y et que vous savez que l'instance de base de données ne générera pas beaucoup de segments WAL pendant la sauvegarde).
NOTE:
L'option db-timeout doit être inférieure à l'option protocol-timeout.
default: 1800
allowed: 0.1-604800
example: --db-timeout=600
Délai d'attente E/S.
Délai d'attente, en secondes, utilisé pour les connexions et les opérations de lecture/écriture.
Notez que l'ensemble de l'opération de lecture/écriture n'a pas besoin de se terminer dans ce délai mais une progression doit être constatée, même s'il ne s'agit que d'un seul octet.
default: 60
allowed: 0.1-3600
example: --io-timeout=120
Utilisation d'un umask
neutre
Définit l'umask à 0000 pour que les modes dans le dépôt de sauvegarde soient créés de manière appropriée. Le mode par défaut du répertoire est 0750 et le mode par défaut du fichier est 0640. Pour les répertoires lock et log, les modes de répertoire et de fichier sont respectivement fixés à 0770 et 0660.
Pour utiliser l'umask de l'utilisateur en cours d'exécution, spécifiez plutôt neutral-umask=n dans le fichier de configuration ou --no-neutral-umask sur la ligne de commande.
default: y
example: --no-neutral-umask
Délai d'attente du protocole.
Définit le délai, en secondes, durant lequel le processus local ou distant attendra qu'un nouveau message soit reçu au niveau de la couche protocole. Cela permet d'éviter que les processus n'attendent indéfiniment un message.
NOTE:
L'option protocol-timeout doit être supérieure à celle de db-timeout option.
default: 1830
allowed: 0.1-604800
example: --protocol-timeout=630
Activation de la fonction de keep-alive (maintien en vie).
Activation des messages de keep-alive (maintien en vie) sur les connexions réseaux.
default: y
example: --no-sck-keep-alive
Defines the stanza.
Un stanza est la configuration de la sauvegarde d'une instance PostgreSQL où est définit l'endroit où il se trouve, la façon dont il sera sauvegardé, les options d'archivage, etc... La plupart des serveurs de base de données n'auront qu'une seule instance PostgreSQL et donc un stanza alors que les serveurs de sauvegarde auront un stanza pour chaque instance de base de données qui doit être sauvegardé.
Il est tentant de nommer le stanza en référence à l'instance primaire, mais un meilleur nom décrirait les bases de données contenues dans l'instance : comme le nom du stanza sera utilisé pour le primaire et tous les secondaire, il est plus approprié de choisir un nom qui décrit la fonction réelle du groupe d'instances, comme app ou dw, plutôt que le nom local de l'instance, comme main ou prod.
example: --stanza=main
Compteur Keep-alive.
Spécifie le nombre de messages TCP à garder en mémoire qui peuvent être perdus avant que la connexion ne soit considérée comme morte.
Cette option n'est disponible que sur les systèmes qui prennent en charge l'option réseau TCP_KEEPCNT.
allowed: 1-32
example: --tcp-keep-alive-count=3
Temps d'inactivité du keepalive.
Spécifie la durée (en secondes) sans activité du réseau après laquelle le système d'exploitation doit envoyer un message TCP de maintien en activité (keep-alive).
Cette option n'est disponible que sur les systèmes qui prennent en charge l'option réseau TCP_KEEPIDLE.
allowed: 1-3600
example: --tcp-keep-alive-idle=60
Temps d'intervalle de maintien en vie (keep-alive).
Spécifie le temps (en secondes) après lequel un message TCP de maintien en activité (keep-alive) non acquitté doit être retransmis.
Cette option n'est disponible que sur les systèmes qui prennent en charge l'option réseau TCP_KEEPINTVL.
allowed: 1-900
example: --tcp-keep-alive-interval=30
Niveau de journalisation en sortie sur la console.
Les niveaux de traces suivants sont pris en charge:
- off - Pas de journal de traces (non recommandé)
- error - Journaliser uniquement les erreurs
- warn - Journaliser les avertissements et les erreurs
- info - Journaliser les messages d'information, les avertissements et les erreurs
- detail - Journaliser les détails, les messages d'information, les avertissements et les erreurs
- debug - Journaliser les message de Débogage, les détails, les messages d'information, les avertissements et les erreurs
- trace - Journaliser les traces (un débogage très verbeux), les message de Débogage, les détails, les messages d'information, les avertissements et les erreurs
default: warn
example: --log-level-console=error
Niveau d'enregistrement des traces lors de l'enregistrement sur fichier.
Les niveaux de traces suivants sont pris en charge:
- off - Pas de journal de traces (non recommandé)
- error - Journaliser uniquement les erreurs
- warn - Journaliser les avertissements et les erreurs
- info - Journaliser les messages d'information, les avertissements et les erreurs
- detail - Journaliser les détails, les messages d'information, les avertissements et les erreurs
- debug - Journaliser les message de Débogage, les détails, les messages d'information, les avertissements et les erreurs
- trace - Journaliser les traces (un débogage très verbeux), les message de Débogage, les détails, les messages d'information, les avertissements et les erreurs
default: info
example: --log-level-file=debug
Niveau de traces sur la sortie console stderr.
Spécifie les niveaux de traces qui sortiront en
stderr plutôt que
stdout (spécifié par
log-level-console). L'horodatage et le processus ne seront pas émis sur
stderr.
Les niveaux de traces suivants sont pris en charge:
- off - Pas de journal de traces (non recommandé)
- error - Journaliser uniquement les erreurs
- warn - Journaliser les avertissements et les erreurs
- info - Journaliser les messages d'information, les avertissements et les erreurs
- detail - Journaliser les détails, les messages d'information, les avertissements et les erreurs
- debug - Journaliser les message de Débogage, les détails, les messages d'information, les avertissements et les erreurs
- trace - Journaliser les traces (un débogage très verbeux), les message de Débogage, les détails, les messages d'information, les avertissements et les erreurs
default: warn
example: --log-level-stderr=error
Emplacement où les fichiers journaux de traces sont stockés.
Le chemin d'accès au journal fournit un emplacement pour pgBackRest pour stocker les fichiers journaux. Notez que si log-level-file=off alors aucun chemin pour l'emplacement des journaux de traces n'est nécessaire.
default: /var/log/pgbackrest
example: --log-path=/backup/db/log
Activer la journalisation des traces dans les sous-processus.
Activez la journalisation des traces dans les fichiers pour tous les sous-processus créés par ce processus en utilisant le niveau de journalisation spécifié par log-level-file.
default: n
example: --log-subprocess
Activer l'horodatage dans les traces.
Active l'horodatage dans la console et l'enregistrement des fichiers. Cette option est désactivée dans des situations particulières telles que la génération de documentation.
default: y
example: --no-log-timestamp
Chiffrement (cipher) utilisé pour chiffrer le dépôt.
Les types de chiffrement suivants sont pris en charge:
- none - Le dépôt n'est pas chiffré.
- aes-256-cbc - Advanced Encryption Standard avec une clef de 256 bit
À noter que le chiffrement est toujours effectué côté client même si le type de stockage (par exemple S3) supporte le chiffrement.
default: none
example: --repo1-cipher-type=aes-256-cbc
Hôte de dépôt dans le cas d'un fonctionnement à distance via SSH.
Assurez-vous que l'authentification SSH soit correctement approuvé entre l'hôte PostgreSQL et l'hôte du référentiel.
Ce paramètre n'est pas nécessaire pour la sauvegarde et l'archivage sur un système de fichiers monté localement.
example: --repo1-host=repo1.domain.com
Nom obsolète: backup-host
Chemin des binaires pgBackRest sur l'hôte du dépôt.
Nécessaire uniquement si le chemin d'accès à pgbackrest est différent entre les hôtes locaux et l'hote du dépôt. S'il n'est pas défini, le chemin des binaires sur l'hôte du dépôt sera le même que le chemin des binaires locaux.
example: --repo1-host-cmd=/usr/lib/backrest/bin/pgbackrest
Nom obsolète: backup-cmd
Emplacement du fichier de configuration pgBackRest sur l'hôte du dépôt.
Définit l'emplacement du fichier de configuration sur l'hôte du dépôt. Ceci n'est nécessaire que si le fichier de configuration de l'hôte du dépôt se trouve dans un emplacement différent de celui du fichier de configuration local.
default: /etc/pgbackrest/pgbackrest.conf
example: --repo1-host-config=/conf/pgbackrest/pgbackrest.conf
Nom obsolète: backup-config
Chemin d'inclusion pgBackRest de la configuration de l'hôte du dépôt.
Définit l'emplacement du chemin d'inclusion de la configuration sur l'hôte du dépôt. Ceci n'est nécessaire que si le chemin d'inclusion de la configuration de l'hôte du dépôt se trouve à un endroit différent du chemin d'inclusion de la configuration locale.
default: /etc/pgbackrest/conf.d
example: --repo1-host-config-include-path=/conf/pgbackrest/conf.d
Chemin de configuration pgBackRest de l'hôte du dépôt.
Définit l'emplacement du chemin de configuration sur l'hôte du dépôt. Ceci n'est nécessaire que si le chemin de configuration de l'hôte du référentiel se trouve à un endroit différent du chemin de configuration local.
default: /etc/pgbackrest
example: --repo1-host-config-path=/conf/pgbackrest
Port de l'hôte du dépôt lorsque repo-host est défini.
Utilisez cette option pour spécifier un port non par défaut pour le protocole d'accès à l'hôte du dépôt. Actuellement, seul SSH est pris en charge
allowed: 0-65535
example: --repo1-host-port=25
Nom obsolète: backup-ssh-port
Utilisateur de l'hôte du dépôt lorsque repo-host est défini.
Définit l'utilisateur qui sera utilisé pour les opérations sur l'hôte du dépôt. De préférence, il ne s'agit pas de l'utilisateur postgres mais plutôt d'un autre utilisateur comme pgbackrest. Si PostgreSQL fonctionne sur l'hôte du dépôt, l'utilisateur postgres peut être placé dans le groupe pgbackrest afin qu'il ait les autorisations de lecture sur le dépôt sans pouvoir en endommager le contenu accidentellement.
default: pgbackrest
example: --repo1-host-user=repo-user
Nom obsolète: backup-user
Chemin d'accès où sont stockées les sauvegardes et les archives.
Le dépôt est l'endroit où pgBackRest stocke les sauvegardes et archive les segments des journaux de transaction (WAL).
Il peut être difficile d'estimer à l'avance l'espace dont vous aurez besoin. La meilleure chose à faire est de prendre quelques sauvegardes puis d'enregistrer la taille des différents types de sauvegardes (full/incr/diff) et de mesurer la quantité de WAL générée par jour. Cela vous donnera une idée générale de l'espace dont vous aurez besoin, même si, bien sûr, les besoins changeront probablement au fil du temps, à fur et à mesure de l'évolution de votre base de données.
default: /var/lib/pgbackrest
example: --repo1-path=/backup/db/backrest
S3 dépôt bucket.
Bucket S3 utilisé pour stocker le dépôt.
Les dépots pgBackRest peuvent être stockés à la racine du bucket en définissant repo-path=/ mais il est généralement préférable de spécifier un préfixe, comme par exemple /repo, afin que les logs et autres contenus générés par AWS puissent également être stockés dans le bucket.
example: --repo1-s3-bucket=pg-backup
Ficher SSL CA S3.
Utiliser un fichier CA autre que celui défini par défaut dans le système.
example: --repo1-s3-ca-file=/etc/pki/tls/certs/ca-bundle.crt
Chemin S3 SSL CA.
Utiliser un chemin pour le CA autre que celui défini par défaut dans le système.
example: --repo1-s3-ca-path=/etc/pki/tls/certs
Dépot S3 Point de terminaison (endpoint).
Le point de terminaison d'AWS doit être valable pour la région sélectionnée.
example: --repo1-s3-endpoint=s3.amazonaws.com
Hôte du dépot S3.
Conntecter sur un hôte différent du point de terminaison (endpoint). Il est généralement utilisé à des fins de test.
example: --repo1-s3-host=127.0.0.1
Port de connection au dépot S3.
Port à utiliser lors de la connexion au point de terminaison (ou à l'hôte si spécifié).
default: 443
allowed: 1-65535
example: --repo1-s3-port=9000
Région du dépôt S3.
La région d'AWS où le bucket a été créé.
example: --repo1-s3-region=us-east-1
S3 URI formats.
Les formats URI suivants sont pris en charge:
- host - Connexion à l'hôte bucket.endpoint.
- path - Connexion à l'hôte endpoint et ajout du bucket aux URIs.
default: host
example: --repo1-s3-uri-style=path
Vérifier le certificat du serveur S3.
Désactive la vérification du certificat du serveur S3. Cette fonction ne doit être utilisée que dans le cadre de tests ou dans le cas d'une utilisation avec un certificat a été auto-signé.
default: y
example: --no-repo1-s3-verify-tls
Nom obsolète: repo-s3-verify-ssl
Type de stockage utilisé pour le dépôt.
Les types de stockage suivants sont pris en charge :
- cifs - Comme posix, mais désactive les liens et les fsyncs sur les répertoires
- posix - Systèmes de fichiers conformes à Posix
- s3 - Service de stockage d'objet (AWS Simple Storage Service)
default: posix
example: --repo1-type=cifs
This command is generally run manually, but there are instances where it might be automated.
Restaurer uniquement des bases de données spécifiques.
Cette fonctionnalité permet de ne restaurer que certaines bases de données. Les bases de données qui ne sont pas spécifiquement sélectionnées seront restaurées sous la forme de fichiers épars et mis à zéro afin d'économiser de l'espace, tout en permettant à
PostgreSQL d'effectuer la restauration. Après la récupération, les bases de données qui n'ont pas été incluses ne seront pas accessibles mais peuvent être supprimées avec la commande
drop database.
NOTE:
Les bases de données intégrées (template0, template1, et postgres) sont toujours restaurées.
L'option
--db-include peut être passée plusieurs fois pour spécifier plus d'une base de données à inclure.
example: --db-include=db_main
Forcer une restauration.
En soi, cette option écrase complètement les chemins des données et des tablespaces de PostgreSQL. En association avec --delta, un delta sera effectué en se basant sur l'horodatage et la taille au lieu des sommes de contrôle.
default: n
example: --force
Restaurer tous les liens symboliques
Par défaut, les liens symboliques qu'ils soient répertoires ou fichiers sont restaurés comme des répertoires et fichiers standards dans $PGDATA. En effet, il peut être dangereux de restaurer des liens symboliques vers leur destination d'origine sur un système autre que celui où la sauvegarde d'origine a été effectuée. Cette option restaure tous les liens symboliques tels qu'ils étaient sur le système d'origine où la sauvegarde a été effectuée.
default: n
example: --link-all
Modification de la destination d'un lien symbolique.
Permet de modifier la destination du fichier ou du répertoire d'un lien symbolique lors de la restauration. Ceci est utile lors de la restauration sur un sytèmes avec une configuration du stockage différente de celle du système d'origine (là où la sauvegarde a été réalisée).
example: --link-map=pg_xlog=/data/xlog
Définissez une option dans recovery.conf.
Consultez http://www.postgresql.org/docs/X.X/static/recovery-config.html pour plus de détails sur les options de recovery.conf (remplacez X.X par votre
PostgreSQL version). Cette option peut être utilisée plusieurs fois.
NOTE:
L'option restore_command sera générée automatiquement mais peut être écrasée avec cette option. Faites attention à bien spécifier votre propre restore_command car pgBackRest est conçu pour gérer cela pour vous. Les options Target Recovery (recovery_target_name, recovery_target_time, etc.) sont générées automatiquement par pgBackRest et ne doivent pas être définies avec cette option.
Dans la mesure où
pgBackRest ne démarre pas
PostgreSQL après avoir écrit le fichier
recovery.conf, il est toujours possible de modifier/contrôler
recovery.conf avant de redémarrer manuellement.
example: --recovery-option=primary_conninfo=db.mydomain.com
Jeu de sauvegarde à restaurer.
Le jeu de sauvegarde à restaurer : latest restaurera la dernière sauvegarde, autrement fournir le nom de la sauvegarde à restaurer
default: latest
example: --set=20150131-153358F_20150131-153401I
Restaurer un tablespace dans un répertoire spécifique.
Déplace un tablespace vers un nouvel emplacement pendant la restauration. Cela est utile lorsque les emplacements des tablespaces ne sont pas les mêmes sur un secondaire en réplication, ou lorsqu'un système a des points de montage différents après une mis à niveau.
Depuis la version PostgreSQL 9.2, les emplacements des tablespaces ne sont pas stockés dans pg_tablespace, donc le déplacement des tablespaces peut se faire en toute tranquillité. Cependant, le déplacement d'un tablespace vers le data_directory n'est pas recommandé et peut causer des problèmes. Pour plus d'informations sur le déplacement des tablespaces, http://www.databasesoup.com/2013/11/moving-tablespaces.html est une bonne ressource (en anglais).
example: --tablespace-map=ts_01=/db/ts_01
Restaurez tous les tablespaces dans le répertoire spécifié.
Par défaut, les tablespaces sont restaurés à leur emplacement d'origine et, bien que ce comportement puisse être modifié avec l'option tablespace-map, il est parfois souhaitable de remapper tous les tablespaces dans un nouveau répertoire en une seule fois. Ceci est particulièrement utile pour les systèmes de développement ou de mise en place qui peuvent ne pas avoir la même disposition de stockage que le système d'origine où la sauvegarde a été réalisée.
Le chemin spécifié sera le chemin parent utilisé pour créer tous les tablespaces de la sauvegarde lors de la restauration.
example: --tablespace-map-all=/data/tablespace
Cible de récupération target.
Définit la cible de récupération lorsque --type est nom, xid, ou temps
example: --target=2015-01-30 14:15:11 EST
Action à prendre lorsque la cible de récupération est atteint.
Cette option est effective lorsque
hot_standby=on est configuré dans
PostgreSQL (ex :
postgresql.conf); sans quoi l'instance sera promu lorsque la cible sera atteinte ou lorsqu'il n'y plus d'autre WAL archivé.
Les actions suivantes sont supportées:
- pause - mise en pause lorsque la cible de récupération est atteint. (PostgreSQL >= 9.1)
- promote - promotion et changement de timeline lorsque la cible de récupération est atteint. (PostgreSQL >= 9.1)
- shutdown - arrêt du serveur lorsque la cible de récupération est atteint (PostgreSQL >= 9.5)
default: pause
example: --target-action=promote
S'arrêter juste avant que l'objectif de récupération ne soit atteint.
Définit si la cible de récupération est exclusive (la valeur par défaut est inclusive) et n'est valable que lorsque --type est time ou xid. Par exemple, l'utilisation de --target-exclusive exclurait le contenu de la transaction 1007 lorsque --type=xid et --target=1007. Pour plus d'information, consultez dans la documentation de PostgreSQL l'option recovery_target_inclusive.
default: n
example: --no-target-exclusive
Récupération jusqu'à une timeline.
Voir recovery_target_timeline dans la documentation de PostgreSQL pour plus d'informations
example: --target-timeline=3
Type de récupération.
Les types de récupération suivants sont pris en charge:
- default - récupération jusqu'à la fin du flux d'archives.
- immediate - récupération uniquement jusqu'à ce que la base de données devienne cohérente. Cette option n'est prise en charge que sur PostgreSQL >= 9.4.
- name - récupération jusqu'au point de restauration spécifié dans --target.
- xid - récupération jusqu'à l'ID de transaction specifié dans --target.
- time - se récupération jusqu'au moment spécifié dans --target.
- preserve - préserver la configuration de la récupération (ex fichier recovery.conf).
- standby - ajoute standby_mode=on au option de récupération de PostgreSQL (ex: recovery.conf) pour que l'instance démarre en mode standby.
- none - Aucune configuration de récupération n'est écrite dans PostgreSQL (ex : recovery.conf). PostgreSQL tentera d'obtenir une cohérence en utilisant les segments WAL présents dans pg_xlog/pg_wal. Fournissez les segments WAL requis ou utilisez le paramètre archive-copy pour les inclure avec la sauvegarde.
default: default
example: --type=xid
Taille de la mémoire tampon pour les opérations sur les fichiers.
Définissez la taille de la mémoire tampon utilisée pour les opérations de copie, de compression et de décompression. Un maximum de 3 tampons seront utilisés à la fois par processus. Un maximum supplémentaire de 256K par processus peut être utilisé pour les tampons zlib.
La taille peut être saisie en octets (par défaut) ou en KB, MB, GB, TB, ou PB où le multiplicateur est une puissance de 1024. Par exemple, la valeur insensible à la casse 32k (ou 32KB) peut être utilisée au lieu de 32768.
Les valeurs autorisées, en octets, sont16384, 32768, 65536, 131072, 262144, 524288, 1048576, 2097152, 4194304, 8388608, et 16777216.
default: 1048576
example: --buffer-size=32K
Chemin d'accès à l'exécutable du client ssh.
Utilisez un client SSH spécifique lorsqu'une alternative est nécessaire ou lorsque l'exécutable ssh n'est pas dans $PATH.
default: ssh
example: --cmd-ssh=/usr/bin/ssh
Niveau de compression du réseau.
Définit le niveau de compression sur le réseau, lorsque compress-type=none et que la commande n'est pas exécutée sur le même hôte que le dépôt. La compression est utilisée pour réduire le trafic réseau mais peut être désactivée en définissant compress-level-network=0. Lorsque compress-type n'est pas égal à none, le paramètre compress-level-network est ignoré et compress-level est utilisé à la place de sorte que le fichier ne soit compressé qu'une seule fois. La compression SSH est toujours désactivée.
default: 3
allowed: 0-9
example: --compress-level-network=1
Fichier de configuration pgBackRest.
Utiliser cette option pour spécifier un fichier de configuration différent de celui par défaut.
default: /etc/pgbackrest/pgbackrest.conf
example: --config=/conf/pgbackrest/pgbackrest.conf
Emplacement des fichiers de configuration pgBackRest supplémentaires..
Les fichiers de configuration existant à l'emplacement spécifié avec l'extension .conf seront concaténés avec le fichier de configuration pgBackRest, ce qui donne un seul fichier de configuration.
default: /etc/pgbackrest/conf.d
example: --config-include-path=/conf/pgbackrest/conf.d
Emplacement du répertoire de racine de pgBackRest des fichiers de configuration.
Ce paramètre est utilisé pour écraser le chemin racine par défaut pour les options --config et --config-include-path à moins qu'elles ne soient explicitement définies sur la ligne de commande.
Par exemple, en utilisant uniquement --config-path=/conf/pgbackrest, la valeur par défaut de --config est /conf/pgbackrest/pgbackrest.conf et la valeur par défaut de --config-include-path est /conf/pgbackrest/conf.d.
default: /etc/pgbackrest
example: --config-path=/conf/pgbackrest
Restauration ou sauvegarde à l'aide de sommes de contrôle.
Lors d'une restauration, par défaut, les répertoires PostgreSQL data et tablespace sont censés être présents mais vides. Cette option effectue une restauration delta en utilisant des sommes de contrôle.
Lors d'une sauvegarde, cette option utilisera les sommes de contrôle au lieu des horodatages pour déterminer si les fichiers devront être copiés.
default: n
example: --delta
Délai d'attente E/S.
Délai d'attente, en secondes, utilisé pour les connexions et les opérations de lecture/écriture.
Notez que l'ensemble de l'opération de lecture/écriture n'a pas besoin de se terminer dans ce délai mais une progression doit être constatée, même s'il ne s'agit que d'un seul octet.
default: 60
allowed: 0.1-3600
example: --io-timeout=120
Chemin d'accès où sont stockés les fichiers de verrouillage.
Le chemin de verrouillage fournit l'emplacement à pgBackRest pour créer des fichiers de verrouillage afin d'éviter que des opérations en conflictuelles ne soient exécutées simultanément.
default: /tmp/pgbackrest
example: --lock-path=/backup/db/lock
Utilisation d'un umask
neutre
Définit l'umask à 0000 pour que les modes dans le dépôt de sauvegarde soient créés de manière appropriée. Le mode par défaut du répertoire est 0750 et le mode par défaut du fichier est 0640. Pour les répertoires lock et log, les modes de répertoire et de fichier sont respectivement fixés à 0770 et 0660.
Pour utiliser l'umask de l'utilisateur en cours d'exécution, spécifiez plutôt neutral-umask=n dans le fichier de configuration ou --no-neutral-umask sur la ligne de commande.
default: y
example: --no-neutral-umask
Nombre de processus maximal lors utilisé lors de la compression et du transfert.
Chaque processus effectuera une compression et un transfert pour que la commande s'exécute plus rapidement, mais ne réglez pas process-max à un niveau si élevé que cela affecte les performances de la base de données.
default: 1
allowed: 1-999
example: --process-max=4
Délai d'attente du protocole.
Définit le délai, en secondes, durant lequel le processus local ou distant attendra qu'un nouveau message soit reçu au niveau de la couche protocole. Cela permet d'éviter que les processus n'attendent indéfiniment un message.
NOTE:
L'option protocol-timeout doit être supérieure à celle de db-timeout option.
default: 1830
allowed: 0.1-604800
example: --protocol-timeout=630
Activation de la fonction de keep-alive (maintien en vie).
Activation des messages de keep-alive (maintien en vie) sur les connexions réseaux.
default: y
example: --no-sck-keep-alive
Defines the stanza.
Un stanza est la configuration de la sauvegarde d'une instance PostgreSQL où est définit l'endroit où il se trouve, la façon dont il sera sauvegardé, les options d'archivage, etc... La plupart des serveurs de base de données n'auront qu'une seule instance PostgreSQL et donc un stanza alors que les serveurs de sauvegarde auront un stanza pour chaque instance de base de données qui doit être sauvegardé.
Il est tentant de nommer le stanza en référence à l'instance primaire, mais un meilleur nom décrirait les bases de données contenues dans l'instance : comme le nom du stanza sera utilisé pour le primaire et tous les secondaire, il est plus approprié de choisir un nom qui décrit la fonction réelle du groupe d'instances, comme app ou dw, plutôt que le nom local de l'instance, comme main ou prod.
example: --stanza=main
Compteur Keep-alive.
Spécifie le nombre de messages TCP à garder en mémoire qui peuvent être perdus avant que la connexion ne soit considérée comme morte.
Cette option n'est disponible que sur les systèmes qui prennent en charge l'option réseau TCP_KEEPCNT.
allowed: 1-32
example: --tcp-keep-alive-count=3
Temps d'inactivité du keepalive.
Spécifie la durée (en secondes) sans activité du réseau après laquelle le système d'exploitation doit envoyer un message TCP de maintien en activité (keep-alive).
Cette option n'est disponible que sur les systèmes qui prennent en charge l'option réseau TCP_KEEPIDLE.
allowed: 1-3600
example: --tcp-keep-alive-idle=60
Temps d'intervalle de maintien en vie (keep-alive).
Spécifie le temps (en secondes) après lequel un message TCP de maintien en activité (keep-alive) non acquitté doit être retransmis.
Cette option n'est disponible que sur les systèmes qui prennent en charge l'option réseau TCP_KEEPINTVL.
allowed: 1-900
example: --tcp-keep-alive-interval=30
Niveau de journalisation en sortie sur la console.
Les niveaux de traces suivants sont pris en charge:
- off - Pas de journal de traces (non recommandé)
- error - Journaliser uniquement les erreurs
- warn - Journaliser les avertissements et les erreurs
- info - Journaliser les messages d'information, les avertissements et les erreurs
- detail - Journaliser les détails, les messages d'information, les avertissements et les erreurs
- debug - Journaliser les message de Débogage, les détails, les messages d'information, les avertissements et les erreurs
- trace - Journaliser les traces (un débogage très verbeux), les message de Débogage, les détails, les messages d'information, les avertissements et les erreurs
default: warn
example: --log-level-console=error
Niveau d'enregistrement des traces lors de l'enregistrement sur fichier.
Les niveaux de traces suivants sont pris en charge:
- off - Pas de journal de traces (non recommandé)
- error - Journaliser uniquement les erreurs
- warn - Journaliser les avertissements et les erreurs
- info - Journaliser les messages d'information, les avertissements et les erreurs
- detail - Journaliser les détails, les messages d'information, les avertissements et les erreurs
- debug - Journaliser les message de Débogage, les détails, les messages d'information, les avertissements et les erreurs
- trace - Journaliser les traces (un débogage très verbeux), les message de Débogage, les détails, les messages d'information, les avertissements et les erreurs
default: info
example: --log-level-file=debug
Niveau de traces sur la sortie console stderr.
Spécifie les niveaux de traces qui sortiront en
stderr plutôt que
stdout (spécifié par
log-level-console). L'horodatage et le processus ne seront pas émis sur
stderr.
Les niveaux de traces suivants sont pris en charge:
- off - Pas de journal de traces (non recommandé)
- error - Journaliser uniquement les erreurs
- warn - Journaliser les avertissements et les erreurs
- info - Journaliser les messages d'information, les avertissements et les erreurs
- detail - Journaliser les détails, les messages d'information, les avertissements et les erreurs
- debug - Journaliser les message de Débogage, les détails, les messages d'information, les avertissements et les erreurs
- trace - Journaliser les traces (un débogage très verbeux), les message de Débogage, les détails, les messages d'information, les avertissements et les erreurs
default: warn
example: --log-level-stderr=error
Emplacement où les fichiers journaux de traces sont stockés.
Le chemin d'accès au journal fournit un emplacement pour pgBackRest pour stocker les fichiers journaux. Notez que si log-level-file=off alors aucun chemin pour l'emplacement des journaux de traces n'est nécessaire.
default: /var/log/pgbackrest
example: --log-path=/backup/db/log
Activer la journalisation des traces dans les sous-processus.
Activez la journalisation des traces dans les fichiers pour tous les sous-processus créés par ce processus en utilisant le niveau de journalisation spécifié par log-level-file.
default: n
example: --log-subprocess
Activer l'horodatage dans les traces.
Active l'horodatage dans la console et l'enregistrement des fichiers. Cette option est désactivée dans des situations particulières telles que la génération de documentation.
default: y
example: --no-log-timestamp
Chiffrement (cipher) utilisé pour chiffrer le dépôt.
Les types de chiffrement suivants sont pris en charge:
- none - Le dépôt n'est pas chiffré.
- aes-256-cbc - Advanced Encryption Standard avec une clef de 256 bit
À noter que le chiffrement est toujours effectué côté client même si le type de stockage (par exemple S3) supporte le chiffrement.
default: none
example: --repo1-cipher-type=aes-256-cbc
Hôte de dépôt dans le cas d'un fonctionnement à distance via SSH.
Assurez-vous que l'authentification SSH soit correctement approuvé entre l'hôte PostgreSQL et l'hôte du référentiel.
Ce paramètre n'est pas nécessaire pour la sauvegarde et l'archivage sur un système de fichiers monté localement.
example: --repo1-host=repo1.domain.com
Nom obsolète: backup-host
Chemin des binaires pgBackRest sur l'hôte du dépôt.
Nécessaire uniquement si le chemin d'accès à pgbackrest est différent entre les hôtes locaux et l'hote du dépôt. S'il n'est pas défini, le chemin des binaires sur l'hôte du dépôt sera le même que le chemin des binaires locaux.
example: --repo1-host-cmd=/usr/lib/backrest/bin/pgbackrest
Nom obsolète: backup-cmd
Emplacement du fichier de configuration pgBackRest sur l'hôte du dépôt.
Définit l'emplacement du fichier de configuration sur l'hôte du dépôt. Ceci n'est nécessaire que si le fichier de configuration de l'hôte du dépôt se trouve dans un emplacement différent de celui du fichier de configuration local.
default: /etc/pgbackrest/pgbackrest.conf
example: --repo1-host-config=/conf/pgbackrest/pgbackrest.conf
Nom obsolète: backup-config
Chemin d'inclusion pgBackRest de la configuration de l'hôte du dépôt.
Définit l'emplacement du chemin d'inclusion de la configuration sur l'hôte du dépôt. Ceci n'est nécessaire que si le chemin d'inclusion de la configuration de l'hôte du dépôt se trouve à un endroit différent du chemin d'inclusion de la configuration locale.
default: /etc/pgbackrest/conf.d
example: --repo1-host-config-include-path=/conf/pgbackrest/conf.d
Chemin de configuration pgBackRest de l'hôte du dépôt.
Définit l'emplacement du chemin de configuration sur l'hôte du dépôt. Ceci n'est nécessaire que si le chemin de configuration de l'hôte du référentiel se trouve à un endroit différent du chemin de configuration local.
default: /etc/pgbackrest
example: --repo1-host-config-path=/conf/pgbackrest
Port de l'hôte du dépôt lorsque repo-host est défini.
Utilisez cette option pour spécifier un port non par défaut pour le protocole d'accès à l'hôte du dépôt. Actuellement, seul SSH est pris en charge
allowed: 0-65535
example: --repo1-host-port=25
Nom obsolète: backup-ssh-port
Utilisateur de l'hôte du dépôt lorsque repo-host est défini.
Définit l'utilisateur qui sera utilisé pour les opérations sur l'hôte du dépôt. De préférence, il ne s'agit pas de l'utilisateur postgres mais plutôt d'un autre utilisateur comme pgbackrest. Si PostgreSQL fonctionne sur l'hôte du dépôt, l'utilisateur postgres peut être placé dans le groupe pgbackrest afin qu'il ait les autorisations de lecture sur le dépôt sans pouvoir en endommager le contenu accidentellement.
default: pgbackrest
example: --repo1-host-user=repo-user
Nom obsolète: backup-user
Chemin d'accès où sont stockées les sauvegardes et les archives.
Le dépôt est l'endroit où pgBackRest stocke les sauvegardes et archive les segments des journaux de transaction (WAL).
Il peut être difficile d'estimer à l'avance l'espace dont vous aurez besoin. La meilleure chose à faire est de prendre quelques sauvegardes puis d'enregistrer la taille des différents types de sauvegardes (full/incr/diff) et de mesurer la quantité de WAL générée par jour. Cela vous donnera une idée générale de l'espace dont vous aurez besoin, même si, bien sûr, les besoins changeront probablement au fil du temps, à fur et à mesure de l'évolution de votre base de données.
default: /var/lib/pgbackrest
example: --repo1-path=/backup/db/backrest
S3 dépôt bucket.
Bucket S3 utilisé pour stocker le dépôt.
Les dépots pgBackRest peuvent être stockés à la racine du bucket en définissant repo-path=/ mais il est généralement préférable de spécifier un préfixe, comme par exemple /repo, afin que les logs et autres contenus générés par AWS puissent également être stockés dans le bucket.
example: --repo1-s3-bucket=pg-backup
Ficher SSL CA S3.
Utiliser un fichier CA autre que celui défini par défaut dans le système.
example: --repo1-s3-ca-file=/etc/pki/tls/certs/ca-bundle.crt
Chemin S3 SSL CA.
Utiliser un chemin pour le CA autre que celui défini par défaut dans le système.
example: --repo1-s3-ca-path=/etc/pki/tls/certs
Dépot S3 Point de terminaison (endpoint).
Le point de terminaison d'AWS doit être valable pour la région sélectionnée.
example: --repo1-s3-endpoint=s3.amazonaws.com
Hôte du dépot S3.
Conntecter sur un hôte différent du point de terminaison (endpoint). Il est généralement utilisé à des fins de test.
example: --repo1-s3-host=127.0.0.1
Port de connection au dépot S3.
Port à utiliser lors de la connexion au point de terminaison (ou à l'hôte si spécifié).
default: 443
allowed: 1-65535
example: --repo1-s3-port=9000
Région du dépôt S3.
La région d'AWS où le bucket a été créé.
example: --repo1-s3-region=us-east-1
S3 URI formats.
Les formats URI suivants sont pris en charge:
- host - Connexion à l'hôte bucket.endpoint.
- path - Connexion à l'hôte endpoint et ajout du bucket aux URIs.
default: host
example: --repo1-s3-uri-style=path
Vérifier le certificat du serveur S3.
Désactive la vérification du certificat du serveur S3. Cette fonction ne doit être utilisée que dans le cadre de tests ou dans le cas d'une utilisation avec un certificat a été auto-signé.
default: y
example: --no-repo1-s3-verify-tls
Nom obsolète: repo-s3-verify-ssl
Type de stockage utilisé pour le dépôt.
Les types de stockage suivants sont pris en charge :
- cifs - Comme posix, mais désactive les liens et les fsyncs sur les répertoires
- posix - Systèmes de fichiers conformes à Posix
- s3 - Service de stockage d'objet (AWS Simple Storage Service)
default: posix
example: --repo1-type=cifs
PostgreSQL data directory.
Ce paramètre doit être le même que le paramètre data_directory du fichier postgresql.conf. Même si cette valeur peut être lue à partir de postgresql.conf ou PostgreSQL, il est conseillé de la définir au cas où ces ressources ne seraient pas disponibles pendant un scénario de restauration ou de sauvegarde hors ligne.
L'option pg-path est testée par rapport à la valeur indiquée par PostgreSQL à chaque sauvegarde en ligne, elle doit donc toujours être à jour.
example: --pg1-path=/data/db
Nom obsolète: db-path
La commande stanza-create doit être exécutée sur l'hôte où se trouve le dépôt après que le stanza ait été configurée dans pgbackrest.conf.
Sauvegarde depuis l'instance standby secondaire.
Activer la sauvegarde depuis le secondaire en standby pour réduire la charge sur l'instance primaire. Cette option nécessite que les hôtes primary (primaire) et standby (secondaire en standby) soit correctement configurés.
default: n
example: --backup-standby
Création sur une instance en ligne.
Le fait de spécifier --no-online empêche pgBackRest de se connecter à PostgreSQL lors de la création du stanza.
default: y
example: --no-online
Taille de la mémoire tampon pour les opérations sur les fichiers.
Définissez la taille de la mémoire tampon utilisée pour les opérations de copie, de compression et de décompression. Un maximum de 3 tampons seront utilisés à la fois par processus. Un maximum supplémentaire de 256K par processus peut être utilisé pour les tampons zlib.
La taille peut être saisie en octets (par défaut) ou en KB, MB, GB, TB, ou PB où le multiplicateur est une puissance de 1024. Par exemple, la valeur insensible à la casse 32k (ou 32KB) peut être utilisée au lieu de 32768.
Les valeurs autorisées, en octets, sont16384, 32768, 65536, 131072, 262144, 524288, 1048576, 2097152, 4194304, 8388608, et 16777216.
default: 1048576
example: --buffer-size=32K
Chemin d'accès à l'exécutable du client ssh.
Utilisez un client SSH spécifique lorsqu'une alternative est nécessaire ou lorsque l'exécutable ssh n'est pas dans $PATH.
default: ssh
example: --cmd-ssh=/usr/bin/ssh
Niveau de compression du réseau.
Définit le niveau de compression sur le réseau, lorsque compress-type=none et que la commande n'est pas exécutée sur le même hôte que le dépôt. La compression est utilisée pour réduire le trafic réseau mais peut être désactivée en définissant compress-level-network=0. Lorsque compress-type n'est pas égal à none, le paramètre compress-level-network est ignoré et compress-level est utilisé à la place de sorte que le fichier ne soit compressé qu'une seule fois. La compression SSH est toujours désactivée.
default: 3
allowed: 0-9
example: --compress-level-network=1
Fichier de configuration pgBackRest.
Utiliser cette option pour spécifier un fichier de configuration différent de celui par défaut.
default: /etc/pgbackrest/pgbackrest.conf
example: --config=/conf/pgbackrest/pgbackrest.conf
Emplacement des fichiers de configuration pgBackRest supplémentaires..
Les fichiers de configuration existant à l'emplacement spécifié avec l'extension .conf seront concaténés avec le fichier de configuration pgBackRest, ce qui donne un seul fichier de configuration.
default: /etc/pgbackrest/conf.d
example: --config-include-path=/conf/pgbackrest/conf.d
Emplacement du répertoire de racine de pgBackRest des fichiers de configuration.
Ce paramètre est utilisé pour écraser le chemin racine par défaut pour les options --config et --config-include-path à moins qu'elles ne soient explicitement définies sur la ligne de commande.
Par exemple, en utilisant uniquement --config-path=/conf/pgbackrest, la valeur par défaut de --config est /conf/pgbackrest/pgbackrest.conf et la valeur par défaut de --config-include-path est /conf/pgbackrest/conf.d.
default: /etc/pgbackrest
example: --config-path=/conf/pgbackrest
Délai d'attente des requêtes à la base de données.
Définit le délai d'attente, en secondes, pour les interrogations de la base de données. Cela inclut les fonctions
pg_start_backup() et
pg_stop_backup() qui peuvent chacune prendre un temps considérable. C'est pourquoi le délai d'attente doit être maintenu à un niveau élevé, sauf si vous savez que ces fonctions retourneront rapidement (c'est-à-dire si vous avez défini
startfast=y et que vous savez que l'instance de base de données ne générera pas beaucoup de segments WAL pendant la sauvegarde).
NOTE:
L'option db-timeout doit être inférieure à l'option protocol-timeout.
default: 1800
allowed: 0.1-604800
example: --db-timeout=600
Délai d'attente E/S.
Délai d'attente, en secondes, utilisé pour les connexions et les opérations de lecture/écriture.
Notez que l'ensemble de l'opération de lecture/écriture n'a pas besoin de se terminer dans ce délai mais une progression doit être constatée, même s'il ne s'agit que d'un seul octet.
default: 60
allowed: 0.1-3600
example: --io-timeout=120
Chemin d'accès où sont stockés les fichiers de verrouillage.
Le chemin de verrouillage fournit l'emplacement à pgBackRest pour créer des fichiers de verrouillage afin d'éviter que des opérations en conflictuelles ne soient exécutées simultanément.
default: /tmp/pgbackrest
example: --lock-path=/backup/db/lock
Utilisation d'un umask
neutre
Définit l'umask à 0000 pour que les modes dans le dépôt de sauvegarde soient créés de manière appropriée. Le mode par défaut du répertoire est 0750 et le mode par défaut du fichier est 0640. Pour les répertoires lock et log, les modes de répertoire et de fichier sont respectivement fixés à 0770 et 0660.
Pour utiliser l'umask de l'utilisateur en cours d'exécution, spécifiez plutôt neutral-umask=n dans le fichier de configuration ou --no-neutral-umask sur la ligne de commande.
default: y
example: --no-neutral-umask
Délai d'attente du protocole.
Définit le délai, en secondes, durant lequel le processus local ou distant attendra qu'un nouveau message soit reçu au niveau de la couche protocole. Cela permet d'éviter que les processus n'attendent indéfiniment un message.
NOTE:
L'option protocol-timeout doit être supérieure à celle de db-timeout option.
default: 1830
allowed: 0.1-604800
example: --protocol-timeout=630
Activation de la fonction de keep-alive (maintien en vie).
Activation des messages de keep-alive (maintien en vie) sur les connexions réseaux.
default: y
example: --no-sck-keep-alive
Defines the stanza.
Un stanza est la configuration de la sauvegarde d'une instance PostgreSQL où est définit l'endroit où il se trouve, la façon dont il sera sauvegardé, les options d'archivage, etc... La plupart des serveurs de base de données n'auront qu'une seule instance PostgreSQL et donc un stanza alors que les serveurs de sauvegarde auront un stanza pour chaque instance de base de données qui doit être sauvegardé.
Il est tentant de nommer le stanza en référence à l'instance primaire, mais un meilleur nom décrirait les bases de données contenues dans l'instance : comme le nom du stanza sera utilisé pour le primaire et tous les secondaire, il est plus approprié de choisir un nom qui décrit la fonction réelle du groupe d'instances, comme app ou dw, plutôt que le nom local de l'instance, comme main ou prod.
example: --stanza=main
Compteur Keep-alive.
Spécifie le nombre de messages TCP à garder en mémoire qui peuvent être perdus avant que la connexion ne soit considérée comme morte.
Cette option n'est disponible que sur les systèmes qui prennent en charge l'option réseau TCP_KEEPCNT.
allowed: 1-32
example: --tcp-keep-alive-count=3
Temps d'inactivité du keepalive.
Spécifie la durée (en secondes) sans activité du réseau après laquelle le système d'exploitation doit envoyer un message TCP de maintien en activité (keep-alive).
Cette option n'est disponible que sur les systèmes qui prennent en charge l'option réseau TCP_KEEPIDLE.
allowed: 1-3600
example: --tcp-keep-alive-idle=60
Temps d'intervalle de maintien en vie (keep-alive).
Spécifie le temps (en secondes) après lequel un message TCP de maintien en activité (keep-alive) non acquitté doit être retransmis.
Cette option n'est disponible que sur les systèmes qui prennent en charge l'option réseau TCP_KEEPINTVL.
allowed: 1-900
example: --tcp-keep-alive-interval=30
Niveau de journalisation en sortie sur la console.
Les niveaux de traces suivants sont pris en charge:
- off - Pas de journal de traces (non recommandé)
- error - Journaliser uniquement les erreurs
- warn - Journaliser les avertissements et les erreurs
- info - Journaliser les messages d'information, les avertissements et les erreurs
- detail - Journaliser les détails, les messages d'information, les avertissements et les erreurs
- debug - Journaliser les message de Débogage, les détails, les messages d'information, les avertissements et les erreurs
- trace - Journaliser les traces (un débogage très verbeux), les message de Débogage, les détails, les messages d'information, les avertissements et les erreurs
default: warn
example: --log-level-console=error
Niveau d'enregistrement des traces lors de l'enregistrement sur fichier.
Les niveaux de traces suivants sont pris en charge:
- off - Pas de journal de traces (non recommandé)
- error - Journaliser uniquement les erreurs
- warn - Journaliser les avertissements et les erreurs
- info - Journaliser les messages d'information, les avertissements et les erreurs
- detail - Journaliser les détails, les messages d'information, les avertissements et les erreurs
- debug - Journaliser les message de Débogage, les détails, les messages d'information, les avertissements et les erreurs
- trace - Journaliser les traces (un débogage très verbeux), les message de Débogage, les détails, les messages d'information, les avertissements et les erreurs
default: info
example: --log-level-file=debug
Niveau de traces sur la sortie console stderr.
Spécifie les niveaux de traces qui sortiront en
stderr plutôt que
stdout (spécifié par
log-level-console). L'horodatage et le processus ne seront pas émis sur
stderr.
Les niveaux de traces suivants sont pris en charge:
- off - Pas de journal de traces (non recommandé)
- error - Journaliser uniquement les erreurs
- warn - Journaliser les avertissements et les erreurs
- info - Journaliser les messages d'information, les avertissements et les erreurs
- detail - Journaliser les détails, les messages d'information, les avertissements et les erreurs
- debug - Journaliser les message de Débogage, les détails, les messages d'information, les avertissements et les erreurs
- trace - Journaliser les traces (un débogage très verbeux), les message de Débogage, les détails, les messages d'information, les avertissements et les erreurs
default: warn
example: --log-level-stderr=error
Emplacement où les fichiers journaux de traces sont stockés.
Le chemin d'accès au journal fournit un emplacement pour pgBackRest pour stocker les fichiers journaux. Notez que si log-level-file=off alors aucun chemin pour l'emplacement des journaux de traces n'est nécessaire.
default: /var/log/pgbackrest
example: --log-path=/backup/db/log
Activer la journalisation des traces dans les sous-processus.
Activez la journalisation des traces dans les fichiers pour tous les sous-processus créés par ce processus en utilisant le niveau de journalisation spécifié par log-level-file.
default: n
example: --log-subprocess
Activer l'horodatage dans les traces.
Active l'horodatage dans la console et l'enregistrement des fichiers. Cette option est désactivée dans des situations particulières telles que la génération de documentation.
default: y
example: --no-log-timestamp
Chiffrement (cipher) utilisé pour chiffrer le dépôt.
Les types de chiffrement suivants sont pris en charge:
- none - Le dépôt n'est pas chiffré.
- aes-256-cbc - Advanced Encryption Standard avec une clef de 256 bit
À noter que le chiffrement est toujours effectué côté client même si le type de stockage (par exemple S3) supporte le chiffrement.
default: none
example: --repo1-cipher-type=aes-256-cbc
Chemin d'accès où sont stockées les sauvegardes et les archives.
Le dépôt est l'endroit où pgBackRest stocke les sauvegardes et archive les segments des journaux de transaction (WAL).
Il peut être difficile d'estimer à l'avance l'espace dont vous aurez besoin. La meilleure chose à faire est de prendre quelques sauvegardes puis d'enregistrer la taille des différents types de sauvegardes (full/incr/diff) et de mesurer la quantité de WAL générée par jour. Cela vous donnera une idée générale de l'espace dont vous aurez besoin, même si, bien sûr, les besoins changeront probablement au fil du temps, à fur et à mesure de l'évolution de votre base de données.
default: /var/lib/pgbackrest
example: --repo1-path=/backup/db/backrest
S3 dépôt bucket.
Bucket S3 utilisé pour stocker le dépôt.
Les dépots pgBackRest peuvent être stockés à la racine du bucket en définissant repo-path=/ mais il est généralement préférable de spécifier un préfixe, comme par exemple /repo, afin que les logs et autres contenus générés par AWS puissent également être stockés dans le bucket.
example: --repo1-s3-bucket=pg-backup
Ficher SSL CA S3.
Utiliser un fichier CA autre que celui défini par défaut dans le système.
example: --repo1-s3-ca-file=/etc/pki/tls/certs/ca-bundle.crt
Chemin S3 SSL CA.
Utiliser un chemin pour le CA autre que celui défini par défaut dans le système.
example: --repo1-s3-ca-path=/etc/pki/tls/certs
Dépot S3 Point de terminaison (endpoint).
Le point de terminaison d'AWS doit être valable pour la région sélectionnée.
example: --repo1-s3-endpoint=s3.amazonaws.com
Hôte du dépot S3.
Conntecter sur un hôte différent du point de terminaison (endpoint). Il est généralement utilisé à des fins de test.
example: --repo1-s3-host=127.0.0.1
Port de connection au dépot S3.
Port à utiliser lors de la connexion au point de terminaison (ou à l'hôte si spécifié).
default: 443
allowed: 1-65535
example: --repo1-s3-port=9000
Région du dépôt S3.
La région d'AWS où le bucket a été créé.
example: --repo1-s3-region=us-east-1
S3 URI formats.
Les formats URI suivants sont pris en charge:
- host - Connexion à l'hôte bucket.endpoint.
- path - Connexion à l'hôte endpoint et ajout du bucket aux URIs.
default: host
example: --repo1-s3-uri-style=path
Vérifier le certificat du serveur S3.
Désactive la vérification du certificat du serveur S3. Cette fonction ne doit être utilisée que dans le cadre de tests ou dans le cas d'une utilisation avec un certificat a été auto-signé.
default: y
example: --no-repo1-s3-verify-tls
Nom obsolète: repo-s3-verify-ssl
Type de stockage utilisé pour le dépôt.
Les types de stockage suivants sont pris en charge :
- cifs - Comme posix, mais désactive les liens et les fsyncs sur les répertoires
- posix - Systèmes de fichiers conformes à Posix
- s3 - Service de stockage d'objet (AWS Simple Storage Service)
default: posix
example: --repo1-type=cifs
Hôte PostgreSQL pour les opérations à distance via SSH.
Utilisé pour les sauvegardes lorsque l'hôte PostgreSQL est différent de l'hôte du dépôt.
example: --pg1-host=db.domain.com
Nom obsolète: db-host
Emplacement des exécutable pgBackRest sur l'hôte PostgreSQL.
Uniquement requis si le chemin vers pgbackrest est différent sur le serveur local et PostgreSQL. S'il n'est pas défini, le chemin de l'pgbackrest de l'hôte de la base de données sera le même que le chemin de l'pgbackrest local.
example: --pg1-host-cmd=/usr/lib/backrest/bin/pgbackrest
Nom obsolète: db-cmd
pgBackRest database host configuration file.
Définit l'emplacement du fichier de configuration sur l'hôte PostgreSQL. Ceci n'est requis que si le fichier de configuration de l'hôte PostgreSQL se trouve dans un emplacement différent de celui du fichier de configuration local.
default: /etc/pgbackrest/pgbackrest.conf
example: --pg1-host-config=/conf/pgbackrest/pgbackrest.conf
Nom obsolète: db-config
Chemin d'inclusion de la configuration pgBackRest sur l'hôte.
Définit l'emplacement du chemin d'inclusion de la configuration sur l'hôte PostgreSQL. Ceci n'est requis que si le chemin d'inclusion de la configuration de l'hôte PostgreSQL se trouve à un endroit différent du chemin d'inclusion de la configuration locale.
default: /etc/pgbackrest/conf.d
example: --pg1-host-config-include-path=/conf/pgbackrest/conf.d
Chemin de configuration pgBackRest de l'hôte de base de données.
Définit l'emplacement du chemin de configuration sur l'hôte PostgreSQL. Ceci n'est requis que si le chemin de configuration de l'hôte PostgreSQL se trouve dans un emplacement différent du chemin de configuration local.
default: /etc/pgbackrest
example: --pg1-host-config-path=/conf/pgbackrest
Port de l'hôte PostgreSQL lorsque pg-host est configuré.
Utiliser cette option pour spécifier un port non par défaut pour le protocole hôte PostgreSQL. Actuellement, seul le protocole SSH est pris en charge
allowed: 0-65535
example: --pg1-host-port=25
Nom obsolète: db-ssh-port
Utilisateur de connexion PostgreSQL lorsque pg-host est défini.
Cet utilisateur sera également propriétaire du processus distant pgBackRest et initiera les connexions à PostgreSQL. Pour que cela puisse fonctionner correctement, l'utilisateur doit être le propriétaire de l'instance de base de données PostgreSQL, qui est généralement par défaut postgres.
default: postgres
example: --pg1-host-user=db_owner
Nom obsolète: db-user
PostgreSQL data directory.
Ce paramètre doit être le même que le paramètre data_directory du fichier postgresql.conf. Même si cette valeur peut être lue à partir de postgresql.conf ou PostgreSQL, il est conseillé de la définir au cas où ces ressources ne seraient pas disponibles pendant un scénario de restauration ou de sauvegarde hors ligne.
L'option pg-path est testée par rapport à la valeur indiquée par PostgreSQL à chaque sauvegarde en ligne, elle doit donc toujours être à jour.
example: --pg1-path=/data/db
Nom obsolète: db-path
Port PostgreSQL.
Port sur lequel PostgreSQL écoute. Il n'est généralement pas nécessaire de le préciser car la plupart des instances PostgreSQL fonctionnent sur le port par défaut.
default: 5432
allowed: 0-65535
example: --pg1-port=6543
Nom obsolète: db-port
Emplacement socket unix PostgreSQL.
Le répertoire de la socket unix qui a été spécifié au démarrage de PostgreSQL. pgBackRest trouvera automatiquement l'emplacement standard pour votre système d'exploitation, il n'est donc généralement pas nécessaire de spécifier ce paramètre, sauf si le répertoire des sockets a été explicitement modifié avec le paramètre unix_socket_directory dans postgresql.conf.
allowed: 0-65535
example: --pg1-socket-path=/var/run/postgresql
Nom obsolète: db-socket-path
Nom d'utilisateur de base de données PostgreSQL.
Le nom d'utilisateur de la base de données utilisé lors de la connexion à PostgreSQL. S'il n'est pas spécifié, pgBackRest se connectera avec l'utilisateur du système d'exploitation local ou PGUSER.
example: --pg1-user=backupuser
La commande
stanza-delete supprime les données du dépôt associé au stanza.
WARNING:
Utilisez cette commande avec précaution — elle supprimera définitivement toutes les sauvegardes et archives du dépôt pgBackRest pour la stanza spécifiée.
Pour supprimer un stanza:
- Arrêter l'instance PostgreSQL associé au stanza (ou utiliser l'option --force pour passer outre).
- Exécuter la commande stop sur l'hôte du dépôt.
- Exécuter la commande stanza-delete sur l'hôte du dépôt.
Une fois la commande terminée avec succès, il incombe à l'utilisateur de supprimer de la configuration
pgBackRest le stanza.
Forcer la suppression du stanzadu réferentiel.
Si PostgreSQL est toujours en cours d'exécution pour le stanza, alors cette option peut être utilisée pour forcer sa suppression du référentiel.
default: n
example: --no-force
Taille de la mémoire tampon pour les opérations sur les fichiers.
Définissez la taille de la mémoire tampon utilisée pour les opérations de copie, de compression et de décompression. Un maximum de 3 tampons seront utilisés à la fois par processus. Un maximum supplémentaire de 256K par processus peut être utilisé pour les tampons zlib.
La taille peut être saisie en octets (par défaut) ou en KB, MB, GB, TB, ou PB où le multiplicateur est une puissance de 1024. Par exemple, la valeur insensible à la casse 32k (ou 32KB) peut être utilisée au lieu de 32768.
Les valeurs autorisées, en octets, sont16384, 32768, 65536, 131072, 262144, 524288, 1048576, 2097152, 4194304, 8388608, et 16777216.
default: 1048576
example: --buffer-size=32K
Chemin d'accès à l'exécutable du client ssh.
Utilisez un client SSH spécifique lorsqu'une alternative est nécessaire ou lorsque l'exécutable ssh n'est pas dans $PATH.
default: ssh
example: --cmd-ssh=/usr/bin/ssh
Niveau de compression du réseau.
Définit le niveau de compression sur le réseau, lorsque compress-type=none et que la commande n'est pas exécutée sur le même hôte que le dépôt. La compression est utilisée pour réduire le trafic réseau mais peut être désactivée en définissant compress-level-network=0. Lorsque compress-type n'est pas égal à none, le paramètre compress-level-network est ignoré et compress-level est utilisé à la place de sorte que le fichier ne soit compressé qu'une seule fois. La compression SSH est toujours désactivée.
default: 3
allowed: 0-9
example: --compress-level-network=1
Fichier de configuration pgBackRest.
Utiliser cette option pour spécifier un fichier de configuration différent de celui par défaut.
default: /etc/pgbackrest/pgbackrest.conf
example: --config=/conf/pgbackrest/pgbackrest.conf
Emplacement des fichiers de configuration pgBackRest supplémentaires..
Les fichiers de configuration existant à l'emplacement spécifié avec l'extension .conf seront concaténés avec le fichier de configuration pgBackRest, ce qui donne un seul fichier de configuration.
default: /etc/pgbackrest/conf.d
example: --config-include-path=/conf/pgbackrest/conf.d
Emplacement du répertoire de racine de pgBackRest des fichiers de configuration.
Ce paramètre est utilisé pour écraser le chemin racine par défaut pour les options --config et --config-include-path à moins qu'elles ne soient explicitement définies sur la ligne de commande.
Par exemple, en utilisant uniquement --config-path=/conf/pgbackrest, la valeur par défaut de --config est /conf/pgbackrest/pgbackrest.conf et la valeur par défaut de --config-include-path est /conf/pgbackrest/conf.d.
default: /etc/pgbackrest
example: --config-path=/conf/pgbackrest
Délai d'attente des requêtes à la base de données.
Définit le délai d'attente, en secondes, pour les interrogations de la base de données. Cela inclut les fonctions
pg_start_backup() et
pg_stop_backup() qui peuvent chacune prendre un temps considérable. C'est pourquoi le délai d'attente doit être maintenu à un niveau élevé, sauf si vous savez que ces fonctions retourneront rapidement (c'est-à-dire si vous avez défini
startfast=y et que vous savez que l'instance de base de données ne générera pas beaucoup de segments WAL pendant la sauvegarde).
NOTE:
L'option db-timeout doit être inférieure à l'option protocol-timeout.
default: 1800
allowed: 0.1-604800
example: --db-timeout=600
Délai d'attente E/S.
Délai d'attente, en secondes, utilisé pour les connexions et les opérations de lecture/écriture.
Notez que l'ensemble de l'opération de lecture/écriture n'a pas besoin de se terminer dans ce délai mais une progression doit être constatée, même s'il ne s'agit que d'un seul octet.
default: 60
allowed: 0.1-3600
example: --io-timeout=120
Chemin d'accès où sont stockés les fichiers de verrouillage.
Le chemin de verrouillage fournit l'emplacement à pgBackRest pour créer des fichiers de verrouillage afin d'éviter que des opérations en conflictuelles ne soient exécutées simultanément.
default: /tmp/pgbackrest
example: --lock-path=/backup/db/lock
Utilisation d'un umask
neutre
Définit l'umask à 0000 pour que les modes dans le dépôt de sauvegarde soient créés de manière appropriée. Le mode par défaut du répertoire est 0750 et le mode par défaut du fichier est 0640. Pour les répertoires lock et log, les modes de répertoire et de fichier sont respectivement fixés à 0770 et 0660.
Pour utiliser l'umask de l'utilisateur en cours d'exécution, spécifiez plutôt neutral-umask=n dans le fichier de configuration ou --no-neutral-umask sur la ligne de commande.
default: y
example: --no-neutral-umask
Délai d'attente du protocole.
Définit le délai, en secondes, durant lequel le processus local ou distant attendra qu'un nouveau message soit reçu au niveau de la couche protocole. Cela permet d'éviter que les processus n'attendent indéfiniment un message.
NOTE:
L'option protocol-timeout doit être supérieure à celle de db-timeout option.
default: 1830
allowed: 0.1-604800
example: --protocol-timeout=630
Activation de la fonction de keep-alive (maintien en vie).
Activation des messages de keep-alive (maintien en vie) sur les connexions réseaux.
default: y
example: --no-sck-keep-alive
Defines the stanza.
Un stanza est la configuration de la sauvegarde d'une instance PostgreSQL où est définit l'endroit où il se trouve, la façon dont il sera sauvegardé, les options d'archivage, etc... La plupart des serveurs de base de données n'auront qu'une seule instance PostgreSQL et donc un stanza alors que les serveurs de sauvegarde auront un stanza pour chaque instance de base de données qui doit être sauvegardé.
Il est tentant de nommer le stanza en référence à l'instance primaire, mais un meilleur nom décrirait les bases de données contenues dans l'instance : comme le nom du stanza sera utilisé pour le primaire et tous les secondaire, il est plus approprié de choisir un nom qui décrit la fonction réelle du groupe d'instances, comme app ou dw, plutôt que le nom local de l'instance, comme main ou prod.
example: --stanza=main
Compteur Keep-alive.
Spécifie le nombre de messages TCP à garder en mémoire qui peuvent être perdus avant que la connexion ne soit considérée comme morte.
Cette option n'est disponible que sur les systèmes qui prennent en charge l'option réseau TCP_KEEPCNT.
allowed: 1-32
example: --tcp-keep-alive-count=3
Temps d'inactivité du keepalive.
Spécifie la durée (en secondes) sans activité du réseau après laquelle le système d'exploitation doit envoyer un message TCP de maintien en activité (keep-alive).
Cette option n'est disponible que sur les systèmes qui prennent en charge l'option réseau TCP_KEEPIDLE.
allowed: 1-3600
example: --tcp-keep-alive-idle=60
Temps d'intervalle de maintien en vie (keep-alive).
Spécifie le temps (en secondes) après lequel un message TCP de maintien en activité (keep-alive) non acquitté doit être retransmis.
Cette option n'est disponible que sur les systèmes qui prennent en charge l'option réseau TCP_KEEPINTVL.
allowed: 1-900
example: --tcp-keep-alive-interval=30
Niveau de journalisation en sortie sur la console.
Les niveaux de traces suivants sont pris en charge:
- off - Pas de journal de traces (non recommandé)
- error - Journaliser uniquement les erreurs
- warn - Journaliser les avertissements et les erreurs
- info - Journaliser les messages d'information, les avertissements et les erreurs
- detail - Journaliser les détails, les messages d'information, les avertissements et les erreurs
- debug - Journaliser les message de Débogage, les détails, les messages d'information, les avertissements et les erreurs
- trace - Journaliser les traces (un débogage très verbeux), les message de Débogage, les détails, les messages d'information, les avertissements et les erreurs
default: warn
example: --log-level-console=error
Niveau d'enregistrement des traces lors de l'enregistrement sur fichier.
Les niveaux de traces suivants sont pris en charge:
- off - Pas de journal de traces (non recommandé)
- error - Journaliser uniquement les erreurs
- warn - Journaliser les avertissements et les erreurs
- info - Journaliser les messages d'information, les avertissements et les erreurs
- detail - Journaliser les détails, les messages d'information, les avertissements et les erreurs
- debug - Journaliser les message de Débogage, les détails, les messages d'information, les avertissements et les erreurs
- trace - Journaliser les traces (un débogage très verbeux), les message de Débogage, les détails, les messages d'information, les avertissements et les erreurs
default: info
example: --log-level-file=debug
Niveau de traces sur la sortie console stderr.
Spécifie les niveaux de traces qui sortiront en
stderr plutôt que
stdout (spécifié par
log-level-console). L'horodatage et le processus ne seront pas émis sur
stderr.
Les niveaux de traces suivants sont pris en charge:
- off - Pas de journal de traces (non recommandé)
- error - Journaliser uniquement les erreurs
- warn - Journaliser les avertissements et les erreurs
- info - Journaliser les messages d'information, les avertissements et les erreurs
- detail - Journaliser les détails, les messages d'information, les avertissements et les erreurs
- debug - Journaliser les message de Débogage, les détails, les messages d'information, les avertissements et les erreurs
- trace - Journaliser les traces (un débogage très verbeux), les message de Débogage, les détails, les messages d'information, les avertissements et les erreurs
default: warn
example: --log-level-stderr=error
Emplacement où les fichiers journaux de traces sont stockés.
Le chemin d'accès au journal fournit un emplacement pour pgBackRest pour stocker les fichiers journaux. Notez que si log-level-file=off alors aucun chemin pour l'emplacement des journaux de traces n'est nécessaire.
default: /var/log/pgbackrest
example: --log-path=/backup/db/log
Activer la journalisation des traces dans les sous-processus.
Activez la journalisation des traces dans les fichiers pour tous les sous-processus créés par ce processus en utilisant le niveau de journalisation spécifié par log-level-file.
default: n
example: --log-subprocess
Activer l'horodatage dans les traces.
Active l'horodatage dans la console et l'enregistrement des fichiers. Cette option est désactivée dans des situations particulières telles que la génération de documentation.
default: y
example: --no-log-timestamp
Chiffrement (cipher) utilisé pour chiffrer le dépôt.
Les types de chiffrement suivants sont pris en charge:
- none - Le dépôt n'est pas chiffré.
- aes-256-cbc - Advanced Encryption Standard avec une clef de 256 bit
À noter que le chiffrement est toujours effectué côté client même si le type de stockage (par exemple S3) supporte le chiffrement.
default: none
example: --repo1-cipher-type=aes-256-cbc
Chemin d'accès où sont stockées les sauvegardes et les archives.
Le dépôt est l'endroit où pgBackRest stocke les sauvegardes et archive les segments des journaux de transaction (WAL).
Il peut être difficile d'estimer à l'avance l'espace dont vous aurez besoin. La meilleure chose à faire est de prendre quelques sauvegardes puis d'enregistrer la taille des différents types de sauvegardes (full/incr/diff) et de mesurer la quantité de WAL générée par jour. Cela vous donnera une idée générale de l'espace dont vous aurez besoin, même si, bien sûr, les besoins changeront probablement au fil du temps, à fur et à mesure de l'évolution de votre base de données.
default: /var/lib/pgbackrest
example: --repo1-path=/backup/db/backrest
S3 dépôt bucket.
Bucket S3 utilisé pour stocker le dépôt.
Les dépots pgBackRest peuvent être stockés à la racine du bucket en définissant repo-path=/ mais il est généralement préférable de spécifier un préfixe, comme par exemple /repo, afin que les logs et autres contenus générés par AWS puissent également être stockés dans le bucket.
example: --repo1-s3-bucket=pg-backup
Ficher SSL CA S3.
Utiliser un fichier CA autre que celui défini par défaut dans le système.
example: --repo1-s3-ca-file=/etc/pki/tls/certs/ca-bundle.crt
Chemin S3 SSL CA.
Utiliser un chemin pour le CA autre que celui défini par défaut dans le système.
example: --repo1-s3-ca-path=/etc/pki/tls/certs
Dépot S3 Point de terminaison (endpoint).
Le point de terminaison d'AWS doit être valable pour la région sélectionnée.
example: --repo1-s3-endpoint=s3.amazonaws.com
Hôte du dépot S3.
Conntecter sur un hôte différent du point de terminaison (endpoint). Il est généralement utilisé à des fins de test.
example: --repo1-s3-host=127.0.0.1
Port de connection au dépot S3.
Port à utiliser lors de la connexion au point de terminaison (ou à l'hôte si spécifié).
default: 443
allowed: 1-65535
example: --repo1-s3-port=9000
Région du dépôt S3.
La région d'AWS où le bucket a été créé.
example: --repo1-s3-region=us-east-1
S3 URI formats.
Les formats URI suivants sont pris en charge:
- host - Connexion à l'hôte bucket.endpoint.
- path - Connexion à l'hôte endpoint et ajout du bucket aux URIs.
default: host
example: --repo1-s3-uri-style=path
Vérifier le certificat du serveur S3.
Désactive la vérification du certificat du serveur S3. Cette fonction ne doit être utilisée que dans le cadre de tests ou dans le cas d'une utilisation avec un certificat a été auto-signé.
default: y
example: --no-repo1-s3-verify-tls
Nom obsolète: repo-s3-verify-ssl
Type de stockage utilisé pour le dépôt.
Les types de stockage suivants sont pris en charge :
- cifs - Comme posix, mais désactive les liens et les fsyncs sur les répertoires
- posix - Systèmes de fichiers conformes à Posix
- s3 - Service de stockage d'objet (AWS Simple Storage Service)
default: posix
example: --repo1-type=cifs
Hôte PostgreSQL pour les opérations à distance via SSH.
Utilisé pour les sauvegardes lorsque l'hôte PostgreSQL est différent de l'hôte du dépôt.
example: --pg1-host=db.domain.com
Nom obsolète: db-host
Emplacement des exécutable pgBackRest sur l'hôte PostgreSQL.
Uniquement requis si le chemin vers pgbackrest est différent sur le serveur local et PostgreSQL. S'il n'est pas défini, le chemin de l'pgbackrest de l'hôte de la base de données sera le même que le chemin de l'pgbackrest local.
example: --pg1-host-cmd=/usr/lib/backrest/bin/pgbackrest
Nom obsolète: db-cmd
pgBackRest database host configuration file.
Définit l'emplacement du fichier de configuration sur l'hôte PostgreSQL. Ceci n'est requis que si le fichier de configuration de l'hôte PostgreSQL se trouve dans un emplacement différent de celui du fichier de configuration local.
default: /etc/pgbackrest/pgbackrest.conf
example: --pg1-host-config=/conf/pgbackrest/pgbackrest.conf
Nom obsolète: db-config
Chemin d'inclusion de la configuration pgBackRest sur l'hôte.
Définit l'emplacement du chemin d'inclusion de la configuration sur l'hôte PostgreSQL. Ceci n'est requis que si le chemin d'inclusion de la configuration de l'hôte PostgreSQL se trouve à un endroit différent du chemin d'inclusion de la configuration locale.
default: /etc/pgbackrest/conf.d
example: --pg1-host-config-include-path=/conf/pgbackrest/conf.d
Chemin de configuration pgBackRest de l'hôte de base de données.
Définit l'emplacement du chemin de configuration sur l'hôte PostgreSQL. Ceci n'est requis que si le chemin de configuration de l'hôte PostgreSQL se trouve dans un emplacement différent du chemin de configuration local.
default: /etc/pgbackrest
example: --pg1-host-config-path=/conf/pgbackrest
Port de l'hôte PostgreSQL lorsque pg-host est configuré.
Utiliser cette option pour spécifier un port non par défaut pour le protocole hôte PostgreSQL. Actuellement, seul le protocole SSH est pris en charge
allowed: 0-65535
example: --pg1-host-port=25
Nom obsolète: db-ssh-port
Utilisateur de connexion PostgreSQL lorsque pg-host est défini.
Cet utilisateur sera également propriétaire du processus distant pgBackRest et initiera les connexions à PostgreSQL. Pour que cela puisse fonctionner correctement, l'utilisateur doit être le propriétaire de l'instance de base de données PostgreSQL, qui est généralement par défaut postgres.
default: postgres
example: --pg1-host-user=db_owner
Nom obsolète: db-user
PostgreSQL data directory.
Ce paramètre doit être le même que le paramètre data_directory du fichier postgresql.conf. Même si cette valeur peut être lue à partir de postgresql.conf ou PostgreSQL, il est conseillé de la définir au cas où ces ressources ne seraient pas disponibles pendant un scénario de restauration ou de sauvegarde hors ligne.
L'option pg-path est testée par rapport à la valeur indiquée par PostgreSQL à chaque sauvegarde en ligne, elle doit donc toujours être à jour.
example: --pg1-path=/data/db
Nom obsolète: db-path
Port PostgreSQL.
Port sur lequel PostgreSQL écoute. Il n'est généralement pas nécessaire de le préciser car la plupart des instances PostgreSQL fonctionnent sur le port par défaut.
default: 5432
allowed: 0-65535
example: --pg1-port=6543
Nom obsolète: db-port
Emplacement socket unix PostgreSQL.
Le répertoire de la socket unix qui a été spécifié au démarrage de PostgreSQL. pgBackRest trouvera automatiquement l'emplacement standard pour votre système d'exploitation, il n'est donc généralement pas nécessaire de spécifier ce paramètre, sauf si le répertoire des sockets a été explicitement modifié avec le paramètre unix_socket_directory dans postgresql.conf.
allowed: 0-65535
example: --pg1-socket-path=/var/run/postgresql
Nom obsolète: db-socket-path
Nom d'utilisateur de base de données PostgreSQL.
Le nom d'utilisateur de la base de données utilisé lors de la connexion à PostgreSQL. S'il n'est pas spécifié, pgBackRest se connectera avec l'utilisateur du système d'exploitation local ou PGUSER.
example: --pg1-user=backupuser
Immédiatement après la mise à niveau de PostgreSQL vers une nouvelle version majeure, le chemin pg-path pour toute la configuration de pgBackRest doit être défini sur le nouvel emplacement de la base de données et la commande stanza-upgrade doit être exécuté sur l'hôte du dépôt. Si l'instance PostgreSQL est hors ligne, utilisez l'option --no-online.
Sauvegarde depuis l'instance standby secondaire.
Activer la sauvegarde depuis le secondaire en standby pour réduire la charge sur l'instance primaire. Cette option nécessite que les hôtes primary (primaire) et standby (secondaire en standby) soit correctement configurés.
default: n
example: --backup-standby
Mettre à jour une instance en ligne.
Le fait de spécifier --no-online empêche pgBackRest de se connecter à PostgreSQL lors de la mise à jour du stanza.
default: y
example: --no-online
Taille de la mémoire tampon pour les opérations sur les fichiers.
Définissez la taille de la mémoire tampon utilisée pour les opérations de copie, de compression et de décompression. Un maximum de 3 tampons seront utilisés à la fois par processus. Un maximum supplémentaire de 256K par processus peut être utilisé pour les tampons zlib.
La taille peut être saisie en octets (par défaut) ou en KB, MB, GB, TB, ou PB où le multiplicateur est une puissance de 1024. Par exemple, la valeur insensible à la casse 32k (ou 32KB) peut être utilisée au lieu de 32768.
Les valeurs autorisées, en octets, sont16384, 32768, 65536, 131072, 262144, 524288, 1048576, 2097152, 4194304, 8388608, et 16777216.
default: 1048576
example: --buffer-size=32K
Chemin d'accès à l'exécutable du client ssh.
Utilisez un client SSH spécifique lorsqu'une alternative est nécessaire ou lorsque l'exécutable ssh n'est pas dans $PATH.
default: ssh
example: --cmd-ssh=/usr/bin/ssh
Niveau de compression du réseau.
Définit le niveau de compression sur le réseau, lorsque compress-type=none et que la commande n'est pas exécutée sur le même hôte que le dépôt. La compression est utilisée pour réduire le trafic réseau mais peut être désactivée en définissant compress-level-network=0. Lorsque compress-type n'est pas égal à none, le paramètre compress-level-network est ignoré et compress-level est utilisé à la place de sorte que le fichier ne soit compressé qu'une seule fois. La compression SSH est toujours désactivée.
default: 3
allowed: 0-9
example: --compress-level-network=1
Fichier de configuration pgBackRest.
Utiliser cette option pour spécifier un fichier de configuration différent de celui par défaut.
default: /etc/pgbackrest/pgbackrest.conf
example: --config=/conf/pgbackrest/pgbackrest.conf
Emplacement des fichiers de configuration pgBackRest supplémentaires..
Les fichiers de configuration existant à l'emplacement spécifié avec l'extension .conf seront concaténés avec le fichier de configuration pgBackRest, ce qui donne un seul fichier de configuration.
default: /etc/pgbackrest/conf.d
example: --config-include-path=/conf/pgbackrest/conf.d
Emplacement du répertoire de racine de pgBackRest des fichiers de configuration.
Ce paramètre est utilisé pour écraser le chemin racine par défaut pour les options --config et --config-include-path à moins qu'elles ne soient explicitement définies sur la ligne de commande.
Par exemple, en utilisant uniquement --config-path=/conf/pgbackrest, la valeur par défaut de --config est /conf/pgbackrest/pgbackrest.conf et la valeur par défaut de --config-include-path est /conf/pgbackrest/conf.d.
default: /etc/pgbackrest
example: --config-path=/conf/pgbackrest
Délai d'attente des requêtes à la base de données.
Définit le délai d'attente, en secondes, pour les interrogations de la base de données. Cela inclut les fonctions
pg_start_backup() et
pg_stop_backup() qui peuvent chacune prendre un temps considérable. C'est pourquoi le délai d'attente doit être maintenu à un niveau élevé, sauf si vous savez que ces fonctions retourneront rapidement (c'est-à-dire si vous avez défini
startfast=y et que vous savez que l'instance de base de données ne générera pas beaucoup de segments WAL pendant la sauvegarde).
NOTE:
L'option db-timeout doit être inférieure à l'option protocol-timeout.
default: 1800
allowed: 0.1-604800
example: --db-timeout=600
Délai d'attente E/S.
Délai d'attente, en secondes, utilisé pour les connexions et les opérations de lecture/écriture.
Notez que l'ensemble de l'opération de lecture/écriture n'a pas besoin de se terminer dans ce délai mais une progression doit être constatée, même s'il ne s'agit que d'un seul octet.
default: 60
allowed: 0.1-3600
example: --io-timeout=120
Chemin d'accès où sont stockés les fichiers de verrouillage.
Le chemin de verrouillage fournit l'emplacement à pgBackRest pour créer des fichiers de verrouillage afin d'éviter que des opérations en conflictuelles ne soient exécutées simultanément.
default: /tmp/pgbackrest
example: --lock-path=/backup/db/lock
Utilisation d'un umask
neutre
Définit l'umask à 0000 pour que les modes dans le dépôt de sauvegarde soient créés de manière appropriée. Le mode par défaut du répertoire est 0750 et le mode par défaut du fichier est 0640. Pour les répertoires lock et log, les modes de répertoire et de fichier sont respectivement fixés à 0770 et 0660.
Pour utiliser l'umask de l'utilisateur en cours d'exécution, spécifiez plutôt neutral-umask=n dans le fichier de configuration ou --no-neutral-umask sur la ligne de commande.
default: y
example: --no-neutral-umask
Délai d'attente du protocole.
Définit le délai, en secondes, durant lequel le processus local ou distant attendra qu'un nouveau message soit reçu au niveau de la couche protocole. Cela permet d'éviter que les processus n'attendent indéfiniment un message.
NOTE:
L'option protocol-timeout doit être supérieure à celle de db-timeout option.
default: 1830
allowed: 0.1-604800
example: --protocol-timeout=630
Activation de la fonction de keep-alive (maintien en vie).
Activation des messages de keep-alive (maintien en vie) sur les connexions réseaux.
default: y
example: --no-sck-keep-alive
Defines the stanza.
Un stanza est la configuration de la sauvegarde d'une instance PostgreSQL où est définit l'endroit où il se trouve, la façon dont il sera sauvegardé, les options d'archivage, etc... La plupart des serveurs de base de données n'auront qu'une seule instance PostgreSQL et donc un stanza alors que les serveurs de sauvegarde auront un stanza pour chaque instance de base de données qui doit être sauvegardé.
Il est tentant de nommer le stanza en référence à l'instance primaire, mais un meilleur nom décrirait les bases de données contenues dans l'instance : comme le nom du stanza sera utilisé pour le primaire et tous les secondaire, il est plus approprié de choisir un nom qui décrit la fonction réelle du groupe d'instances, comme app ou dw, plutôt que le nom local de l'instance, comme main ou prod.
example: --stanza=main
Compteur Keep-alive.
Spécifie le nombre de messages TCP à garder en mémoire qui peuvent être perdus avant que la connexion ne soit considérée comme morte.
Cette option n'est disponible que sur les systèmes qui prennent en charge l'option réseau TCP_KEEPCNT.
allowed: 1-32
example: --tcp-keep-alive-count=3
Temps d'inactivité du keepalive.
Spécifie la durée (en secondes) sans activité du réseau après laquelle le système d'exploitation doit envoyer un message TCP de maintien en activité (keep-alive).
Cette option n'est disponible que sur les systèmes qui prennent en charge l'option réseau TCP_KEEPIDLE.
allowed: 1-3600
example: --tcp-keep-alive-idle=60
Temps d'intervalle de maintien en vie (keep-alive).
Spécifie le temps (en secondes) après lequel un message TCP de maintien en activité (keep-alive) non acquitté doit être retransmis.
Cette option n'est disponible que sur les systèmes qui prennent en charge l'option réseau TCP_KEEPINTVL.
allowed: 1-900
example: --tcp-keep-alive-interval=30
Niveau de journalisation en sortie sur la console.
Les niveaux de traces suivants sont pris en charge:
- off - Pas de journal de traces (non recommandé)
- error - Journaliser uniquement les erreurs
- warn - Journaliser les avertissements et les erreurs
- info - Journaliser les messages d'information, les avertissements et les erreurs
- detail - Journaliser les détails, les messages d'information, les avertissements et les erreurs
- debug - Journaliser les message de Débogage, les détails, les messages d'information, les avertissements et les erreurs
- trace - Journaliser les traces (un débogage très verbeux), les message de Débogage, les détails, les messages d'information, les avertissements et les erreurs
default: warn
example: --log-level-console=error
Niveau d'enregistrement des traces lors de l'enregistrement sur fichier.
Les niveaux de traces suivants sont pris en charge:
- off - Pas de journal de traces (non recommandé)
- error - Journaliser uniquement les erreurs
- warn - Journaliser les avertissements et les erreurs
- info - Journaliser les messages d'information, les avertissements et les erreurs
- detail - Journaliser les détails, les messages d'information, les avertissements et les erreurs
- debug - Journaliser les message de Débogage, les détails, les messages d'information, les avertissements et les erreurs
- trace - Journaliser les traces (un débogage très verbeux), les message de Débogage, les détails, les messages d'information, les avertissements et les erreurs
default: info
example: --log-level-file=debug
Niveau de traces sur la sortie console stderr.
Spécifie les niveaux de traces qui sortiront en
stderr plutôt que
stdout (spécifié par
log-level-console). L'horodatage et le processus ne seront pas émis sur
stderr.
Les niveaux de traces suivants sont pris en charge:
- off - Pas de journal de traces (non recommandé)
- error - Journaliser uniquement les erreurs
- warn - Journaliser les avertissements et les erreurs
- info - Journaliser les messages d'information, les avertissements et les erreurs
- detail - Journaliser les détails, les messages d'information, les avertissements et les erreurs
- debug - Journaliser les message de Débogage, les détails, les messages d'information, les avertissements et les erreurs
- trace - Journaliser les traces (un débogage très verbeux), les message de Débogage, les détails, les messages d'information, les avertissements et les erreurs
default: warn
example: --log-level-stderr=error
Emplacement où les fichiers journaux de traces sont stockés.
Le chemin d'accès au journal fournit un emplacement pour pgBackRest pour stocker les fichiers journaux. Notez que si log-level-file=off alors aucun chemin pour l'emplacement des journaux de traces n'est nécessaire.
default: /var/log/pgbackrest
example: --log-path=/backup/db/log
Activer la journalisation des traces dans les sous-processus.
Activez la journalisation des traces dans les fichiers pour tous les sous-processus créés par ce processus en utilisant le niveau de journalisation spécifié par log-level-file.
default: n
example: --log-subprocess
Activer l'horodatage dans les traces.
Active l'horodatage dans la console et l'enregistrement des fichiers. Cette option est désactivée dans des situations particulières telles que la génération de documentation.
default: y
example: --no-log-timestamp
Chiffrement (cipher) utilisé pour chiffrer le dépôt.
Les types de chiffrement suivants sont pris en charge:
- none - Le dépôt n'est pas chiffré.
- aes-256-cbc - Advanced Encryption Standard avec une clef de 256 bit
À noter que le chiffrement est toujours effectué côté client même si le type de stockage (par exemple S3) supporte le chiffrement.
default: none
example: --repo1-cipher-type=aes-256-cbc
Chemin d'accès où sont stockées les sauvegardes et les archives.
Le dépôt est l'endroit où pgBackRest stocke les sauvegardes et archive les segments des journaux de transaction (WAL).
Il peut être difficile d'estimer à l'avance l'espace dont vous aurez besoin. La meilleure chose à faire est de prendre quelques sauvegardes puis d'enregistrer la taille des différents types de sauvegardes (full/incr/diff) et de mesurer la quantité de WAL générée par jour. Cela vous donnera une idée générale de l'espace dont vous aurez besoin, même si, bien sûr, les besoins changeront probablement au fil du temps, à fur et à mesure de l'évolution de votre base de données.
default: /var/lib/pgbackrest
example: --repo1-path=/backup/db/backrest
S3 dépôt bucket.
Bucket S3 utilisé pour stocker le dépôt.
Les dépots pgBackRest peuvent être stockés à la racine du bucket en définissant repo-path=/ mais il est généralement préférable de spécifier un préfixe, comme par exemple /repo, afin que les logs et autres contenus générés par AWS puissent également être stockés dans le bucket.
example: --repo1-s3-bucket=pg-backup
Ficher SSL CA S3.
Utiliser un fichier CA autre que celui défini par défaut dans le système.
example: --repo1-s3-ca-file=/etc/pki/tls/certs/ca-bundle.crt
Chemin S3 SSL CA.
Utiliser un chemin pour le CA autre que celui défini par défaut dans le système.
example: --repo1-s3-ca-path=/etc/pki/tls/certs
Dépot S3 Point de terminaison (endpoint).
Le point de terminaison d'AWS doit être valable pour la région sélectionnée.
example: --repo1-s3-endpoint=s3.amazonaws.com
Hôte du dépot S3.
Conntecter sur un hôte différent du point de terminaison (endpoint). Il est généralement utilisé à des fins de test.
example: --repo1-s3-host=127.0.0.1
Port de connection au dépot S3.
Port à utiliser lors de la connexion au point de terminaison (ou à l'hôte si spécifié).
default: 443
allowed: 1-65535
example: --repo1-s3-port=9000
Région du dépôt S3.
La région d'AWS où le bucket a été créé.
example: --repo1-s3-region=us-east-1
S3 URI formats.
Les formats URI suivants sont pris en charge:
- host - Connexion à l'hôte bucket.endpoint.
- path - Connexion à l'hôte endpoint et ajout du bucket aux URIs.
default: host
example: --repo1-s3-uri-style=path
Vérifier le certificat du serveur S3.
Désactive la vérification du certificat du serveur S3. Cette fonction ne doit être utilisée que dans le cadre de tests ou dans le cas d'une utilisation avec un certificat a été auto-signé.
default: y
example: --no-repo1-s3-verify-tls
Nom obsolète: repo-s3-verify-ssl
Type de stockage utilisé pour le dépôt.
Les types de stockage suivants sont pris en charge :
- cifs - Comme posix, mais désactive les liens et les fsyncs sur les répertoires
- posix - Systèmes de fichiers conformes à Posix
- s3 - Service de stockage d'objet (AWS Simple Storage Service)
default: posix
example: --repo1-type=cifs
Hôte PostgreSQL pour les opérations à distance via SSH.
Utilisé pour les sauvegardes lorsque l'hôte PostgreSQL est différent de l'hôte du dépôt.
example: --pg1-host=db.domain.com
Nom obsolète: db-host
Emplacement des exécutable pgBackRest sur l'hôte PostgreSQL.
Uniquement requis si le chemin vers pgbackrest est différent sur le serveur local et PostgreSQL. S'il n'est pas défini, le chemin de l'pgbackrest de l'hôte de la base de données sera le même que le chemin de l'pgbackrest local.
example: --pg1-host-cmd=/usr/lib/backrest/bin/pgbackrest
Nom obsolète: db-cmd
pgBackRest database host configuration file.
Définit l'emplacement du fichier de configuration sur l'hôte PostgreSQL. Ceci n'est requis que si le fichier de configuration de l'hôte PostgreSQL se trouve dans un emplacement différent de celui du fichier de configuration local.
default: /etc/pgbackrest/pgbackrest.conf
example: --pg1-host-config=/conf/pgbackrest/pgbackrest.conf
Nom obsolète: db-config
Chemin d'inclusion de la configuration pgBackRest sur l'hôte.
Définit l'emplacement du chemin d'inclusion de la configuration sur l'hôte PostgreSQL. Ceci n'est requis que si le chemin d'inclusion de la configuration de l'hôte PostgreSQL se trouve à un endroit différent du chemin d'inclusion de la configuration locale.
default: /etc/pgbackrest/conf.d
example: --pg1-host-config-include-path=/conf/pgbackrest/conf.d
Chemin de configuration pgBackRest de l'hôte de base de données.
Définit l'emplacement du chemin de configuration sur l'hôte PostgreSQL. Ceci n'est requis que si le chemin de configuration de l'hôte PostgreSQL se trouve dans un emplacement différent du chemin de configuration local.
default: /etc/pgbackrest
example: --pg1-host-config-path=/conf/pgbackrest
Port de l'hôte PostgreSQL lorsque pg-host est configuré.
Utiliser cette option pour spécifier un port non par défaut pour le protocole hôte PostgreSQL. Actuellement, seul le protocole SSH est pris en charge
allowed: 0-65535
example: --pg1-host-port=25
Nom obsolète: db-ssh-port
Utilisateur de connexion PostgreSQL lorsque pg-host est défini.
Cet utilisateur sera également propriétaire du processus distant pgBackRest et initiera les connexions à PostgreSQL. Pour que cela puisse fonctionner correctement, l'utilisateur doit être le propriétaire de l'instance de base de données PostgreSQL, qui est généralement par défaut postgres.
default: postgres
example: --pg1-host-user=db_owner
Nom obsolète: db-user
PostgreSQL data directory.
Ce paramètre doit être le même que le paramètre data_directory du fichier postgresql.conf. Même si cette valeur peut être lue à partir de postgresql.conf ou PostgreSQL, il est conseillé de la définir au cas où ces ressources ne seraient pas disponibles pendant un scénario de restauration ou de sauvegarde hors ligne.
L'option pg-path est testée par rapport à la valeur indiquée par PostgreSQL à chaque sauvegarde en ligne, elle doit donc toujours être à jour.
example: --pg1-path=/data/db
Nom obsolète: db-path
Port PostgreSQL.
Port sur lequel PostgreSQL écoute. Il n'est généralement pas nécessaire de le préciser car la plupart des instances PostgreSQL fonctionnent sur le port par défaut.
default: 5432
allowed: 0-65535
example: --pg1-port=6543
Nom obsolète: db-port
Emplacement socket unix PostgreSQL.
Le répertoire de la socket unix qui a été spécifié au démarrage de PostgreSQL. pgBackRest trouvera automatiquement l'emplacement standard pour votre système d'exploitation, il n'est donc généralement pas nécessaire de spécifier ce paramètre, sauf si le répertoire des sockets a été explicitement modifié avec le paramètre unix_socket_directory dans postgresql.conf.
allowed: 0-65535
example: --pg1-socket-path=/var/run/postgresql
Nom obsolète: db-socket-path
Nom d'utilisateur de base de données PostgreSQL.
Le nom d'utilisateur de la base de données utilisé lors de la connexion à PostgreSQL. S'il n'est pas spécifié, pgBackRest se connectera avec l'utilisateur du système d'exploitation local ou PGUSER.
example: --pg1-user=backupuser
Si les processus pgBackRest ont été précédemment arrêtés à l'aide de la commande stop, ils peuvent être relancés à l'aide de la commande start. Notez que cela ne démarrera pas immédiatement les processus pgBackRest mais ils seront autorisés à s'exécuter.
Chemin d'accès à l'exécutable du client ssh.
Utilisez un client SSH spécifique lorsqu'une alternative est nécessaire ou lorsque l'exécutable ssh n'est pas dans $PATH.
default: ssh
example: --cmd-ssh=/usr/bin/ssh
Fichier de configuration pgBackRest.
Utiliser cette option pour spécifier un fichier de configuration différent de celui par défaut.
default: /etc/pgbackrest/pgbackrest.conf
example: --config=/conf/pgbackrest/pgbackrest.conf
Emplacement des fichiers de configuration pgBackRest supplémentaires..
Les fichiers de configuration existant à l'emplacement spécifié avec l'extension .conf seront concaténés avec le fichier de configuration pgBackRest, ce qui donne un seul fichier de configuration.
default: /etc/pgbackrest/conf.d
example: --config-include-path=/conf/pgbackrest/conf.d
Emplacement du répertoire de racine de pgBackRest des fichiers de configuration.
Ce paramètre est utilisé pour écraser le chemin racine par défaut pour les options --config et --config-include-path à moins qu'elles ne soient explicitement définies sur la ligne de commande.
Par exemple, en utilisant uniquement --config-path=/conf/pgbackrest, la valeur par défaut de --config est /conf/pgbackrest/pgbackrest.conf et la valeur par défaut de --config-include-path est /conf/pgbackrest/conf.d.
default: /etc/pgbackrest
example: --config-path=/conf/pgbackrest
Chemin d'accès où sont stockés les fichiers de verrouillage.
Le chemin de verrouillage fournit l'emplacement à pgBackRest pour créer des fichiers de verrouillage afin d'éviter que des opérations en conflictuelles ne soient exécutées simultanément.
default: /tmp/pgbackrest
example: --lock-path=/backup/db/lock
Utilisation d'un umask
neutre
Définit l'umask à 0000 pour que les modes dans le dépôt de sauvegarde soient créés de manière appropriée. Le mode par défaut du répertoire est 0750 et le mode par défaut du fichier est 0640. Pour les répertoires lock et log, les modes de répertoire et de fichier sont respectivement fixés à 0770 et 0660.
Pour utiliser l'umask de l'utilisateur en cours d'exécution, spécifiez plutôt neutral-umask=n dans le fichier de configuration ou --no-neutral-umask sur la ligne de commande.
default: y
example: --no-neutral-umask
Defines the stanza.
Un stanza est la configuration de la sauvegarde d'une instance PostgreSQL où est définit l'endroit où il se trouve, la façon dont il sera sauvegardé, les options d'archivage, etc... La plupart des serveurs de base de données n'auront qu'une seule instance PostgreSQL et donc un stanza alors que les serveurs de sauvegarde auront un stanza pour chaque instance de base de données qui doit être sauvegardé.
Il est tentant de nommer le stanza en référence à l'instance primaire, mais un meilleur nom décrirait les bases de données contenues dans l'instance : comme le nom du stanza sera utilisé pour le primaire et tous les secondaire, il est plus approprié de choisir un nom qui décrit la fonction réelle du groupe d'instances, comme app ou dw, plutôt que le nom local de l'instance, comme main ou prod.
example: --stanza=main
Niveau de journalisation en sortie sur la console.
Les niveaux de traces suivants sont pris en charge:
- off - Pas de journal de traces (non recommandé)
- error - Journaliser uniquement les erreurs
- warn - Journaliser les avertissements et les erreurs
- info - Journaliser les messages d'information, les avertissements et les erreurs
- detail - Journaliser les détails, les messages d'information, les avertissements et les erreurs
- debug - Journaliser les message de Débogage, les détails, les messages d'information, les avertissements et les erreurs
- trace - Journaliser les traces (un débogage très verbeux), les message de Débogage, les détails, les messages d'information, les avertissements et les erreurs
default: warn
example: --log-level-console=error
Niveau d'enregistrement des traces lors de l'enregistrement sur fichier.
Les niveaux de traces suivants sont pris en charge:
- off - Pas de journal de traces (non recommandé)
- error - Journaliser uniquement les erreurs
- warn - Journaliser les avertissements et les erreurs
- info - Journaliser les messages d'information, les avertissements et les erreurs
- detail - Journaliser les détails, les messages d'information, les avertissements et les erreurs
- debug - Journaliser les message de Débogage, les détails, les messages d'information, les avertissements et les erreurs
- trace - Journaliser les traces (un débogage très verbeux), les message de Débogage, les détails, les messages d'information, les avertissements et les erreurs
default: info
example: --log-level-file=debug
Niveau de traces sur la sortie console stderr.
Spécifie les niveaux de traces qui sortiront en
stderr plutôt que
stdout (spécifié par
log-level-console). L'horodatage et le processus ne seront pas émis sur
stderr.
Les niveaux de traces suivants sont pris en charge:
- off - Pas de journal de traces (non recommandé)
- error - Journaliser uniquement les erreurs
- warn - Journaliser les avertissements et les erreurs
- info - Journaliser les messages d'information, les avertissements et les erreurs
- detail - Journaliser les détails, les messages d'information, les avertissements et les erreurs
- debug - Journaliser les message de Débogage, les détails, les messages d'information, les avertissements et les erreurs
- trace - Journaliser les traces (un débogage très verbeux), les message de Débogage, les détails, les messages d'information, les avertissements et les erreurs
default: warn
example: --log-level-stderr=error
Emplacement où les fichiers journaux de traces sont stockés.
Le chemin d'accès au journal fournit un emplacement pour pgBackRest pour stocker les fichiers journaux. Notez que si log-level-file=off alors aucun chemin pour l'emplacement des journaux de traces n'est nécessaire.
default: /var/log/pgbackrest
example: --log-path=/backup/db/log
Activer la journalisation des traces dans les sous-processus.
Activez la journalisation des traces dans les fichiers pour tous les sous-processus créés par ce processus en utilisant le niveau de journalisation spécifié par log-level-file.
default: n
example: --log-subprocess
Activer l'horodatage dans les traces.
Active l'horodatage dans la console et l'enregistrement des fichiers. Cette option est désactivée dans des situations particulières telles que la génération de documentation.
default: y
example: --no-log-timestamp
Chiffrement (cipher) utilisé pour chiffrer le dépôt.
Les types de chiffrement suivants sont pris en charge:
- none - Le dépôt n'est pas chiffré.
- aes-256-cbc - Advanced Encryption Standard avec une clef de 256 bit
À noter que le chiffrement est toujours effectué côté client même si le type de stockage (par exemple S3) supporte le chiffrement.
default: none
example: --repo1-cipher-type=aes-256-cbc
Hôte de dépôt dans le cas d'un fonctionnement à distance via SSH.
Assurez-vous que l'authentification SSH soit correctement approuvé entre l'hôte PostgreSQL et l'hôte du référentiel.
Ce paramètre n'est pas nécessaire pour la sauvegarde et l'archivage sur un système de fichiers monté localement.
example: --repo1-host=repo1.domain.com
Nom obsolète: backup-host
Chemin des binaires pgBackRest sur l'hôte du dépôt.
Nécessaire uniquement si le chemin d'accès à pgbackrest est différent entre les hôtes locaux et l'hote du dépôt. S'il n'est pas défini, le chemin des binaires sur l'hôte du dépôt sera le même que le chemin des binaires locaux.
example: --repo1-host-cmd=/usr/lib/backrest/bin/pgbackrest
Nom obsolète: backup-cmd
Emplacement du fichier de configuration pgBackRest sur l'hôte du dépôt.
Définit l'emplacement du fichier de configuration sur l'hôte du dépôt. Ceci n'est nécessaire que si le fichier de configuration de l'hôte du dépôt se trouve dans un emplacement différent de celui du fichier de configuration local.
default: /etc/pgbackrest/pgbackrest.conf
example: --repo1-host-config=/conf/pgbackrest/pgbackrest.conf
Nom obsolète: backup-config
Chemin d'inclusion pgBackRest de la configuration de l'hôte du dépôt.
Définit l'emplacement du chemin d'inclusion de la configuration sur l'hôte du dépôt. Ceci n'est nécessaire que si le chemin d'inclusion de la configuration de l'hôte du dépôt se trouve à un endroit différent du chemin d'inclusion de la configuration locale.
default: /etc/pgbackrest/conf.d
example: --repo1-host-config-include-path=/conf/pgbackrest/conf.d
Chemin de configuration pgBackRest de l'hôte du dépôt.
Définit l'emplacement du chemin de configuration sur l'hôte du dépôt. Ceci n'est nécessaire que si le chemin de configuration de l'hôte du référentiel se trouve à un endroit différent du chemin de configuration local.
default: /etc/pgbackrest
example: --repo1-host-config-path=/conf/pgbackrest
Port de l'hôte du dépôt lorsque repo-host est défini.
Utilisez cette option pour spécifier un port non par défaut pour le protocole d'accès à l'hôte du dépôt. Actuellement, seul SSH est pris en charge
allowed: 0-65535
example: --repo1-host-port=25
Nom obsolète: backup-ssh-port
Utilisateur de l'hôte du dépôt lorsque repo-host est défini.
Définit l'utilisateur qui sera utilisé pour les opérations sur l'hôte du dépôt. De préférence, il ne s'agit pas de l'utilisateur postgres mais plutôt d'un autre utilisateur comme pgbackrest. Si PostgreSQL fonctionne sur l'hôte du dépôt, l'utilisateur postgres peut être placé dans le groupe pgbackrest afin qu'il ait les autorisations de lecture sur le dépôt sans pouvoir en endommager le contenu accidentellement.
default: pgbackrest
example: --repo1-host-user=repo-user
Nom obsolète: backup-user
Chemin d'accès où sont stockées les sauvegardes et les archives.
Le dépôt est l'endroit où pgBackRest stocke les sauvegardes et archive les segments des journaux de transaction (WAL).
Il peut être difficile d'estimer à l'avance l'espace dont vous aurez besoin. La meilleure chose à faire est de prendre quelques sauvegardes puis d'enregistrer la taille des différents types de sauvegardes (full/incr/diff) et de mesurer la quantité de WAL générée par jour. Cela vous donnera une idée générale de l'espace dont vous aurez besoin, même si, bien sûr, les besoins changeront probablement au fil du temps, à fur et à mesure de l'évolution de votre base de données.
default: /var/lib/pgbackrest
example: --repo1-path=/backup/db/backrest
S3 dépôt bucket.
Bucket S3 utilisé pour stocker le dépôt.
Les dépots pgBackRest peuvent être stockés à la racine du bucket en définissant repo-path=/ mais il est généralement préférable de spécifier un préfixe, comme par exemple /repo, afin que les logs et autres contenus générés par AWS puissent également être stockés dans le bucket.
example: --repo1-s3-bucket=pg-backup
Ficher SSL CA S3.
Utiliser un fichier CA autre que celui défini par défaut dans le système.
example: --repo1-s3-ca-file=/etc/pki/tls/certs/ca-bundle.crt
Chemin S3 SSL CA.
Utiliser un chemin pour le CA autre que celui défini par défaut dans le système.
example: --repo1-s3-ca-path=/etc/pki/tls/certs
Dépot S3 Point de terminaison (endpoint).
Le point de terminaison d'AWS doit être valable pour la région sélectionnée.
example: --repo1-s3-endpoint=s3.amazonaws.com
Hôte du dépot S3.
Conntecter sur un hôte différent du point de terminaison (endpoint). Il est généralement utilisé à des fins de test.
example: --repo1-s3-host=127.0.0.1
Port de connection au dépot S3.
Port à utiliser lors de la connexion au point de terminaison (ou à l'hôte si spécifié).
default: 443
allowed: 1-65535
example: --repo1-s3-port=9000
Région du dépôt S3.
La région d'AWS où le bucket a été créé.
example: --repo1-s3-region=us-east-1
S3 URI formats.
Les formats URI suivants sont pris en charge:
- host - Connexion à l'hôte bucket.endpoint.
- path - Connexion à l'hôte endpoint et ajout du bucket aux URIs.
default: host
example: --repo1-s3-uri-style=path
Vérifier le certificat du serveur S3.
Désactive la vérification du certificat du serveur S3. Cette fonction ne doit être utilisée que dans le cadre de tests ou dans le cas d'une utilisation avec un certificat a été auto-signé.
default: y
example: --no-repo1-s3-verify-tls
Nom obsolète: repo-s3-verify-ssl
Type de stockage utilisé pour le dépôt.
Les types de stockage suivants sont pris en charge :
- cifs - Comme posix, mais désactive les liens et les fsyncs sur les répertoires
- posix - Systèmes de fichiers conformes à Posix
- s3 - Service de stockage d'objet (AWS Simple Storage Service)
default: posix
example: --repo1-type=cifs
Hôte PostgreSQL pour les opérations à distance via SSH.
Utilisé pour les sauvegardes lorsque l'hôte PostgreSQL est différent de l'hôte du dépôt.
example: --pg1-host=db.domain.com
Nom obsolète: db-host
Emplacement des exécutable pgBackRest sur l'hôte PostgreSQL.
Uniquement requis si le chemin vers pgbackrest est différent sur le serveur local et PostgreSQL. S'il n'est pas défini, le chemin de l'pgbackrest de l'hôte de la base de données sera le même que le chemin de l'pgbackrest local.
example: --pg1-host-cmd=/usr/lib/backrest/bin/pgbackrest
Nom obsolète: db-cmd
pgBackRest database host configuration file.
Définit l'emplacement du fichier de configuration sur l'hôte PostgreSQL. Ceci n'est requis que si le fichier de configuration de l'hôte PostgreSQL se trouve dans un emplacement différent de celui du fichier de configuration local.
default: /etc/pgbackrest/pgbackrest.conf
example: --pg1-host-config=/conf/pgbackrest/pgbackrest.conf
Nom obsolète: db-config
Chemin d'inclusion de la configuration pgBackRest sur l'hôte.
Définit l'emplacement du chemin d'inclusion de la configuration sur l'hôte PostgreSQL. Ceci n'est requis que si le chemin d'inclusion de la configuration de l'hôte PostgreSQL se trouve à un endroit différent du chemin d'inclusion de la configuration locale.
default: /etc/pgbackrest/conf.d
example: --pg1-host-config-include-path=/conf/pgbackrest/conf.d
Chemin de configuration pgBackRest de l'hôte de base de données.
Définit l'emplacement du chemin de configuration sur l'hôte PostgreSQL. Ceci n'est requis que si le chemin de configuration de l'hôte PostgreSQL se trouve dans un emplacement différent du chemin de configuration local.
default: /etc/pgbackrest
example: --pg1-host-config-path=/conf/pgbackrest
Port de l'hôte PostgreSQL lorsque pg-host est configuré.
Utiliser cette option pour spécifier un port non par défaut pour le protocole hôte PostgreSQL. Actuellement, seul le protocole SSH est pris en charge
allowed: 0-65535
example: --pg1-host-port=25
Nom obsolète: db-ssh-port
Utilisateur de connexion PostgreSQL lorsque pg-host est défini.
Cet utilisateur sera également propriétaire du processus distant pgBackRest et initiera les connexions à PostgreSQL. Pour que cela puisse fonctionner correctement, l'utilisateur doit être le propriétaire de l'instance de base de données PostgreSQL, qui est généralement par défaut postgres.
default: postgres
example: --pg1-host-user=db_owner
Nom obsolète: db-user
Interdit l'exécution de tout nouveau processus pgBackRest. Par défaut, les processus en cours d'exécution seront autorisés à se terminer normalement. Utiliser l'option --force pour mettre fin aux processus en cours.
Les processus pgBackRest retourneront une erreur s'ils sont exécutés après la fin de la commande d'arrêt.
Forcer l'arrêt de tous les processus pgBackRest.
Cette option enverra un signal TERM à tous les processus pgBackRest en cours pour effectuer un arrêt contrôlé et immédiat. Notez que cela arrêtera également les processus qui ont été lancés depuis un autre système et qui ont des commandes à distance fonctionnant sur le système actuel. Par exemple, si une sauvegarde a été lancée sur le serveur de sauvegarde, l'exécution de stop --force sur le serveur de base de données arrêtera le processus de sauvegarde sur le serveur de sauvegarde.
default: n
example: --force
Chemin d'accès à l'exécutable du client ssh.
Utilisez un client SSH spécifique lorsqu'une alternative est nécessaire ou lorsque l'exécutable ssh n'est pas dans $PATH.
default: ssh
example: --cmd-ssh=/usr/bin/ssh
Fichier de configuration pgBackRest.
Utiliser cette option pour spécifier un fichier de configuration différent de celui par défaut.
default: /etc/pgbackrest/pgbackrest.conf
example: --config=/conf/pgbackrest/pgbackrest.conf
Emplacement des fichiers de configuration pgBackRest supplémentaires..
Les fichiers de configuration existant à l'emplacement spécifié avec l'extension .conf seront concaténés avec le fichier de configuration pgBackRest, ce qui donne un seul fichier de configuration.
default: /etc/pgbackrest/conf.d
example: --config-include-path=/conf/pgbackrest/conf.d
Emplacement du répertoire de racine de pgBackRest des fichiers de configuration.
Ce paramètre est utilisé pour écraser le chemin racine par défaut pour les options --config et --config-include-path à moins qu'elles ne soient explicitement définies sur la ligne de commande.
Par exemple, en utilisant uniquement --config-path=/conf/pgbackrest, la valeur par défaut de --config est /conf/pgbackrest/pgbackrest.conf et la valeur par défaut de --config-include-path est /conf/pgbackrest/conf.d.
default: /etc/pgbackrest
example: --config-path=/conf/pgbackrest
Chemin d'accès où sont stockés les fichiers de verrouillage.
Le chemin de verrouillage fournit l'emplacement à pgBackRest pour créer des fichiers de verrouillage afin d'éviter que des opérations en conflictuelles ne soient exécutées simultanément.
default: /tmp/pgbackrest
example: --lock-path=/backup/db/lock
Utilisation d'un umask
neutre
Définit l'umask à 0000 pour que les modes dans le dépôt de sauvegarde soient créés de manière appropriée. Le mode par défaut du répertoire est 0750 et le mode par défaut du fichier est 0640. Pour les répertoires lock et log, les modes de répertoire et de fichier sont respectivement fixés à 0770 et 0660.
Pour utiliser l'umask de l'utilisateur en cours d'exécution, spécifiez plutôt neutral-umask=n dans le fichier de configuration ou --no-neutral-umask sur la ligne de commande.
default: y
example: --no-neutral-umask
Defines the stanza.
Un stanza est la configuration de la sauvegarde d'une instance PostgreSQL où est définit l'endroit où il se trouve, la façon dont il sera sauvegardé, les options d'archivage, etc... La plupart des serveurs de base de données n'auront qu'une seule instance PostgreSQL et donc un stanza alors que les serveurs de sauvegarde auront un stanza pour chaque instance de base de données qui doit être sauvegardé.
Il est tentant de nommer le stanza en référence à l'instance primaire, mais un meilleur nom décrirait les bases de données contenues dans l'instance : comme le nom du stanza sera utilisé pour le primaire et tous les secondaire, il est plus approprié de choisir un nom qui décrit la fonction réelle du groupe d'instances, comme app ou dw, plutôt que le nom local de l'instance, comme main ou prod.
example: --stanza=main
Niveau de journalisation en sortie sur la console.
Les niveaux de traces suivants sont pris en charge:
- off - Pas de journal de traces (non recommandé)
- error - Journaliser uniquement les erreurs
- warn - Journaliser les avertissements et les erreurs
- info - Journaliser les messages d'information, les avertissements et les erreurs
- detail - Journaliser les détails, les messages d'information, les avertissements et les erreurs
- debug - Journaliser les message de Débogage, les détails, les messages d'information, les avertissements et les erreurs
- trace - Journaliser les traces (un débogage très verbeux), les message de Débogage, les détails, les messages d'information, les avertissements et les erreurs
default: warn
example: --log-level-console=error
Niveau d'enregistrement des traces lors de l'enregistrement sur fichier.
Les niveaux de traces suivants sont pris en charge:
- off - Pas de journal de traces (non recommandé)
- error - Journaliser uniquement les erreurs
- warn - Journaliser les avertissements et les erreurs
- info - Journaliser les messages d'information, les avertissements et les erreurs
- detail - Journaliser les détails, les messages d'information, les avertissements et les erreurs
- debug - Journaliser les message de Débogage, les détails, les messages d'information, les avertissements et les erreurs
- trace - Journaliser les traces (un débogage très verbeux), les message de Débogage, les détails, les messages d'information, les avertissements et les erreurs
default: info
example: --log-level-file=debug
Niveau de traces sur la sortie console stderr.
Spécifie les niveaux de traces qui sortiront en
stderr plutôt que
stdout (spécifié par
log-level-console). L'horodatage et le processus ne seront pas émis sur
stderr.
Les niveaux de traces suivants sont pris en charge:
- off - Pas de journal de traces (non recommandé)
- error - Journaliser uniquement les erreurs
- warn - Journaliser les avertissements et les erreurs
- info - Journaliser les messages d'information, les avertissements et les erreurs
- detail - Journaliser les détails, les messages d'information, les avertissements et les erreurs
- debug - Journaliser les message de Débogage, les détails, les messages d'information, les avertissements et les erreurs
- trace - Journaliser les traces (un débogage très verbeux), les message de Débogage, les détails, les messages d'information, les avertissements et les erreurs
default: warn
example: --log-level-stderr=error
Emplacement où les fichiers journaux de traces sont stockés.
Le chemin d'accès au journal fournit un emplacement pour pgBackRest pour stocker les fichiers journaux. Notez que si log-level-file=off alors aucun chemin pour l'emplacement des journaux de traces n'est nécessaire.
default: /var/log/pgbackrest
example: --log-path=/backup/db/log
Activer la journalisation des traces dans les sous-processus.
Activez la journalisation des traces dans les fichiers pour tous les sous-processus créés par ce processus en utilisant le niveau de journalisation spécifié par log-level-file.
default: n
example: --log-subprocess
Activer l'horodatage dans les traces.
Active l'horodatage dans la console et l'enregistrement des fichiers. Cette option est désactivée dans des situations particulières telles que la génération de documentation.
default: y
example: --no-log-timestamp
Chiffrement (cipher) utilisé pour chiffrer le dépôt.
Les types de chiffrement suivants sont pris en charge:
- none - Le dépôt n'est pas chiffré.
- aes-256-cbc - Advanced Encryption Standard avec une clef de 256 bit
À noter que le chiffrement est toujours effectué côté client même si le type de stockage (par exemple S3) supporte le chiffrement.
default: none
example: --repo1-cipher-type=aes-256-cbc
Hôte de dépôt dans le cas d'un fonctionnement à distance via SSH.
Assurez-vous que l'authentification SSH soit correctement approuvé entre l'hôte PostgreSQL et l'hôte du référentiel.
Ce paramètre n'est pas nécessaire pour la sauvegarde et l'archivage sur un système de fichiers monté localement.
example: --repo1-host=repo1.domain.com
Nom obsolète: backup-host
Chemin des binaires pgBackRest sur l'hôte du dépôt.
Nécessaire uniquement si le chemin d'accès à pgbackrest est différent entre les hôtes locaux et l'hote du dépôt. S'il n'est pas défini, le chemin des binaires sur l'hôte du dépôt sera le même que le chemin des binaires locaux.
example: --repo1-host-cmd=/usr/lib/backrest/bin/pgbackrest
Nom obsolète: backup-cmd
Emplacement du fichier de configuration pgBackRest sur l'hôte du dépôt.
Définit l'emplacement du fichier de configuration sur l'hôte du dépôt. Ceci n'est nécessaire que si le fichier de configuration de l'hôte du dépôt se trouve dans un emplacement différent de celui du fichier de configuration local.
default: /etc/pgbackrest/pgbackrest.conf
example: --repo1-host-config=/conf/pgbackrest/pgbackrest.conf
Nom obsolète: backup-config
Chemin d'inclusion pgBackRest de la configuration de l'hôte du dépôt.
Définit l'emplacement du chemin d'inclusion de la configuration sur l'hôte du dépôt. Ceci n'est nécessaire que si le chemin d'inclusion de la configuration de l'hôte du dépôt se trouve à un endroit différent du chemin d'inclusion de la configuration locale.
default: /etc/pgbackrest/conf.d
example: --repo1-host-config-include-path=/conf/pgbackrest/conf.d
Chemin de configuration pgBackRest de l'hôte du dépôt.
Définit l'emplacement du chemin de configuration sur l'hôte du dépôt. Ceci n'est nécessaire que si le chemin de configuration de l'hôte du référentiel se trouve à un endroit différent du chemin de configuration local.
default: /etc/pgbackrest
example: --repo1-host-config-path=/conf/pgbackrest
Port de l'hôte du dépôt lorsque repo-host est défini.
Utilisez cette option pour spécifier un port non par défaut pour le protocole d'accès à l'hôte du dépôt. Actuellement, seul SSH est pris en charge
allowed: 0-65535
example: --repo1-host-port=25
Nom obsolète: backup-ssh-port
Utilisateur de l'hôte du dépôt lorsque repo-host est défini.
Définit l'utilisateur qui sera utilisé pour les opérations sur l'hôte du dépôt. De préférence, il ne s'agit pas de l'utilisateur postgres mais plutôt d'un autre utilisateur comme pgbackrest. Si PostgreSQL fonctionne sur l'hôte du dépôt, l'utilisateur postgres peut être placé dans le groupe pgbackrest afin qu'il ait les autorisations de lecture sur le dépôt sans pouvoir en endommager le contenu accidentellement.
default: pgbackrest
example: --repo1-host-user=repo-user
Nom obsolète: backup-user
Chemin d'accès où sont stockées les sauvegardes et les archives.
Le dépôt est l'endroit où pgBackRest stocke les sauvegardes et archive les segments des journaux de transaction (WAL).
Il peut être difficile d'estimer à l'avance l'espace dont vous aurez besoin. La meilleure chose à faire est de prendre quelques sauvegardes puis d'enregistrer la taille des différents types de sauvegardes (full/incr/diff) et de mesurer la quantité de WAL générée par jour. Cela vous donnera une idée générale de l'espace dont vous aurez besoin, même si, bien sûr, les besoins changeront probablement au fil du temps, à fur et à mesure de l'évolution de votre base de données.
default: /var/lib/pgbackrest
example: --repo1-path=/backup/db/backrest
S3 dépôt bucket.
Bucket S3 utilisé pour stocker le dépôt.
Les dépots pgBackRest peuvent être stockés à la racine du bucket en définissant repo-path=/ mais il est généralement préférable de spécifier un préfixe, comme par exemple /repo, afin que les logs et autres contenus générés par AWS puissent également être stockés dans le bucket.
example: --repo1-s3-bucket=pg-backup
Ficher SSL CA S3.
Utiliser un fichier CA autre que celui défini par défaut dans le système.
example: --repo1-s3-ca-file=/etc/pki/tls/certs/ca-bundle.crt
Chemin S3 SSL CA.
Utiliser un chemin pour le CA autre que celui défini par défaut dans le système.
example: --repo1-s3-ca-path=/etc/pki/tls/certs
Dépot S3 Point de terminaison (endpoint).
Le point de terminaison d'AWS doit être valable pour la région sélectionnée.
example: --repo1-s3-endpoint=s3.amazonaws.com
Hôte du dépot S3.
Conntecter sur un hôte différent du point de terminaison (endpoint). Il est généralement utilisé à des fins de test.
example: --repo1-s3-host=127.0.0.1
Port de connection au dépot S3.
Port à utiliser lors de la connexion au point de terminaison (ou à l'hôte si spécifié).
default: 443
allowed: 1-65535
example: --repo1-s3-port=9000
Région du dépôt S3.
La région d'AWS où le bucket a été créé.
example: --repo1-s3-region=us-east-1
S3 URI formats.
Les formats URI suivants sont pris en charge:
- host - Connexion à l'hôte bucket.endpoint.
- path - Connexion à l'hôte endpoint et ajout du bucket aux URIs.
default: host
example: --repo1-s3-uri-style=path
Vérifier le certificat du serveur S3.
Désactive la vérification du certificat du serveur S3. Cette fonction ne doit être utilisée que dans le cadre de tests ou dans le cas d'une utilisation avec un certificat a été auto-signé.
default: y
example: --no-repo1-s3-verify-tls
Nom obsolète: repo-s3-verify-ssl
Type de stockage utilisé pour le dépôt.
Les types de stockage suivants sont pris en charge :
- cifs - Comme posix, mais désactive les liens et les fsyncs sur les répertoires
- posix - Systèmes de fichiers conformes à Posix
- s3 - Service de stockage d'objet (AWS Simple Storage Service)
default: posix
example: --repo1-type=cifs
Hôte PostgreSQL pour les opérations à distance via SSH.
Utilisé pour les sauvegardes lorsque l'hôte PostgreSQL est différent de l'hôte du dépôt.
example: --pg1-host=db.domain.com
Nom obsolète: db-host
Emplacement des exécutable pgBackRest sur l'hôte PostgreSQL.
Uniquement requis si le chemin vers pgbackrest est différent sur le serveur local et PostgreSQL. S'il n'est pas défini, le chemin de l'pgbackrest de l'hôte de la base de données sera le même que le chemin de l'pgbackrest local.
example: --pg1-host-cmd=/usr/lib/backrest/bin/pgbackrest
Nom obsolète: db-cmd
pgBackRest database host configuration file.
Définit l'emplacement du fichier de configuration sur l'hôte PostgreSQL. Ceci n'est requis que si le fichier de configuration de l'hôte PostgreSQL se trouve dans un emplacement différent de celui du fichier de configuration local.
default: /etc/pgbackrest/pgbackrest.conf
example: --pg1-host-config=/conf/pgbackrest/pgbackrest.conf
Nom obsolète: db-config
Chemin d'inclusion de la configuration pgBackRest sur l'hôte.
Définit l'emplacement du chemin d'inclusion de la configuration sur l'hôte PostgreSQL. Ceci n'est requis que si le chemin d'inclusion de la configuration de l'hôte PostgreSQL se trouve à un endroit différent du chemin d'inclusion de la configuration locale.
default: /etc/pgbackrest/conf.d
example: --pg1-host-config-include-path=/conf/pgbackrest/conf.d
Chemin de configuration pgBackRest de l'hôte de base de données.
Définit l'emplacement du chemin de configuration sur l'hôte PostgreSQL. Ceci n'est requis que si le chemin de configuration de l'hôte PostgreSQL se trouve dans un emplacement différent du chemin de configuration local.
default: /etc/pgbackrest
example: --pg1-host-config-path=/conf/pgbackrest
Port de l'hôte PostgreSQL lorsque pg-host est configuré.
Utiliser cette option pour spécifier un port non par défaut pour le protocole hôte PostgreSQL. Actuellement, seul le protocole SSH est pris en charge
allowed: 0-65535
example: --pg1-host-port=25
Nom obsolète: db-ssh-port
Utilisateur de connexion PostgreSQL lorsque pg-host est défini.
Cet utilisateur sera également propriétaire du processus distant pgBackRest et initiera les connexions à PostgreSQL. Pour que cela puisse fonctionner correctement, l'utilisateur doit être le propriétaire de l'instance de base de données PostgreSQL, qui est généralement par défaut postgres.
default: postgres
example: --pg1-host-user=db_owner
Nom obsolète: db-user
Affiche la version pgBackRest installée..