schema

Documentation

Index

• Constants
• type Column
  • func (c Column) MarshalJSON() ([]byte, error)
  • func (c Column) MarshalYAML() ([]byte, error)
  • func (c *Column) UnmarshalJSON(data []byte) error
  • func (c *Column) UnmarshalYAML(data []byte) error
• type Constraint
• type Driver
  • func (d Driver) MarshalJSON() ([]byte, error)
• type DriverMeta
• type Index
• type Label
• type Labels
  • func (labels Labels) Merge(name string) Labels
• type Relation
  • func (r Relation) MarshalJSON() ([]byte, error)
  • func (r Relation) MarshalYAML() ([]byte, error)
  • func (r *Relation) UnmarshalJSON(data []byte) error
  • func (r *Relation) UnmarshalYAML(data []byte) error
• type Schema
  • func (s *Schema) FindTableByName(name string) (*Table, error)
  • func (s Schema) MarshalJSON() ([]byte, error)
  • func (s *Schema) NormalizeTableName(name string) string
  • func (s *Schema) NormalizeTableNames(names []string) []string
  • func (s *Schema) Repair() error
  • func (s *Schema) Sort() error
• type Table
  • func (t *Table) CollectTablesAndRelations(distance int, root bool) ([]*Table, []*Relation, error)
  • func (t *Table) FindColumnByName(name string) (*Column, error)
  • func (t *Table) FindConstrainsByColumnName(name string) []*Constraint
  • func (t Table) MarshalJSON() ([]byte, error)
• type Trigger

Constants

const (
	TypeFK = "FOREIGN KEY"
)

Types

type Column

type Column struct {
	Name            string         `json:"name"`
	Type            string         `json:"type"`
	Nullable        bool           `json:"nullable"`
	Default         sql.NullString `json:"default"`
	Comment         string         `json:"comment"`
	ParentRelations []*Relation    `json:"-"`
	ChildRelations  []*Relation    `json:"-"`
}

Column is the struct for table column

func (Column) MarshalJSON

func (c Column) MarshalJSON() ([]byte, error)

MarshalJSON return custom JSON byte

func (Column) MarshalYAML

func (c Column) MarshalYAML() ([]byte, error)

MarshalYAML return custom YAML byte

func (*Column) UnmarshalJSON

func (c *Column) UnmarshalJSON(data []byte) error

UnmarshalJSON unmarshal JSON to schema.Column

func (*Column) UnmarshalYAML

func (c *Column) UnmarshalYAML(data []byte) error

UnmarshalYAML unmarshal YAML to schema.Column

type Constraint

type Constraint struct {
	Name             string   `json:"name"`
	Type             string   `json:"type"`
	Def              string   `json:"def"`
	Table            *string  `json:"table"`
	ReferenceTable   *string  `json:"reference_table" yaml:"referenceTable"`
	Columns          []string `json:"columns"`
	ReferenceColumns []string `json:"reference_columns" yaml:"referenceColumns"`
}

Constraint is the struct for database constraint

type Driver

type Driver struct {
	Name            string      `json:"name"`
	DatabaseVersion string      `json:"database_version" yaml:"databaseVersion"`
	Meta            *DriverMeta `json:"meta"`
}

Driver is the struct for tbls driver information

func (Driver) MarshalJSON

func (d Driver) MarshalJSON() ([]byte, error)

MarshalJSON return custom JSON byte

type DriverMeta

type DriverMeta struct {
	CurrentSchema string     `json:"current_schema,omitempty" yaml:"currentSchema,omitempty"`
	SearchPaths   []string   `json:"search_paths,omitempty" yaml:"searchPaths,omitempty"`
	Dict          *dict.Dict `json:"dict,omitempty"`
}

type Index

type Index struct {
	Name    string   `json:"name"`
	Def     string   `json:"def"`
	Table   *string  `json:"table"`
	Columns []string `json:"columns"`
}

Index is the struct for database index

type Label

type Label struct {
	Name    string
	Virtual bool
}

type Labels

type Labels []*Label

func (Labels) Merge

func (labels Labels) Merge(name string) Labels

type Relation

type Relation struct {
	Table         *Table    `json:"table"`
	Columns       []*Column `json:"columns"`
	ParentTable   *Table    `json:"parent_table" yaml:"parentTable"`
	ParentColumns []*Column `json:"parent_columns" yaml:"parentColumns"`
	Def           string    `json:"def"`
	Virtual       bool      `json:"virtual"`
}

Relation is the struct for table relation

func (Relation) MarshalJSON

func (r Relation) MarshalJSON() ([]byte, error)

MarshalJSON return custom JSON byte

func (Relation) MarshalYAML

func (r Relation) MarshalYAML() ([]byte, error)

MarshalYAML return custom YAML byte

func (*Relation) UnmarshalJSON

func (r *Relation) UnmarshalJSON(data []byte) error

UnmarshalJSON unmarshal JSON to schema.Column

func (*Relation) UnmarshalYAML

func (r *Relation) UnmarshalYAML(data []byte) error

UnmarshalYAML unmarshal YAML to schema.Column

type Schema

type Schema struct {
	Name      string      `json:"name"`
	Desc      string      `json:"desc"`
	Tables    []*Table    `json:"tables"`
	Relations []*Relation `json:"relations"`
	Driver    *Driver     `json:"driver"`
	Labels    Labels      `json:"labels,omitempty"`
}

Schema is the struct for database schema

func (*Schema) FindTableByName

func (s *Schema) FindTableByName(name string) (*Table, error)

FindTableByName find table by table name

func (Schema) MarshalJSON

func (s Schema) MarshalJSON() ([]byte, error)

MarshalJSON return custom JSON byte

func (*Schema) NormalizeTableName

func (s *Schema) NormalizeTableName(name string) string

func (*Schema) NormalizeTableNames

func (s *Schema) NormalizeTableNames(names []string) []string

func (*Schema) Repair

func (s *Schema) Repair() error

Repair column relations

func (*Schema) Sort

func (s *Schema) Sort() error

Sort schema tables, columns, relations, and constrains

type Table

type Table struct {
	Name        string        `json:"name"`
	Type        string        `json:"type"`
	Comment     string        `json:"comment"`
	Columns     []*Column     `json:"columns"`
	Indexes     []*Index      `json:"indexes"`
	Constraints []*Constraint `json:"constraints"`
	Triggers    []*Trigger    `json:"triggers"`
	Def         string        `json:"def"`
	Labels      Labels        `json:"labels,omitempty"`
}

Table is the struct for database table

func (*Table) CollectTablesAndRelations

func (t *Table) CollectTablesAndRelations(distance int, root bool) ([]*Table, []*Relation, error)

func (*Table) FindColumnByName

func (t *Table) FindColumnByName(name string) (*Column, error)

FindColumnByName find column by column name

func (*Table) FindConstrainsByColumnName

func (t *Table) FindConstrainsByColumnName(name string) []*Constraint

func (Table) MarshalJSON

func (t Table) MarshalJSON() ([]byte, error)

MarshalJSON return custom JSON byte

type Trigger

type Trigger struct {
	Name string `json:"name"`
	Def  string `json:"def"`
}

Trigger is the struct for database trigger