データベースが誤って削除されることを防止

このページでは、Spanner データベースが誤って削除されないように保護する方法について説明します。

Spanner データベースの削除保護によって、データベースの削除に必要な IAM 権限を持つユーザーまたはサービス アカウントによる既存のデータベースの誤った削除を防ぐことができます。データベースの削除保護を有効にすることで、アプリケーションとサービスにとって重要なデータベースを保護できます。 データベースの削除保護にポイントインタイム リカバリとバックアップ機能を併用して、Spanner データベースに包括的なデータ保護機能のセットを提供します。

デフォルトでは、新しいデータベースを作成すると、削除保護設定は無効になります。データベースの作成に成功すると、削除保護設定を有効にすることができます。さらに、この設定は既存のデータベースで有効にすることもできます。複数のデータベースを保護する場合は、各データベースの設定を個別に有効にします。削除保護を有効 / 無効にしても、データベースへのパフォーマンス上の影響はありません。データベース保護が有効なデータベースを削除する必要がある場合は、データベースを削除する前に保護を無効にする必要があります。

制限事項

次のシナリオでは、データベースの削除保護を有効にできません。

• データベースが削除中の場合。
• データベースをバックアップから復元している途中の場合。（復元オペレーションの完了後は、データベースの保護を有効にできます）。

また、データベースのバックアップとバックアップから復元されたデータベースは、元のデータベースのデータベース削除保護の設定を継承しません。バックアップからデータベースを復元した後、データベースの削除保護を個別に有効にする必要があります。

プロジェクトを削除する場合、Spanner データベース削除保護を使用してもデータベースやインスタンスの削除は防止されません。プロジェクトを削除する場合の影響については、プロジェクトのシャットダウン（削除）をご覧ください。

IAM を使用したアクセス制御

データベースの削除保護設定を有効にするには、特定の IAM 権限が必要です。

データベースの削除保護を有効または無効にするには、spanner.databases.update 権限が必要です。データベース構成のステータスを表示するだけの場合は、必要となるのは spanner.databases.list 権限または spanner.databases.get 権限です。Spanner IAM 権限を付与する方法については、IAM 権限を適用するをご覧ください。

データベースに事前定義された Spanner データベース管理者 roles/spanner.databaseAdmin ロールがある場合は、データベースの削除保護を更新して有効にできます。

既存のデータベースでデータベースの削除保護設定を有効にすると、データベースが誤って削除されるのを防ぐことができます。

データベースの削除保護を有効にする

データベースの削除保護を有効にするには、gcloud CLI、クライアント ライブラリ、RESTまたはRPC API を使用します。Google Cloud コンソールを使用してデータベースの削除保護を有効にすることはできません。

gcloud

データベースの削除保護設定を有効にするには、次のコマンドを実行します。

  gcloud spanner databases update
  DATABASE_ID --instance=INSTANCE_ID
  --enable-drop-protection [--async]

次のオプションは必須です。

DATABASE_ID

データベースの ID。

INSTANCE_ID

データベースのインスタンスの ID。

次のオプションは省略可能です。

--async

処理中のオペレーションの完了を待たずに、直ちにコマンドを終了します。

クライアント ライブラリ

C++

void UpdateDatabase(google::cloud::spanner_admin::DatabaseAdminClient client,
                    std::string const& project_id,
                    std::string const& instance_id,
                    std::string const& database_id, bool drop_protection) {
  google::cloud::spanner::Database db(project_id, instance_id, database_id);
  google::spanner::admin::database::v1::Database database;
  database.set_name(db.FullName());
  database.set_enable_drop_protection(drop_protection);
  google::protobuf::FieldMask update_mask;
  update_mask.add_paths("enable_drop_protection");
  auto updated = client.UpdateDatabase(database, update_mask).get();
  if (!updated) throw std::move(updated).status();
  std::cout << "Database " << updated->name() << " successfully updated.\n";
}

C#

using Google.Cloud.Spanner.Admin.Database.V1;
using Google.Cloud.Spanner.Common.V1;
using Google.Protobuf.WellKnownTypes;
using System;
using System.Threading.Tasks;

public class UpdateDatabaseAsyncSample
{
    public async Task<Database> UpdateDatabaseAsync(string projectId, string instanceId, string databaseId)
    {
        var databaseAdminClient = await DatabaseAdminClient.CreateAsync();
        var databaseName = DatabaseName.Format(projectId, instanceId, databaseId);
        Database databaseToUpdate = await databaseAdminClient.GetDatabaseAsync(databaseName);

        databaseToUpdate.EnableDropProtection = true;
        var updateDatabaseRequest = new UpdateDatabaseRequest()
        {
            Database = databaseToUpdate,
            UpdateMask = new FieldMask { Paths = { "enable_drop_protection" } }
        };

        var operation = await databaseAdminClient.UpdateDatabaseAsync(updateDatabaseRequest);

        // Wait until the operation has finished.
        Console.WriteLine("Waiting for the operation to finish.");
        var completedResponse = await operation.PollUntilCompletedAsync();

        if (completedResponse.IsFaulted)
        {
            Console.WriteLine($"Error while updating database {databaseId}: {completedResponse.Exception}");
            throw completedResponse.Exception;
        }

        Console.WriteLine($"Updated database {databaseId}.");

        // Return the updated database.
        return completedResponse.Result;
    }
}

Go

import (
	"context"
	"fmt"
	"io"

	database "cloud.google.com/go/spanner/admin/database/apiv1"
	adminpb "cloud.google.com/go/spanner/admin/database/apiv1/databasepb"
	"google.golang.org/genproto/protobuf/field_mask"
)

func updateDatabase(ctx context.Context, w io.Writer, db string) error {
	// db = `projects/<project>/instances/<instance-id>/database/<database-id>`
	// Instantiate database admin client.
	adminClient, err := database.NewDatabaseAdminClient(ctx)
	if err != nil {
		return fmt.Errorf("updateDatabase.NewDatabaseAdminClient: %w", err)
	}
	defer adminClient.Close()

	// Instantiate the request for performing update database operation.
	op, err := adminClient.UpdateDatabase(ctx, &adminpb.UpdateDatabaseRequest{
		Database: &adminpb.Database{
			Name:                 db,
			EnableDropProtection: true,
		},
		UpdateMask: &field_mask.FieldMask{
			Paths: []string{"enable_drop_protection"},
		},
	})
	if err != nil {
		return fmt.Errorf("updateDatabase.UpdateDatabase: %w", err)
	}

	// Wait for update database operation to complete.
	fmt.Fprintf(w, "Waiting for update database operation to complete [%s]\n", db)
	if _, err := op.Wait(ctx); err != nil {
		return fmt.Errorf("updateDatabase.Wait: %w", err)
	}
	fmt.Fprintf(w, "Updated database [%s]\n", db)
	return nil
}

Java

import com.google.api.gax.longrunning.OperationFuture;
import com.google.cloud.spanner.Spanner;
import com.google.cloud.spanner.SpannerExceptionFactory;
import com.google.cloud.spanner.SpannerOptions;
import com.google.cloud.spanner.admin.database.v1.DatabaseAdminClient;
import com.google.common.collect.Lists;
import com.google.protobuf.FieldMask;
import com.google.spanner.admin.database.v1.Database;
import com.google.spanner.admin.database.v1.DatabaseName;
import com.google.spanner.admin.database.v1.UpdateDatabaseMetadata;
import com.google.spanner.admin.database.v1.UpdateDatabaseRequest;
import java.util.concurrent.ExecutionException;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.TimeoutException;

public class UpdateDatabaseSample {

  static void updateDatabase() {
    // TODO(developer): Replace these variables before running the sample.
    final String projectId = "my-project";
    final String instanceId = "my-instance";
    final String databaseId = "my-database";

    updateDatabase(projectId, instanceId, databaseId);
  }

  static void updateDatabase(
      String projectId, String instanceId, String databaseId) {
    try (Spanner spanner =
        SpannerOptions.newBuilder().setProjectId(projectId).build().getService();
        DatabaseAdminClient databaseAdminClient = spanner.createDatabaseAdminClient()) {
      final Database database =
          Database.newBuilder()
              .setName(DatabaseName.of(projectId, instanceId, databaseId).toString())
              .setEnableDropProtection(true).build();
      final UpdateDatabaseRequest updateDatabaseRequest =
          UpdateDatabaseRequest.newBuilder()
              .setDatabase(database)
              .setUpdateMask(
                  FieldMask.newBuilder().addAllPaths(
                      Lists.newArrayList("enable_drop_protection")).build())
              .build();
      OperationFuture<Database, UpdateDatabaseMetadata> operation =
          databaseAdminClient.updateDatabaseAsync(updateDatabaseRequest);
      System.out.printf("Waiting for update operation for %s to complete...\n", databaseId);
      Database updatedDb = operation.get(5, TimeUnit.MINUTES);
      System.out.printf("Updated database %s.\n", updatedDb.getName());
    } catch (ExecutionException | TimeoutException 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);
    }
  }
}

注: Java 用の古いクライアント ライブラリ インターフェースのコードサンプルは、GitHub にアーカイブされています。

Node.js

/**
 * TODO(developer): Uncomment these variables before running the sample.
 */
// const instanceId = 'my-instance';
// const databaseId = 'my-database';
// const projectId = 'my-project-id';

// Imports the Google Cloud client library
const {Spanner, protos} = require('@google-cloud/spanner');

// creates a client
const spanner = new Spanner({
  projectId: projectId,
});

const databaseAdminClient = spanner.getDatabaseAdminClient();

async function updateDatabase() {
  // Update the database metadata fields
  try {
    console.log(
      `Updating database ${databaseAdminClient.databasePath(
        projectId,
        instanceId,
        databaseId
      )}.`
    );
    const [operation] = await databaseAdminClient.updateDatabase({
      database: {
        name: databaseAdminClient.databasePath(
          projectId,
          instanceId,
          databaseId
        ),
        enableDropProtection: true,
      },
      // updateMask contains the fields to be updated in database
      updateMask: (protos.google.protobuf.FieldMask = {
        paths: ['enable_drop_protection'],
      }),
    });
    console.log(
      `Waiting for update operation for ${databaseId} to complete...`
    );
    await operation.promise();
    console.log(`Updated database ${databaseId}.`);
  } catch (err) {
    console.log('ERROR:', err);
  }
}
updateDatabase();

注: Node.js の古いクライアント ライブラリ インターフェースのコードサンプルは、GitHub にアーカイブされています。

PHP

use Google\Cloud\Spanner\Admin\Database\V1\Client\DatabaseAdminClient;
use Google\Cloud\Spanner\Admin\Database\V1\Database;
use Google\Cloud\Spanner\Admin\Database\V1\GetDatabaseRequest;
use Google\Cloud\Spanner\Admin\Database\V1\UpdateDatabaseRequest;
use Google\Protobuf\FieldMask;

/**
 * Updates the drop protection setting for a database.
 * Example:
 * ```
 * update_database($projectId, $instanceId, $databaseId);
 * ```
 *
 * @param string $projectId The Google Cloud project ID.
 * @param string $instanceId The Spanner instance ID.
 * @param string $databaseId The Spanner database ID.
 */
function update_database(string $projectId, string $instanceId, string $databaseId): void
{
    $newUpdateMaskField = new FieldMask([
        'paths' => ['enable_drop_protection']
    ]);
    $databaseAdminClient = new DatabaseAdminClient();
    $databaseFullName = DatabaseAdminClient::databaseName($projectId, $instanceId, $databaseId);
    $database = (new Database())
        ->setEnableDropProtection(true)
        ->setName($databaseFullName);

    printf('Updating database %s', $databaseId);
    $operation = $databaseAdminClient->updateDatabase((new UpdateDatabaseRequest())
        ->setDatabase($database)
        ->setUpdateMask($newUpdateMaskField));

    $operation->pollUntilComplete();

    $database = $databaseAdminClient->getDatabase(
        new GetDatabaseRequest(['name' => $databaseFullName])
    );
    printf(
        'Updated the drop protection for %s to %s' . PHP_EOL,
        $database->getName(),
        $database->getEnableDropProtection()
    );
}

注: PHP 用の古いクライアント ライブラリ インターフェースのコードサンプルは GitHub にアーカイブされています。

Python

def update_database(instance_id, database_id):
    """Updates the drop protection setting for a database."""
    from google.cloud.spanner_admin_database_v1.types import spanner_database_admin

    spanner_client = spanner.Client()
    database_admin_api = spanner_client.database_admin_api

    request = spanner_database_admin.UpdateDatabaseRequest(
        database=spanner_database_admin.Database(
            name=database_admin_api.database_path(
                spanner_client.project, instance_id, database_id
            ),
            enable_drop_protection=True,
        ),
        update_mask={"paths": ["enable_drop_protection"]},
    )
    operation = database_admin_api.update_database(request=request)
    print(
        "Waiting for update operation for {}/databases/{} to complete...".format(
            database_admin_api.instance_path(spanner_client.project, instance_id),
            database_id,
        )
    )
    operation.result(OPERATION_TIMEOUT_SECONDS)

    print(
        "Updated database {}/databases/{}.".format(
            database_admin_api.instance_path(spanner_client.project, instance_id),
            database_id,
        )
    )

注: Python 用の古いクライアント ライブラリ インターフェースのコードサンプルは、GitHub にアーカイブされています。

Ruby

require "google/cloud/spanner/admin/database"

##
# This is a snippet for showcasing how to update database.
#
# @param project_id  [String] The ID of the Google Cloud project.
# @param instance_id [String] The ID of the spanner instance.
# @param database_id [String] The ID of the database.
#
def spanner_update_database project_id:, instance_id:, database_id:
  client = Google::Cloud::Spanner::Admin::Database.database_admin project_id: project_id
  db_path = client.database_path project: project_id, instance: instance_id, database: database_id
  database = client.get_database name: db_path

  puts "Updating database #{database.name}"
  database.enable_drop_protection = true
  job = client.update_database database: database, update_mask: { paths: ["enable_drop_protection"] }
  puts "Waiting for update operation for #{database.name} to complete..."
  job.wait_until_done!
  puts "Updated database #{database.name}"
end

データベースの削除保護が有効かどうかを確認する

データベースの削除保護が有効かどうかを確認するには、データベース構成を表示します。

gcloud

データベースの削除保護が有効になっているかどうかを確認するには、gcloud spanner databases describe コマンドを実行してデータベースに関する詳細情報を取得するか、gcloud spanner databases list を実行してインスタンス内のデータベースに関する詳細情報を取得します。

  gcloud spanner databases describe
  projects/PROJECT_ID/instances/INSTANCE_ID/databases/DATABASE_ID

次のオプションは必須です。

PROJECT_ID

データベースのプロジェクトの ID。

INSTANCE_ID

データベースのインスタンスの ID。

DATABASE_ID

データベースの ID。

削除保護が有効になっている場合、出力に enableDropProtection: true パラメータが表示されます。

データベースの削除保護を無効にする

データベースでこの保護が不要になった場合や、この設定が有効になっているデータベースを削除する必要がある場合は、データベースの削除保護を無効にできます。

削除保護が有効になっているデータベースが 1 つ以上存在するインスタンスを削除するには、そのインスタンスを削除する前に、まずそのインスタンスのすべてのデータベースの削除保護を無効にする必要があります。

gcloud

データベースの削除保護設定を無効にするには、次のコマンドを実行します。

  gcloud spanner databases update
  DATABASE_ID --instance=INSTANCE_ID
  --no-enable-drop-protection [--async]

次のオプションは必須です。

DATABASE_ID

データベースの ID。

INSTANCE_ID

データベースのインスタンスの ID。

次のオプションは省略可能です。

--async

処理中のオペレーションの完了を待たずに、直ちにコマンドを終了します。

次のステップ

• データベースの作成方法と管理方法を確認する。
• データベースのバックアップと復元方法を学習する。
• スキーマを更新する方法を学習する。