chore(cloud-sql): cleanup pg/knex example comments

ruyadorno · ruyadorno · commit 329d9cafd4ab · 2023-06-27T12:34:20.000-04:00
Just cleaning up a couple of the sample comments to make sure it propertly mentions the `INSTANCE_CONNECTION_NAME` environment variable name and uses an IAM username in examples that is similar to the usernames used by Posgtres Cloud SQL Instances. Ref: GoogleCloudPlatform#3266
diff --git a/cloud-sql/postgres/knex/connect-connector-with-iam-authn.js b/cloud-sql/postgres/knex/connect-connector-with-iam-authn.js
@@ -42,7 +42,7 @@ const connectWithConnectorAutoIAMAuthn = async config => {
     client: 'pg',
     connection: {
       ...clientOpts,
-      user: process.env.IAM_DB_USER, // e.g. 'service-account-name'
+      user: process.env.IAM_DB_USER, // e.g. 'sa-name@project-id.iam'
       database: process.env.DB_NAME, // e.g. 'my-database'
     },
     // ... Specify additional properties here.
diff --git a/cloud-sql/postgres/knex/index.js b/cloud-sql/postgres/knex/index.js
@@ -119,7 +119,8 @@ const createPool = async () => {
     }
   }
   if (process.env.INSTANCE_CONNECTION_NAME) {
-    // Uses the Cloud SQL Node.js Connector (e.g., project:region:instance) is defined
+    // Uses the Cloud SQL Node.js Connector when INSTANCE_CONNECTION_NAME
+    // (e.g., project:region:instance) is defined
     return createConnectorPool(config);
   } else if (process.env.INSTANCE_HOST) {
     // Use a TCP socket when INSTANCE_HOST (e.g., 127.0.0.1) is defined

Original file line number	Diff line number	Diff line change
`@@ -119,7 +119,8 @@ const createPool = async () => {`
`119`	`119`	`}`
`120`	`120`	`}`
`121`	`121`	`if (process.env.INSTANCE_CONNECTION_NAME) {`
`122`		`- // Uses the Cloud SQL Node.js Connector (e.g., project:region:instance) is defined`
	`122`	`+ // Uses the Cloud SQL Node.js Connector when INSTANCE_CONNECTION_NAME`
	`123`	`+ // (e.g., project:region:instance) is defined`
`123`	`124`	`return createConnectorPool(config);`
`124`	`125`	`} else if (process.env.INSTANCE_HOST) {`
`125`	`126`	`// Use a TCP socket when INSTANCE_HOST (e.g., 127.0.0.1) is defined`