Class ConnectionPool

Hierarchy

BaseConnectionPool
- ConnectionPool

Index

Constructors

constructor

new ConnectionPool(opts?: ConnectionPoolOptions): ConnectionPool
Parameters
- Optional opts: ConnectionPoolOptions
Returns ConnectionPool
Overrides BaseConnectionPool.constructor
- Defined in node_modules/@elastic/elasticsearch/lib/pool/index.d.ts:173

Properties

Connection

Connection: typeof Connection

_agent

_agent: AgentOptions

_proxy

_proxy: string | URL

_sniffEnabled

_sniffEnabled: boolean

_ssl

_ssl: SecureContextOptions

auth

auth: BasicAuth | ApiKeyAuth

connections

connections: Connection[]

dead

dead: string[]

emit

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

Type declaration

- (event: string | symbol, ...args: any[]): boolean
- Parameters
  - event: string | symbol
  - Rest ...args: any[]
  Returns boolean

pingTimeout

pingTimeout: number

resurrectStrategy

resurrectStrategy: number

resurrectTimeout

resurrectTimeout: number

resurrectTimeoutCutoff

resurrectTimeoutCutoff: number

size

size: number

`Static` resurrectStrategies

resurrectStrategies: { none: number; optimistic: number; ping: number }

Type declaration

none: number
optimistic: number
ping: number

Methods

addConnection

addConnection(opts: any): Connection
Adds a new connection to the pool.

Returns
Parameters
- opts: any
Returns Connection
Inherited from BaseConnectionPool.addConnection
- Defined in node_modules/@elastic/elasticsearch/lib/pool/index.d.ts:124

empty

empty(): ConnectionPool
Empties the connection pool.

Returns

Returns ConnectionPool
Inherited from BaseConnectionPool.empty
- Defined in node_modules/@elastic/elasticsearch/lib/pool/index.d.ts:137

getConnection

getConnection(opts?: getConnectionOptions): Connection
Returns an alive connection if present, otherwise returns a dead connection. By default it filters the master only nodes. It uses the selector to choose which connection return.

Returns
connection
Parameters
- Optional opts: getConnectionOptions
Returns Connection
Inherited from BaseConnectionPool.getConnection
- Defined in node_modules/@elastic/elasticsearch/lib/pool/index.d.ts:117

markAlive

markAlive(connection: Connection): ConnectionPool
Marks a connection as 'alive'. If needed removes the connection from the dead list and then resets the deadCount.
Parameters
- connection: Connection
Returns ConnectionPool
Inherited from BaseConnectionPool.markAlive
- Defined in node_modules/@elastic/elasticsearch/lib/pool/index.d.ts:98

markDead

markDead(connection: Connection): ConnectionPool
Marks a connection as 'dead'. If needed adds the connection to the dead list and then increments the deadCount.
Parameters
- connection: Connection
Returns ConnectionPool
Inherited from BaseConnectionPool.markDead
- Defined in node_modules/@elastic/elasticsearch/lib/pool/index.d.ts:106

nodesToHost

nodesToHost(nodes: any, protocol: string): any[]
Transforms the nodes objects to a host object.

Returns
hosts
Parameters
- nodes: any
- protocol: string
Returns any[]
Inherited from BaseConnectionPool.nodesToHost
- Defined in node_modules/@elastic/elasticsearch/lib/pool/index.d.ts:151

removeConnection

removeConnection(connection: Connection): ConnectionPool
Removes a new connection to the pool.

Returns
Parameters
- connection: Connection
Returns ConnectionPool
Inherited from BaseConnectionPool.removeConnection
- Defined in node_modules/@elastic/elasticsearch/lib/pool/index.d.ts:131

resurrect

resurrect(opts: resurrectOptions, callback?: ((isAlive: boolean, connection: Connection) => void)): void
If enabled, tries to resurrect a connection with the given resurrect strategy ('ping', 'optimistic', 'none').
Parameters
- opts: resurrectOptions
- Optional callback: ((isAlive: boolean, connection: Connection) => void)
  
  (isAlive, connection)
  - - (isAlive: boolean, connection: Connection): void
    - Parameters
      
      isAlive: boolean
      
      connection: Connection
      
      Returns void
Returns void
- Defined in node_modules/@elastic/elasticsearch/lib/pool/index.d.ts:182

update

update(connections: any[]): ConnectionPool
Update the ConnectionPool with new connections.

Returns
Parameters
- connections: any[]
Returns ConnectionPool
Inherited from BaseConnectionPool.update
- Defined in node_modules/@elastic/elasticsearch/lib/pool/index.d.ts:144

urlToHost

urlToHost(url: string): { url: URL }
Transforms an url string to a host object

Returns
host
Parameters
- url: string
Returns { url: URL }
- url: URL
Inherited from BaseConnectionPool.urlToHost
- Defined in node_modules/@elastic/elasticsearch/lib/pool/index.d.ts:158

Generated using TypeDoc