You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cloudberry.apache.org by dj...@apache.org on 2026/04/30 01:16:40 UTC
(cloudberry-backup) 02/05: gpbackman: document history-db env-var fallback in COMMANDS.md and README.md.
This is an automated email from the ASF dual-hosted git repository.
tuhaihe pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/cloudberry-backup.git
commit e86cc03c2e21e7deef9a0f758df5dd721f0c9011
Author: chenqiang <ch...@hashdata.cn>
AuthorDate: Wed Apr 29 12:45:52 2026 +0800
gpbackman: document history-db env-var fallback in COMMANDS.md and README.md.
Replace the "current directory" wording everywhere it appeared with the
new resolution order: $COORDINATOR_DATA_DIRECTORY, $MASTER_DATA_DIRECTORY,
then the current directory.
Signed-off-by: chenqiang <ch...@hashdata.cn>
---
gpbackman/COMMANDS.md | 10 +++++-----
gpbackman/README.md | 2 +-
2 files changed, 6 insertions(+), 6 deletions(-)
diff --git a/gpbackman/COMMANDS.md b/gpbackman/COMMANDS.md
index c67947a3..cf82aa8b 100644
--- a/gpbackman/COMMANDS.md
+++ b/gpbackman/COMMANDS.md
@@ -72,7 +72,7 @@ For non local backups the following logic are applied:
The gpbackup_history.db file location can be set using the --history-db option.
Can be specified only once. The full path to the file is required.
-If the --history-db option is not specified, the history database will be searched in the current directory.
+If the --history-db option is not specified, the history database is looked for under `$COORDINATOR_DATA_DIRECTORY` (then `$MASTER_DATA_DIRECTORY`); if neither variable is set, the current directory is used as a last resort.
Usage:
gpbackman backup-clean [flags]
@@ -158,7 +158,7 @@ For non local backups the following logic are applied:
The gpbackup_history.db file location can be set using the --history-db option.
Can be specified only once. The full path to the file is required.
-If the --history-db option is not specified, the history database will be searched in the current directory.
+If the --history-db option is not specified, the history database is looked for under `$COORDINATOR_DATA_DIRECTORY` (then `$MASTER_DATA_DIRECTORY`); if neither variable is set, the current directory is used as a last resort.
Usage:
gpbackman backup-delete [flags]
@@ -256,7 +256,7 @@ To display the "object filtering details" column for all backups without using -
The gpbackup_history.db file location can be set using the --history-db option.
Can be specified only once. The full path to the file is required.
-If the --history-db option is not specified, the history database will be searched in the current directory.
+If the --history-db option is not specified, the history database is looked for under `$COORDINATOR_DATA_DIRECTORY` (then `$MASTER_DATA_DIRECTORY`); if neither variable is set, the current directory is used as a last resort.
Usage:
gpbackman backup-info [flags]
@@ -455,7 +455,7 @@ Only --older-than-days or --before-timestamp option must be specified, not both.
The gpbackup_history.db file location can be set using the --history-db option.
Can be specified only once. The full path to the file is required.
-If the --history-db option is not specified, the history database will be searched in the current directory.
+If the --history-db option is not specified, the history database is looked for under `$COORDINATOR_DATA_DIRECTORY` (then `$MASTER_DATA_DIRECTORY`); if neither variable is set, the current directory is used as a last resort.
Usage:
gpbackman history-clean [flags]
@@ -524,7 +524,7 @@ It is not necessary to use the --plugin-report-file-path flag for the following
The gpbackup_history.db file location can be set using the --history-db option.
Can be specified only once. The full path to the file is required.
-If the --history-db option is not specified, the history database will be searched in the current directory.
+If the --history-db option is not specified, the history database is looked for under `$COORDINATOR_DATA_DIRECTORY` (then `$MASTER_DATA_DIRECTORY`); if neither variable is set, the current directory is used as a last resort.
Usage:
gpbackman report-info [flags]
diff --git a/gpbackman/README.md b/gpbackman/README.md
index 388ff898..923964ad 100644
--- a/gpbackman/README.md
+++ b/gpbackman/README.md
@@ -53,7 +53,7 @@ Available Commands:
Flags:
-h, --help help for gpbackman
- --history-db string full path to the gpbackup_history.db file
+ --history-db string full path to the gpbackup_history.db file (if unset, falls back to $COORDINATOR_DATA_DIRECTORY/gpbackup_history.db, then $MASTER_DATA_DIRECTORY/gpbackup_history.db, then the current directory)
--log-file string full path to log file directory, if not specified, the log file will be created in the $HOME/gpAdminLogs directory
--log-level-console string level for console logging (error, info, debug, verbose) (default "info")
--log-level-file string level for file logging (error, info, debug, verbose) (default "info")
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@cloudberry.apache.org
For additional commands, e-mail: commits-help@cloudberry.apache.org