trait DatabaseAdmin extends AnyRef

Cloud Spanner Database Admin API The Cloud Spanner Database Admin API can be used to create, drop, and list databases. It also enables updating the schema of pre-existing databases. It can be also used to create, delete and list backups for a database and to restore from an existing backup.

Linear Supertypes
AnyRef, Any
Known Subclasses
DatabaseAdminClient, DefaultDatabaseAdminClient
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. DatabaseAdmin
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def createBackup(in: CreateBackupRequest): Future[Operation]

    Starts creating a new Cloud Spanner Backup.

    Starts creating a new Cloud Spanner Backup. The returned backup [long-running operation][google.longrunning.Operation] will have a name of the format projects/<project>/instances/<instance>/backups/<backup>/operations/<operation_id> and can be used to track creation of the backup. The [metadata][google.longrunning.Operation.metadata] field type is [CreateBackupMetadata][google.spanner.admin.database.v1.CreateBackupMetadata]. The [response][google.longrunning.Operation.response] field type is [Backup][google.spanner.admin.database.v1.Backup], if successful. Cancelling the returned operation will stop the creation and delete the backup. There can be only one pending backup creation per database. Backup creation of different databases can run concurrently.

  2. abstract def createDatabase(in: CreateDatabaseRequest): Future[Operation]

    Creates a new Cloud Spanner database and starts to prepare it for serving.

    Creates a new Cloud Spanner database and starts to prepare it for serving. The returned [long-running operation][google.longrunning.Operation] will have a name of the format <database_name>/operations/<operation_id> and can be used to track preparation of the database. The [metadata][google.longrunning.Operation.metadata] field type is [CreateDatabaseMetadata][google.spanner.admin.database.v1.CreateDatabaseMetadata]. The [response][google.longrunning.Operation.response] field type is [Database][google.spanner.admin.database.v1.Database], if successful.

  3. abstract def deleteBackup(in: DeleteBackupRequest): Future[Empty]

    Deletes a pending or completed [Backup][google.spanner.admin.database.v1.Backup].

  4. abstract def dropDatabase(in: DropDatabaseRequest): Future[Empty]

    Drops (aka deletes) a Cloud Spanner database.

    Drops (aka deletes) a Cloud Spanner database. Completed backups for the database will be retained according to their expire_time.

  5. abstract def getBackup(in: GetBackupRequest): Future[Backup]

    Gets metadata on a pending or completed [Backup][google.spanner.admin.database.v1.Backup].

  6. abstract def getDatabase(in: GetDatabaseRequest): Future[Database]

    Gets the state of a Cloud Spanner database.

  7. abstract def getDatabaseDdl(in: GetDatabaseDdlRequest): Future[GetDatabaseDdlResponse]

    Returns the schema of a Cloud Spanner database as a list of formatted DDL statements.

    Returns the schema of a Cloud Spanner database as a list of formatted DDL statements. This method does not show pending schema updates, those may be queried using the [Operations][google.longrunning.Operations] API.

  8. abstract def getIamPolicy(in: GetIamPolicyRequest): Future[Policy]

    Gets the access control policy for a database or backup resource.

    Gets the access control policy for a database or backup resource. Returns an empty policy if a database or backup exists but does not have a policy set. Authorization requires spanner.databases.getIamPolicy permission on [resource][google.iam.v1.GetIamPolicyRequest.resource]. For backups, authorization requires spanner.backups.getIamPolicy permission on [resource][google.iam.v1.GetIamPolicyRequest.resource].

  9. abstract def listBackupOperations(in: ListBackupOperationsRequest): Future[ListBackupOperationsResponse]

    Lists the backup [long-running operations][google.longrunning.Operation] in the given instance.

    Lists the backup [long-running operations][google.longrunning.Operation] in the given instance. A backup operation has a name of the form projects/<project>/instances/<instance>/backups/<backup>/operations/<operation>. The long-running operation [metadata][google.longrunning.Operation.metadata] field type metadata.type_url describes the type of the metadata. Operations returned include those that have completed/failed/canceled within the last 7 days, and pending operations. Operations returned are ordered by operation.metadata.value.progress.start_time in descending order starting from the most recently started operation.

  10. abstract def listBackups(in: ListBackupsRequest): Future[ListBackupsResponse]

    Lists completed and pending backups.

    Lists completed and pending backups. Backups returned are ordered by create_time in descending order, starting from the most recent create_time.

  11. abstract def listDatabaseOperations(in: ListDatabaseOperationsRequest): Future[ListDatabaseOperationsResponse]

    Lists database [longrunning-operations][google.longrunning.Operation].

    Lists database [longrunning-operations][google.longrunning.Operation]. A database operation has a name of the form projects/<project>/instances/<instance>/databases/<database>/operations/<operation>. The long-running operation [metadata][google.longrunning.Operation.metadata] field type metadata.type_url describes the type of the metadata. Operations returned include those that have completed/failed/canceled within the last 7 days, and pending operations.

  12. abstract def listDatabases(in: ListDatabasesRequest): Future[ListDatabasesResponse]

    Lists Cloud Spanner databases.

  13. abstract def restoreDatabase(in: RestoreDatabaseRequest): Future[Operation]

    Create a new database by restoring from a completed backup.

    Create a new database by restoring from a completed backup. The new database must be in the same project and in an instance with the same instance configuration as the instance containing the backup. The returned database [long-running operation][google.longrunning.Operation] has a name of the format projects/<project>/instances/<instance>/databases/<database>/operations/<operation_id>, and can be used to track the progress of the operation, and to cancel it. The [metadata][google.longrunning.Operation.metadata] field type is [RestoreDatabaseMetadata][google.spanner.admin.database.v1.RestoreDatabaseMetadata]. The [response][google.longrunning.Operation.response] type is [Database][google.spanner.admin.database.v1.Database], if successful. Cancelling the returned operation will stop the restore and delete the database. There can be only one database being restored into an instance at a time. Once the restore operation completes, a new restore operation can be initiated, without waiting for the optimize operation associated with the first restore to complete.

  14. abstract def setIamPolicy(in: SetIamPolicyRequest): Future[Policy]

    Sets the access control policy on a database or backup resource.

    Sets the access control policy on a database or backup resource. Replaces any existing policy. Authorization requires spanner.databases.setIamPolicy permission on [resource][google.iam.v1.SetIamPolicyRequest.resource]. For backups, authorization requires spanner.backups.setIamPolicy permission on [resource][google.iam.v1.SetIamPolicyRequest.resource].

  15. abstract def testIamPermissions(in: TestIamPermissionsRequest): Future[TestIamPermissionsResponse]

    Returns permissions that the caller has on the specified database or backup resource.

    Returns permissions that the caller has on the specified database or backup resource. Attempting this RPC on a non-existent Cloud Spanner database will result in a NOT_FOUND error if the user has spanner.databases.list permission on the containing Cloud Spanner instance. Otherwise returns an empty set of permissions. Calling this method on a backup that does not exist will result in a NOT_FOUND error if the user has spanner.backups.list permission on the containing instance.

  16. abstract def updateBackup(in: UpdateBackupRequest): Future[Backup]

    Updates a pending or completed [Backup][google.spanner.admin.database.v1.Backup].

  17. abstract def updateDatabaseDdl(in: UpdateDatabaseDdlRequest): Future[Operation]

    Updates the schema of a Cloud Spanner database by creating/altering/dropping tables, columns, indexes, etc.

    Updates the schema of a Cloud Spanner database by creating/altering/dropping tables, columns, indexes, etc. The returned [long-running operation][google.longrunning.Operation] will have a name of the format <database_name>/operations/<operation_id> and can be used to track execution of the schema change(s). The [metadata][google.longrunning.Operation.metadata] field type is [UpdateDatabaseDdlMetadata][google.spanner.admin.database.v1.UpdateDatabaseDdlMetadata]. The operation has no response.

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  14. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  15. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  16. def toString(): String
    Definition Classes
    AnyRef → Any
  17. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  18. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  19. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()

Inherited from AnyRef

Inherited from Any

Ungrouped