chore: use consistent naming for GlobalDB related functionalities - #690
Merged
Conversation
karenc-bq
force-pushed
the
chore/rename-gdb
branch
from
August 19, 2026 18:25
f8be36d to
7183733
Compare
sophia-bq
approved these changes
Aug 19, 2026
| > Ensure that `failoverHomeRegion` is included in the `gdbAccessibleRegions` list. Otherwise, home region failover logic will not function correctly. | ||
|
|
||
| ### Interaction with GDB Read/Write Splitting | ||
| ### Interaction with GlobalDb Read/Write Splitting |
Contributor
There was a problem hiding this comment.
Suggested change
| ### Interaction with GlobalDb Read/Write Splitting | |
| ### Interaction with Global Db Read/Write Splitting |
Contributor
Author
There was a problem hiding this comment.
I feel like it may be better to use the fully expanded Global Database in documentation.
Contributor
There was a problem hiding this comment.
Oooh if that is possible then yes, that is even more readable!
| | Parameter | Value | Required | Description | Default Value | | ||
| | --------------------------------- | :------: | :------: | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------- | | ||
| | `monitoringConnectionPriority` | `string` | No | Defines the priority for monitoring connections. Determines which type of host the topology monitor should connect to.<br><br>Possible values: `strict-writer`, `strict-reader`, `writer-or-reader`. | `strict-writer` | | ||
| | `gdbMonitoringConnectionPriority` | `string` | No | Defines the priority for monitoring connections in a Global Aurora Database context. Supports region-aware variants and specific region names.<br><br>See [GlobalDb Monitoring Connection Priority Values](#gdb-monitoring-connection-priority-values). | `null` | |
Contributor
There was a problem hiding this comment.
Suggested change
| | `gdbMonitoringConnectionPriority` | `string` | No | Defines the priority for monitoring connections in a Global Aurora Database context. Supports region-aware variants and specific region names.<br><br>See [GlobalDb Monitoring Connection Priority Values](#gdb-monitoring-connection-priority-values). | `null` | | |
| | `gdbMonitoringConnectionPriority` | `string` | No | Defines the priority for monitoring connections in a Global Aurora Database context. Supports region-aware variants and specific region names.<br><br>See [Global Db Monitoring Connection Priority Values](#gdb-monitoring-connection-priority-values). | `null` | |
| | `writer-or-reader` | The topology monitor connects to a writer host if available; otherwise falls back to a reader host. | | ||
|
|
||
| ### GDB Values (`gdbMonitoringConnectionPriority`) | ||
| ### GlobalDb Values (`gdbMonitoringConnectionPriority`) |
Contributor
There was a problem hiding this comment.
Suggested change
| ### GlobalDb Values (`gdbMonitoringConnectionPriority`) | |
| ### Global Db Values (`gdbMonitoringConnectionPriority`) |
| @@ -1,19 +1,19 @@ | |||
| # Global Database (GDB) Failover Plugin | |||
| # Global Database (GlobalDb) Failover Plugin | |||
Contributor
There was a problem hiding this comment.
Suggested change
| # Global Database (GlobalDb) Failover Plugin | |
| # Global Database (Global Db) Failover Plugin |
I have a slight preference for putting the space here when used like this in the docs but totally okay to keep it without the space as well
karenc-bq
force-pushed
the
chore/rename-gdb
branch
from
August 19, 2026 23:01
d5f5313 to
a0d7b99
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Renames the internal
Gdb/GDBcode identifiers used for Aurora Global Database support toGlobalDb, for consistent and readable naming across the wrapper.Configuration parameters and plugin codes are intentionally left as
gdb*.Description
Renamed files / directories (git-tracked as renames):
utils/gdb_region_utils.ts→utils/global_db_region_utils.tshost_list_provider/monitoring/gdb_monitoring_connection_handler.ts→global_db_monitoring_connection_handler.tsplugins/read_write_splitting/gdb_read_write_splitting_plugin{,_factory}.ts→global_db_read_write_splitting_plugin{,_factory}.tsplugins/gdb_failover/→plugins/global_db_failover/UsingTheGdb*docsRenamed identifiers (
Gdb/GDB→GlobalDb):GDBRegionUtils,GdbReadWriteSplittingPlugin(Factory),GdbMonitoringConnectionHandler,GdbMonitoringConnectionPriority,GdbPriorityConfig,GdbTopologyUtilsparseGdbPriority,isGdbTopologyUtils,gdbRdsUtils,GDB_CLUSTER_ARN_PATTERNWrapperPropertiesconstants:GDB_RW_HOME_REGION,GDB_RW_RESTRICT_{WRITER,READER}_TO_HOME_REGION,GDB_ACCESSIBLE_REGIONS,GDB_MONITORING_CONNECTION_PRIORITY→GLOBAL_DB_*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.