Class: ReplicaRoutingDbAdapter

Defined in: src/adapters/ReplicaRoutingDbAdapter.ts:16

An adapter wrapper that routes read operations across read replicas and locks write operations, procedures, and transactions to the primary database.

Implements

• IDbAdapter

Accessors

provider

Get Signature

get provider(): DbProvider

Defined in: src/adapters/ReplicaRoutingDbAdapter.ts:28

Returns

DbProvider

Implementation of

IDbAdapter.provider

Constructors

Constructor

new ReplicaRoutingDbAdapter(primary, replicas?, options?): ReplicaRoutingDbAdapter

Defined in: src/adapters/ReplicaRoutingDbAdapter.ts:20

Parameters

Parameter	Type	Default value
primary	IDbAdapter	undefined
replicas	IDbAdapter[]	[]
options?	ReplicaRoutingOptions	undefined

Returns

ReplicaRoutingDbAdapter

Methods

getPrimaryAdapter()

getPrimaryAdapter(): IDbAdapter

Defined in: src/adapters/ReplicaRoutingDbAdapter.ts:32

Returns

IDbAdapter

---

getReplicaAdapters()

getReplicaAdapters(): IDbAdapter[]

Defined in: src/adapters/ReplicaRoutingDbAdapter.ts:36

Returns

IDbAdapter[]

---

getNextReplica()

getNextReplica(): IDbAdapter

Defined in: src/adapters/ReplicaRoutingDbAdapter.ts:40

Returns

IDbAdapter

---

connect()

connect(): Promise<void>

Defined in: src/adapters/ReplicaRoutingDbAdapter.ts:53

Returns

Promise<void>

Implementation of

IDbAdapter.connect

---

disconnect()

disconnect(): Promise<void>

Defined in: src/adapters/ReplicaRoutingDbAdapter.ts:60

Returns

Promise<void>

Implementation of

IDbAdapter.disconnect

---

ping()

ping(): Promise<boolean>

Defined in: src/adapters/ReplicaRoutingDbAdapter.ts:67

Returns

Promise<boolean>

Implementation of

IDbAdapter.ping

---

executeQuery()

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

Defined in: src/adapters/ReplicaRoutingDbAdapter.ts:77

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/adapters/ReplicaRoutingDbAdapter.ts:102

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/adapters/ReplicaRoutingDbAdapter.ts:111

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/adapters/ReplicaRoutingDbAdapter.ts:127

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/adapters/ReplicaRoutingDbAdapter.ts:137

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

---

beginTransaction()

beginTransaction(isolationLevel?): Promise<DbTransaction>

Defined in: src/adapters/ReplicaRoutingDbAdapter.ts:146

Parameters

Parameter	Type
isolationLevel?	IsolationLevel

Returns

Promise<DbTransaction>

Implementation of

IDbAdapter.beginTransaction

---

escapeIdentifier()

escapeIdentifier(name): string

Defined in: src/adapters/ReplicaRoutingDbAdapter.ts:151

Parameters

Parameter	Type
name	string

Returns

string

Implementation of

IDbAdapter.escapeIdentifier

---

formatParameterPlaceholder()

formatParameterPlaceholder(paramName, index): string

Defined in: src/adapters/ReplicaRoutingDbAdapter.ts:155

Parameters

Parameter	Type
paramName	string
index	number

Returns

string

Implementation of

IDbAdapter.formatParameterPlaceholder