model

type ApplicationOptions struct {
	DryRun bool `bson:"dry_run" json:"dry_run" yaml:"dry_run"`
	Limit  int  `bson:"limit" json:"limit" yaml:"limit"`
}

type Configuration struct {
	Options          ApplicationOptions             `bson:"options" json:"options" yaml:"options"`
	SimpleMigrations []ConfigurationSimpleMigration `bson:"simple_migrations" json:"simple_migrations" yaml:"simple_migrations"`
	ManualMigrations []ConfigurationManualMigration `bson:"manual_migrations" json:"manual_migrations" yaml:"manual_migrations"`
	StreamMigrations []ConfigurationManualMigration `bson:"stream_migrations" json:"stream_migrations" yaml:"stream_migrations"`
}

type ConfigurationManualMigration struct {
	Options GeneratorOptions  `bson:"options" json:"options" yaml:"options"`
	Name    string            `bson:"name" json:"name" yaml:"name"`
	Params  map[string]string `bson:"params,omitempty" json:"params,omitempty" yaml:"params,omitempty"`
}

type ConfigurationSimpleMigration struct {
	Options GeneratorOptions       `bson:"options" json:"options" yaml:"options"`
	Update  map[string]interface{} `bson:"update" json:"update" yaml:"update"`
}

type DependencyNetworker interface {
	// Add inserts a list of dependencies for a given item. If the
	// slice of dependencies is empty, Add is a noop. Furthermore,
	// the Add method provides no validation, and will do nothing
	// to prevent cycles or broken dependencies.
	Add(string, []string)

	// Resolve, returns all of the dependencies for the specified task.
	Resolve(string) []string

	// All returns a list of all tasks that have registered
	// dependencies.
	All() []string

	// Network returns the dependency graph for all registered
	// tasks as a mapping of task IDs to the IDs of its
	// dependencies.
	Network() map[string][]string

	// Validate returns errors if there are either dependencies
	// specified that do not have tasks available *or* if there
	// are dependency cycles.
	Validate() error

	// AddGroup and GetGroup set and return the lists of tasks
	// that belong to a specific task group. Unlike the specific
	// task dependency setters.
	AddGroup(string, []string)
	GetGroup(string) []string

	// For introspection and convince, DependencyNetworker
	// composes implementations of common interfaces.
	fmt.Stringer
	json.Marshaler
}

type GeneratorOptions struct {
	JobID     string                 `bson:"_id" json:"id" yaml:"id"`
	DependsOn []string               `bson:"dependencies" json:"dependencies" yaml:"dependencies"`
	NS        Namespace              `bson:"namespace" json:"namespace" yaml:"namespace"`
	Query     map[string]interface{} `bson:"query" json:"query" yaml:"query"`
	Limit     int                    `bson:"limit" json:"limit" yaml:"limit"`
}

type Manual struct {
	// ID returns the _id field of the document that is the
	// input of the migration.
	ID interface{} `bson:"id" json:"id" yaml:"id"`

	// The name of the migration function to run. This function
	// must be defined in the migration registry
	OperationName string `bson:"op_name" json:"op_name" yaml:"op_name"`

	// Migration holds the ID of the migration operation,
	// typically the name of the class of migration and
	Migration string `bson:"migration_id" json:"migration_id" yaml:"migration_id"`

	// Namespace holds a struct that describes which database and
	// collection where the query for the input document should run.
	Namespace Namespace `bson:"namespace" json:"namespace" yaml:"namespace"`
}

type MigrationMetadata struct {
	ID        string `bson:"_id" json:"id" yaml:"id"`
	Migration string `bson:"migration" json:"migration" yaml:"migration"`
	HasErrors bool   `bson:"has_errors" json:"has_errors" yaml:"has_errors"`
	Completed bool   `bson:"completed" json:"completed" yaml:"completed"`
}

type Namespace struct {
	DB         string `bson:"db_name" json:"db_name" yaml:"db_name"`
	Collection string `bson:"collection" json:"collection" yaml:"collection"`
}

type Simple struct {
	// ID returns the _id field of the document that is the
	// subject of the migration.
	ID interface{} `bson:"id" json:"id" yaml:"id"`

	// Update is a specification for the update
	// operation. This is converted to a bson.M{} (but is typed as
	// a map to allow migration implementations to *not* depend upon
	// bson.M
	Update map[string]interface{} `bson:"update" json:"update" yaml:"update"`

	// Migration holds the ID of the migration operation,
	// typically the name of the class of migration and
	Migration string `bson:"migration_id" json:"migration_id" yaml:"migration_id"`

	// Namespace holds a struct that describes which database and
	// collection where the migration should run
	Namespace Namespace `bson:"namespace" json:"namespace" yaml:"namespace"`
}

type Stream struct {
	Query map[string]interface{} `bson:"query" json:"query" yaml:"query"`

	// The name of a registered DocumentProcessor implementation.
	// Because the producer isn't versioned, changes to the
	// implementation of the Producer between migration runs, may
	// complicate idempotency requirements.
	ProcessorName string `bson:"producer" json:"producer" yaml:"producer"`

	// Migration holds the ID of the migration operation,
	// typically the name of the class of migration and
	Migration string `bson:"migration_id" json:"migration_id" yaml:"migration_id"`

	// Namespace holds a struct that describes which database and
	// collection where the query for the input document should run.
	Namespace Namespace `bson:"namespace" json:"namespace" yaml:"namespace"`
}