forked from water32/gpbackup
-
Notifications
You must be signed in to change notification settings - Fork 0
/
validate.go
317 lines (288 loc) · 12.5 KB
/
validate.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
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
package restore
import (
"fmt"
"strconv"
"strings"
"github.com/greenplum-db/gp-common-go-libs/dbconn"
"github.com/greenplum-db/gp-common-go-libs/gplog"
"github.com/greenplum-db/gpbackup/options"
"github.com/greenplum-db/gpbackup/toc"
"github.com/greenplum-db/gpbackup/utils"
"github.com/pkg/errors"
"github.com/spf13/pflag"
)
/*
* This file contains functions related to validating user input.
*/
func validateFilterListsInBackupSet() {
ValidateIncludeSchemasInBackupSet(opts.IncludedSchemas)
ValidateExcludeSchemasInBackupSet(opts.ExcludedSchemas)
ValidateIncludeRelationsInBackupSet(opts.IncludedRelations)
ValidateExcludeRelationsInBackupSet(opts.ExcludedRelations)
}
func ValidateIncludeSchemasInBackupSet(schemaList []string) {
if keys := getFilterSchemasInBackupSet(schemaList); len(keys) != 0 {
gplog.Fatal(errors.Errorf("Could not find the following schema(s) in the backup set: %s", strings.Join(keys, ", ")), "")
}
}
func ValidateExcludeSchemasInBackupSet(schemaList []string) {
if keys := getFilterSchemasInBackupSet(schemaList); len(keys) != 0 {
gplog.Warn("Could not find the following excluded schema(s) in the backup set: %s", strings.Join(keys, ", "))
}
}
/* This only checks the globalTOC, but will still succesfully validate tables
* in incremental backups since incremental backups will always take backups of
* the metadata (--incremental and --data-only backup flags are not compatible)
*/
func getFilterSchemasInBackupSet(schemaList []string) []string {
if len(schemaList) == 0 {
return []string{}
}
schemaMap := make(map[string]bool, len(schemaList))
for _, schema := range schemaList {
schemaMap[schema] = true
}
if !backupConfig.DataOnly {
for _, entry := range globalTOC.PredataEntries {
if _, ok := schemaMap[entry.Schema]; ok {
delete(schemaMap, entry.Schema)
}
if len(schemaMap) == 0 {
return []string{}
}
}
} else {
for _, entry := range globalTOC.DataEntries {
if _, ok := schemaMap[entry.Schema]; ok {
delete(schemaMap, entry.Schema)
}
if len(schemaMap) == 0 {
return []string{}
}
}
}
keys := make([]string, len(schemaMap))
i := 0
for k := range schemaMap {
keys[i] = k
i++
}
return keys
}
func GenerateRestoreRelationList(opts options.Options) []string {
includeRelations := opts.IncludedRelations
if len(includeRelations) > 0 {
return includeRelations
}
relationList := make([]string, 0)
includedSchemaSet := utils.NewIncludeSet(opts.IncludedSchemas)
excludedSchemaSet := utils.NewExcludeSet(opts.ExcludedSchemas)
excludedRelationsSet := utils.NewExcludeSet(opts.ExcludedRelations)
if len(globalTOC.DataEntries) == 0 {
return []string{}
}
for _, entry := range globalTOC.DataEntries {
fqn := utils.MakeFQN(entry.Schema, entry.Name)
if includedSchemaSet.MatchesFilter(entry.Schema) &&
excludedSchemaSet.MatchesFilter(entry.Schema) &&
excludedRelationsSet.MatchesFilter(fqn) {
relationList = append(relationList, fqn)
}
}
return relationList
}
func ValidateRelationsInRestoreDatabase(connectionPool *dbconn.DBConn, relationList []string) {
if len(relationList) == 0 {
return
}
quotedTablesStr := utils.SliceToQuotedString(relationList)
query := fmt.Sprintf(`
SELECT
quote_ident(n.nspname) || '.' || quote_ident(c.relname) AS string
FROM pg_namespace n
JOIN pg_class c ON n.oid = c.relnamespace
WHERE quote_ident(n.nspname) || '.' || quote_ident(c.relname) IN (%s)`, quotedTablesStr)
relationsInDB := dbconn.MustSelectStringSlice(connectionPool, query)
/*
* For data-only we check that the relations we are planning to restore
* are already defined in the database so we have somewhere to put the data.
*
* For non-data-only we check that the relations we are planning to restore
* are not already in the database so we don't get duplicate data.
*/
var errMsg string
if backupConfig.DataOnly || MustGetFlagBool(options.DATA_ONLY) {
if len(relationsInDB) < len(relationList) {
dbRelationsSet := utils.NewSet(relationsInDB)
for _, restoreRelation := range relationList {
matches := dbRelationsSet.MatchesFilter(restoreRelation)
if !matches {
errMsg = fmt.Sprintf("Relation %s must exist for data-only restore", restoreRelation)
}
}
}
} else if len(relationsInDB) > 0 {
errMsg = fmt.Sprintf("Relation %s already exists", relationsInDB[0])
}
if errMsg != "" {
gplog.Fatal(nil, errMsg)
}
}
func ValidateRedirectSchema(connectionPool *dbconn.DBConn, redirectSchema string) {
query := fmt.Sprintf(`SELECT quote_ident(nspname) AS name FROM pg_namespace n WHERE n.nspname = '%s'`, redirectSchema)
schemaInDB := dbconn.MustSelectStringSlice(connectionPool, query)
if len(schemaInDB) == 0 {
gplog.Fatal(nil, fmt.Sprintf("Schema %s to redirect into does not exist", redirectSchema))
}
}
func ValidateIncludeRelationsInBackupSet(schemaList []string) {
if keys := getFilterRelationsInBackupSet(schemaList); len(keys) != 0 {
gplog.Fatal(errors.Errorf("Could not find the following relation(s) in the backup set: %s", strings.Join(keys, ", ")), "")
}
}
func ValidateExcludeRelationsInBackupSet(schemaList []string) {
if keys := getFilterRelationsInBackupSet(schemaList); len(keys) != 0 {
gplog.Warn("Could not find the following excluded relation(s) in the backup set: %s", strings.Join(keys, ", "))
}
}
func getFilterRelationsInBackupSet(relationList []string) []string {
if len(relationList) == 0 {
return []string{}
}
relationMap := make(map[string]bool, len(relationList))
for _, relation := range relationList {
relationMap[relation] = true
}
for _, entry := range globalTOC.PredataEntries {
if entry.ObjectType != toc.OBJ_TABLE && entry.ObjectType != toc.OBJ_SEQUENCE && entry.ObjectType != toc.OBJ_VIEW && entry.ObjectType != toc.OBJ_MATERIALIZED_VIEW {
continue
}
fqn := utils.MakeFQN(entry.Schema, entry.Name)
if _, ok := relationMap[fqn]; ok {
delete(relationMap, fqn)
}
if len(relationMap) == 0 {
return []string{}
}
}
dataEntries := make([]string, 0)
for _, restorePlanEntry := range backupConfig.RestorePlan {
dataEntries = append(dataEntries, restorePlanEntry.TableFQNs...)
}
for _, fqn := range dataEntries {
if _, ok := relationMap[fqn]; ok {
delete(relationMap, fqn)
}
if len(relationMap) == 0 {
return []string{}
}
}
keys := make([]string, len(relationMap))
i := 0
for k := range relationMap {
keys[i] = k
i++
}
return keys
}
func ValidateDatabaseExistence(unquotedDBName string, createDatabase bool, isFiltered bool) {
qry := fmt.Sprintf(`
SELECT CASE
WHEN EXISTS (SELECT 1 FROM pg_database WHERE datname='%s') THEN 'true'
ELSE 'false'
END AS string;`, utils.EscapeSingleQuotes(unquotedDBName))
databaseExists, err := strconv.ParseBool(dbconn.MustSelectString(connectionPool, qry))
gplog.FatalOnError(err)
if !databaseExists {
if isFiltered {
gplog.Fatal(errors.Errorf(`Database "%s" must be created manually to restore table-filtered or data-only backups.`, unquotedDBName), "")
} else if !createDatabase {
gplog.Fatal(errors.Errorf(`Database "%s" does not exist. Use the --create-db flag to create "%s" as part of the restore process.`, unquotedDBName, unquotedDBName), "")
}
} else if createDatabase {
gplog.Fatal(errors.Errorf(`Database "%s" already exists. Run gprestore again without --create-db flag.`, unquotedDBName), "")
}
}
func ValidateBackupFlagCombinations() {
if backupConfig.SingleDataFile && MustGetFlagInt(options.JOBS) != 1 {
gplog.Fatal(errors.Errorf("Cannot use jobs flag when restoring backups with a single data file per segment."), "")
}
if (backupConfig.IncludeTableFiltered || backupConfig.DataOnly) && MustGetFlagBool(options.WITH_GLOBALS) {
gplog.Fatal(errors.Errorf("Global metadata is not backed up in table-filtered or data-only backups."), "")
}
if backupConfig.MetadataOnly && MustGetFlagBool(options.DATA_ONLY) {
gplog.Fatal(errors.Errorf("Cannot use data-only flag when restoring metadata-only backup"), "")
}
if backupConfig.DataOnly && MustGetFlagBool(options.METADATA_ONLY) {
gplog.Fatal(errors.Errorf("Cannot use metadata-only flag when restoring data-only backup"), "")
}
if !backupConfig.SingleDataFile && FlagChanged(options.COPY_QUEUE_SIZE) {
gplog.Fatal(errors.Errorf("The --copy-queue-size flag can only be used if the backup was taken with --single-data-file"), "")
}
validateBackupFlagPluginCombinations()
}
func validateBackupFlagPluginCombinations() {
if backupConfig.Plugin != "" && MustGetFlagString(options.PLUGIN_CONFIG) == "" {
gplog.Fatal(errors.Errorf("Backup was taken with plugin %s. The --plugin-config flag must be used to restore.", backupConfig.Plugin), "")
} else if backupConfig.Plugin == "" && MustGetFlagString(options.PLUGIN_CONFIG) != "" {
gplog.Fatal(errors.Errorf("The --plugin-config flag cannot be used to restore a backup taken without a plugin."), "")
}
}
func ValidateFlagCombinations(flags *pflag.FlagSet) {
options.CheckExclusiveFlags(flags, options.DATA_ONLY, options.WITH_GLOBALS)
options.CheckExclusiveFlags(flags, options.DATA_ONLY, options.CREATE_DB)
options.CheckExclusiveFlags(flags, options.DEBUG, options.QUIET, options.VERBOSE)
options.CheckExclusiveFlags(flags, options.INCLUDE_SCHEMA, options.INCLUDE_RELATION, options.INCLUDE_RELATION_FILE)
options.CheckExclusiveFlags(flags, options.EXCLUDE_SCHEMA, options.INCLUDE_SCHEMA)
options.CheckExclusiveFlags(flags, options.EXCLUDE_SCHEMA, options.EXCLUDE_RELATION, options.INCLUDE_RELATION, options.EXCLUDE_RELATION_FILE, options.INCLUDE_RELATION_FILE)
options.CheckExclusiveFlags(flags, options.METADATA_ONLY, options.DATA_ONLY)
options.CheckExclusiveFlags(flags, options.PLUGIN_CONFIG, options.BACKUP_DIR)
options.CheckExclusiveFlags(flags, options.TRUNCATE_TABLE, options.METADATA_ONLY, options.INCREMENTAL)
options.CheckExclusiveFlags(flags, options.TRUNCATE_TABLE, options.REDIRECT_SCHEMA)
if flags.Changed(options.REDIRECT_SCHEMA) {
// Redirect schema not compatible with any exclude flags
if flags.Changed(options.EXCLUDE_SCHEMA) || flags.Changed(options.EXCLUDE_SCHEMA_FILE) ||
flags.Changed(options.EXCLUDE_RELATION) || flags.Changed(options.EXCLUDE_RELATION_FILE) {
gplog.Fatal(errors.Errorf("Cannot use --redirect-schema with exclude flags"), "")
}
// Redirect schema requires an include flag
if !(flags.Changed(options.INCLUDE_RELATION) || flags.Changed(options.INCLUDE_RELATION_FILE) ||
flags.Changed(options.INCLUDE_SCHEMA) || flags.Changed(options.INCLUDE_SCHEMA_FILE)) {
gplog.Fatal(errors.Errorf("Cannot use --redirect-schema without --include-table, --include-table-file, --include-schema, or --include-schema-file"), "")
}
}
if flags.Changed(options.TRUNCATE_TABLE) &&
!(flags.Changed(options.INCLUDE_RELATION) || flags.Changed(options.INCLUDE_RELATION_FILE)) &&
!flags.Changed(options.DATA_ONLY) {
gplog.Fatal(errors.Errorf("Cannot use --truncate-table without --include-table or --include-table-file and without --data-only"), "")
}
if flags.Changed(options.INCREMENTAL) && !flags.Changed(options.DATA_ONLY) {
gplog.Fatal(errors.Errorf("Cannot use --incremental without --data-only"), "")
}
if !flags.Changed(options.TIMESTAMP) && !flags.Changed(options.BACKUP_DIR) {
gplog.Fatal(errors.Errorf("Must provide --backup-dir if --timestamp is not provided"), "")
}
options.CheckExclusiveFlags(flags, options.RUN_ANALYZE, options.WITH_STATS)
}
func ValidateSafeToResizeCluster() {
// If SegmentCount is 0, the backup was taken before the SegmentCount parameter was added, in which case we won't
// allow a restore to a different-size cluster. Any backups that do have a SegmentCount will have that checked
// when attempting a normal restore, so that the user doesn't accidentally restore a different-size backup without
// using the --resize-cluster flag.
origSize, destSize, resizeCluster, _ := GetResizeClusterInfo()
if resizeCluster {
if origSize == 0 {
timestamp := MustGetFlagString(options.TIMESTAMP)
gplog.Fatal(errors.Errorf("Segment count for backup with timestamp %s is unknown, cannot restore using --resize-cluster flag.", timestamp), "")
} else if origSize == destSize {
cmdFlags.Set(options.RESIZE_CLUSTER, "false")
gplog.Warn("Backup segment count matches restore segment count; the --resize-cluster flag is not needed. Proceeding with a normal restore.")
} else {
gplog.Info("Resize restore specified, will restore a backup set from a %d-segment cluster to a %d-segment cluster", origSize, destSize)
}
} else {
if origSize != 0 && origSize != destSize {
gplog.Fatal(errors.New(fmt.Sprintf("Cannot restore a backup taken on a cluster with %d segments to a cluster with %d segments unless the --resize-cluster flag is used.", origSize, destSize)), "")
}
}
}