chore: copy samples and rewrite create backup.

googleapis · arpan14 · Feb 23, 2024 · Feb 6, 2023 · Feb 8, 2023 · Feb 8, 2023
commit 37759969d694c86f8d67a25ebaa9b0ebc4f1f888
@@ -0,0 +1,101 @@
+/*
+ * Copyright 2022 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.admin.generated;
+
+// [START spanner_copy_backup]
+
+import com.google.api.gax.longrunning.OperationFuture;
+import com.google.cloud.Timestamp;
+import com.google.cloud.spanner.Backup;
+import com.google.cloud.spanner.BackupId;
+import com.google.cloud.spanner.DatabaseAdminClient;
+import com.google.cloud.spanner.Spanner;
+import com.google.cloud.spanner.SpannerException;
+import com.google.cloud.spanner.SpannerExceptionFactory;
+import com.google.cloud.spanner.SpannerOptions;
+import com.google.spanner.admin.database.v1.CopyBackupMetadata;
+import java.time.LocalDateTime;
+import java.time.OffsetDateTime;
+import java.util.concurrent.ExecutionException;
+import java.util.concurrent.TimeUnit;
+
+public class CopyBackupSample {
+ static void copyBackup() {
+ // TODO(developer): Replace these variables before running the sample.
+ String projectId = "my-project";
+ String instanceId = "my-instance";
+ String sourceBackupId = "my-backup";
+ String destinationBackupId = "my-destination-backup";
+ try (Spanner spanner =
+ SpannerOptions.newBuilder().setProjectId(projectId).build().getService()) {
+ DatabaseAdminClient databaseAdminClient = spanner.getDatabaseAdminClient();
+ copyBackup(databaseAdminClient, projectId, instanceId, sourceBackupId, destinationBackupId);
+ }
+ }
+
+ static void copyBackup(
+ DatabaseAdminClient databaseAdminClient,
+ String projectId,
+ String instanceId,
+ String sourceBackupId,
+ String destinationBackupId) {
+
+ Timestamp expireTime =
+ Timestamp.ofTimeMicroseconds(
+ TimeUnit.MICROSECONDS.convert(
+ System.currentTimeMillis() + TimeUnit.DAYS.toMillis(14),
+ TimeUnit.MILLISECONDS));
+ // Creates a copy of an existing backup.
+ Backup destinationBackup =
+ databaseAdminClient
+ .newBackupBuilder(BackupId.of(projectId, instanceId, destinationBackupId))
+ .setExpireTime(expireTime)
+ .build();
+
+ // Initiate the request which returns an OperationFuture.
+ System.out.println("Copying backup [" + destinationBackup.getId() + "]...");
+ OperationFuture<Backup, CopyBackupMetadata> operation =
+ databaseAdminClient.copyBackup(
+ BackupId.of(projectId, instanceId, sourceBackupId), destinationBackup);
+ try {
+ // Wait for the backup operation to complete.
+ destinationBackup = operation.get();
+ System.out.println("Copied backup [" + destinationBackup.getId() + "]");
+ } catch (ExecutionException e) {
+ throw (SpannerException) e.getCause();
+ } catch (InterruptedException e) {
+ throw SpannerExceptionFactory.propagateInterrupt(e);
+ }
+ // Load the metadata of the new backup from the server.
+ destinationBackup = destinationBackup.reload();
+ System.out.println(
+ String.format(
+ "Backup %s of size %d bytes was copied at %s for version of database at %s",
+ destinationBackup.getId().getName(),
+ destinationBackup.getSize(),
+ LocalDateTime.ofEpochSecond(
+ destinationBackup.getProto().getCreateTime().getSeconds(),
+ destinationBackup.getProto().getCreateTime().getNanos(),
+ OffsetDateTime.now().getOffset()),
+ LocalDateTime.ofEpochSecond(
+ destinationBackup.getProto().getVersionTime().getSeconds(),
+ destinationBackup.getProto().getVersionTime().getNanos(),
+ OffsetDateTime.now().getOffset())));
+ return;
+ }
+}
+// [END spanner_copy_backup]
@@ -0,0 +1,107 @@
+/*
+ * Copyright 2021 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.admin.generated;
+
+// [START spanner_create_backup_with_encryption_key]
+
+import com.google.api.gax.longrunning.OperationFuture;
+import com.google.cloud.Timestamp;
+import com.google.cloud.spanner.Backup;
+import com.google.cloud.spanner.BackupId;
+import com.google.cloud.spanner.DatabaseAdminClient;
+import com.google.cloud.spanner.DatabaseId;
+import com.google.cloud.spanner.Spanner;
+import com.google.cloud.spanner.SpannerExceptionFactory;
+import com.google.cloud.spanner.SpannerOptions;
+import com.google.cloud.spanner.encryption.EncryptionConfigs;
+import com.google.spanner.admin.database.v1.CreateBackupMetadata;
+import java.util.concurrent.ExecutionException;
+import java.util.concurrent.TimeUnit;
+import java.util.concurrent.TimeoutException;
+import org.threeten.bp.LocalDateTime;
+import org.threeten.bp.OffsetDateTime;
+
+public class CreateBackupWithEncryptionKey {
+
+ static void createBackupWithEncryptionKey() throws InterruptedException {
+ // TODO(developer): Replace these variables before running the sample.
+ String projectId = "my-project";
+ String instanceId = "my-instance";
+ String databaseId = "my-database";
+ String backupId = "my-backup";
+ String kmsKeyName =
+ "projects/" + projectId + "/locations/<location>/keyRings/<keyRing>/cryptoKeys/<keyId>";
+
+ try (Spanner spanner =
+ SpannerOptions.newBuilder().setProjectId(projectId).build().getService()) {
+ DatabaseAdminClient adminClient = spanner.getDatabaseAdminClient();
+ createBackupWithEncryptionKey(
+ adminClient,
+ projectId,
+ instanceId,
+ databaseId,
+ backupId,
+ kmsKeyName);
+ }
+ }
+
+ static Void createBackupWithEncryptionKey(DatabaseAdminClient adminClient,
+ String projectId, String instanceId, String databaseId, String backupId, String kmsKeyName)
+ throws InterruptedException {
+ // Set expire time to 14 days from now.
+ final Timestamp expireTime = Timestamp.ofTimeMicroseconds(TimeUnit.MICROSECONDS.convert(
+ System.currentTimeMillis() + TimeUnit.DAYS.toMillis(14), TimeUnit.MILLISECONDS));
+ final Backup backupToCreate = adminClient
+ .newBackupBuilder(BackupId.of(projectId, instanceId, backupId))
+ .setDatabase(DatabaseId.of(projectId, instanceId, databaseId))
+ .setExpireTime(expireTime)
+ .setEncryptionConfig(EncryptionConfigs.customerManagedEncryption(kmsKeyName))
+ .build();
+ final OperationFuture<Backup, CreateBackupMetadata> operation = adminClient
+ .createBackup(backupToCreate);
+
+ Backup backup;
+ try {
+ System.out.println("Waiting for operation to complete...");
+ backup = operation.get(1200, TimeUnit.SECONDS);
+ } catch (ExecutionException e) {
+ // If the operation failed during execution, expose the cause.
+ throw SpannerExceptionFactory.asSpannerException(e.getCause());
+ } catch (InterruptedException e) {
+ // Throw when a thread is waiting, sleeping, or otherwise occupied,
+ // and the thread is interrupted, either before or during the activity.
+ throw SpannerExceptionFactory.propagateInterrupt(e);
+ } catch (TimeoutException e) {
+ // If the operation timed out propagates the timeout
+ throw SpannerExceptionFactory.propagateTimeout(e);
+ }
+
+ System.out.printf(
+ "Backup %s of size %d bytes was created at %s using encryption key %s%n",
+ backup.getId().getName(),
+ backup.getSize(),
+ LocalDateTime.ofEpochSecond(
+ backup.getProto().getCreateTime().getSeconds(),
+ backup.getProto().getCreateTime().getNanos(),
+ OffsetDateTime.now().getOffset()),
+ kmsKeyName
+ );
+
+ return null;
+ }
+}
+// [END spanner_create_backup_with_encryption_key]
@@ -0,0 +1,100 @@
+/*
+ * Copyright 2021 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.admin.generated;
+
+// [START spanner_create_database_with_encryption_key]
+
+import com.google.api.gax.longrunning.OperationFuture;
+import com.google.cloud.spanner.Database;
+import com.google.cloud.spanner.DatabaseAdminClient;
+import com.google.cloud.spanner.DatabaseId;
+import com.google.cloud.spanner.Spanner;
+import com.google.cloud.spanner.SpannerExceptionFactory;
+import com.google.cloud.spanner.SpannerOptions;
+import com.google.cloud.spanner.encryption.EncryptionConfigs;
+import com.google.spanner.admin.database.v1.CreateDatabaseMetadata;
+import java.util.Arrays;
+import java.util.concurrent.ExecutionException;
+import java.util.concurrent.TimeUnit;
+import java.util.concurrent.TimeoutException;
+
+public class CreateDatabaseWithEncryptionKey {
+
+ static void createDatabaseWithEncryptionKey() {
+ // TODO(developer): Replace these variables before running the sample.
+ String projectId = "my-project";
+ String instanceId = "my-instance";
+ String databaseId = "my-database";
+ String kmsKeyName =
+ "projects/" + projectId + "/locations/<location>/keyRings/<keyRing>/cryptoKeys/<keyId>";
+
+ try (Spanner spanner =
+ SpannerOptions.newBuilder().setProjectId(projectId).build().getService()) {
+ DatabaseAdminClient adminClient = spanner.getDatabaseAdminClient();
+ createDatabaseWithEncryptionKey(
+ adminClient,
+ projectId,
+ instanceId,
+ databaseId,
+ kmsKeyName);
+ }
+ }
+
+ static void createDatabaseWithEncryptionKey(DatabaseAdminClient adminClient,
+ String projectId, String instanceId, String databaseId, String kmsKeyName) {
+ final Database databaseToCreate = adminClient
+ .newDatabaseBuilder(DatabaseId.of(projectId, instanceId, databaseId))
+ .setEncryptionConfig(EncryptionConfigs.customerManagedEncryption(kmsKeyName))
+ .build();
+ final OperationFuture<Database, CreateDatabaseMetadata> operation = adminClient
+ .createDatabase(databaseToCreate, Arrays.asList(
+ "CREATE TABLE Singers ("
+ + " SingerId INT64 NOT NULL,"
+ + " FirstName STRING(1024),"
+ + " LastName STRING(1024),"
+ + " SingerInfo BYTES(MAX)"
+ + ") PRIMARY KEY (SingerId)",
+ "CREATE TABLE Albums ("
+ + " SingerId INT64 NOT NULL,"
+ + " AlbumId INT64 NOT NULL,"
+ + " AlbumTitle STRING(MAX)"
+ + ") PRIMARY KEY (SingerId, AlbumId),"
+ + " INTERLEAVE IN PARENT Singers ON DELETE CASCADE"
+ ));
+ try {
+ System.out.println("Waiting for operation to complete...");
+ Database createdDatabase = operation.get(120, TimeUnit.SECONDS);
+
+ System.out.printf(
+ "Database %s created with encryption key %s%n",
+ createdDatabase.getId(),
+ createdDatabase.getEncryptionConfig().getKmsKeyName()
+ );
+ } catch (ExecutionException e) {
+ // If the operation failed during execution, expose the cause.
+ throw SpannerExceptionFactory.asSpannerException(e.getCause());
+ } catch (InterruptedException e) {
+ // Throw when a thread is waiting, sleeping, or otherwise occupied,
+ // and the thread is interrupted, either before or during the activity.
+ throw SpannerExceptionFactory.propagateInterrupt(e);
+ } catch (TimeoutException e) {
+ // If the operation timed out propagates the timeout
+ throw SpannerExceptionFactory.propagateTimeout(e);
+ }
+ }
+}
+// [END spanner_create_database_with_encryption_key]