databaseschema

Documentation

Index

• type Column
• type Entity
• type Name
• type NameForm
• type Relation
• type Schema
  • func Parse(filePath string, projectName string, organizationName string) (*Schema, error)

Types

type Column

type Column struct {
	Name              Name
	ObjectName        string
	DataType          string
	Primary           bool
	DefaultValue      string
	Nullable          bool
	ObjectType        string
	APIReturnable     bool
	APIUpdatable      bool
	APIType           string
	APIObjectType     string
	FakerType         string
	IsCommonColumn    bool
	TableName         Name
	RelationTableName Name
	IsSystemUseColumn bool
}

Column ...

type Entity

type Entity struct {
	Name          Name
	Columns       []*Column
	Relations     []*Relation
	PrimaryKey    *Column
	Description   string
	HasDecimal    bool
	HasJSON       bool
	PackageName   string
	UseSoftDelete bool
}

Entity ...

type Name

type Name struct {
	Original string
	Singular NameForm
	Plural   NameForm
}

Name ...

type NameForm

type NameForm struct {
	Camel string
	Title string
	Snake string
	Kebab string
}

NameForm ...

type Relation

type Relation struct {
	Entity           *Entity
	Column           *Column
	RelationType     string
	ObjectName       string
	MultipleEntities bool
}

Relation ...

type Schema

type Schema struct {
	FilePath           string
	ProjectName        string
	OrganizationName   string
	PackageName        string
	PrimaryKeyDataType string
	Entities           []*Entity
}

Schema ...

func Parse

func Parse(filePath string, projectName string, organizationName string) (*Schema, error)

Parse ...