Class: PooledDbAdapter

Defined in: src/pool/PooledDbAdapter.ts:12

Adapter decorator that manages connection pooling, acquisition bounds, and background health heartbeat checks over any underlying IDbAdapter.

Implements

• IDbAdapter

Accessors

connectionPool

Get Signature

get connectionPool(): IConnectionPool

Defined in: src/pool/PooledDbAdapter.ts:30

Returns

IConnectionPool

Implementation of

IDbAdapter.connectionPool

---

provider

Get Signature

get provider(): DbProvider

Defined in: src/pool/PooledDbAdapter.ts:34

Returns

DbProvider

Implementation of

IDbAdapter.provider

---

innerAdapter

Get Signature

get innerAdapter(): IDbAdapter

Defined in: src/pool/PooledDbAdapter.ts:38

Returns

IDbAdapter

Constructors

Constructor

new PooledDbAdapter(inner, poolOrOptions?): PooledDbAdapter

Defined in: src/pool/PooledDbAdapter.ts:15

Parameters

Parameter	Type
inner	IDbAdapter
poolOrOptions?	ConnectionPoolOptions | IConnectionPool

Returns

PooledDbAdapter

Methods

connect()

connect(): Promise<void>

Defined in: src/pool/PooledDbAdapter.ts:42

Returns

Promise<void>

Implementation of

IDbAdapter.connect

---

disconnect()

disconnect(): Promise<void>

Defined in: src/pool/PooledDbAdapter.ts:47

Returns

Promise<void>

Implementation of

IDbAdapter.disconnect

---

ping()

ping(): Promise<boolean>

Defined in: src/pool/PooledDbAdapter.ts:52

Returns

Promise<boolean>

Implementation of

IDbAdapter.ping

---

escapeIdentifier()

escapeIdentifier(name): string

Defined in: src/pool/PooledDbAdapter.ts:56

Parameters

Parameter	Type
name	string

Returns

string

Implementation of

IDbAdapter.escapeIdentifier

---

formatParameterPlaceholder()

formatParameterPlaceholder(paramName, index): string

Defined in: src/pool/PooledDbAdapter.ts:60

Parameters

Parameter	Type
paramName	string
index	number

Returns

string

Implementation of

IDbAdapter.formatParameterPlaceholder

---

beginTransaction()

beginTransaction(isolationLevel?): Promise<DbTransaction>

Defined in: src/pool/PooledDbAdapter.ts:64

Parameters

Parameter	Type
isolationLevel?	IsolationLevel

Returns

Promise<DbTransaction>

Implementation of

IDbAdapter.beginTransaction

---

executeQuery()

executeQuery<T>(sql, params?, transaction?): Promise<T[]>

Defined in: src/pool/PooledDbAdapter.ts:117

Type Parameters

Type Parameter	Default type
T	unknown

Parameters

Parameter	Type
sql	string
params?	AdapterParam[]
transaction?	DbTransaction

Returns

Promise<T[]>

Implementation of

IDbAdapter.executeQuery

---

executeNonQuery()

executeNonQuery(sql, params?, transaction?): Promise<{ rowsAffected: number; insertId?: unknown; }>

Defined in: src/pool/PooledDbAdapter.ts:128

Parameters

Parameter	Type
sql	string
params?	AdapterParam[]
transaction?	DbTransaction

Returns

Promise<{ rowsAffected: number; insertId?: unknown; }>

Implementation of

IDbAdapter.executeNonQuery

---

executeScalar()

executeScalar<T>(sql, params?, transaction?): Promise<T>

Defined in: src/pool/PooledDbAdapter.ts:139

Type Parameters

Type Parameter	Default type
T	unknown

Parameters

Parameter	Type
sql	string
params?	AdapterParam[]
transaction?	DbTransaction

Returns

Promise<T>

Implementation of

IDbAdapter.executeScalar

---

executeProcedure()

executeProcedure<T>(name, params, timeoutMs?, transaction?): Promise<StoredProcedureResult<T[]>>

Defined in: src/pool/PooledDbAdapter.ts:150

Type Parameters

Type Parameter	Default type
T	unknown

Parameters

Parameter	Type
name	string
params	AdapterParam[]
timeoutMs?	number
transaction?	DbTransaction

Returns

Promise<StoredProcedureResult<T[]>>

Implementation of

IDbAdapter.executeProcedure

---

executeProcedureMultiple()

executeProcedureMultiple<T>(name, params, timeoutMs?, transaction?): Promise<StoredProcedureResult<T>>

Defined in: src/pool/PooledDbAdapter.ts:162

Type Parameters

Type Parameter	Default type
T extends unknown[]	unknown[]

Parameters

Parameter	Type
name	string
params	AdapterParam[]
timeoutMs?	number
transaction?	DbTransaction

Returns

Promise<StoredProcedureResult<T>>

Implementation of

IDbAdapter.executeProcedureMultiple

---

executeStream()?

optional executeStream<T>(sql, params?, transaction?): AsyncIterable<T>

Defined in: src/pool/PooledDbAdapter.ts:174

Optional: streams large result sets as an AsyncIterable without loading all rows into memory.

Adapters that don't implement this method will fall back to DbSet.stream()'s built-in batched-pagination polyfill, which works on every adapter.

Type Parameters

Type Parameter	Default type
T	unknown

Parameters

Parameter	Type
sql	string
params?	AdapterParam[]
transaction?	DbTransaction

Returns

AsyncIterable<T>

Implementation of

IDbAdapter.executeStream

Properties

pool

readonly pool: IConnectionPool

Defined in: src/pool/PooledDbAdapter.ts:13