go: cloud.google.com/go/spanner/admin/database/apiv1 Index | Examples | Files

package database

import "cloud.google.com/go/spanner/admin/database/apiv1"

Copyright 2020 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 database is an auto-generated package for the Cloud Spanner Database Admin API.

Use of Context

The ctx passed to NewClient is used for authentication requests and for creating the underlying connection, but is not used for subsequent calls. Individual methods on the client use the ctx given to them.

To close the open connection, use the Close() method.

For information about setting deadlines, reusing contexts, and more please visit pkg.go.dev/cloud.google.com/go.

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.

Index

Examples

Package Files

backup.go database.go database_admin_client.go doc.go init.go path_funcs.go

func DatabaseAdminDatabasePath Uses

func DatabaseAdminDatabasePath(project, instance, database string) string

DatabaseAdminDatabasePath returns the path for the database resource.

Deprecated: Use

fmt.Sprintf("projects/%s/instances/%s/databases/%s", project, instance, database)

instead.

func DatabaseAdminInstancePath Uses

func DatabaseAdminInstancePath(project, instance string) string

DatabaseAdminInstancePath returns the path for the instance resource.

Deprecated: Use

fmt.Sprintf("projects/%s/instances/%s", project, instance)

instead.

func DefaultAuthScopes Uses

func DefaultAuthScopes() []string

DefaultAuthScopes reports the default set of authentication scopes to use with this package.

type BackupIterator Uses

type BackupIterator struct {

    // Response is the raw response for the current page.
    // It must be cast to the RPC response type.
    // Calling Next() or InternalFetch() updates this value.
    Response interface{}

    // InternalFetch is for use by the Google Cloud Libraries only.
    // It is not part of the stable interface of this package.
    //
    // InternalFetch returns results from a single call to the underlying RPC.
    // The number of results is no greater than pageSize.
    // If there are no more results, nextPageToken is empty and err is nil.
    InternalFetch func(pageSize int, pageToken string) (results []*databasepb.Backup, nextPageToken string, err error)
    // contains filtered or unexported fields
}

BackupIterator manages a stream of *databasepb.Backup.

func (*BackupIterator) Next Uses

func (it *BackupIterator) Next() (*databasepb.Backup, error)

Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.

func (*BackupIterator) PageInfo Uses

func (it *BackupIterator) PageInfo() *iterator.PageInfo

PageInfo supports pagination. See the google.golang.org/api/iterator package for details.

type CreateBackupOperation Uses

type CreateBackupOperation struct {
    // contains filtered or unexported fields
}

CreateBackupOperation manages a long-running operation from CreateBackup.

func (*CreateBackupOperation) Done Uses

func (op *CreateBackupOperation) Done() bool

Done reports whether the long-running operation has completed.

func (*CreateBackupOperation) Metadata Uses

func (op *CreateBackupOperation) Metadata() (*databasepb.CreateBackupMetadata, error)

Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.

func (*CreateBackupOperation) Name Uses

func (op *CreateBackupOperation) Name() string

Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.

func (*CreateBackupOperation) Poll Uses

func (op *CreateBackupOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*databasepb.Backup, error)

Poll fetches the latest state of the long-running operation.

Poll also fetches the latest metadata, which can be retrieved by Metadata.

If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.

func (*CreateBackupOperation) Wait Uses

func (op *CreateBackupOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*databasepb.Backup, error)

Wait blocks until the long-running operation is completed, returning the response and any errors encountered.

See documentation of Poll for error-handling information.

type CreateDatabaseOperation Uses

type CreateDatabaseOperation struct {
    // contains filtered or unexported fields
}

CreateDatabaseOperation manages a long-running operation from CreateDatabase.

func (*CreateDatabaseOperation) Done Uses

func (op *CreateDatabaseOperation) Done() bool

Done reports whether the long-running operation has completed.

func (*CreateDatabaseOperation) Metadata Uses

func (op *CreateDatabaseOperation) Metadata() (*databasepb.CreateDatabaseMetadata, error)

Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.

func (*CreateDatabaseOperation) Name Uses

func (op *CreateDatabaseOperation) Name() string

Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.

func (*CreateDatabaseOperation) Poll Uses

func (op *CreateDatabaseOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*databasepb.Database, error)

Poll fetches the latest state of the long-running operation.

Poll also fetches the latest metadata, which can be retrieved by Metadata.

If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.

func (*CreateDatabaseOperation) Wait Uses

func (op *CreateDatabaseOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*databasepb.Database, error)

Wait blocks until the long-running operation is completed, returning the response and any errors encountered.

See documentation of Poll for error-handling information.

type DatabaseAdminCallOptions Uses

type DatabaseAdminCallOptions struct {
    ListDatabases          []gax.CallOption
    CreateDatabase         []gax.CallOption
    GetDatabase            []gax.CallOption
    UpdateDatabaseDdl      []gax.CallOption
    DropDatabase           []gax.CallOption
    GetDatabaseDdl         []gax.CallOption
    SetIamPolicy           []gax.CallOption
    GetIamPolicy           []gax.CallOption
    TestIamPermissions     []gax.CallOption
    CreateBackup           []gax.CallOption
    GetBackup              []gax.CallOption
    UpdateBackup           []gax.CallOption
    DeleteBackup           []gax.CallOption
    ListBackups            []gax.CallOption
    RestoreDatabase        []gax.CallOption
    ListDatabaseOperations []gax.CallOption
    ListBackupOperations   []gax.CallOption
}

DatabaseAdminCallOptions contains the retry settings for each method of DatabaseAdminClient.

type DatabaseAdminClient Uses

type DatabaseAdminClient struct {

    // LROClient is used internally to handle longrunning operations.
    // It is exposed so that its CallOptions can be modified if required.
    // Users should not Close this client.
    LROClient *lroauto.OperationsClient

    // The call options for this service.
    CallOptions *DatabaseAdminCallOptions
    // contains filtered or unexported fields
}

DatabaseAdminClient is a client for interacting with Cloud Spanner Database Admin API.

Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.

func NewDatabaseAdminClient Uses

func NewDatabaseAdminClient(ctx context.Context, opts ...option.ClientOption) (*DatabaseAdminClient, error)

NewDatabaseAdminClient creates a new database admin client.

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.

Code:

ctx := context.Background()
c, err := database.NewDatabaseAdminClient(ctx)
if err != nil {
    // TODO: Handle error.
}
// TODO: Use client.
_ = c

func (*DatabaseAdminClient) Close Uses

func (c *DatabaseAdminClient) Close() error

Close closes the connection to the API service. The user should invoke this when the client is no longer required.

func (*DatabaseAdminClient) Connection Uses

func (c *DatabaseAdminClient) Connection() *grpc.ClientConn

Connection returns a connection to the API service.

Deprecated.

func (*DatabaseAdminClient) CreateBackup Uses

func (c *DatabaseAdminClient) CreateBackup(ctx context.Context, req *databasepb.CreateBackupRequest, opts ...gax.CallOption) (*CreateBackupOperation, error)

CreateBackup 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 field type is CreateBackupMetadata. The response field type is 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.

Code:

// import databasepb "google.golang.org/genproto/googleapis/spanner/admin/database/v1"

ctx := context.Background()
c, err := database.NewDatabaseAdminClient(ctx)
if err != nil {
    // TODO: Handle error.
}

req := &databasepb.CreateBackupRequest{
    // TODO: Fill request struct fields.
}
op, err := c.CreateBackup(ctx, req)
if err != nil {
    // TODO: Handle error.
}

resp, err := op.Wait(ctx)
if err != nil {
    // TODO: Handle error.
}
// TODO: Use resp.
_ = resp

func (*DatabaseAdminClient) CreateBackupOperation Uses

func (c *DatabaseAdminClient) CreateBackupOperation(name string) *CreateBackupOperation

CreateBackupOperation returns a new CreateBackupOperation from a given name. The name must be that of a previously created CreateBackupOperation, possibly from a different process.

func (*DatabaseAdminClient) CreateDatabase Uses

func (c *DatabaseAdminClient) CreateDatabase(ctx context.Context, req *databasepb.CreateDatabaseRequest, opts ...gax.CallOption) (*CreateDatabaseOperation, error)

CreateDatabase 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 field type is CreateDatabaseMetadata. The response field type is Database, if successful.

Code:

// import databasepb "google.golang.org/genproto/googleapis/spanner/admin/database/v1"

ctx := context.Background()
c, err := database.NewDatabaseAdminClient(ctx)
if err != nil {
    // TODO: Handle error.
}

req := &databasepb.CreateDatabaseRequest{
    // TODO: Fill request struct fields.
}
op, err := c.CreateDatabase(ctx, req)
if err != nil {
    // TODO: Handle error.
}

resp, err := op.Wait(ctx)
if err != nil {
    // TODO: Handle error.
}
// TODO: Use resp.
_ = resp

func (*DatabaseAdminClient) CreateDatabaseOperation Uses

func (c *DatabaseAdminClient) CreateDatabaseOperation(name string) *CreateDatabaseOperation

CreateDatabaseOperation returns a new CreateDatabaseOperation from a given name. The name must be that of a previously created CreateDatabaseOperation, possibly from a different process.

func (*DatabaseAdminClient) CreateDatabaseWithRetry Uses

func (c *DatabaseAdminClient) CreateDatabaseWithRetry(ctx context.Context, req *databasepb.CreateDatabaseRequest, opts ...gax.CallOption) (*CreateDatabaseOperation, error)

CreateDatabaseWithRetry creates a new database and retries the call if the backend returns a retryable error. The actual CreateDatabase RPC is only retried if the initial call did not reach the server. In other cases, the client will query the backend for the long-running operation that was created by the initial RPC and return that operation.

func (*DatabaseAdminClient) DeleteBackup Uses

func (c *DatabaseAdminClient) DeleteBackup(ctx context.Context, req *databasepb.DeleteBackupRequest, opts ...gax.CallOption) error

DeleteBackup deletes a pending or completed Backup.

Code:

ctx := context.Background()
c, err := database.NewDatabaseAdminClient(ctx)
if err != nil {
    // TODO: Handle error.
}

req := &databasepb.DeleteBackupRequest{
    // TODO: Fill request struct fields.
}
err = c.DeleteBackup(ctx, req)
if err != nil {
    // TODO: Handle error.
}

func (*DatabaseAdminClient) DropDatabase Uses

func (c *DatabaseAdminClient) DropDatabase(ctx context.Context, req *databasepb.DropDatabaseRequest, opts ...gax.CallOption) error

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

Code:

ctx := context.Background()
c, err := database.NewDatabaseAdminClient(ctx)
if err != nil {
    // TODO: Handle error.
}

req := &databasepb.DropDatabaseRequest{
    // TODO: Fill request struct fields.
}
err = c.DropDatabase(ctx, req)
if err != nil {
    // TODO: Handle error.
}

func (*DatabaseAdminClient) GetBackup Uses

func (c *DatabaseAdminClient) GetBackup(ctx context.Context, req *databasepb.GetBackupRequest, opts ...gax.CallOption) (*databasepb.Backup, error)

GetBackup gets metadata on a pending or completed Backup.

Code:

// import databasepb "google.golang.org/genproto/googleapis/spanner/admin/database/v1"

ctx := context.Background()
c, err := database.NewDatabaseAdminClient(ctx)
if err != nil {
    // TODO: Handle error.
}

req := &databasepb.GetBackupRequest{
    // TODO: Fill request struct fields.
}
resp, err := c.GetBackup(ctx, req)
if err != nil {
    // TODO: Handle error.
}
// TODO: Use resp.
_ = resp

func (*DatabaseAdminClient) GetDatabase Uses

func (c *DatabaseAdminClient) GetDatabase(ctx context.Context, req *databasepb.GetDatabaseRequest, opts ...gax.CallOption) (*databasepb.Database, error)

GetDatabase gets the state of a Cloud Spanner database.

Code:

// import databasepb "google.golang.org/genproto/googleapis/spanner/admin/database/v1"

ctx := context.Background()
c, err := database.NewDatabaseAdminClient(ctx)
if err != nil {
    // TODO: Handle error.
}

req := &databasepb.GetDatabaseRequest{
    // TODO: Fill request struct fields.
}
resp, err := c.GetDatabase(ctx, req)
if err != nil {
    // TODO: Handle error.
}
// TODO: Use resp.
_ = resp

func (*DatabaseAdminClient) GetDatabaseDdl Uses

func (c *DatabaseAdminClient) GetDatabaseDdl(ctx context.Context, req *databasepb.GetDatabaseDdlRequest, opts ...gax.CallOption) (*databasepb.GetDatabaseDdlResponse, error)

GetDatabaseDdl 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 API.

Code:

// import databasepb "google.golang.org/genproto/googleapis/spanner/admin/database/v1"

ctx := context.Background()
c, err := database.NewDatabaseAdminClient(ctx)
if err != nil {
    // TODO: Handle error.
}

req := &databasepb.GetDatabaseDdlRequest{
    // TODO: Fill request struct fields.
}
resp, err := c.GetDatabaseDdl(ctx, req)
if err != nil {
    // TODO: Handle error.
}
// TODO: Use resp.
_ = resp

func (*DatabaseAdminClient) GetIamPolicy Uses

func (c *DatabaseAdminClient) GetIamPolicy(ctx context.Context, req *iampb.GetIamPolicyRequest, opts ...gax.CallOption) (*iampb.Policy, error)

GetIamPolicy 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. For backups, authorization requires spanner.backups.getIamPolicy permission on resource.

Code:

// import iampb "google.golang.org/genproto/googleapis/iam/v1"

ctx := context.Background()
c, err := database.NewDatabaseAdminClient(ctx)
if err != nil {
    // TODO: Handle error.
}

req := &iampb.GetIamPolicyRequest{
    // TODO: Fill request struct fields.
}
resp, err := c.GetIamPolicy(ctx, req)
if err != nil {
    // TODO: Handle error.
}
// TODO: Use resp.
_ = resp

func (*DatabaseAdminClient) ListBackupOperations Uses

func (c *DatabaseAdminClient) ListBackupOperations(ctx context.Context, req *databasepb.ListBackupOperationsRequest, opts ...gax.CallOption) *OperationIterator

ListBackupOperations 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 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.

Code:

// import databasepb "google.golang.org/genproto/googleapis/spanner/admin/database/v1"
// import "google.golang.org/api/iterator"

ctx := context.Background()
c, err := database.NewDatabaseAdminClient(ctx)
if err != nil {
    // TODO: Handle error.
}

req := &databasepb.ListBackupOperationsRequest{
    // TODO: Fill request struct fields.
}
it := c.ListBackupOperations(ctx, req)
for {
    resp, err := it.Next()
    if err == iterator.Done {
        break
    }
    if err != nil {
        // TODO: Handle error.
    }
    // TODO: Use resp.
    _ = resp
}

func (*DatabaseAdminClient) ListBackups Uses

func (c *DatabaseAdminClient) ListBackups(ctx context.Context, req *databasepb.ListBackupsRequest, opts ...gax.CallOption) *BackupIterator

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

Code:

// import databasepb "google.golang.org/genproto/googleapis/spanner/admin/database/v1"
// import "google.golang.org/api/iterator"

ctx := context.Background()
c, err := database.NewDatabaseAdminClient(ctx)
if err != nil {
    // TODO: Handle error.
}

req := &databasepb.ListBackupsRequest{
    // TODO: Fill request struct fields.
}
it := c.ListBackups(ctx, req)
for {
    resp, err := it.Next()
    if err == iterator.Done {
        break
    }
    if err != nil {
        // TODO: Handle error.
    }
    // TODO: Use resp.
    _ = resp
}

func (*DatabaseAdminClient) ListDatabaseOperations Uses

func (c *DatabaseAdminClient) ListDatabaseOperations(ctx context.Context, req *databasepb.ListDatabaseOperationsRequest, opts ...gax.CallOption) *OperationIterator

ListDatabaseOperations 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 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.

Code:

// import databasepb "google.golang.org/genproto/googleapis/spanner/admin/database/v1"
// import "google.golang.org/api/iterator"

ctx := context.Background()
c, err := database.NewDatabaseAdminClient(ctx)
if err != nil {
    // TODO: Handle error.
}

req := &databasepb.ListDatabaseOperationsRequest{
    // TODO: Fill request struct fields.
}
it := c.ListDatabaseOperations(ctx, req)
for {
    resp, err := it.Next()
    if err == iterator.Done {
        break
    }
    if err != nil {
        // TODO: Handle error.
    }
    // TODO: Use resp.
    _ = resp
}

func (*DatabaseAdminClient) ListDatabases Uses

func (c *DatabaseAdminClient) ListDatabases(ctx context.Context, req *databasepb.ListDatabasesRequest, opts ...gax.CallOption) *DatabaseIterator

ListDatabases lists Cloud Spanner databases.

Code:

// import databasepb "google.golang.org/genproto/googleapis/spanner/admin/database/v1"
// import "google.golang.org/api/iterator"

ctx := context.Background()
c, err := database.NewDatabaseAdminClient(ctx)
if err != nil {
    // TODO: Handle error.
}

req := &databasepb.ListDatabasesRequest{
    // TODO: Fill request struct fields.
}
it := c.ListDatabases(ctx, req)
for {
    resp, err := it.Next()
    if err == iterator.Done {
        break
    }
    if err != nil {
        // TODO: Handle error.
    }
    // TODO: Use resp.
    _ = resp
}

func (*DatabaseAdminClient) RestoreDatabase Uses

func (c *DatabaseAdminClient) RestoreDatabase(ctx context.Context, req *databasepb.RestoreDatabaseRequest, opts ...gax.CallOption) (*RestoreDatabaseOperation, error)

RestoreDatabase 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 field type is RestoreDatabaseMetadata. The response type is 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.

Code:

// import databasepb "google.golang.org/genproto/googleapis/spanner/admin/database/v1"

ctx := context.Background()
c, err := database.NewDatabaseAdminClient(ctx)
if err != nil {
    // TODO: Handle error.
}

req := &databasepb.RestoreDatabaseRequest{
    // TODO: Fill request struct fields.
}
op, err := c.RestoreDatabase(ctx, req)
if err != nil {
    // TODO: Handle error.
}

resp, err := op.Wait(ctx)
if err != nil {
    // TODO: Handle error.
}
// TODO: Use resp.
_ = resp

func (*DatabaseAdminClient) RestoreDatabaseOperation Uses

func (c *DatabaseAdminClient) RestoreDatabaseOperation(name string) *RestoreDatabaseOperation

RestoreDatabaseOperation returns a new RestoreDatabaseOperation from a given name. The name must be that of a previously created RestoreDatabaseOperation, possibly from a different process.

func (*DatabaseAdminClient) SetIamPolicy Uses

func (c *DatabaseAdminClient) SetIamPolicy(ctx context.Context, req *iampb.SetIamPolicyRequest, opts ...gax.CallOption) (*iampb.Policy, error)

SetIamPolicy sets the access control policy on a database or backup resource. Replaces any existing policy.

Authorization requires spanner.databases.setIamPolicy permission on resource. For backups, authorization requires spanner.backups.setIamPolicy permission on resource.

Code:

// import iampb "google.golang.org/genproto/googleapis/iam/v1"

ctx := context.Background()
c, err := database.NewDatabaseAdminClient(ctx)
if err != nil {
    // TODO: Handle error.
}

req := &iampb.SetIamPolicyRequest{
    // TODO: Fill request struct fields.
}
resp, err := c.SetIamPolicy(ctx, req)
if err != nil {
    // TODO: Handle error.
}
// TODO: Use resp.
_ = resp

func (*DatabaseAdminClient) StartBackupOperation Uses

func (c *DatabaseAdminClient) StartBackupOperation(ctx context.Context, backupID string, databasePath string, expireTime time.Time, opts ...gax.CallOption) (*CreateBackupOperation, error)

StartBackupOperation creates a backup of the given database. It will be stored as projects/<project>/instances/<instance>/backups/<backupID>. The backup will be automatically deleted by Cloud Spanner after its expiration.

backupID must be unique across an instance.

expireTime is the time the backup will expire. It is respected to microsecond granularity.

databasePath must have the form projects/<project>/instances/<instance>/databases/<database>.

func (*DatabaseAdminClient) TestIamPermissions Uses

func (c *DatabaseAdminClient) TestIamPermissions(ctx context.Context, req *iampb.TestIamPermissionsRequest, opts ...gax.CallOption) (*iampb.TestIamPermissionsResponse, error)

TestIamPermissions 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.

Code:

// import iampb "google.golang.org/genproto/googleapis/iam/v1"

ctx := context.Background()
c, err := database.NewDatabaseAdminClient(ctx)
if err != nil {
    // TODO: Handle error.
}

req := &iampb.TestIamPermissionsRequest{
    // TODO: Fill request struct fields.
}
resp, err := c.TestIamPermissions(ctx, req)
if err != nil {
    // TODO: Handle error.
}
// TODO: Use resp.
_ = resp

func (*DatabaseAdminClient) UpdateBackup Uses

func (c *DatabaseAdminClient) UpdateBackup(ctx context.Context, req *databasepb.UpdateBackupRequest, opts ...gax.CallOption) (*databasepb.Backup, error)

UpdateBackup updates a pending or completed Backup.

Code:

// import databasepb "google.golang.org/genproto/googleapis/spanner/admin/database/v1"

ctx := context.Background()
c, err := database.NewDatabaseAdminClient(ctx)
if err != nil {
    // TODO: Handle error.
}

req := &databasepb.UpdateBackupRequest{
    // TODO: Fill request struct fields.
}
resp, err := c.UpdateBackup(ctx, req)
if err != nil {
    // TODO: Handle error.
}
// TODO: Use resp.
_ = resp

func (*DatabaseAdminClient) UpdateDatabaseDdl Uses

func (c *DatabaseAdminClient) UpdateDatabaseDdl(ctx context.Context, req *databasepb.UpdateDatabaseDdlRequest, opts ...gax.CallOption) (*UpdateDatabaseDdlOperation, error)

UpdateDatabaseDdl 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 field type is UpdateDatabaseDdlMetadata. The operation has no response.

Code:

// import databasepb "google.golang.org/genproto/googleapis/spanner/admin/database/v1"

ctx := context.Background()
c, err := database.NewDatabaseAdminClient(ctx)
if err != nil {
    // TODO: Handle error.
}

req := &databasepb.UpdateDatabaseDdlRequest{
    // TODO: Fill request struct fields.
}
op, err := c.UpdateDatabaseDdl(ctx, req)
if err != nil {
    // TODO: Handle error.
}

err = op.Wait(ctx)
if err != nil {
    // TODO: Handle error.
}

func (*DatabaseAdminClient) UpdateDatabaseDdlOperation Uses

func (c *DatabaseAdminClient) UpdateDatabaseDdlOperation(name string) *UpdateDatabaseDdlOperation

UpdateDatabaseDdlOperation returns a new UpdateDatabaseDdlOperation from a given name. The name must be that of a previously created UpdateDatabaseDdlOperation, possibly from a different process.

type DatabaseIterator Uses

type DatabaseIterator struct {

    // Response is the raw response for the current page.
    // It must be cast to the RPC response type.
    // Calling Next() or InternalFetch() updates this value.
    Response interface{}

    // InternalFetch is for use by the Google Cloud Libraries only.
    // It is not part of the stable interface of this package.
    //
    // InternalFetch returns results from a single call to the underlying RPC.
    // The number of results is no greater than pageSize.
    // If there are no more results, nextPageToken is empty and err is nil.
    InternalFetch func(pageSize int, pageToken string) (results []*databasepb.Database, nextPageToken string, err error)
    // contains filtered or unexported fields
}

DatabaseIterator manages a stream of *databasepb.Database.

func (*DatabaseIterator) Next Uses

func (it *DatabaseIterator) Next() (*databasepb.Database, error)

Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.

func (*DatabaseIterator) PageInfo Uses

func (it *DatabaseIterator) PageInfo() *iterator.PageInfo

PageInfo supports pagination. See the google.golang.org/api/iterator package for details.

type OperationIterator Uses

type OperationIterator struct {

    // Response is the raw response for the current page.
    // It must be cast to the RPC response type.
    // Calling Next() or InternalFetch() updates this value.
    Response interface{}

    // InternalFetch is for use by the Google Cloud Libraries only.
    // It is not part of the stable interface of this package.
    //
    // InternalFetch returns results from a single call to the underlying RPC.
    // The number of results is no greater than pageSize.
    // If there are no more results, nextPageToken is empty and err is nil.
    InternalFetch func(pageSize int, pageToken string) (results []*longrunningpb.Operation, nextPageToken string, err error)
    // contains filtered or unexported fields
}

OperationIterator manages a stream of *longrunningpb.Operation.

func (*OperationIterator) Next Uses

func (it *OperationIterator) Next() (*longrunningpb.Operation, error)

Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.

func (*OperationIterator) PageInfo Uses

func (it *OperationIterator) PageInfo() *iterator.PageInfo

PageInfo supports pagination. See the google.golang.org/api/iterator package for details.

type RestoreDatabaseOperation Uses

type RestoreDatabaseOperation struct {
    // contains filtered or unexported fields
}

RestoreDatabaseOperation manages a long-running operation from RestoreDatabase.

func (*RestoreDatabaseOperation) Done Uses

func (op *RestoreDatabaseOperation) Done() bool

Done reports whether the long-running operation has completed.

func (*RestoreDatabaseOperation) Metadata Uses

func (op *RestoreDatabaseOperation) Metadata() (*databasepb.RestoreDatabaseMetadata, error)

Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.

func (*RestoreDatabaseOperation) Name Uses

func (op *RestoreDatabaseOperation) Name() string

Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.

func (*RestoreDatabaseOperation) Poll Uses

func (op *RestoreDatabaseOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*databasepb.Database, error)

Poll fetches the latest state of the long-running operation.

Poll also fetches the latest metadata, which can be retrieved by Metadata.

If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.

func (*RestoreDatabaseOperation) Wait Uses

func (op *RestoreDatabaseOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*databasepb.Database, error)

Wait blocks until the long-running operation is completed, returning the response and any errors encountered.

See documentation of Poll for error-handling information.

type UpdateDatabaseDdlOperation Uses

type UpdateDatabaseDdlOperation struct {
    // contains filtered or unexported fields
}

UpdateDatabaseDdlOperation manages a long-running operation from UpdateDatabaseDdl.

func (*UpdateDatabaseDdlOperation) Done Uses

func (op *UpdateDatabaseDdlOperation) Done() bool

Done reports whether the long-running operation has completed.

func (*UpdateDatabaseDdlOperation) Metadata Uses

func (op *UpdateDatabaseDdlOperation) Metadata() (*databasepb.UpdateDatabaseDdlMetadata, error)

Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.

func (*UpdateDatabaseDdlOperation) Name Uses

func (op *UpdateDatabaseDdlOperation) Name() string

Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.

func (*UpdateDatabaseDdlOperation) Poll Uses

func (op *UpdateDatabaseDdlOperation) Poll(ctx context.Context, opts ...gax.CallOption) error

Poll fetches the latest state of the long-running operation.

Poll also fetches the latest metadata, which can be retrieved by Metadata.

If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.

func (*UpdateDatabaseDdlOperation) Wait Uses

func (op *UpdateDatabaseDdlOperation) Wait(ctx context.Context, opts ...gax.CallOption) error

Wait blocks until the long-running operation is completed, returning the response and any errors encountered.

See documentation of Poll for error-handling information.

Package database imports 26 packages (graph) and is imported by 37 packages. Updated 2020-09-25. Refresh now. Tools for package owners.