migrate

Documentation

Index

• type EntRevisions
  • func NewEntRevisions(ctx context.Context, ac *sqlclient.Client, opts ...Option) (*EntRevisions, error)
  • func (r *EntRevisions) CurrentRevision(ctx context.Context) (*migrate.Revision, error)
  • func (r *EntRevisions) DeleteRevision(ctx context.Context, v string) error
  • func (r *EntRevisions) ID(ctx context.Context, operatorV string) (string, error)
  • func (r *EntRevisions) Ident() *migrate.TableIdent
  • func (r *EntRevisions) Migrate(ctx context.Context) (err error)
  • func (r *EntRevisions) ReadRevision(ctx context.Context, v string) (*migrate.Revision, error)
  • func (r *EntRevisions) ReadRevisions(ctx context.Context) ([]*migrate.Revision, error)
  • func (r *EntRevisions) WriteRevision(ctx context.Context, rev *migrate.Revision) error
• type Option
  • func WithSchema(s string) Option
• type StatusReporter
  • func (r *StatusReporter) Report(ctx context.Context) (*cmdlog.MigrateStatus, error)

Types

type EntRevisions

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

EntRevisions provides implementation for the migrate.RevisionReadWriter interface.

func NewEntRevisions

func NewEntRevisions(ctx context.Context, ac *sqlclient.Client, opts ...Option) (*EntRevisions, error)

NewEntRevisions creates a new EntRevisions with the given sqlclient.Client.

func (*EntRevisions) CurrentRevision

func (r *EntRevisions) CurrentRevision(ctx context.Context) (*migrate.Revision, error)

CurrentRevision returns the current (latest) revision in the revisions table.

func (*EntRevisions) DeleteRevision

func (r *EntRevisions) DeleteRevision(ctx context.Context, v string) error

DeleteRevision deletes a revision from the revisions table.

func (*EntRevisions) ID

func (r *EntRevisions) ID(ctx context.Context, operatorV string) (string, error)

ID returns the identifier of the connected revisions table.

func (*EntRevisions) Ident

func (r *EntRevisions) Ident() *migrate.TableIdent

Ident returns the table identifier.

func (*EntRevisions) Migrate

func (r *EntRevisions) Migrate(ctx context.Context) (err error)

Migrate attempts to create / update the revisions table. This is separated since Ent attempts to wrap the migration execution in a transaction and assumes the underlying connection is of type *sql.DB, which is not true for actually reading and writing revisions.

func (*EntRevisions) ReadRevision

func (r *EntRevisions) ReadRevision(ctx context.Context, v string) (*migrate.Revision, error)

ReadRevision reads a revision from the revisions table.

ReadRevision will not return results only saved in cache.

func (*EntRevisions) ReadRevisions

func (r *EntRevisions) ReadRevisions(ctx context.Context) ([]*migrate.Revision, error)

ReadRevisions reads the revisions from the revisions table.

ReadRevisions will not return results only saved to cache.

func (*EntRevisions) WriteRevision

func (r *EntRevisions) WriteRevision(ctx context.Context, rev *migrate.Revision) error

WriteRevision writes a revision to the revisions table.

type Option

type Option func(*EntRevisions) error

Option allows to configure EntRevisions by using functional arguments.

func WithSchema

func WithSchema(s string) Option

WithSchema configures the schema to use for the revision table.

type StatusReporter

type StatusReporter struct {
	// Client configures the connection to the database to file a MigrateStatus for.
	Client *sqlclient.Client
	// Dir is used for scanning and validating the migration directory.
	Dir migrate.Dir
	// Schema name the revision table resides in.
	Schema string
}

StatusReporter is used to gather information about migration status.

func (*StatusReporter) Report

func (r *StatusReporter) Report(ctx context.Context) (*cmdlog.MigrateStatus, error)

Report creates and writes a MigrateStatus.