forked from influxdata/influxdb
-
Notifications
You must be signed in to change notification settings - Fork 0
/
backup.go
152 lines (125 loc) · 5.16 KB
/
backup.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
package influxdb
import (
"context"
"io"
"time"
"github.com/influxdata/influxdb/v2/kit/platform"
)
const (
BackupFilenamePattern = "20060102T150405Z"
)
// BackupService represents the data backup functions of InfluxDB.
type BackupService interface {
// BackupKVStore creates a live backup copy of the metadata database.
BackupKVStore(ctx context.Context, w io.Writer) error
// BackupShard downloads a backup file for a single shard.
BackupShard(ctx context.Context, w io.Writer, shardID uint64, since time.Time) error
// LockKVStore locks the database.
LockKVStore()
// UnlockKVStore unlocks the database.
UnlockKVStore()
}
// SqlBackupRestoreService represents the backup and restore functions for the sqlite database.
type SqlBackupRestoreService interface {
// BackupSqlStore creates a live backup copy of the sqlite database.
BackupSqlStore(ctx context.Context, w io.Writer) error
// RestoreSqlStore restores & replaces the sqlite database.
RestoreSqlStore(ctx context.Context, r io.Reader) error
// LockSqlStore locks the database.
LockSqlStore()
// UnlockSqlStore unlocks the database.
UnlockSqlStore()
}
type BucketManifestWriter interface {
WriteManifest(ctx context.Context, w io.Writer) error
}
// RestoreService represents the data restore functions of InfluxDB.
type RestoreService interface {
// RestoreKVStore restores & replaces metadata database.
RestoreKVStore(ctx context.Context, r io.Reader) error
// RestoreBucket restores storage metadata for a bucket.
// TODO(danmoran): As far as I can tell, dbInfo is typed as a []byte because typing it as
// a meta.DatabaseInfo introduces a circular dependency between the root package and `meta`.
// We should refactor to make this signature easier to use. It might be easier to wait
// until we're ready to delete the 2.0.x restore APIs before refactoring.
RestoreBucket(ctx context.Context, id platform.ID, dbInfo []byte) (shardIDMap map[uint64]uint64, err error)
// RestoreShard uploads a backup file for a single shard.
RestoreShard(ctx context.Context, shardID uint64, r io.Reader) error
}
// BucketMetadataManifest contains the information about a bucket for backup purposes.
// It is composed of various nested structs below.
type BucketMetadataManifest struct {
OrganizationID platform.ID `json:"organizationID"`
OrganizationName string `json:"organizationName"`
BucketID platform.ID `json:"bucketID"`
BucketName string `json:"bucketName"`
Description *string `json:"description,omitempty"`
DefaultRetentionPolicy string `json:"defaultRetentionPolicy"`
RetentionPolicies []RetentionPolicyManifest `json:"retentionPolicies"`
}
type RetentionPolicyManifest struct {
Name string `json:"name"`
ReplicaN int `json:"replicaN"`
Duration time.Duration `json:"duration"`
ShardGroupDuration time.Duration `json:"shardGroupDuration"`
ShardGroups []ShardGroupManifest `json:"shardGroups"`
Subscriptions []SubscriptionManifest `json:"subscriptions"`
}
type ShardGroupManifest struct {
ID uint64 `json:"id"`
StartTime time.Time `json:"startTime"`
EndTime time.Time `json:"endTime"`
DeletedAt *time.Time `json:"deletedAt,omitempty"` // use pointer to time.Time so that omitempty works
TruncatedAt *time.Time `json:"truncatedAt,omitempty"` // use pointer to time.Time so that omitempty works
Shards []ShardManifest `json:"shards"`
}
type ShardManifest struct {
ID uint64 `json:"id"`
ShardOwners []ShardOwner `json:"shardOwners"`
}
type ShardOwner struct {
NodeID uint64 `json:"nodeID"`
}
type SubscriptionManifest struct {
Name string `json:"name"`
Mode string `json:"mode"`
Destinations []string `json:"destinations"`
}
// Manifest lists the KV and shard file information contained in the backup.
type Manifest struct {
KV ManifestKVEntry `json:"kv"`
Files []ManifestEntry `json:"files"`
}
// ManifestEntry contains the data information for a backed up shard.
type ManifestEntry struct {
OrganizationID string `json:"organizationID"`
OrganizationName string `json:"organizationName"`
BucketID string `json:"bucketID"`
BucketName string `json:"bucketName"`
ShardID uint64 `json:"shardID"`
FileName string `json:"fileName"`
Size int64 `json:"size"`
LastModified time.Time `json:"lastModified"`
}
// ManifestKVEntry contains the KV store information for a backup.
type ManifestKVEntry struct {
FileName string `json:"fileName"`
Size int64 `json:"size"`
}
type RestoredBucketMappings struct {
ID platform.ID `json:"id"`
Name string `json:"name"`
ShardMappings []RestoredShardMapping `json:"shardMappings"`
}
type RestoredShardMapping struct {
OldId uint64 `json:"oldId"`
NewId uint64 `json:"newId"`
}
// Size returns the size of the manifest.
func (m *Manifest) Size() int64 {
n := m.KV.Size
for _, f := range m.Files {
n += f.Size
}
return n
}