roll

package

v0.5.0 Latest Latest Go to latest Published: Feb 7, 2024 License: Apache-2.0 Imports: 9 Imported by: 1

Details

This section is empty.

This section is empty.

func VersionedSchemaName(schema string, version string) string

type Option func(*options)

func WithDisableViewsManagement() Option

WithDisableViewsManagement disables pgroll version schemas management when passed, pgroll will not create or drop version schemas

func WithLockTimeoutMs(lockTimeoutMs int) Option

WithLockTimeoutMs sets the lock timeout in milliseconds for pgroll DDL operations

func WithRole(role string) Option

WithRole sets the role to set before executing migrations

type PGVersion int

const PGVersion15 PGVersion = 15

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

func New(ctx context.Context, pgURL, schema string, state *state.State, opts ...Option) (*Roll, error)

func (m *Roll) Close() error

func (m *Roll) Complete(ctx context.Context) error

Complete will update the database schema to match the current version

func (m *Roll) Init(ctx context.Context) error

func (m *Roll) PGVersion() PGVersion

func (m *Roll) Rollback(ctx context.Context) error

func (m *Roll) Start(ctx context.Context, migration *migrations.Migration, cbs ...migrations.CallbackFn) error

Start will apply the required changes to enable supporting the new schema version

func (m *Roll) Status(ctx context.Context, schema string) (*state.Status, error)