You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .github/ISSUE_TEMPLATE/bug-report.yml
+2-2Lines changed: 2 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,5 @@
1
1
name: "\U0001F41B Bug Report"
2
-
description: Problems and issues with code in gp-common-go-libs for CloudberryDB.
2
+
description: Problems and issues with code in gpbackup for CloudberryDB.
3
3
title: "[Bug] "
4
4
labels: ["type: Bug"]
5
5
body:
@@ -8,7 +8,7 @@ body:
8
8
value: "Thank you for reporting the problem! We really appreciate your efforts to improve Cloudberry Database. Before reporting it, please (ideally) test on the latest release or main to see if the issue is fixed."
Copy file name to clipboardExpand all lines: README.md
+53-70Lines changed: 53 additions & 70 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,25 +9,28 @@
9
9
---
10
10
11
11
`gpbackup` and `gprestore` are Go utilities for performing Greenplum database
12
-
backups, which are developed by Greenplum Database team. This repo is a fork
13
-
of gpbackup, dedicated to support CloduberryDB 1.0+. You will feel no change
14
-
using gpbackup in CloudberryDB just as well in Greenplum.
12
+
backups, which are originally developed by the Greenplum Database team. This
13
+
repo is a fork of gpbackup, dedicated to supporting CloduberryDB 1.0+. You
14
+
will feel no change using gpbackup in CloudberryDB as well as in Greenplum.
15
15
16
16
## Pre-Requisites
17
17
18
18
The project requires the Go Programming language version 1.11 or higher.
19
19
Follow the directions [here](https://golang.org/doc/) for installation, usage
20
-
and configuration instructions.
20
+
and configuration instructions. Make sure to set the [Go PATH environment
21
+
variable](https://go.dev/doc/install) before starting the following steps.
21
22
22
-
## Downloading
23
+
## Download & Build
24
+
25
+
1. Downloading the latest version:
23
26
24
27
```bash
25
-
go get github.com/cloudberrydb/gpbackup/...
28
+
go install github.com/cloudberrydb/gpbackup@latest
26
29
```
27
30
28
-
This will place the code in `$GOPATH/github.com/greenplum-db/gpbackup`.
31
+
This will place the code in `$GOPATH/pkg/mod/github.com/cloudberrydb/gpbackup`.
29
32
30
-
##Building and installing binaries
33
+
2. Building and installing binaries
31
34
32
35
Make the `gpbackup` directory your current working directory and run:
33
36
@@ -36,97 +39,77 @@ make depend
36
39
make build
37
40
```
38
41
39
-
The `build` target will put the `gpbackup` and `gprestore` binaries in `$HOME/go/bin`.
40
-
41
-
This will also attempt to copy `gpbackup_helper` to the greenplum segments (retrieving hostnames from `gp_segment_configuration`). Pay attention to the output as it will indicate whether this operation was successful.
42
+
The `build` target will put the `gpbackup` and `gprestore` binaries in
43
+
`$HOME/go/bin`. This will also attempt to copy `gpbackup_helper` to the
44
+
CloudberryDB segments (retrieving hostnames from `gp_segment_configuration`).
45
+
Pay attention to the output as it will indicate whether this operation was
46
+
successful.
42
47
43
48
`make build_linux` is for cross compiling on macOS, and the target is Linux.
44
49
45
50
`make install` will scp the `gpbackup_helper` binary (used with -single-data-file flag) to all hosts
46
51
52
+
## Running the utilities
53
+
54
+
The basic command for gpbackup is
55
+
```bash
56
+
gpbackup --dbname <your_db_name>
57
+
```
58
+
59
+
The basic command for gprestore is
60
+
```bash
61
+
gprestore --timestamp <YYYYMMDDHHMMSS>
62
+
```
63
+
64
+
Run `--help` with either command for a complete list of options.
65
+
47
66
## Validation and code quality
48
67
49
68
### Test setup
50
69
51
-
Required for Greenplum Database 6 or higher, several tests require the `dummy_seclabel` Greenplum contrib module. This module exists only to support regression testing of the SECURITY LABEL statement. It is not intended to be used in production. Use the following commands to install the module.
70
+
Required for Cloudberry Database 1.0+, several tests require the
71
+
`dummy_seclabel` Cloudberry Database contrib module. This module exists only
72
+
to support regression testing of the SECURITY LABEL statement. It is not
73
+
intended to be used in production. Use the following commands to install the
0 commit comments