Skip to content

docs: update default plugin list #686

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
karenc-bq merged 3 commits into from
Aug 20, 2026
Merged

docs: update default plugin list #686

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
28137ae
docs: update default plugin list
sakurai-ryo Aug 17, 2026
6530e2f
Merge branch 'main' into update-failover-plugin-doc
karenc-bq Aug 20, 2026
5ec7e9c
fix: formatting error
karenc-bq Aug 20, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions docs/using-the-nodejs-wrapper/UsingTheNodejsWrapper.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,14 +79,14 @@ Plugins are loaded and managed through the Connection Plugin Manager and may be

### Connection Plugin Manager Parameters

| Parameter | Value | Required | Description | Default Value |
| ---------------------------- | --------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------- |
| `plugins` | `string` | No | Comma separated list of connection plugin codes. <br><br>Example: `failover,efm` | `auroraConnectionTracker,failover,efm2` |
| `autoSortWrapperPluginOrder` | `boolean` | No | Allows the AWS Advanced NodeJS Wrapper to sort connection plugins to prevent plugin misconfiguration. Allows a user to provide a custom plugin order if needed. | `true` |
| `profileName` | `string` | No | Driver configuration profile name. Instead of listing plugin codes with `plugins`, the driver profile can be set with this parameter. <br><br> Example: See [below](#configuration-profiles). | `null` |
| Parameter | Value | Required | Description | Default Value |
| ---------------------------- | --------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------- |
| `plugins` | `string` | No | Comma separated list of connection plugin codes. <br><br>Example: `failover,efm` | `initialConnection,auroraConnectionTracker,failover2,efm2` |
| `autoSortWrapperPluginOrder` | `boolean` | No | Allows the AWS Advanced NodeJS Wrapper to sort connection plugins to prevent plugin misconfiguration. Allows a user to provide a custom plugin order if needed. | `true` |
| `profileName` | `string` | No | Driver configuration profile name. Instead of listing plugin codes with `plugins`, the driver profile can be set with this parameter. <br><br> Example: See [below](#configuration-profiles). | `null` |

To use a built-in plugin, specify its relevant plugin code for the `plugins` .
The default value for `plugins` is `failover`. These plugins are enabled by default. To read more about these plugins, see the [List of Available Plugins](#list-of-available-plugins) section.
The default value for `plugins` is `initialConnection,auroraConnectionTracker,failover2,efm2`. These plugins are enabled by default. To read more about these plugins, see the [List of Available Plugins](#list-of-available-plugins) section.
To override the default plugins, simply provide a new value for `plugins`.
For instance, to use the [IAM Authentication Connection Plugin](./using-plugins/UsingTheIamAuthenticationPlugin.md) and the [Failover Connection Plugin](./using-plugins/UsingTheFailoverPlugin.md):

Expand Down Expand Up @@ -122,8 +122,8 @@ The AWS Advanced NodeJS Wrapper has several built-in plugins that are available

| Plugin name | Plugin Code | Database Compatibility | Description | Additional Required Dependencies |
| ------------------------------------------------------------------------------------------------------------- | ------------------------- | ------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------ |
| [Failover Connection Plugin](./using-plugins/UsingTheFailoverPlugin.md) | `failover` | Aurora, RDS Multi-AZ DB Cluster | Enables the failover functionality supported by Amazon Aurora clusters and RDS Multi-AZ DB clusters. Prevents opening a wrong connection to an old writer instance due to stale DNS after a failover event. This plugin is enabled by default. | None |
| [Failover2 Connection Plugin](./using-plugins/UsingTheFailover2Plugin.md) | `failover2` | Aurora | Enables the failover functionality supported by Amazon Aurora clusters. Prevents opening a wrong connection to an old writer instance due to stale DNS after a failover event. This is the next version of the Failover Plugin. | None |
| [Failover Connection Plugin](./using-plugins/UsingTheFailoverPlugin.md) | `failover` | Aurora, RDS Multi-AZ DB Cluster | Enables the failover functionality supported by Amazon Aurora clusters and RDS Multi-AZ DB clusters. Prevents opening a wrong connection to an old writer instance due to stale DNS after a failover event. | None |
| [Failover2 Connection Plugin](./using-plugins/UsingTheFailover2Plugin.md) | `failover2` | Aurora | Enables the failover functionality supported by Amazon Aurora clusters. Prevents opening a wrong connection to an old writer instance due to stale DNS after a failover event. This is the next version of the Failover Plugin. This plugin is enabled by default. | None |
| [Host Monitoring Plugin](./using-plugins/UsingTheHostMonitoringPlugin.md) | `efm` | Aurora, RDS Multi-AZ DB Cluster | Enables enhanced host connection failure monitoring, allowing faster failure detection rates. | None |
| [Host Monitoring 2 Plugin](./using-plugins/UsingTheHostMonitoringPlugin.md#host-monitoring-plugin-v2) | `efm2` | Aurora, RDS Multi-AZ DB Cluster | Enables enhanced host connection failure monitoring, allowing faster failure detection rates. Split monitoring logic into two separate tasks and simlified monitoring logic to increase overall monitoring stability. This plugin is enabled by default. | None |
| Execution Time Connection Plugin | `executeTime` | Any database | Logs the time taken to execute any client method. | None |
Expand All @@ -134,7 +134,7 @@ The AWS Advanced NodeJS Wrapper has several built-in plugins that are available
| Aurora Stale DNS Plugin | `staleDns` | Aurora | Prevents incorrectly opening a new connection to an old writer node when DNS records have not yet updated after a recent failover event. <br><br> :warning:**Note:** Contrary to `failover` plugin, `auroraStaleDns` plugin doesn't implement failover support itself. It helps to eliminate opening wrong connections to an old writer node after cluster failover is completed. <br><br> :warning:**Note:** This logic is already included in `failover` plugin so you can omit using both plugins at the same time. | None |
| [Aurora Connection Tracker Plugin](./using-plugins/UsingTheAuroraConnectionTrackerPlugin.md) | `auroraConnectionTracker` | Aurora, RDS Multi-AZ DB Cluster | Tracks all the opened connections. In the event of a cluster failover, the plugin will close all the impacted connections to the host. This plugin is enabled by default. | None |
| [Read Write Splitting Plugin](./using-plugins/UsingTheReadWriteSplittingPlugin.md) | `readWriteSplitting` | Aurora | Enables read write splitting functionality where users can switch between database reader and writer instances. | None |
| [Aurora Initial Connection Strategy Plugin](./using-plugins/UsingTheAuroraInitialConnectionStrategyPlugin.md) | `initialConnection` | Aurora | Allows users to configure their initial connection strategy to reader cluster endpoints. | None |
| [Aurora Initial Connection Strategy Plugin](./using-plugins/UsingTheAuroraInitialConnectionStrategyPlugin.md) | `initialConnection` | Aurora | Allows users to configure their initial connection strategy to reader cluster endpoints. This plugin is enabled by default. | None |
| [Aurora Limitless Connection Plugin](./using-plugins/UsingTheAuroraInitialConnectionStrategyPlugin.md) | `limitless` | Aurora | Allows users to use Aurora Limitless Database and effectively load-balance load between available transaction routers. | None |
| [Fastest Response Strategy Plugin](./using-plugins/UsingTheFastestResponseStrategyPlugin.md) | `fastestResponseStrategy` | Aurora | When read-write splitting is enabled, this plugin selects the reader to switch to based on the host with the fastest response time. The plugin achieves this by periodically monitoring the hosts' response times and storing the fastest host in a cache.<br><br> :warning:**Note:** the `readerHostSelector` strategy must be set to `fastestResponse` in the user-defined connection properties in order to enable this plugin. See [reader selection strategies](./ReaderSelectionStrategies.md) | None |
| [Custom Endpoint Plugin](./using-plugins/UsingTheCustomEndpointPlugin.md) | `customEndpoint` | Aurora | This plugin will analyse custom endpoint information to ensure instances used in connections are part of the custom endpoint being used. | See the Custom Endpoint Plugin [prerequisites](./using-plugins/UsingTheCustomEndpointPlugin.md#Prerequisites) |
Expand Down
2 changes: 1 addition & 1 deletion ...e-nodejs-wrapper/using-plugins/UsingTheAuroraInitialConnectionStrategyPlugin.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ This plugin also helps retrieve connections more reliably. When a user connects

## Enabling the Aurora Initial Connection Strategy Plugin

To enable the Aurora Initial Connection Strategy Plugin, add `initialConnection` to the [`plugins`](../UsingTheNodejsWrapper.md#connection-plugin-manager-parameters) connection parameter.
Since version 2.1.1, the Aurora Initial Connection Strategy Plugin will be enabled by default if the [`plugins`](../UsingTheNodejsWrapper.md#connection-plugin-manager-parameters) value is not specified. In earlier versions the plugin was not enabled by default. The Aurora Initial Connection Strategy Plugin can also be explicitly included by adding the plugin code `initialConnection` to the [`plugins`](../UsingTheNodejsWrapper.md#connection-plugin-manager-parameters) connection parameter.

## Aurora Initial Connection Strategy Connection Parameters

Expand Down
2 changes: 1 addition & 1 deletion docs/using-the-nodejs-wrapper/using-plugins/UsingTheFailover2Plugin.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ With the `failover2` plugin:

## Using the Failover Plugin v2

The Failover Plugin v2 will **NOT** be enabled by default. It must be explicitly included by adding the plugin code `failover2` to the [`plugins`](../UsingTheNodejsWrapper.md#plugins) parameter, or by adding it to the current [Configuration Profile](../UsingTheNodejsWrapper.md#configuration-profiles). After you load the plugin, the failover2 feature will be enabled.
Since version 2.1.1, the Failover Plugin v2 will be enabled by default if the [`plugins`](../UsingTheNodejsWrapper.md#plugins) value is not specified. In earlier versions the [Failover Plugin](./UsingTheFailoverPlugin.md) (`failover`) was the one enabled by default. The Failover Plugin v2 can also be explicitly included by adding the plugin code `failover2` to the [`plugins`](../UsingTheNodejsWrapper.md#plugins) parameter, or by adding it to the current [Configuration Profile](../UsingTheNodejsWrapper.md#configuration-profiles). After you load the plugin, the failover2 feature will be enabled.

Please refer to the [failover configuration guide](../FailoverConfigurationGuide.md) for tips to keep in mind when using the failover plugin.

Expand Down
Loading