From 51aebda6bc59e7c8c2147722a01ca191b33480e8 Mon Sep 17 00:00:00 2001 From: Jonathan Hess Date: Tue, 4 Nov 2025 18:02:13 -0700 Subject: [PATCH] docs: Update documentation to describe how to use Advanced DR write endpoint. --- README.md | 21 +++++++++++++++++---- 1 file changed, 17 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 9bea3d6d..d6921425 100644 --- a/README.md +++ b/README.md @@ -348,14 +348,27 @@ conn = connector.connect( ) ``` -### Using DNS domain names to identify instances +### Using Advanced Disaster Recovery and DNS domain names to identify instances -The connector can be configured to use DNS to look up an instance. This would -allow you to configure your application to connect to a database instance, and -centrally configure which instance in your DNS zone. +The connector can be configured to use DNS to look up an instance. +Use a DNS name managed by Cloud SQL [Advanced Disaster Recovery](https://docs.cloud.google.com/sql/docs/mysql/use-advanced-disaster-recovery), +or a domain name that you manage. + +#### Using Advanced Recovery Write Endpoint DNS Name + +[Advanced Disaster Recovery](https://docs.cloud.google.com/sql/docs/mysql/use-advanced-disaster-recovery) +creates geographically distributed replicas of your Cloud SQL database instance. When you perform +switchover or failover on the database instance, the connector will gracefully disconnect from the +old primary instance and reconnect to the new primary instance. + +Follow the instructions in [Connect using Write Endpoint](https://docs.cloud.google.com/sql/docs/mysql/connect-to-instance-using-write-endpoint) +to get the write endpoint DNS name for your primary instance. Then, use this write endpoint DNS +name to configure the connector. #### Configure your DNS Records +The connector may be configured to use DNS that you define as well. + Add a DNS TXT record for the Cloud SQL instance to a **private** DNS server or a private Google Cloud DNS Zone used by your application.