Class Elastic6Instance

class ElasticInstance

to manipulate the shared Elasticsearch resources.

Hierarchy

Elastic6Instance

Index

Constructors

Properties

client? elastic? query? synchronizer?

Accessors

Methods

createIndex describeIndex destroyIndex generateSearchResult mget search

Constructors

constructor

new Elastic6Instance(__namedParameters: { autocompleteFields: string[]; endpoint: string; esDocType: string; esVersion: string; indexName: string; tableName: string }): Elastic6Instance
default constructor
Parameters
- __namedParameters: { autocompleteFields: string[]; endpoint: string; esDocType: string; esVersion: string; indexName: string; tableName: string }
  - autocompleteFields: string[]
    
    field to make auto-complele
  - endpoint: string
    
    url endpoint
  - esDocType: string
    
    doc-type (only valid under 6.2)
  - esVersion: string
    
    ES engine version(6.2 ~ 7.x)
  - indexName: string
    
    name of index
  - tableName: string
    
    dynamo-table to sync
Returns Elastic6Instance
- Defined in src/extended/abstract-service.ts:844

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:891

Methods

createIndex

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

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

describeIndex

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

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

destroyIndex

destroyIndex(): Promise<any>
destroy Elasticsearch index

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

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:984

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:944

search

search<T>(body: any, params?: { indexName?: string; searchType?: "query_then_fetch" | "dfs_query_then_fetch" }): Promise<SearchResult<T, any>>
search raw query
Type Parameters
- T
Parameters
- body: any
  
  Elasticsearch Query DSL
- Optional params: { indexName?: string; searchType?: "query_then_fetch" | "dfs_query_then_fetch" }
  
  see 'search_type' in Elasticsearch documentation
  - Optional indexName?: string
  - Optional searchType?: "query_then_fetch" | "dfs_query_then_fetch"
Returns Promise<SearchResult<T, any>>
- Defined in src/extended/abstract-service.ts:964

Generated using TypeDoc