fix(cloud-sql): Updated sample to include full JDBC url in comments. (GoogleCloudPlatform#3562)

shubha-rajan · web-flow · commit b594c489e91e · 2020-08-19T09:41:55.000-07:00
* added full jdbc url in cloud sql sample comments

* updated variable names and moved URL

* moved full JDBC url to before config options
diff --git a/cloud-sql/mysql/servlet/src/main/java/com/example/cloudsql/ConnectionPoolContextListener.java b/cloud-sql/mysql/servlet/src/main/java/com/example/cloudsql/ConnectionPoolContextListener.java
@@ -50,6 +50,12 @@ private DataSource createConnectionPool() {
     // The configuration object specifies behaviors for the connection pool.
     HikariConfig config = new HikariConfig();
 
+    // The following URL is equivalent to setting the config options below:
+    // jdbc:postgresql:///<DB_NAME>?cloudSqlInstance=<CLOUD_SQL_CONNECTION_NAME>&
+    // socketFactory=com.google.cloud.sql.postgres.SocketFactory&user=<DB_USER>&password=<DB_PASS>
+    // See the link below for more info on building a JDBC URL for the Cloud SQL JDBC Socket Factory
+    // https://github.com/GoogleCloudPlatform/cloud-sql-jdbc-socket-factory#creating-the-jdbc-url
+
     // Configure which instance and what database user to connect with.
     config.setJdbcUrl(String.format("jdbc:mysql:///%s", DB_NAME));
     config.setUsername(DB_USER); // e.g. "root", "postgres"
@@ -110,7 +116,7 @@ private void createTable(DataSource pool) throws SQLException {
           "CREATE TABLE IF NOT EXISTS votes ( "
               + "vote_id SERIAL NOT NULL, time_cast timestamp NOT NULL, candidate CHAR(6) NOT NULL,"
               + " PRIMARY KEY (vote_id) );";
-      try (PreparedStatement createTableStatement = conn.prepareStatement(stmt); ) {
+      try (PreparedStatement createTableStatement = conn.prepareStatement(stmt);) {
         createTableStatement.execute();
       }
     }
diff --git a/cloud-sql/postgres/servlet/src/main/java/com/example/cloudsql/ConnectionPoolContextListener.java b/cloud-sql/postgres/servlet/src/main/java/com/example/cloudsql/ConnectionPoolContextListener.java
@@ -50,6 +50,12 @@ private DataSource createConnectionPool() {
     // The configuration object specifies behaviors for the connection pool.
     HikariConfig config = new HikariConfig();
 
+    // The following URL is equivalent to setting the config options below:
+    // jdbc:postgresql:///<DB_NAME>?cloudSqlInstance=<CLOUD_SQL_CONNECTION_NAME>&
+    // socketFactory=com.google.cloud.sql.postgres.SocketFactory&user=<DB_USER>&password=<DB_PASS>
+    // See the link below for more info on building a JDBC URL for the Cloud SQL JDBC Socket Factory
+    // https://github.com/GoogleCloudPlatform/cloud-sql-jdbc-socket-factory#creating-the-jdbc-url
+
     // Configure which instance and what database user to connect with.
     config.setJdbcUrl(String.format("jdbc:postgresql:///%s", DB_NAME));
     config.setUsername(DB_USER); // e.g. "root", "postgres"
@@ -60,6 +66,8 @@ private DataSource createConnectionPool() {
     config.addDataSourceProperty("socketFactory", "com.google.cloud.sql.postgres.SocketFactory");
     config.addDataSourceProperty("cloudSqlInstance", CLOUD_SQL_CONNECTION_NAME);
 
+
+
     // ... Specify additional connection properties here.
     // [START_EXCLUDE]
 
@@ -110,7 +118,7 @@ private void createTable(DataSource pool) throws SQLException {
           "CREATE TABLE IF NOT EXISTS votes ( "
               + "vote_id SERIAL NOT NULL, time_cast timestamp NOT NULL, candidate CHAR(6) NOT NULL,"
               + " PRIMARY KEY (vote_id) );";
-      try (PreparedStatement createTableStatement = conn.prepareStatement(stmt); ) {
+      try (PreparedStatement createTableStatement = conn.prepareStatement(stmt);) {
         createTableStatement.execute();
       }
     }
