sqlspec

Documentation

Index

• type AddColumn
• type Change
• type Check
• type Column
• type ForeignKey
• type Index
• type ModifyTable
• type PrimaryKey
• type Schema
• type Table
• type Type

Types

type AddColumn

type AddColumn struct {
	Change
	Column *Column `spec:"column"`
}

AddColumn is a specification for a schema.AddColumn.

type Change

type Change interface {
	// contains filtered or unexported methods
}

Change is the interface implemented by change specifications. Change instances are supposed to be mappable to schema.Change instances.

type Check

type Check struct {
	Name string `spec:",name"`
	Expr string `spec:"expr"`
	schemaspec.DefaultExtension
}

Check holds a specification for a check constraint on a table.

type Column

type Column struct {
	Name    string           `spec:",name"`
	Null    bool             `spec:"null"`
	Type    *schemaspec.Type `spec:"type"`
	Default schemaspec.Value `spec:"default"`
	schemaspec.DefaultExtension
}

Column holds a specification for a column in an SQL table.

type ForeignKey

type ForeignKey struct {
	Symbol     string                 `spec:",name"`
	Columns    []*schemaspec.Ref      `spec:"columns"`
	RefColumns []*schemaspec.Ref      `spec:"ref_columns"`
	OnUpdate   schema.ReferenceOption `spec:"on_update"`
	OnDelete   schema.ReferenceOption `spec:"on_delete"`
	schemaspec.DefaultExtension
}

ForeignKey holds a specification for the Foreign key of a table.

type Index

type Index struct {
	Name    string            `spec:",name"`
	Unique  bool              `spec:"unique"`
	Columns []*schemaspec.Ref `spec:"columns"`
	schemaspec.DefaultExtension
}

Index holds a specification for the index key of a table.

type ModifyTable

type ModifyTable struct {
	Change
	Table   string   `spec:"table"`
	Changes []Change `spec:""`
}

ModifyTable is a specification for a schema.ModifyTable.

type PrimaryKey

type PrimaryKey struct {
	Columns []*schemaspec.Ref `spec:"columns"`
	schemaspec.DefaultExtension
}

PrimaryKey holds a specification for the primary key of a table.

type Schema

type Schema struct {
	Name string `spec:",name"`
	schemaspec.DefaultExtension
}

Schema holds a specification for a Schema.

type Table

type Table struct {
	Name        string          `spec:",name"`
	Schema      *schemaspec.Ref `spec:"schema"`
	Columns     []*Column       `spec:"column"`
	PrimaryKey  *PrimaryKey     `spec:"primary_key"`
	ForeignKeys []*ForeignKey   `spec:"foreign_key"`
	Indexes     []*Index        `spec:"index"`
	Checks      []*Check        `spec:"check"`
	schemaspec.DefaultExtension
}

Table holds a specification for an SQL table.

type Type

type Type string

Type represents a database agnostic column type.

const (
	TypeInt     Type = "int"
	TypeInt8    Type = "int8"
	TypeInt16   Type = "int16"
	TypeInt64   Type = "int64"
	TypeUint    Type = "uint"
	TypeUint8   Type = "uint8"
	TypeUint16  Type = "uint16"
	TypeUint64  Type = "uint64"
	TypeString  Type = "string"
	TypeBinary  Type = "binary"
	TypeEnum    Type = "enum"
	TypeBoolean Type = "boolean"
	TypeDecimal Type = "decimal"
	TypeFloat   Type = "float"
	TypeTime    Type = "time"
)

Type<X> are Types that represent database agnostic column types to be used in Atlas DDL documents.