elasticsearch-store / index-manager / IndexManager
Class: IndexManager
Defined in: elasticsearch-store/src/index-manager.ts:18
Manage Elasticsearch Indices
Constructors
new IndexManager()
new IndexManager(
client,enableIndexMutations):IndexManager
Defined in: elasticsearch-store/src/index-manager.ts:24
Parameters
| Parameter | Type | Default value |
|---|---|---|
client | Client | undefined |
enableIndexMutations | boolean | isTest |
Returns
Properties
| Property | Modifier | Type | Defined in |
|---|---|---|---|
client | readonly | Client | elasticsearch-store/src/index-manager.ts:19 |
clientMetadata | readonly | ClientMetadata | elasticsearch-store/src/index-manager.ts:20 |
enableIndexMutations | public | boolean | elasticsearch-store/src/index-manager.ts:22 |
Methods
exists()
exists(
index):Promise<boolean>
Defined in: elasticsearch-store/src/index-manager.ts:46
Verify the index exists
Parameters
| Parameter | Type |
|---|---|
index | string |
Returns
Promise<boolean>
formatIndexName()
formatIndexName<
T>(config,useWildcard):string
Defined in: elasticsearch-store/src/index-manager.ts:57
Format the current index name.
Type Parameters
| Type Parameter |
|---|
T extends Record<string, any> |
Parameters
| Parameter | Type | Default value | Description |
|---|---|---|---|
config | IndexConfig<T> | undefined | - |
useWildcard | boolean | true | if true a wildcard is added to the end of the end the index name |
Returns
string
formatTemplateName()
formatTemplateName<
T>(config):string
Defined in: elasticsearch-store/src/index-manager.ts:85
Format the template name, similar to formatIndexName except it excludes template wildcards and the time series parts of the index name.
Type Parameters
| Type Parameter |
|---|
T extends Record<string, any> |
Parameters
| Parameter | Type |
|---|---|
config | IndexConfig<T> |
Returns
string
getMapping()
getMapping(
index):Promise<IndicesGetMappingResponse>
Defined in: elasticsearch-store/src/index-manager.ts:290
Parameters
| Parameter | Type |
|---|---|
index | string |
Returns
Promise<IndicesGetMappingResponse>
getTemplate()
getTemplate(
name,flat_settings):Promise<IndicesGetTemplateResponse>
Defined in: elasticsearch-store/src/index-manager.ts:381
Parameters
| Parameter | Type |
|---|---|
name | string |
flat_settings | boolean |
Returns
Promise<IndicesGetTemplateResponse>
indexSetup()
indexSetup<
T>(config):Promise<boolean>
Defined in: elasticsearch-store/src/index-manager.ts:102
Safely setup a versioned Index, its template and any other required resources
Type Parameters
| Type Parameter |
|---|
T extends Record<string, any> |
Parameters
| Parameter | Type |
|---|---|
config | IndexConfig<T> |
Returns
Promise<boolean>
a boolean that indicates whether the index was created or not
isIndexActive()
isIndexActive(
index):Promise<boolean>
Defined in: elasticsearch-store/src/index-manager.ts:195
Parameters
| Parameter | Type |
|---|---|
index | string |
Returns
Promise<boolean>
migrateIndex()
migrateIndex<
T>(options):Promise<boolean|ReindexResponse>
Defined in: elasticsearch-store/src/index-manager.ts:215
Perform an Index Migration
IMPORTANT This is a potentially dangerous operation and should only when the cluster is properly shutdown.
Type Parameters
| Type Parameter |
|---|
T extends Record<string, any> |
Parameters
| Parameter | Type |
|---|---|
options | MigrateIndexOptions<T> |
Returns
Promise<boolean | ReindexResponse>
Todo
add support for timeseries and templated indexes
Todo
add support for complicated re-indexing behaviors
putMapping()
putMapping(
index,type,properties):Promise<IndicesPutMappingResponse>
Defined in: elasticsearch-store/src/index-manager.ts:296
Parameters
| Parameter | Type |
|---|---|
index | string |
type | string |
properties | Record<string, any> |
Returns
Promise<IndicesPutMappingResponse>
updateMapping()
updateMapping(
index,type,mapping,logger):Promise<void>
Defined in: elasticsearch-store/src/index-manager.ts:315
Safely update a mapping
WARNING: This only updates the mapping if it exists
Parameters
| Parameter | Type |
|---|---|
index | string |
type | string |
mapping | Record<string, any> |
logger | Logger |
Returns
Promise<void>
upsertTemplate()
upsertTemplate(
template,logger?):Promise<void>
Defined in: elasticsearch-store/src/index-manager.ts:395
Safely create or update a template
Parameters
| Parameter | Type |
|---|---|
template | ESMapping |
logger? | Logger |
Returns
Promise<void>
waitForIndexAvailability()
protectedwaitForIndexAvailability(index):Promise<void>
Defined in: elasticsearch-store/src/index-manager.ts:426
Parameters
| Parameter | Type |
|---|---|
index | string |
Returns
Promise<void>