db

Documentation

Index

• type Session
  • func NewSession() *Session
  • func (s *Session) Apply(m mig.File) error
  • func (s *Session) Connect() error
  • func (s *Session) Disconnect() error
  • func (s *Session) EnsureChangelogExists() error
  • func (s *Session) PendingMigrations(dir *mig.Dir) ([]mig.File, error)

Types

type Session

type Session struct {
	Host          string
	Port          string
	Database      string
	Username      string
	SslMode       string
	ChangelogName string
	Interactive   bool
	// contains filtered or unexported fields
}

Session represents a user session to a specific PostgreSQL database

func NewSession

func NewSession() *Session

NewSession creates a new database session object

func (*Session) Apply

func (s *Session) Apply(m mig.File) error

func (*Session) Connect

func (s *Session) Connect() error

Connect creates a new connection to the database and makes sure it is responding by pinging it.

func (*Session) Disconnect

func (s *Session) Disconnect() error

Disconnect closes the database connection

func (*Session) EnsureChangelogExists

func (s *Session) EnsureChangelogExists() error

EnsureChangelogExists creates the changelog table if it does not exist

func (*Session) PendingMigrations

func (s *Session) PendingMigrations(dir *mig.Dir) ([]mig.File, error)

PendingMigrations returns a list of migration files that have not been applied yet, according to the changelog