sql

Documentation

Overview

Code adapted from https://github.com/jackc/tern/blob/master/migrate/internal/sqlsplit/sqlsplit.go

Index

• func SQLSplit(sql string) []string
• type DatabaseName
• type DatabaseServer
• type DatabaseStatus
• type LocalSqlServer
  • func NewLocalSqlServer(projectName string, localResources *resources.LocalResourcesService, ...) (*LocalSqlServer, error)
  • func (l *LocalSqlServer) BuildAndRunMigrations(fs afero.Fs, databasesToMigrate map[string]*resourcespb.SqlDatabaseResource, ...) error
  • func (l *LocalSqlServer) ConnectionString(ctx context.Context, req *sqlpb.SqlConnectionStringRequest) (*sqlpb.SqlConnectionStringResponse, error)
  • func (l *LocalSqlServer) GetState() State
  • func (l *LocalSqlServer) Publish(state State)
  • func (l *LocalSqlServer) Query(ctx context.Context, connectionString string, query string) ([]*orderedmap.OrderedMap[string, any], error)
  • func (l *LocalSqlServer) RegisterDatabases(lrs resources.LocalResourcesState)
  • func (l *LocalSqlServer) Stop() error
  • func (l *LocalSqlServer) SubscribeToState(subscriberFunction func(State))
• type MigrationRunner
• type State

Functions

func SQLSplit

func SQLSplit(sql string) []string

Split splits sql into into a slice of strings each containing one SQL statement.

Types

type DatabaseName

type DatabaseName = string

type DatabaseServer

type DatabaseServer struct {
	DatabaseName     string
	Status           string
	ResourceRegister *resources.ResourceRegister[resourcespb.SqlDatabaseResource]
	ConnectionString string
}

type DatabaseStatus

type DatabaseStatus string

const (
	DatabaseStatusStarting           DatabaseStatus = "starting"
	DatabaseStatusBuildingMigrations DatabaseStatus = "building migrations"
	DatabaseStatusApplyingMigrations DatabaseStatus = "applying migrations"
	DatabaseStatusActive             DatabaseStatus = "active"
	DatabaseStatusError              DatabaseStatus = "error"
)

type LocalSqlServer

type LocalSqlServer struct {
	State State
	sqlpb.UnimplementedSqlServer
	// contains filtered or unexported fields
}

func NewLocalSqlServer

func NewLocalSqlServer(projectName string, localResources *resources.LocalResourcesService, migrationRunner MigrationRunner, connectionStringHost string) (*LocalSqlServer, error)

func (*LocalSqlServer) BuildAndRunMigrations

func (l *LocalSqlServer) BuildAndRunMigrations(fs afero.Fs, databasesToMigrate map[string]*resourcespb.SqlDatabaseResource, useBuilder bool) error

func (*LocalSqlServer) ConnectionString

func (l *LocalSqlServer) ConnectionString(ctx context.Context, req *sqlpb.SqlConnectionStringRequest) (*sqlpb.SqlConnectionStringResponse, error)

func (*LocalSqlServer) GetState

func (l *LocalSqlServer) GetState() State

func (*LocalSqlServer) Publish

func (l *LocalSqlServer) Publish(state State)

func (*LocalSqlServer) Query

func (l *LocalSqlServer) Query(ctx context.Context, connectionString string, query string) ([]*orderedmap.OrderedMap[string, any], error)

create a function that will execute a query on the local database

func (*LocalSqlServer) RegisterDatabases

func (l *LocalSqlServer) RegisterDatabases(lrs resources.LocalResourcesState)

func (*LocalSqlServer) Stop

func (l *LocalSqlServer) Stop() error

func (*LocalSqlServer) SubscribeToState

func (l *LocalSqlServer) SubscribeToState(subscriberFunction func(State))

type MigrationRunner

type MigrationRunner = func(fs afero.Fs, servers map[string]*DatabaseServer, databasesToMigrate map[string]*resourcespb.SqlDatabaseResource, useBuilder bool) error

type State

type State = map[DatabaseName]*DatabaseServer