admin

Documentation

Index

• type SpannerAdmin
  • func (a *SpannerAdmin) AlterDatabase(db string, ddl []string) error
  • func (a *SpannerAdmin) CreateAdminClient() error
  • func (a *SpannerAdmin) CreateDatabase(db string, ddl []string) error

Examples

• SpannerAdmin.AlterDatabase
• SpannerAdmin.CreateAdminClient
• SpannerAdmin.CreateDatabase

Types

type SpannerAdmin

type SpannerAdmin struct {
	Context     context.Context
	Project     string
	Instance    string
	Opts        []option.ClientOption
	AdminClient *database.DatabaseAdminClient
}

SpannerAdmin - Wrapper for Cloud Spanner admin.

func (*SpannerAdmin) AlterDatabase

func (a *SpannerAdmin) AlterDatabase(db string, ddl []string) error

AlterDatabase - Alter a Cloud Spanner database.

Can be used with any valid DDL to add/alter/drop tables or add/alter/drop indexes.

Params:

db string - Name of the Cloud Spanner database to create.
ddl []string - Data Definition Language statements to alter a database.

Return:

error - An error if it occurred.

Example

ExampleSpannerAdmin_AlterDatabase - Example usage for AlterDatabase.

ctx := context.Background()

// Create the admin struct.
spannerAdmin := &SpannerAdmin{
	Context:  ctx,
	Project:  "my-awesome-project-id",
	Instance: "my-awesome-spanner-instance",
}

// Create the admin client.
err := spannerAdmin.CreateAdminClient()
if err != nil {
	fmt.Fprintf(os.Stderr, "Failed to create Spanner admin client. Reason - %+v", err)
}

// Some indexes we want to add.
indexDDL := []string{
	`CREATE INDEX AlbumsByAlbumTitle ON Albums(AlbumTitle)`,
	`CREATE INDEX AlbumsByAlbumTitle2 ON Albums(AlbumTitle) STORING (MarketingBudget)`,
}

// Alter the database.
dbErr := spannerAdmin.AlterDatabase("my-awesome-spanner-database", indexDDL)
if dbErr != nil {
	fmt.Fprintf(os.Stderr, "Failed to alter Spanner database. Reason - %+v", dbErr)
}

func (*SpannerAdmin) CreateAdminClient

func (a *SpannerAdmin) CreateAdminClient() error

CreateAdminClient - Create a new Cloud Spanner admin client.

Return:

error - An error if it occurred.

Example

ExampleSpannerAdmin_CreateAdminClient - Example usage for CreateAdminClient.

ctx := context.Background()

// Create the admin struct.
spannerAdmin := &SpannerAdmin{
	Context:  ctx,
	Project:  "my-awesome-project-id",
	Instance: "my-awesome-spanner-instance",
}

// Create the admin client.
err := spannerAdmin.CreateAdminClient()
if err != nil {
	fmt.Fprintf(os.Stderr, "Failed to create Spanner admin client. Reason - %+v", err)
	os.Exit(1)
}

func (*SpannerAdmin) CreateDatabase

func (a *SpannerAdmin) CreateDatabase(db string, ddl []string) error

CreateDatabase - Create a new Cloud Spanner database.

Params:

db string - Name of the Cloud Spanner database to create.
ddl []string - Data Definition Language statements to apply to the newly
created database.

Return:

error - An error if it occurred.

Example

ExampleSpannerAdmin_CreateDatabase - Example usage for CreateDatabase.

ctx := context.Background()

// Create the admin struct.
spannerAdmin := &SpannerAdmin{
	Context:  ctx,
	Project:  "my-awesome-project-id",
	Instance: "my-awesome-spanner-instance",
}

// Create the admin client.
err := spannerAdmin.CreateAdminClient()
if err != nil {
	fmt.Fprintf(os.Stderr, "Failed to create Spanner admin client. Reason - %+v", err)
}

// Some tables to create with the database.
tablesDDL := []string{
	`CREATE TABLE Singers (
			SingerId   INT64 NOT NULL,
			FirstName  STRING(1024),
			LastName   STRING(1024),
			SingerInfo BYTES(MAX)
		) PRIMARY KEY (SingerId)`,
	`CREATE TABLE Albums (
			SingerId	INT64 NOT NULL,
			AlbumId		INT64 NOT NULL,
			AlbumTitle	STRING(MAX),
		) PRIMARY KEY (SingerId, AlbumId),
		INTERLEAVE IN PARENT Singers ON DELETE CASCADE`,
}

// Create the database.
dbErr := spannerAdmin.CreateDatabase("my-awesome-spanner-database", tablesDDL)
if dbErr != nil {
	fmt.Fprintf(os.Stderr, "Failed to create Spanner database. Reason - %+v", dbErr)
}