source

Documentation

Index

• type FileReader
• type FileSource
  • func (fs *FileSource) GetMigrationDownFile(schema string, version int) (string, string, error)
  • func (fs *FileSource) GetMigrationUpFile(schema string, version int) (string, string, error)
  • func (fs *FileSource) GetSchemaList() ([]string, error)
  • func (fs *FileSource) GetSortedVersions(schema string) ([]int, error)
• type MigrationSource
  • func GetFileSource(baseLocation string, fs FileReader) (MigrationSource, error)
• type ReaderImplementation
  • func (f ReaderImplementation) ReadDirs(root string) ([]string, error)
  • func (f ReaderImplementation) ReadFileAsString(path string) (string, error)
  • func (f ReaderImplementation) ReadFilesWithExtension(root string, extension string) ([]string, error)

Types

type FileReader

type FileReader interface {
	ReadDirs(root string) ([]string, error)
	ReadFilesWithExtension(root string, extension string) ([]string, error)
	ReadFileAsString(path string) (string, error)
}

FileReader utlilty helps you read file system

type FileSource

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

FileSource file implementation for MigrationSource

func (*FileSource) GetMigrationDownFile

func (fs *FileSource) GetMigrationDownFile(schema string, version int) (string, string, error)

GetMigrationDownFile returns the Migration Down Files of specifed version

func (*FileSource) GetMigrationUpFile

func (fs *FileSource) GetMigrationUpFile(schema string, version int) (string, string, error)

GetMigrationUpFile returns the Migration Up Files of specifed version

func (*FileSource) GetSchemaList

func (fs *FileSource) GetSchemaList() ([]string, error)

GetSchemaList returns list of folders which will be used ad shcema names

func (*FileSource) GetSortedVersions

func (fs *FileSource) GetSortedVersions(schema string) ([]int, error)

GetSortedVersions gets the list of verrsion numbers

type MigrationSource

type MigrationSource interface {
	GetSchemaList() ([]string, error)
	GetSortedVersions(schema string) ([]int, error)
	GetMigrationUpFile(schema string, version int) (string, string, error)
	GetMigrationDownFile(schema string, version int) (string, string, error)
}

MigrationSource Interface for Giving detials about migration versions

func GetFileSource

func GetFileSource(baseLocation string, fs FileReader) (MigrationSource, error)

GetFileSource returns as Filesource Object

type ReaderImplementation

type ReaderImplementation struct {
	Fs afero.Fs
}

ReaderImplementation implementation of FileReader

func (ReaderImplementation) ReadDirs

func (f ReaderImplementation) ReadDirs(root string) ([]string, error)

ReadDirs reads all sub directories in a directory

func (ReaderImplementation) ReadFileAsString

func (f ReaderImplementation) ReadFileAsString(path string) (string, error)

func (ReaderImplementation) ReadFilesWithExtension

func (f ReaderImplementation) ReadFilesWithExtension(root string, extension string) ([]string, error)

ReadFilesWithExtension just for testing