migrate

Mar 24, 2024

Changes in this version

+ var ErrTableAlreadyExists = errors.New("table already exists")

type Attribute

+ func NewBinaryAttribute(name string) Attribute

+ func NewNumberAttribute(name string) Attribute

+ func NewStringAttribute(name string) Attribute

+ func (attr Attribute) HashKey() KeySchema

+ func (attr Attribute) RangeKey() KeySchema

+ type IndexOption func(si *SecondaryIndex)

+ func WithIndexProjection(t types.ProjectionType, attrs ...string) IndexOption

+ func WithIndexThroughput(read, write int64) IndexOption

type KeySchema

+ func NewHashKey(name string) KeySchema

+ func NewRangeKey(name string) KeySchema

type Keys

+ func NewKeys(hashKey KeySchema, rangeKey ...KeySchema) Keys

type Projection

+ func NewProjection(t types.ProjectionType, attrs ...string) *Projection

type SchemaBuilder

+ func (b *SchemaBuilder) Get() Schema

+ type SchemaBuilders []*SchemaBuilder

+ func (b SchemaBuilders) Build(ctx context.Context, api MigrationApi, opt ...TableSchemaOption) ([]*dynamodb.CreateTableOutput, error)

+ type Schemas []Schema

+ func GetSchemas(builders ...*SchemaBuilder) Schemas

+ func (src Schemas) GetSchemas(ctx context.Context) ([]Schema, error)

type SecondaryIndex

+ func NewSecondaryIndex(name string, keys Keys, opts ...IndexOption) SecondaryIndex

+ type TableSchemaOption func(ts *TableSchema)

+ func WithTableNamePrefix(prefix string) TableSchemaOption

Mar 9, 2024

Changes in this version

+ type SchemaBuilder struct

+ func NewSchema(name string) *SchemaBuilder

+ func (b *SchemaBuilder) Attributes(attrs ...Attribute) *SchemaBuilder

+ func (b *SchemaBuilder) BillingMode(mode types.BillingMode) *SchemaBuilder

+ func (b *SchemaBuilder) Build(ctx context.Context, api MigrationApi) (*dynamodb.CreateTableOutput, error)

+ func (b *SchemaBuilder) GlobalSecondaryIndex(indexes ...SecondaryIndex) *SchemaBuilder

+ func (b *SchemaBuilder) Keys(keys ...KeySchema) *SchemaBuilder

+ func (b *SchemaBuilder) LocalSecondaryIndex(indexes ...SecondaryIndex) *SchemaBuilder

+ func (b *SchemaBuilder) TableClass(class types.TableClass) *SchemaBuilder

+ func (b *SchemaBuilder) Throughput(read, write int64) *SchemaBuilder

+ func (b *SchemaBuilder) TimeToLive(attr string, enabled bool) *SchemaBuilder

Aug 23, 2023

Changes in this version

+ type Config struct

+ Debug bool

+ Endpoint string

+ Local bool

+ Profile string

+ Region string

type FilesMigrate

+ func (v *FilesMigrate) Read(ctx context.Context) (schemas []Schema, err error)

type Migrate

+ Read func(ctx context.Context) (schemas []Schema, err error)

type MigrationApi

+ func Setup(ctx context.Context, conf Config) (MigrationApi, error)

type SchemaMigrate

+ func (v *SchemaMigrate) Read(ctx context.Context) (schemas []Schema, err error)

Oct 22, 2022

Changes in this version

+ const DynamoDB

+ const MigrationTable

+ var ErrNotFound *types.ResourceNotFoundException

+ func SaveRecord(ctx context.Context, api MigrationApi, tableName string, ...) (err error)

+ type Attribute struct

+ Name string

+ Type types.ScalarAttributeType

+ func (attr Attribute) Definition() types.AttributeDefinition

+ type Attributes []Attribute

+ func (attrs Attributes) Definitions() []types.AttributeDefinition

+ func (attrs Attributes) Map() map[string]types.ScalarAttributeType

+ type FilesMigrate struct

+ func (v *FilesMigrate) Run(ctx context.Context, save SaveFunc) (err error)

+ type KeySchema struct

+ Name string

+ Type types.KeyType

+ func (k KeySchema) Element() *types.KeySchemaElement

+ type Keys []KeySchema

+ func (keys Keys) Elements() []types.KeySchemaElement

+ func (keys Keys) Map() map[string]types.KeyType

+ type Migrate interface

+ Run func(ctx context.Context, save SaveFunc) error

+ func New(api MigrationApi, dirPath ...string) Migrate

+ func Parse(api MigrationApi, schema string) Migrate

+ type Migration struct

+ ID string

+ type MigrationApi interface

+ CreateTable func(ctx context.Context, params *dynamodb.CreateTableInput, ...) (*dynamodb.CreateTableOutput, error)

+ DeleteTable func(ctx context.Context, params *dynamodb.DeleteTableInput, ...) (*dynamodb.DeleteTableOutput, error)

+ DescribeTable func(ctx context.Context, params *dynamodb.DescribeTableInput, ...) (*dynamodb.DescribeTableOutput, error)

+ DescribeTimeToLive func(ctx context.Context, params *dynamodb.DescribeTimeToLiveInput, ...) (*dynamodb.DescribeTimeToLiveOutput, error)

+ GetItem func(ctx context.Context, params *dynamodb.GetItemInput, ...) (*dynamodb.GetItemOutput, error)

+ PutItem func(ctx context.Context, params *dynamodb.PutItemInput, ...) (*dynamodb.PutItemOutput, error)

+ UpdateTable func(ctx context.Context, params *dynamodb.UpdateTableInput, ...) (*dynamodb.UpdateTableOutput, error)

+ UpdateTimeToLive func(ctx context.Context, params *dynamodb.UpdateTimeToLiveInput, ...) (*dynamodb.UpdateTimeToLiveOutput, error)

+ type Projection struct

+ AttributeNames []string

+ Type types.ProjectionType

+ func (p Projection) Element() *types.Projection

+ type ProvisionedThroughput struct

+ Read int64

+ Write int64

+ func (t ProvisionedThroughput) Element() *types.ProvisionedThroughput

+ func (t ProvisionedThroughput) Update(desc types.TableDescription) *types.ProvisionedThroughput

+ type Resource struct

+ Properties TableSchema

+ Type string

+ func (r *Resource) Checksum() (h [32]byte, err error)

+ type Resources map[string]Resource

+ type SaveFunc func(ctx context.Context, api MigrationApi, tableName string, ...) error

+ type Schema struct

+ Records []map[string]interface{}

+ Table TableSchema

+ func ParseJson(name string, body []byte) (schemas []Schema, err error)

+ func ParseYaml(name string, body []byte) (schemas []Schema, err error)

+ type SchemaMigrate struct

+ func (v *SchemaMigrate) Run(ctx context.Context, save SaveFunc) (err error)

+ type SecondaryIndex struct

+ Keys Keys

+ Name string

+ Projection *Projection

+ Throughput *ProvisionedThroughput

+ func (s SecondaryIndex) CreateGlobal() types.GlobalSecondaryIndex

+ func (s SecondaryIndex) CreateLocal() types.LocalSecondaryIndex

+ type SecondaryIndexes []SecondaryIndex

+ func (indexes SecondaryIndexes) GlobalIndexes() []types.GlobalSecondaryIndex

+ func (indexes SecondaryIndexes) LocalIndexes() []types.LocalSecondaryIndex

+ func (indexes SecondaryIndexes) UpdateGlobals(desc types.TableDescription) []types.GlobalSecondaryIndexUpdate

+ type TableSchema struct

+ Attributes Attributes

+ BillingMode types.BillingMode

+ GlobalSecondaryIndex SecondaryIndexes

+ Keys Keys

+ LocalSecondaryIndex SecondaryIndexes

+ TableClass types.TableClass

+ TableName string

+ Throughput ProvisionedThroughput

+ TimeToLive *TimeToLiveSpecification

+ func (t TableSchema) Create(ctx context.Context, api MigrationApi) (out *dynamodb.CreateTableOutput, err error)

+ func (t TableSchema) Delete(ctx context.Context, api MigrationApi) (out *dynamodb.DeleteTableOutput, err error)

+ func (t TableSchema) Exists(ctx context.Context, api MigrationApi) (out *dynamodb.DescribeTableOutput, err error)

+ func (t TableSchema) Update(ctx context.Context, api MigrationApi, desc types.TableDescription) (out *dynamodb.UpdateTableOutput, err error)

+ type Template struct

+ Version string

+ type TimeToLiveSpecification struct

+ AttributeName string

+ Enabled bool

+ func (s TimeToLiveSpecification) Element() *types.TimeToLiveSpecification