samples(spanner): add sample for Proto columns

samples/install-without-bom/pom.xml

@@ -107,6 +107,11 @@
 
   <!-- compile and run all snippet tests -->
   <build>
+    <resources>
+      <resource>
+        <directory>../snippets/src/main/resources</directory>
+      </resource>
+    </resources>
     <plugins>
       <plugin>
         <groupId>org.codehaus.mojo</groupId>

samples/snapshot/pom.xml

@@ -106,6 +106,11 @@
 
   <!-- compile and run all snippet tests -->
   <build>
+    <resources>
+      <resource>
+        <directory>../snippets/src/main/resources</directory>
+      </resource>
+    </resources>
     <plugins>
       <plugin>
         <groupId>org.codehaus.mojo</groupId>

samples/snippets/pom.xml

@@ -189,6 +189,15 @@
           </systemPropertyVariables>
         </configuration>
       </plugin>
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-checkstyle-plugin</artifactId>
+        <version>3.3.1</version>
+        <configuration>
+          <!-- exclude protoc generated file from checkstyle validation -->
+          <excludes>**/SingerProto.java</excludes>
+        </configuration>
+      </plugin>
     </plugins>
   </build>
 </project>

samples/snippets/src/main/java/com/example/spanner/AddProtoColumnSample.java

@@ -0,0 +1,76 @@
+/*
+ * Copyright 2024 Google Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.example.spanner;
+
+// [START spanner_add_proto_type_columns]
+
+import com.google.cloud.spanner.Spanner;
+import com.google.cloud.spanner.SpannerOptions;
+import com.google.cloud.spanner.admin.database.v1.DatabaseAdminClient;
+import com.google.common.collect.ImmutableList;
+import com.google.protobuf.ByteString;
+import com.google.spanner.admin.database.v1.DatabaseName;
+import com.google.spanner.admin.database.v1.UpdateDatabaseDdlRequest;
+import java.io.IOException;
+import java.io.InputStream;
+import java.util.concurrent.ExecutionException;
+
+class AddProtoColumnSample {
+
+  static void addProtoColumn() throws InterruptedException, ExecutionException, IOException {
+    // TODO(developer): Replace these variables before running the sample.
+    String projectId = "my-project";
+    String instanceId = "my-instance";
+    String databaseId = "my-database";
+
+    addProtoColumn(projectId, instanceId, databaseId);
+  }
+
+  static void addProtoColumn(String projectId, String instanceId, String databaseId)
+      throws InterruptedException, ExecutionException, IOException {
+    InputStream in =
+        AddProtoColumnSample.class
+            .getClassLoader()
+            .getResourceAsStream("com/example/spanner/descriptors.pb");
+    try (Spanner spanner =
+            SpannerOptions.newBuilder().setProjectId(projectId).build().getService();
+        DatabaseAdminClient databaseAdminClient = spanner.createDatabaseAdminClient()) {
+      UpdateDatabaseDdlRequest request =
+          UpdateDatabaseDdlRequest.newBuilder()
+              .setDatabase(DatabaseName.of(projectId, instanceId, databaseId).toString())
+              .addAllStatements(
+                  ImmutableList.of(
+                      "CREATE PROTO BUNDLE ("
+                          + "examples.spanner.music.SingerInfo,"
+                          + "examples.spanner.music.Genre,"
+                          + ")",
+                      "ALTER TABLE Singers ADD COLUMN SingerInfo examples.spanner.music.SingerInfo",
+                      "ALTER TABLE Singers ADD COLUMN "
+                          + "SingerInfoArray ARRAY<examples.spanner.music.SingerInfo>",
+                      "ALTER TABLE Singers ADD COLUMN SingerGenre examples.spanner.music.Genre",
+                      "ALTER TABLE Singers ADD COLUMN "
+                          + "SingerGenreArray ARRAY<examples.spanner.music.Genre>"))
+              .setProtoDescriptors(ByteString.readFrom(in))
+              .build();
+      // Wait for the operation to finish.
+      // This will throw an ExecutionException if the operation fails.
+      databaseAdminClient.updateDatabaseDdlAsync(request).get();
+      System.out.printf("Added Proto columns %n");
+    }
+  }
+}
+// [END spanner_add_proto_type_columns]

samples/snippets/src/main/java/com/example/spanner/QueryWithProtoParameterSample.java

@@ -0,0 +1,70 @@
+/*
+ * Copyright 2024 Google Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.example.spanner;
+
+// [START spanner_query_with_proto_types_parameter]
+import com.example.spanner.SingerProto.Genre;
+import com.example.spanner.SingerProto.SingerInfo;
+import com.google.cloud.spanner.DatabaseClient;
+import com.google.cloud.spanner.DatabaseId;
+import com.google.cloud.spanner.ResultSet;
+import com.google.cloud.spanner.Spanner;
+import com.google.cloud.spanner.SpannerOptions;
+import com.google.cloud.spanner.Statement;
+
+class QueryWithProtoParameterSample {
+
+  static void queryWithProtoParameter() {
+    // TODO(developer): Replace these variables before running the sample.
+    String projectId = "my-project";
+    String instanceId = "my-instance";
+    String databaseId = "my-database";
+
+    try (Spanner spanner =
+        SpannerOptions.newBuilder().setProjectId(projectId).build().getService()) {
+      DatabaseClient client =
+          spanner.getDatabaseClient(DatabaseId.of(projectId, instanceId, databaseId));
+      queryWithProtoParameter(client);
+    }
+  }
+
+  static void queryWithProtoParameter(DatabaseClient client) {
+    Statement statement =
+        Statement.newBuilder(
+                "SELECT SingerId, SingerInfo, SingerInfo.nationality, SingerInfoArray, "
+                    + "SingerGenre, SingerGenreArray FROM Singers "
+                    + "WHERE SingerInfo.nationality=@country and SingerGenre=@singerGenre")
+            .bind("country")
+            .to("Country2")
+            .bind("singerGenre")
+            .to(Genre.FOLK)
+            .build();
+    try (ResultSet resultSet = client.singleUse().executeQuery(statement)) {
+      while (resultSet.next()) {
+        System.out.printf(
+            "%d %s %s %s %s %s%n",
+            resultSet.getLong("SingerId"),
+            resultSet.getProtoMessage("SingerInfo", SingerInfo.getDefaultInstance()),
+            resultSet.getString("nationality"),
+            resultSet.getProtoMessageList("SingerInfoArray", SingerInfo.getDefaultInstance()),
+            resultSet.getProtoEnum("SingerGenre", Genre::forNumber),
+            resultSet.getProtoEnumList("SingerGenreArray", Genre::forNumber));
+      }
+    }
+  }
+}
+// [END spanner_query_with_proto_types_parameter]