migrate

Documentation

Overview

Package migrate provides a simple composer tool, which implements the Migrator interface and can take in any number of migrators which themselves have to implement the interface

Index

• type CreateTenantPayload
• type Migrator
• type UpdateTenantPayload

Types

type CreateTenantPayload

type CreateTenantPayload struct {
	Name   string
	Status string
}

type Migrator

type Migrator interface {
	AddClass(ctx context.Context, class *models.Class, shardingState *sharding.State) error
	DropClass(ctx context.Context, className string) error
	UpdateClass(ctx context.Context, className string,
		newClassName *string) error
	GetShardsQueueSize(ctx context.Context, className, tenant string) (map[string]int64, error)
	GetShardsStatus(ctx context.Context, className, tenant string) (map[string]string, error)
	UpdateShardStatus(ctx context.Context, className, shardName, targetStatus string) error
	AddProperty(ctx context.Context, className string,
		prop *models.Property) error
	UpdateProperty(ctx context.Context, className string,
		propName string, newName *string) error

	NewTenants(ctx context.Context, class *models.Class, creates []*CreateTenantPayload) (commit func(success bool), err error)
	UpdateTenants(ctx context.Context, class *models.Class, updates []*UpdateTenantPayload) (commit func(success bool), err error)
	DeleteTenants(ctx context.Context, class *models.Class, tenants []string) (commit func(success bool), err error)

	ValidateVectorIndexConfigUpdate(ctx context.Context,
		old, updated schema.VectorIndexConfig) error
	UpdateVectorIndexConfig(ctx context.Context, className string,
		updated schema.VectorIndexConfig) error
	ValidateVectorIndexConfigsUpdate(ctx context.Context,
		old, updated map[string]schema.VectorIndexConfig) error
	UpdateVectorIndexConfigs(ctx context.Context, className string,
		updated map[string]schema.VectorIndexConfig) error
	ValidateInvertedIndexConfigUpdate(ctx context.Context,
		old, updated *models.InvertedIndexConfig) error
	UpdateInvertedIndexConfig(ctx context.Context, className string,
		updated *models.InvertedIndexConfig) error
	RecalculateVectorDimensions(ctx context.Context) error
	RecountProperties(ctx context.Context) error
	InvertedReindex(ctx context.Context, taskNames ...string) error
	AdjustFilterablePropSettings(ctx context.Context) error
}

Migrator represents both the input and output interface of the Composer

type UpdateTenantPayload

type UpdateTenantPayload struct {
	Name   string
	Status string
}