aws_advanced_ruby_driver_wrapper 1.0.0

data/lib/aws_advanced_ruby_driver_wrapper/active_record/aws_postgresql_adapter.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+#  Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+#  Licensed under the Apache License, Version 2.0 (the "License").
+#  You may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#  http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+
+require 'active_record/connection_adapters/postgresql_adapter'
+require_relative '../postgresql'
+require_relative '../errors'
+require_relative '../utils/ar_constants'
+
+module ActiveRecord
+  module ConnectionAdapters
+    class AwsPostgreSQLAdapter < PostgreSQLAdapter
+      ADAPTER_NAME = 'AwsPostgreSQL'
+
+      # ActiveRecord-only keys that should not be passed to the wrapper or native driver.
+      AR_ONLY_KEYS = (AwsAdvancedRubyDriverWrapper::Utils::AR_COMMON_KEYS + %i[advisory_locks schema_search_path]).freeze
+
+      # ActiveRecord uses :username and :database, but the PG gem expects :user and :dbname.
+      # The parent adapter translates these in @connection_parameters, but also strips
+      # non-PG keys (including wrapper properties) via slice!. Since we rebuild from @config
+      # to preserve wrapper properties, we need to redo this translation ourselves.
+      AR_TO_PG_KEY_MAP = { username: :user, database: :dbname }.freeze
+
+      def initialize(...)
+        # Capture the full config before the parent's initialize strips it
+        # down to only PG-recognized keys in @connection_parameters.
+        super
+        @connection_broken = false
+        # Store non-AR parameters in @wrapper_config.
+        wrapper_config = @config.compact.except(*AR_ONLY_KEYS)
+        # Remap ActiveRecord key names to PG gem key names.
+        AR_TO_PG_KEY_MAP.each { |ar_key, pg_key| wrapper_config[pg_key] = wrapper_config.delete(ar_key) if wrapper_config.key?(ar_key) }
+        @wrapper_config = wrapper_config
+      end
+
+      def adapter_name = ADAPTER_NAME
+
+      # Note that this config includes wrapper properties.
+      def self.new_client(config)
+        AwsAdvancedRubyDriverWrapper::WrapperPgConnection.new(**config)
+      end
+
+      def connect
+        @connection_broken = false
+        # Override @connection_parameters with the full config so the parent's
+        # call to new_client(@connection_parameters) includes wrapper properties.
+        @connection_parameters = @wrapper_config
+        super
+      end
+
+      def reconnect
+        @connection_broken = false
+        super
+      end
+
+      def active?
+        return false if @connection_broken
+
+        super
+      end
+
+      def translate_exception(exception, message:, sql:, binds:)
+        return super unless exception.is_a?(AwsAdvancedRubyDriverWrapper::Errors::AwsError)
+
+        if exception.needs_reconfiguration
+          configure_connection
+          exception
+        elsif exception.is_a?(AwsAdvancedRubyDriverWrapper::Errors::FailoverFailedError)
+          @connection_broken = true
+          ActiveRecord::ConnectionFailed.new(message, sql:, binds:, connection_pool: @pool)
+        else
+          exception
+        end
+      end
+    end
+  end
+end
+
+ActiveRecord::ConnectionAdapters.register(
+  'aws_postgresql',
+  'ActiveRecord::ConnectionAdapters::AwsPostgreSQLAdapter',
+  'aws_advanced_ruby_driver_wrapper/active_record/aws_postgresql_adapter'
+)

data/lib/aws_advanced_ruby_driver_wrapper/custom_configuration.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+#  Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+#  Licensed under the Apache License, Version 2.0 (the "License").
+#  You may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#  http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+
+module AwsAdvancedRubyDriverWrapper
+  class Configuration
+    VALID_KEYS = %i[
+      prepare_host_func
+      custom_dialect
+      custom_error_handler
+      connection_init_func
+    ].freeze
+
+    def initialize
+      @mutex = Mutex.new
+      @values = {}
+    end
+
+    (VALID_KEYS - %i[prepare_host_func]).each do |key|
+      define_method(key) { @mutex.synchronize { @values[key] } }
+      define_method(:"#{key}=") { |val| @mutex.synchronize { @values[key] = val } }
+    end
+
+    def prepare_host_func
+      Utils::RdsUtils.prepare_host_func
+    end
+
+    def prepare_host_func=(func)
+      Utils::RdsUtils.prepare_host_func = func
+    end
+
+    def update(**options)
+      options.each do |key, value|
+        raise ArgumentError, "Unknown configuration key: #{key}" unless VALID_KEYS.include?(key)
+
+        public_send(:"#{key}=", value)
+      end
+      self
+    end
+
+    def reset!
+      VALID_KEYS.each { |key| public_send(:"#{key}=", nil) }
+      self
+    end
+  end
+end

data/lib/aws_advanced_ruby_driver_wrapper/db_dialects/aurora_mysql_dialect.rb

@@ -0,0 +1,103 @@
+# frozen_string_literal: true
+
+#  Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+#  Licensed under the Apache License, Version 2.0 (the "License").
+#  You may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#  http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+
+require_relative 'mysql_dialect'
+require_relative 'utils/dialect_utils'
+
+module AwsAdvancedRubyDriverWrapper
+  module DbDialects
+    class AuroraMysqlDialect < MysqlDialect
+      AURORA_VERSION_EXISTS_QUERY = <<~SQL
+        SHOW VARIABLES LIKE 'aurora_version'
+      SQL
+
+      TOPOLOGY_QUERY = <<~SQL
+        SELECT SERVER_ID AS instance_id,
+        CASE WHEN SESSION_ID = 'MASTER_SESSION_ID' THEN TRUE ELSE FALSE END AS is_writer,
+        CPU AS cpu_utilization,
+        REPLICA_LAG_IN_MILLISECONDS AS instance_lag,
+        LAST_UPDATE_TIMESTAMP AS last_update_time
+        FROM information_schema.replica_host_status
+        WHERE time_to_sec(timediff(now(), LAST_UPDATE_TIMESTAMP)) <= 300 OR SESSION_ID = 'MASTER_SESSION_ID'
+      SQL
+
+      # We need to extract ID and instance name. For Aurora they are equivalent, but for multi-az clusters they are not.
+      INSTANCE_IDENTITY_QUERY = <<~SQL
+        SELECT @@aurora_server_id, @@aurora_server_id
+      SQL
+
+      WRITER_ID_QUERY = <<~SQL
+        SELECT SERVER_ID FROM information_schema.replica_host_status
+        WHERE SESSION_ID = 'MASTER_SESSION_ID' AND SERVER_ID = @@aurora_server_id
+      SQL
+
+      IS_READER_QUERY = <<~SQL
+        SELECT @@innodb_read_only
+      SQL
+
+      BG_TOPOLOGY_EXISTS_QUERY = <<~SQL
+        SELECT 1 AS tmp FROM information_schema.tables WHERE
+        table_schema = 'mysql' AND table_name = 'rds_topology'
+      SQL
+
+      BG_STATUS_QUERY = <<~SQL
+        SELECT * FROM mysql.rds_topology
+      SQL
+
+      DIALECT_UPDATE_CANDIDATES = [
+        AwsAdvancedRubyDriverWrapper::DialectCodes::GLOBAL_AURORA_MYSQL,
+        AwsAdvancedRubyDriverWrapper::DialectCodes::MULTI_AZ_MYSQL_CLUSTER
+      ].freeze
+
+      def dialect?(connection)
+        check_existence_queries(@driver_dialect, connection, AURORA_VERSION_EXISTS_QUERY)
+      end
+
+      def dialect_update_candidates
+        DIALECT_UPDATE_CANDIDATES
+      end
+
+      def instance_identity(connection)
+        query_instance_identity(@driver_dialect, connection, INSTANCE_IDENTITY_QUERY)
+      end
+
+      def topology_query
+        TOPOLOGY_QUERY
+      end
+
+      def writer_id_query
+        WRITER_ID_QUERY
+      end
+
+      def blue_green_status_available?(connection)
+        check_existence_queries(@driver_dialect, connection, BG_TOPOLOGY_EXISTS_QUERY)
+      end
+
+      def blue_green_status_query
+        BG_STATUS_QUERY
+      end
+
+      # @param service_container [Services::ServiceContainer]
+      # @return [Host::RdsHostListProvider] the host list provider
+      def create_host_list_provider(service_container)
+        require_relative '../utils/aurora_topology_utils'
+        require_relative '../host/rds_host_list_provider'
+        topology_utils = Utils::AuroraTopologyUtils.new(dialect: self)
+        Host::RdsHostListProvider.new(service_container:, topology_utils:)
+      end
+    end
+  end
+end

data/lib/aws_advanced_ruby_driver_wrapper/db_dialects/aurora_pg_dialect.rb

@@ -0,0 +1,124 @@
+# frozen_string_literal: true
+
+#  Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+#  Licensed under the Apache License, Version 2.0 (the "License").
+#  You may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#  http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+
+require_relative 'pg_dialect'
+require_relative 'utils/dialect_utils'
+
+module AwsAdvancedRubyDriverWrapper
+  module DbDialects
+    class AuroraPgDialect < PgDialect
+      AURORA_UTILS_EXIST_QUERY = <<~SQL
+        SELECT (setting OPERATOR(pg_catalog.~~) '%aurora_stat_utils%') AS aurora_stat_utils
+        FROM pg_catalog.pg_settings
+        WHERE name OPERATOR(pg_catalog.=) 'rds.extensions'
+      SQL
+
+      TOPOLOGY_EXISTS_QUERY = <<~SQL
+        SELECT 1 FROM pg_catalog.aurora_replica_status() LIMIT 1
+      SQL
+
+      TOPOLOGY_QUERY = <<~SQL
+        SELECT SERVER_ID AS instance_id,
+        CASE WHEN SESSION_ID OPERATOR(pg_catalog.=) 'MASTER_SESSION_ID' THEN TRUE ELSE FALSE END AS is_writer,
+        CPU AS cpu_utilization,
+        COALESCE(REPLICA_LAG_IN_MSEC, 0) AS instance_lag,
+        LAST_UPDATE_TIMESTAMP AS last_update_time
+        FROM pg_catalog.aurora_replica_status()
+        WHERE EXTRACT(EPOCH FROM(pg_catalog.NOW() OPERATOR(pg_catalog.-) LAST_UPDATE_TIMESTAMP)) OPERATOR(pg_catalog.<=) 300
+        OR SESSION_ID OPERATOR(pg_catalog.=) 'MASTER_SESSION_ID'
+        OR LAST_UPDATE_TIMESTAMP IS NULL
+      SQL
+
+      INSTANCE_IDENTITY_QUERY = <<~SQL
+        SELECT pg_catalog.aurora_db_instance_identifier() AS instance_id,
+               pg_catalog.aurora_db_instance_identifier() AS instance_name
+      SQL
+
+      WRITER_ID_QUERY = <<~SQL
+        SELECT SERVER_ID FROM pg_catalog.aurora_replica_status()
+        WHERE SESSION_ID OPERATOR(pg_catalog.=) 'MASTER_SESSION_ID'
+        AND SERVER_ID OPERATOR(pg_catalog.=) pg_catalog.aurora_db_instance_identifier()
+      SQL
+
+      BG_TOPOLOGY_EXISTS_QUERY = <<~SQL
+        SELECT 'pg_catalog.get_blue_green_fast_switchover_metadata'::pg_catalog.regproc
+      SQL
+
+      BG_STATUS_QUERY = <<~SQL.freeze
+        SELECT * FROM pg_catalog.get_blue_green_fast_switchover_metadata('aws_advanced_ruby_driver_wrapper-#{AwsAdvancedRubyDriverWrapper::VERSION}')
+      SQL
+
+      DIALECT_UPDATE_CANDIDATES = [
+        AwsAdvancedRubyDriverWrapper::DialectCodes::GLOBAL_AURORA_PG,
+        AwsAdvancedRubyDriverWrapper::DialectCodes::MULTI_AZ_PG_CLUSTER,
+        AwsAdvancedRubyDriverWrapper::DialectCodes::RDS_PG
+      ].freeze
+
+      def dialect?(connection)
+        return false unless super
+
+        begin
+          result = @driver_dialect.execute(connection, AURORA_UTILS_EXIST_QUERY)
+          return false unless result.any?
+          return false unless result.first['aurora_stat_utils'] == 't'
+        rescue StandardError
+          return false
+        end
+
+        result = @driver_dialect.execute(connection, TOPOLOGY_EXISTS_QUERY)
+        !result.nil? && result.any?
+      rescue StandardError
+        false
+      end
+
+      def dialect_update_candidates
+        DIALECT_UPDATE_CANDIDATES
+      end
+
+      def topology_query
+        TOPOLOGY_QUERY
+      end
+
+      def writer_id_query
+        WRITER_ID_QUERY
+      end
+
+      def blue_green_status_available?(connection)
+        result = @driver_dialect.execute(connection, BG_TOPOLOGY_EXISTS_QUERY)
+        !result.nil? && result.any?
+      rescue StandardError
+        false
+      end
+
+      def instance_identity(connection)
+        query_instance_identity(@driver_dialect, connection, INSTANCE_IDENTITY_QUERY)
+      end
+
+      def blue_green_status_query
+        BG_STATUS_QUERY
+      end
+
+      # @param service_container [Services::ServiceContainer]
+      # @return [Host::RdsHostListProvider] the host list provider
+      def create_host_list_provider(service_container)
+        require_relative '../utils/aurora_topology_utils'
+        require_relative '../host/rds_host_list_provider'
+        topology_utils = Utils::AuroraTopologyUtils.new(dialect: self)
+        Host::RdsHostListProvider.new(service_container:, topology_utils:)
+      end
+    end
+  end
+end

data/lib/aws_advanced_ruby_driver_wrapper/db_dialects/dialect_codes.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+#  Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+#  Licensed under the Apache License, Version 2.0 (the "License").
+#  You may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#  http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+
+module AwsAdvancedRubyDriverWrapper
+  module DialectCodes
+    # MySQL variants
+    GLOBAL_AURORA_MYSQL = 'global-aurora-mysql'
+    AURORA_MYSQL = 'aurora-mysql'
+    RDS_MYSQL = 'rds-mysql'
+    MYSQL = 'mysql'
+    # https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html
+    MULTI_AZ_MYSQL_CLUSTER = 'multi-az-mysql-cluster'
+
+    # PostgreSQL variants
+    GLOBAL_AURORA_PG = 'global-aurora-pg'
+    AURORA_PG = 'aurora-pg'
+    RDS_PG = 'rds-pg'
+    # https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html
+    MULTI_AZ_PG_CLUSTER = 'multi-az-pg-cluster'
+    PG = 'pg'
+
+    UNKNOWN = 'unknown'
+    CUSTOM = 'custom'
+  end
+end

data/lib/aws_advanced_ruby_driver_wrapper/db_dialects/global_mysql_dialect.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+#  Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+#  Licensed under the Apache License, Version 2.0 (the "License").
+#  You may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#  http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+
+require_relative 'aurora_mysql_dialect'
+require_relative 'utils/dialect_utils'
+
+module AwsAdvancedRubyDriverWrapper
+  module DbDialects
+    class GlobalMysqlDialect < AuroraMysqlDialect
+      GLOBAL_STATUS_TABLE_EXISTS_QUERY = <<~SQL
+        SELECT 1 AS tmp FROM information_schema.tables WHERE
+        upper(table_schema) = 'INFORMATION_SCHEMA' AND upper(table_name) = 'AURORA_GLOBAL_DB_STATUS'
+      SQL
+
+      GLOBAL_INSTANCE_STATUS_EXISTS_QUERY = <<~SQL
+        SELECT 1 AS tmp FROM information_schema.tables WHERE
+        upper(table_schema) = 'INFORMATION_SCHEMA' AND upper(table_name) = 'AURORA_GLOBAL_DB_INSTANCE_STATUS'
+      SQL
+
+      GLOBAL_TOPOLOGY_QUERY = <<~SQL
+        SELECT SERVER_ID AS instance_id,
+        CASE WHEN SESSION_ID = 'MASTER_SESSION_ID' THEN TRUE ELSE FALSE END AS is_writer,
+        VISIBILITY_LAG_IN_MSEC AS instance_lag,
+        AWS_REGION AS aws_region
+        FROM information_schema.aurora_global_db_instance_status
+      SQL
+
+      REGION_COUNT_QUERY = <<~SQL
+        SELECT count(1) FROM information_schema.aurora_global_db_status
+      SQL
+
+      REGION_BY_INSTANCE_ID_QUERY = <<~SQL
+        SELECT AWS_REGION FROM information_schema.aurora_global_db_instance_status WHERE SERVER_ID = ?
+      SQL
+
+      def dialect?(connection)
+        return false unless
+          check_existence_queries(@driver_dialect, connection, GLOBAL_STATUS_TABLE_EXISTS_QUERY, GLOBAL_INSTANCE_STATUS_EXISTS_QUERY)
+
+        begin
+          result = @driver_dialect.execute(connection, REGION_COUNT_QUERY)
+          return false unless result.any?
+
+          row = result.first
+          aws_region_count = row.values.first.to_i
+          aws_region_count > 1
+        rescue StandardError
+          false
+        end
+      end
+
+      def global?
+        true
+      end
+
+      def dialect_update_candidates
+        []
+      end
+
+      def topology_query
+        GLOBAL_TOPOLOGY_QUERY
+      end
+
+      def region_by_instance_id_query
+        REGION_BY_INSTANCE_ID_QUERY
+      end
+
+      # @param service_container [Services::ServiceContainer]
+      # @return [Host::GlobalAuroraHostListProvider] the host list provider
+      def create_host_list_provider(service_container)
+        require_relative '../utils/global_aurora_topology_utils'
+        require_relative '../host/global_aurora_host_list_provider'
+        topology_utils = Utils::GlobalAuroraTopologyUtils.new(dialect: self)
+        Host::GlobalAuroraHostListProvider.new(service_container:, topology_utils:)
+      end
+    end
+  end
+end

data/lib/aws_advanced_ruby_driver_wrapper/db_dialects/global_pg_dialect.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+#  Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+#  Licensed under the Apache License, Version 2.0 (the "License").
+#  You may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#  http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+
+require_relative 'aurora_pg_dialect'
+require_relative 'utils/dialect_utils'
+
+module AwsAdvancedRubyDriverWrapper
+  module DbDialects
+    class GlobalPgDialect < AuroraPgDialect
+      GLOBAL_STATUS_FUNC_EXISTS_QUERY = <<~SQL
+        SELECT 'pg_catalog.aurora_global_db_status'::pg_catalog.regproc
+      SQL
+
+      GLOBAL_INSTANCE_STATUS_FUNC_EXISTS_QUERY = <<~SQL
+        SELECT 'pg_catalog.aurora_global_db_instance_status'::pg_catalog.regproc
+      SQL
+
+      GLOBAL_TOPOLOGY_QUERY = <<~SQL
+        SELECT SERVER_ID AS instance_id,
+        CASE WHEN SESSION_ID OPERATOR(pg_catalog.=) 'MASTER_SESSION_ID' THEN TRUE ELSE FALSE END AS is_writer,
+        VISIBILITY_LAG_IN_MSEC AS instance_lag,
+        AWS_REGION AS aws_region
+        FROM pg_catalog.aurora_global_db_instance_status()
+      SQL
+
+      REGION_COUNT_QUERY = <<~SQL
+        SELECT pg_catalog.count(1) FROM pg_catalog.aurora_global_db_status()
+      SQL
+
+      REGION_BY_INSTANCE_ID_QUERY = <<~SQL
+        SELECT AWS_REGION FROM pg_catalog.aurora_global_db_instance_status() WHERE SERVER_ID OPERATOR(pg_catalog.=) $1
+      SQL
+
+      def dialect?(connection)
+        result = @driver_dialect.execute(connection, AURORA_UTILS_EXIST_QUERY)
+        return false unless result.any?
+
+        return false unless result.first['aurora_stat_utils'] == 't'
+
+        return false unless
+          check_existence_queries(@driver_dialect, connection, GLOBAL_STATUS_FUNC_EXISTS_QUERY, GLOBAL_INSTANCE_STATUS_FUNC_EXISTS_QUERY)
+
+        result = connection.exec(REGION_COUNT_QUERY)
+        return false unless result.any?
+
+        row = result.first
+        aws_region_count = row.is_a?(Hash) ? row.values.first.to_i : row[0].to_i
+        aws_region_count > 1
+      rescue StandardError
+        false
+      end
+
+      def global?
+        true
+      end
+
+      def dialect_update_candidates
+        []
+      end
+
+      def topology_query
+        GLOBAL_TOPOLOGY_QUERY
+      end
+
+      def region_by_instance_id_query
+        REGION_BY_INSTANCE_ID_QUERY
+      end
+
+      # @param service_container [Services::ServiceContainer]
+      # @return [Host::GlobalAuroraHostListProvider] the host list provider
+      def create_host_list_provider(service_container)
+        require_relative '../utils/global_aurora_topology_utils'
+        require_relative '../host/global_aurora_host_list_provider'
+        topology_utils = Utils::GlobalAuroraTopologyUtils.new(dialect: self)
+        Host::GlobalAuroraHostListProvider.new(service_container:, topology_utils:)
+      end
+    end
+  end
+end