Class AbstractElastic6Instance`Abstract`

class AbstractElastic6Instance

to manipulate the shared Elasticsearch resources.

Hierarchy

AbstractElastic6Instance
- Elastic6Instance

Index

Constructors

Properties

client? elastic? query? synchronizer?

Accessors

Methods

createIndex describeIndex destroyIndex generateSearchResult hello mget search

Constructors

constructor

new AbstractElastic6Instance(__namedParameters: Elastic6ContructParams): AbstractElastic6Instance
default constructor
Parameters
- __namedParameters: Elastic6ContructParams
Returns AbstractElastic6Instance
- Defined in src/extended/abstract-service.ts:891

Properties

`Optional` `Readonly` client

client?: Client

Elasticsearch client

`Optional` `Readonly` elastic

elastic?: Elastic6Service<any>

Elastic6Service instance

`Optional` `Readonly` query

query?: Elastic6QueryService<any>

Elastic6QueryService instance

`Optional` `Readonly` synchronizer

synchronizer?: Elastic6Synchronizer

Elastic6Synchronizer instance

Accessors

options

get options(): Elastic6Option
read the current elastic6-option.

Returns Elastic6Option
- Defined in src/extended/abstract-service.ts:921

Methods

createIndex

createIndex(): Promise<any>
create Elasticsearch index w/ custom settings

Returns Promise<any>
- Defined in src/extended/abstract-service.ts:929

describeIndex

describeIndex(): Promise<any>
display index settings and mappings

Returns Promise<any>
- Defined in src/extended/abstract-service.ts:966

destroyIndex

destroyIndex(): Promise<any>
destroy Elasticsearch index

Returns Promise<any>
- Defined in src/extended/abstract-service.ts:959

generateSearchResult

generateSearchResult<T>(body: any, searchType?: "query_then_fetch" | "dfs_query_then_fetch"): AsyncGenerator<T[], void, unknown>
create async generator that yields items queried until last
Type Parameters
- T
Parameters
- body: any
  
  Elasticsearch Query DSL
- Optional searchType: "query_then_fetch" | "dfs_query_then_fetch"
  
  see 'search_type' in Elasticsearch documentation
Returns AsyncGenerator<T[], void, unknown>
- Defined in src/extended/abstract-service.ts:1008

`Abstract` hello

hello(): string
say hello

Returns string
- Defined in src/extended/abstract-service.ts:916

mget

mget<T>(_ids: string[]): Promise<T[]>
multi get
Type Parameters
- T
Parameters
- _ids: string[]
  
  _id list
Returns Promise<T[]>
- Defined in src/extended/abstract-service.ts:974

search

search<T>(body: any, params?: Elastic6SearchParams): Promise<SearchResult<T, any>>
search raw query
Type Parameters
- T
Parameters
- body: any
  
  Elasticsearch Query DSL
- Optional params: Elastic6SearchParams
  
  see 'search_type' in Elasticsearch documentation
Returns Promise<SearchResult<T, any>>
- Defined in src/extended/abstract-service.ts:994

Generated using TypeDoc