sqlite

README

sqlite

sqlite://path/to/database?query

Unlike other migrate database drivers, the sqlite driver will automatically wrap each migration in an implicit transaction by default. Migrations must not contain explicit BEGIN or COMMIT statements. This behavior may change in a future major release. (See below for a workaround.)

The auxiliary query parameters listed below may be supplied to tailor migrate behavior. All auxiliary query parameters are optional.

URL Query	WithInstance Config	Description
x-migrations-table	MigrationsTable	Name of the migrations table. Defaults to schema_migrations.
x-no-tx-wrap	NoTxWrap	Disable implicit transactions when true. Migrations may, and should, contain explicit BEGIN and COMMIT statements.

Notes

• Uses the modernc.org/sqlite sqlite db driver (pure Go)
  • Has limited GOOS and GOARCH support

Documentation

Index

• Variables
• func WithInstance(instance *sql.DB, config *Config) (database.Driver, error)
• type Config
• type Sqlite
  • func (m *Sqlite) Close() error
  • func (m *Sqlite) Drop() (err error)
  • func (m *Sqlite) ListAppliedVersions() ([]int, error)
  • func (m *Sqlite) Lock() error
  • func (m *Sqlite) Open(url string) (database.Driver, error)
  • func (m *Sqlite) Run(migration io.Reader) error
  • func (m *Sqlite) SetSourceDriver(sourceDrv source.Driver) error
  • func (m *Sqlite) SetVersion(version int, dirty bool, forced bool, knownDirection *source.Direction) (*source.Direction, error)
  • func (m *Sqlite) Unlock() error
  • func (m *Sqlite) Version() (version int, dirty bool, err error)

Variables

var (
	ErrDatabaseDirty  = fmt.Errorf("database is dirty")
	ErrNilConfig      = fmt.Errorf("no config")
	ErrNoDatabaseName = fmt.Errorf("no database name")
)

var DefaultMigrationsTable = "schema_migrations"

Functions

func WithInstance

func WithInstance(instance *sql.DB, config *Config) (database.Driver, error)

Types

type Config

type Config struct {
	MigrationsTable string
	DatabaseName    string
	NoTxWrap        bool
}

type Sqlite

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

func (*Sqlite) Close

func (m *Sqlite) Close() error

func (*Sqlite) Drop

func (m *Sqlite) Drop() (err error)

func (*Sqlite) ListAppliedVersions

func (m *Sqlite) ListAppliedVersions() ([]int, error)

func (*Sqlite) Lock

func (m *Sqlite) Lock() error

func (*Sqlite) Open

func (m *Sqlite) Open(url string) (database.Driver, error)

func (*Sqlite) Run

func (m *Sqlite) Run(migration io.Reader) error

func (*Sqlite) SetSourceDriver

func (m *Sqlite) SetSourceDriver(sourceDrv source.Driver) error

This database driver does not currently support file sourcing.

func (*Sqlite) SetVersion

func (m *Sqlite) SetVersion(version int, dirty bool, forced bool, knownDirection *source.Direction) (*source.Direction, error)

func (*Sqlite) Unlock

func (m *Sqlite) Unlock() error

func (*Sqlite) Version

func (m *Sqlite) Version() (version int, dirty bool, err error)