migrator

package

v1.0.7 Latest Latest Go to latest Published: Jul 21, 2021 License: Apache-2.0 Imports: 13 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/jucardi/go-mongodb-lib

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func SetLogger(logger log.ILogger)
type MigrationError
- func Migrate(dataDir string, db mgo.IDatabase, failOnOrderMismatch bool, ...) *MigrationError
type MigrationErrorCode
type MigrationInfo

Constants ¶

View Source

const (
	MigrationCollection = "_migration"
	ErrFileAccess       = 0x1
	ErrDbAccess         = 0x2
	ErrDbOperation      = 0x4
	ErrOrderFailed      = 0x8
	ErrHashingFailed    = 0x16
)

Variables ¶

This section is empty.

Functions ¶

func SetLogger ¶ added in v1.0.3

func SetLogger(logger log.ILogger)

Types ¶

type MigrationError ¶

type MigrationError struct {
	Message string
	Code    int
}

func Migrate ¶

func Migrate(dataDir string, db mgo.IDatabase, failOnOrderMismatch bool, collectionIdSuffix ...string) *MigrationError

Migrate begins a DB migration process by migrating the scripts located in the provided data dir and storing the migration track in a migration repository ('_migration' by default)

{dataDir}              - The location where the migration scripts are contained
{db}                   - The database client already initialized
{failOnOrderMismatch}  - Indicates whether the migration should fail if the order of previously migrated scripts
                         have failed (removing or adding scripts between previously migrated scripts)
{collectionIdSuffix}   - (optional) A suffix to use for the collection name where the migration data is stored.
                         This is useful when sharing the same database instance with multiple services that own
                         their unique collections.

func (*MigrationError) Error ¶

func (m *MigrationError) Error() string

Returns the error message

func (*MigrationError) ErrorCode ¶

func (m *MigrationError) ErrorCode() int

func (*MigrationError) Is ¶

func (m *MigrationError) Is(errorCode int) bool

type MigrationErrorCode ¶

type MigrationErrorCode int

type MigrationInfo ¶

type MigrationInfo struct {
	ScriptId  string    `json:"script_id" bson:"script_id"`
	Hash      string    `json:"hash" bson:"hash"`
	Timestamp time.Time `json:"timestamp" bson:"timestamp"`
}

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL