database_admin_client.h

Go to the documentation of this file.

// Copyright 2019 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.

#ifndef GOOGLE_CLOUD_CPP_GOOGLE_CLOUD_SPANNER_DATABASE_ADMIN_CLIENT_H
#define GOOGLE_CLOUD_CPP_GOOGLE_CLOUD_SPANNER_DATABASE_ADMIN_CLIENT_H

#include "google/cloud/spanner/backup.h"
#include "google/cloud/spanner/connection_options.h"
#include "google/cloud/spanner/database.h"
#include "google/cloud/spanner/database_admin_connection.h"
#include "google/cloud/spanner/iam_updater.h"
#include "google/cloud/spanner/instance.h"
#include "google/cloud/future.h"
#include "google/cloud/status_or.h"
#include <chrono>

namespace google {
namespace cloud {
namespace spanner {
inline namespace SPANNER_CLIENT_NS {

class DatabaseAdminClient {
 public:
  explicit DatabaseAdminClient(
      ConnectionOptions const& options = ConnectionOptions());

  future<StatusOr<google::spanner::admin::database::v1::Database>>
  CreateDatabase(Database db, std::vector<std::string> extra_statements = {});

  StatusOr<google::spanner::admin::database::v1::Database> GetDatabase(
      Database db);

  StatusOr<google::spanner::admin::database::v1::GetDatabaseDdlResponse>
  GetDatabaseDdl(Database db);

  future<
      StatusOr<google::spanner::admin::database::v1::UpdateDatabaseDdlMetadata>>
  UpdateDatabase(Database db, std::vector<std::string> statements);

  Status DropDatabase(Database db);

  ListDatabaseRange ListDatabases(Instance in);

  future<StatusOr<google::spanner::admin::database::v1::Database>>
  RestoreDatabase(Database db, Backup const& backup);

  future<StatusOr<google::spanner::admin::database::v1::Database>>
  RestoreDatabase(Database db,
                  google::spanner::admin::database::v1::Backup const& backup);

  StatusOr<google::iam::v1::Policy> GetIamPolicy(Database db);

  StatusOr<google::iam::v1::Policy> SetIamPolicy(
      Database db, google::iam::v1::Policy policy);

  StatusOr<google::iam::v1::Policy> SetIamPolicy(Database const& db,
                                                 IamUpdater const& updater);

  StatusOr<google::iam::v1::Policy> SetIamPolicy(
      Database const& db, IamUpdater const& updater,
      std::unique_ptr<TransactionRerunPolicy> rerun_policy,
      std::unique_ptr<BackoffPolicy> backoff_policy);

  StatusOr<google::iam::v1::TestIamPermissionsResponse> TestIamPermissions(
      Database db, std::vector<std::string> permissions);

  future<StatusOr<google::spanner::admin::database::v1::Backup>> CreateBackup(
      Database db, std::string backup_id,
      std::chrono::system_clock::time_point expire_time);

  StatusOr<google::spanner::admin::database::v1::Backup> GetBackup(
      Backup const& backup);

  Status DeleteBackup(
      google::spanner::admin::database::v1::Backup const& backup);

  Status DeleteBackup(Backup const& backup);

  ListBackupsRange ListBackups(Instance in, std::string filter = {});

  StatusOr<google::spanner::admin::database::v1::Backup> UpdateBackupExpireTime(
      google::spanner::admin::database::v1::Backup const& backup,
      std::chrono::system_clock::time_point const& expire_time);

  StatusOr<google::spanner::admin::database::v1::Backup> UpdateBackupExpireTime(
      Backup const& backup,
      std::chrono::system_clock::time_point const& expire_time);

  ListBackupOperationsRange ListBackupOperations(Instance in,
                                                 std::string filter = {});

  ListDatabaseOperationsRange ListDatabaseOperations(Instance in,
                                                     std::string filter = {});

  explicit DatabaseAdminClient(std::shared_ptr<DatabaseAdminConnection> c)
      : conn_(std::move(c)) {}

 private:
  std::shared_ptr<DatabaseAdminConnection> conn_;
};

}  // namespace SPANNER_CLIENT_NS
}  // namespace spanner
}  // namespace cloud
}  // namespace google

#endif  // GOOGLE_CLOUD_CPP_GOOGLE_CLOUD_SPANNER_DATABASE_ADMIN_CLIENT_H