-
Notifications
You must be signed in to change notification settings - Fork 871
/
opensearch_archiver.ts
191 lines (178 loc) · 5.02 KB
/
opensearch_archiver.ts
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
/*
* SPDX-License-Identifier: Apache-2.0
*
* The OpenSearch Contributors require contributions made to
* this file be licensed under the Apache-2.0 license or a
* compatible open source license.
*/
/*
* Licensed to Elasticsearch B.V. under one or more contributor
* license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright
* ownership. Elasticsearch B.V. licenses this file to you under
* the Apache License, Version 2.0 (the "License"); you may
* not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
/*
* Modifications Copyright OpenSearch Contributors. See
* GitHub history for details.
*/
import { Client } from 'elasticsearch';
import { ToolingLog, OsdClient } from '@osd/dev-utils';
import {
saveAction,
loadAction,
unloadAction,
rebuildAllAction,
emptyOpenSearchDashboardsIndexAction,
editAction,
} from './actions';
export class OpenSearchArchiver {
private readonly client: Client;
private readonly dataDir: string;
private readonly log: ToolingLog;
private readonly osdClient: OsdClient;
constructor({
client,
dataDir,
log,
opensearchDashboardsUrl,
}: {
client: Client;
dataDir: string;
log: ToolingLog;
opensearchDashboardsUrl: string;
}) {
this.client = client;
this.dataDir = dataDir;
this.log = log;
this.osdClient = new OsdClient({ log, url: opensearchDashboardsUrl });
}
/**
* Extract data and mappings from an opensearch index and store
* it in the dataDir so it can be used later to recreate the index.
*
* @param {String} name - the name of this archive, used to determine filename
* @param {String|Array<String>} indices - the indices to archive
* @param {Object} options
* @property {Boolean} options.raw - should the archive be raw (unzipped) or not
* @return Promise<Stats>
*/
async save(
name: string,
indices: string | string[],
{ raw = false, query }: { raw?: boolean; query?: Record<string, any> } = {}
) {
return await saveAction({
name,
indices,
raw,
client: this.client,
dataDir: this.dataDir,
log: this.log,
query,
});
}
/**
* Load an index from an archive
*
* @param {String} name - the name of the archive to load
* @param {Object} options
* @property {Boolean} options.skipExisting - should existing indices
* be ignored or overwritten
* @property {Boolean} options.useCreate - use a create operation instead of index for documents
* @return Promise<Stats>
*/
async load(
name: string,
{
skipExisting = false,
useCreate = false,
}: { skipExisting?: boolean; useCreate?: boolean } = {}
) {
return await loadAction({
name,
skipExisting: !!skipExisting,
useCreate: !!useCreate,
client: this.client,
dataDir: this.dataDir,
log: this.log,
osdClient: this.osdClient,
});
}
/**
* Remove the indexes in opensearch that have data in an archive.
*
* @param {String} name
* @return Promise<Stats>
*/
async unload(name: string) {
return await unloadAction({
name,
client: this.client,
dataDir: this.dataDir,
log: this.log,
osdClient: this.osdClient,
});
}
/**
* Parse and reformat all of the archives. This is primarily helpful
* for working on the opensearchArchiver.
*
* @return Promise<Stats>
*/
async rebuildAll() {
return await rebuildAllAction({
dataDir: this.dataDir,
log: this.log,
});
}
/**
* Extract the gzipped files in an archive, then call the handler. When it
* resolves re-archive the gzipped files.
*
* @param {String} prefix optional prefix to limit archives that are extracted
* @param {() => Promise<any>} handler
* @return Promise<void>
*/
async edit(prefix: string, handler: () => Promise<void>) {
return await editAction({
prefix,
log: this.log,
dataDir: this.dataDir,
handler,
});
}
/**
* Just like load, but skips any existing index
*
* @param {String} name
* @return Promise<Stats>
*/
async loadIfNeeded(name: string) {
return await this.load(name, { skipExisting: true });
}
/**
* Delete any OpenSearchDashboards indices, and initialize the OpenSearchDashboards index as OpenSearchDashboards would do
* on startup.
*
* @return Promise
*/
async emptyOpenSearchDashboardsIndex() {
await emptyOpenSearchDashboardsIndexAction({
client: this.client,
log: this.log,
osdClient: this.osdClient,
});
}
}