Zum Inhalt springen

Befehlsreferenz

pgBackRest-Befehlsreferenz mit allen Optionen für Backup-, Wiederherstellungs-, Archiv- und Verwaltungsvorgänge.

Einführung

Befehle führen die verschiedenen pgBackRest-Funktionen aus. Hier sind sämtliche Befehlsoptionen aufgeführt: Jede auf einen Befehl anwendbare Option wird bei diesem Befehl genannt, auch wenn sie für weitere Befehle gilt. Dazu gehören alle Optionen, die auch in pgbackrest.conf konfiguriert werden können.

Nicht boolesche Optionen aus pgbackrest.conf lassen sich über die Befehlszeile mit dem Präfix reset- auf ihren Standardwert zurücksetzen. Damit kann ein Backup direkt auf einem Repository-Host wiederhergestellt werden. Normalerweise meldet pgBackRest einen Fehler, weil es erkennt, dass sich die Datenbank auf einem entfernten Host befindet und Wiederherstellungen nicht aus der Ferne möglich sind. Mit --reset-pg1-host in der Befehlszeile ignoriert pgBackRest den entfernten Datenbank-Host und führt die Wiederherstellung lokal aus. Möglicherweise muss ein neuer Wert für --pg1-path angegeben werden, um die Wiederherstellung in einem bestimmten Pfad zu erzwingen, also nicht in dem auf dem Datenbank-Host verwendeten Pfad.

Mit dem Präfix no- lässt sich eine boolesche Option über die Befehlszeile auf false setzen.

Jede Option kann über eine Umgebungsvariable gesetzt werden. Dazu werden das Präfix PGBACKREST_ und der Optionsname in Großbuchstaben verwendet, wobei - durch _ ersetzt wird. Beispielsweise wird pg1-path zu PGBACKREST_PG1_PATH und stanza zu PGBACKREST_STANZA. Boolesche Optionen werden wie in einer Konfigurationsdatei angegeben, etwa PGBACKREST_COMPRESS="n"; Varianten mit reset-* sind nicht zulässig. Für Optionen, die mehrfach in der Befehlszeile oder einer Konfigurationsdatei angegeben werden können, werden die Werte durch Doppelpunkte getrennt, etwa PGBACKREST_DB_INCLUDE="db1:db2".

Befehlszeilenoptionen haben Vorrang vor Umgebungsvariablen; diese haben wiederum Vorrang vor Optionen aus der Konfigurationsdatei.

Informationen zu den Optionentypen finden Sie in der Einführung zur Konfiguration

Befehle

Befehl Zusammenfassung
annotate Backup-Anmerkungen nach der Erstellung des Backups hinzufügen, ändern oder entfernen.
archive-get Archivierte WAL-Segmente für Wiederherstellung, PITR oder die Recovery eines Replikats abrufen.
archive-push WAL-Segmente von PostgreSQL entgegennehmen und an die konfigurierten Repositorys übertragen.
backup Backups im Ziel-Repository erstellen (standardmäßig im Repository mit der höchsten Priorität).
check Die Backup- und Archivkonfiguration einer Stanza und die Funktionsfähigkeit der WAL-Archivierung prüfen.
expire Backups und archivierte WAL gemäß den konfigurierten Aufbewahrungsregeln entfernen.
help Allgemeine Hilfe oder Hilfe zu einem Befehl oder einer Option anzeigen.
info Status und Metadaten von Stanzas und Backups im Text- oder JSON-Format anzeigen.
repo-get Repository-Dateien für Verwaltung, Untersuchung und Tests lesen (wie cat).
repo-ls Repository-Dateien und -Pfade für Verwaltung, Untersuchung und Tests auflisten (wie ls).
restore Ein Backup wiederherstellen (standardmäßig das neueste), optional mit Point-in-Time-Recovery.
server Den pgBackRest-TLS-Server für den Zugriff auf entfernte Hosts ohne SSH ausführen.
server-ping Einen pgBackRest-TLS-Server mit einem Ping darauf prüfen, ob er Verbindungen annimmt.
stanza-create Stanza-Metadaten in allen konfigurierten Repositorys erstellen.
stanza-delete Alle Backups und Archive einer Stanza dauerhaft entfernen.
stanza-upgrade Stanza-Metadaten nach einem Upgrade auf eine neue PostgreSQL-Hauptversion aktualisieren.
start Die Ausführung von pgBackRest-Prozessen nach einem vorherigen stop wieder zulassen.
stop Neue pgBackRest-Prozesse verhindern und laufende Prozesse optional zwangsweise beenden.
verify Die Gültigkeit der Backup- und Archivdaten im Repository prüfen.
version Die installierte pgBackRest-Version anzeigen.

Referenz zu den Optionen und zum Verhalten des pgBackRest-Befehls annotate.

Referenz zu den Optionen und zum Verhalten des pgBackRest-Befehls archive-get.

Referenz zu den Optionen und zum Verhalten des pgBackRest-Befehls archive-push.

Referenz zu den Optionen und zum Verhalten des pgBackRest-Befehls backup.

Referenz zu den Optionen und zum Verhalten des pgBackRest-Befehls check.

Referenz zu den Optionen und zum Verhalten des pgBackRest-Befehls expire.

Referenz zu den Optionen und zum Verhalten des pgBackRest-Befehls help.

Referenz zu den Optionen und zum Verhalten des pgBackRest-Befehls info.

Referenz zu den Optionen und zum Verhalten des pgBackRest-Befehls repo-get.

Referenz zu den Optionen und zum Verhalten des pgBackRest-Befehls repo-ls.

Referenz zu den Optionen und zum Verhalten des pgBackRest-Befehls restore.

Referenz zu den Optionen und zum Verhalten des pgBackRest-Befehls server.

Referenz zu den Optionen und zum Verhalten des pgBackRest-Befehls server-ping.

Referenz zu den Optionen und zum Verhalten des pgBackRest-Befehls stanza-create.

Referenz zu den Optionen und zum Verhalten des pgBackRest-Befehls stanza-delete.

Referenz zu den Optionen und zum Verhalten des pgBackRest-Befehls stanza-upgrade.

Referenz zu den Optionen und zum Verhalten des pgBackRest-Befehls start.

Referenz zu den Optionen und zum Verhalten des pgBackRest-Befehls stop.

Referenz zu den Optionen und zum Verhalten des pgBackRest-Befehls verify.

Referenz zu den Optionen und zum Verhalten des pgBackRest-Befehls version.