-
Notifications
You must be signed in to change notification settings - Fork 679
/
dump.go
265 lines (245 loc) · 7.23 KB
/
dump.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
package gauss
import (
"bufio"
"context"
"fmt"
"io"
"log/slog"
"net"
"os"
"os/exec"
"path/filepath"
"strings"
"github.com/pkg/errors"
"github.com/bytebase/bytebase/backend/plugin/db"
"github.com/bytebase/bytebase/backend/plugin/db/util"
pgparser "github.com/bytebase/bytebase/backend/plugin/parser/pg"
storepb "github.com/bytebase/bytebase/proto/generated-go/store"
)
// Dump dumps the database.
func (driver *Driver) Dump(ctx context.Context, out io.Writer, schemaOnly bool) (string, error) {
// We don't support pg_dump for CloudSQL, because pg_dump not support IAM & instance name for authentication.
// To dump schema for CloudSQL, you need to run the cloud-sql-proxy with IAM to get the host and port.
// Learn more: https://linear.app/bytebase/issue/BYT-5401/support-iam-authentication-for-gcp-and-aws
if driver.config.AuthenticationType == storepb.DataSourceOptions_GOOGLE_CLOUD_SQL_IAM {
return "", nil
}
// pg_dump -d dbName --schema-only+
// Find all dumpable databases
databases, err := driver.getDatabases(ctx)
if err != nil {
return "", errors.Wrap(err, "failed to get databases")
}
var dumpableDbNames []string
if driver.databaseName != "" {
exist := false
for _, n := range databases {
if n.Name == driver.databaseName {
exist = true
break
}
}
if !exist {
return "", errors.Errorf("database %s not found", driver.databaseName)
}
dumpableDbNames = []string{driver.databaseName}
} else {
for _, n := range databases {
if pgparser.IsSystemDatabase(n.Name) {
continue
}
dumpableDbNames = append(dumpableDbNames, n.Name)
}
}
for _, dbName := range dumpableDbNames {
if err := driver.dumpOneDatabaseWithPgDump(ctx, dbName, out, schemaOnly); err != nil {
return "", err
}
}
return "", nil
}
func (driver *Driver) dumpOneDatabaseWithPgDump(ctx context.Context, database string, out io.Writer, schemaOnly bool) error {
var args []string
args = append(args, fmt.Sprintf("--username=%s", driver.config.Username))
if driver.config.Password == "" {
args = append(args, "--no-password")
}
if driver.sshClient == nil {
args = append(args, fmt.Sprintf("--host=%s", driver.config.Host))
args = append(args, fmt.Sprintf("--port=%s", driver.config.Port))
} else {
localPort := <-util.PortFIFO
defer func() {
util.PortFIFO <- localPort
}()
args = append(args, fmt.Sprintf("--host=%s", "localhost"))
args = append(args, fmt.Sprintf("--port=%d", localPort))
listener, err := net.Listen("tcp", fmt.Sprintf(":%d", localPort))
if err != nil {
return err
}
defer listener.Close()
databaseAddress := fmt.Sprintf("%s:%s", driver.config.Host, driver.config.Port)
go util.ProxyConnection(driver.sshClient, listener, databaseAddress)
}
if schemaOnly {
args = append(args, "--schema-only")
}
args = append(args, "--inserts")
args = append(args, "--use-set-session-authorization")
// Avoid pg_dump v15 generate "ALTER SCHEMA public OWNER TO" statement.
args = append(args, "--no-owner")
// Avoid pg_dump v15 generate REVOKE/GRANT statement.
args = append(args, "--no-privileges")
args = append(args, database)
if err := driver.execPgDump(ctx, args, out); err != nil {
return errors.Wrapf(err, "failed to exec pg_dump")
}
return nil
}
func (driver *Driver) execPgDump(ctx context.Context, args []string, out io.Writer) error {
pgDumpPath := filepath.Join(driver.dbBinDir, "pg_dump")
cmd := exec.CommandContext(ctx, pgDumpPath, args...)
// Unlike MySQL, PostgreSQL does not support specifying password in commands, we can do this by means of environment variables.
if driver.config.Password != "" {
cmd.Env = append(cmd.Env, fmt.Sprintf("PGPASSWORD=%s", driver.config.Password))
}
sslMode := getSSLMode(driver.config.TLSConfig, driver.config.SSHConfig)
cmd.Env = append(cmd.Env, fmt.Sprintf("PGSSLMODE=%s", sslMode))
if driver.config.TLSConfig.SslCA != "" {
caTempFile, err := os.CreateTemp("", "pg-ssl-ca-")
if err != nil {
return err
}
defer os.Remove(caTempFile.Name())
if _, err := caTempFile.WriteString(driver.config.TLSConfig.SslCA); err != nil {
return err
}
if err := caTempFile.Close(); err != nil {
return err
}
cmd.Env = append(cmd.Env, fmt.Sprintf("PGSSLROOTCERT=%s", caTempFile.Name()))
}
if driver.config.TLSConfig.SslCert != "" {
certTempFile, err := os.CreateTemp("", "pg-ssl-cert-")
if err != nil {
return err
}
defer os.Remove(certTempFile.Name())
if _, err := certTempFile.WriteString(driver.config.TLSConfig.SslCert); err != nil {
return err
}
if err := certTempFile.Close(); err != nil {
return err
}
cmd.Env = append(cmd.Env, fmt.Sprintf("PGSSLCERT=%s", certTempFile.Name()))
}
if driver.config.TLSConfig.SslKey != "" {
keyTempFile, err := os.CreateTemp("", "pg-ssl-key-")
if err != nil {
return err
}
defer os.Remove(keyTempFile.Name())
if _, err := keyTempFile.WriteString(driver.config.TLSConfig.SslKey); err != nil {
return err
}
if err := keyTempFile.Close(); err != nil {
return err
}
cmd.Env = append(cmd.Env, fmt.Sprintf("PGSSLKEY=%s", keyTempFile.Name()))
}
cmd.Env = append(cmd.Env, "OPENSSL_CONF=/etc/ssl/")
outPipe, err := cmd.StdoutPipe()
if err != nil {
return err
}
defer outPipe.Close()
outReader := bufio.NewReader(outPipe)
errPipe, err := cmd.StderrPipe()
if err != nil {
return err
}
defer errPipe.Close()
errReader := bufio.NewReader(errPipe)
if err := cmd.Start(); err != nil {
return err
}
previousLineComment := false
previousLineEmpty := false
for {
line, readErr := outReader.ReadString('\n')
if readErr != nil && readErr != io.EOF {
return readErr
}
if err := func() error {
// Skip "SET SESSION AUTHORIZATION" till we can support it.
if strings.HasPrefix(line, "SET SESSION AUTHORIZATION ") {
return nil
}
// Skip comment lines.
if strings.HasPrefix(line, "--") {
previousLineComment = true
return nil
}
if previousLineComment && line == "" {
previousLineComment = false
return nil
}
previousLineComment = false
// Skip extra empty lines.
if strings.TrimSpace(line) == "" {
if previousLineEmpty {
return nil
}
previousLineEmpty = true
} else {
previousLineEmpty = false
}
if _, err := io.WriteString(out, line); err != nil {
return err
}
return nil
}(); err != nil {
return err
}
if readErr == io.EOF {
break
}
}
// We init allMsg with 1024 bytes cap to avoid \x00 in the error message.
allMsg := make([]byte, 0, 1024)
for {
errorMsg := make([]byte, 1024)
readSize, readErr := errReader.Read(errorMsg)
if readSize > 0 {
slog.Warn(string(errorMsg))
allMsg = append(allMsg, errorMsg[0:readSize]...)
}
if readErr != nil {
if readErr == io.EOF {
break
}
return err
}
// We may store the error message in meta store, due to the performance concern, we only store the first 1024 bytes.
if len(allMsg) >= 1024 {
break
}
}
err = cmd.Wait()
if err != nil {
return errors.Wrapf(err, "error message: %s", allMsg)
}
return nil
}
// Restore restores a database.
func (driver *Driver) Restore(ctx context.Context, sc io.Reader) error {
buf := new(strings.Builder)
if _, err := io.Copy(buf, sc); err != nil {
return err
}
if _, err := driver.Execute(ctx, buf.String(), db.ExecuteOptions{}); err != nil {
return err
}
return nil
}