package source

Import Path
	github.com/golang-migrate/migrate/v4/source (on go.dev)

Dependency Relation
	imports 7 packages, and imported by 2 packages

Involved Source Files

	   d➜ driver.go
		Package source provides the Source interface.
		All source drivers must implement this interface, register themselves,
		optionally provide a `WithInstance` function and pass the tests
		in package source/testing.

	      migration.go
	      parse.go
Package-Level Type Names (total 5, in which 4 are exported)

	/* sort exporteds by: alphabet | popularity */
	 type Direction string (basic type)
		Direction is either up or down.

		As Types Of (total 2, both are exported)
			const Down
			const Up

	 type Driver (interface)
		Driver is the interface every source driver must implement.

		How to implement a source driver?
		  1. Implement this interface.
		  2. Optionally, add a function named `WithInstance`.
		     This function should accept an existing source instance and a Config{} struct
		     and return a driver instance.
		  3. Add a test that calls source/testing.go:Test()
		  4. Add own tests for Open(), WithInstance() (when provided) and Close().
		     All other functions are tested by tests in source/testing.
		     Saves you some time and makes sure all source drivers behave the same way.
		  5. Call Register in init().

		Guidelines:
		  * All configuration input must come from the URL string in func Open()
		    or the Config{} struct in WithInstance. Don't os.Getenv().
		  * Drivers are supposed to be read only.
		  * Ideally don't load any contents (into memory) in Open or WithInstance.

		Methods (total 7, all are exported)
			( T) Close() error
				Close closes the underlying source instance managed by the driver.
				Migrate will call this function only once per instance.

			( T) First() (version uint, err error)
				First returns the very first migration version available to the driver.
				Migrate will call this function multiple times.
				If there is no version available, it must return os.ErrNotExist.

			( T) Next(version uint) (nextVersion uint, err error)
				Next returns the next version for a given version available to the driver.
				Migrate will call this function multiple times.
				If there is no next version available, it must return os.ErrNotExist.

			( T) Open(url string) (Driver, error)
				Open returns a a new driver instance configured with parameters
				coming from the URL string. Migrate will call this function
				only once per instance.

			( T) Prev(version uint) (prevVersion uint, err error)
				Prev returns the previous version for a given version available to the driver.
				Migrate will call this function multiple times.
				If there is no previous version available, it must return os.ErrNotExist.

			( T) ReadDown(version uint) (r io.ReadCloser, identifier string, err error)
				ReadDown returns the DOWN migration body and an identifier that helps
				finding this migration in the source for a given version.
				If there is no down migration available for this version,
				it must return os.ErrNotExist.
				Do not start reading, just return the ReadCloser!

			( T) ReadUp(version uint) (r io.ReadCloser, identifier string, err error)
				ReadUp returns the UP migration body and an identifier that helps
				finding this migration in the source for a given version.
				If there is no up migration available for this version,
				it must return os.ErrNotExist.
				Do not start reading, just return the ReadCloser!

		Implemented By (at least one exported)
			*github.com/golang-migrate/migrate/v4/source/file.File
		Implements (at least one exported)
			 T : io.Closer
		As Outputs Of (at least 3, all are exported)
			func Open(url string) (Driver, error)
			func Driver.Open(url string) (Driver, error)
			func github.com/golang-migrate/migrate/v4/source/file.(*File).Open(url string) (Driver, error)
		As Inputs Of (at least 3, all are exported)
			func Register(name string, driver Driver)
			func github.com/golang-migrate/migrate/v4.NewWithInstance(sourceName string, sourceInstance Driver, databaseName string, databaseInstance database.Driver) (*migrate.Migrate, error)
			func github.com/golang-migrate/migrate/v4.NewWithSourceInstance(sourceName string, sourceInstance Driver, databaseURL string) (*migrate.Migrate, error)

	 type Migration (struct)
		Migration is a helper struct for source drivers that need to
		build the full directory tree in memory.
		Migration is fully independent from migrate.Migration.

		Fields (total 4, all are exported)
			Direction Direction
				Direction is either Up or Down.

			Identifier string
				Identifier can be any string that helps identifying
				this migration in the source.

			Raw string
				Raw holds the raw location path to this migration in source.
				ReadUp and ReadDown will use this.

			Version uint
				Version is the version of this migration.

		As Outputs Of (at least 3, all are exported)
			func Parse(raw string) (*Migration, error)
			func (*Migrations).Down(version uint) (m *Migration, ok bool)
			func (*Migrations).Up(version uint) (m *Migration, ok bool)
		As Inputs Of (at least one exported)
			func (*Migrations).Append(m *Migration) (ok bool)

	 type Migrations (struct)
		Migrations wraps Migration and has an internal index
		to keep track of Migration order.

		Fields (total 2, neither is exported)
			/* 2 unexporteds ... *//* 2 unexporteds: */
			index uintSlice
			migrations map[uint]map[Direction]*Migration
		Methods (total 8, in which 6 are exported)
			(*T) Append(m *Migration) (ok bool)
			(*T) Down(version uint) (m *Migration, ok bool)
			(*T) First() (version uint, ok bool)
			(*T) Next(version uint) (nextVersion uint, ok bool)
			(*T) Prev(version uint) (prevVersion uint, ok bool)
			(*T) Up(version uint) (m *Migration, ok bool)
			/* 2 unexporteds ... *//* 2 unexporteds: */
			(*T) buildIndex()
			(*T) findPos(version uint) int
		As Outputs Of (at least one exported)
			func NewMigrations() *Migrations

	/* one unexported ... *//* one unexported: */
	 type uintSlice ([]T)

		Methods (total 4, all are exported)
			( T) Len() int
			( T) Less(i, j int) bool
			( T) Search(x uint) int
			( T) Swap(i, j int)
		Implements (at least 2, in which 1 are exported)
			 T : sort.Interface
			/* at least one unexported ... *//* at least one unexported: */
			 T : github.com/aws/aws-sdk-go/aws/corehandlers.lener


Package-Level Functions (total 5, all are exported)

	 func List() []string
		List lists the registered drivers

	 func NewMigrations() *Migrations
	 func Open(url string) (Driver, error)
		Open returns a new driver instance.

	 func Parse(raw string) (*Migration, error)
		Parse returns Migration for matching Regex pattern.

	 func Register(name string, driver Driver)
		Register globally registers a driver.


Package-Level Variables (total 6, in which 4 are exported)

	  var DefaultParse func(raw string) (*Migration, error)
	  var DefaultRegex *regexp.Regexp
	  var ErrParse error
	  var Regex *regexp.Regexp
		Regex matches the following pattern:
		 123_name.up.ext
		 123_name.down.ext

	/* 2 unexporteds ... *//* 2 unexporteds: */
	  var drivers map[string]Driver
	  var driversMu sync.RWMutex
Package-Level Constants (total 2, both are exported)

	const Down Direction = "down"
	const Up Direction = "up"

The pages are generated with Golds v0.3.2-preview. (GOOS=darwin GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @Go100and1 (reachable from the left QR code) to get the latest news of Golds.