Documentation

Overview

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

    NOTE: This package is in alpha. It is not stable, and is likely to change.
    

    Index

    Examples

    Constants

    This section is empty.

    Variables

    This section is empty.

    Functions

    func DatabaseAdminDatabasePath

    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

      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

        func DefaultAuthScopes() []string

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

          Types

          type CreateDatabaseOperation

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

            CreateDatabaseOperation manages a long-running operation from CreateDatabase.

            func (*CreateDatabaseOperation) Done

            func (op *CreateDatabaseOperation) Done() bool

              Done reports whether the long-running operation has completed.

              func (*CreateDatabaseOperation) Metadata

                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

                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

                    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

                      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

                      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

                        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

                          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.

                          Example
                          Output:
                          
                          

                          func (*DatabaseAdminClient) Close

                          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

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

                              Connection returns the client's connection to the API service.

                              func (*DatabaseAdminClient) CreateDatabase

                                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.

                                Example
                                Output:
                                
                                

                                func (*DatabaseAdminClient) CreateDatabaseOperation

                                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

                                    DropDatabase drops (aka deletes) a Cloud Spanner database.

                                    Example
                                    Output:
                                    
                                    

                                    func (*DatabaseAdminClient) GetDatabase

                                      GetDatabase gets the state of a Cloud Spanner database.

                                      Example
                                      Output:
                                      
                                      

                                      func (*DatabaseAdminClient) GetDatabaseDdl

                                        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.

                                        Example
                                        Output:
                                        
                                        

                                        func (*DatabaseAdminClient) GetIamPolicy

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

                                          Example
                                          Output:
                                          
                                          

                                          func (*DatabaseAdminClient) ListDatabases

                                            ListDatabases lists Cloud Spanner databases.

                                            Example
                                            Output:
                                            
                                            

                                            func (*DatabaseAdminClient) SetIamPolicy

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

                                              Example
                                              Output:
                                              
                                              

                                              func (*DatabaseAdminClient) TestIamPermissions

                                                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.

                                                Example
                                                Output:
                                                
                                                

                                                func (*DatabaseAdminClient) UpdateDatabaseDdl

                                                  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.

                                                  Example
                                                  Output:
                                                  
                                                  

                                                  func (*DatabaseAdminClient) UpdateDatabaseDdlOperation

                                                  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

                                                    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

                                                      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

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

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

                                                          type UpdateDatabaseDdlOperation

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

                                                            UpdateDatabaseDdlOperation manages a long-running operation from UpdateDatabaseDdl.

                                                            func (*UpdateDatabaseDdlOperation) Done

                                                            func (op *UpdateDatabaseDdlOperation) Done() bool

                                                              Done reports whether the long-running operation has completed.

                                                              func (*UpdateDatabaseDdlOperation) Metadata

                                                                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

                                                                  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

                                                                    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

                                                                      Wait blocks until the long-running operation is completed, returning any error encountered.

                                                                      See documentation of Poll for error-handling information.