Class BaseConnectionPool

Hierarchy

BaseConnectionPool
- ConnectionPool
- CloudConnectionPool

Index

Constructors

Properties

Connection _agent _proxy _ssl auth connections emit size

Methods

addConnection empty getConnection markAlive markDead nodesToHost removeConnection update urlToHost

Constructors

constructor

new BaseConnectionPool(opts?: BaseConnectionPoolOptions): BaseConnectionPool
Parameters
- Optional opts: BaseConnectionPoolOptions
Returns BaseConnectionPool
- Defined in node_modules/@elastic/elasticsearch/lib/pool/index.d.ts:90

Properties

Connection

Connection: typeof Connection

_agent

_agent: AgentOptions

_proxy

_proxy: string | URL

_ssl

_ssl: SecureContextOptions

auth

auth: BasicAuth | ApiKeyAuth

connections

connections: Connection[]

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

size

size: number

Methods

addConnection

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

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

empty

empty(): BaseConnectionPool
Empties the connection pool.

Returns

Returns BaseConnectionPool
- 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
- Defined in node_modules/@elastic/elasticsearch/lib/pool/index.d.ts:117

markAlive

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

markDead

markDead(connection: Connection): BaseConnectionPool
Marks a connection as 'dead'. If needed adds the connection to the dead list and then increments the deadCount.
Parameters
- connection: Connection
Returns BaseConnectionPool
- 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[]
- Defined in node_modules/@elastic/elasticsearch/lib/pool/index.d.ts:151

removeConnection

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

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

update

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

Returns
Parameters
- connections: any[]
Returns BaseConnectionPool
- 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
- Defined in node_modules/@elastic/elasticsearch/lib/pool/index.d.ts:158

Generated using TypeDoc