Class ReplicaManager

ReplicaManager class for managing read replicas with lag detection

Hierarchy

EventEmitter
- ReplicaManager

Constructors

constructor

new ReplicaManager(options?: Partial<ReplicationOptions>): ReplicaManager
Create a new ReplicaManager
Parameters
- Optionaloptions: Partial<ReplicationOptions>
Returns ReplicaManager
Overrides EventEmitter.constructor
- Defined in replica-manager.ts:257

Methods

addReplica

addReplica(config: ReplicaConnectionConfig): Promise<void>
Add a replica to the manager
Parameters
- config: ReplicaConnectionConfig
Returns Promise<void>
- Defined in replica-manager.ts:275

removeReplica

removeReplica(name: string): Promise<void>
Remove a replica from the manager
Parameters
- name: string
Returns Promise<void>
- Defined in replica-manager.ts:299

getReplica

getReplica(name: string): ReplicaPool | undefined
Get a replica by name
Parameters
- name: string
Returns ReplicaPool | undefined
- Defined in replica-manager.ts:315

getReplicaNames

getReplicaNames(): string[]
Get all replica names

Returns string[]
- Defined in replica-manager.ts:322

checkLag

checkLag(name: string): Promise<number | null>
Check replication lag for a specific replica Uses dialect-specific queries for lag detection
Parameters
- name: string
Returns Promise<number | null>
- Defined in replica-manager.ts:330

startLagMonitor

startLagMonitor(): void
Start the lag monitoring loop

Returns void
- Defined in replica-manager.ts:398

stopLagMonitor

stopLagMonitor(): void
Stop the lag monitoring loop

Returns void
- Defined in replica-manager.ts:468

getReplicaStats

getReplicaStats(): Map<string, ReplicaStatus>
Get statistics for all replicas

Returns Map<string, ReplicaStatus>
- Defined in replica-manager.ts:479

getReplicaStat

getReplicaStat(name: string): ReplicaStatus | undefined
Get statistics for a specific replica
Parameters
- name: string
Returns ReplicaStatus | undefined
- Defined in replica-manager.ts:486

setRoutingStrategy

setRoutingStrategy(strategy: RoutingStrategy): void
Set the routing strategy
Parameters
- strategy: RoutingStrategy
Returns void
- Defined in replica-manager.ts:493

getRoutingStrategy

getRoutingStrategy(): RoutingStrategy
Get the current routing strategy

Returns RoutingStrategy
- Defined in replica-manager.ts:500

selectReplica

selectReplica(): Promise<{ name: string; pool: ReplicaPool }>
Select a replica based on the current routing strategy

Returns Promise<{ name: string; pool: ReplicaPool }>
- Defined in replica-manager.ts:507

queryReplica

queryReplica(sql: string, options?: QueryOptions): Promise<any>
Execute a query on a replica (auto-selects replica based on routing strategy)
Parameters
- sql: string
- Optionaloptions: QueryOptions
Returns Promise<any>
- Defined in replica-manager.ts:581

getHealthyReplicas

getHealthyReplicas(): string[]
Get healthy replicas

Returns string[]
- Defined in replica-manager.ts:597

getReplicaCount

getReplicaCount(): number
Get replica count

Returns number
- Defined in replica-manager.ts:610

isReplicationEnabled

isReplicationEnabled(): boolean
Check if replication is enabled

Returns boolean
- Defined in replica-manager.ts:617

setLagDetectionConfig

setLagDetectionConfig(config: Partial<LagDetectionConfig>): void
Set lag detection configuration
Parameters
- config: Partial<LagDetectionConfig>
Returns void
- Defined in replica-manager.ts:624

getLagDetectionConfig

getLagDetectionConfig(): LagDetectionConfig
Get lag detection configuration

Returns LagDetectionConfig
- Defined in replica-manager.ts:634

close

close(): Promise<void>
Close all replica connections

Returns Promise<void>
- Defined in replica-manager.ts:641