arangox

Documentation

Overview

Package migration allows to perform versioned migrations in your ArangoDB.

Index

• Constants
• Variables
• func HasVersion(migrations []Migration, version uint64) bool
• func MigrateIndexes(ctx context.Context, col arangoDriver.Collection, indexes []IndexParam) error
• type CollectionParam
• type EdgeCollectionParam
• type GraphParam
• type IndexParam
• type IndexType
  • func ParseIndexType(s string) (IndexType, error)
  • func (u IndexType) MarshalJSON() ([]byte, error)
  • func (u IndexType) String() string
  • func (u *IndexType) UnmarshalJSON(data []byte) (err error)
• type Migration
• type MigrationFunc
• type Migrations
  • func (m Migrations) Sort()
• type Migrator
  • func NewMigrator(in NewMigratorOptions) *Migrator
  • func (m *Migrator) Down(ctx context.Context, targetVersion int) error
  • func (m *Migrator) SetMigrationsCollection(name string)
  • func (m *Migrator) Up(ctx context.Context, targetVersion int) error
  • func (m *Migrator) Version(ctx context.Context) (current uint64, latest uint64, desc string, outErr error)
• type NewMigratorOptions
• type ViewParam

Constants

const AllAvailable = -1

AllAvailable used in "Up" or "Down" methods to run all available migrations.

const DefaultMigrationsCollection = "migrations"

Variables

var (
	IndexType_name = map[int]string{
		0: "PERSISTENT",
		1: "GEO",
		2: "HASH",
		3: "INVERTED",
		4: "TIME_TO_LIVE",
		5: "ZKD",
		6: "SKIP_LIST",
	}
	IndexType_value = map[string]int{
		"PERSISTENT":   0,
		"GEO":          1,
		"HASH":         2,
		"INVERTED":     3,
		"TIME_TO_LIVE": 4,
		"ZKD":          5,
		"SKIP_LIST":    6,
	}
)

Functions

func HasVersion

func HasVersion(migrations []Migration, version uint64) bool

func MigrateIndexes

func MigrateIndexes(ctx context.Context, col arangoDriver.Collection, indexes []IndexParam) error

Types

type CollectionParam

type CollectionParam struct {
	Name    string
	Options *arangoDriver.CreateCollectionOptions
	Indexes []IndexParam
}

type EdgeCollectionParam

type EdgeCollectionParam struct {
	Name        string
	Constraints arangoDriver.VertexConstraints
}

type GraphParam

type GraphParam struct {
	Name              string
	Options           *arangoDriver.CreateGraphOptions
	VertexCollections []string
	EdgeCollections   []EdgeCollectionParam
}

type IndexParam

type IndexParam struct {
	Type                   IndexType
	Fields                 []string
	ExpireAfter            int
	InvertedIndexOptions   *arangoDriver.InvertedIndexOptions
	ZKDIndexOptions        *arangoDriver.EnsureZKDIndexOptions
	SkipListIndexOptions   *arangoDriver.EnsureSkipListIndexOptions
	PersistentIndexOptions *arangoDriver.EnsurePersistentIndexOptions
	HashIndexOptions       *arangoDriver.EnsureHashIndexOptions
	GeoIndexOptions        *arangoDriver.EnsureGeoIndexOptions
	TTLIndexOptions        *arangoDriver.EnsureTTLIndexOptions
}

type IndexType

type IndexType int

const (
	IndexTypePersistent IndexType = iota
	IndexTypeGeo
	IndexTypeHash
	IndexTypeInverted
	IndexTypeTTL
	IndexTypeZKD
	IndexTypeSkipList
)

func ParseIndexType

func ParseIndexType(s string) (IndexType, error)

func (IndexType) MarshalJSON

func (u IndexType) MarshalJSON() ([]byte, error)

func (IndexType) String

func (u IndexType) String() string

func (*IndexType) UnmarshalJSON

func (u *IndexType) UnmarshalJSON(data []byte) (err error)

type Migration

type Migration struct {
	Version     uint64
	Description string
	Up          MigrationFunc
	Down        MigrationFunc
}

Migration represents single database migration. Migration contains:

- version: migration version, must be unique in migration list

- description: text description of migration

- up: callback which will be called in "up" migration process

- down: callback which will be called in "down" migration process for reverting changes

type MigrationFunc

type MigrationFunc func(ctx context.Context, db arangoDriver.Database) error

MigrationFunc is used to define actions to be performed for a migration.

type Migrations

type Migrations []Migration

func (Migrations) Sort

func (m Migrations) Sort()

type Migrator

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

Migrate is type for performing migrations in provided database. Database versioned using dedicated collection. Each migration applying ("up" and "down") adds new document to collection. This document consists migration version, migration description and timestamp. Current database version determined as version in latest added document (biggest "_key") from collection mentioned above.

func NewMigrator

func NewMigrator(in NewMigratorOptions) *Migrator

func (*Migrator) Down

func (m *Migrator) Down(ctx context.Context, targetVersion int) error

Down performs "down" migration to bring back migrations to `version`. If targetVersion<=0 all "down" migrations will be performed. If targetVersion>0, only the down migrations where version>targetVersion will be performed (only if they were applied).

func (*Migrator) SetMigrationsCollection

func (m *Migrator) SetMigrationsCollection(name string)

SetMigrationsCollection replaces name of collection for storing migration information. By default it is "migrations".

func (*Migrator) Up

func (m *Migrator) Up(ctx context.Context, targetVersion int) error

Up performs "up" migrations up to the specified targetVersion. If targetVersion<=0 all "up" migrations will be executed (if not executed yet) If targetVersion>0 only migrations where version<=targetVersion will be performed (if not executed yet)

func (*Migrator) Version

func (m *Migrator) Version(ctx context.Context) (current uint64, latest uint64, desc string, outErr error)

Version returns current database version and comment.

type NewMigratorOptions

type NewMigratorOptions struct {
	Database   arangoDriver.Database
	Package    string
	Migrations Migrations
	DryRun     bool
	Logger     *logrusx.Logger
}

type ViewParam

type ViewParam struct {
	Name    string
	Options *arangoDriver.ArangoSearchViewProperties
}