diff --git a/common/lib/plugins/bluegreen/blue_green_status_provider.ts b/common/lib/plugins/bluegreen/blue_green_status_provider.ts index 5a80116d..f313aacf 100644 --- a/common/lib/plugins/bluegreen/blue_green_status_provider.ts +++ b/common/lib/plugins/bluegreen/blue_green_status_provider.ts @@ -458,7 +458,7 @@ export class BlueGreenStatusProvider { // New connect requests: go to blue or green hosts; default behaviour; no routing // Existing connections: default behaviour; no action - // Execute JDBC calls: default behaviour; no action + // Execute database calls: default behaviour; no action protected getStatusOfCreated(): BlueGreenStatus { return new BlueGreenStatus(this.bgdId, BlueGreenPhase.CREATED, [], [], this.roleByHost, this.correspondingHosts); } diff --git a/docs/README.md b/docs/README.md index cbb466a7..44dd47cd 100644 --- a/docs/README.md +++ b/docs/README.md @@ -31,6 +31,10 @@ - [Custom Endpoint Plugin](./using-the-nodejs-wrapper/using-plugins/UsingTheCustomEndpointPlugin.md) - [Developer Plugin](./using-the-nodejs-wrapper/using-plugins/UsingTheDeveloperPlugin.md) - [Limitless Connection Plugin](./using-the-nodejs-wrapper/using-plugins/UsingTheLimitlessConnectionPlugin.md) + - [Plugins Compatibility](./using-the-nodejs-wrapper/compatibility/Compatibility.md) + - [Database Type Compatibility](./using-the-nodejs-wrapper/compatibility/CompatibilityDatabaseTypes.md) + - [Database URL Type Compatibility](./using-the-nodejs-wrapper/compatibility/CompatibilityEndpoints.md) + - [Cross Plugins Compatibility](./using-the-nodejs-wrapper/compatibility/CompatibilityCrossPlugins.md) - [Host Availability Strategy](./using-the-nodejs-wrapper/HostAvailabilityStrategy.md) - [Reader Selection Strategies](./using-the-nodejs-wrapper/ReaderSelectionStrategies.md) - [Custom Configuration](./using-the-nodejs-wrapper/custom-configuration/AwsCredentialsConfiguration.md) diff --git a/docs/using-the-nodejs-wrapper/compatibility/Compatibility.md b/docs/using-the-nodejs-wrapper/compatibility/Compatibility.md new file mode 100644 index 00000000..05d8cd26 --- /dev/null +++ b/docs/using-the-nodejs-wrapper/compatibility/Compatibility.md @@ -0,0 +1,22 @@ +# Plugins compatibility + +The AWS Advanced NodeJS Wrapper uses plugins to execute client methods. You can think of a plugin as an extensible code module that adds additional logic around target driver method calls. Plugins are designed with the intention of being compatible with each other; however, there are logical constraints related to database type or database features that can make plugins inefficient in certain configurations. + +For example, RDS Single-AZ Instance deployments do not support failover, so the `failover` and `failover2` plugins are marked as incompatible. If either of these plugins is included in the wrapper configuration, there will be no added value. However, these unnecessary plugins will function without errors and will simply consume additional resources. + +The following matrices help verify plugin compatibility with other plugins and with various database types. Some plugins are sensitive to the database URL provided in the connection configuration, and this is also presented below. + +We encourage users to verify their configurations and ensure that their configuration contains no incompatible components. + +- [Database type compatibility](./CompatibilityDatabaseTypes.md) +- [Database URL type compatibility](./CompatibilityEndpoints.md) +- [Cross Plugins compatibility](./CompatibilityCrossPlugins.md) + +## Universally Compatible Plugins + +The following plugins operate independently of connection management and are compatible with all plugins, database types, and endpoint types: + +| Plugin | Description | +|---------------------------------------------------------------|----------------------------------------------------------| +| [dev](../using-plugins/UsingTheDeveloperPlugin.md) | Developer utility plugin for debugging and diagnostics. | +| executeTime | Logs the time taken to execute any client method. | diff --git a/docs/using-the-nodejs-wrapper/compatibility/CompatibilityCrossPlugins.md b/docs/using-the-nodejs-wrapper/compatibility/CompatibilityCrossPlugins.md new file mode 100644 index 00000000..9f7265fd --- /dev/null +++ b/docs/using-the-nodejs-wrapper/compatibility/CompatibilityCrossPlugins.md @@ -0,0 +1,81 @@ +# Cross plugin compatibility + +This document is part of the [Compatibility Guide](./Compatibility.md) and explains compatibility between various plugins. While combining plugins in a single wrapper configuration is common, some plugins may not work properly together. Such incompatibilities can arise from either plugin design constraints or logical conflicts. + +For example, the `failover` plugin is incompatible with `failover2`. Both plugins support database cluster failover but implement this functionality differently. Combining them in a single configuration causes interference between their operations, leading to instability. + +Similarly, the `limitless` plugin and `customEndpoint` plugin are incompatible because Limitless Database does not support custom endpoints. + + +| Plugin codes / Plugin codes | [efm](../using-plugins/UsingTheHostMonitoringPlugin.md) | [efm2](../using-plugins/UsingTheHostMonitoringPlugin.md#host-monitoring-plugin-v2) | [failover](../using-plugins/UsingTheFailoverPlugin.md) | [failover2](../using-plugins/UsingTheFailover2Plugin.md) | [gdbFailover](../using-plugins/UsingTheGdbFailoverPlugin.md) | +|---------------------------------------------------------------------------------------|----------------------------------------------------------|-----------------------------------------------------------------------------------|----------------------------------------------------------|----------------------------------------------------------|-------------------------------------------------------------| +| [efm2](../using-plugins/UsingTheHostMonitoringPlugin.md#host-monitoring-plugin-v2) | | | | | | +| [failover](../using-plugins/UsingTheFailoverPlugin.md) | | | | | | +| [failover2](../using-plugins/UsingTheFailover2Plugin.md) | | | | | | +| [gdbFailover](../using-plugins/UsingTheGdbFailoverPlugin.md) | | | | | | +| [iam](../using-plugins/UsingTheIamAuthenticationPlugin.md) | | | | | | +| [secretsManager](../using-plugins/UsingTheAwsSecretsManagerPlugin.md) | | | | | | +| [federatedAuth](../using-plugins/UsingTheFederatedAuthPlugin.md) | | | | | | +| [okta](../using-plugins/UsingTheOktaAuthPlugin.md) | | | | | | +| [readWriteSplitting](../using-plugins/UsingTheReadWriteSplittingPlugin.md) | | | | | | +| [gdbReadWriteSplitting](../using-plugins/UsingTheGdbReadWriteSplittingPlugin.md) | | | | | | +| [customEndpoint](../using-plugins/UsingTheCustomEndpointPlugin.md) | | | | | | +| [auroraConnectionTracker](../using-plugins/UsingTheAuroraConnectionTrackerPlugin.md) | | | | | | +| [initialConnection](../using-plugins/UsingTheAuroraInitialConnectionStrategyPlugin.md) | | | | | | +| staleDns | | | | | | +| connectTime | | | | | | +| [fastestResponseStrategy](../using-plugins/UsingTheFastestResponseStrategyPlugin.md) | | | | | | +| [limitless](../using-plugins/UsingTheLimitlessConnectionPlugin.md) | | | | | | +| [bg](../using-plugins/UsingTheBlueGreenPlugin.md) | | | | | | + +
+ +| Plugin codes / Plugin codes | [iam](../using-plugins/UsingTheIamAuthenticationPlugin.md) | [secretsManager](../using-plugins/UsingTheAwsSecretsManagerPlugin.md) | [federatedAuth](../using-plugins/UsingTheFederatedAuthPlugin.md) | [okta](../using-plugins/UsingTheOktaAuthPlugin.md) | +|---------------------------------------------------------------------------------------|-----------------------------------------------------------|----------------------------------------------------------------------|-----------------------------------------------------------------|----------------------------------------------------------| +| [secretsManager](../using-plugins/UsingTheAwsSecretsManagerPlugin.md) | | | | | +| [federatedAuth](../using-plugins/UsingTheFederatedAuthPlugin.md) | | | | | +| [okta](../using-plugins/UsingTheOktaAuthPlugin.md) | | | | | +| [readWriteSplitting](../using-plugins/UsingTheReadWriteSplittingPlugin.md) | | | | | +| [gdbReadWriteSplitting](../using-plugins/UsingTheGdbReadWriteSplittingPlugin.md) | | | | | +| [customEndpoint](../using-plugins/UsingTheCustomEndpointPlugin.md) | | | | | +| [auroraConnectionTracker](../using-plugins/UsingTheAuroraConnectionTrackerPlugin.md) | | | | | +| [initialConnection](../using-plugins/UsingTheAuroraInitialConnectionStrategyPlugin.md) | | | | | +| staleDns | | | | | +| connectTime | | | | | +| [fastestResponseStrategy](../using-plugins/UsingTheFastestResponseStrategyPlugin.md) | | | | | +| [limitless](../using-plugins/UsingTheLimitlessConnectionPlugin.md) | | | | | +| [bg](../using-plugins/UsingTheBlueGreenPlugin.md) | | | | | + +
+ +| Plugin codes / Plugin codes | [readWriteSplitting](../using-plugins/UsingTheReadWriteSplittingPlugin.md) | [gdbReadWriteSplitting](../using-plugins/UsingTheGdbReadWriteSplittingPlugin.md) | +|---------------------------------------------------------------------------------------|---------------------------------------------------------------------------|---------------------------------------------------------------------------------| +| [gdbReadWriteSplitting](../using-plugins/UsingTheGdbReadWriteSplittingPlugin.md) | | | +| [customEndpoint](../using-plugins/UsingTheCustomEndpointPlugin.md) | | | +| [auroraConnectionTracker](../using-plugins/UsingTheAuroraConnectionTrackerPlugin.md) | | | +| [initialConnection](../using-plugins/UsingTheAuroraInitialConnectionStrategyPlugin.md) | | | +| staleDns | | | +| connectTime | | | +| [fastestResponseStrategy](../using-plugins/UsingTheFastestResponseStrategyPlugin.md) | | | +| [limitless](../using-plugins/UsingTheLimitlessConnectionPlugin.md) | | | +| [bg](../using-plugins/UsingTheBlueGreenPlugin.md) | | | + +
+ +| Plugin codes / Plugin codes | [customEndpoint](../using-plugins/UsingTheCustomEndpointPlugin.md) | [auroraConnectionTracker](../using-plugins/UsingTheAuroraConnectionTrackerPlugin.md) | [initialConnection](../using-plugins/UsingTheAuroraInitialConnectionStrategyPlugin.md) | staleDns | +|---------------------------------------------------------------------------------------|-------------------------------------------------------------------|-------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------|----------------------------------------------------------| +| [auroraConnectionTracker](../using-plugins/UsingTheAuroraConnectionTrackerPlugin.md) | | | | | +| [initialConnection](../using-plugins/UsingTheAuroraInitialConnectionStrategyPlugin.md) | | | | | +| staleDns | | | | | +| connectTime | | | | | +| [fastestResponseStrategy](../using-plugins/UsingTheFastestResponseStrategyPlugin.md) | | | | | +| [limitless](../using-plugins/UsingTheLimitlessConnectionPlugin.md) | | | | | +| [bg](../using-plugins/UsingTheBlueGreenPlugin.md) | | | | | + +
+ +| Plugin codes / Plugin codes | connectTime | [fastestResponseStrategy](../using-plugins/UsingTheFastestResponseStrategyPlugin.md) | [limitless](../using-plugins/UsingTheLimitlessConnectionPlugin.md) | [bg](../using-plugins/UsingTheBlueGreenPlugin.md) | +|-------------------------------------------------------------------|----------------------------------------------------------|-------------------------------------------------------------------------------------|-------------------------------------------------------------------|----------------------------------------------------------| +| [fastestResponseStrategy](../using-plugins/UsingTheFastestResponseStrategyPlugin.md) | | | | | +| [limitless](../using-plugins/UsingTheLimitlessConnectionPlugin.md) | | | | | +| [bg](../using-plugins/UsingTheBlueGreenPlugin.md) | | | | | diff --git a/docs/using-the-nodejs-wrapper/compatibility/CompatibilityDatabaseTypes.md b/docs/using-the-nodejs-wrapper/compatibility/CompatibilityDatabaseTypes.md new file mode 100644 index 00000000..9faf9036 --- /dev/null +++ b/docs/using-the-nodejs-wrapper/compatibility/CompatibilityDatabaseTypes.md @@ -0,0 +1,54 @@ +# Database type compatibility + +This document is part of the [Compatibility Guide](./Compatibility.md) and explains plugin compatibility with various database types and deployments. Some plugins require specific metadata from particular database types to function properly. + +For example, the `limitless` plugin is incompatible with [Aurora Global Database](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-global-database.html) because it's built on different architectural principles than [Limitless Database](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/limitless-architecture.html). Aurora Global Database doesn't use transaction routers and doesn't provide the transaction routers' metadata. This lack of required metadata makes it incompatible with the `limitless` plugin. + +For Aurora Global Database configuration details, see the [Global Database (GDB) Failover Plugin](../using-plugins/UsingTheGdbFailoverPlugin.md) and [Global Database (GDB) Read/Write Splitting Plugin](../using-plugins/UsingTheGdbReadWriteSplittingPlugin.md) documentation. + + +| Plugin codes / Database types | [Aurora Global Database](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-global-database.html)
(MySQL and PG) | [Aurora Cluster](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Overview.html)
(MySQL and PG) | [RDS Multi-AZ DB Cluster deployment (3 instances)](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html)
(MySQL and PG) | +|---------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [customEndpoint](../using-plugins/UsingTheCustomEndpointPlugin.md) | | | | +| [efm](../using-plugins/UsingTheHostMonitoringPlugin.md) | | | | +| [efm2](../using-plugins/UsingTheHostMonitoringPlugin.md#host-monitoring-plugin-v2) | | | | +| [failover](../using-plugins/UsingTheFailoverPlugin.md) | | | | +| [failover2](../using-plugins/UsingTheFailover2Plugin.md) | | | | +| [gdbFailover](../using-plugins/UsingTheGdbFailoverPlugin.md) | | | | +| [iam](../using-plugins/UsingTheIamAuthenticationPlugin.md) | | | | +| [secretsManager](../using-plugins/UsingTheAwsSecretsManagerPlugin.md) | | | | +| [federatedAuth](../using-plugins/UsingTheFederatedAuthPlugin.md) | | | | +| [okta](../using-plugins/UsingTheOktaAuthPlugin.md) | | | | +| staleDns | | | | +| [readWriteSplitting](../using-plugins/UsingTheReadWriteSplittingPlugin.md) | | | | +| [gdbReadWriteSplitting](../using-plugins/UsingTheGdbReadWriteSplittingPlugin.md) | | | | +| [auroraConnectionTracker](../using-plugins/UsingTheAuroraConnectionTrackerPlugin.md) | | | | +| connectTime | | | | +| [fastestResponseStrategy](../using-plugins/UsingTheFastestResponseStrategyPlugin.md) | | | | +| [initialConnection](../using-plugins/UsingTheAuroraInitialConnectionStrategyPlugin.md) | | | | +| [limitless](../using-plugins/UsingTheLimitlessConnectionPlugin.md) | | (PostgreSQL only) | | +| [bg](../using-plugins/UsingTheBlueGreenPlugin.md) | | | | +
+ + +| Plugin codes / Database types | [RDS Multi-AZ DB Instance deployment (2 instances)](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.MultiAZSingleStandby.html)
(MySQL and PG) | [RDS Single-AZ Instance deployment (1 instance)](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Overview.DBInstance.html)
(MySQL and PG) | Community Database
(MySQL and PG) | +|---------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------| +| [customEndpoint](../using-plugins/UsingTheCustomEndpointPlugin.md) | | | | +| [efm](../using-plugins/UsingTheHostMonitoringPlugin.md) | | | | +| [efm2](../using-plugins/UsingTheHostMonitoringPlugin.md#host-monitoring-plugin-v2) | | | | +| [failover](../using-plugins/UsingTheFailoverPlugin.md) | | | | +| [failover2](../using-plugins/UsingTheFailover2Plugin.md) | | | | +| [gdbFailover](../using-plugins/UsingTheGdbFailoverPlugin.md) | | | | +| [iam](../using-plugins/UsingTheIamAuthenticationPlugin.md) | | | | +| [secretsManager](../using-plugins/UsingTheAwsSecretsManagerPlugin.md) | | | | +| [federatedAuth](../using-plugins/UsingTheFederatedAuthPlugin.md) | | | | +| [okta](../using-plugins/UsingTheOktaAuthPlugin.md) | | | | +| staleDns | | | | +| [readWriteSplitting](../using-plugins/UsingTheReadWriteSplittingPlugin.md) | | | | +| [gdbReadWriteSplitting](../using-plugins/UsingTheGdbReadWriteSplittingPlugin.md) | | | | +| [auroraConnectionTracker](../using-plugins/UsingTheAuroraConnectionTrackerPlugin.md) | | | | +| connectTime | | | | +| [fastestResponseStrategy](../using-plugins/UsingTheFastestResponseStrategyPlugin.md) | | | | +| [initialConnection](../using-plugins/UsingTheAuroraInitialConnectionStrategyPlugin.md) | | | | +| [limitless](../using-plugins/UsingTheLimitlessConnectionPlugin.md) | | | | +| [bg](../using-plugins/UsingTheBlueGreenPlugin.md) | | | | diff --git a/docs/using-the-nodejs-wrapper/compatibility/CompatibilityEndpoints.md b/docs/using-the-nodejs-wrapper/compatibility/CompatibilityEndpoints.md new file mode 100644 index 00000000..520faed7 --- /dev/null +++ b/docs/using-the-nodejs-wrapper/compatibility/CompatibilityEndpoints.md @@ -0,0 +1,114 @@ +# Database URL types compatibility + +This document is part of the [Compatibility Guide](./Compatibility.md) and explains plugin compatibility with various database endpoints. + +There are many different URL types (endpoints) that can be used with the AWS Advanced NodeJS Wrapper, but certain URL types are not compatible with certain plugins. This page outlines the various URL types and which plugins are compatible with each type. + +- [Aurora Global Database Endpoint](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-global-database-connecting.html) - `.global-.global.rds.amazonaws.com` +- [Aurora Cluster Writer Endpoint](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Endpoints.Cluster.html) - `.cluster-..rds.amazonaws.com` +- [Aurora Cluster Reader Endpoint](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Endpoints.Reader.html) - `.cluster-ro-..rds.amazonaws.com` +- [Aurora Cluster Custom Endpoint](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Endpoints.Custom.html) - `.cluster-custom-..rds.amazonaws.com` +- [Aurora Instance Endpoint](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Endpoints.Instance.html) - `...rds.amazonaws.com` +- [RDS Multi-AZ DB Cluster Writer Endpoint](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts-connection-management.html) - `.cluster-..rds.amazonaws.com` +- [RDS Multi-AZ DB Cluster Reader Endpoint](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts-connection-management.html) - `.cluster-ro-..rds.amazonaws.com` +- [RDS Instance Endpoint](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts-connection-management.html) - `...rds.amazonaws.com` +- [RDS Proxy Endpoint](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-proxy-endpoints.html) - `.proxy-..rds.amazonaws.com`, `.endpoint.proxy-..rds.amazonaws.com` +- [DB Shard Group Endpoint (Aurora Limitless)](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/limitless-shard.html) - `.shardgrp-..rds.amazonaws.com` +- [IP address](https://en.wikipedia.org/wiki/IP_address) - IPv4 or IPv6 addresses, for example: `8.8.0.0`, `2001:0db8:85a3:0000:0000:8a2e:0370:7334` +- User custom domain (CNAME alias) - any other domain names, for example: `my-database.my-domain.com` + +
+ +| Plugin codes / Database URL types | [Aurora Global Database Endpoint](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-global-database-connecting.html) | +|---------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------| +| [customEndpoint](../using-plugins/UsingTheCustomEndpointPlugin.md) | | +| [efm](../using-plugins/UsingTheHostMonitoringPlugin.md) | (requires `initialConnection` plugin) | +| [efm2](../using-plugins/UsingTheHostMonitoringPlugin.md#host-monitoring-plugin-v2) | (requires `initialConnection` plugin) | +| [failover](../using-plugins/UsingTheFailoverPlugin.md) | | +| [failover2](../using-plugins/UsingTheFailover2Plugin.md) | | +| [gdbFailover](../using-plugins/UsingTheGdbFailoverPlugin.md) | | +| [iam](../using-plugins/UsingTheIamAuthenticationPlugin.md) | (requires `initialConnection` plugin) | +| [secretsManager](../using-plugins/UsingTheAwsSecretsManagerPlugin.md) | | +| [federatedAuth](../using-plugins/UsingTheFederatedAuthPlugin.md) | | +| [okta](../using-plugins/UsingTheOktaAuthPlugin.md) | | +| staleDns | | +| [readWriteSplitting](../using-plugins/UsingTheReadWriteSplittingPlugin.md) | | +| [gdbReadWriteSplitting](../using-plugins/UsingTheGdbReadWriteSplittingPlugin.md) | | +| [auroraConnectionTracker](../using-plugins/UsingTheAuroraConnectionTrackerPlugin.md) | | +| connectTime | | +| [fastestResponseStrategy](../using-plugins/UsingTheFastestResponseStrategyPlugin.md) | | +| [initialConnection](../using-plugins/UsingTheAuroraInitialConnectionStrategyPlugin.md) | | +| [limitless](../using-plugins/UsingTheLimitlessConnectionPlugin.md) | | +| [bg](../using-plugins/UsingTheBlueGreenPlugin.md) | | + +
+ +| Plugin codes / Database URL types | [Aurora Cluster Writer Endpoint](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Endpoints.Cluster.html) | [Aurora Cluster Reader Endpoint](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Endpoints.Reader.html) | [Aurora Cluster Custom Endpoint](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Endpoints.Custom.html) | [Aurora Instance Endpoint](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Endpoints.Instance.html),
[RDS Instance Endpoint](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts-connection-management.html) | +|---------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [customEndpoint](../using-plugins/UsingTheCustomEndpointPlugin.md) | | | | | +| [efm](../using-plugins/UsingTheHostMonitoringPlugin.md) | (requires `initialConnection` plugin) | (requires `initialConnection` plugin) | | | +| [efm2](../using-plugins/UsingTheHostMonitoringPlugin.md#host-monitoring-plugin-v2) | (requires `initialConnection` plugin) | (requires `initialConnection` plugin) | | | +| [failover](../using-plugins/UsingTheFailoverPlugin.md) | | | | | +| [failover2](../using-plugins/UsingTheFailover2Plugin.md) | | | | | +| [gdbFailover](../using-plugins/UsingTheGdbFailoverPlugin.md) | | | | | +| [iam](../using-plugins/UsingTheIamAuthenticationPlugin.md) | | | | | +| [secretsManager](../using-plugins/UsingTheAwsSecretsManagerPlugin.md) | | | | | +| [federatedAuth](../using-plugins/UsingTheFederatedAuthPlugin.md) | | | | | +| [okta](../using-plugins/UsingTheOktaAuthPlugin.md) | | | | | +| staleDns | | | | | +| [readWriteSplitting](../using-plugins/UsingTheReadWriteSplittingPlugin.md) | | | | | +| [gdbReadWriteSplitting](../using-plugins/UsingTheGdbReadWriteSplittingPlugin.md) | | | | | +| [auroraConnectionTracker](../using-plugins/UsingTheAuroraConnectionTrackerPlugin.md) | | | | | +| connectTime | | | | | +| [fastestResponseStrategy](../using-plugins/UsingTheFastestResponseStrategyPlugin.md) | | | | | +| [initialConnection](../using-plugins/UsingTheAuroraInitialConnectionStrategyPlugin.md) | | | | | +| [limitless](../using-plugins/UsingTheLimitlessConnectionPlugin.md) | | | | | +| [bg](../using-plugins/UsingTheBlueGreenPlugin.md) | | | | | + +
+ +| Plugin codes / Database URL types | [RDS Multi-AZ DB Cluster Writer Endpoint](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts-connection-management.html) | [RDS Multi-AZ DB Cluster Reader Endpoint](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts-connection-management.html) | [RDS Proxy Endpoint](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-proxy-endpoints.html) | [DB Shard Group Endpoint (Aurora Limitless)](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/limitless-shard.html) | +|---------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------| +| [customEndpoint](../using-plugins/UsingTheCustomEndpointPlugin.md) | | | | | +| [efm](../using-plugins/UsingTheHostMonitoringPlugin.md) | (requires `initialConnection` plugin) | (requires `initialConnection` plugin) | | | +| [efm2](../using-plugins/UsingTheHostMonitoringPlugin.md#host-monitoring-plugin-v2) | (requires `initialConnection` plugin) | (requires `initialConnection` plugin) | | | +| [failover](../using-plugins/UsingTheFailoverPlugin.md) | | | | | +| [failover2](../using-plugins/UsingTheFailover2Plugin.md) | | | | | +| [gdbFailover](../using-plugins/UsingTheGdbFailoverPlugin.md) | | | | | +| [iam](../using-plugins/UsingTheIamAuthenticationPlugin.md) | | | | | +| [secretsManager](../using-plugins/UsingTheAwsSecretsManagerPlugin.md) | | | | | +| [federatedAuth](../using-plugins/UsingTheFederatedAuthPlugin.md) | | | | | +| [okta](../using-plugins/UsingTheOktaAuthPlugin.md) | | | | | +| staleDns | | | | | +| [readWriteSplitting](../using-plugins/UsingTheReadWriteSplittingPlugin.md) | | | | | +| [gdbReadWriteSplitting](../using-plugins/UsingTheGdbReadWriteSplittingPlugin.md) | | | | | +| [auroraConnectionTracker](../using-plugins/UsingTheAuroraConnectionTrackerPlugin.md) | | | | | +| connectTime | | | | | +| [fastestResponseStrategy](../using-plugins/UsingTheFastestResponseStrategyPlugin.md) | | | | | +| [initialConnection](../using-plugins/UsingTheAuroraInitialConnectionStrategyPlugin.md) | | | | | +| [limitless](../using-plugins/UsingTheLimitlessConnectionPlugin.md) | | | | | +| [bg](../using-plugins/UsingTheBlueGreenPlugin.md) | | | | | + +
+ +| Plugin codes / Database URL types | [IP address](https://en.wikipedia.org/wiki/IP_address) | User custom domain (CNAME alias) | +|---------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------| +| [customEndpoint](../using-plugins/UsingTheCustomEndpointPlugin.md) | | | +| [efm](../using-plugins/UsingTheHostMonitoringPlugin.md) | | | +| [efm2](../using-plugins/UsingTheHostMonitoringPlugin.md#host-monitoring-plugin-v2) | | | +| [failover](../using-plugins/UsingTheFailoverPlugin.md) | (requires special configuration) | (requires special configuration) | +| [failover2](../using-plugins/UsingTheFailover2Plugin.md) | (requires special configuration) | (requires special configuration) | +| [gdbFailover](../using-plugins/UsingTheGdbFailoverPlugin.md) | (requires special configuration) | (requires special configuration) | +| [iam](../using-plugins/UsingTheIamAuthenticationPlugin.md) | (requires special configuration) | (requires special configuration) | +| [secretsManager](../using-plugins/UsingTheAwsSecretsManagerPlugin.md) | (requires special configuration) | (requires special configuration) | +| [federatedAuth](../using-plugins/UsingTheFederatedAuthPlugin.md) | (requires special configuration) | (requires special configuration) | +| [okta](../using-plugins/UsingTheOktaAuthPlugin.md) | (requires special configuration) | (requires special configuration) | +| staleDns | | | +| [readWriteSplitting](../using-plugins/UsingTheReadWriteSplittingPlugin.md) | | | +| [gdbReadWriteSplitting](../using-plugins/UsingTheGdbReadWriteSplittingPlugin.md) | | | +| [auroraConnectionTracker](../using-plugins/UsingTheAuroraConnectionTrackerPlugin.md) | | | +| connectTime | | | +| [fastestResponseStrategy](../using-plugins/UsingTheFastestResponseStrategyPlugin.md) | | | +| [initialConnection](../using-plugins/UsingTheAuroraInitialConnectionStrategyPlugin.md) | | | +| [limitless](../using-plugins/UsingTheLimitlessConnectionPlugin.md) | | | +| [bg](../using-plugins/UsingTheBlueGreenPlugin.md) | (requires special configuration) | | diff --git a/docs/using-the-nodejs-wrapper/using-plugins/UsingTheGdbFailoverPlugin.md b/docs/using-the-nodejs-wrapper/using-plugins/UsingTheGdbFailoverPlugin.md index 91e1b1f1..346f4087 100644 --- a/docs/using-the-nodejs-wrapper/using-plugins/UsingTheGdbFailoverPlugin.md +++ b/docs/using-the-nodejs-wrapper/using-plugins/UsingTheGdbFailoverPlugin.md @@ -42,7 +42,7 @@ Please refer to the [failover configuration guide](../FailoverConfigurationGuide > [!WARNING] > Do not use the `gdbFailover`, `failover` and/or `failover2` plugins in any combination at the same time for the same connection! -Verify plugin compatibility within your driver configuration using the [compatibility guide](../Compatibility.md). +Verify plugin compatibility within your driver configuration using the [compatibility guide](../compatibility/Compatibility.md). ### GDB Failover Plugin Configuration Parameters