Référence des commandes on PIG.CENTER

Commande d'annotation (annotate)

Mon, 01 Jan 0001 00:00:00 +0000

Les annotations incluses avec la commande backup peuvent être ajoutées, modifiées ou supprimées ultérieurement à l’aide de la commande annotate.

Options de commande

Option d’annotation de sauvegarde (`--annotation`)

Ajoutez des paires clé/valeur définies par l’utilisateur à la sauvegarde.

Les utilisateurs peuvent attacher des paires clé/valeur explicatives à la sauvegarde. Cette option peut être utilisée plusieurs fois pour attacher plusieurs annotations.

Commande d’archive (archive-get)

Mon, 01 Jan 0001 00:00:00 +0000

Cette commande est utilisée par PostgreSQL pour effectuer une restauration, une récupération jusqu’à un instant précis (PITR), ou en tant qu’alternative au streaming afin de maintenir une réplique à jour. Les segments WAL sont requis pour la récupération de PostgreSQL ou pour maintenir une réplique.

Lorsque plusieurs dépôts sont configurés, les fichiers WAL seront récupérés dans l’ordre de priorité des dépôts (par exemple repo1, repo2, etc.). En général, il est préférable que les dépôts plus rapides ou moins coûteux aient une priorité plus élevée. Si un dépôt est spécifié avec l’option --repo, seul ce dépôt sera recherché.

Commande de poussée d'archive (archive-push)

Mon, 01 Jan 0001 00:00:00 +0000

Accepte un segment WAL de PostgreSQL et l’archive dans chaque dépôt défini par l’option indexée repo-path (voir la section Repository pour obtenir des informations sur la configuration des dépôts). Le segment WAL peut être envoyé immédiatement à l’archive ou stocké localement, selon la valeur de archive-async. En cas de configuration de plusieurs dépôts, archive-push tentera d’envoyer à autant de dépôts que possible.

Le archive-push est destiné à être configuré et appelé par PostgreSQL. Voir Configurer la sauvegarde d’archive pour un exemple.

Commande de sauvegarde (backup)

Mon, 01 Jan 0001 00:00:00 +0000

Lorsque plusieurs dépôts sont configurés, pgBackRest effectuera la sauvegarde vers le dépôt de priorité la plus élevée (par exemple repo1) sauf si l’option --repo est spécifiée.

pgBackRest ne dispose pas de planificateur intégré, il est donc préférable de l’exécuter depuis cron ou un autre mécanisme de planification.

Consultez Effectuer une sauvegarde pour plus de détails et d’exemples.

Options de commande

Option d’annotation de sauvegarde (`--annotation`)

Ajoutez des paires clé/valeur définies par l’utilisateur à la sauvegarde.

Commande de vérification (check)

Mon, 01 Jan 0001 00:00:00 +0000

La commande check vérifie que pgBackRest et le paramètre archive_command sont correctement configurés pour l’archivage et les sauvegardes du stanza spécifié. Elle tente de vérifier tous les dépôts et bases de données configurés pour l’hôte sur lequel la commande est exécutée. Elle détecte les mauvaises configurations, en particulier celles relatives à l’archivage, qui entraînent des sauvegardes incomplètes car des segments WAL requis n’ont pas atteint l’archive. La commande peut être exécutée sur l’hôte PostgreSQL ou sur l’hôte dépôt. Elle peut également être exécutée sur l’hôte de basculement, toutefois, comme les opérations pg_switch_xlog()/pg_switch_wal() ne peuvent pas être effectuées sur le basculement, la commande ne testera que la configuration du dépôt.

Commande d'expiration (expire)

Mon, 01 Jan 0001 00:00:00 +0000

pgBackRest effectue la rotation des sauvegardes complètes selon le type de rétention, qui peut être défini par un nombre ou une période de temps. Lorsqu’un nombre est spécifié, l’expiration n’est pas liée à la date de création des sauvegardes, mais au nombre de sauvegardes à conserver. Les sauvegardes différentielles sont basées sur un nombre, mais sont toujours expirées lorsque la sauvegarde complète dont elles dépendent est expirée. Les sauvegardes incrémentielles ne sont pas expirées indépendamment par rétention — elles sont toujours expirées en même temps que leur sauvegarde complète ou différentielle associée. Pour plus de détails et d’exemples, reportez-vous aux sections Rétention des sauvegardes complètes et Rétention des sauvegardes différentielles .

Commande d'aide (help)

Mon, 01 Jan 0001 00:00:00 +0000

Trois niveaux d’aide sont proposés. Si aucune commande n’est spécifiée, une aide générale sera affichée. Si une commande est précisée (par exemple pgbackrest help backup), une description complète de la commande sera affichée, accompagnée d’une liste des options valides. Si une option est précisée en plus d’une commande (par exemple pgbackrest help backup type), une description complète de l’option telle qu’elle s’applique à la commande sera affichée.

Options de commande

Afficher l’option d’aide (`--help`)

Affiche l’aide.

Info Commande (info)

Mon, 01 Jan 0001 00:00:00 +0000

La commande info s’applique à une seule stanza ou à toutes les stanzas. La sortie texte est la valeur par défaut et fournit un résumé lisible par l’humain des sauvegardes pour la ou les stanzas demandées. Ce format peut évoluer à tout moment dans une version.

Pour une sortie lisible par machine, utilisez --output=json. La sortie JSON contient bien plus d’informations que la sortie texte et est maintenue stable, sauf en cas de bug.

Commande d'obtention de dépôt (repo-get)

Mon, 01 Jan 0001 00:00:00 +0000

Similaire à la commande unix cat mais fonctionne sur n’importe quel type de dépôt pris en charge. Cette commande nécessite un nom de fichier entièrement qualifié et est principalement destinée à l’administration, l’investigation et les tests. Elle n’est pas obligatoire dans une configuration normale de pgBackRest.

Si le dépôt est chiffré, repo-get déchiffrera automatiquement le fichier. Les fichiers ne sont pas automatiquement décompressés, mais la sortie peut être redirigée vers la commande de décompression appropriée, par exemple gzip -d.

Commande Liste des dépôts (repo-ls)

Mon, 01 Jan 0001 00:00:00 +0000

Similaire à la commande unix ls mais fonctionne sur tout type de dépôt pris en charge. Cette commande accepte un chemin, absolu ou relatif par rapport au chemin du dépôt défini par l’option --repo-path, et est principalement destinée à l’administration, l’investigation et les tests. Elle n’est pas obligatoire dans une configuration pgBackRest normale.

La sortie texte par défaut affiche un nom de fichier par ligne. La sortie JSON est disponible en spécifiant --output=json.

Commande de restauration (restore)

Mon, 01 Jan 0001 00:00:00 +0000

La commande de restauration sélectionne automatiquement la dernière sauvegarde du premier dépôt où des sauvegardes existent (voir Démarrage rapide - Restaurer une sauvegarde ). L’ordre dans lequel les dépôts sont vérifiés est déterminé par le pgbackrest.conf (par exemple, repo1 sera vérifié avant repo2). Pour sélectionner un dépôt spécifique, l’option --repo peut être utilisée (par exemple, --repo=1). L’option --set peut être utilisée si une sauvegarde autre que la plus récente est souhaitée.

Commande serveur (server)

Mon, 01 Jan 0001 00:00:00 +0000

Le serveur pgBackRest permet d’accéder aux hôtes distants sans utiliser le protocole SSH.

Options de commande

Option d’adresse serveur TLS (`--tls-server-address`)

Adresse du serveur TLS.

Adresse IP sur laquelle le serveur écoute les requêtes clients.

default: localhost
example: --tls-server-address=*

Option Clients autorisés du serveur TLS (`--tls-server-auth`)

Clients autorisés du serveur TLS.

Commande de ping serveur (server-ping)

Mon, 01 Jan 0001 00:00:00 +0000

Pongez un serveur TLS pgBackRest pour vérifier qu’il accepte les connexions. Cette opération ne sert qu’à vérifier la disponibilité, car aucune authentification n’est tentée.

Si aucun hôte n’est spécifié en ligne de commande, l’option tls-server-host sera utilisée.

Options de commande

Option d’adresse serveur TLS (`--tls-server-address`)

Adresse du serveur TLS.

Adresse IP sur laquelle le serveur écoute les requêtes clients.

default: localhost
example: --tls-server-address=*

Option de port serveur TLS (`--tls-server-port`)

Port du serveur TLS.

Commande de création de stanza (stanza-create)

Mon, 01 Jan 0001 00:00:00 +0000

La commande stanza-create doit être exécutée après la configuration du stanza dans pgbackrest.conf. Si plusieurs dépôts sont configurés, le stanza sera créé sur chacun d’eux. Les stanzas déjà créés seront ignorés, ce qui rend toujours sûr l’exécution de stanza-create, même après la configuration d’un nouveau dépôt.

Consultez Créer une stanza pour plus d’informations et un exemple.

Options de commande

Option en ligne (`--online`)

Créez sur un cluster en ligne.

Commande de suppression de stanza (stanza-delete)

Mon, 01 Jan 0001 00:00:00 +0000

La commande stanza-delete supprime les données du dépôt associées à un stanza.

AVERTISSEMENT :

Utilisez cette commande avec précaution — elle supprimera définitivement toutes les sauvegardes et archives du dépôt pgBackRest pour le stanza spécifié.

Pour supprimer une stanza :

Arrêtez le cluster PostgreSQL associé à la stanza (ou utilisez –force pour l’ignorer).
Exécutez la commande stop sur l’hôte où la commande stanza-delete sera exécutée.
Exécutez la commande stanza-delete.

Une fois la commande exécutée avec succès, il incombe à l’utilisateur de supprimer la stanza de tous les fichiers de configuration pgBackRest et/ou des variables d’environnement.

Commande de mise à jour de stanza (stanza-upgrade)

Mon, 01 Jan 0001 00:00:00 +0000

Immédiatement après la mise à niveau de PostgreSQL vers une nouvelle version majeure, le pg-path de toutes les configurations pgBackRest doit être défini sur le nouveau emplacement de la base de données, puis la commande stanza-upgrade doit être exécutée. Si plusieurs dépôts sont configurés sur l’hôte, le stanza sera mis à niveau sur chacun. Si la base de données est hors ligne, utilisez l’option --no-online.

Options de commande

Option en ligne (`--online`)

Mettre à jour un cluster en ligne.

Commande de démarrage (start)

Mon, 01 Jan 0001 00:00:00 +0000

Si les processus pgBackRest ont été précédemment arrêtés à l’aide de la commande stop, ils peuvent être redémarrés à l’aide de la commande start. Notez qu’il ne s’agit pas d’un démarrage immédiat des processus pgBackRest, mais qu’ils sont autorisés à s’exécuter. Voir Démarrage et arrêt pour plus d’informations et d’exemples.

Options générales

Autoriser l’exécution en tant qu’utilisateur root (`--allow-root`)

Permettre à la commande de s’exécuter en tant qu’utilisateur root.

Commande d'arrêt (stop)

Mon, 01 Jan 0001 00:00:00 +0000

N’autorise aucun nouveau processus pgBackRest à s’exécuter. Par défaut, les processus en cours d’exécution sont autorisés à se terminer correctement. Utilisez l’option --force pour terminer les 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. Consultez Démarrage et arrêt pour plus d’informations et d’exemples.

Options de commande

Option obligatoire (`--force`)

Forcer l’arrêt de tous les processus pgBackRest.

Commande de vérification (verify)

Mon, 01 Jan 0001 00:00:00 +0000

Verify détermine si les sauvegardes et les archives présentes dans un dépôt sont valides.

Options de commande

Option de sortie (`--output`)

Type de sortie.

Les types de sortie suivants sont pris en charge :

none - Aucune vérification de sortie.
text - Informations de vérification de sortie affichées sur stdout.

default: none
example: --output=text

Définir l’option (`--set`)

Sauvegarde configurée pour vérification.

Commande Version (version)

Mon, 01 Jan 0001 00:00:00 +0000

Affiche la version de pgBackRest installée.

Options de commande

Option de sortie (`--output`)

Type de sortie.

Les types de sortie suivants sont pris en charge :

text - Affiche la version installée de pgBackRest sous forme de texte.
num - Affiche la version installée de pgBackRest sous forme d’entier.

default: text
example: --output=num

Référence des commandes on PIG.CENTER

Commande d'annotation (annotate)

Options de commande

Option d’annotation de sauvegarde (--annotation)

Commande d’archive (archive-get)

Commande de poussée d'archive (archive-push)

Commande de sauvegarde (backup)

Options de commande

Option d’annotation de sauvegarde (--annotation)

Commande de vérification (check)

Commande d'expiration (expire)

Commande d'aide (help)

Options de commande

Afficher l’option d’aide (--help)

Info Commande (info)

Commande d'obtention de dépôt (repo-get)

Commande Liste des dépôts (repo-ls)

Commande de restauration (restore)

Commande serveur (server)

Options de commande

Option d’adresse serveur TLS (--tls-server-address)

Option Clients autorisés du serveur TLS (--tls-server-auth)

Commande de ping serveur (server-ping)

Options de commande

Option d’adresse serveur TLS (--tls-server-address)

Option de port serveur TLS (--tls-server-port)

Commande de création de stanza (stanza-create)

Options de commande

Option en ligne (--online)

Commande de suppression de stanza (stanza-delete)

Commande de mise à jour de stanza (stanza-upgrade)

Options de commande

Option en ligne (--online)

Commande de démarrage (start)

Options générales

Autoriser l’exécution en tant qu’utilisateur root (--allow-root)

Commande d'arrêt (stop)

Options de commande

Option obligatoire (--force)

Commande de vérification (verify)

Options de commande

Option de sortie (--output)

Définir l’option (--set)

Commande Version (version)

Options de commande

Option de sortie (--output)

Option d’annotation de sauvegarde (`--annotation`)

Option d’annotation de sauvegarde (`--annotation`)

Afficher l’option d’aide (`--help`)

Option d’adresse serveur TLS (`--tls-server-address`)

Option Clients autorisés du serveur TLS (`--tls-server-auth`)

Option d’adresse serveur TLS (`--tls-server-address`)

Option de port serveur TLS (`--tls-server-port`)

Option en ligne (`--online`)

Option en ligne (`--online`)

Autoriser l’exécution en tant qu’utilisateur root (`--allow-root`)

Option obligatoire (`--force`)

Option de sortie (`--output`)

Définir l’option (`--set`)

Option de sortie (`--output`)