Class Elastic6Service<T>

class: Elastic6Service

extends ElasticIndexService and adds version-specific implementation

Type Parameters

T extends ElasticItem = any

Hierarchy

ElasticIndexService
- Elastic6Service
  - DummyElastic6Service

Constructors

constructor

new Elastic6Service<T>(options: Elastic6Option): Elastic6Service<T>
default constuctor w/ options.
Type Parameters
- T extends ElasticItem = any
Parameters
- options: Elastic6Option
  
  { endpoint, indexName } is required.
Returns Elastic6Service<T>
Overrides ElasticIndexService.constructor
- Defined in src/cores/elastic/elastic6-service.ts:326

Properties

`Readonly` _client

_client: Client

`Protected` _options

_options: ElasticOption

`Static` `Readonly` DECOMPOSED_FIELD

DECOMPOSED_FIELD: "_decomposed" = '_decomposed'

`Static` `Readonly` QWERTY_FIELD

QWERTY_FIELD: "_qwerty" = '_qwerty'

Accessors

client

get client(): Client
get the client instance.

Returns Client
Inherited from ElasticIndexService.client
- Defined in src/cores/elastic/elastic6-service.ts:234

isLatestOS2

get isLatestOS2(): boolean
get isLatestOS2
- used when verifying results of search
Returns boolean
- Defined in src/cores/elastic/elastic6-service.ts:353

isOldES6

get isOldES6(): boolean
get isOldES6
- used when setting doctype
- used when verifying mismatched error and results of search
Returns boolean
- Defined in src/cores/elastic/elastic6-service.ts:339

isOldES71

get isOldES71(): boolean
get isOldES71
- used when verifying mismatched error
Returns boolean
- Defined in src/cores/elastic/elastic6-service.ts:346

options

get options(): ElasticOption
get the current options.

Returns ElasticOption
Inherited from ElasticIndexService.options
- Defined in src/cores/elastic/elastic6-service.ts:240

parsedVersion

get parsedVersion(): ParsedVersion
get the parsedVersion

Returns ParsedVersion
- Defined in src/cores/elastic/elastic6-service.ts:359

version

get version(): number
get the version from options

Returns number
Inherited from ElasticIndexService.version
- Defined in src/cores/elastic/elastic6-service.ts:246

Methods

createIndex

createIndex(settings?: any): Promise<{ acknowledged: any; index: string; status: any }>
create index by name
Parameters
- Optional settings: any
  
  creating settings
Returns Promise<{ acknowledged: any; index: string; status: any }>
- Defined in src/cores/elastic/elastic6-service.ts:545

deleteItem

deleteItem(id: string): Promise<T>
delete item with projections
Parameters
- id: string
  
  item-id
Returns Promise<T>
Overrides ElasticIndexService.deleteItem
- Defined in src/cores/elastic/elastic6-service.ts:832

describe

describe(): Promise<{ mappings: any; settings: any }>
describe settings and mappings of index.

Returns Promise<{ mappings: any; settings: any }>
- Defined in src/cores/elastic/elastic6-service.ts:662

destroyIndex

destroyIndex(): Promise<{ acknowledged: any; index: string; status: any }>
destroy search index

Returns Promise<{ acknowledged: any; index: string; status: any }>
- Defined in src/cores/elastic/elastic6-service.ts:585

`Protected` executeSelfTest

executeSelfTest(): Promise<{ isEqual: boolean; optionVersion: ParsedVersion; rootVersion: ParsedVersion }>
Protected
check whether the service version matches the version provided in the options.

only for internal test.

Returns Promise<{ isEqual: boolean; optionVersion: ParsedVersion; rootVersion: ParsedVersion }>
- Defined in src/cores/elastic/elastic6-service.ts:397

findIndex

findIndex(indexName?: string): Promise<{ docsCount: number; docsDeleted: number; health: string; index: string; pri: number; priStoreSize: string; rep: number; status: string; storeSize: string; uuid: string }>
find the index by name
Parameters
- Optional indexName: string
  
  name of the index
Returns Promise<{ docsCount: number; docsDeleted: number; health: string; index: string; pri: number; priStoreSize: string; rep: number; status: string; storeSize: string; uuid: string }>
- Defined in src/cores/elastic/elastic6-service.ts:533

flushIndex

flushIndex(): Promise<any>
flush search index - force store changes into search index immediately

Returns Promise<any>
- Defined in src/cores/elastic/elastic6-service.ts:638

generateSearchResult

generateSearchResult(body: SearchBody, params?: ElasticSearchAllParams): AsyncGenerator<any[], void, unknown>
create async generator that yields items queried until last
Parameters
- body: SearchBody
  
  Elasticsearch Query DSL that defines the search request (e.g., size, query, filters).
- Optional params: ElasticSearchAllParams
  
  parameters including search type, limit, and retry options.
Returns AsyncGenerator<any[], void, unknown>
- Defined in src/cores/elastic/elastic6-service.ts:1047

getIndexMapping

getIndexMapping(): Promise<any>
get mapping of an index

Returns Promise<any>
- Defined in src/cores/elastic/elastic6-service.ts:510

`Protected` getVersion

getVersion(options?: { dump?: boolean }): Promise<ParsedVersion>
Protected
get the root version from client

only for internal test.
Parameters
- Optional options: { dump?: boolean }
  - Optional dump?: boolean
Returns Promise<ParsedVersion>
- Defined in src/cores/elastic/elastic6-service.ts:367

hello

hello(): string
say hello of identity.

Returns string
Overrides ElasticIndexService.hello
- Defined in src/cores/elastic/elastic6-service.ts:333

listIndices

listIndices(): Promise<{ list: { docsCount: number; docsDeleted: number; health: string; index: string; pri: number; priStoreSize: string; rep: number; status: string; storeSize: string; uuid: string }[] }>
list of index

Returns Promise<{ list: { docsCount: number; docsDeleted: number; health: string; index: string; pri: number; priStoreSize: string; rep: number; status: string; storeSize: string; uuid: string }[] }>
- Defined in src/cores/elastic/elastic6-service.ts:478

parseVersion

parseVersion(version: string, options?: { throwable?: boolean }): ParsedVersion
parse version according to Semantic Versioning (SemVer) rules.

Returns
A ParsedVersion object or null if parsing fails and throwable is false.
Parameters
- version: string
  
  The version string to parse (e.g., "1.2.3", "1.2.3-alpha.1", "1.2.3+build.001").
- Optional options: { throwable?: boolean }
  
  Optional configuration for throwable behavior.
  - Optional throwable?: boolean
Returns ParsedVersion
- Defined in src/cores/elastic/elastic6-service.ts:425

`Private` popullateAutocompleteFields

popullateAutocompleteFields<T>(body: T): T
Private
generate autocomplete fields into the item body to be indexed
Type Parameters
- T = any
Parameters
- body: T
  
  item body to be saved into ES6 index
Returns T
- Defined in src/cores/elastic/elastic6-service.ts:1260

pushItem

pushItem(item: T, type?: string): Promise<T>
push item for time-series data.
Parameters
- item: T
  
  item to push
- Optional type: string
  
  document type (default: doc-type given at construction time)
Returns Promise<T>
Overrides ElasticIndexService.pushItem
- Defined in src/cores/elastic/elastic6-service.ts:751

readItem

readItem(id: string, views?: object | string[]): Promise<T>
read item with projections
Parameters
- id: string
  
  item-id
- Optional views: object | string[]
  
  projections
Returns Promise<T>
Overrides ElasticIndexService.readItem
- Defined in src/cores/elastic/elastic6-service.ts:788

refreshIndex

refreshIndex(): Promise<any>
refresh search index - refresh index to make all items searchable

Returns Promise<any>
- Defined in src/cores/elastic/elastic6-service.ts:614

`Private` saveInfoToFile

saveInfoToFile(info: any, filePath: string): Promise<void>
save info to a JSON file.
Parameters
- info: any
  
  The information to be saved
- filePath: string
  
  The file path where should be saved.
Returns Promise<void>
- Defined in src/cores/elastic/elastic6-service.ts:457

saveItem

saveItem(id: string, item: T, type?: string): Promise<T>
save single item
Parameters
- id: string
  
  id
- item: T
  
  item to save
- Optional type: string
  
  document type (default: doc-type given at construction time)
Returns Promise<T>
Overrides ElasticIndexService.saveItem
- Defined in src/cores/elastic/elastic6-service.ts:700

search

search(body: SearchBody, searchType?: SearchType): Promise<SearchResponse<any>>
run search, and get the formatmted response.
Parameters
- body: SearchBody
  
  Elasticsearch Query DSL that defines the search request (e.g., size, query, filters).
- Optional searchType: SearchType
  
  type of search (e.g., 'query_then_fetch', 'dfs_query_then_fetch').
Returns Promise<SearchResponse<any>>
Overrides ElasticIndexService.search
- Defined in src/cores/elastic/elastic6-service.ts:1010

searchAll

searchAll<T>(body: SearchBody, params?: ElasticSearchAllParams): Promise<T[]>
search all until limit (-1 means no-limit)
Type Parameters
- T
Parameters
- body: SearchBody
  
  Elasticsearch Query DSL that defines the search request (e.g., size, query, filters).
- Optional params: ElasticSearchAllParams
  
  parameters including search type, limit, and retry options.
Returns Promise<T[]>
- Defined in src/cores/elastic/elastic6-service.ts:1033

searchRaw

searchRaw<T>(body: SearchBody, searchType?: SearchType): Promise<T>
run search and get the raw response.
Type Parameters
- T extends object = any
Parameters
- body: SearchBody
  
  Elasticsearch Query DSL that defines the search request (e.g., size, query, filters).
- Optional searchType: SearchType
  
  type of search (e.g., 'query_then_fetch', 'dfs_query_then_fetch').
Returns Promise<T>
Overrides ElasticIndexService.searchRaw
- Defined in src/cores/elastic/elastic6-service.ts:970

updateItem

updateItem(id: string, item: T, increments?: Incrementable, options?: { maxRetries?: number }): Promise<T>
update item (throw if not exist) update table set a=1, b=b+2 where id='a1' 0. no of a1 -> 1,2 (created)
1. a,b := 10,20 -> 11,22
2. a,b := 10,null -> 11,2 (upsert)
3. a,b := null,20 -> 1,22
Parameters
- id: string
  
  item-id
- item: T
  
  item to update
- Optional increments: Incrementable
  
  item to increase
- Optional options: { maxRetries?: number }
  
  (optional) request option of client.
  - Optional maxRetries?: number
Returns Promise<T>
Overrides ElasticIndexService.updateItem
- Defined in src/cores/elastic/elastic6-service.ts:873

`Static` instance

instance(endpoint: string): { client: Client }
simple instance maker.
```
const { client } = ElasticIndexService.instance(endpoint);
```
See
https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/16.x/configuration.html
Parameters
- endpoint: string
  
  service-url
Returns { client: Client }
- client: Client
Inherited from ElasticIndexService.instance
- Defined in src/cores/elastic/elastic6-service.ts:205

`Static` prepareSettings

prepareSettings(params: { docType: string; idName: string; replicas?: number; shards?: number; timeSeries?: boolean; version?: string }): any
prepare default setting
- migrated from engine-v2.
Parameters
- params: { docType: string; idName: string; replicas?: number; shards?: number; timeSeries?: boolean; version?: string }
  - docType: string
  - idName: string
  - Optional replicas?: number
  - Optional shards?: number
  - Optional timeSeries?: boolean
  - Optional version?: string
Returns any
- Defined in src/cores/elastic/elastic6-service.ts:1090

Class Elastic6Service<T>

Type Parameters

T extends ElasticItem = any

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

T extends ElasticItem = any

Parameters

options: Elastic6Option

Returns Elastic6Service<T>

Properties

Readonly _client

Protected _options

Static Readonly DECOMPOSED_FIELD

Static Readonly QWERTY_FIELD

Accessors

client

Returns Client

isLatestOS2

Returns boolean

isOldES6

Returns boolean

isOldES71

Returns boolean

options

Returns ElasticOption

parsedVersion

Returns ParsedVersion

version

Returns number

Methods

createIndex

Parameters

Optional settings: any

Returns Promise<{ acknowledged: any; index: string; status: any }>

deleteItem

Parameters

id: string

Returns Promise<T>

describe

Returns Promise<{ mappings: any; settings: any }>

destroyIndex

Returns Promise<{ acknowledged: any; index: string; status: any }>

Protected executeSelfTest

Returns Promise<{ isEqual: boolean; optionVersion: ParsedVersion; rootVersion: ParsedVersion }>

findIndex

Parameters

Optional indexName: string

Returns Promise<{ docsCount: number; docsDeleted: number; health: string; index: string; pri: number; priStoreSize: string; rep: number; status: string; storeSize: string; uuid: string }>

flushIndex

Returns Promise<any>

generateSearchResult

Parameters

body: SearchBody

Optional params: ElasticSearchAllParams

Returns AsyncGenerator<any[], void, unknown>

getIndexMapping

Returns Promise<any>

Protected getVersion

Parameters

Optional options: { dump?: boolean }

Optional dump?: boolean

Returns Promise<ParsedVersion>

hello

Returns string

listIndices

Returns Promise<{ list: { docsCount: number; docsDeleted: number; health: string; index: string; pri: number; priStoreSize: string; rep: number; status: string; storeSize: string; uuid: string }[] }>

parseVersion

Returns

Parameters

version: string

Optional options: { throwable?: boolean }

Optional throwable?: boolean

Returns ParsedVersion

`Readonly` _client

`Protected` _options

`Static` `Readonly` DECOMPOSED_FIELD

`Static` `Readonly` QWERTY_FIELD

`Optional` settings: any

`Protected` executeSelfTest

`Optional` indexName: string

`Optional` params: ElasticSearchAllParams

`Protected` getVersion

`Optional` options: { dump?: boolean }

`Optional` dump?: boolean

`Optional` options: { throwable?: boolean }

`Optional` throwable?: boolean

`Private` popullateAutocompleteFields

`Optional` type: string

`Optional` views: object | string[]

`Private` saveInfoToFile

`Optional` type: string

`Optional` searchType: SearchType

`Optional` params: ElasticSearchAllParams

`Optional` searchType: SearchType

`Optional` increments: Incrementable

`Optional` options: { maxRetries?: number }

`Optional` maxRetries?: number

`Static` instance

`Static` prepareSettings

`Optional` replicas?: number

`Optional` shards?: number

`Optional` timeSeries?: boolean