Skip to content

Add --timestamp and --detail options for backup-info command. #34

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
woblerr merged 8 commits into from
Sep 18, 2025
Merged

Add --timestamp and --detail options for backup-info command. #34

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
a9eec51
Add timestamp option for backup-info command.
woblerr Sep 14, 2025
c8dbe4e
Use struct for backup-info command options.
woblerr Sep 15, 2025
016227f
Add functional to display verbose info for filtered objects.
woblerr Sep 15, 2025
6848504
Fix linting issue.
woblerr Sep 15, 2025
a72eb02
Add e2e test for new functional.
woblerr Sep 15, 2025
e5bdca1
Fix e2e tests for backup-info command.
woblerr Sep 15, 2025
db3ff05
Add --detail option for backup-info command.
woblerr Sep 15, 2025
75f2c60
Fix style.
woblerr Sep 15, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
81 changes: 68 additions & 13 deletions COMMANDS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -270,8 +270,8 @@ Display information about backups.

By default, only active backups or backups with deletion status "In progress" from gpbackup_history.db are displayed.

To additional display deleted backups, use the --deleted option.
To additional display failed backups, use the --failed option.
To display deleted backups, use the --deleted option.
To display failed backups, use the --failed option.
To display all backups, use --deleted and --failed options together.

To display backups of a specific type, use the --type option.
Expand All @@ -286,7 +286,21 @@ To display backups that exclude the specified table, use the --table and --exclu
The formatting rules for <schema>.<table> match those of the --exclude-table option in gpbackup.

To display backups that exclude the specified schema, use the --schema and --exclude options.
The formatting rules for <schema>match those of the --exclude-schema option in gpbackup.
The formatting rules for <schema> match those of the --exclude-schema option in gpbackup.

To display details about object filtering, use the --detail option.
The details are presented as follows, depending on the active filtering type:
* include-table / exclude-table: a comma-separated list of fully-qualified table names in the format <schema>.<table>;
* include-schema / exclude-schema: a comma-separated list of schema names;
* if no object filtering was used, the value is empty.

To display a backup chain for a specific backup, use the --timestamp option.
In this mode, the backup with the specified timestamp and all of its dependent backups will be displayed.
The deleted and failed backups are always included in this mode.
The information about object filtering details is always included in this mode.
When --timestamp is set, the following options cannot be used: --type, --table, --schema, --exclude, --failed, --deleted, --detail.

To display the "object filtering details" column for all backups without using --timestamp, use the --detail option.

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.
Expand All @@ -296,13 +310,15 @@ Usage:
gpbackman backup-info [flags]

Flags:
--deleted show deleted backups
--exclude show backups that exclude the specific table (format <schema>.<table>) or schema
--failed show failed backups
-h, --help help for backup-info
--schema string show backups that include the specified schema
--table string show backups that include the specified table (format <schema>.<table>)
--type string backup type filter (full, incremental, data-only, metadata-only)
--deleted show deleted backups
--detail show object filtering details
--exclude show backups that exclude the specific table (format <schema>.<table>) or schema
--failed show failed backups
-h, --help help for backup-info
--schema string show backups that include the specified schema
--table string show backups that include the specified table (format <schema>.<table>)
--timestamp string show backup info and its dependent backups for the specified timestamp
--type string backup type filter (full, incremental, data-only, metadata-only)

Global Flags:
--history-db string full path to the gpbackup_history.db file
Expand Down Expand Up @@ -338,6 +354,12 @@ The following information is provided about each backup:
- `""` - if backup is active;
- date in format `Mon Jan 02 2006 15:04:05` - if backup is deleted and deletion timestamp is set.

If the `--timestamp` option is specified, the following additional information is provided:
* `OBJECT FILTERING DETAILS` - details about object filtering:
- if `include-table` or `exclude-table` filtering was used, a comma-separated list of fully-qualified table names in the format `<schema>.<table>`;
- if `include-schema` or `exclude-schema` filtering was used, a comma-separated list of schema names;
- if no object filtering was used, the value is empty.

If gpbackup is launched without specifying `--metadata-only` flag, but there were no tables that contain data for backup, then gpbackup will only perform a `metadata-only` backup. The logs will contain messages like `No tables in backup set contain data. Performing metadata-only backup instead.` As a result, gpBackMan will display such backups as `metadata-only`.

## Examples
Expand Down Expand Up @@ -371,7 +393,7 @@ Display info for active full backups from `gpbackup_history.db`:
./gpbackman backup-info \
--type full

TIMESTAMP | DATE | STATUS | DATABASE | TYPE | OBJECT FILTERING | PLUGIN | DURATION | DATE DELETED
TIMESTAMP | DATE | STATUS | DATABASE | TYPE | OBJECT FILTERING | PLUGIN | DURATION | DATE DELETED
----------------+--------------------------+---------+----------+------+------------------+--------------------+----------+--------------
20230809232817 | Wed Aug 09 2023 23:28:17 | Success | demo | full | | | 04:00:03 |
20230725101115 | Tue Jul 25 2023 10:11:15 | Success | demo | full | | gpbackup_s3_plugin | 00:00:20 |
Expand All @@ -386,7 +408,7 @@ Find all backups, including deleted ones, containing the `test1` schema.
--deleted \
--schema test1

TIMESTAMP | DATE | STATUS | DATABASE | TYPE | OBJECT FILTERING | PLUGIN | DURATION | DATE DELETED
TIMESTAMP | DATE | STATUS | DATABASE | TYPE | OBJECT FILTERING | PLUGIN | DURATION | DATE DELETED
----------------+--------------------------+---------+----------+-------------+------------------+--------------------+----------+--------------------------
20230525101152 | Thu May 25 2023 10:11:52 | Success | demo | incremental | include-schema | gpbackup_s3_plugin | 00:30:00 | Sun Jun 25 2023 10:11:52
20230524101152 | Wed May 24 2023 10:11:52 | Success | demo | incremental | include-schema | gpbackup_s3_plugin | 00:30:00 |
Expand All @@ -400,7 +422,7 @@ Display info for all backups, including deleted and failed ones, from `gpbackup_
--failed \
--history-db /data/master/gpseg-1/gpbackup_history.db

TIMESTAMP | DATE | STATUS | DATABASE | TYPE | OBJECT FILTERING | PLUGIN | DURATION | DATE DELETED
TIMESTAMP | DATE | STATUS | DATABASE | TYPE | OBJECT FILTERING | PLUGIN | DURATION | DATE DELETED
----------------+--------------------------+---------+----------+---------------+------------------+--------------------+----------+-----------------------------
20230809232817 | Wed Aug 09 2023 23:28:17 | Success | demo | full | | | 04:00:03 |
20230806230400 | Sun Aug 06 2023 23:04:00 | Failure | demo | full | | gpbackup_s3_plugin | 00:00:38 |
Expand All @@ -425,6 +447,39 @@ TIMESTAMP | DATE | STATUS | DATABASE | TYPE |
20230523101115 | Tue May 23 2023 10:11:15 | Success | demo | full | include-schema | gpbackup_s3_plugin | 01:01:00 |
```

Display full backup with object filtering details:
```bash
./gpbackman backup-info \
--type full \
--detail

TIMESTAMP | DATE | STATUS | DATABASE | TYPE | OBJECT FILTERING | PLUGIN | DURATION | DATE DELETED | OBJECT FILTERING DETAILS
----------------+--------------------------+---------+----------+------+------------------+--------------------+----------+--------------+--------------------------
20250915221743 | Mon Sep 15 2025 22:17:43 | Success | demo | full | | | 00:00:01 | |
20250915221643 | Mon Sep 15 2025 22:16:43 | Success | demo | full | exclude-schema | gpbackup_s3_plugin | 00:00:01 | | sch1
20250915221631 | Mon Sep 15 2025 22:16:31 | Success | demo | full | include-table | gpbackup_s3_plugin | 00:00:01 | | sch2.tbl_c, sch2.tbl_d
20250915221616 | Mon Sep 15 2025 22:16:16 | Success | demo | full | | gpbackup_s3_plugin | 00:00:05 | |
20250915221553 | Mon Sep 15 2025 22:15:53 | Success | demo | full | exclude-table | | 00:00:02 | | sch1.tbl_b
20250915221542 | Mon Sep 15 2025 22:15:42 | Success | demo | full | include-table | | 00:00:01 | | sch1.tbl_a
20250915221531 | Mon Sep 15 2025 22:15:31 | Success | demo | full | | | 00:00:01 | |

```

Display info for the backup chain for a specific backup. In this example, the backup with timestamp `20250913210921` is a full backup, and all its dependent incremental backups are displayed as well:
```bash
./gpbackman backup-info \
--timestamp 20250913210921

TIMESTAMP | DATE | STATUS | DATABASE | TYPE | OBJECT FILTERING | PLUGIN | DURATION | DATE DELETED | OBJECT FILTERING DETAILS
----------------+--------------------------+---------+----------+-------------+------------------+--------------------+----------+--------------------------+--------------------------
20250915201446 | Mon Sep 15 2025 20:14:46 | Success | demo | incremental | include-table | gpbackup_s3_plugin | 00:00:02 | | sch2.tbl_c
20250915201439 | Mon Sep 15 2025 20:14:39 | Success | demo | incremental | include-table | gpbackup_s3_plugin | 00:00:01 | | sch2.tbl_c
20250915201307 | Mon Sep 15 2025 20:13:07 | Success | demo | incremental | include-table | gpbackup_s3_plugin | 00:00:02 | Mon Sep 15 2025 20:17:56 | sch2.tbl_c
20250915200929 | Mon Sep 15 2025 20:09:29 | Success | demo | incremental | include-table | gpbackup_s3_plugin | 00:00:01 | | sch2.tbl_c
20250913210957 | Sat Sep 13 2025 21:09:57 | Success | demo | incremental | include-table | gpbackup_s3_plugin | 00:00:01 | | sch2.tbl_c
20250913210921 | Sat Sep 13 2025 21:09:21 | Success | demo | full | include-table | gpbackup_s3_plugin | 00:00:02 | | sch2.tbl_c
```

## Using container

```bash
Expand Down
Loading
Loading