schema

Documentation

Overview

TODO: Normalize implicit things in input first, and then compare

This package has SQL parser, its abstraction and SQL generator. Never touch database.

Index

• Constants
• func GenerateIdempotentDDLs(mode GeneratorMode, sqlParser database.Parser, desiredSQL string, ...) ([]string, error)
• type AddForeignKey
  • func (a *AddForeignKey) Statement() string
• type AddIndex
  • func (a *AddIndex) Statement() string
• type AddPolicy
  • func (a *AddPolicy) Statement() string
• type AddPrimaryKey
  • func (a *AddPrimaryKey) Statement() string
• type CheckDefinition
• type Column
• type ColumnKeyOption
• type Comment
  • func (t *Comment) Statement() string
• type ConstraintOptions
• type CreateIndex
  • func (c *CreateIndex) Statement() string
• type CreateTable
  • func (c *CreateTable) Statement() string
• type DDL
  • func FilterTables(ddls []DDL, config database.GeneratorConfig) []DDL
  • func ParseDDLs(mode GeneratorMode, sqlParser database.Parser, sql string, ...) ([]DDL, error)
• type DefaultDefinition
• type Extension
  • func (t *Extension) Statement() string
• type ForeignKey
• type Generated
• type GeneratedType
• type Generator
• type GeneratorMode
• type Identity
• type Index
• type IndexColumn
• type IndexOption
• type IndexPartition
• type Policy
• type Sequence
• type SridDefinition
• type Table
  • func (t *Table) PrimaryKey() *Index
• type Trigger
  • func (t *Trigger) Statement() string
• type Type
  • func (t *Type) Statement() string
• type Value
• type ValueType
• type View
  • func (v *View) Statement() string

Constants

const (
	AscScr  = "asc"
	DescScr = "desc"
)

IndexColumn.direction

const (
	ValueTypeStr = ValueType(iota)
	ValueTypeInt
	ValueTypeFloat
	ValueTypeHexNum
	ValueTypeHex
	ValueTypeValArg
	ValueTypeBit
	ValueTypeBool
)

const (
	ColumnKeyNone = ColumnKeyOption(iota)
	ColumnKeyPrimary
	ColumnKeySpatialKey
	ColumnKeyUnique
	ColumnKeyUniqueKey
	ColumnKey
)

const (
	GeneratedTypeVirtual = GeneratedType(iota)
	GeneratedTypeStored
)

const (
	GeneratorModeMysql = GeneratorMode(iota)
	GeneratorModePostgres
	GeneratorModeSQLite3
	GeneratorModeMssql
)

Functions

func GenerateIdempotentDDLs

func GenerateIdempotentDDLs(mode GeneratorMode, sqlParser database.Parser, desiredSQL string, currentSQL string, config database.GeneratorConfig, defaultSchema string) ([]string, error)

Parse argument DDLs and call `generateDDLs()`

Types

type AddForeignKey

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

func (*AddForeignKey) Statement

func (a *AddForeignKey) Statement() string

type AddIndex

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

func (*AddIndex) Statement

func (a *AddIndex) Statement() string

type AddPolicy

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

func (*AddPolicy) Statement

func (a *AddPolicy) Statement() string

type AddPrimaryKey

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

func (*AddPrimaryKey) Statement

func (a *AddPrimaryKey) Statement() string

type CheckDefinition

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

type Column

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

type ColumnKeyOption

type ColumnKeyOption int

type Comment

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

func (*Comment) Statement

func (t *Comment) Statement() string

type ConstraintOptions

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

type CreateIndex

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

func (*CreateIndex) Statement

func (c *CreateIndex) Statement() string

type CreateTable

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

func (*CreateTable) Statement

func (c *CreateTable) Statement() string

type DDL

type DDL interface {
	Statement() string
}

func FilterTables

func FilterTables(ddls []DDL, config database.GeneratorConfig) []DDL

func ParseDDLs

func ParseDDLs(mode GeneratorMode, sqlParser database.Parser, sql string, defaultSchema string) ([]DDL, error)

Parse `ddls`, which is expected to `;`-concatenated DDLs and not to include destructive DDL.

type DefaultDefinition

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

type Extension

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

func (*Extension) Statement

func (t *Extension) Statement() string

type ForeignKey

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

type Generated

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

type GeneratedType

type GeneratedType int

type Generator

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

This struct holds simulated schema states during GenerateIdempotentDDLs().

type GeneratorMode

type GeneratorMode int

type Identity

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

type Index

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

type IndexColumn

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

type IndexOption

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

type IndexPartition

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

type Policy

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

type Sequence

type Sequence struct {
	Name        string
	IfNotExists bool
	Type        string
	IncrementBy *int
	MinValue    *int
	NoMinValue  bool
	MaxValue    *int
	NoMaxValue  bool
	StartWith   *int
	Cache       *int
	Cycle       bool
	NoCycle     bool
	OwnedBy     string
}

type SridDefinition

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

type Table

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

func (*Table) PrimaryKey

func (t *Table) PrimaryKey() *Index

type Trigger

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

func (*Trigger) Statement

func (t *Trigger) Statement() string

type Type

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

TODO: include type information

func (*Type) Statement

func (t *Type) Statement() string

type Value

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

type ValueType

type ValueType int

type View

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

func (*View) Statement

func (v *View) Statement() string