Class ElasticSearchService<T>

Type parameters

T: ElasticSearchServiceParameters

Hierarchy

Service<T>
- ElasticSearchService

Constructors

Properties

_client

_createException

_initTime

_name

_webda

logger

defaultMaxListeners

Methods

__clean

_create

_delete

_update

_wait

addRoute

bulk

computeParameters

count

emit

emitSync

exists

getClient

getMaxListeners

getName

getWebda

init

listeners

log

off

on

onAsync

once

prependListener

prependOnceListener

reinit

removeAllListeners

resolve

search

setMaxListeners

wait

flatten

getModda

Constructors

new ElasticSearchService(webda: Core, name: string, params?: any): ElasticSearchService

Inherited from CloudWatchLogger.constructor

Parameters
- webda: Core
  
  The main instance of Webda
- name: string
  
  The name of the service
- Optional params: any
  
  The parameters block define in the configuration file
Returns ElasticSearchService
- Defined in packages/core/lib/services/service.d.ts:42

Properties

_asyncCount: number = 0

_client: elasticsearch.Client

_createException: string

_initException: any

_initTime: number

_name: string

Service name

_refreshMode: string = "false"

_webda: Core

Webda Core object

logger: Logger

Logger with class context

parameters: T

Hold the parameters for your service

It will be bring from the webda.config.json

defaultMaxListeners: number

Methods

__clean(): Promise<void>

Overrides CloudWatchLogger.__clean

Returns Promise<void>
- Defined in packages/elasticsearch/src/elasticsearchservice.ts:223

_create(index: string, object: CoreModel, uuid: string): Promise<void>

Parameters
- index: string
- object: CoreModel
- uuid: string
Returns Promise<void>
- Defined in packages/elasticsearch/src/elasticsearchservice.ts:65

_delete(index: string, object: CoreModel, uuid: string): Promise<void>

Parameters
- index: string
- object: CoreModel
- uuid: string
Returns Promise<void>
- Defined in packages/elasticsearch/src/elasticsearchservice.ts:51

_httpSearch(ctx: any): void

Parameters
- ctx: any
Returns void
- Defined in packages/elasticsearch/src/elasticsearchservice.ts:97

_update(index: string, object: CoreModel, uuid: string): Promise<void>

Parameters
- index: string
- object: CoreModel
- uuid: string
Returns Promise<void>
- Defined in packages/elasticsearch/src/elasticsearchservice.ts:80

_wait(): Promise<unknown>

Returns Promise<unknown>
- Defined in packages/elasticsearch/src/elasticsearchservice.ts:199

addListener(event: string | symbol, listener: function): this

Inherited from CloudWatchLogger.addListener

Overrides EventEmitter.addListener

Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
      Defined in node_modules/@types/node/events.d.ts:32
Returns this
- Defined in node_modules/@types/node/events.d.ts:32

addRoute(url: string, methods: HttpMethodType[], executer: Function, openapi?: object, allowPath?: boolean): void

Inherited from CloudWatchLogger.addRoute

Add a route dynamicaly

Parameters
- url: string
  
  of the route can contains dynamic part like {uuid}
- methods: HttpMethodType[]
- executer: Function
  
  Method to execute for this route
- Optional openapi: object
- Optional allowPath: boolean
Returns void
- Defined in packages/core/lib/services/service.d.ts:80

bulk(index: string, objects: any): Promise<object>

Parameters
- index: string
- objects: any
Returns Promise<object>
- Defined in packages/elasticsearch/src/elasticsearchservice.ts:131

computeParameters(): void

Inherited from CloudWatchLogger.computeParameters

Used to compute or derivate input parameter to attribute

Returns void
- Defined in packages/core/lib/services/service.d.ts:59

count(index?: string): Promise<any>

Parameters
- Default value index: string = undefined
Returns Promise<any>
- Defined in packages/elasticsearch/src/elasticsearchservice.ts:189

emit(event: string | symbol, ...args: any[]): boolean

Inherited from CloudWatchLogger.emit

Overrides EventEmitter.emit

Parameters
- event: string | symbol
- Rest ...args: any[]
Returns boolean
- Defined in node_modules/@types/node/events.d.ts:44

emitSync(event: any, data: any): Promise<any[]>

Inherited from CloudWatchLogger.emitSync

Emit the event with data and wait for Promise to finish if listener returned a Promise

Parameters
- event: any
- data: any
Returns Promise<any[]>
- Defined in packages/core/lib/services/service.d.ts:108

eventNames(): Array<string | symbol>

Inherited from CloudWatchLogger.eventNames

Overrides EventEmitter.eventNames

Returns Array<string | symbol>
- Defined in node_modules/@types/node/events.d.ts:45

exists(index: string, uuid: string): Promise<any>

Parameters
- index: string
- uuid: string
Returns Promise<any>
- Defined in packages/elasticsearch/src/elasticsearchservice.ts:178

getClient(): any

Returns any
- Defined in packages/elasticsearch/src/elasticsearchservice.ts:241

getMaxListeners(): number

Inherited from CloudWatchLogger.getMaxListeners

Overrides EventEmitter.getMaxListeners

Returns number
- Defined in node_modules/@types/node/events.d.ts:41

getName(): string

Inherited from CloudWatchLogger.getName

Get service name

Returns string
- Defined in packages/core/lib/services/service.d.ts:129

getParameters(): T

Inherited from CloudWatchLogger.getParameters

Get the service parameters

Returns T
- Defined in packages/core/lib/services/service.d.ts:63

getService<T>(service: string): T

Inherited from CloudWatchLogger.getService

Return a webda service

Type parameters
- T: Service<ServiceParameters>
Parameters
- service: string
  
  name to retrieve
Returns T
- Defined in packages/core/lib/services/service.d.ts:120

getWebda(): Core

Inherited from CloudWatchLogger.getWebda

Return WebdaCore

Returns Core
- Defined in packages/core/lib/services/service.d.ts:67

init(): Promise<void>

Inherited from AWSSecretsManager.init

Will be called after all the Services are created

abstract

Returns Promise<void>
- Defined in packages/core/lib/services/service.d.ts:99

initRoutes(): void

Inherited from CloudWatchLogger.initRoutes

Init the routes

Returns void
- Defined in packages/core/lib/services/service.d.ts:84

listenerCount(type: string | symbol): number

Inherited from CloudWatchLogger.listenerCount

Overrides EventEmitter.listenerCount

Parameters
- type: string | symbol
Returns number
- Defined in node_modules/@types/node/events.d.ts:46

listeners(event: string | symbol): Function[]

Inherited from CloudWatchLogger.listeners

Overrides EventEmitter.listeners

Parameters
- event: string | symbol
Returns Function[]
- Defined in node_modules/@types/node/events.d.ts:42

loadParameters(params: any): ServiceParameters

Inherited from Queue.loadParameters

Load the parameters for a service

Parameters
- params: any
Returns ServiceParameters
- Defined in packages/core/lib/services/service.d.ts:55

log(level: WorkerLogLevel, ...args: any[]): void

Inherited from CloudWatchLogger.log

Parameters
- level: WorkerLogLevel
  
  to log
- Rest ...args: any[]
Returns void
- Defined in packages/core/lib/services/service.d.ts:145

off(event: string | symbol, listener: function): this

Inherited from CloudWatchLogger.off

Overrides EventEmitter.off

Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
      Defined in node_modules/@types/node/events.d.ts:38
Returns this
- Defined in node_modules/@types/node/events.d.ts:38

on(event: string | symbol, listener: function): this

Inherited from CloudWatchLogger.on

Overrides EventEmitter.on

Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
      Defined in node_modules/@types/node/events.d.ts:33
Returns this
- Defined in node_modules/@types/node/events.d.ts:33

onAsync(event: any, callback: any, queue?: string): void

Inherited from CloudWatchLogger.onAsync

Listen to an event as on(...) would do except that it will be asynchronous

Parameters
- event: any
- callback: any
- Optional queue: string
  
  Name of queue to use, can be undefined, queue name are used to define differents priorities
Returns void
- Defined in packages/core/lib/services/service.d.ts:115

once(event: string | symbol, listener: function): this

Inherited from CloudWatchLogger.once

Overrides EventEmitter.once

Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
      Defined in node_modules/@types/node/events.d.ts:34
Returns this
- Defined in node_modules/@types/node/events.d.ts:34

prependListener(event: string | symbol, listener: function): this

Inherited from CloudWatchLogger.prependListener

Overrides EventEmitter.prependListener

Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
      Defined in node_modules/@types/node/events.d.ts:35
Returns this
- Defined in node_modules/@types/node/events.d.ts:35

prependOnceListener(event: string | symbol, listener: function): this

Inherited from CloudWatchLogger.prependOnceListener

Overrides EventEmitter.prependOnceListener

Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
      Defined in node_modules/@types/node/events.d.ts:36
Returns this
- Defined in node_modules/@types/node/events.d.ts:36

rawListeners(event: string | symbol): Function[]

Inherited from CloudWatchLogger.rawListeners

Overrides EventEmitter.rawListeners

Parameters
- event: string | symbol
Returns Function[]
- Defined in node_modules/@types/node/events.d.ts:43

reinit(config: any): Promise<void>

Inherited from CloudWatchLogger.reinit

Parameters
- config: any
  
  new parameters for the service
Returns Promise<void>
- Defined in packages/core/lib/services/service.d.ts:104

removeAllListeners(event?: string | symbol): this

Inherited from CloudWatchLogger.removeAllListeners

Overrides EventEmitter.removeAllListeners

Parameters
- Optional event: string | symbol
Returns this
- Defined in node_modules/@types/node/events.d.ts:39

removeListener(event: string | symbol, listener: function): this

Inherited from CloudWatchLogger.removeListener

Overrides EventEmitter.removeListener

Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
      Defined in node_modules/@types/node/events.d.ts:37
Returns this
- Defined in node_modules/@types/node/events.d.ts:37

resolve(): void

Overrides CloudWatchLogger.resolve

Returns void
- Defined in packages/elasticsearch/src/elasticsearchservice.ts:16

search(index: string, query: any, from?: number): Promise<any[]>

Parameters
- index: string
- query: any
- Default value from: number = 0
Returns Promise<any[]>
- Defined in packages/elasticsearch/src/elasticsearchservice.ts:99

setMaxListeners(n: number): this

Inherited from CloudWatchLogger.setMaxListeners

Overrides EventEmitter.setMaxListeners

Parameters
- n: number
Returns this
- Defined in node_modules/@types/node/events.d.ts:40

setRefreshMode(mode: string): void

Parameters
- mode: string
Returns void
- Defined in packages/elasticsearch/src/elasticsearchservice.ts:219

toPublicJSON(object: any): string

Inherited from CloudWatchLogger.toPublicJSON

Convert an object to JSON using the Webda json filter

Parameters
- object: any
  
  The object to export
Returns string

The export of the strip object ( removed all attribute with _ )
- Defined in packages/core/lib/services/service.d.ts:92

wait(timeout?: number): Promise<void>

Parameters
- Default value timeout: number = 10000
Returns Promise<void>
- Defined in packages/elasticsearch/src/elasticsearchservice.ts:207

flatten(array: any[]): any

Parameters
- array: any[]
Returns any
- Defined in packages/elasticsearch/src/elasticsearchservice.ts:124

getModda(): object

Overrides Queue.getModda

Returns object
- configuration: object
- description: string
- documentation: string
- label: string
- uuid: string
- Defined in packages/elasticsearch/src/elasticsearchservice.ts:245

getObjectSize(obj: any): number

Parameters
- obj: any
Returns number
- Defined in packages/elasticsearch/src/elasticsearchservice.ts:120

listenerCount(emitter: EventEmitter, event: string | symbol): number

Inherited from CloudWatchLogger.listenerCount

deprecated

since v4.0.0

Parameters
- emitter: EventEmitter
- event: string | symbol
Returns number
- Defined in node_modules/@types/node/events.d.ts:29

Generated using TypeDoc