Rename CLOUD_SQL_CONNECTION_NAME to INSTANCE_CONNECTION_NAME (GoogleCloudPlatform#1552)

Author: jsimonweb

cloud_sql/mysql/pdo/README.md

@@ -50,7 +50,7 @@ Use these terminal commands to initialize other environment variables as well:
 
 ```bash
 export GOOGLE_APPLICATION_CREDENTIALS=/path/to/service/account/key.json
-export CLOUD_SQL_CONNECTION_NAME='<MY-PROJECT>:<INSTANCE-REGION>:<INSTANCE-NAME>'
+export INSTANCE_CONNECTION_NAME='<MY-PROJECT>:<INSTANCE-REGION>:<INSTANCE-NAME>'
 export DB_USER='<DB_USER_NAME>'
 export DB_PASS='<DB_PASSWORD>'
 export DB_NAME='<DB_NAME>'
@@ -64,7 +64,7 @@ safe.
 Then use the following command to launch the proxy in the background:
 
 ```bash
-./cloud_sql_proxy -dir=$DB_SOCKET_DIR --instances=$CLOUD_SQL_CONNECTION_NAME --credential_file=$GOOGLE_APPLICATION_CREDENTIALS &
+./cloud_sql_proxy -dir=$DB_SOCKET_DIR --instances=$INSTANCE_CONNECTION_NAME --credential_file=$GOOGLE_APPLICATION_CREDENTIALS &
 ```
 
 ### TCP mode
@@ -76,7 +76,7 @@ Use these terminal commands to initialize environment variables:
 
 ```bash
 export GOOGLE_APPLICATION_CREDENTIALS=/path/to/service/account/key.json
-export CLOUD_SQL_CONNECTION_NAME='<MY-PROJECT>:<INSTANCE-REGION>:<INSTANCE-NAME>'
+export INSTANCE_CONNECTION_NAME='<MY-PROJECT>:<INSTANCE-REGION>:<INSTANCE-NAME>'
 export DB_HOST='127.0.0.1'
 export DB_USER='<DB_USER_NAME>'
 export DB_PASS='<DB_PASSWORD>'
@@ -91,7 +91,7 @@ safe.
 Then use the following command to launch the proxy in the background:
 
 ```bash
-./cloud_sql_proxy -instances=$CLOUD_SQL_CONNECTION_NAME=tcp:3306 -credential_file=$GOOGLE_APPLICAITON_CREDENTIALS &
+./cloud_sql_proxy -instances=$INSTANCE_CONNECTION_NAME=tcp:3306 -credential_file=$GOOGLE_APPLICAITON_CREDENTIALS &
 ```
 
 #### Windows/PowerShell

cloud_sql/mysql/pdo/app.flex.yaml

@@ -19,7 +19,7 @@ env: flex
 # something like https://cloud.google.com/secret-manager/ to help keep secrets
 # secret.
 env_variables:
-  CLOUD_SQL_CONNECTION_NAME: "<MY-PROJECT>:<INSTANCE-REGION>:<INSTANCE-NAME>"
+  INSTANCE_CONNECTION_NAME: "<MY-PROJECT>:<INSTANCE-REGION>:<INSTANCE-NAME>"
   DB_USER: my-db-user
   DB_PASS: my-db-pass
   DB_NAME: my-db

cloud_sql/mysql/pdo/app.standard.yaml

@@ -17,7 +17,7 @@ runtime: php74
 # Remember - storing secrets in plaintext is potentially unsafe. Consider using
 # something like https://cloud.google.com/secret-manager/ to help keep secrets secret.
 env_variables:
-  CLOUD_SQL_CONNECTION_NAME: <MY-PROJECT>:<INSTANCE-REGION>:<MY-DATABASE>
+  INSTANCE_CONNECTION_NAME: <MY-PROJECT>:<INSTANCE-REGION>:<INSTANCE-NAME>
   DB_USER: my-db-user
   DB_PASS: my-db-pass
   DB_NAME: my-db

cloud_sql/mysql/pdo/src/DBInitializer.php

@@ -104,7 +104,7 @@ public static function initUnixDatabaseConnection(
             // $username = 'your_db_user';
             // $password = 'yoursupersecretpassword';
             // $dbName = 'your_db_name';
-            // $connectionName = getenv("CLOUD_SQL_CONNECTION_NAME");
+            // $connectionName = getenv("INSTANCE_CONNECTION_NAME");
             // $socketDir = getenv('DB_SOCKET_DIR') ?: '/cloudsql';
 
             // Connect using UNIX sockets

cloud_sql/postgres/pdo/README.md

@@ -52,7 +52,7 @@ Use these terminal commands to initialize other environment variables as well:
 
 ```bash
 export GOOGLE_APPLICATION_CREDENTIALS=/path/to/service/account/key.json
-export CLOUD_SQL_CONNECTION_NAME='<MY-PROJECT>:<INSTANCE-REGION>:<INSTANCE-NAME>'
+export INSTANCE_CONNECTION_NAME='<MY-PROJECT>:<INSTANCE-REGION>:<INSTANCE-NAME>'
 export DB_USER='<DB_USER_NAME>'
 export DB_PASS='<DB_PASSWORD>'
 export DB_NAME='<DB_NAME>'
@@ -66,7 +66,7 @@ safe.
 Then use the following command to launch the proxy in the background:
 
 ```bash
-./cloud_sql_proxy -dir=$DB_SOCKET_DIR --instances=$CLOUD_SQL_CONNECTION_NAME --credential_file=$GOOGLE_APPLICATION_CREDENTIALS &
+./cloud_sql_proxy -dir=$DB_SOCKET_DIR --instances=$INSTANCE_CONNECTION_NAME --credential_file=$GOOGLE_APPLICATION_CREDENTIALS &
 ```
 
 ### TCP mode
@@ -80,7 +80,7 @@ Use these terminal commands to initalie environment variables:
 
 ```bash
 export GOOGLE_APPLICATION_CREDENTIALS=/path/to/service/account/key.json
-export CLOUD_SQL_CONNECTION_NAME='<MY-PROJECT>:<INSTANCE-REGION>:<INSTANCE-NAME>'
+export INSTANCE_CONNECTION_NAME='<MY-PROJECT>:<INSTANCE-REGION>:<INSTANCE-NAME>'
 export DB_HOST='127.0.0.1'
 export DB_USER='<DB_USER_NAME>'
 export DB_PASS='<DB_PASSWORD>'
@@ -95,7 +95,7 @@ safe.
 Then use the following command to launch the proxy in the background:
 
 ```bash
-./cloud_sql_proxy -instances=$CLOUD_SQL_CONNECTION_NAME=tcp:5432 -credential_file=$GOOGLE_APPLICAITON_CREDENTIALS &
+./cloud_sql_proxy -instances=$INSTANCE_CONNECTION_NAME=tcp:5432 -credential_file=$GOOGLE_APPLICAITON_CREDENTIALS &
 ```
 
 #### Windows/PowerShell

cloud_sql/postgres/pdo/app.flex.yaml

@@ -19,7 +19,7 @@ env: flex
 # something like https://cloud.google.com/secret-manager/ to help keep secrets
 # secret.
 env_variables:
-  CLOUD_SQL_CONNECTION_NAME: "<MY-PROJECT>:<INSTANCE-REGION>:<INSTANCE-NAME>"
+  INSTANCE_CONNECTION_NAME: "<MY-PROJECT>:<INSTANCE-REGION>:<INSTANCE-NAME>"
   DB_USER: my-db-user
   DB_PASS: my-db-pass
   DB_NAME: my-db

cloud_sql/postgres/pdo/app.standard.yaml

@@ -17,7 +17,7 @@ runtime: php74
 # Remember - storing secrets in plaintext is potentially unsafe. Consider using
 # something like https://cloud.google.com/secret-manager/ to help keep secrets secret.
 env_variables:
-  CLOUD_SQL_CONNECTION_NAME: <MY-PROJECT>:<INSTANCE-REGION>:<INSTANCE-NAME>
+  INSTANCE_CONNECTION_NAME: <MY-PROJECT>:<INSTANCE-REGION>:<INSTANCE-NAME>
   DB_USER: my-db-user
   DB_PASS: my-db-pass
   DB_NAME: my-db

cloud_sql/postgres/pdo/src/DBInitializer.php

@@ -58,7 +58,7 @@ public static function initTcpDatabaseConnection(
                 sprintf(
                     'Invalid or missing configuration! Make sure you have set ' .
                     '$username, $password, $dbName, and $host (for TCP mode) ' .
-                    'or $cloud_sql_connection_name (for UNIX socket mode). ' .
+                    'or $connectionName (for UNIX socket mode). ' .
                     'The PHP error was %s',
                     $e->getMessage()
                 ),
@@ -104,7 +104,7 @@ public static function initUnixDatabaseConnection(
             // $username = 'your_db_user';
             // $password = 'yoursupersecretpassword';
             // $dbName = 'your_db_name';
-            // $connectionName = getenv("CLOUD_SQL_CONNECTION_NAME");
+            // $connectionName = getenv("INSTANCE_CONNECTION_NAME");
             // $socketDir = getenv('DB_SOCKET_DIR') ?: '/cloudsql';
 
             // Connect using UNIX sockets

cloud_sql/sqlserver/pdo/README.md

@@ -21,7 +21,7 @@ export GOOGLE_APPLICATION_CREDENTIALS=/path/to/service/account/key.json
 To run the Cloud SQL proxy, you need to set the instance connection name. See the instructions [here](https://cloud.google.com/sql/docs/sqlserver/quickstart-proxy-test#get_the_instance_connection_name) for finding the instance connection name.
 
 ```bash
-export CLOUD_SQL_CONNECTION_NAME='<MY-PROJECT>:<INSTANCE-REGION>:<INSTANCE-NAME>'
+export INSTANCE_CONNECTION_NAME='<MY-PROJECT>:<INSTANCE-REGION>:<INSTANCE-NAME>'
 ```
 
 Once the proxy is ready, use one of the following commands to start the proxy in the background.
@@ -30,7 +30,7 @@ You may connect to your instance via TCP. To connect via TCP, you must provide a
 
 ```bash
 $ ./cloud_sql_proxy \
-    --instances=$CLOUD_SQL_CONNECTION_NAME=tcp:1433 \
+    --instances=$INSTANCE_CONNECTION_NAME=tcp:1433 \
     --credential_file=$GOOGLE_APPLICATION_CREDENTIALS
 ```
 

cloud_sql/sqlserver/pdo/src/DBInitializer.php

@@ -56,8 +56,7 @@ public static function initTcpDatabaseConnection(
             throw new RuntimeException(
                 sprintf(
                     'Invalid or missing configuration! Make sure you have set ' .
-                    '$username, $password, $dbName, and $dbHost (for TCP mode) ' .
-                    'or $cloud_sql_connection_name (for UNIX socket mode). ' .
+                    '$username, $password, $dbName, and $dbHost (for TCP mode).' .
                     'The PHP error was %s',
                     $e->getMessage()
                 ),