Befehlsreferenz

• 1: Befehl für Anmerkungen (annotate)
• 2: Befehl zum Abrufen aus dem Archiv (archive-get)
• 3: Befehl zum Übertragen ins Archiv (archive-push)
• 4: Backup-Befehl (backup)
• 5: Prüfbefehl (check)
• 6: Befehl zum Entfernen abgelaufener Backups (expire)
• 7: Hilfebefehl (help)
• 8: Informationsbefehl (info)
• 9: Befehl zum Lesen aus dem Repository (repo-get)
• 10: Befehl zum Auflisten des Repository-Inhalts (repo-ls)
• 11: Befehl zur Wiederherstellung (restore)
• 12: Server-Befehl (server)
• 13: Server-Ping-Befehl (server-ping)
• 14: Befehl zum Erstellen einer Stanza (stanza-create)
• 15: Befehl zum Löschen einer Stanza (stanza-delete)
• 16: Befehl zum Aktualisieren einer Stanza (stanza-upgrade)
• 17: Startbefehl (start)
• 18: Stoppbefehl (stop)
• 19: Validierungsbefehl (verify)
• 20: Versionsbefehl (version)

1 - Befehl für Anmerkungen (annotate)

Mit dem Befehl backup angegebene Anmerkungen können nachträglich mit dem Befehl annotate hinzugefügt, geändert oder entfernt werden.

Befehlsoptionen

Option für Backup-Anmerkungen (--annotation)

Das Backup mit benutzerdefinierten Schlüssel/Wert-Paaren versehen.

Benutzer können dem Backup informative Schlüssel/Wert-Paare hinzufügen. Diese Option kann mehrfach verwendet werden, um mehrere Anmerkungen hinzuzufügen.

Anmerkungen erscheinen in der Textausgabe des Befehls info, wenn mit --set ein Backup angegeben wird. In der JSON-Ausgabe erscheinen sie immer.

example: --annotation=source="Sunday backup for website database"

Option zur Auswahl des Backup-Satzes (--set)

Backup-Satz, dessen Anmerkungen bearbeitet werden sollen.

Der Backup-Satz, dessen Anmerkungen bearbeitet werden sollen.

example: --set=20150131-153358F_20150131-153401I

Allgemeine Optionen

Option zur Ausführung als root (--allow-root)

Die Ausführung des Befehls als Benutzer root erlauben.

Standardmäßig darf nur der Befehl restore als Benutzer root ausgeführt werden, da er die Dateieigentümer sorgfältig verwaltet. Bei anderen Befehlen besteht das Risiko, dass Dateien entstehen, die root gehören, etwa im Repository. Diese sind für den PostgreSQL-Benutzer nicht zugänglich, sodass spätere Befehle fehlschlagen.

Diese Option aktivieren, um einen Befehl dennoch als root auszuführen. Es ist jedoch deutlich besser, pgBackRest als den Benutzer auszuführen, dem das Repository und der PostgreSQL-Cluster gehören.

default: n
example: --allow-root

Option für die Puffergröße (--buffer-size)

Puffergröße für I/O-Operationen.

Puffergröße für Kopier-, Komprimierungs-, Verschlüsselungs- und andere Operationen. Die Anzahl der verwendeten Puffer hängt von den Optionen ab. Jede Operation kann zusätzlichen Speicher benötigen; beispielsweise kann die Komprimierung mit gz weitere 256KiB Speicher beanspruchen.

Zulässige Werte sind 16KiB, 32KiB, 64KiB, 128KiB, 256KiB, 512KiB, 1MiB, 2MiB, 4MiB, 8MiB und 16MiB.

default: 1MiB
example: --buffer-size=2MiB

Option für den SSH-Client-Befehl (--cmd-ssh)

SSH-Client-Befehl.

Einen bestimmten SSH-Client-Befehl verwenden, wenn eine Alternative gewünscht wird oder der Befehl ssh nicht in $PATH liegt.

default: ssh
example: --cmd-ssh=/usr/bin/ssh

Option für die Netzwerkkomprimierungsstufe (--compress-level-network)

Komprimierungsstufe für die Netzwerkübertragung.

Legt die Komprimierungsstufe für die Netzwerkübertragung fest, wenn compress-type=none gilt und der Befehl nicht auf demselben Host wie das Repository ausgeführt wird. Die Komprimierung verringert den Netzwerkverkehr. Wenn compress-type nicht none ist, wird compress-level-network ignoriert und stattdessen compress-level verwendet, damit die Datei nur einmal komprimiert wird.

default: 1
allowed: [-5, 12]
example: --compress-level-network=1

Option für die Konfigurationsdatei (--config)

pgBackRest-Konfigurationsdatei.

Mit dieser Option eine andere als die standardmäßige Konfigurationsdatei angeben.

default: CFGOPTDEF_CONFIG_PATH "/" PROJECT_CONFIG_FILE
example: --config=/conf/pgbackrest/pgbackrest.conf

Option für den Pfad zusätzlicher Konfigurationsdateien (--config-include-path)

Pfad zu zusätzlichen pgBackRest-Konfigurationsdateien.

Konfigurationsdateien mit der Endung .conf am angegebenen Speicherort werden mit der pgBackRest-Konfigurationsdatei zu einer einzigen Konfigurationsdatei zusammengefügt.

default: CFGOPTDEF_CONFIG_PATH "/" PROJECT_CONFIG_INCLUDE_PATH
example: --config-include-path=/conf/pgbackrest/conf.d

Option für den Konfigurationspfad (--config-path)

Basispfad der pgBackRest-Konfigurationsdateien.

Diese Einstellung überschreibt den standardmäßigen Basispfad der Optionen --config und --config-include-path, sofern diese nicht ausdrücklich in der Befehlszeile gesetzt werden.

Wird beispielsweise nur --config-path=/conf/pgbackrest angegeben, erhält --config den Standardwert /conf/pgbackrest/pgbackrest.conf und --config-include-path den Standardwert /conf/pgbackrest/conf.d.

default: CFGOPTDEF_CONFIG_PATH
example: --config-path=/conf/pgbackrest

Option für das I/O-Zeitlimit (--io-timeout)

I/O-Zeitlimit.

Zeitlimit in Sekunden für Verbindungen sowie Lese- und Schreiboperationen.

Die gesamte Lese- oder Schreiboperation muss nicht innerhalb dieses Zeitlimits abgeschlossen sein, aber es muss irgendein Fortschritt erzielt werden, selbst wenn es nur ein einziges Byte ist.

default: 1m
allowed: [100ms, 1h]
example: --io-timeout=120

Option für den Sperrdateipfad (--lock-path)

Pfad zum Speichern der Sperrdateien.

In diesem Pfad erstellt pgBackRest Sperrdateien, um die gleichzeitige Ausführung miteinander in Konflikt stehender Operationen zu verhindern.

default: /tmp/pgbackrest
example: --lock-path=/backup/db/lock

Option für eine neutrale umask (--neutral-umask)

Eine neutrale umask verwenden.

Setzt die umask auf 0000, damit die Zugriffsrechte im Repository sinnvoll gesetzt werden. Standardmäßig erhalten Verzeichnisse den Modus 0750 und Dateien den Modus 0640.

Um stattdessen die umask des ausführenden Benutzers zu verwenden, neutral-umask=n in der Konfigurationsdatei oder --no-neutral-umask in der Befehlszeile angeben.

default: y
example: --no-neutral-umask

Option für die Prozesspriorität (--priority)

Prozesspriorität festlegen.

Legt fest, welche Priorität (also welcher nice-Wert) dem Prozess vom Kernel-Scheduler zugewiesen wird. Positive Werte verringern die Priorität, negative Werte erhöhen sie. In den meisten Fällen dürfen Prozesse ihre Priorität nicht erhöhen.

allowed: [-20, 19]
example: --priority=19

Option für das Protokollzeitlimit (--protocol-timeout)

Protokollzeitlimit.

Legt in Sekunden fest, wie lange der lokale oder entfernte Prozess auf eine neue Nachricht auf der Protokollebene wartet. Dies verhindert, dass Prozesse unbegrenzt auf eine Nachricht warten.

HINWEIS: Der Wert von protocol-timeout muss größer sein als der von db-timeout.

default: 31m
allowed: [100ms, 7d]
example: --protocol-timeout=630

Option für Keep-alive (--sck-keep-alive)

Keep-alive aktivieren.

Aktiviert Keep-alive-Nachrichten auf Socket-Verbindungen.

default: y
example: --no-sck-keep-alive

Option für die Stanza (--stanza)

Definiert die Stanza.

Eine Stanza ist die Konfiguration eines PostgreSQL-Datenbankclusters. Sie legt unter anderem dessen Speicherort, das Backup-Verfahren und die Archivierungsoptionen fest. Die meisten Datenbankserver haben nur einen PostgreSQL-Datenbankcluster und daher nur eine Stanza. Backup-Server haben dagegen für jeden zu sichernden Datenbankcluster eine Stanza.

Es liegt nahe, die Stanza nach dem Primärcluster zu benennen. Ein besserer Name beschreibt jedoch die im Cluster enthaltenen Datenbanken. Da der Stanza-Name für den Primärserver und alle Replikate verwendet wird, sollte er die tatsächliche Funktion des Clusters beschreiben, etwa app oder dw, statt den lokalen Clusternamen wie main oder prod zu übernehmen.

example: --stanza=main

Option für die Keep-alive-Anzahl (--tcp-keep-alive-count)

Anzahl der Keep-alive-Nachrichten.

Legt fest, wie viele TCP-Keep-alive-Nachrichten verloren gehen dürfen, bevor die Verbindung als unterbrochen gilt.

Diese Option ist auf Systemen verfügbar, die die Socket-Option TCP_KEEPCNT unterstützen.

allowed: [1, 32]
example: --tcp-keep-alive-count=3

Option für die Keep-alive-Leerlaufzeit (--tcp-keep-alive-idle)

Keep-alive-Leerlaufzeit.

Legt die Zeit ohne Netzwerkaktivität in Sekunden fest, nach der das Betriebssystem eine TCP-Keep-alive-Nachricht senden sollte.

Diese Option ist auf Systemen verfügbar, die die Socket-Option TCP_KEEPIDLE unterstützen.

allowed: [1, 3600]
example: --tcp-keep-alive-idle=60

Option für das Keep-alive-Intervall (--tcp-keep-alive-interval)

Keep-alive-Intervall.

Legt die Zeit in Sekunden fest, nach der eine nicht bestätigte TCP-Keep-alive-Nachricht erneut gesendet werden sollte.

Diese Option ist auf Systemen verfügbar, die die Socket-Option TCP_KEEPINTVL unterstützen.

allowed: [1, 900]
example: --tcp-keep-alive-interval=30

Option für TLSv1.2-Cipher-Suites (--tls-cipher-12)

Zulässige TLSv1.2-Cipher-Suites.

Alle TLS-Verbindungen zwischen pgBackRest-Client und -Server sind verschlüsselt. Standardmäßig sind auch Verbindungen zu Objektspeichern wie S3 verschlüsselt.

HINWEIS: TLSv1.2 ist das absolute Mindestsicherheitsniveau für jede Transportverbindung.

Die akzeptierten Cipher-Suites können bei Bedarf angepasst werden. Das Beispiel ist eine sinnvolle Wahl, sofern keine besonderen Sicherheitsanforderungen bestehen. Ist die Option nicht gesetzt (Standardeinstellung), gilt die Vorgabe der zugrunde liegenden OpenSSL-Bibliothek.

example: --tls-cipher-12=HIGH:MEDIUM:+3DES:!aNULL

Option für TLSv1.3-Cipher-Suites (--tls-cipher-13)

Zulässige TLSv1.3-Cipher-Suites.

Alle TLS-Verbindungen zwischen pgBackRest-Client und -Server sind verschlüsselt. Standardmäßig sind auch Verbindungen zu Objektspeichern wie S3 verschlüsselt.

HINWEIS: TLSv1.2 ist das absolute Mindestsicherheitsniveau für jede Transportverbindung.

Die akzeptierten Cipher-Suites können bei Bedarf angepasst werden. Ist die Option nicht gesetzt (Standardeinstellung), gilt die Vorgabe der zugrunde liegenden OpenSSL-Bibliothek.

example: --tls-cipher-13=TLS_AES_256_GCM_SHA384:TLS_CHACHA20_POLY1305_SHA256

Protokollierungsoptionen

Option für die Protokollierungsstufe der Konsole (--log-level-console)

Protokollierungsstufe für die Konsole.

Die folgenden Protokollierungsstufen werden unterstützt:

• off - Keine Protokollierung (nicht empfohlen)
• error - Nur Fehler protokollieren
• warn - Warnungen und Fehler protokollieren
• info - Informationen, Warnungen und Fehler protokollieren
• detail - Details, Informationen, Warnungen und Fehler protokollieren
• debug - Debug-Meldungen, Details, Informationen, Warnungen und Fehler protokollieren
• trace - Trace-Meldungen (sehr ausführliche Debug-Ausgaben), Debug-Meldungen, Informationen, Warnungen und Fehler protokollieren

default: warn
example: --log-level-console=error

Option für die Protokollierungsstufe der Datei (--log-level-file)

Protokollierungsstufe für die Dateiausgabe.

Die folgenden Protokollierungsstufen werden unterstützt:

• off - Keine Protokollierung (nicht empfohlen)
• error - Nur Fehler protokollieren
• warn - Warnungen und Fehler protokollieren
• info - Informationen, Warnungen und Fehler protokollieren
• detail - Details, Informationen, Warnungen und Fehler protokollieren
• debug - Debug-Meldungen, Details, Informationen, Warnungen und Fehler protokollieren
• trace - Trace-Meldungen (sehr ausführliche Debug-Ausgaben), Debug-Meldungen, Informationen, Warnungen und Fehler protokollieren

default: info
example: --log-level-file=debug

Option für die Protokollierungsstufe der Standardfehlerausgabe (--log-level-stderr)

Protokollierungsstufe für stderr.

Legt fest, welche Protokollierungsstufen an stderr statt an stdout ausgegeben werden (festgelegt durch log-level-console). Zeitstempel und Prozess werden nicht an stderr ausgegeben.

Die folgenden Protokollierungsstufen werden unterstützt:

• off - Keine Protokollierung (nicht empfohlen)
• error - Nur Fehler protokollieren
• warn - Warnungen und Fehler protokollieren
• info - Informationen, Warnungen und Fehler protokollieren
• detail - Details, Informationen, Warnungen und Fehler protokollieren
• debug - Debug-Meldungen, Details, Informationen, Warnungen und Fehler protokollieren
• trace - Trace-Meldungen (sehr ausführliche Debug-Ausgaben), Debug-Meldungen, Informationen, Warnungen und Fehler protokollieren

default: off
example: --log-level-stderr=error

Option für den Protokollpfad (--log-path)

Pfad, an dem Protokolldateien gespeichert werden.

In diesem Pfad speichert pgBackRest seine Protokolldateien. Bei log-level-file=off ist kein Protokollpfad erforderlich.

default: /var/log/pgbackrest
example: --log-path=/backup/db/log

Option für die Protokollierung von Unterprozessen (--log-subprocess)

Protokollierung in Unterprozessen aktivieren.

Aktiviert die Dateiprotokollierung für alle von diesem Prozess erzeugten Unterprozesse mit der durch log-level-file festgelegten Protokollierungsstufe.

default: n
example: --log-subprocess

Option für Zeitstempel im Protokoll (--log-timestamp)

Zeitstempel in der Protokollierung aktivieren.

Aktiviert Zeitstempel in der Konsolen- und Dateiprotokollierung. Diese Option wird in besonderen Situationen deaktiviert, etwa beim Erzeugen der Dokumentation.

default: y
example: --no-log-timestamp

Repository-Optionen

Option zur Auswahl des Repositorys (--repo)

Repository festlegen.

Legt das Repository fest, auf das ein Befehl wirken soll.

Damit kann beispielsweise eine Wiederherstellung aus einem bestimmten Repository durchgeführt werden, anstatt pgBackRest die Auswahl zu überlassen.

allowed: [1, 256]
example: --repo=1

Option für den Azure-Container des Repositorys (--repo-azure-container)

Azure-Repository-Container.

Azure-Container, der das Repository speichert.

pgBackRest-Repositorys können mit repo-path=/ im Stammverzeichnis des Containers gespeichert werden. Meist ist jedoch ein Präfix wie /repo sinnvoll, damit auch Protokolle und andere von Azure erzeugte Inhalte im Container gespeichert werden können.

example: --repo1-azure-container=pg-backup

Option für den Azure-Schlüsseltyp des Repositorys (--repo-azure-key-type)

Azure-Repository-Schlüsseltyp.

Folgende Typen werden für die Autorisierung unterstützt:

• shared - Gemeinsamer Schlüssel
• sas - Signatur für gemeinsamen Zugriff
• auto - Automatische Autorisierung mit verwalteten Azure-Identitäten

default: shared
example: --repo1-azure-key-type=sas

Option für den Azure-URI-Stil des Repositorys (--repo-azure-uri-style)

Azure-URI-Stil.

Folgende URI-Stile werden unterstützt:

• host - Verbindung zum account.endpoint-Host herstellen.
• path - Verbindung zum endpoint-Host herstellen und den Kontonamen vor die URIs stellen.

default: host
example: --repo1-azure-uri-style=path

Option für den Verschlüsselungstyp des Repositorys (--repo-cipher-type)

Verfahren zur Verschlüsselung des Repositorys.

Folgende Verschlüsselungstypen werden unterstützt:

• none - Das Repository ist nicht verschlüsselt
• aes-256-cbc - Advanced Encryption Standard mit Schlüssellänge von 256 Bit

Beachten Sie, dass die Verschlüsselung immer clientseitig durchgeführt wird, selbst wenn der Repository-Typ (z. B. S3) Verschlüsselung unterstützt.

default: none
example: --repo1-cipher-type=aes-256-cbc

Option für den GCS-Bucket des Repositorys (--repo-gcs-bucket)

GCS-Bucket des Repositorys.

GCS-Bucket, in dem das Repository gespeichert wird.

pgBackRest-Repositorys können mit repo-path=/ im Stammverzeichnis des Buckets gespeichert werden. Meist ist jedoch ein Präfix wie /repo sinnvoll, damit auch Protokolle und andere von GCS erzeugte Inhalte im Bucket gespeichert werden können.

example: --repo1-gcs-bucket=/pg-backup

Option für den GCS-Endpunkt des Repositorys (--repo-gcs-endpoint)

GCS-Repository-Endpunkt.

Endpunkt, der zum Verbinden mit dem Speicherdienst verwendet wird. Kann aktualisiert werden, um einen lokalen GCS-Server oder einen alternativen Endpunkt zu verwenden.

default: storage.googleapis.com
example: --repo1-gcs-endpoint=localhost

Option für den GCS-Schlüsseltyp des Repositorys (--repo-gcs-key-type)

GCS-Repository-Schlüsseltyp.

Folgende Typen werden für die Autorisierung unterstützt:

• auto - Autorisierung mithilfe des Dienstkontos der Instanz.
• service - Dienstkonto anhand eines lokal gespeicherten Schlüssels.
• token - Für lokale Tests, z. B. fakegcs.

Wenn repo-gcs-key-type=service ist, werden die Anmeldeinformationen erneut geladen, wenn das Authentifizierungstoken erneuert wird.

default: service
example: --repo1-gcs-key-type=auto

Option für die GCS-Projekt-ID des Repositorys (--repo-gcs-user-project)

GCS-Projekt-ID.

GCS-Projekt-ID, die zur Bestimmung der Abrechnung von Anfragen verwendet wird.

example: --repo1-gcs-user-project=my-project

Option für den Repository-Host (--repo-host)

Repository-Host bei entfernter Ausführung.

Für Backups und Archivierung auf einem lokal eingehängten Dateisystem ist diese Einstellung nicht erforderlich.

example: --repo1-host=repo1.domain.com

Veralteter Name: backup-host

Option für die CA-Datei des Repository-Hosts (--repo-host-ca-file)

Datei mit den Zertifizierungsstellen für den Repository-Host.

Für Verbindungen zum Repository-Host eine andere als die systemweite CA-Datei verwenden.

example: --repo1-host-ca-file=/etc/pki/tls/certs/ca-bundle.crt

Option für den CA-Pfad des Repository-Hosts (--repo-host-ca-path)

Pfad mit den Zertifizierungsstellen für den Repository-Host.

Für Verbindungen zum Repository-Host einen anderen als den systemweiten CA-Pfad verwenden.

example: --repo1-host-ca-path=/etc/pki/tls/certs

Option für die Zertifikatdatei des Repository-Hosts (--repo-host-cert-file)

Zertifikatdatei für den Repository-Host.

Wird an den Repository-Host gesendet, um die Client-Identität zu bestätigen.

example: --repo1-host-cert-file=/path/to/client.crt

Option für den Befehl auf dem Repository-Host (--repo-host-cmd)

pgBackRest-Befehl auf dem Repository-Host.

Erforderlich nur, wenn der Pfad zum pgBackRest-Befehl auf dem lokalen und dem Repository-Host unterschiedlich ist. Wenn nicht definiert, wird der Repository-Host-Befehl auf den gleichen Wert wie der lokale Befehl gesetzt.

default: [path of executed pgbackrest binary]
example: --repo1-host-cmd=/usr/lib/backrest/bin/pgbackrest

Veralteter Name: backup-cmd

Option für die Konfiguration des Repository-Hosts (--repo-host-config)

pgBackRest-Konfigurationsdatei auf dem Repository-Host.

Legt den Speicherort der Konfigurationsdatei auf dem Repository-Host fest. Dies ist nur erforderlich, wenn sich die Repository-Host-Konfigurationsdatei an einem anderen Ort befindet als die lokale Konfigurationsdatei.

default: CFGOPTDEF_CONFIG_PATH "/" PROJECT_CONFIG_FILE
example: --repo1-host-config=/conf/pgbackrest/pgbackrest.conf

Veralteter Name: backup-config

Option für zusätzliche Konfigurationsdateien auf dem Repository-Host (--repo-host-config-include-path)

Pfad zu zusätzlichen pgBackRest-Konfigurationsdateien auf dem Repository-Host.

Legt den Pfad für zusätzliche Konfigurationsdateien auf dem Repository-Host fest. Dies ist nur erforderlich, wenn dieser Pfad auf dem Repository-Host vom entsprechenden lokalen Pfad abweicht.

default: CFGOPTDEF_CONFIG_PATH "/" PROJECT_CONFIG_INCLUDE_PATH
example: --repo1-host-config-include-path=/conf/pgbackrest/conf.d

Option für den Konfigurationspfad des Repository-Hosts (--repo-host-config-path)

pgBackRest-Konfigurationspfad auf dem Repository-Host.

Legt den Konfigurationspfad auf dem Repository-Host fest. Dies ist nur erforderlich, wenn dieser Pfad auf dem Repository-Host vom lokalen Konfigurationspfad abweicht.

default: CFGOPTDEF_CONFIG_PATH
example: --repo1-host-config-path=/conf/pgbackrest

Option für die Schlüsseldatei des Repository-Hosts (--repo-host-key-file)

Schlüsseldatei für den Repository-Host.

Weist nach, dass das Client-Zertifikat von seinem Eigentümer gesendet wurde.

example: --repo1-host-key-file=/path/to/client.key

Option für den Port des Repository-Hosts (--repo-host-port)

Port des Repository-Hosts, wenn repo-host gesetzt ist.

Mit dieser Option einen anderen als den Standardport für das Protokoll des Repository-Hosts angeben.

HINWEIS: Bei repo-host-type=ssh gibt es keinen Standardwert für repo-host-port. In diesem Fall wird der Port verwendet, der für den durch cmd-ssh angegebenen Befehl konfiguriert ist.

default (depending on repo-host-type):
    tls - 8432

allowed: [0, 65535]
example: --repo1-host-port=25

Veralteter Name: backup-ssh-port

Option für den Protokolltyp des Repository-Hosts (--repo-host-type)

Protokolltyp für den Repository-Host.

Die folgenden Protokolltypen werden unterstützt:

• ssh - Secure Shell.
• tls - pgBackRest-TLS-Server.

default: ssh
example: --repo1-host-type=tls

Option für den Benutzer auf dem Repository-Host (--repo-host-user)

Benutzer auf dem Repository-Host, wenn repo-host gesetzt ist.

Legt den Benutzer für Operationen auf dem Repository-Host fest. Vorzugsweise ist dies nicht postgres, sondern ein anderer Benutzer wie pgbackrest. Läuft PostgreSQL auf dem Repository-Host, kann der Benutzer postgres der Gruppe pgbackrest hinzugefügt werden. So erhält er Leserechte für das Repository, ohne dessen Inhalt versehentlich beschädigen zu können.

default: pgbackrest
example: --repo1-host-user=repo-user

Veralteter Name: backup-user

Option für den Repository-Pfad (--repo-path)

Pfad zum Speichern von Backups und Archiv.

Im Repository speichert pgBackRest Backups und archiviert WAL-Segmente.

Der benötigte Speicherplatz lässt sich im Voraus oft schwer abschätzen. Am besten erstellen Sie einige Backups, erfassen die Größe verschiedener Backup-Typen (full/incr/diff) und messen die täglich erzeugte WAL-Menge. So erhalten Sie einen ungefähren Überblick über den Platzbedarf. Dieser wird sich im Laufe der Zeit mit der Entwicklung der Datenbank wahrscheinlich ändern.

default: /var/lib/pgbackrest
example: --repo1-path=/backup/db/backrest

Option für den S3-Bucket des Repositorys (--repo-s3-bucket)

S3-Bucket des Repositorys.

S3-Bucket, in dem das Repository gespeichert wird.

pgBackRest-Repositorys können mit repo-path=/ im Stammverzeichnis des Buckets gespeichert werden. Meist ist jedoch ein Präfix wie /repo sinnvoll, damit auch Protokolle und andere von AWS erzeugte Inhalte im Bucket gespeichert werden können.

example: --repo1-s3-bucket=pg-backup

Option für den S3-Endpunkt des Repositorys (--repo-s3-endpoint)

S3-Endpunkt des Repositorys.

Der AWS-Endpunkt sollte für die ausgewählte Region gültig sein.

Für angepasste Konfigurationen oder Tests können die Optionen repo-storage-ca-file, repo-storage-ca-path, repo-storage-host, repo-storage-port und repo-storage-verify-tls hilfreich sein.

example: --repo1-s3-endpoint=s3.amazonaws.com

Option für den S3-Schlüsseltyp des Repositorys (--repo-s3-key-type)

S3-Schlüsseltyp des Repositorys.

Die folgenden Typen werden unterstützt:

• shared - Gemeinsame Schlüssel
• auto - Temporäre Anmeldeinformationen automatisch abrufen
• web-id - Anmeldeinformationen für eine Web-Identität automatisch abrufen
• pod-id - Anmeldeinformationen für eine EKS-Pod-Identität automatisch abrufen
• process - Anmeldeinformationen durch Ausführen eines Prozesses abrufen

default: shared
example: --repo1-s3-key-type=auto

Option für die KMS-Schlüssel-ID des S3-Repositorys (--repo-s3-kms-key-id)

KMS-Schlüssel für das S3-Repository.

Aktiviert die serverseitige S3-Verschlüsselung mit dem angegebenen Schlüssel des AWS Key Management Service.

example: --repo1-s3-kms-key-id=bceb4f13-6939-4be3-910d-df54dee817b7

Option für den S3-Authentifizierungsprozess (--repo-s3-process-cmd)

Befehl für den S3-Authentifizierungsprozess.

Befehl mit optionalen Argumenten zum Abrufen temporärer S3-Anmeldeinformationen. Der erste Listeneintrag ist der Befehl; die übrigen Einträge werden als Parameter übergeben.

Der Prozess muss JSON mit den Feldern AccessKeyId, SecretAccessKey, SessionToken und Expiration ausgeben. Die Anmeldeinformationen werden vor ihrem Ablauf automatisch erneuert. Einzelheiten zum Format finden Sie unter Anmeldeinformationen aus einem Prozess .

example: --repo1-s3-process-cmd=/usr/local/bin/get-credentials --repo1-s3-process-cmd=--role --repo1-s3-process-cmd=my-role

Option für die S3-Region des Repositorys (--repo-s3-region)

S3-Region des Repositorys.

AWS-Region, in der der Bucket erstellt wurde.

example: --repo1-s3-region=us-east-1

Option für die Kostenübernahme durch den S3-Anforderer (--repo-s3-requester-pays)

Kostenübernahme durch den Anforderer beim S3-Repository.

Aktiviert die S3-Kostenübernahme durch den Anforderer.

default: n
example: --no-repo1-s3-requester-pays

Option für die S3-Rolle des Repositorys (--repo-s3-role)

S3-Rolle des Repositorys.

Name der AWS-Rolle (nicht der vollständige ARN) zum Abrufen temporärer Anmeldeinformationen bei repo-s3-key-type=auto.

example: --repo1-s3-role=authrole

Option für den S3-Dienst des Repositorys (--repo-s3-service)

S3-Signaturdienst.

Der bei der SigV4-Authentifizierung verwendete S3-Signaturdienst. Für standardmäßige S3-Endpunkte ist der Standardwert s3. Bei einem S3-Outposts-Endpunkt auf s3-outposts setzen.

default: s3
example: --repo1-s3-service=s3-outposts

Option für den STS-Endpunkt des S3-Repositorys (--repo-s3-sts-host)

STS-Endpunkt des S3-Repositorys.

STS-Endpunkt zum Abrufen temporärer Anmeldeinformationen, wenn repo-s3-key-type=web-id konfiguriert ist. Einen regionalen Endpunkt wie sts.us-east-1.amazonaws.com angeben, um regionales STS zu verwenden. Dies kann für GovCloud, Regionen in China oder zur Verringerung der Latenz erforderlich sein.

default: sts.amazonaws.com
example: --repo1-s3-sts-host=sts.us-east-1.amazonaws.com

Option für den S3-URI-Stil des Repositorys (--repo-s3-uri-style)

S3-URI-Stil.

Folgende URI-Stile werden unterstützt:

• host - Mit dem Host bucket.endpoint verbinden.
• path - Mit dem Host endpoint verbinden und den Bucket den URIs voranstellen.

default: host
example: --repo1-s3-uri-style=path

Option für den SFTP-Host des Repositorys (--repo-sftp-host)

SFTP-Host des Repositorys.

SFTP-Host, auf dem sich das Repository befindet.

example: --repo1-sftp-host=sftprepo.domain

Option für den Fingerabdruck des SFTP-Hosts (--repo-sftp-host-fingerprint)

Fingerabdruck des SFTP-Hosts des Repositorys.

Die Erzeugung des Fingerabdrucks für den SFTP-Host des Repositorys sollte repo-sftp-host-key-hash-type entsprechen. Den Fingerabdruck mit awk '{print $2}' ssh_host_xxx_key.pub | base64 -d | (md5sum or sha1sum) -b erzeugen. Die SSH-Hostschlüssel befinden sich normalerweise im Verzeichnis /etc/ssh.

example: --repo1-sftp-host-fingerprint=f84e172dfead7aeeeae6c1fdfb5aa8cf

Option für die SFTP-Hostschlüsselprüfung (--repo-sftp-host-key-check-type)

Art der SFTP-Hostschlüsselprüfung.

Die folgenden Arten der SFTP-Hostschlüsselprüfung werden unterstützt:

• strict - pgBackRest fügt niemals automatisch Hostschlüssel zur Datei ~/.ssh/known_hosts hinzu und verweigert Verbindungen zu Hosts, deren Hostschlüssel geändert wurde oder in den Dateien mit bekannten Hosts fehlt. Bei dieser Option muss der Benutzer alle neuen Hosts manuell hinzufügen.
• accept-new - pgBackRest fügt neue Hostschlüssel automatisch zur Datei mit bekannten Hosts des Benutzers hinzu, lässt aber keine Verbindungen zu Hosts mit geändertem Hostschlüssel zu.
• fingerprint - pgBackRest prüft den Hostschlüssel anhand des mit repo-sftp-host-fingerprint angegebenen Fingerabdrucks.
• none - Es wird keine Hostschlüsselprüfung durchgeführt.

default: strict
example: --repo1-sftp-host-key-check-type=accept-new

Option für den Hash-Typ des SFTP-Hostschlüssels (--repo-sftp-host-key-hash-type)

Hash-Typ des SFTP-Hostschlüssels für das Repository.

Hash-Typ des SFTP-Hostschlüssels für das Repository. Legt den Hash-Typ fest, mit dem beim SSH-Verbindungsaufbau der Hashwert des Hostschlüssels des entfernten Systems berechnet wird. Neuere Versionen von libssh2 unterstützen neben md5 und sha1 auch sha256.

example: --repo1-sftp-host-key-hash-type=sha256

Option für den Port des SFTP-Hosts (--repo-sftp-host-port)

Port des SFTP-Hosts für das Repository.

Port des SFTP-Hosts für das Repository.

default: 22
allowed: [1, 65535]
example: --repo1-sftp-host-port=22

Option für den Benutzer auf dem SFTP-Host (--repo-sftp-host-user)

Benutzer auf dem SFTP-Host für das Repository.

Benutzer auf dem Host, auf dem das Repository gespeichert wird.

example: --repo1-sftp-host-user=pg-backup

Option für die Datei bekannter SFTP-Hosts (--repo-sftp-known-host)

Datei mit bekannten SFTP-Hosts.

Datei mit bekannten Hosts, in der bei der Authentifizierung nach einem passenden SFTP-Host gesucht wird. Ohne Angabe durchsucht pgBackRest standardmäßig ~/.ssh/known_hosts, ~/.ssh/known_hosts2, /etc/ssh/ssh_known_hosts und /etc/ssh/ssh_known_hosts2. Sind ein oder mehrere Dateipfade konfiguriert, durchsucht pgBackRest diese nach einem passenden Eintrag. Dateipfade müssen vollständig sein oder mit einer Tilde beginnen. Die Option repo-sftp-known-host kann mehrfach angegeben werden, um mehrere Dateien mit bekannten Hosts zu durchsuchen. Für die Prüfung anhand dieser Dateien darf repo-sftp-host-fingerprint nicht angegeben sein. Siehe auch die Option repo-sftp-host-check-type.

example: --repo1-sftp-known-host=/home/postgres/.ssh/known_hosts

Option für die private SFTP-Schlüsseldatei (--repo-sftp-private-key-file)

Datei mit dem privaten SFTP-Schlüssel.

Datei mit dem privaten SFTP-Schlüssel zur Authentifizierung.

example: --repo1-sftp-private-key-file=~/.ssh/id_ed25519

Option für die öffentliche SFTP-Schlüsseldatei (--repo-sftp-public-key-file)

Datei mit dem öffentlichen SFTP-Schlüssel.

Datei mit dem öffentlichen SFTP-Schlüssel zur Authentifizierung. Bei einer gegen OpenSSL kompilierten Version optional, bei einer gegen eine andere Bibliothek kompilierten Version erforderlich.

example: --repo1-sftp-public-key-file=~/.ssh/id_ed25519.pub

Option für die CA-Datei des Repository-Speichers (--repo-storage-ca-file)

CA-Datei für den Repository-Speicher.

Für Zertifikate des Speicherdienstes (z. B. S3 oder Azure) eine andere als die systemweite CA-Datei verwenden.

example: --repo1-storage-ca-file=/etc/pki/tls/certs/ca-bundle.crt

Veraltete Namen: repo-azure-ca-file, repo-s3-ca-file

Option für den TLS-CA-Pfad des Repository-Speichers (--repo-storage-ca-path)

CA-Pfad für den Repository-Speicher.

Für Zertifikate des Speicherdienstes (z. B. S3 oder Azure) einen anderen als den systemweiten CA-Pfad verwenden.

example: --repo1-storage-ca-path=/etc/pki/tls/certs

Veraltete Namen: repo-azure-ca-path, repo-s3-ca-path

Option für den Host des Repository-Speichers (--repo-storage-host)

Host des Repository-Speichers.

Mit einem anderen Host als dem Endpunkt des Speicherdienstes (z. B. S3 oder Azure) verbinden. Dies wird üblicherweise für Tests verwendet.

example: --repo1-storage-host=127.0.0.1

Veraltete Namen: repo-azure-host, repo-s3-host

Option für den Port des Repository-Speichers (--repo-storage-port)

Port des Repository-Speichers.

Port für Verbindungen zum Endpunkt des Speicherdienstes (z. B. S3 oder Azure) oder zum angegebenen Host.

default: 443
allowed: [1, 65535]
example: --repo1-storage-port=9000

Veraltete Namen: repo-azure-port, repo-s3-port

Option für Tags im Repository-Speicher (--repo-storage-tag)

Tags für den Repository-Speicher.

Tags angeben, die Objekten hinzugefügt werden, wenn das Repository ein Objektspeicher wie S3 ist. Die Option kann wiederholt werden, um mehrere Tags hinzuzufügen.

pgBackRest bietet keine Möglichkeit, diese Tags zu ändern. Deshalb sollten sie vor dem Ausführen von stanza-create korrekt gesetzt werden, damit die Tags im gesamten Repository einheitlich sind.

example: --repo1-storage-tag=key1=value1

Option für die Upload-Blockgröße des Repository-Speichers (--repo-storage-upload-chunk-size)

Blockgröße für Uploads in den Repository-Speicher.

Objektspeicher wie S3 erlauben das Hochladen von Dateien in Blöcken, wenn die Datei zu groß für den Arbeitsspeicher ist. Auch wenn die Datei in den Arbeitsspeicher passt, ist es speichereffizienter, den für Uploads verwendeten Speicher zu begrenzen.

Eine größere Blockgröße verbessert im Allgemeinen die Leistung, da sie die Anzahl der Upload-Anfragen verringert und es ermöglicht, mehr Dateien jeweils in einer einzelnen Anfrage statt in Blöcken hochzuladen. Nachteilig ist der höhere Speicherverbrauch. Da für jeden Prozess ein eigener Blockpuffer zugewiesen werden muss, erhöhen größere Werte für process-max den gesamten Speicherverbrauch zusätzlich.

Die zulässigen Blockgrößen unterscheiden sich je nach Speichertyp und Plattform. Beispielsweise beträgt die Mindestblockgröße bei AWS S3 5MiB. Auch die Bezeichnung variiert: Bei der Suche nach Mindest- und Höchstwerten für AWS S3 nach „part size“, für GCS nach „chunk size“ und für Azure nach „block size“ suchen.

Ist eine Datei größer als 1GiB (die maximale Dateigröße, die PostgreSQL standardmäßig erzeugt), wird die Blockgröße schrittweise bis zum zulässigen Maximum erhöht, um den Datei-Upload abzuschließen.

default (depending on repo-type):
    azure - 4MiB
    gcs - 4MiB
    s3 - 5MiB

allow range (depending on repo-type):
    azure - [4MiB, 1GiB]
    gcs - [4MiB, 1GiB]
    s3 - [5MiB, 1GiB]

example: --repo1-storage-upload-chunk-size=16MiB

Option zur Zertifikatprüfung des Repository-Speichers (--repo-storage-verify-tls)

Zertifikatprüfung für den Repository-Speicher.

Mit dieser Option lässt sich die Prüfung des TLS-Serverzertifikats des Speicherdienstes (z. B. S3 oder Azure) aktivieren oder deaktivieren. Die Prüfung sollte nur für Tests oder andere Situationen mit selbstsignierten Zertifikaten deaktiviert werden.

default: y
example: --no-repo1-storage-verify-tls

Veraltete Namen: repo-azure-verify-tls, repo-s3-verify-ssl, repo-s3-verify-tls

Option für den Repository-Typ (--repo-type)

Art des für das Repository verwendeten Speichers.

Die folgenden Repository-Typen werden unterstützt:

• azure - Azure Blob Storage Service
• cifs - Wie posix, deaktiviert jedoch Links und fsync für Verzeichnisse
• gcs - Google Cloud Storage
• posix - POSIX-konforme Dateisysteme
• s3 - AWS Simple Storage Service
• sftp - Secure File Transfer Protocol

Wird ein NFS-Mount als posix-Repository verwendet, gelten für pgBackRest dieselben Regeln wie in der PostgreSQL-Dokumentation beschrieben: Erstellen eines Datenbankclusters – Dateisysteme .

default: posix
example: --repo1-type=cifs

2 - Befehl zum Abrufen aus dem Archiv (archive-get)

PostgreSQL verwendet diesen Befehl, um ein Backup wiederherzustellen, PITR durchzuführen oder ein Replikat als Alternative zum Streaming aktuell zu halten. WAL-Segmente werden für die PostgreSQL-Recovery oder zur Pflege eines Replikats benötigt.

Sind mehrere Repositorys konfiguriert, werden WAL-Segmente in der Reihenfolge ihrer Priorität aus ihnen abgerufen (z. B. repo1, repo2 usw.). Im Allgemeinen sollte schnellerer oder günstigerer Speicher eine höhere Priorität erhalten. Wird mit --repo ein Repository angegeben, wird nur dieses durchsucht.

pgBackRest konfiguriert und erzeugt den Befehl archive-get während einer Wiederherstellung zur Verwendung durch PostgreSQL. Ein Beispiel finden Sie unter Point-in-Time-Recovery .

Befehlsoptionen

Option für asynchrone Archivierung (--archive-async)

WAL-Segmente asynchron übertragen und abrufen.

Aktiviert den asynchronen Betrieb für die Befehle archive-push und archive-get.

Der asynchrone Betrieb ist effizienter, da er Verbindungen wiederverwenden und parallele Verarbeitung nutzen kann. Weitere Informationen bieten die Optionen spool-path, archive-get-queue-max und archive-push-queue-max.

default: n
example: --archive-async

Option für die maximale Größe der Abrufwarteschlange (--archive-get-queue-max)

Maximale Größe der archive-get-Warteschlange von pgBackRest.

Legt die maximale Größe der archive-get-Warteschlange fest, wenn archive-async aktiviert ist. Die Warteschlange liegt im spool-path und beschleunigt die Bereitstellung von WAL für PostgreSQL.

default: 128MiB
allowed: [0B, 4PiB]
example: --archive-get-queue-max=1GiB

Option zum erneuten Abruf fehlender WAL-Segmente (--archive-missing-retry)

Abruf fehlender WAL-Segmente erneut versuchen

Ein WAL-Segment erneut abrufen, das der Befehl archive-get im asynchronen Modus zuvor als fehlend gemeldet hat. Dies verhindert, dass Meldungen einer früheren Wiederherstellung aus dem Spool-Pfad verwendet werden und möglicherweise die Recovery scheitern lassen, wenn noch kein konsistenter Zustand erreicht wurde.

Bei deaktivierter Option kann PostgreSQL zuverlässiger erkennen, wann das Ende des WAL im Archiv erreicht ist, und dann zum Streaming vom Primärserver wechseln. Bei aktivierten Wiederholungsversuchen führt ein stetiger Strom neu archivierter WAL-Segmente dazu, dass PostgreSQL weiterhin WAL aus dem Archiv abruft, statt zum Streaming zu wechseln.

Wird diese Option deaktiviert, muss sichergestellt werden, dass der Spool-Pfad der Stanza leer ist. Der Befehl restore erledigt dies automatisch, wenn der Spool-Pfad zum Zeitpunkt der Wiederherstellung konfiguriert ist. Andernfalls muss der Benutzer selbst dafür sorgen, dass der Spool-Pfad leer ist.

default: y
example: --no-archive-missing-retry

Option für das Archivierungszeitlimit (--archive-timeout)

Archivierungszeitlimit.

Maximale Wartezeit in Sekunden festlegen, bis ein einzelnes WAL-Segment das Archiv-Repository von pgBackRest erreicht. Dieses Zeitlimit gilt für die Befehle check und backup, wenn sie auf die Archivierung der WAL-Segmente warten, die für ein konsistentes Backup erforderlich sind.

default: 1m
allowed: [100ms, 1d]
example: --archive-timeout=30

Allgemeine Optionen

Option zur Ausführung als root (--allow-root)

Die Ausführung des Befehls als Benutzer root erlauben.

Standardmäßig darf nur der Befehl restore als Benutzer root ausgeführt werden, da er die Dateieigentümer sorgfältig verwaltet. Bei anderen Befehlen besteht das Risiko, dass Dateien entstehen, die root gehören, etwa im Repository. Diese sind für den PostgreSQL-Benutzer nicht zugänglich, sodass spätere Befehle fehlschlagen.

Diese Option aktivieren, um einen Befehl dennoch als root auszuführen. Es ist jedoch deutlich besser, pgBackRest als den Benutzer auszuführen, dem das Repository und der PostgreSQL-Cluster gehören.

default: n
example: --allow-root

Option für die Puffergröße (--buffer-size)

Puffergröße für I/O-Operationen.

Puffergröße für Kopier-, Komprimierungs-, Verschlüsselungs- und andere Operationen. Die Anzahl der verwendeten Puffer hängt von den Optionen ab. Jede Operation kann zusätzlichen Speicher benötigen; beispielsweise kann die Komprimierung mit gz weitere 256KiB Speicher beanspruchen.

Zulässige Werte sind 16KiB, 32KiB, 64KiB, 128KiB, 256KiB, 512KiB, 1MiB, 2MiB, 4MiB, 8MiB und 16MiB.

default: 1MiB
example: --buffer-size=2MiB

Option für den pgBackRest-Befehl (--cmd)

pgBackRest-Befehl.

pgBackRest kann eine Befehlszeichenfolge erzeugen, etwa wenn der Befehl restore die Einstellung restore_command erzeugt. Dafür wird der Befehl verwendet, mit dem der pgBackRest-Prozess gestartet wurde, sofern nicht die Option cmd angegeben ist.

ACHTUNG:

Das Einbetten des pgBackRest-Befehls in einen Wrapper kann unvorhersehbares Verhalten verursachen und wird nicht empfohlen.

default: [path of executed pgbackrest binary]
example: --cmd=/var/lib/pgsql/bin/pgbackrest_wrapper.sh

Option für den SSH-Client-Befehl (--cmd-ssh)

SSH-Client-Befehl.

Einen bestimmten SSH-Client-Befehl verwenden, wenn eine Alternative gewünscht wird oder der Befehl ssh nicht in $PATH liegt.

default: ssh
example: --cmd-ssh=/usr/bin/ssh

Option für die Netzwerkkomprimierungsstufe (--compress-level-network)

Komprimierungsstufe für die Netzwerkübertragung.

Legt die Komprimierungsstufe für die Netzwerkübertragung fest, wenn compress-type=none gilt und der Befehl nicht auf demselben Host wie das Repository ausgeführt wird. Die Komprimierung verringert den Netzwerkverkehr. Wenn compress-type nicht none ist, wird compress-level-network ignoriert und stattdessen compress-level verwendet, damit die Datei nur einmal komprimiert wird.

default: 1
allowed: [-5, 12]
example: --compress-level-network=1

Option für die Konfigurationsdatei (--config)

pgBackRest-Konfigurationsdatei.

Mit dieser Option eine andere als die standardmäßige Konfigurationsdatei angeben.

default: CFGOPTDEF_CONFIG_PATH "/" PROJECT_CONFIG_FILE
example: --config=/conf/pgbackrest/pgbackrest.conf

Option für den Pfad zusätzlicher Konfigurationsdateien (--config-include-path)

Pfad zu zusätzlichen pgBackRest-Konfigurationsdateien.

Konfigurationsdateien mit der Endung .conf am angegebenen Speicherort werden mit der pgBackRest-Konfigurationsdatei zu einer einzigen Konfigurationsdatei zusammengefügt.

default: CFGOPTDEF_CONFIG_PATH "/" PROJECT_CONFIG_INCLUDE_PATH
example: --config-include-path=/conf/pgbackrest/conf.d

Option für den Konfigurationspfad (--config-path)

Basispfad der pgBackRest-Konfigurationsdateien.

Diese Einstellung überschreibt den standardmäßigen Basispfad der Optionen --config und --config-include-path, sofern diese nicht ausdrücklich in der Befehlszeile gesetzt werden.

Wird beispielsweise nur --config-path=/conf/pgbackrest angegeben, erhält --config den Standardwert /conf/pgbackrest/pgbackrest.conf und --config-include-path den Standardwert /conf/pgbackrest/conf.d.

default: CFGOPTDEF_CONFIG_PATH
example: --config-path=/conf/pgbackrest

Option für das I/O-Zeitlimit (--io-timeout)

I/O-Zeitlimit.

Zeitlimit in Sekunden für Verbindungen sowie Lese- und Schreiboperationen.

Die gesamte Lese- oder Schreiboperation muss nicht innerhalb dieses Zeitlimits abgeschlossen sein, aber es muss irgendein Fortschritt erzielt werden, selbst wenn es nur ein einziges Byte ist.

default: 1m
allowed: [100ms, 1h]
example: --io-timeout=120

Option für den Sperrdateipfad (--lock-path)

Pfad zum Speichern der Sperrdateien.

In diesem Pfad erstellt pgBackRest Sperrdateien, um die gleichzeitige Ausführung miteinander in Konflikt stehender Operationen zu verhindern.

default: /tmp/pgbackrest
example: --lock-path=/backup/db/lock

Option für eine neutrale umask (--neutral-umask)

Eine neutrale umask verwenden.

Setzt die umask auf 0000, damit die Zugriffsrechte im Repository sinnvoll gesetzt werden. Standardmäßig erhalten Verzeichnisse den Modus 0750 und Dateien den Modus 0640.

Um stattdessen die umask des ausführenden Benutzers zu verwenden, neutral-umask=n in der Konfigurationsdatei oder --no-neutral-umask in der Befehlszeile angeben.

default: y
example: --no-neutral-umask

Option für die Prozesspriorität (--priority)

Prozesspriorität festlegen.

Legt fest, welche Priorität (also welcher nice-Wert) dem Prozess vom Kernel-Scheduler zugewiesen wird. Positive Werte verringern die Priorität, negative Werte erhöhen sie. In den meisten Fällen dürfen Prozesse ihre Priorität nicht erhöhen.

allowed: [-20, 19]
example: --priority=19

Option für die maximale Prozessanzahl (--process-max)

Maximale Anzahl der Prozesse für Komprimierung und Übertragung.

Jeder Prozess führt Komprimierung und Übertragung aus, um den Befehl zu beschleunigen. process-max jedoch nicht so hoch setzen, dass die Datenbankleistung beeinträchtigt wird.

default: 1
allowed: [1, 999]
example: --process-max=4

Option für das Protokollzeitlimit (--protocol-timeout)

Protokollzeitlimit.

Legt in Sekunden fest, wie lange der lokale oder entfernte Prozess auf eine neue Nachricht auf der Protokollebene wartet. Dies verhindert, dass Prozesse unbegrenzt auf eine Nachricht warten.

HINWEIS: Der Wert von protocol-timeout muss größer sein als der von db-timeout.

default: 31m
allowed: [100ms, 7d]
example: --protocol-timeout=630

Option für Keep-alive (--sck-keep-alive)

Keep-alive aktivieren.

Aktiviert Keep-alive-Nachrichten auf Socket-Verbindungen.

default: y
example: --no-sck-keep-alive

Option für den Spool-Pfad (--spool-path)

Pfad zum Speichern vorübergehend benötigter Daten.

In diesem Pfad werden Daten für die asynchronen Befehle archive-push und archive-get gespeichert.

Der asynchrone Befehl archive-push schreibt Bestätigungen in den Spool-Pfad, wenn WAL erfolgreich im Archiv gespeichert wurde, und Fehlermeldungen bei einem Fehlschlag. So kann der Vordergrundprozess PostgreSQL schnell benachrichtigen. Die Bestätigungsdateien sind sehr klein: bei Erfolg leer, bei Fehlern wenige hundert Byte groß.

Der asynchrone Befehl archive-get hält WAL im Spool-Pfad bereit, damit es auf Anfrage von PostgreSQL sehr schnell geliefert werden kann. Das Verschieben der Dateien zu PostgreSQL ist am effizientesten, wenn der Spool-Pfad auf demselben Dateisystem wie pg_xlog/pg_wal liegt. Es wird jedoch davon abgeraten, den Spool-Pfad innerhalb des Verzeichnisses pg_xlog/pg_wal anzulegen, da dies bei PostgreSQL-Werkzeugen wie pg_rewind Probleme verursachen kann.

Die Daten im Spool-Pfad sind nicht rein temporär, da sie einen Neustart überdauern können und sollten. Ihr Verlust ist jedoch kein Problem: Für archive-push prüft pgBackRest einfach jedes WAL-Segment erneut auf sichere Archivierung; für archive-get baut es die Warteschlange neu auf.

Der Spool-Pfad ist für ein lokales POSIX-kompatibles Dateisystem vorgesehen, nicht für ein entferntes Dateisystem wie NFS oder CIFS.

default: /var/spool/pgbackrest
example: --spool-path=/backup/db/spool

Option für die Stanza (--stanza)

Definiert die Stanza.

Eine Stanza ist die Konfiguration eines PostgreSQL-Datenbankclusters. Sie legt unter anderem dessen Speicherort, das Backup-Verfahren und die Archivierungsoptionen fest. Die meisten Datenbankserver haben nur einen PostgreSQL-Datenbankcluster und daher nur eine Stanza. Backup-Server haben dagegen für jeden zu sichernden Datenbankcluster eine Stanza.

Es liegt nahe, die Stanza nach dem Primärcluster zu benennen. Ein besserer Name beschreibt jedoch die im Cluster enthaltenen Datenbanken. Da der Stanza-Name für den Primärserver und alle Replikate verwendet wird, sollte er die tatsächliche Funktion des Clusters beschreiben, etwa app oder dw, statt den lokalen Clusternamen wie main oder prod zu übernehmen.

example: --stanza=main

Option für die Keep-alive-Anzahl (--tcp-keep-alive-count)

Anzahl der Keep-alive-Nachrichten.

Legt fest, wie viele TCP-Keep-alive-Nachrichten verloren gehen dürfen, bevor die Verbindung als unterbrochen gilt.

Diese Option ist auf Systemen verfügbar, die die Socket-Option TCP_KEEPCNT unterstützen.

allowed: [1, 32]
example: --tcp-keep-alive-count=3

Option für die Keep-alive-Leerlaufzeit (--tcp-keep-alive-idle)

Keep-alive-Leerlaufzeit.

Legt die Zeit ohne Netzwerkaktivität in Sekunden fest, nach der das Betriebssystem eine TCP-Keep-alive-Nachricht senden sollte.

Diese Option ist auf Systemen verfügbar, die die Socket-Option TCP_KEEPIDLE unterstützen.

allowed: [1, 3600]
example: --tcp-keep-alive-idle=60

Option für das Keep-alive-Intervall (--tcp-keep-alive-interval)

Keep-alive-Intervall.

Legt die Zeit in Sekunden fest, nach der eine nicht bestätigte TCP-Keep-alive-Nachricht erneut gesendet werden sollte.

Diese Option ist auf Systemen verfügbar, die die Socket-Option TCP_KEEPINTVL unterstützen.

allowed: [1, 900]
example: --tcp-keep-alive-interval=30

Option für TLSv1.2-Cipher-Suites (--tls-cipher-12)

Zulässige TLSv1.2-Cipher-Suites.

Alle TLS-Verbindungen zwischen pgBackRest-Client und -Server sind verschlüsselt. Standardmäßig sind auch Verbindungen zu Objektspeichern wie S3 verschlüsselt.

HINWEIS: TLSv1.2 ist das absolute Mindestsicherheitsniveau für jede Transportverbindung.

Die akzeptierten Cipher-Suites können bei Bedarf angepasst werden. Das Beispiel ist eine sinnvolle Wahl, sofern keine besonderen Sicherheitsanforderungen bestehen. Ist die Option nicht gesetzt (Standardeinstellung), gilt die Vorgabe der zugrunde liegenden OpenSSL-Bibliothek.

example: --tls-cipher-12=HIGH:MEDIUM:+3DES:!aNULL

Option für TLSv1.3-Cipher-Suites (--tls-cipher-13)

Zulässige TLSv1.3-Cipher-Suites.

Alle TLS-Verbindungen zwischen pgBackRest-Client und -Server sind verschlüsselt. Standardmäßig sind auch Verbindungen zu Objektspeichern wie S3 verschlüsselt.

HINWEIS: TLSv1.2 ist das absolute Mindestsicherheitsniveau für jede Transportverbindung.

Die akzeptierten Cipher-Suites können bei Bedarf angepasst werden. Ist die Option nicht gesetzt (Standardeinstellung), gilt die Vorgabe der zugrunde liegenden OpenSSL-Bibliothek.

example: --tls-cipher-13=TLS_AES_256_GCM_SHA384:TLS_CHACHA20_POLY1305_SHA256

Protokollierungsoptionen

Option für die Protokollierungsstufe der Konsole (--log-level-console)

Protokollierungsstufe für die Konsole.

Die folgenden Protokollierungsstufen werden unterstützt:

• off - Keine Protokollierung (nicht empfohlen)
• error - Nur Fehler protokollieren
• warn - Warnungen und Fehler protokollieren
• info - Informationen, Warnungen und Fehler protokollieren
• detail - Details, Informationen, Warnungen und Fehler protokollieren
• debug - Debug-Meldungen, Details, Informationen, Warnungen und Fehler protokollieren
• trace - Trace-Meldungen (sehr ausführliche Debug-Ausgaben), Debug-Meldungen, Informationen, Warnungen und Fehler protokollieren

default: warn
example: --log-level-console=error

Option für die Protokollierungsstufe der Datei (--log-level-file)

Protokollierungsstufe für die Dateiausgabe.

Die folgenden Protokollierungsstufen werden unterstützt:

• off - Keine Protokollierung (nicht empfohlen)
• error - Nur Fehler protokollieren
• warn - Warnungen und Fehler protokollieren
• info - Informationen, Warnungen und Fehler protokollieren
• detail - Details, Informationen, Warnungen und Fehler protokollieren
• debug - Debug-Meldungen, Details, Informationen, Warnungen und Fehler protokollieren
• trace - Trace-Meldungen (sehr ausführliche Debug-Ausgaben), Debug-Meldungen, Informationen, Warnungen und Fehler protokollieren

default: info
example: --log-level-file=debug

Option für die Protokollierungsstufe der Standardfehlerausgabe (--log-level-stderr)

Protokollierungsstufe für stderr.

Legt fest, welche Protokollierungsstufen an stderr statt an stdout ausgegeben werden (festgelegt durch log-level-console). Zeitstempel und Prozess werden nicht an stderr ausgegeben.

Die folgenden Protokollierungsstufen werden unterstützt:

• off - Keine Protokollierung (nicht empfohlen)
• error - Nur Fehler protokollieren
• warn - Warnungen und Fehler protokollieren
• info - Informationen, Warnungen und Fehler protokollieren
• detail - Details, Informationen, Warnungen und Fehler protokollieren
• debug - Debug-Meldungen, Details, Informationen, Warnungen und Fehler protokollieren
• trace - Trace-Meldungen (sehr ausführliche Debug-Ausgaben), Debug-Meldungen, Informationen, Warnungen und Fehler protokollieren

default: off
example: --log-level-stderr=error

Option für den Protokollpfad (--log-path)

Pfad, an dem Protokolldateien gespeichert werden.

In diesem Pfad speichert pgBackRest seine Protokolldateien. Bei log-level-file=off ist kein Protokollpfad erforderlich.

default: /var/log/pgbackrest
example: --log-path=/backup/db/log

Option für die Protokollierung von Unterprozessen (--log-subprocess)

Protokollierung in Unterprozessen aktivieren.

Aktiviert die Dateiprotokollierung für alle von diesem Prozess erzeugten Unterprozesse mit der durch log-level-file festgelegten Protokollierungsstufe.

default: n
example: --log-subprocess

Option für Zeitstempel im Protokoll (--log-timestamp)

Zeitstempel in der Protokollierung aktivieren.

Aktiviert Zeitstempel in der Konsolen- und Dateiprotokollierung. Diese Option wird in besonderen Situationen deaktiviert, etwa beim Erzeugen der Dokumentation.

default: y
example: --no-log-timestamp

Optionen für Maintainer

Option zum Erzwingen der PostgreSQL-Version (--pg-version-force)

PostgreSQL-Version erzwingen.

Verwendet die angegebene PostgreSQL-Version statt der Version, die automatisch aus pg_control oder WAL-Headern ermittelt wird. Dies ist hauptsächlich für PostgreSQL-Forks oder Entwicklungsversionen hilfreich, deren Werte von denen der veröffentlichten Version abweichen. Die von PostgreSQL über server_version_num gemeldete Version muss mit der erzwungenen Version übereinstimmen.

WARNUNG:

Diese Option mit Vorsicht verwenden: pg_control und WAL-Header werden weiterhin im erwarteten Format der angegebenen Version gelesen, also im Format der offiziellen Open-Source-Version von PostgreSQL. Ändert der Fork oder die Entwicklungsversion das Format von Feldern, auf die pgBackRest angewiesen ist, führt dies zu unerwartetem Verhalten. Im Allgemeinen funktioniert diese Option nur dann wie erwartet, wenn der Fork alle eigenen Strukturfelder nach den standardmäßigen PostgreSQL-Feldern hinzufügt.

example: --pg-version-force=15

Repository-Optionen

Option zur Auswahl des Repositorys (--repo)

Repository festlegen.

Legt das Repository fest, auf das ein Befehl wirken soll.

Damit kann beispielsweise eine Wiederherstellung aus einem bestimmten Repository durchgeführt werden, anstatt pgBackRest die Auswahl zu überlassen.

allowed: [1, 256]
example: --repo=1

Option für den Azure-Container des Repositorys (--repo-azure-container)

Azure-Repository-Container.

Azure-Container, der das Repository speichert.

pgBackRest-Repositorys können mit repo-path=/ im Stammverzeichnis des Containers gespeichert werden. Meist ist jedoch ein Präfix wie /repo sinnvoll, damit auch Protokolle und andere von Azure erzeugte Inhalte im Container gespeichert werden können.

example: --repo1-azure-container=pg-backup

Option für den Azure-Schlüsseltyp des Repositorys (--repo-azure-key-type)

Azure-Repository-Schlüsseltyp.

Folgende Typen werden für die Autorisierung unterstützt:

• shared - Gemeinsamer Schlüssel
• sas - Signatur für gemeinsamen Zugriff
• auto - Automatische Autorisierung mit verwalteten Azure-Identitäten

default: shared
example: --repo1-azure-key-type=sas

Option für den Azure-URI-Stil des Repositorys (--repo-azure-uri-style)

Azure-URI-Stil.

Folgende URI-Stile werden unterstützt:

• host - Verbindung zum account.endpoint-Host herstellen.
• path - Verbindung zum endpoint-Host herstellen und den Kontonamen vor die URIs stellen.

default: host
example: --repo1-azure-uri-style=path

Option für den Verschlüsselungstyp des Repositorys (--repo-cipher-type)

Verfahren zur Verschlüsselung des Repositorys.

Folgende Verschlüsselungstypen werden unterstützt:

• none - Das Repository ist nicht verschlüsselt
• aes-256-cbc - Advanced Encryption Standard mit Schlüssellänge von 256 Bit

Beachten Sie, dass die Verschlüsselung immer clientseitig durchgeführt wird, selbst wenn der Repository-Typ (z. B. S3) Verschlüsselung unterstützt.

default: none
example: --repo1-cipher-type=aes-256-cbc

Option für den GCS-Bucket des Repositorys (--repo-gcs-bucket)

GCS-Bucket des Repositorys.

GCS-Bucket, in dem das Repository gespeichert wird.

pgBackRest-Repositorys können mit repo-path=/ im Stammverzeichnis des Buckets gespeichert werden. Meist ist jedoch ein Präfix wie /repo sinnvoll, damit auch Protokolle und andere von GCS erzeugte Inhalte im Bucket gespeichert werden können.

example: --repo1-gcs-bucket=/pg-backup

Option für den GCS-Endpunkt des Repositorys (--repo-gcs-endpoint)

GCS-Repository-Endpunkt.

Endpunkt, der zum Verbinden mit dem Speicherdienst verwendet wird. Kann aktualisiert werden, um einen lokalen GCS-Server oder einen alternativen Endpunkt zu verwenden.

default: storage.googleapis.com
example: --repo1-gcs-endpoint=localhost

Option für den GCS-Schlüsseltyp des Repositorys (--repo-gcs-key-type)

GCS-Repository-Schlüsseltyp.

Folgende Typen werden für die Autorisierung unterstützt:

• auto - Autorisierung mithilfe des Dienstkontos der Instanz.
• service - Dienstkonto anhand eines lokal gespeicherten Schlüssels.
• token - Für lokale Tests, z. B. fakegcs.

Wenn repo-gcs-key-type=service ist, werden die Anmeldeinformationen erneut geladen, wenn das Authentifizierungstoken erneuert wird.

default: service
example: --repo1-gcs-key-type=auto

Option für die GCS-Projekt-ID des Repositorys (--repo-gcs-user-project)

GCS-Projekt-ID.

GCS-Projekt-ID, die zur Bestimmung der Abrechnung von Anfragen verwendet wird.

example: --repo1-gcs-user-project=my-project

Option für den Repository-Host (--repo-host)

Repository-Host bei entfernter Ausführung.

Für Backups und Archivierung auf einem lokal eingehängten Dateisystem ist diese Einstellung nicht erforderlich.

example: --repo1-host=repo1.domain.com

Veralteter Name: backup-host

Option für die CA-Datei des Repository-Hosts (--repo-host-ca-file)

Datei mit den Zertifizierungsstellen für den Repository-Host.

Für Verbindungen zum Repository-Host eine andere als die systemweite CA-Datei verwenden.

example: --repo1-host-ca-file=/etc/pki/tls/certs/ca-bundle.crt

Option für den CA-Pfad des Repository-Hosts (--repo-host-ca-path)

Pfad mit den Zertifizierungsstellen für den Repository-Host.

Für Verbindungen zum Repository-Host einen anderen als den systemweiten CA-Pfad verwenden.

example: --repo1-host-ca-path=/etc/pki/tls/certs

Option für die Zertifikatdatei des Repository-Hosts (--repo-host-cert-file)

Zertifikatdatei für den Repository-Host.

Wird an den Repository-Host gesendet, um die Client-Identität zu bestätigen.

example: --repo1-host-cert-file=/path/to/client.crt

Option für den Befehl auf dem Repository-Host (--repo-host-cmd)

pgBackRest-Befehl auf dem Repository-Host.

Erforderlich nur, wenn der Pfad zum pgBackRest-Befehl auf dem lokalen und dem Repository-Host unterschiedlich ist. Wenn nicht definiert, wird der Repository-Host-Befehl auf den gleichen Wert wie der lokale Befehl gesetzt.

default: [path of executed pgbackrest binary]
example: --repo1-host-cmd=/usr/lib/backrest/bin/pgbackrest

Veralteter Name: backup-cmd

Option für die Konfiguration des Repository-Hosts (--repo-host-config)

pgBackRest-Konfigurationsdatei auf dem Repository-Host.

Legt den Speicherort der Konfigurationsdatei auf dem Repository-Host fest. Dies ist nur erforderlich, wenn sich die Repository-Host-Konfigurationsdatei an einem anderen Ort befindet als die lokale Konfigurationsdatei.

default: CFGOPTDEF_CONFIG_PATH "/" PROJECT_CONFIG_FILE
example: --repo1-host-config=/conf/pgbackrest/pgbackrest.conf

Veralteter Name: backup-config

Option für zusätzliche Konfigurationsdateien auf dem Repository-Host (--repo-host-config-include-path)

Pfad zu zusätzlichen pgBackRest-Konfigurationsdateien auf dem Repository-Host.

Legt den Pfad für zusätzliche Konfigurationsdateien auf dem Repository-Host fest. Dies ist nur erforderlich, wenn dieser Pfad auf dem Repository-Host vom entsprechenden lokalen Pfad abweicht.

default: CFGOPTDEF_CONFIG_PATH "/" PROJECT_CONFIG_INCLUDE_PATH
example: --repo1-host-config-include-path=/conf/pgbackrest/conf.d

Option für den Konfigurationspfad des Repository-Hosts (--repo-host-config-path)

pgBackRest-Konfigurationspfad auf dem Repository-Host.

Legt den Konfigurationspfad auf dem Repository-Host fest. Dies ist nur erforderlich, wenn dieser Pfad auf dem Repository-Host vom lokalen Konfigurationspfad abweicht.

default: CFGOPTDEF_CONFIG_PATH
example: --repo1-host-config-path=/conf/pgbackrest

Option für die Schlüsseldatei des Repository-Hosts (--repo-host-key-file)

Schlüsseldatei für den Repository-Host.

Weist nach, dass das Client-Zertifikat von seinem Eigentümer gesendet wurde.

example: --repo1-host-key-file=/path/to/client.key

Option für den Port des Repository-Hosts (--repo-host-port)

Port des Repository-Hosts, wenn repo-host gesetzt ist.

Mit dieser Option einen anderen als den Standardport für das Protokoll des Repository-Hosts angeben.

HINWEIS: Bei repo-host-type=ssh gibt es keinen Standardwert für repo-host-port. In diesem Fall wird der Port verwendet, der für den durch cmd-ssh angegebenen Befehl konfiguriert ist.

default (depending on repo-host-type):
    tls - 8432

allowed: [0, 65535]
example: --repo1-host-port=25

Veralteter Name: backup-ssh-port

Option für den Protokolltyp des Repository-Hosts (--repo-host-type)

Protokolltyp für den Repository-Host.

Die folgenden Protokolltypen werden unterstützt:

• ssh - Secure Shell.
• tls - pgBackRest-TLS-Server.

default: ssh
example: --repo1-host-type=tls

Option für den Benutzer auf dem Repository-Host (--repo-host-user)

Benutzer auf dem Repository-Host, wenn repo-host gesetzt ist.

Legt den Benutzer für Operationen auf dem Repository-Host fest. Vorzugsweise ist dies nicht postgres, sondern ein anderer Benutzer wie pgbackrest. Läuft PostgreSQL auf dem Repository-Host, kann der Benutzer postgres der Gruppe pgbackrest hinzugefügt werden. So erhält er Leserechte für das Repository, ohne dessen Inhalt versehentlich beschädigen zu können.

default: pgbackrest
example: --repo1-host-user=repo-user

Veralteter Name: backup-user

Option für den Repository-Pfad (--repo-path)

Pfad zum Speichern von Backups und Archiv.

Im Repository speichert pgBackRest Backups und archiviert WAL-Segmente.

Der benötigte Speicherplatz lässt sich im Voraus oft schwer abschätzen. Am besten erstellen Sie einige Backups, erfassen die Größe verschiedener Backup-Typen (full/incr/diff) und messen die täglich erzeugte WAL-Menge. So erhalten Sie einen ungefähren Überblick über den Platzbedarf. Dieser wird sich im Laufe der Zeit mit der Entwicklung der Datenbank wahrscheinlich ändern.

default: /var/lib/pgbackrest
example: --repo1-path=/backup/db/backrest

Option für den S3-Bucket des Repositorys (--repo-s3-bucket)

S3-Bucket des Repositorys.

S3-Bucket, in dem das Repository gespeichert wird.

pgBackRest-Repositorys können mit repo-path=/ im Stammverzeichnis des Buckets gespeichert werden. Meist ist jedoch ein Präfix wie /repo sinnvoll, damit auch Protokolle und andere von AWS erzeugte Inhalte im Bucket gespeichert werden können.

example: --repo1-s3-bucket=pg-backup

Option für den S3-Endpunkt des Repositorys (--repo-s3-endpoint)

S3-Endpunkt des Repositorys.

Der AWS-Endpunkt sollte für die ausgewählte Region gültig sein.

Für angepasste Konfigurationen oder Tests können die Optionen repo-storage-ca-file, repo-storage-ca-path, repo-storage-host, repo-storage-port und repo-storage-verify-tls hilfreich sein.

example: --repo1-s3-endpoint=s3.amazonaws.com

Option für den S3-Schlüsseltyp des Repositorys (--repo-s3-key-type)

S3-Schlüsseltyp des Repositorys.

Die folgenden Typen werden unterstützt:

• shared - Gemeinsame Schlüssel
• auto - Temporäre Anmeldeinformationen automatisch abrufen
• web-id - Anmeldeinformationen für eine Web-Identität automatisch abrufen
• pod-id - Anmeldeinformationen für eine EKS-Pod-Identität automatisch abrufen
• process - Anmeldeinformationen durch Ausführen eines Prozesses abrufen

default: shared
example: --repo1-s3-key-type=auto

Option für die KMS-Schlüssel-ID des S3-Repositorys (--repo-s3-kms-key-id)

KMS-Schlüssel für das S3-Repository.

Aktiviert die serverseitige S3-Verschlüsselung mit dem angegebenen Schlüssel des AWS Key Management Service.

example: --repo1-s3-kms-key-id=bceb4f13-6939-4be3-910d-df54dee817b7

Option für den S3-Authentifizierungsprozess (--repo-s3-process-cmd)

Befehl für den S3-Authentifizierungsprozess.

Befehl mit optionalen Argumenten zum Abrufen temporärer S3-Anmeldeinformationen. Der erste Listeneintrag ist der Befehl; die übrigen Einträge werden als Parameter übergeben.

Der Prozess muss JSON mit den Feldern AccessKeyId, SecretAccessKey, SessionToken und Expiration ausgeben. Die Anmeldeinformationen werden vor ihrem Ablauf automatisch erneuert. Einzelheiten zum Format finden Sie unter Anmeldeinformationen aus einem Prozess .

example: --repo1-s3-process-cmd=/usr/local/bin/get-credentials --repo1-s3-process-cmd=--role --repo1-s3-process-cmd=my-role

Option für die S3-Region des Repositorys (--repo-s3-region)

S3-Region des Repositorys.

AWS-Region, in der der Bucket erstellt wurde.

example: --repo1-s3-region=us-east-1

Option für die Kostenübernahme durch den S3-Anforderer (--repo-s3-requester-pays)

Kostenübernahme durch den Anforderer beim S3-Repository.

Aktiviert die S3-Kostenübernahme durch den Anforderer.

default: n
example: --no-repo1-s3-requester-pays

Option für die S3-Rolle des Repositorys (--repo-s3-role)

S3-Rolle des Repositorys.

Name der AWS-Rolle (nicht der vollständige ARN) zum Abrufen temporärer Anmeldeinformationen bei repo-s3-key-type=auto.

example: --repo1-s3-role=authrole

Option für den S3-Dienst des Repositorys (--repo-s3-service)

S3-Signaturdienst.

Der bei der SigV4-Authentifizierung verwendete S3-Signaturdienst. Für standardmäßige S3-Endpunkte ist der Standardwert s3. Bei einem S3-Outposts-Endpunkt auf s3-outposts setzen.

default: s3
example: --repo1-s3-service=s3-outposts

Option für den STS-Endpunkt des S3-Repositorys (--repo-s3-sts-host)

STS-Endpunkt des S3-Repositorys.

STS-Endpunkt zum Abrufen temporärer Anmeldeinformationen, wenn repo-s3-key-type=web-id konfiguriert ist. Einen regionalen Endpunkt wie sts.us-east-1.amazonaws.com angeben, um regionales STS zu verwenden. Dies kann für GovCloud, Regionen in China oder zur Verringerung der Latenz erforderlich sein.

default: sts.amazonaws.com
example: --repo1-s3-sts-host=sts.us-east-1.amazonaws.com

Option für den S3-URI-Stil des Repositorys (--repo-s3-uri-style)

S3-URI-Stil.

Folgende URI-Stile werden unterstützt:

• host - Mit dem Host bucket.endpoint verbinden.
• path - Mit dem Host endpoint verbinden und den Bucket den URIs voranstellen.

default: host
example: --repo1-s3-uri-style=path

Option für den SFTP-Host des Repositorys (--repo-sftp-host)

SFTP-Host des Repositorys.

SFTP-Host, auf dem sich das Repository befindet.

example: --repo1-sftp-host=sftprepo.domain

Option für den Fingerabdruck des SFTP-Hosts (--repo-sftp-host-fingerprint)

Fingerabdruck des SFTP-Hosts des Repositorys.

Die Erzeugung des Fingerabdrucks für den SFTP-Host des Repositorys sollte repo-sftp-host-key-hash-type entsprechen. Den Fingerabdruck mit awk '{print $2}' ssh_host_xxx_key.pub | base64 -d | (md5sum or sha1sum) -b erzeugen. Die SSH-Hostschlüssel befinden sich normalerweise im Verzeichnis /etc/ssh.

example: --repo1-sftp-host-fingerprint=f84e172dfead7aeeeae6c1fdfb5aa8cf

Option für die SFTP-Hostschlüsselprüfung (--repo-sftp-host-key-check-type)

Art der SFTP-Hostschlüsselprüfung.

Die folgenden Arten der SFTP-Hostschlüsselprüfung werden unterstützt:

• strict - pgBackRest fügt niemals automatisch Hostschlüssel zur Datei ~/.ssh/known_hosts hinzu und verweigert Verbindungen zu Hosts, deren Hostschlüssel geändert wurde oder in den Dateien mit bekannten Hosts fehlt. Bei dieser Option muss der Benutzer alle neuen Hosts manuell hinzufügen.
• accept-new - pgBackRest fügt neue Hostschlüssel automatisch zur Datei mit bekannten Hosts des Benutzers hinzu, lässt aber keine Verbindungen zu Hosts mit geändertem Hostschlüssel zu.
• fingerprint - pgBackRest prüft den Hostschlüssel anhand des mit repo-sftp-host-fingerprint angegebenen Fingerabdrucks.
• none - Es wird keine Hostschlüsselprüfung durchgeführt.

default: strict
example: --repo1-sftp-host-key-check-type=accept-new

Option für den Hash-Typ des SFTP-Hostschlüssels (--repo-sftp-host-key-hash-type)

Hash-Typ des SFTP-Hostschlüssels für das Repository.

Hash-Typ des SFTP-Hostschlüssels für das Repository. Legt den Hash-Typ fest, mit dem beim SSH-Verbindungsaufbau der Hashwert des Hostschlüssels des entfernten Systems berechnet wird. Neuere Versionen von libssh2 unterstützen neben md5 und sha1 auch sha256.

example: --repo1-sftp-host-key-hash-type=sha256

Option für den Port des SFTP-Hosts (--repo-sftp-host-port)

Port des SFTP-Hosts für das Repository.

Port des SFTP-Hosts für das Repository.

default: 22
allowed: [1, 65535]
example: --repo1-sftp-host-port=22

Option für den Benutzer auf dem SFTP-Host (--repo-sftp-host-user)

Benutzer auf dem SFTP-Host für das Repository.

Benutzer auf dem Host, auf dem das Repository gespeichert wird.

example: --repo1-sftp-host-user=pg-backup

Option für die Datei bekannter SFTP-Hosts (--repo-sftp-known-host)

Datei mit bekannten SFTP-Hosts.

Datei mit bekannten Hosts, in der bei der Authentifizierung nach einem passenden SFTP-Host gesucht wird. Ohne Angabe durchsucht pgBackRest standardmäßig ~/.ssh/known_hosts, ~/.ssh/known_hosts2, /etc/ssh/ssh_known_hosts und /etc/ssh/ssh_known_hosts2. Sind ein oder mehrere Dateipfade konfiguriert, durchsucht pgBackRest diese nach einem passenden Eintrag. Dateipfade müssen vollständig sein oder mit einer Tilde beginnen. Die Option repo-sftp-known-host kann mehrfach angegeben werden, um mehrere Dateien mit bekannten Hosts zu durchsuchen. Für die Prüfung anhand dieser Dateien darf repo-sftp-host-fingerprint nicht angegeben sein. Siehe auch die Option repo-sftp-host-check-type.

example: --repo1-sftp-known-host=/home/postgres/.ssh/known_hosts

Option für die private SFTP-Schlüsseldatei (--repo-sftp-private-key-file)

Datei mit dem privaten SFTP-Schlüssel.

Datei mit dem privaten SFTP-Schlüssel zur Authentifizierung.

example: --repo1-sftp-private-key-file=~/.ssh/id_ed25519

Option für die öffentliche SFTP-Schlüsseldatei (--repo-sftp-public-key-file)

Datei mit dem öffentlichen SFTP-Schlüssel.

Datei mit dem öffentlichen SFTP-Schlüssel zur Authentifizierung. Bei einer gegen OpenSSL kompilierten Version optional, bei einer gegen eine andere Bibliothek kompilierten Version erforderlich.

example: --repo1-sftp-public-key-file=~/.ssh/id_ed25519.pub

Option für die CA-Datei des Repository-Speichers (--repo-storage-ca-file)

CA-Datei für den Repository-Speicher.

Für Zertifikate des Speicherdienstes (z. B. S3 oder Azure) eine andere als die systemweite CA-Datei verwenden.

example: --repo1-storage-ca-file=/etc/pki/tls/certs/ca-bundle.crt

Veraltete Namen: repo-azure-ca-file, repo-s3-ca-file

Option für den TLS-CA-Pfad des Repository-Speichers (--repo-storage-ca-path)

CA-Pfad für den Repository-Speicher.

Für Zertifikate des Speicherdienstes (z. B. S3 oder Azure) einen anderen als den systemweiten CA-Pfad verwenden.

example: --repo1-storage-ca-path=/etc/pki/tls/certs

Veraltete Namen: repo-azure-ca-path, repo-s3-ca-path

Option für den Host des Repository-Speichers (--repo-storage-host)

Host des Repository-Speichers.

Mit einem anderen Host als dem Endpunkt des Speicherdienstes (z. B. S3 oder Azure) verbinden. Dies wird üblicherweise für Tests verwendet.

example: --repo1-storage-host=127.0.0.1

Veraltete Namen: repo-azure-host, repo-s3-host

Option für den Port des Repository-Speichers (--repo-storage-port)

Port des Repository-Speichers.

Port für Verbindungen zum Endpunkt des Speicherdienstes (z. B. S3 oder Azure) oder zum angegebenen Host.

default: 443
allowed: [1, 65535]
example: --repo1-storage-port=9000

Veraltete Namen: repo-azure-port, repo-s3-port

Option für Tags im Repository-Speicher (--repo-storage-tag)

Tags für den Repository-Speicher.

Tags angeben, die Objekten hinzugefügt werden, wenn das Repository ein Objektspeicher wie S3 ist. Die Option kann wiederholt werden, um mehrere Tags hinzuzufügen.

pgBackRest bietet keine Möglichkeit, diese Tags zu ändern. Deshalb sollten sie vor dem Ausführen von stanza-create korrekt gesetzt werden, damit die Tags im gesamten Repository einheitlich sind.

example: --repo1-storage-tag=key1=value1

Option für die Upload-Blockgröße des Repository-Speichers (--repo-storage-upload-chunk-size)

Blockgröße für Uploads in den Repository-Speicher.

Objektspeicher wie S3 erlauben das Hochladen von Dateien in Blöcken, wenn die Datei zu groß für den Arbeitsspeicher ist. Auch wenn die Datei in den Arbeitsspeicher passt, ist es speichereffizienter, den für Uploads verwendeten Speicher zu begrenzen.

Eine größere Blockgröße verbessert im Allgemeinen die Leistung, da sie die Anzahl der Upload-Anfragen verringert und es ermöglicht, mehr Dateien jeweils in einer einzelnen Anfrage statt in Blöcken hochzuladen. Nachteilig ist der höhere Speicherverbrauch. Da für jeden Prozess ein eigener Blockpuffer zugewiesen werden muss, erhöhen größere Werte für process-max den gesamten Speicherverbrauch zusätzlich.

Die zulässigen Blockgrößen unterscheiden sich je nach Speichertyp und Plattform. Beispielsweise beträgt die Mindestblockgröße bei AWS S3 5MiB. Auch die Bezeichnung variiert: Bei der Suche nach Mindest- und Höchstwerten für AWS S3 nach „part size“, für GCS nach „chunk size“ und für Azure nach „block size“ suchen.

Ist eine Datei größer als 1GiB (die maximale Dateigröße, die PostgreSQL standardmäßig erzeugt), wird die Blockgröße schrittweise bis zum zulässigen Maximum erhöht, um den Datei-Upload abzuschließen.

default (depending on repo-type):
    azure - 4MiB
    gcs - 4MiB
    s3 - 5MiB

allow range (depending on repo-type):
    azure - [4MiB, 1GiB]
    gcs - [4MiB, 1GiB]
    s3 - [5MiB, 1GiB]

example: --repo1-storage-upload-chunk-size=16MiB

Option zur Zertifikatprüfung des Repository-Speichers (--repo-storage-verify-tls)

Zertifikatprüfung für den Repository-Speicher.

Mit dieser Option lässt sich die Prüfung des TLS-Serverzertifikats des Speicherdienstes (z. B. S3 oder Azure) aktivieren oder deaktivieren. Die Prüfung sollte nur für Tests oder andere Situationen mit selbstsignierten Zertifikaten deaktiviert werden.

default: y
example: --no-repo1-storage-verify-tls

Veraltete Namen: repo-azure-verify-tls, repo-s3-verify-ssl, repo-s3-verify-tls

Option für den Zielzeitpunkt des Repositorys (--repo-target-time)

Zielzeitpunkt für das Repository.

Der Zielzeitpunkt legt fest, welchen Stand des Repositorys Befehle auf versioniertem Speicher lesen. So lässt sich das Repository zu einem früheren Zeitpunkt lesen, um Daten wiederherzustellen, die versehentlich durch Benutzer oder durch Schadsoftware gelöscht oder beschädigt wurden.

S3, GCS und Azure unterstützen versionierten Speicher, aktivieren ihn aber im Allgemeinen nicht standardmäßig. Neben der Versionierung kann es sinnvoll sein, bei S3 die Objektsperre und bei GCS oder Azure das vorläufige Löschen zu aktivieren.

Wenn repo-target-time angegeben wird, muss auch die Option repo angegeben werden. Wahrscheinlich unterstützen nicht alle Repository-Typen die Versionierung. Im Allgemeinen ist es sinnvoll, für die Wiederherstellung ein einzelnes Repository auszuwählen.

Beim Vergleich werden Speicherzeitstempel berücksichtigt, die <= dem angegebenen Zeitstempel sind. Enthaltene Millisekunden werden abgeschnitten.

example: --repo-target-time=2024-08-08 12:12:12+00

Option für den Repository-Typ (--repo-type)

Art des für das Repository verwendeten Speichers.

Die folgenden Repository-Typen werden unterstützt:

• azure - Azure Blob Storage Service
• cifs - Wie posix, deaktiviert jedoch Links und fsync für Verzeichnisse
• gcs - Google Cloud Storage
• posix - POSIX-konforme Dateisysteme
• s3 - AWS Simple Storage Service
• sftp - Secure File Transfer Protocol

Wird ein NFS-Mount als posix-Repository verwendet, gelten für pgBackRest dieselben Regeln wie in der PostgreSQL-Dokumentation beschrieben: Erstellen eines Datenbankclusters – Dateisysteme .

default: posix
example: --repo1-type=cifs

Stanza-Optionen

Option für den PostgreSQL-Pfad (--pg-path)

PostgreSQL-Datenverzeichnis.

Dieser Pfad sollte dem von PostgreSQL gemeldeten data_directory entsprechen. Obwohl sich der Wert an verschiedenen Stellen auslesen lässt, ist eine ausdrückliche Angabe ratsam, falls diese Quellen bei einer Wiederherstellung oder einem Offline-Backup nicht verfügbar sind.

Bei jedem Online-Backup wird pg-path mit dem von PostgreSQL gemeldeten Wert verglichen. Die Option sollte daher immer aktuell sein.

example: --pg1-path=/data/db

Veralteter Name: db-path

3 - Befehl zum Übertragen ins Archiv (archive-push)

Nimmt ein WAL-Segment von PostgreSQL entgegen und archiviert es in jedem Repository, das durch die indizierte Option repo-path definiert ist. Informationen zur Konfiguration der Repositorys finden Sie im Abschnitt Repository . Abhängig von archive-async wird das WAL-Segment sofort ins Archiv übertragen oder lokal gespeichert. Sind mehrere Repositorys konfiguriert, versucht archive-push, das Segment an möglichst viele davon zu übertragen.

archive-push ist zur Konfiguration und zum Aufruf durch PostgreSQL vorgesehen. Ein Beispiel finden Sie unter Archivierung konfigurieren .

Befehlsoptionen

Option für asynchrone Archivierung (--archive-async)

WAL-Segmente asynchron übertragen und abrufen.

Aktiviert den asynchronen Betrieb für die Befehle archive-push und archive-get.

Der asynchrone Betrieb ist effizienter, da er Verbindungen wiederverwenden und parallele Verarbeitung nutzen kann. Weitere Informationen bieten die Optionen spool-path, archive-get-queue-max und archive-push-queue-max.

default: n
example: --archive-async

Option zur Archivprüfung (--archive-check)

Vor Abschluss des Backups prüfen, ob sich die WAL-Segmente im Archiv befinden.

Prüft, ob alle für ein konsistentes Backup erforderlichen WAL-Segmente im WAL-Archiv vorhanden sind. Es empfiehlt sich, die Standardeinstellung beizubehalten, sofern keine andere Archivierungsmethode verwendet wird.

Diese Option muss aktiviert sein, wenn archive-copy aktiviert ist.

default: y
example: --no-archive-check

Option zur Prüfung des Archivierungsmodus (--archive-mode-check)

Die PostgreSQL-Einstellung archive_mode prüfen.

Diese standardmäßig aktivierte Option verbietet die PostgreSQL-Einstellung archive_mode=always.

Von einem Standby-Server übertragene WAL-Segmente können logisch mit denen des Primärservers übereinstimmen, aber andere Prüfsummen aufweisen. Zur Vermeidung von Konflikten wird empfohlen, die Archivierung aus mehreren Quellen zu unterbinden.

ACHTUNG:

Bei deaktivierter Option muss unbedingt sichergestellt werden, dass nur ein Archivierer mit dem Befehl archive-push in das Repository schreibt.

default: y
example: --no-archive-mode-check

Option für die Datenmenge pro Archivierungslauf (--archive-push-batch-size)

Maximale WAL-Menge, die pro asynchronem Lauf übertragen wird.

Im asynchronen Modus überträgt der Prozess archive-push alle bereitstehenden WAL-Segmente in einem Lauf. Da archive-push-queue-max nur zu Beginn jedes Laufs geprüft wird, kann die Warteschlange bei einem Lauf mit sehr vielen Segmenten weit über den Grenzwert hinaus wachsen, bevor sie erneut geprüft wird.

Diese Option begrenzt die pro Lauf verarbeitete WAL-Menge. Der Prozess beendet sich dadurch und wird beim nächsten archive-push neu gestartet, wobei die Warteschlange erneut geprüft wird. Kleinere Werte führen zu häufigeren Prüfungen, erfordern aber auch häufigere Starts des asynchronen Prozesses. Der Wert wird auf eine ganze Anzahl von WAL-Segmenten abgerundet; mindestens ein Segment wird jedoch immer verarbeitet.

default: 16GiB
allowed: [1MiB, 4PiB]
example: --archive-push-batch-size=1GiB

Option für die maximale Größe der Archivierungswarteschlange (--archive-push-queue-max)

Maximale Größe der PostgreSQL-Archivierungswarteschlange.

Nach Erreichen des Grenzwerts geschieht Folgendes:

• pgBackRest meldet PostgreSQL, dass das WAL erfolgreich archiviert wurde, und wird es dann VERWERFEN.
• Eine Warnung wird in das PostgreSQL-Protokoll geschrieben.

Dadurch wird der Archivprotokollstrom unterbrochen, und PITR ist über diesen Punkt hinaus nicht mehr möglich. Ein neues Backup ist erforderlich, um die vollständige Wiederherstellbarkeit erneut herzustellen.

Im asynchronen Modus wird die gesamte Warteschlange verworfen. So wird verhindert, dass kurzzeitig wieder einzelne WAL-Segmente archiviert werden, bevor die Grenze erneut überschritten wird.

Im asynchronen Modus wird diese Grenze nur zu Beginn jedes archive-push-Laufs geprüft. Daher kann die Warteschlange innerhalb eines Laufs darüber hinaus wachsen. archive-push-batch-size verringern, um die Warteschlange häufiger zu prüfen.

Diese Funktion soll verhindern, dass das Volume mit den Protokolldateien voll wird, da PostgreSQL dann vollständig zum Stillstand kommt. Es ist besser, das Backup zu verlieren, als PostgreSQL ausfallen zu lassen.

allowed: [0B, 4PiB]
example: --archive-push-queue-max=1TiB

Veralteter Name: archive-queue-max

Option für das Archivierungszeitlimit (--archive-timeout)

Archivierungszeitlimit.

Maximale Wartezeit in Sekunden festlegen, bis ein einzelnes WAL-Segment das Archiv-Repository von pgBackRest erreicht. Dieses Zeitlimit gilt für die Befehle check und backup, wenn sie auf die Archivierung der WAL-Segmente warten, die für ein konsistentes Backup erforderlich sind.

default: 1m
allowed: [100ms, 1d]
example: --archive-timeout=30

Allgemeine Optionen

Option zur Ausführung als root (--allow-root)

Die Ausführung des Befehls als Benutzer root erlauben.

Standardmäßig darf nur der Befehl restore als Benutzer root ausgeführt werden, da er die Dateieigentümer sorgfältig verwaltet. Bei anderen Befehlen besteht das Risiko, dass Dateien entstehen, die root gehören, etwa im Repository. Diese sind für den PostgreSQL-Benutzer nicht zugänglich, sodass spätere Befehle fehlschlagen.

Diese Option aktivieren, um einen Befehl dennoch als root auszuführen. Es ist jedoch deutlich besser, pgBackRest als den Benutzer auszuführen, dem das Repository und der PostgreSQL-Cluster gehören.

default: n
example: --allow-root

Option für die Puffergröße (--buffer-size)

Puffergröße für I/O-Operationen.

Puffergröße für Kopier-, Komprimierungs-, Verschlüsselungs- und andere Operationen. Die Anzahl der verwendeten Puffer hängt von den Optionen ab. Jede Operation kann zusätzlichen Speicher benötigen; beispielsweise kann die Komprimierung mit gz weitere 256KiB Speicher beanspruchen.

Zulässige Werte sind 16KiB, 32KiB, 64KiB, 128KiB, 256KiB, 512KiB, 1MiB, 2MiB, 4MiB, 8MiB und 16MiB.

default: 1MiB
example: --buffer-size=2MiB

Option für den pgBackRest-Befehl (--cmd)

pgBackRest-Befehl.

pgBackRest kann eine Befehlszeichenfolge erzeugen, etwa wenn der Befehl restore die Einstellung restore_command erzeugt. Dafür wird der Befehl verwendet, mit dem der pgBackRest-Prozess gestartet wurde, sofern nicht die Option cmd angegeben ist.

ACHTUNG:

Das Einbetten des pgBackRest-Befehls in einen Wrapper kann unvorhersehbares Verhalten verursachen und wird nicht empfohlen.

default: [path of executed pgbackrest binary]
example: --cmd=/var/lib/pgsql/bin/pgbackrest_wrapper.sh

Option für den SSH-Client-Befehl (--cmd-ssh)

SSH-Client-Befehl.

Einen bestimmten SSH-Client-Befehl verwenden, wenn eine Alternative gewünscht wird oder der Befehl ssh nicht in $PATH liegt.

default: ssh
example: --cmd-ssh=/usr/bin/ssh

Option zur Komprimierung (--compress)

Dateikomprimierung verwenden.

Die Backup-Dateien sind mit Komprimierungswerkzeugen für die Befehlszeile kompatibel.

Diese Option ist inzwischen veraltet. Stattdessen sollte compress-type verwendet werden.

default: y
example: --no-compress

Option für die Komprimierungsstufe (--compress-level)

Komprimierungsstufe für Dateien.

Legt die Stufe für die Dateikomprimierung fest, wenn compress-type nicht none ist oder compress=y (veraltet) gilt.

default (depending on compress-type):
    bz2 - 9
    gz - 6
    lz4 - 1
    zst - 3

allow range (depending on compress-type):
    bz2 - [1, 9]
    gz - [-1, 9]
    lz4 - [-5, 12]
    zst - [-7, 22]

example: --compress-level=9

Option für die Netzwerkkomprimierungsstufe (--compress-level-network)

Komprimierungsstufe für die Netzwerkübertragung.

Legt die Komprimierungsstufe für die Netzwerkübertragung fest, wenn compress-type=none gilt und der Befehl nicht auf demselben Host wie das Repository ausgeführt wird. Die Komprimierung verringert den Netzwerkverkehr. Wenn compress-type nicht none ist, wird compress-level-network ignoriert und stattdessen compress-level verwendet, damit die Datei nur einmal komprimiert wird.

default: 1
allowed: [-5, 12]
example: --compress-level-network=1

Option für das Komprimierungsverfahren (--compress-type)

Komprimierungsverfahren für Dateien.

Die folgenden Komprimierungsverfahren werden unterstützt:

• none - Keine Komprimierung
• bz2 - bzip2-Komprimierungsformat
• gz - gzip-Komprimierungsformat
• lz4 - lz4-Komprimierungsformat (nicht auf allen Plattformen verfügbar)
• zst - Zstandard-Komprimierungsformat (nicht auf allen Plattformen verfügbar)

default: gz
example: --compress-type=none

Option für die Konfigurationsdatei (--config)

pgBackRest-Konfigurationsdatei.

Mit dieser Option eine andere als die standardmäßige Konfigurationsdatei angeben.

default: CFGOPTDEF_CONFIG_PATH "/" PROJECT_CONFIG_FILE
example: --config=/conf/pgbackrest/pgbackrest.conf

Option für den Pfad zusätzlicher Konfigurationsdateien (--config-include-path)

Pfad zu zusätzlichen pgBackRest-Konfigurationsdateien.

Konfigurationsdateien mit der Endung .conf am angegebenen Speicherort werden mit der pgBackRest-Konfigurationsdatei zu einer einzigen Konfigurationsdatei zusammengefügt.

default: CFGOPTDEF_CONFIG_PATH "/" PROJECT_CONFIG_INCLUDE_PATH
example: --config-include-path=/conf/pgbackrest/conf.d

Option für den Konfigurationspfad (--config-path)

Basispfad der pgBackRest-Konfigurationsdateien.

Diese Einstellung überschreibt den standardmäßigen Basispfad der Optionen --config und --config-include-path, sofern diese nicht ausdrücklich in der Befehlszeile gesetzt werden.

Wird beispielsweise nur --config-path=/conf/pgbackrest angegeben, erhält --config den Standardwert /conf/pgbackrest/pgbackrest.conf und --config-include-path den Standardwert /conf/pgbackrest/conf.d.

default: CFGOPTDEF_CONFIG_PATH
example: --config-path=/conf/pgbackrest

Option für das I/O-Zeitlimit (--io-timeout)

I/O-Zeitlimit.

Zeitlimit in Sekunden für Verbindungen sowie Lese- und Schreiboperationen.

Die gesamte Lese- oder Schreiboperation muss nicht innerhalb dieses Zeitlimits abgeschlossen sein, aber es muss irgendein Fortschritt erzielt werden, selbst wenn es nur ein einziges Byte ist.

default: 1m
allowed: [100ms, 1h]
example: --io-timeout=120

Option für den Sperrdateipfad (--lock-path)

Pfad zum Speichern der Sperrdateien.

In diesem Pfad erstellt pgBackRest Sperrdateien, um die gleichzeitige Ausführung miteinander in Konflikt stehender Operationen zu verhindern.

default: /tmp/pgbackrest
example: --lock-path=/backup/db/lock

Option für eine neutrale umask (--neutral-umask)

Eine neutrale umask verwenden.

Setzt die umask auf 0000, damit die Zugriffsrechte im Repository sinnvoll gesetzt werden. Standardmäßig erhalten Verzeichnisse den Modus 0750 und Dateien den Modus 0640.

Um stattdessen die umask des ausführenden Benutzers zu verwenden, neutral-umask=n in der Konfigurationsdatei oder --no-neutral-umask in der Befehlszeile angeben.

default: y
example: --no-neutral-umask

Option für die Prozesspriorität (--priority)

Prozesspriorität festlegen.

Legt fest, welche Priorität (also welcher nice-Wert) dem Prozess vom Kernel-Scheduler zugewiesen wird. Positive Werte verringern die Priorität, negative Werte erhöhen sie. In den meisten Fällen dürfen Prozesse ihre Priorität nicht erhöhen.

allowed: [-20, 19]
example: --priority=19

Option für die maximale Prozessanzahl (--process-max)

Maximale Anzahl der Prozesse für Komprimierung und Übertragung.

Jeder Prozess führt Komprimierung und Übertragung aus, um den Befehl zu beschleunigen. process-max jedoch nicht so hoch setzen, dass die Datenbankleistung beeinträchtigt wird.

default: 1
allowed: [1, 999]
example: --process-max=4

Option für das Protokollzeitlimit (--protocol-timeout)

Protokollzeitlimit.

Legt in Sekunden fest, wie lange der lokale oder entfernte Prozess auf eine neue Nachricht auf der Protokollebene wartet. Dies verhindert, dass Prozesse unbegrenzt auf eine Nachricht warten.

HINWEIS: Der Wert von protocol-timeout muss größer sein als der von db-timeout.

default: 31m
allowed: [100ms, 7d]
example: --protocol-timeout=630

Option für Keep-alive (--sck-keep-alive)

Keep-alive aktivieren.

Aktiviert Keep-alive-Nachrichten auf Socket-Verbindungen.

default: y
example: --no-sck-keep-alive

Option für den Spool-Pfad (--spool-path)

Pfad zum Speichern vorübergehend benötigter Daten.

In diesem Pfad werden Daten für die asynchronen Befehle archive-push und archive-get gespeichert.

Der asynchrone Befehl archive-push schreibt Bestätigungen in den Spool-Pfad, wenn WAL erfolgreich im Archiv gespeichert wurde, und Fehlermeldungen bei einem Fehlschlag. So kann der Vordergrundprozess PostgreSQL schnell benachrichtigen. Die Bestätigungsdateien sind sehr klein: bei Erfolg leer, bei Fehlern wenige hundert Byte groß.

Der asynchrone Befehl archive-get hält WAL im Spool-Pfad bereit, damit es auf Anfrage von PostgreSQL sehr schnell geliefert werden kann. Das Verschieben der Dateien zu PostgreSQL ist am effizientesten, wenn der Spool-Pfad auf demselben Dateisystem wie pg_xlog/pg_wal liegt. Es wird jedoch davon abgeraten, den Spool-Pfad innerhalb des Verzeichnisses pg_xlog/pg_wal anzulegen, da dies bei PostgreSQL-Werkzeugen wie pg_rewind Probleme verursachen kann.

Die Daten im Spool-Pfad sind nicht rein temporär, da sie einen Neustart überdauern können und sollten. Ihr Verlust ist jedoch kein Problem: Für archive-push prüft pgBackRest einfach jedes WAL-Segment erneut auf sichere Archivierung; für archive-get baut es die Warteschlange neu auf.

Der Spool-Pfad ist für ein lokales POSIX-kompatibles Dateisystem vorgesehen, nicht für ein entferntes Dateisystem wie NFS oder CIFS.

default: /var/spool/pgbackrest
example: --spool-path=/backup/db/spool

Option für die Stanza (--stanza)

Definiert die Stanza.

Eine Stanza ist die Konfiguration eines PostgreSQL-Datenbankclusters. Sie legt unter anderem dessen Speicherort, das Backup-Verfahren und die Archivierungsoptionen fest. Die meisten Datenbankserver haben nur einen PostgreSQL-Datenbankcluster und daher nur eine Stanza. Backup-Server haben dagegen für jeden zu sichernden Datenbankcluster eine Stanza.

Es liegt nahe, die Stanza nach dem Primärcluster zu benennen. Ein besserer Name beschreibt jedoch die im Cluster enthaltenen Datenbanken. Da der Stanza-Name für den Primärserver und alle Replikate verwendet wird, sollte er die tatsächliche Funktion des Clusters beschreiben, etwa app oder dw, statt den lokalen Clusternamen wie main oder prod zu übernehmen.

example: --stanza=main

Option für die Keep-alive-Anzahl (--tcp-keep-alive-count)

Anzahl der Keep-alive-Nachrichten.

Legt fest, wie viele TCP-Keep-alive-Nachrichten verloren gehen dürfen, bevor die Verbindung als unterbrochen gilt.

Diese Option ist auf Systemen verfügbar, die die Socket-Option TCP_KEEPCNT unterstützen.

allowed: [1, 32]
example: --tcp-keep-alive-count=3

Option für die Keep-alive-Leerlaufzeit (--tcp-keep-alive-idle)

Keep-alive-Leerlaufzeit.

Legt die Zeit ohne Netzwerkaktivität in Sekunden fest, nach der das Betriebssystem eine TCP-Keep-alive-Nachricht senden sollte.

Diese Option ist auf Systemen verfügbar, die die Socket-Option TCP_KEEPIDLE unterstützen.

allowed: [1, 3600]
example: --tcp-keep-alive-idle=60

Option für das Keep-alive-Intervall (--tcp-keep-alive-interval)

Keep-alive-Intervall.

Legt die Zeit in Sekunden fest, nach der eine nicht bestätigte TCP-Keep-alive-Nachricht erneut gesendet werden sollte.

Diese Option ist auf Systemen verfügbar, die die Socket-Option TCP_KEEPINTVL unterstützen.

allowed: [1, 900]
example: --tcp-keep-alive-interval=30

Option für TLSv1.2-Cipher-Suites (--tls-cipher-12)

Zulässige TLSv1.2-Cipher-Suites.

Alle TLS-Verbindungen zwischen pgBackRest-Client und -Server sind verschlüsselt. Standardmäßig sind auch Verbindungen zu Objektspeichern wie S3 verschlüsselt.

HINWEIS: TLSv1.2 ist das absolute Mindestsicherheitsniveau für jede Transportverbindung.

Die akzeptierten Cipher-Suites können bei Bedarf angepasst werden. Das Beispiel ist eine sinnvolle Wahl, sofern keine besonderen Sicherheitsanforderungen bestehen. Ist die Option nicht gesetzt (Standardeinstellung), gilt die Vorgabe der zugrunde liegenden OpenSSL-Bibliothek.

example: --tls-cipher-12=HIGH:MEDIUM:+3DES:!aNULL

Option für TLSv1.3-Cipher-Suites (--tls-cipher-13)

Zulässige TLSv1.3-Cipher-Suites.

Alle TLS-Verbindungen zwischen pgBackRest-Client und -Server sind verschlüsselt. Standardmäßig sind auch Verbindungen zu Objektspeichern wie S3 verschlüsselt.

HINWEIS: TLSv1.2 ist das absolute Mindestsicherheitsniveau für jede Transportverbindung.

Die akzeptierten Cipher-Suites können bei Bedarf angepasst werden. Ist die Option nicht gesetzt (Standardeinstellung), gilt die Vorgabe der zugrunde liegenden OpenSSL-Bibliothek.

example: --tls-cipher-13=TLS_AES_256_GCM_SHA384:TLS_CHACHA20_POLY1305_SHA256

Protokollierungsoptionen

Option für die Protokollierungsstufe der Konsole (--log-level-console)

Protokollierungsstufe für die Konsole.

Die folgenden Protokollierungsstufen werden unterstützt:

• off - Keine Protokollierung (nicht empfohlen)
• error - Nur Fehler protokollieren
• warn - Warnungen und Fehler protokollieren
• info - Informationen, Warnungen und Fehler protokollieren
• detail - Details, Informationen, Warnungen und Fehler protokollieren
• debug - Debug-Meldungen, Details, Informationen, Warnungen und Fehler protokollieren
• trace - Trace-Meldungen (sehr ausführliche Debug-Ausgaben), Debug-Meldungen, Informationen, Warnungen und Fehler protokollieren

default: warn
example: --log-level-console=error

Option für die Protokollierungsstufe der Datei (--log-level-file)

Protokollierungsstufe für die Dateiausgabe.

Die folgenden Protokollierungsstufen werden unterstützt:

• off - Keine Protokollierung (nicht empfohlen)
• error - Nur Fehler protokollieren
• warn - Warnungen und Fehler protokollieren
• info - Informationen, Warnungen und Fehler protokollieren
• detail - Details, Informationen, Warnungen und Fehler protokollieren
• debug - Debug-Meldungen, Details, Informationen, Warnungen und Fehler protokollieren
• trace - Trace-Meldungen (sehr ausführliche Debug-Ausgaben), Debug-Meldungen, Informationen, Warnungen und Fehler protokollieren

default: info
example: --log-level-file=debug

Option für die Protokollierungsstufe der Standardfehlerausgabe (--log-level-stderr)

Protokollierungsstufe für stderr.

Legt fest, welche Protokollierungsstufen an stderr statt an stdout ausgegeben werden (festgelegt durch log-level-console). Zeitstempel und Prozess werden nicht an stderr ausgegeben.

Die folgenden Protokollierungsstufen werden unterstützt:

• off - Keine Protokollierung (nicht empfohlen)
• error - Nur Fehler protokollieren
• warn - Warnungen und Fehler protokollieren
• info - Informationen, Warnungen und Fehler protokollieren
• detail - Details, Informationen, Warnungen und Fehler protokollieren
• debug - Debug-Meldungen, Details, Informationen, Warnungen und Fehler protokollieren
• trace - Trace-Meldungen (sehr ausführliche Debug-Ausgaben), Debug-Meldungen, Informationen, Warnungen und Fehler protokollieren

default: off
example: --log-level-stderr=error

Option für den Protokollpfad (--log-path)

Pfad, an dem Protokolldateien gespeichert werden.

In diesem Pfad speichert pgBackRest seine Protokolldateien. Bei log-level-file=off ist kein Protokollpfad erforderlich.

default: /var/log/pgbackrest
example: --log-path=/backup/db/log

Option für die Protokollierung von Unterprozessen (--log-subprocess)

Protokollierung in Unterprozessen aktivieren.

Aktiviert die Dateiprotokollierung für alle von diesem Prozess erzeugten Unterprozesse mit der durch log-level-file festgelegten Protokollierungsstufe.

default: n
example: --log-subprocess

Option für Zeitstempel im Protokoll (--log-timestamp)

Zeitstempel in der Protokollierung aktivieren.

Aktiviert Zeitstempel in der Konsolen- und Dateiprotokollierung. Diese Option wird in besonderen Situationen deaktiviert, etwa beim Erzeugen der Dokumentation.

default: y
example: --no-log-timestamp

Optionen für Maintainer

Option zur Prüfung der WAL-Header (--archive-header-check)

PostgreSQL-Version und -ID in WAL-Headern prüfen.

Diese standardmäßig aktivierte Option prüft den WAL-Header anhand der PostgreSQL-Version und der Systemkennung. Dadurch wird sichergestellt, dass WAL in die richtige Stanza kopiert wird. Zusätzlich wird bereits pg_control mit der Stanza abgeglichen und geprüft, ob WAL aus demselben PostgreSQL-Datenverzeichnis kopiert wird, in dem sich pg_control befindet.

Das Deaktivieren dieser Prüfung ist daher relativ sicher, sollte aber nur bei Bedarf erfolgen, etwa wenn WAL verschlüsselt ist.

default: y
example: --no-archive-header-check

Option zum Erzwingen der PostgreSQL-Version (--pg-version-force)

PostgreSQL-Version erzwingen.

Verwendet die angegebene PostgreSQL-Version statt der Version, die automatisch aus pg_control oder WAL-Headern ermittelt wird. Dies ist hauptsächlich für PostgreSQL-Forks oder Entwicklungsversionen hilfreich, deren Werte von denen der veröffentlichten Version abweichen. Die von PostgreSQL über server_version_num gemeldete Version muss mit der erzwungenen Version übereinstimmen.

WARNUNG:

Diese Option mit Vorsicht verwenden: pg_control und WAL-Header werden weiterhin im erwarteten Format der angegebenen Version gelesen, also im Format der offiziellen Open-Source-Version von PostgreSQL. Ändert der Fork oder die Entwicklungsversion das Format von Feldern, auf die pgBackRest angewiesen ist, führt dies zu unerwartetem Verhalten. Im Allgemeinen funktioniert diese Option nur dann wie erwartet, wenn der Fork alle eigenen Strukturfelder nach den standardmäßigen PostgreSQL-Feldern hinzufügt.

example: --pg-version-force=15

Repository-Optionen

Option für den Azure-Container des Repositorys (--repo-azure-container)

Azure-Repository-Container.

Azure-Container, der das Repository speichert.

pgBackRest-Repositorys können mit repo-path=/ im Stammverzeichnis des Containers gespeichert werden. Meist ist jedoch ein Präfix wie /repo sinnvoll, damit auch Protokolle und andere von Azure erzeugte Inhalte im Container gespeichert werden können.

example: --repo1-azure-container=pg-backup

Option für den Azure-Schlüsseltyp des Repositorys (--repo-azure-key-type)

Azure-Repository-Schlüsseltyp.

Folgende Typen werden für die Autorisierung unterstützt:

• shared - Gemeinsamer Schlüssel
• sas - Signatur für gemeinsamen Zugriff
• auto - Automatische Autorisierung mit verwalteten Azure-Identitäten

default: shared
example: --repo1-azure-key-type=sas

Option für den Azure-URI-Stil des Repositorys (--repo-azure-uri-style)

Azure-URI-Stil.

Folgende URI-Stile werden unterstützt:

• host - Verbindung zum account.endpoint-Host herstellen.
• path - Verbindung zum endpoint-Host herstellen und den Kontonamen vor die URIs stellen.

default: host
example: --repo1-azure-uri-style=path

Option für den Verschlüsselungstyp des Repositorys (--repo-cipher-type)

Verfahren zur Verschlüsselung des Repositorys.

Folgende Verschlüsselungstypen werden unterstützt:

• none - Das Repository ist nicht verschlüsselt
• aes-256-cbc - Advanced Encryption Standard mit Schlüssellänge von 256 Bit

Beachten Sie, dass die Verschlüsselung immer clientseitig durchgeführt wird, selbst wenn der Repository-Typ (z. B. S3) Verschlüsselung unterstützt.

default: none
example: --repo1-cipher-type=aes-256-cbc

Option für den GCS-Bucket des Repositorys (--repo-gcs-bucket)

GCS-Bucket des Repositorys.

GCS-Bucket, in dem das Repository gespeichert wird.

pgBackRest-Repositorys können mit repo-path=/ im Stammverzeichnis des Buckets gespeichert werden. Meist ist jedoch ein Präfix wie /repo sinnvoll, damit auch Protokolle und andere von GCS erzeugte Inhalte im Bucket gespeichert werden können.

example: --repo1-gcs-bucket=/pg-backup

Option für den GCS-Endpunkt des Repositorys (--repo-gcs-endpoint)

GCS-Repository-Endpunkt.

Endpunkt, der zum Verbinden mit dem Speicherdienst verwendet wird. Kann aktualisiert werden, um einen lokalen GCS-Server oder einen alternativen Endpunkt zu verwenden.

default: storage.googleapis.com
example: --repo1-gcs-endpoint=localhost

Option für den GCS-Schlüsseltyp des Repositorys (--repo-gcs-key-type)

GCS-Repository-Schlüsseltyp.

Folgende Typen werden für die Autorisierung unterstützt:

• auto - Autorisierung mithilfe des Dienstkontos der Instanz.
• service - Dienstkonto anhand eines lokal gespeicherten Schlüssels.
• token - Für lokale Tests, z. B. fakegcs.

Wenn repo-gcs-key-type=service ist, werden die Anmeldeinformationen erneut geladen, wenn das Authentifizierungstoken erneuert wird.

default: service
example: --repo1-gcs-key-type=auto

Option für die GCS-Projekt-ID des Repositorys (--repo-gcs-user-project)

GCS-Projekt-ID.

GCS-Projekt-ID, die zur Bestimmung der Abrechnung von Anfragen verwendet wird.

example: --repo1-gcs-user-project=my-project

Option für den Repository-Host (--repo-host)

Repository-Host bei entfernter Ausführung.

Für Backups und Archivierung auf einem lokal eingehängten Dateisystem ist diese Einstellung nicht erforderlich.

example: --repo1-host=repo1.domain.com

Veralteter Name: backup-host

Option für die CA-Datei des Repository-Hosts (--repo-host-ca-file)

Datei mit den Zertifizierungsstellen für den Repository-Host.

Für Verbindungen zum Repository-Host eine andere als die systemweite CA-Datei verwenden.

example: --repo1-host-ca-file=/etc/pki/tls/certs/ca-bundle.crt

Option für den CA-Pfad des Repository-Hosts (--repo-host-ca-path)

Pfad mit den Zertifizierungsstellen für den Repository-Host.

Für Verbindungen zum Repository-Host einen anderen als den systemweiten CA-Pfad verwenden.

example: --repo1-host-ca-path=/etc/pki/tls/certs

Option für die Zertifikatdatei des Repository-Hosts (--repo-host-cert-file)

Zertifikatdatei für den Repository-Host.

Wird an den Repository-Host gesendet, um die Client-Identität zu bestätigen.

example: --repo1-host-cert-file=/path/to/client.crt

Option für den Befehl auf dem Repository-Host (--repo-host-cmd)

pgBackRest-Befehl auf dem Repository-Host.

Erforderlich nur, wenn der Pfad zum pgBackRest-Befehl auf dem lokalen und dem Repository-Host unterschiedlich ist. Wenn nicht definiert, wird der Repository-Host-Befehl auf den gleichen Wert wie der lokale Befehl gesetzt.

default: [path of executed pgbackrest binary]
example: --repo1-host-cmd=/usr/lib/backrest/bin/pgbackrest

Veralteter Name: backup-cmd

Option für die Konfiguration des Repository-Hosts (--repo-host-config)

pgBackRest-Konfigurationsdatei auf dem Repository-Host.

Legt den Speicherort der Konfigurationsdatei auf dem Repository-Host fest. Dies ist nur erforderlich, wenn sich die Repository-Host-Konfigurationsdatei an einem anderen Ort befindet als die lokale Konfigurationsdatei.

default: CFGOPTDEF_CONFIG_PATH "/" PROJECT_CONFIG_FILE
example: --repo1-host-config=/conf/pgbackrest/pgbackrest.conf

Veralteter Name: backup-config

Option für zusätzliche Konfigurationsdateien auf dem Repository-Host (--repo-host-config-include-path)

Pfad zu zusätzlichen pgBackRest-Konfigurationsdateien auf dem Repository-Host.

Legt den Pfad für zusätzliche Konfigurationsdateien auf dem Repository-Host fest. Dies ist nur erforderlich, wenn dieser Pfad auf dem Repository-Host vom entsprechenden lokalen Pfad abweicht.

default: CFGOPTDEF_CONFIG_PATH "/" PROJECT_CONFIG_INCLUDE_PATH
example: --repo1-host-config-include-path=/conf/pgbackrest/conf.d

Option für den Konfigurationspfad des Repository-Hosts (--repo-host-config-path)

pgBackRest-Konfigurationspfad auf dem Repository-Host.

Legt den Konfigurationspfad auf dem Repository-Host fest. Dies ist nur erforderlich, wenn dieser Pfad auf dem Repository-Host vom lokalen Konfigurationspfad abweicht.

default: CFGOPTDEF_CONFIG_PATH
example: --repo1-host-config-path=/conf/pgbackrest

Option für die Schlüsseldatei des Repository-Hosts (--repo-host-key-file)

Schlüsseldatei für den Repository-Host.

Weist nach, dass das Client-Zertifikat von seinem Eigentümer gesendet wurde.

example: --repo1-host-key-file=/path/to/client.key

Option für den Port des Repository-Hosts (--repo-host-port)

Port des Repository-Hosts, wenn repo-host gesetzt ist.

Mit dieser Option einen anderen als den Standardport für das Protokoll des Repository-Hosts angeben.

HINWEIS: Bei repo-host-type=ssh gibt es keinen Standardwert für repo-host-port. In diesem Fall wird der Port verwendet, der für den durch cmd-ssh angegebenen Befehl konfiguriert ist.

default (depending on repo-host-type):
    tls - 8432

allowed: [0, 65535]
example: --repo1-host-port=25

Veralteter Name: backup-ssh-port

Option für den Protokolltyp des Repository-Hosts (--repo-host-type)

Protokolltyp für den Repository-Host.

Die folgenden Protokolltypen werden unterstützt:

• ssh - Secure Shell.
• tls - pgBackRest-TLS-Server.

default: ssh
example: --repo1-host-type=tls

Option für den Benutzer auf dem Repository-Host (--repo-host-user)

Benutzer auf dem Repository-Host, wenn repo-host gesetzt ist.

Legt den Benutzer für Operationen auf dem Repository-Host fest. Vorzugsweise ist dies nicht postgres, sondern ein anderer Benutzer wie pgbackrest. Läuft PostgreSQL auf dem Repository-Host, kann der Benutzer postgres der Gruppe pgbackrest hinzugefügt werden. So erhält er Leserechte für das Repository, ohne dessen Inhalt versehentlich beschädigen zu können.

default: pgbackrest
example: --repo1-host-user=repo-user

Veralteter Name: backup-user

Option für den Repository-Pfad (--repo-path)

Pfad zum Speichern von Backups und Archiv.

Im Repository speichert pgBackRest Backups und archiviert WAL-Segmente.

Der benötigte Speicherplatz lässt sich im Voraus oft schwer abschätzen. Am besten erstellen Sie einige Backups, erfassen die Größe verschiedener Backup-Typen (full/incr/diff) und messen die täglich erzeugte WAL-Menge. So erhalten Sie einen ungefähren Überblick über den Platzbedarf. Dieser wird sich im Laufe der Zeit mit der Entwicklung der Datenbank wahrscheinlich ändern.

default: /var/lib/pgbackrest
example: --repo1-path=/backup/db/backrest

Option für den S3-Bucket des Repositorys (--repo-s3-bucket)

S3-Bucket des Repositorys.

S3-Bucket, in dem das Repository gespeichert wird.

pgBackRest-Repositorys können mit repo-path=/ im Stammverzeichnis des Buckets gespeichert werden. Meist ist jedoch ein Präfix wie /repo sinnvoll, damit auch Protokolle und andere von AWS erzeugte Inhalte im Bucket gespeichert werden können.

example: --repo1-s3-bucket=pg-backup

Option für den S3-Endpunkt des Repositorys (--repo-s3-endpoint)

S3-Endpunkt des Repositorys.

Der AWS-Endpunkt sollte für die ausgewählte Region gültig sein.

Für angepasste Konfigurationen oder Tests können die Optionen repo-storage-ca-file, repo-storage-ca-path, repo-storage-host, repo-storage-port und repo-storage-verify-tls hilfreich sein.

example: --repo1-s3-endpoint=s3.amazonaws.com

Option für den S3-Schlüsseltyp des Repositorys (--repo-s3-key-type)

S3-Schlüsseltyp des Repositorys.

Die folgenden Typen werden unterstützt:

• shared - Gemeinsame Schlüssel
• auto - Temporäre Anmeldeinformationen automatisch abrufen
• web-id - Anmeldeinformationen für eine Web-Identität automatisch abrufen
• pod-id - Anmeldeinformationen für eine EKS-Pod-Identität automatisch abrufen
• process - Anmeldeinformationen durch Ausführen eines Prozesses abrufen

default: shared
example: --repo1-s3-key-type=auto

Option für die KMS-Schlüssel-ID des S3-Repositorys (--repo-s3-kms-key-id)

KMS-Schlüssel für das S3-Repository.

Aktiviert die serverseitige S3-Verschlüsselung mit dem angegebenen Schlüssel des AWS Key Management Service.

example: --repo1-s3-kms-key-id=bceb4f13-6939-4be3-910d-df54dee817b7

Option für den S3-Authentifizierungsprozess (--repo-s3-process-cmd)

Befehl für den S3-Authentifizierungsprozess.

Befehl mit optionalen Argumenten zum Abrufen temporärer S3-Anmeldeinformationen. Der erste Listeneintrag ist der Befehl; die übrigen Einträge werden als Parameter übergeben.

Der Prozess muss JSON mit den Feldern AccessKeyId, SecretAccessKey, SessionToken und Expiration ausgeben. Die Anmeldeinformationen werden vor ihrem Ablauf automatisch erneuert. Einzelheiten zum Format finden Sie unter Anmeldeinformationen aus einem Prozess .

example: --repo1-s3-process-cmd=/usr/local/bin/get-credentials --repo1-s3-process-cmd=--role --repo1-s3-process-cmd=my-role

Option für die S3-Region des Repositorys (--repo-s3-region)

S3-Region des Repositorys.

AWS-Region, in der der Bucket erstellt wurde.

example: --repo1-s3-region=us-east-1

Option für die Kostenübernahme durch den S3-Anforderer (--repo-s3-requester-pays)

Kostenübernahme durch den Anforderer beim S3-Repository.

Aktiviert die S3-Kostenübernahme durch den Anforderer.

default: n
example: --no-repo1-s3-requester-pays

Option für die S3-Rolle des Repositorys (--repo-s3-role)

S3-Rolle des Repositorys.

Name der AWS-Rolle (nicht der vollständige ARN) zum Abrufen temporärer Anmeldeinformationen bei repo-s3-key-type=auto.

example: --repo1-s3-role=authrole

Option für den S3-Dienst des Repositorys (--repo-s3-service)

S3-Signaturdienst.

Der bei der SigV4-Authentifizierung verwendete S3-Signaturdienst. Für standardmäßige S3-Endpunkte ist der Standardwert s3. Bei einem S3-Outposts-Endpunkt auf s3-outposts setzen.

default: s3
example: --repo1-s3-service=s3-outposts

Option für den STS-Endpunkt des S3-Repositorys (--repo-s3-sts-host)

STS-Endpunkt des S3-Repositorys.

STS-Endpunkt zum Abrufen temporärer Anmeldeinformationen, wenn repo-s3-key-type=web-id konfiguriert ist. Einen regionalen Endpunkt wie sts.us-east-1.amazonaws.com angeben, um regionales STS zu verwenden. Dies kann für GovCloud, Regionen in China oder zur Verringerung der Latenz erforderlich sein.

default: sts.amazonaws.com
example: --repo1-s3-sts-host=sts.us-east-1.amazonaws.com

Option für den S3-URI-Stil des Repositorys (--repo-s3-uri-style)

S3-URI-Stil.

Folgende URI-Stile werden unterstützt:

• host - Mit dem Host bucket.endpoint verbinden.
• path - Mit dem Host endpoint verbinden und den Bucket den URIs voranstellen.

default: host
example: --repo1-s3-uri-style=path

Option für den SFTP-Host des Repositorys (--repo-sftp-host)

SFTP-Host des Repositorys.

SFTP-Host, auf dem sich das Repository befindet.

example: --repo1-sftp-host=sftprepo.domain

Option für den Fingerabdruck des SFTP-Hosts (--repo-sftp-host-fingerprint)

Fingerabdruck des SFTP-Hosts des Repositorys.

Die Erzeugung des Fingerabdrucks für den SFTP-Host des Repositorys sollte repo-sftp-host-key-hash-type entsprechen. Den Fingerabdruck mit awk '{print $2}' ssh_host_xxx_key.pub | base64 -d | (md5sum or sha1sum) -b erzeugen. Die SSH-Hostschlüssel befinden sich normalerweise im Verzeichnis /etc/ssh.

example: --repo1-sftp-host-fingerprint=f84e172dfead7aeeeae6c1fdfb5aa8cf

Option für die SFTP-Hostschlüsselprüfung (--repo-sftp-host-key-check-type)

Art der SFTP-Hostschlüsselprüfung.

Die folgenden Arten der SFTP-Hostschlüsselprüfung werden unterstützt:

• strict - pgBackRest fügt niemals automatisch Hostschlüssel zur Datei ~/.ssh/known_hosts hinzu und verweigert Verbindungen zu Hosts, deren Hostschlüssel geändert wurde oder in den Dateien mit bekannten Hosts fehlt. Bei dieser Option muss der Benutzer alle neuen Hosts manuell hinzufügen.
• accept-new - pgBackRest fügt neue Hostschlüssel automatisch zur Datei mit bekannten Hosts des Benutzers hinzu, lässt aber keine Verbindungen zu Hosts mit geändertem Hostschlüssel zu.
• fingerprint - pgBackRest prüft den Hostschlüssel anhand des mit repo-sftp-host-fingerprint angegebenen Fingerabdrucks.
• none - Es wird keine Hostschlüsselprüfung durchgeführt.

default: strict
example: --repo1-sftp-host-key-check-type=accept-new

Option für den Hash-Typ des SFTP-Hostschlüssels (--repo-sftp-host-key-hash-type)

Hash-Typ des SFTP-Hostschlüssels für das Repository.

Hash-Typ des SFTP-Hostschlüssels für das Repository. Legt den Hash-Typ fest, mit dem beim SSH-Verbindungsaufbau der Hashwert des Hostschlüssels des entfernten Systems berechnet wird. Neuere Versionen von libssh2 unterstützen neben md5 und sha1 auch sha256.

example: --repo1-sftp-host-key-hash-type=sha256

Option für den Port des SFTP-Hosts (--repo-sftp-host-port)

Port des SFTP-Hosts für das Repository.

Port des SFTP-Hosts für das Repository.

default: 22
allowed: [1, 65535]
example: --repo1-sftp-host-port=22

Option für den Benutzer auf dem SFTP-Host (--repo-sftp-host-user)

Benutzer auf dem SFTP-Host für das Repository.

Benutzer auf dem Host, auf dem das Repository gespeichert wird.

example: --repo1-sftp-host-user=pg-backup

Option für die Datei bekannter SFTP-Hosts (--repo-sftp-known-host)

Datei mit bekannten SFTP-Hosts.

Datei mit bekannten Hosts, in der bei der Authentifizierung nach einem passenden SFTP-Host gesucht wird. Ohne Angabe durchsucht pgBackRest standardmäßig ~/.ssh/known_hosts, ~/.ssh/known_hosts2, /etc/ssh/ssh_known_hosts und /etc/ssh/ssh_known_hosts2. Sind ein oder mehrere Dateipfade konfiguriert, durchsucht pgBackRest diese nach einem passenden Eintrag. Dateipfade müssen vollständig sein oder mit einer Tilde beginnen. Die Option repo-sftp-known-host kann mehrfach angegeben werden, um mehrere Dateien mit bekannten Hosts zu durchsuchen. Für die Prüfung anhand dieser Dateien darf repo-sftp-host-fingerprint nicht angegeben sein. Siehe auch die Option repo-sftp-host-check-type.

example: --repo1-sftp-known-host=/home/postgres/.ssh/known_hosts

Option für die private SFTP-Schlüsseldatei (--repo-sftp-private-key-file)

Datei mit dem privaten SFTP-Schlüssel.

Datei mit dem privaten SFTP-Schlüssel zur Authentifizierung.

example: --repo1-sftp-private-key-file=~/.ssh/id_ed25519

Option für die öffentliche SFTP-Schlüsseldatei (--repo-sftp-public-key-file)

Datei mit dem öffentlichen SFTP-Schlüssel.

Datei mit dem öffentlichen SFTP-Schlüssel zur Authentifizierung. Bei einer gegen OpenSSL kompilierten Version optional, bei einer gegen eine andere Bibliothek kompilierten Version erforderlich.

example: --repo1-sftp-public-key-file=~/.ssh/id_ed25519.pub

Option für die CA-Datei des Repository-Speichers (--repo-storage-ca-file)

CA-Datei für den Repository-Speicher.

Für Zertifikate des Speicherdienstes (z. B. S3 oder Azure) eine andere als die systemweite CA-Datei verwenden.

example: --repo1-storage-ca-file=/etc/pki/tls/certs/ca-bundle.crt

Veraltete Namen: repo-azure-ca-file, repo-s3-ca-file

Option für den TLS-CA-Pfad des Repository-Speichers (--repo-storage-ca-path)

CA-Pfad für den Repository-Speicher.

Für Zertifikate des Speicherdienstes (z. B. S3 oder Azure) einen anderen als den systemweiten CA-Pfad verwenden.

example: --repo1-storage-ca-path=/etc/pki/tls/certs

Veraltete Namen: repo-azure-ca-path, repo-s3-ca-path

Option für den Host des Repository-Speichers (--repo-storage-host)

Host des Repository-Speichers.

Mit einem anderen Host als dem Endpunkt des Speicherdienstes (z. B. S3 oder Azure) verbinden. Dies wird üblicherweise für Tests verwendet.

example: --repo1-storage-host=127.0.0.1

Veraltete Namen: repo-azure-host, repo-s3-host

Option für den Port des Repository-Speichers (--repo-storage-port)

Port des Repository-Speichers.

Port für Verbindungen zum Endpunkt des Speicherdienstes (z. B. S3 oder Azure) oder zum angegebenen Host.

default: 443
allowed: [1, 65535]
example: --repo1-storage-port=9000

Veraltete Namen: repo-azure-port, repo-s3-port

Option für Tags im Repository-Speicher (--repo-storage-tag)

Tags für den Repository-Speicher.

Tags angeben, die Objekten hinzugefügt werden, wenn das Repository ein Objektspeicher wie S3 ist. Die Option kann wiederholt werden, um mehrere Tags hinzuzufügen.

pgBackRest bietet keine Möglichkeit, diese Tags zu ändern. Deshalb sollten sie vor dem Ausführen von stanza-create korrekt gesetzt werden, damit die Tags im gesamten Repository einheitlich sind.

example: --repo1-storage-tag=key1=value1

Option für die Upload-Blockgröße des Repository-Speichers (--repo-storage-upload-chunk-size)

Blockgröße für Uploads in den Repository-Speicher.

Objektspeicher wie S3 erlauben das Hochladen von Dateien in Blöcken, wenn die Datei zu groß für den Arbeitsspeicher ist. Auch wenn die Datei in den Arbeitsspeicher passt, ist es speichereffizienter, den für Uploads verwendeten Speicher zu begrenzen.

Eine größere Blockgröße verbessert im Allgemeinen die Leistung, da sie die Anzahl der Upload-Anfragen verringert und es ermöglicht, mehr Dateien jeweils in einer einzelnen Anfrage statt in Blöcken hochzuladen. Nachteilig ist der höhere Speicherverbrauch. Da für jeden Prozess ein eigener Blockpuffer zugewiesen werden muss, erhöhen größere Werte für process-max den gesamten Speicherverbrauch zusätzlich.

Die zulässigen Blockgrößen unterscheiden sich je nach Speichertyp und Plattform. Beispielsweise beträgt die Mindestblockgröße bei AWS S3 5MiB. Auch die Bezeichnung variiert: Bei der Suche nach Mindest- und Höchstwerten für AWS S3 nach „part size“, für GCS nach „chunk size“ und für Azure nach „block size“ suchen.

Ist eine Datei größer als 1GiB (die maximale Dateigröße, die PostgreSQL standardmäßig erzeugt), wird die Blockgröße schrittweise bis zum zulässigen Maximum erhöht, um den Datei-Upload abzuschließen.

default (depending on repo-type):
    azure - 4MiB
    gcs - 4MiB
    s3 - 5MiB

allow range (depending on repo-type):
    azure - [4MiB, 1GiB]
    gcs - [4MiB, 1GiB]
    s3 - [5MiB, 1GiB]

example: --repo1-storage-upload-chunk-size=16MiB

Option zur Zertifikatprüfung des Repository-Speichers (--repo-storage-verify-tls)

Zertifikatprüfung für den Repository-Speicher.

Mit dieser Option lässt sich die Prüfung des TLS-Serverzertifikats des Speicherdienstes (z. B. S3 oder Azure) aktivieren oder deaktivieren. Die Prüfung sollte nur für Tests oder andere Situationen mit selbstsignierten Zertifikaten deaktiviert werden.

default: y
example: --no-repo1-storage-verify-tls

Veraltete Namen: repo-azure-verify-tls, repo-s3-verify-ssl, repo-s3-verify-tls

Option für den Repository-Typ (--repo-type)

Art des für das Repository verwendeten Speichers.

Die folgenden Repository-Typen werden unterstützt:

• azure - Azure Blob Storage Service
• cifs - Wie posix, deaktiviert jedoch Links und fsync für Verzeichnisse
• gcs - Google Cloud Storage
• posix - POSIX-konforme Dateisysteme
• s3 - AWS Simple Storage Service
• sftp - Secure File Transfer Protocol

Wird ein NFS-Mount als posix-Repository verwendet, gelten für pgBackRest dieselben Regeln wie in der PostgreSQL-Dokumentation beschrieben: Erstellen eines Datenbankclusters – Dateisysteme .

default: posix
example: --repo1-type=cifs

Stanza-Optionen

Option für den PostgreSQL-Pfad (--pg-path)

PostgreSQL-Datenverzeichnis.

Dieser Pfad sollte dem von PostgreSQL gemeldeten data_directory entsprechen. Obwohl sich der Wert an verschiedenen Stellen auslesen lässt, ist eine ausdrückliche Angabe ratsam, falls diese Quellen bei einer Wiederherstellung oder einem Offline-Backup nicht verfügbar sind.

Bei jedem Online-Backup wird pg-path mit dem von PostgreSQL gemeldeten Wert verglichen. Die Option sollte daher immer aktuell sein.

example: --pg1-path=/data/db

Veralteter Name: db-path

4 - Backup-Befehl (backup)

Sind mehrere Repositorys konfiguriert, erstellt pgBackRest das Backup im Repository mit der höchsten Priorität (z. B. repo1), sofern nicht die Option --repo angegeben wird.

pgBackRest besitzt keinen integrierten Zeitplaner. Daher empfiehlt sich der Aufruf über cron oder einen anderen Mechanismus zur Zeitplanung.

Weitere Einzelheiten und Beispiele finden Sie unter Ein Backup erstellen .

Befehlsoptionen

Option für Backup-Anmerkungen (--annotation)

Das Backup mit benutzerdefinierten Schlüssel/Wert-Paaren versehen.

Benutzer können dem Backup informative Schlüssel/Wert-Paare hinzufügen. Diese Option kann mehrfach verwendet werden, um mehrere Anmerkungen hinzuzufügen.

Anmerkungen erscheinen in der Textausgabe des Befehls info, wenn mit --set ein Backup angegeben wird. In der JSON-Ausgabe erscheinen sie immer.

example: --annotation=source="Sunday backup for website database"

Option zur Archivprüfung (--archive-check)

Vor Abschluss des Backups prüfen, ob sich die WAL-Segmente im Archiv befinden.

Prüft, ob alle für ein konsistentes Backup erforderlichen WAL-Segmente im WAL-Archiv vorhanden sind. Es empfiehlt sich, die Standardeinstellung beizubehalten, sofern keine andere Archivierungsmethode verwendet wird.

Diese Option muss aktiviert sein, wenn archive-copy aktiviert ist.

default: y
example: --no-archive-check

Option zum Kopieren des Archivs (--archive-copy)

Für die Konsistenz benötigte WAL-Segmente in das Backup kopieren.

Diese etwas übervorsichtige Option schützt vor beschädigten Daten im WAL-Segmentarchiv, indem sie die für die Konsistenz erforderlichen WAL-Segmente direkt im Backup speichert. Die WAL-Segmente bleiben zusätzlich im Archiv gespeichert, daher benötigt diese Option weiteren Speicherplatz.

Bei Verwendung dieser Option sollten die Befehle archive-push und backup möglichst denselben Wert für compress-type verwenden (z. B. lz4). Andernfalls müssen die WAL-Segmente mit dem für das Backup verwendeten compress-type neu komprimiert werden. Je nach der während des Backups erzeugten WAL-Menge kann dies recht aufwendig sein.

Bei der Wiederherstellung liegen die WAL-Segmente in pg_xlog/pg_wal. PostgreSQL bevorzugt diese Segmente gegenüber einem Aufruf von restore_command.

Die Option archive-check muss aktiviert sein, wenn archive-copy aktiviert ist.

default: n
example: --archive-copy

Option zur Prüfung des Archivierungsmodus (--archive-mode-check)

Die PostgreSQL-Einstellung archive_mode prüfen.

Diese standardmäßig aktivierte Option verbietet die PostgreSQL-Einstellung archive_mode=always.

Von einem Standby-Server übertragene WAL-Segmente können logisch mit denen des Primärservers übereinstimmen, aber andere Prüfsummen aufweisen. Zur Vermeidung von Konflikten wird empfohlen, die Archivierung aus mehreren Quellen zu unterbinden.

ACHTUNG:

Bei deaktivierter Option muss unbedingt sichergestellt werden, dass nur ein Archivierer mit dem Befehl archive-push in das Repository schreibt.

default: y
example: --no-archive-mode-check

Option für das Archivierungszeitlimit (--archive-timeout)

Archivierungszeitlimit.

Maximale Wartezeit in Sekunden festlegen, bis ein einzelnes WAL-Segment das Archiv-Repository von pgBackRest erreicht. Dieses Zeitlimit gilt für die Befehle check und backup, wenn sie auf die Archivierung der WAL-Segmente warten, die für ein konsistentes Backup erforderlich sind.

default: 1m
allowed: [100ms, 1d]
example: --archive-timeout=30

Option für Backups vom Standby (--backup-standby)

Backup vom Standby-Cluster erstellen.

Backups vom Standby aktivieren, um die Last auf dem Primärcluster zu verringern. Für diese Option müssen sowohl der Primär- als auch der Standby-Host konfiguriert sein.

Die folgenden Modi werden unterstützt:

• y - Für das Backup ist ein Standby erforderlich.
• prefer - Backup vom Standby erstellen, falls verfügbar, andernfalls vom Primärserver.
• n - Backup ausschließlich vom Primärserver erstellen.

default: n
example: --backup-standby=y

Option für Seitenprüfsummen (--checksum-page)

Prüfsummen der Datenseiten validieren.

Weist pgBackRest an, beim Backup eines Clusters die Prüfsummen aller Datenseiten zu validieren. Diese Option wird automatisch aktiviert, wenn Datenseitenprüfsummen im Cluster aktiviert sind.

Fehler bei der Prüfsummenvalidierung brechen das Backup nicht ab. Stattdessen werden Warnungen ins Protokoll geschrieben und bei Standardeinstellungen auch auf der Konsole ausgegeben. Die Liste der ungültigen Seiten wird im Backup-Manifest gespeichert.

example: --no-checksum-page

Option zum Ausschließen von Pfaden und Dateien (--exclude)

Pfade und Dateien vom Backup ausschließen.

Alle Ausschlüsse beziehen sich auf $PGDATA. Endet der Ausschluss mit /, werden nur Dateien im angegebenen Verzeichnis ausgeschlossen. Beispielsweise schließt --exclude=junk/ alle Dateien im Verzeichnis $PGDATA/junk aus, nimmt aber das Verzeichnis selbst auf. Endet der Ausschluss nicht mit /, kann eine Datei entweder genau dem Ausschluss entsprechen oder dem Ausschluss mit angehängtem /. So schließt --exclude=junk das Verzeichnis $PGDATA/junk und alle darin enthaltenen Dateien aus.

Diese Funktion mit Vorsicht verwenden: Wichtige Inhalte lassen sich leicht versehentlich ausschließen, wodurch das Backup inkonsistent wird. Testen Sie unbedingt Ihre Wiederherstellungen!

Alle ausgeschlossenen Dateien werden zusammen mit der Ausschlussregel auf der Stufe info protokolliert. Prüfen Sie unbedingt die Liste, damit keine Dateien unerwartet ausgeschlossen werden.

HINWEIS: Ausschlüsse werden bei Delta-Wiederherstellungen nicht berücksichtigt. Alle beim Backup ausgeschlossenen Dateien und Verzeichnisse werden bei einer Delta-Wiederherstellung entfernt.

Diese Option sollte nicht verwendet werden, um PostgreSQL-Protokolle vom Backup auszuschließen. Mit der PostgreSQL-Einstellung log_directory lassen sich Protokolle außerhalb des Verzeichnisses PGDATA ablegen. Dies hat den Vorteil, dass sie nach einer Wiederherstellung erhalten bleiben können.

In der Befehlszeile oder einer Konfigurationsdatei können mehrere Ausschlüsse angegeben werden.

example: --exclude=junk/

Option zur automatischen Bereinigung (--expire-auto)

Nach einem erfolgreichen Backup automatisch den Befehl expire ausführen.

Diese Einstellung ist standardmäßig aktiviert. Beim Deaktivieren ist Vorsicht geboten: Alle Backups und Archive bleiben dann unbegrenzt erhalten, wodurch der Speicherplatz im Repository ausgehen kann. Um dies zu verhindern, muss der Befehl expire regelmäßig ausgeführt werden.

Wird expire nach einem erfolgreichen Backup automatisch ausgeführt, verwendet es die Konfiguration des Befehls backup. Optionen, die ausschließlich in einem Abschnitt für den Befehl expire stehen, etwa [global:expire], werden daher nicht angewendet. Um eine eigene Konfiguration für expire anzuwenden, diese Option deaktivieren und den Befehl expire separat ausführen.

default: y
example: --expire-auto

Option zum Erzwingen (--force)

Ein Offline-Backup erzwingen.

Zusammen mit --no-start-stop wird ein Backup auch dann ausgeführt, wenn pgBackRest davon ausgeht, dass PostgreSQL läuft. Diese Option sollte mit äußerster Vorsicht verwendet werden, da sie wahrscheinlich zu einem unbrauchbaren Backup führt.

Unter bestimmten Umständen kann ein Backup auch unter diesen Bedingungen wünschenswert sein. Stürzt beispielsweise ein Server ab und lässt sich das Volume des Datenbankclusters nur lesend einhängen, ist ein Backup auch dann sinnvoll, wenn postmaster.pid vorhanden ist. In diesem Fall wäre es besser, auf das vorherige Backup zurückzugreifen und WAL erneut einzuspielen. Möglicherweise befindet sich aber eine sehr wichtige Transaktion in einem noch nicht archivierten WAL-Segment.

default: n
example: --force

Option für den Schwellenwert zum Speichern des Manifests (--manifest-save-threshold)

Schwellenwert zum Speichern des Manifests während des Backups.

Legt fest, wie oft das Manifest während eines Backups gespeichert wird. Das Speichern ist wichtig, da das Manifest Prüfsummen enthält und eine effiziente Wiederaufnahme ermöglicht. Der tatsächlich verwendete Schwellenwert ist der größere Wert aus 1% der Backup-Größe und manifest-save-threshold.

default: 1GiB
allowed: [1B, 1TiB]
example: --manifest-save-threshold=8GiB

Option für Online-Backups (--online)

Ein Online-Backup erstellen.

Mit –no-online führt pgBackRest die Funktionen zum Starten und Stoppen des Backups auf dem Datenbankcluster nicht aus. Dazu sollte PostgreSQL heruntergefahren sein; andernfalls meldet pgBackRest einen Fehler.

Diese Option ermöglicht Offline-Backups. Das Verzeichnis pg_xlog/pg_wal wird unverändert kopiert, und archive-check wird für das Backup automatisch deaktiviert.

default: y
example: --no-online

Option zur Wiederaufnahme (--resume)

Die Wiederaufnahme eines fehlgeschlagenen Backups erlauben.

Legt fest, ob die Wiederaufnahme aktiviert ist. Sie kann die benötigte Zeit erheblich verkürzen, wenn zuvor ein Backup desselben Typs fehlgeschlagen ist. Sie erhöht jedoch die Komplexität. In Umgebungen, die diese Funktion nicht benötigen, kann es daher sinnvoll sein, sie zu deaktivieren.

default: y
example: --no-resume

Option für einen schnellen Start (--start-fast)

Einen Checkpoint erzwingen, um das Backup schnell zu starten.

Erzwingt einen Checkpoint, indem dem Parameter fast der Backup-Startfunktion der Wert y übergeben wird, sodass das Backup sofort beginnt. Andernfalls beginnt es nach dem nächsten regulären Checkpoint.

default: n
example: --start-fast

Option für den Typ (--type)

Backup-Typ.

Die folgenden Backup-Typen werden unterstützt:

• full - Alle Dateien des Datenbankclusters werden kopiert; es bestehen keine Abhängigkeiten von vorherigen Backups.
• incr - Inkrementelles Backup seit dem letzten erfolgreichen Backup.
• diff - Wie ein inkrementelles Backup, aber stets auf Grundlage des letzten vollständigen Backups.

default: incr
example: --type=full

Allgemeine Optionen

Option zur Ausführung als root (--allow-root)

Die Ausführung des Befehls als Benutzer root erlauben.

Standardmäßig darf nur der Befehl restore als Benutzer root ausgeführt werden, da er die Dateieigentümer sorgfältig verwaltet. Bei anderen Befehlen besteht das Risiko, dass Dateien entstehen, die root gehören, etwa im Repository. Diese sind für den PostgreSQL-Benutzer nicht zugänglich, sodass spätere Befehle fehlschlagen.

Diese Option aktivieren, um einen Befehl dennoch als root auszuführen. Es ist jedoch deutlich besser, pgBackRest als den Benutzer auszuführen, dem das Repository und der PostgreSQL-Cluster gehören.

default: n
example: --allow-root

Option für die Puffergröße (--buffer-size)

Puffergröße für I/O-Operationen.

Puffergröße für Kopier-, Komprimierungs-, Verschlüsselungs- und andere Operationen. Die Anzahl der verwendeten Puffer hängt von den Optionen ab. Jede Operation kann zusätzlichen Speicher benötigen; beispielsweise kann die Komprimierung mit gz weitere 256KiB Speicher beanspruchen.

Zulässige Werte sind 16KiB, 32KiB, 64KiB, 128KiB, 256KiB, 512KiB, 1MiB, 2MiB, 4MiB, 8MiB und 16MiB.

default: 1MiB
example: --buffer-size=2MiB

Option für den pgBackRest-Befehl (--cmd)

pgBackRest-Befehl.

pgBackRest kann eine Befehlszeichenfolge erzeugen, etwa wenn der Befehl restore die Einstellung restore_command erzeugt. Dafür wird der Befehl verwendet, mit dem der pgBackRest-Prozess gestartet wurde, sofern nicht die Option cmd angegeben ist.

ACHTUNG:

Das Einbetten des pgBackRest-Befehls in einen Wrapper kann unvorhersehbares Verhalten verursachen und wird nicht empfohlen.

default: [path of executed pgbackrest binary]
example: --cmd=/var/lib/pgsql/bin/pgbackrest_wrapper.sh

Option für den SSH-Client-Befehl (--cmd-ssh)

SSH-Client-Befehl.

Einen bestimmten SSH-Client-Befehl verwenden, wenn eine Alternative gewünscht wird oder der Befehl ssh nicht in $PATH liegt.

default: ssh
example: --cmd-ssh=/usr/bin/ssh

Option zur Komprimierung (--compress)

Dateikomprimierung verwenden.

Die Backup-Dateien sind mit Komprimierungswerkzeugen für die Befehlszeile kompatibel.

Diese Option ist inzwischen veraltet. Stattdessen sollte compress-type verwendet werden.

default: y
example: --no-compress

Option für die Komprimierungsstufe (--compress-level)

Komprimierungsstufe für Dateien.

Legt die Stufe für die Dateikomprimierung fest, wenn compress-type nicht none ist oder compress=y (veraltet) gilt.

default (depending on compress-type):
    bz2 - 9
    gz - 6
    lz4 - 1
    zst - 3

allow range (depending on compress-type):
    bz2 - [1, 9]
    gz - [-1, 9]
    lz4 - [-5, 12]
    zst - [-7, 22]

example: --compress-level=9

Option für die Netzwerkkomprimierungsstufe (--compress-level-network)

Komprimierungsstufe für die Netzwerkübertragung.

Legt die Komprimierungsstufe für die Netzwerkübertragung fest, wenn compress-type=none gilt und der Befehl nicht auf demselben Host wie das Repository ausgeführt wird. Die Komprimierung verringert den Netzwerkverkehr. Wenn compress-type nicht none ist, wird compress-level-network ignoriert und stattdessen compress-level verwendet, damit die Datei nur einmal komprimiert wird.

default: 1
allowed: [-5, 12]
example: --compress-level-network=1

Option für das Komprimierungsverfahren (--compress-type)

Komprimierungsverfahren für Dateien.

Die folgenden Komprimierungsverfahren werden unterstützt:

• none - Keine Komprimierung
• bz2 - bzip2-Komprimierungsformat
• gz - gzip-Komprimierungsformat
• lz4 - lz4-Komprimierungsformat (nicht auf allen Plattformen verfügbar)
• zst - Zstandard-Komprimierungsformat (nicht auf allen Plattformen verfügbar)

default: gz
example: --compress-type=none

Option für die Konfigurationsdatei (--config)

pgBackRest-Konfigurationsdatei.

Mit dieser Option eine andere als die standardmäßige Konfigurationsdatei angeben.

default: CFGOPTDEF_CONFIG_PATH "/" PROJECT_CONFIG_FILE
example: --config=/conf/pgbackrest/pgbackrest.conf

Option für den Pfad zusätzlicher Konfigurationsdateien (--config-include-path)

Pfad zu zusätzlichen pgBackRest-Konfigurationsdateien.

Konfigurationsdateien mit der Endung .conf am angegebenen Speicherort werden mit der pgBackRest-Konfigurationsdatei zu einer einzigen Konfigurationsdatei zusammengefügt.

default: CFGOPTDEF_CONFIG_PATH "/" PROJECT_CONFIG_INCLUDE_PATH
example: --config-include-path=/conf/pgbackrest/conf.d

Option für den Konfigurationspfad (--config-path)

Basispfad der pgBackRest-Konfigurationsdateien.

Diese Einstellung überschreibt den standardmäßigen Basispfad der Optionen --config und --config-include-path, sofern diese nicht ausdrücklich in der Befehlszeile gesetzt werden.

Wird beispielsweise nur --config-path=/conf/pgbackrest angegeben, erhält --config den Standardwert /conf/pgbackrest/pgbackrest.conf und --config-include-path den Standardwert /conf/pgbackrest/conf.d.

default: CFGOPTDEF_CONFIG_PATH
example: --config-path=/conf/pgbackrest

Option für das Datenbankzeitlimit (--db-timeout)

Zeitlimit für Datenbankabfragen.

Legt das Zeitlimit für Datenbankabfragen in Sekunden fest. Dazu gehören auch die Funktionen zum Starten und Stoppen des Backups, die jeweils viel Zeit benötigen können. Daher sollte das Zeitlimit hoch bleiben, sofern nicht bekannt ist, dass diese Funktionen schnell zurückkehren, etwa wenn start-fast=y gesetzt ist und bekannt ist, dass der Datenbankcluster während des Backups nur wenige WAL-Segmente erzeugt.

HINWEIS: Der Wert von db-timeout muss kleiner sein als der von protocol-timeout.

default: 30m
allowed: [100ms, 7d]
example: --db-timeout=600

Delta-Option (--delta)

Wiederherstellung oder Backup anhand von Prüfsummen durchführen.

Bei einer Wiederherstellung wird standardmäßig erwartet, dass die PostgreSQL-Daten- und Tablespace-Verzeichnisse vorhanden, aber leer sind. Diese Option führt eine Delta-Wiederherstellung anhand von Prüfsummen durch.

Bei einem Backup verwendet diese Option Prüfsummen anstelle von Zeitstempeln, um zu entscheiden, ob Dateien kopiert werden.

default: n
example: --delta

Option für das I/O-Zeitlimit (--io-timeout)

I/O-Zeitlimit.

Zeitlimit in Sekunden für Verbindungen sowie Lese- und Schreiboperationen.

Die gesamte Lese- oder Schreiboperation muss nicht innerhalb dieses Zeitlimits abgeschlossen sein, aber es muss irgendein Fortschritt erzielt werden, selbst wenn es nur ein einziges Byte ist.

default: 1m
allowed: [100ms, 1h]
example: --io-timeout=120

Option für den Sperrdateipfad (--lock-path)

Pfad zum Speichern der Sperrdateien.

In diesem Pfad erstellt pgBackRest Sperrdateien, um die gleichzeitige Ausführung miteinander in Konflikt stehender Operationen zu verhindern.

default: /tmp/pgbackrest
example: --lock-path=/backup/db/lock

Option für eine neutrale umask (--neutral-umask)

Eine neutrale umask verwenden.

Setzt die umask auf 0000, damit die Zugriffsrechte im Repository sinnvoll gesetzt werden. Standardmäßig erhalten Verzeichnisse den Modus 0750 und Dateien den Modus 0640.

Um stattdessen die umask des ausführenden Benutzers zu verwenden, neutral-umask=n in der Konfigurationsdatei oder --no-neutral-umask in der Befehlszeile angeben.

default: y
example: --no-neutral-umask

Option für die Prozesspriorität (--priority)

Prozesspriorität festlegen.

Legt fest, welche Priorität (also welcher nice-Wert) dem Prozess vom Kernel-Scheduler zugewiesen wird. Positive Werte verringern die Priorität, negative Werte erhöhen sie. In den meisten Fällen dürfen Prozesse ihre Priorität nicht erhöhen.

allowed: [-20, 19]
example: --priority=19

Option für die maximale Prozessanzahl (--process-max)

Maximale Anzahl der Prozesse für Komprimierung und Übertragung.

Jeder Prozess führt Komprimierung und Übertragung aus, um den Befehl zu beschleunigen. process-max jedoch nicht so hoch setzen, dass die Datenbankleistung beeinträchtigt wird.

default: 1
allowed: [1, 999]
example: --process-max=4

Option für das Protokollzeitlimit (--protocol-timeout)

Protokollzeitlimit.

Legt in Sekunden fest, wie lange der lokale oder entfernte Prozess auf eine neue Nachricht auf der Protokollebene wartet. Dies verhindert, dass Prozesse unbegrenzt auf eine Nachricht warten.

HINWEIS: Der Wert von protocol-timeout muss größer sein als der von db-timeout.

default: 31m
allowed: [100ms, 7d]
example: --protocol-timeout=630

Option für Keep-alive (--sck-keep-alive)

Keep-alive aktivieren.

Aktiviert Keep-alive-Nachrichten auf Socket-Verbindungen.

default: y
example: --no-sck-keep-alive

Option für die Stanza (--stanza)

Definiert die Stanza.

Eine Stanza ist die Konfiguration eines PostgreSQL-Datenbankclusters. Sie legt unter anderem dessen Speicherort, das Backup-Verfahren und die Archivierungsoptionen fest. Die meisten Datenbankserver haben nur einen PostgreSQL-Datenbankcluster und daher nur eine Stanza. Backup-Server haben dagegen für jeden zu sichernden Datenbankcluster eine Stanza.

Es liegt nahe, die Stanza nach dem Primärcluster zu benennen. Ein besserer Name beschreibt jedoch die im Cluster enthaltenen Datenbanken. Da der Stanza-Name für den Primärserver und alle Replikate verwendet wird, sollte er die tatsächliche Funktion des Clusters beschreiben, etwa app oder dw, statt den lokalen Clusternamen wie main oder prod zu übernehmen.

example: --stanza=main

Option für die Keep-alive-Anzahl (--tcp-keep-alive-count)

Anzahl der Keep-alive-Nachrichten.

Legt fest, wie viele TCP-Keep-alive-Nachrichten verloren gehen dürfen, bevor die Verbindung als unterbrochen gilt.

Diese Option ist auf Systemen verfügbar, die die Socket-Option TCP_KEEPCNT unterstützen.

allowed: [1, 32]
example: --tcp-keep-alive-count=3

Option für die Keep-alive-Leerlaufzeit (--tcp-keep-alive-idle)

Keep-alive-Leerlaufzeit.

Legt die Zeit ohne Netzwerkaktivität in Sekunden fest, nach der das Betriebssystem eine TCP-Keep-alive-Nachricht senden sollte.

Diese Option ist auf Systemen verfügbar, die die Socket-Option TCP_KEEPIDLE unterstützen.

allowed: [1, 3600]
example: --tcp-keep-alive-idle=60

Option für das Keep-alive-Intervall (--tcp-keep-alive-interval)

Keep-alive-Intervall.

Legt die Zeit in Sekunden fest, nach der eine nicht bestätigte TCP-Keep-alive-Nachricht erneut gesendet werden sollte.

Diese Option ist auf Systemen verfügbar, die die Socket-Option TCP_KEEPINTVL unterstützen.

allowed: [1, 900]
example: --tcp-keep-alive-interval=30

Option für TLSv1.2-Cipher-Suites (--tls-cipher-12)

Zulässige TLSv1.2-Cipher-Suites.

Alle TLS-Verbindungen zwischen pgBackRest-Client und -Server sind verschlüsselt. Standardmäßig sind auch Verbindungen zu Objektspeichern wie S3 verschlüsselt.

HINWEIS: TLSv1.2 ist das absolute Mindestsicherheitsniveau für jede Transportverbindung.

Die akzeptierten Cipher-Suites können bei Bedarf angepasst werden. Das Beispiel ist eine sinnvolle Wahl, sofern keine besonderen Sicherheitsanforderungen bestehen. Ist die Option nicht gesetzt (Standardeinstellung), gilt die Vorgabe der zugrunde liegenden OpenSSL-Bibliothek.

example: --tls-cipher-12=HIGH:MEDIUM:+3DES:!aNULL

Option für TLSv1.3-Cipher-Suites (--tls-cipher-13)

Zulässige TLSv1.3-Cipher-Suites.

Alle TLS-Verbindungen zwischen pgBackRest-Client und -Server sind verschlüsselt. Standardmäßig sind auch Verbindungen zu Objektspeichern wie S3 verschlüsselt.

HINWEIS: TLSv1.2 ist das absolute Mindestsicherheitsniveau für jede Transportverbindung.

Die akzeptierten Cipher-Suites können bei Bedarf angepasst werden. Ist die Option nicht gesetzt (Standardeinstellung), gilt die Vorgabe der zugrunde liegenden OpenSSL-Bibliothek.

example: --tls-cipher-13=TLS_AES_256_GCM_SHA384:TLS_CHACHA20_POLY1305_SHA256

Protokollierungsoptionen

Option für die Protokollierungsstufe der Konsole (--log-level-console)

Protokollierungsstufe für die Konsole.

Die folgenden Protokollierungsstufen werden unterstützt:

• off - Keine Protokollierung (nicht empfohlen)
• error - Nur Fehler protokollieren
• warn - Warnungen und Fehler protokollieren
• info - Informationen, Warnungen und Fehler protokollieren
• detail - Details, Informationen, Warnungen und Fehler protokollieren
• debug - Debug-Meldungen, Details, Informationen, Warnungen und Fehler protokollieren
• trace - Trace-Meldungen (sehr ausführliche Debug-Ausgaben), Debug-Meldungen, Informationen, Warnungen und Fehler protokollieren

default: warn
example: --log-level-console=error

Option für die Protokollierungsstufe der Datei (--log-level-file)

Protokollierungsstufe für die Dateiausgabe.

Die folgenden Protokollierungsstufen werden unterstützt:

• off - Keine Protokollierung (nicht empfohlen)
• error - Nur Fehler protokollieren
• warn - Warnungen und Fehler protokollieren
• info - Informationen, Warnungen und Fehler protokollieren
• detail - Details, Informationen, Warnungen und Fehler protokollieren
• debug - Debug-Meldungen, Details, Informationen, Warnungen und Fehler protokollieren
• trace - Trace-Meldungen (sehr ausführliche Debug-Ausgaben), Debug-Meldungen, Informationen, Warnungen und Fehler protokollieren

default: info
example: --log-level-file=debug

Option für die Protokollierungsstufe der Standardfehlerausgabe (--log-level-stderr)

Protokollierungsstufe für stderr.

Legt fest, welche Protokollierungsstufen an stderr statt an stdout ausgegeben werden (festgelegt durch log-level-console). Zeitstempel und Prozess werden nicht an stderr ausgegeben.

Die folgenden Protokollierungsstufen werden unterstützt:

• off - Keine Protokollierung (nicht empfohlen)
• error - Nur Fehler protokollieren
• warn - Warnungen und Fehler protokollieren
• info - Informationen, Warnungen und Fehler protokollieren
• detail - Details, Informationen, Warnungen und Fehler protokollieren
• debug - Debug-Meldungen, Details, Informationen, Warnungen und Fehler protokollieren
• trace - Trace-Meldungen (sehr ausführliche Debug-Ausgaben), Debug-Meldungen, Informationen, Warnungen und Fehler protokollieren

default: off
example: --log-level-stderr=error

Option für den Protokollpfad (--log-path)

Pfad, an dem Protokolldateien gespeichert werden.

In diesem Pfad speichert pgBackRest seine Protokolldateien. Bei log-level-file=off ist kein Protokollpfad erforderlich.

default: /var/log/pgbackrest
example: --log-path=/backup/db/log

Option für die Protokollierung von Unterprozessen (--log-subprocess)

Protokollierung in Unterprozessen aktivieren.

Aktiviert die Dateiprotokollierung für alle von diesem Prozess erzeugten Unterprozesse mit der durch log-level-file festgelegten Protokollierungsstufe.

default: n
example: --log-subprocess

Option für Zeitstempel im Protokoll (--log-timestamp)

Zeitstempel in der Protokollierung aktivieren.

Aktiviert Zeitstempel in der Konsolen- und Dateiprotokollierung. Diese Option wird in besonderen Situationen deaktiviert, etwa beim Erzeugen der Dokumentation.

default: y
example: --no-log-timestamp

Optionen für Maintainer

Option zur Prüfung der Seitenheader (--page-header-check)

PostgreSQL-Seitenheader prüfen.

Diese standardmäßig aktivierte Option ergänzt Prüfungen der Seitenheader.

Das Deaktivieren dieser Option sollte vermieden werden, außer wenn es erforderlich ist, etwa bei verschlüsselten Seiten.

default: y
example: --no-page-header-check

Option zum Erzwingen der PostgreSQL-Version (--pg-version-force)

PostgreSQL-Version erzwingen.

Verwendet die angegebene PostgreSQL-Version statt der Version, die automatisch aus pg_control oder WAL-Headern ermittelt wird. Dies ist hauptsächlich für PostgreSQL-Forks oder Entwicklungsversionen hilfreich, deren Werte von denen der veröffentlichten Version abweichen. Die von PostgreSQL über server_version_num gemeldete Version muss mit der erzwungenen Version übereinstimmen.

WARNUNG:

Diese Option mit Vorsicht verwenden: pg_control und WAL-Header werden weiterhin im erwarteten Format der angegebenen Version gelesen, also im Format der offiziellen Open-Source-Version von PostgreSQL. Ändert der Fork oder die Entwicklungsversion das Format von Feldern, auf die pgBackRest angewiesen ist, führt dies zu unerwartetem Verhalten. Im Allgemeinen funktioniert diese Option nur dann wie erwartet, wenn der Fork alle eigenen Strukturfelder nach den standardmäßigen PostgreSQL-Feldern hinzufügt.

example: --pg-version-force=15

Repository-Optionen

Option zur Auswahl des Repositorys (--repo)

Repository festlegen.

Legt das Repository fest, auf das ein Befehl wirken soll.

Damit kann beispielsweise eine Wiederherstellung aus einem bestimmten Repository durchgeführt werden, anstatt pgBackRest die Auswahl zu überlassen.

allowed: [1, 256]
example: --repo=1