spanner

Documentation

Index

• Constants
• Variables
• type Client
  • func NewClient(ctx context.Context, config *Config) (*Client, error)
  • func (c *Client) ApplyDDL(ctx context.Context, statements []string) error
  • func (c *Client) ApplyDDLFile(ctx context.Context, ddl []byte) error
  • func (c *Client) ApplyDML(ctx context.Context, statements []string) (int64, error)
  • func (c *Client) ApplyDMLFile(ctx context.Context, ddl []byte, partitioned bool) (int64, error)
  • func (c *Client) ApplyPartitionedDML(ctx context.Context, statements []string) (int64, error)
  • func (c *Client) Close() error
  • func (c *Client) CreateDatabase(ctx context.Context, ddl []byte) error
  • func (c *Client) DetermineUpgradeStatus(ctx context.Context, tableName string) (UpgradeStatus, error)
  • func (c *Client) DropDatabase(ctx context.Context) error
  • func (c *Client) EnsureMigrationTable(ctx context.Context, tableName string) error
  • func (c *Client) ExecuteMigrations(ctx context.Context, migrations Migrations, limit int, tableName string) error
  • func (c *Client) GetMigrationHistory(ctx context.Context, versionTableName string) ([]MigrationHistoryRecord, error)
  • func (c *Client) GetMigrationLock(ctx context.Context, tableName, lockIdentifier string) (lock MigrationLock, err error)
  • func (c *Client) GetSchemaMigrationVersion(ctx context.Context, tableName string) (uint, bool, error)
  • func (c *Client) LoadDDL(ctx context.Context) ([]byte, error)
  • func (c *Client) LoadDDLs(ctx context.Context) ([]SchemaDDL, error)
  • func (c *Client) SetSchemaMigrationVersion(ctx context.Context, version uint, dirty bool, tableName string) error
  • func (c *Client) SetupMigrationLock(ctx context.Context, tableName string) error
  • func (c *Client) TruncateAllTables(ctx context.Context) error
  • func (c *Client) UpgradeExecuteMigrations(ctx context.Context, migrations Migrations, limit int, tableName string) error
• type Config
  • func (c *Config) URL() string
• type Error
  • func (e *Error) Error() string
• type ErrorCode
• type Migration
• type MigrationHistoryRecord
• type MigrationLock
• type Migrations
  • func LoadMigrations(dir string) (Migrations, error)
  • func (ms Migrations) Len() int
  • func (ms Migrations) Less(i, j int) bool
  • func (ms Migrations) Swap(i, j int)
• type SchemaDDL
• type UpgradeStatus

Constants

const (
	FirstRun                           = UpgradeStatus("FirstRun")
	ExistingMigrationsNoUpgrade        = UpgradeStatus("NoUpgrade")
	ExistingMigrationsUpgradeStarted   = UpgradeStatus("Started")
	ExistingMigrationsUpgradeCompleted = UpgradeStatus("Completed")
)

const (
	ErrorCodeCreateClient = iota + 1
	ErrorCodeCloseClient
	ErrorCodeCreateDatabase
	ErrorCodeDropDatabase
	ErrorCodeTruncateAllTables
	ErrorCodeLoadSchema
	ErrorCodeUpdateDDL
	ErrorCodeUpdateDML
	ErrorCodeUpdatePartitionedDML
	ErrorCodeExecuteMigrations
	ErrorCodeGetMigrationVersion
	ErrorCodeSetMigrationVersion
	ErrorCodeNoMigration
	ErrorCodeMigrationVersionDirty
	ErrorCodeWaitOperation
	ErrorCodeEnsureMigrationTables
	ErrorCodeCompleteUpgrade
)

Variables

var (
	MigrationNameRegex = regexp.MustCompile(`[a-zA-Z0-9_\-]+`)
)

Types

type Client

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

func NewClient

func NewClient(ctx context.Context, config *Config) (*Client, error)

func (*Client) ApplyDDL

func (c *Client) ApplyDDL(ctx context.Context, statements []string) error

func (*Client) ApplyDDLFile

func (c *Client) ApplyDDLFile(ctx context.Context, ddl []byte) error

func (*Client) ApplyDML

func (c *Client) ApplyDML(ctx context.Context, statements []string) (int64, error)

func (*Client) ApplyDMLFile

func (c *Client) ApplyDMLFile(ctx context.Context, ddl []byte, partitioned bool) (int64, error)

func (*Client) ApplyPartitionedDML

func (c *Client) ApplyPartitionedDML(ctx context.Context, statements []string) (int64, error)

func (*Client) Close

func (c *Client) Close() error

func (*Client) CreateDatabase

func (c *Client) CreateDatabase(ctx context.Context, ddl []byte) error

func (*Client) DetermineUpgradeStatus

func (c *Client) DetermineUpgradeStatus(ctx context.Context, tableName string) (UpgradeStatus, error)

func (*Client) DropDatabase

func (c *Client) DropDatabase(ctx context.Context) error

func (*Client) EnsureMigrationTable

func (c *Client) EnsureMigrationTable(ctx context.Context, tableName string) error

func (*Client) ExecuteMigrations

func (c *Client) ExecuteMigrations(ctx context.Context, migrations Migrations, limit int, tableName string) error

func (*Client) GetMigrationHistory

func (c *Client) GetMigrationHistory(ctx context.Context, versionTableName string) ([]MigrationHistoryRecord, error)

func (*Client) GetMigrationLock

func (c *Client) GetMigrationLock(ctx context.Context, tableName, lockIdentifier string) (lock MigrationLock, err error)

func (*Client) GetSchemaMigrationVersion

func (c *Client) GetSchemaMigrationVersion(ctx context.Context, tableName string) (uint, bool, error)

func (*Client) LoadDDL

func (c *Client) LoadDDL(ctx context.Context) ([]byte, error)

func (*Client) LoadDDLs

func (c *Client) LoadDDLs(ctx context.Context) ([]SchemaDDL, error)

func (*Client) SetSchemaMigrationVersion

func (c *Client) SetSchemaMigrationVersion(ctx context.Context, version uint, dirty bool, tableName string) error

func (*Client) SetupMigrationLock

func (c *Client) SetupMigrationLock(ctx context.Context, tableName string) error

func (*Client) TruncateAllTables

func (c *Client) TruncateAllTables(ctx context.Context) error

func (*Client) UpgradeExecuteMigrations

func (c *Client) UpgradeExecuteMigrations(ctx context.Context, migrations Migrations, limit int, tableName string) error

type Config

type Config struct {
	Project         string
	Instance        string
	Database        string
	CredentialsFile string
}

func (*Config) URL

func (c *Config) URL() string

type Error

type Error struct {
	Code ErrorCode
	// contains filtered or unexported fields
}

func (*Error) Error

func (e *Error) Error() string

type ErrorCode

type ErrorCode int

type Migration

type Migration struct {
	// Version is the version of the migration
	Version uint

	// Name is the name of the migration
	Name string

	// Statements is the migration statements
	Statements []string
	// contains filtered or unexported fields
}

migration represents the parsed migration file. e.g. version_name.sql

type MigrationHistoryRecord

type MigrationHistoryRecord struct {
	Version  int64     `spanner:"Version"`
	Dirty    bool      `spanner:"Dirty"`
	Created  time.Time `spanner:"Created"`
	Modified time.Time `spanner:"Modified"`
}

type MigrationLock

type MigrationLock struct {
	Success        bool
	Release        func()
	LockIdentifier string    `spanner:"LockIdentifier"`
	Expiry         time.Time `spanner:"Expiry"`
}

type Migrations

type Migrations []*Migration

func LoadMigrations

func LoadMigrations(dir string) (Migrations, error)

func (Migrations) Len

func (ms Migrations) Len() int

func (Migrations) Less

func (ms Migrations) Less(i, j int) bool

func (Migrations) Swap

func (ms Migrations) Swap(i, j int)

type SchemaDDL

type SchemaDDL struct {
	Statement  string
	Filename   string
	ObjectType string
}

type UpgradeStatus

type UpgradeStatus string