database_admin_connection.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_CONNECTION_H
#define GOOGLE_CLOUD_CPP_GOOGLE_CLOUD_SPANNER_DATABASE_ADMIN_CONNECTION_H

#include "google/cloud/spanner/backoff_policy.h"
#include "google/cloud/spanner/backup.h"
#include "google/cloud/spanner/database.h"
#include "google/cloud/spanner/instance.h"
#include "google/cloud/spanner/internal/database_admin_stub.h"
#include "google/cloud/spanner/polling_policy.h"
#include "google/cloud/spanner/retry_policy.h"
#include "google/cloud/internal/pagination_range.h"
#include <google/spanner/admin/database/v1/spanner_database_admin.grpc.pb.h>
#include <string>
#include <vector>

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

using ListDatabaseRange = google::cloud::internal::PaginationRange<
    google::spanner::admin::database::v1::Database,
    google::spanner::admin::database::v1::ListDatabasesRequest,
    google::spanner::admin::database::v1::ListDatabasesResponse>;

using ListBackupOperationsRange = google::cloud::internal::PaginationRange<
    google::longrunning::Operation,
    google::spanner::admin::database::v1::ListBackupOperationsRequest,
    google::spanner::admin::database::v1::ListBackupOperationsResponse>;

using ListDatabaseOperationsRange = google::cloud::internal::PaginationRange<
    google::longrunning::Operation,
    google::spanner::admin::database::v1::ListDatabaseOperationsRequest,
    google::spanner::admin::database::v1::ListDatabaseOperationsResponse>;

using ListBackupsRange = google::cloud::internal::PaginationRange<
    google::spanner::admin::database::v1::Backup,
    google::spanner::admin::database::v1::ListBackupsRequest,
    google::spanner::admin::database::v1::ListBackupsResponse>;

class DatabaseAdminConnection {
 public:
  virtual ~DatabaseAdminConnection() = 0;


  struct CreateDatabaseParams {
    Database database;
    std::vector<std::string> extra_statements;
  };

  struct GetDatabaseParams {
    Database database;
  };

  struct GetDatabaseDdlParams {
    Database database;
  };

  struct UpdateDatabaseParams {
    Database database;
    std::vector<std::string> statements;
  };

  struct DropDatabaseParams {
    Database database;
  };

  struct ListDatabasesParams {
    Instance instance;
  };

  struct GetIamPolicyParams {
    Database database;
  };

  struct SetIamPolicyParams {
    Database database;
    google::iam::v1::Policy policy;
  };

  struct TestIamPermissionsParams {
    Database database;
    std::vector<std::string> permissions;
  };

  struct CreateBackupParams {
    Database database;
    std::string backup_id;
    std::chrono::system_clock::time_point expire_time;
  };

  struct GetBackupParams {
    std::string backup_full_name;
  };

  struct DeleteBackupParams {
    std::string backup_full_name;
  };

  struct ListBackupsParams {
    Instance instance;
    std::string filter;
  };

  struct RestoreDatabaseParams {
    Database database;
    std::string backup_full_name;
  };

  struct UpdateBackupParams {
    google::spanner::admin::database::v1::UpdateBackupRequest request;
  };

  struct ListBackupOperationsParams {
    Instance instance;
    std::string filter;
  };

  struct ListDatabaseOperationsParams {
    Instance instance;
    std::string filter;
  };

  virtual future<StatusOr<google::spanner::admin::database::v1::Database>>
      CreateDatabase(CreateDatabaseParams) = 0;

  virtual StatusOr<google::spanner::admin::database::v1::Database> GetDatabase(
      GetDatabaseParams) = 0;

  virtual StatusOr<google::spanner::admin::database::v1::GetDatabaseDdlResponse>
      GetDatabaseDdl(GetDatabaseDdlParams) = 0;

  virtual future<
      StatusOr<google::spanner::admin::database::v1::UpdateDatabaseDdlMetadata>>
      UpdateDatabase(UpdateDatabaseParams) = 0;

  virtual Status DropDatabase(DropDatabaseParams) = 0;

  virtual ListDatabaseRange ListDatabases(ListDatabasesParams) = 0;

  virtual future<StatusOr<google::spanner::admin::database::v1::Database>>
      RestoreDatabase(RestoreDatabaseParams);

  virtual StatusOr<google::iam::v1::Policy> GetIamPolicy(
      GetIamPolicyParams) = 0;

  virtual StatusOr<google::iam::v1::Policy> SetIamPolicy(
      SetIamPolicyParams) = 0;

  virtual StatusOr<google::iam::v1::TestIamPermissionsResponse>
      TestIamPermissions(TestIamPermissionsParams) = 0;

  virtual future<StatusOr<google::spanner::admin::database::v1::Backup>>
      CreateBackup(CreateBackupParams);

  virtual StatusOr<google::spanner::admin::database::v1::Backup> GetBackup(
      GetBackupParams);

  virtual Status DeleteBackup(DeleteBackupParams);

  virtual ListBackupsRange ListBackups(ListBackupsParams);

  virtual StatusOr<google::spanner::admin::database::v1::Backup> UpdateBackup(
      UpdateBackupParams);

  virtual ListBackupOperationsRange ListBackupOperations(
      ListBackupOperationsParams);

  virtual ListDatabaseOperationsRange ListDatabaseOperations(
      ListDatabaseOperationsParams);
};

std::shared_ptr<DatabaseAdminConnection> MakeDatabaseAdminConnection(
    ConnectionOptions const& options = ConnectionOptions());

std::shared_ptr<DatabaseAdminConnection> MakeDatabaseAdminConnection(
    ConnectionOptions const& options, std::unique_ptr<RetryPolicy> retry_policy,
    std::unique_ptr<BackoffPolicy> backoff_policy,
    std::unique_ptr<PollingPolicy> polling_policy);

namespace internal {
std::shared_ptr<DatabaseAdminConnection> MakeDatabaseAdminConnection(
    std::shared_ptr<internal::DatabaseAdminStub> stub,
    std::unique_ptr<RetryPolicy> retry_policy,
    std::unique_ptr<BackoffPolicy> backoff_policy,
    std::unique_ptr<PollingPolicy> polling_policy);
}  // namespace internal

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

#endif  // GOOGLE_CLOUD_CPP_GOOGLE_CLOUD_SPANNER_DATABASE_ADMIN_CONNECTION_H