Class ElasticIndexService<T>`Abstract`

abstarct class: ElasticIndexService

abstract class for basic Elasticsearch CRUD operations
common operations that are shared across different versions. TODO - support Elastic and OpenSearch

Type Parameters

T extends ElasticItem = any

Hierarchy

ElasticIndexService
- Elastic6Service

Index

Constructors

Properties

_client _options

Accessors

client options version

Methods

deleteItem hello pushItem readItem saveItem search searchRaw updateItem instance

Constructors

constructor

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

Properties

`Readonly` _client

_client: Client

`Protected` _options

_options: ElasticOption

Accessors

client

get client(): Client
get the client instance.

Returns Client
- Defined in src/cores/elastic/elastic6-service.ts:234

options

get options(): ElasticOption
get the current options.

Returns ElasticOption
- Defined in src/cores/elastic/elastic6-service.ts:240

version

get version(): number
get the version from options

Returns number
- Defined in src/cores/elastic/elastic6-service.ts:246

Methods

`Abstract` deleteItem

deleteItem(id: string): Promise<T>
delete an item by id
Parameters
- id: string
  
  item id
Returns Promise<T>
- Defined in src/cores/elastic/elastic6-service.ts:280

`Abstract` hello

hello(): string
say hello

Returns string
- Defined in src/cores/elastic/elastic6-service.ts:253

`Abstract` 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
Returns Promise<T>
- Defined in src/cores/elastic/elastic6-service.ts:267

`Abstract` 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>
- Defined in src/cores/elastic/elastic6-service.ts:274

`Abstract` saveItem

saveItem(id: string, item: T, type?: string): Promise<T>
save an item
Parameters
- id: string
  
  item id
- item: T
  
  item to save
- Optional type: string
  
  document type
Returns Promise<T>
- Defined in src/cores/elastic/elastic6-service.ts:260

`Abstract` search

search(body: any, searchType?: string): Promise<any>
search and return formatted response
Parameters
- body: any
  
  search query
- Optional searchType: string
  
  type of search
Returns Promise<any>
- Defined in src/cores/elastic/elastic6-service.ts:306

`Abstract` searchRaw

searchRaw<T>(body: any, searchType?: string): Promise<T>
search raw results using a query body
Type Parameters
- T extends object = any
Parameters
- body: any
  
  search query
- Optional searchType: string
  
  type of search
Returns Promise<T>
- Defined in src/cores/elastic/elastic6-service.ts:299

`Abstract` updateItem

updateItem(id: string, item: T, increments?: any, options?: { maxRetries?: number }): Promise<T>
update an item
Parameters
- id: string
  
  item id
- item: T
  
  item to update
- Optional increments: any
  
  fields to increment
- Optional options: { maxRetries?: number }
  - Optional maxRetries?: number
Returns Promise<T>
- Defined in src/cores/elastic/elastic6-service.ts:287

`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
- Defined in src/cores/elastic/elastic6-service.ts:205

Generated using TypeDoc