Skip to content

Commit f5f95c5

Browse files
committed
docs: Update documentation to describe how to use Advanced DR write endpoint.
1 parent 0a5f9fd commit f5f95c5

File tree

4 files changed

+282
-48
lines changed

4 files changed

+282
-48
lines changed

README.md

Lines changed: 18 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -444,13 +444,26 @@ variables. Here is a quick reference to supported values and their effect:
444444
- `GOOGLE_CLOUD_QUOTA_PROJECT`: Used to set a custom quota project to Cloud SQL
445445
APIs when defined.
446446

447-
## Using DNS domain names to identify instances
447+
### Using Advanced Disaster Recovery and DNS domain names to identify instances
448448

449-
The connector can be configured to use DNS to look up an instance. This would
450-
allow you to configure your application to connect to a database instance, and
451-
centrally configure which instance in your DNS zone.
449+
The connector can be configured to use DNS to look up an instance.
450+
Use a DNS name managed by Cloud SQL [Advanced Disaster Recovery](https://docs.cloud.google.com/sql/docs/mysql/use-advanced-disaster-recovery),
451+
or a domain name that you manage.
452452

453-
### Configure your DNS Records
453+
### Using Advanced Recovery Write Endpoint DNS Name
454+
455+
[Advanced Disaster Recovery](https://docs.cloud.google.com/sql/docs/mysql/use-advanced-disaster-recovery)
456+
creates geographically distributed replicas of your Cloud SQL database instance. When you perform
457+
switchover or failover on the database instance, the connector will gracefully disconnect from the
458+
old primary instance and reconnect to the new primary instance.
459+
460+
Follow the instructions in [Connect using Write Endpoint](https://docs.cloud.google.com/sql/docs/mysql/connect-to-instance-using-write-endpoint)
461+
to get the write endpoint DNS name for your primary instance. Then, use this write endpoint DNS
462+
name to configure the connector.
463+
464+
#### Configure your DNS Records
465+
466+
The connector may be configured to use DNS that you define as well.
454467

455468
Add a DNS TXT record for the Cloud SQL instance to a **private** DNS server
456469
or a private Google Cloud DNS Zone used by your application.

package-lock.json

Lines changed: 76 additions & 36 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -58,10 +58,10 @@
5858
},
5959
"devDependencies": {
6060
"@prisma/client": "^5.22.0",
61-
"@sequelize/core": "^7.0.0-alpha.29",
62-
"@sequelize/mssql": "^7.0.0-alpha.29",
63-
"@sequelize/mysql": "^7.0.0-alpha.29",
64-
"@sequelize/postgres": "^7.0.0-alpha.29",
61+
"@sequelize/core": "^7.0.0-alpha.46",
62+
"@sequelize/mssql": "^7.0.0-alpha.46",
63+
"@sequelize/mysql": "^7.0.0-alpha.46",
64+
"@sequelize/postgres": "^7.0.0-alpha.46",
6565
"@types/node": "^22.18.8",
6666
"@types/pg": "^8.15.5",
6767
"@types/tap": "^18.0.0",
@@ -70,7 +70,7 @@
7070
"eslint-plugin-prettier": "^5.5.4",
7171
"gts": "^5.3.1",
7272
"knex": "^3.1.0",
73-
"mssql": "^11.0.1",
73+
"mssql": "^12.0.0",
7474
"mysql2": "^3.15.2",
7575
"nock": "^14.0.10",
7676
"pg": "^8.16.3",
@@ -88,10 +88,10 @@
8888
"url": "git+https://github.com/GoogleCloudPlatform/cloud-sql-nodejs-connector"
8989
},
9090
"dependencies": {
91-
"@googleapis/sqladmin": "^31.1.0",
91+
"@googleapis/sqladmin": "^33.0.0",
9292
"gaxios": "^7.1.2",
9393
"google-auth-library": "^10.4.0",
94-
"p-throttle": "^7.0.0"
94+
"p-throttle": "^8.0.0"
9595
},
9696
"overrides": {
9797
"make-fetch-happen": "12.0.0"

0 commit comments

Comments
 (0)