migration

package

v1.0.11 Latest Latest Go to latest Published: Jul 11, 2021 License: GPL-3.0 Imports: 17 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/alenn-m/rgen

Links

Open Source Insights

Documentation ¶

Index ¶

type Migration
type PivotMigration
- func (p *PivotMigration) Generate() error
- func (p *PivotMigration) Init(tables []PivotMigrationEntry, conf *config.Config)
type PivotMigrationEntry
type Table
- func NewTable(name string, opts map[string]interface{}) Table

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Migration ¶

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

Migration generator

func (*Migration) Generate ¶

func (m *Migration) Generate(input *parser.Parser, conf *config.Config) error

Generate generates migration

func (*Migration) GetContent ¶

func (m *Migration) GetContent() string

GetContent return generated migration content

func (*Migration) Save ¶

func (m *Migration) Save() error

Save saves generated migration to file

type PivotMigration ¶

type PivotMigration struct {
	Tables []PivotMigrationEntry
	Config *config.Config
}

PivotMigration generator

func (*PivotMigration) Generate ¶

func (p *PivotMigration) Generate() error

Generate generates pivot migration

func (*PivotMigration) Init ¶

func (p *PivotMigration) Init(tables []PivotMigrationEntry, conf *config.Config)

Init initializes pivot generator

type PivotMigrationEntry ¶

type PivotMigrationEntry struct {
	TableOne string
	TableTwo string
}

PivotMigrationEntry

type Table ¶

type Table struct {
	Name        string `db:"name"`
	Columns     []fizz.Column
	Indexes     []fizz.Index
	ForeignKeys []fizz.ForeignKey

	Options map[string]interface{}
	// contains filtered or unexported fields
}

Table is the table definition for fizz.

func NewTable ¶

func NewTable(name string, opts map[string]interface{}) Table

NewTable creates a new Table.

func (*Table) Column ¶

func (t *Table) Column(name string, colType string, options fizz.Options) error

Column adds a column to the table definition.

func (Table) Fizz ¶

func (t Table) Fizz() string

Fizz returns the fizz DDL to create the table.

func (*Table) ForeignKey ¶

func (t *Table) ForeignKey(column string, refs interface{}, options fizz.Options) error

ForeignKey adds a new foreign key to the table definition.

func (*Table) HasColumns ¶

func (t *Table) HasColumns(args ...string) bool

HasColumns checks if the Table has all the given columns.

func (*Table) PrimaryKey ¶

func (t *Table) PrimaryKey(pk ...string) error

PrimaryKey adds a primary key to the table. It's useful to define a composite primary key.

func (Table) String ¶

func (t Table) String() string

func (*Table) Timestamp ¶

func (t *Table) Timestamp(name string) error

Timestamp is a shortcut to add a timestamp column with default options.

func (Table) UnFizz ¶

func (t Table) UnFizz() string

UnFizz returns the fizz DDL to remove the table.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL