feat: foreign key on delete cascade

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

@@ -0,0 +1,66 @@
+/*
+ * Copyright 2020 Google LLC
+ *
+ * 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_alter_table_with_foreign_key_delete_cascade]
+import com.google.api.gax.longrunning.OperationFuture;
+import com.google.cloud.spanner.DatabaseAdminClient;
+import com.google.cloud.spanner.Instance;
+import com.google.cloud.spanner.InstanceAdminClient;
+import com.google.cloud.spanner.InstanceConfigId;
+import com.google.cloud.spanner.InstanceId;
+import com.google.cloud.spanner.InstanceInfo;
+import com.google.cloud.spanner.Spanner;
+import com.google.cloud.spanner.SpannerOptions;
+import com.google.common.collect.ImmutableList;
+import com.google.spanner.admin.database.v1.UpdateDatabaseDdlMetadata;
+import com.google.spanner.admin.instance.v1.CreateInstanceMetadata;
+import java.util.concurrent.ExecutionException;
+
+class AlterTableWithForeignKeyDeleteCascadeSample {
+
+  static void alterForeignKeyDeleteCascadeConstraint() {
+    // 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()) {
+      DatabaseAdminClient adminClient = spanner.getDatabaseAdminClient();
+      alterForeignKeyDeleteCascadeConstraint(adminClient, instanceId, databaseId);
+    }
+  }
+
+  static void alterForeignKeyDeleteCascadeConstraint(
+      DatabaseAdminClient adminClient, String instanceId, String databaseId) {
+    adminClient.updateDatabaseDdl(
+            instanceId,
+            databaseId,
+            ImmutableList.of("ALTER TABLE ShoppingCarts\n"
+                + "              ADD CONSTRAINT FKShoppingCartsCustomerName\n"
+                + "              FOREIGN KEY (CustomerName)\n"
+                + "              REFERENCES Customers(CustomerName)\n"
+                + "              ON DELETE CASCADE\n"),
+            null);
+
+    System.out.printf(String.format("Altered ShoppingCarts table with FKShoppingCartsCustomerName\n"
+        + "foreign key constraint on database %s on instance %s", databaseId, instanceId));
+
+  }
+}
+// [END spanner_alter_table_with_foreign_key_delete_cascade]

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

@@ -0,0 +1,70 @@
+/*
+ * Copyright 2020 Google LLC
+ *
+ * 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_create_table_with_foreign_key_delete_cascade]
+import com.google.api.gax.longrunning.OperationFuture;
+import com.google.cloud.spanner.DatabaseAdminClient;
+import com.google.cloud.spanner.Instance;
+import com.google.cloud.spanner.InstanceAdminClient;
+import com.google.cloud.spanner.InstanceConfigId;
+import com.google.cloud.spanner.InstanceId;
+import com.google.cloud.spanner.InstanceInfo;
+import com.google.cloud.spanner.Spanner;
+import com.google.cloud.spanner.SpannerOptions;
+import com.google.common.collect.ImmutableList;
+import com.google.spanner.admin.instance.v1.CreateInstanceMetadata;
+import java.util.concurrent.ExecutionException;
+
+class CreateTableWithForeignKeyDeleteCascadeSample {
+
+  static void createForeignKeyDeleteCascadeConstraint() {
+    // 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()) {
+      DatabaseAdminClient adminClient = spanner.getDatabaseAdminClient();
+      createForeignKeyDeleteCascadeConstraint(adminClient, instanceId, databaseId);
+    }
+  }
+
+  static void createForeignKeyDeleteCascadeConstraint(
+      DatabaseAdminClient adminClient, String instanceId, String databaseId) {
+    adminClient.updateDatabaseDdl(
+        instanceId,
+        databaseId,
+        ImmutableList.of("CREATE TABLE Customers (\n"
+            + "              CustomerId INT64 NOT NULL,\n"
+            + "              CustomerName STRING(62) NOT NULL,\n"
+            + "              ) PRIMARY KEY (CustomerId)",
+            "CREATE TABLE ShoppingCarts (\n"
+                + "              CartId INT64 NOT NULL,\n"
+                + "              CustomerId INT64 NOT NULL,\n"
+                + "              CustomerName STRING(62) NOT NULL,\n"
+                + "              CONSTRAINT FKShoppingCartsCustomerId FOREIGN KEY (CustomerId)\n"
+                + "              REFERENCES Customers (CustomerId) ON DELETE CASCADE\n"
+                + "              ) PRIMARY KEY (CartId)\n"),
+        null);
+
+    System.out.printf(String.format("Created Customers and ShoppingCarts table with FKShoppingCartsCustomerId\n"
+        + "foreign key constraint on database %s on instance %s\n", databaseId, instanceId));
+  }
+}
+// [END spanner_create_table_with_foreign_key_delete_cascade]

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

@@ -0,0 +1,62 @@
+/*
+ * Copyright 2020 Google LLC
+ *
+ * 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_drop_foreign_key_constraint_delete_cascade]
+import com.google.api.gax.longrunning.OperationFuture;
+import com.google.cloud.spanner.DatabaseAdminClient;
+import com.google.cloud.spanner.Instance;
+import com.google.cloud.spanner.InstanceAdminClient;
+import com.google.cloud.spanner.InstanceConfigId;
+import com.google.cloud.spanner.InstanceId;
+import com.google.cloud.spanner.InstanceInfo;
+import com.google.cloud.spanner.Spanner;
+import com.google.cloud.spanner.SpannerOptions;
+import com.google.common.collect.ImmutableList;
+import com.google.spanner.admin.instance.v1.CreateInstanceMetadata;
+import java.util.concurrent.ExecutionException;
+
+class DropForeignKeyConstraintDeleteCascadeSample {
+
+  static void deleteForeignKeyDeleteCascadeConstraint() {
+    // 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()) {
+      DatabaseAdminClient adminClient = spanner.getDatabaseAdminClient();
+      deleteForeignKeyDeleteCascadeConstraint(adminClient, instanceId, databaseId);
+    }
+  }
+
+  static void deleteForeignKeyDeleteCascadeConstraint(
+      DatabaseAdminClient adminClient, String instanceId, String databaseId) {
+    adminClient.updateDatabaseDdl(
+        instanceId,
+        databaseId,
+        ImmutableList.of("ALTER TABLE ShoppingCarts\n"
+            + "              DROP CONSTRAINT FKShoppingCartsCustomerName\n"),
+        null);
+
+    System.out.printf(String.format("Altered ShoppingCarts table to drop FKShoppingCartsCustomerName\n"
+        + "foreign key constraint on database %s on instance %s\n", databaseId, instanceId));
+
+  }
+}
+// [END spanner_drop_foreign_key_constraint_delete_cascade]

samples/snippets/src/test/java/com/example/spanner/AlterTableWithForeignKeyDeleteCascadeSampleIT.java

@@ -0,0 +1,41 @@
+package com.example.spanner;
+
+import static org.junit.Assert.assertTrue;
+
+import java.util.Arrays;
+import java.util.concurrent.TimeUnit;
+import org.junit.Test;
+
+public class AlterTableWithForeignKeyDeleteCascadeSampleIT extends SampleTestBase {
+
+  @Test
+  public void testAlterTableWithForeignKeyDeleteCascade() throws Exception {
+
+    // Creates database
+    final String databaseId = idGenerator.generateDatabaseId();
+    databaseAdminClient.createDatabase(instanceId, databaseId, Arrays.asList("CREATE TABLE Customers (\n"
+            + "              CustomerId INT64 NOT NULL,\n"
+            + "              CustomerName STRING(62) NOT NULL,\n"
+            + "              ) PRIMARY KEY (CustomerId)",
+        "CREATE TABLE ShoppingCarts (\n"
+            + "              CartId INT64 NOT NULL,\n"
+            + "              CustomerId INT64 NOT NULL,\n"
+            + "              CustomerName STRING(62) NOT NULL,\n"
+            + "              CONSTRAINT FKShoppingCartsCustomerId FOREIGN KEY (CustomerId)\n"
+            + "              REFERENCES Customers (CustomerId) ON DELETE CASCADE\n"
+            + "              ) PRIMARY KEY (CartId)\n")
+    ).get(5, TimeUnit.MINUTES);
+
+    // Runs sample
+    final String out = SampleRunner.runSample(() -> AlterTableWithForeignKeyDeleteCascadeSample
+        .alterForeignKeyDeleteCascadeConstraint(databaseAdminClient, instanceId, databaseId)
+    );
+
+    assertTrue(
+        "Expected to have created database " + databaseId + " with tables containing "
+            + "foreign key constraints.", out.contains("Altered ShoppingCarts table "
+            + "with FKShoppingCartsCustomerName"
+        )
+    );
+  }
+}

samples/snippets/src/test/java/com/example/spanner/CreateTableWithForeignKeyDeleteCascadeSampleIT.java

@@ -0,0 +1,31 @@
+package com.example.spanner;
+
+import static org.junit.Assert.assertTrue;
+
+import java.util.Arrays;
+import java.util.concurrent.TimeUnit;
+import org.junit.Test;
+
+public class CreateTableWithForeignKeyDeleteCascadeSampleIT extends SampleTestBase {
+
+  @Test
+  public void testCreateTableWithForeignKeyDeleteCascade() throws Exception {
+
+    // Creates database
+    final String databaseId = idGenerator.generateDatabaseId();
+    databaseAdminClient.createDatabase(instanceId, databaseId, Arrays.asList()
+    ).get(5, TimeUnit.MINUTES);
+
+    // Runs sample
+    final String out = SampleRunner.runSample(() -> CreateTableWithForeignKeyDeleteCascadeSample
+        .createForeignKeyDeleteCascadeConstraint(databaseAdminClient, instanceId, databaseId)
+    );
+
+    assertTrue(
+        "Expected to have created database " + databaseId + " with tables containing "
+            + "foreign key constraints.", out.contains("Created Customers and ShoppingCarts table "
+            + "with FKShoppingCartsCustomerId"
+        )
+    );
+  }
+}

samples/snippets/src/test/java/com/example/spanner/DropForeignKeyConstraintDeleteCascadeSampleIT.java

@@ -0,0 +1,40 @@
+package com.example.spanner;
+
+import static org.junit.Assert.assertTrue;
+
+import java.util.Arrays;
+import java.util.concurrent.TimeUnit;
+import org.junit.Test;
+
+public class DropForeignKeyConstraintDeleteCascadeSampleIT extends SampleTestBase {
+
+  @Test
+  public void testDropForeignKeyConstraintDeleteCascade() throws Exception {
+
+    // Creates database
+    final String databaseId = idGenerator.generateDatabaseId();
+    databaseAdminClient.createDatabase(instanceId, databaseId, Arrays.asList("CREATE TABLE Customers (\n"
+            + "              CustomerId INT64 NOT NULL,\n"
+            + "              CustomerName STRING(62) NOT NULL,\n"
+            + "              ) PRIMARY KEY (CustomerId)",
+        "CREATE TABLE ShoppingCarts (\n"
+            + "              CartId INT64 NOT NULL,\n"
+            + "              CustomerId INT64 NOT NULL,\n"
+            + "              CustomerName STRING(62) NOT NULL,\n"
+            + "              CONSTRAINT FKShoppingCartsCustomerName FOREIGN KEY (CustomerName)\n"
+            + "              REFERENCES Customers (CustomerName) ON DELETE CASCADE\n"
+            + "              ) PRIMARY KEY (CartId)\n")
+    ).get(5, TimeUnit.MINUTES);
+
+    // Runs sample
+    final String out = SampleRunner.runSample(() -> DropForeignKeyConstraintDeleteCascadeSample
+        .deleteForeignKeyDeleteCascadeConstraint(databaseAdminClient, instanceId, databaseId)
+    );
+
+    assertTrue(
+        "Expected to have dropped foreign-key constraints from tables in created database "
+            + databaseId , out.contains("Altered ShoppingCarts table to drop FKShoppingCartsCustomerName"
+        )
+    );
+  }
+}

samples/snippets/src/test/java/com/example/spanner/SampleTestBase.java

@@ -44,10 +44,14 @@ public class SampleTestBase {
 
   @BeforeClass
   public static void beforeClass() {
-    final SpannerOptions options = SpannerOptions
+    final String serverUrl = "";
+    final SpannerOptions.Builder optionsBuilder = SpannerOptions
         .newBuilder()
-        .setAutoThrottleAdministrativeRequests()
-        .build();
+        .setAutoThrottleAdministrativeRequests();
+    if (!serverUrl.isEmpty()) {
+      optionsBuilder.setHost(serverUrl);
+    }
+    final SpannerOptions options = optionsBuilder.build();
     projectId = options.getProjectId();
     spanner = options.getService();
     databaseAdminClient = spanner.getDatabaseAdminClient();