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

package database

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

Package database is an experimental, auto-generated package for the Cloud Spanner Database Admin API.

Index

Examples

Package Files

database_admin_client.go doc.go

func DatabaseAdminDatabasePath Uses

func DatabaseAdminDatabasePath(project, instance, database string) string

DatabaseAdminDatabasePath returns the path for the database resource.

func DatabaseAdminInstancePath Uses

func DatabaseAdminInstancePath(project, instance string) string

DatabaseAdminInstancePath returns the path for the instance resource.

func DefaultAuthScopes Uses

func DefaultAuthScopes() []string

DefaultAuthScopes reports the authentication scopes required by this package.

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
}

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.

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.

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 the client's connection to the API service.

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][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.

Code:

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) DropDatabase Uses

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

DropDatabase drops (aka deletes) a Cloud Spanner database.

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) 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:

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][google.longrunning.Operations] API.

Code:

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 resource. Returns an empty policy if a database exists but does not have a policy set.

Authorization requires `spanner.databases.getIamPolicy` permission on [resource][google.iam.v1.GetIamPolicyRequest.resource].

Code:

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) ListDatabases Uses

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

ListDatabases lists Cloud Spanner databases.

Code:

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) SetGoogleClientInfo Uses

func (c *DatabaseAdminClient) SetGoogleClientInfo(keyval ...string)

SetGoogleClientInfo sets the name and version of the application in the `x-goog-api-client` header passed on each request. Intended for use by Google-written clients.

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 resource. Replaces any existing policy.

Authorization requires `spanner.databases.setIamPolicy` permission on [resource][google.iam.v1.SetIamPolicyRequest.resource].

Code:

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

Code:

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) 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][google.longrunning.Operation.metadata] field type is [UpdateDatabaseDdlMetadata][google.spanner.admin.database.v1.UpdateDatabaseDdlMetadata]. The operation has no response.

Code:

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)
// 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 {

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

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 any error encountered.

See documentation of Poll for error-handling information.

Package database imports 16 packages (graph) and is imported by 3 packages. Updated 2017-08-16. Refresh now. Tools for package owners.