Documentation
¶
Index ¶
- func AliasTypeSpec(name, dbType string, attrs ...*schemaspec.TypeAttr) *schemaspec.TypeSpec
- func Column(spec *sqlspec.Column, conv ConvertTypeFunc) (*schema.Column, error)
- func FromColumn(col *schema.Column, columnTypeSpec ColumnTypeSpecFunc) (*sqlspec.Column, error)
- func FromForeignKey(s *schema.ForeignKey) (*sqlspec.ForeignKey, error)
- func FromIndex(idx *schema.Index) (*sqlspec.Index, error)
- func FromPrimaryKey(s *schema.Index) (*sqlspec.PrimaryKey, error)
- func FromRealm(r *schema.Realm, fn TableSpecFunc) ([]*sqlspec.Schema, []*sqlspec.Table, error)
- func FromSchema(s *schema.Schema, fn TableSpecFunc) (*sqlspec.Schema, []*sqlspec.Table, error)
- func FromTable(t *schema.Table, colFn ColumnSpecFunc, pkFn PrimaryKeySpecFunc, ...) (*sqlspec.Table, error)
- func Index(spec *sqlspec.Index, parent *schema.Table) (*schema.Index, error)
- func ListAttr(k string, litValues ...string) *schemaspec.Attr
- func LitAttr(k, v string) *schemaspec.Attr
- func Marshal(v interface{}, marshaler schemaspec.Marshaler, ...) ([]byte, error)
- func NewCol(name string, coltype *schemaspec.Type, attrs ...*schemaspec.Attr) *sqlspec.Column
- func PrimaryKey(spec *sqlspec.PrimaryKey, parent *schema.Table) (*schema.Index, error)
- func Realm(schemas []*sqlspec.Schema, tables []*sqlspec.Table, ...) (*schema.Realm, error)
- func Schema(spec *sqlspec.Schema, tables []*sqlspec.Table, convertTable ConvertTableFunc) (*schema.Schema, error)
- func SizeTypeAttr(required bool) *schemaspec.TypeAttr
- func StrAttr(k, v string) *schemaspec.Attr
- func Table(spec *sqlspec.Table, parent *schema.Schema, convertColumn ConvertColumnFunc, ...) (*schema.Table, error)
- func TypeSpec(name string, attrs ...*schemaspec.TypeAttr) *schemaspec.TypeSpec
- func Unmarshal(data []byte, unmarshaler schemaspec.Unmarshaler, v interface{}, ...) error
- type ColumnSpecFunc
- type ColumnTypeSpecFunc
- type ConvertColumnFunc
- type ConvertIndexFunc
- type ConvertPrimaryKeyFunc
- type ConvertTableFunc
- type ConvertTypeFunc
- type ForeignKeySpecFunc
- type IndexSpecFunc
- type PrimaryKeySpecFunc
- type RegistryOption
- type TableSpecFunc
- type TypeRegistry
- func (r *TypeRegistry) Convert(typ schema.Type) (*schemaspec.Type, error)
- func (r *TypeRegistry) PrintType(typ *schemaspec.Type) (string, error)
- func (r *TypeRegistry) Register(specs ...*schemaspec.TypeSpec) error
- func (r *TypeRegistry) Specs() []*schemaspec.TypeSpec
- func (r *TypeRegistry) Type(typ *schemaspec.Type, extra []*schemaspec.Attr) (schema.Type, error)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func AliasTypeSpec ¶ added in v0.2.0
func AliasTypeSpec(name, dbType string, attrs ...*schemaspec.TypeAttr) *schemaspec.TypeSpec
AliasTypeSpec returns a TypeSpec with the provided name.
func FromColumn ¶ added in v0.2.0
FromColumn converts a *schema.Column into a *sqlspec.Column using the ColumnTypeSpecFunc.
func FromForeignKey ¶
func FromForeignKey(s *schema.ForeignKey) (*sqlspec.ForeignKey, error)
FromForeignKey converts schema.ForeignKey to sqlspec.ForeignKey
func FromPrimaryKey ¶
func FromPrimaryKey(s *schema.Index) (*sqlspec.PrimaryKey, error)
FromPrimaryKey converts schema.Index to a sqlspec.PrimaryKey.
func FromRealm ¶ added in v0.2.0
FromRealm converts a schema.Realm into []sqlspec.Schema and []sqlspec.Table.
func FromSchema ¶
FromSchema converts a schema.Schema into sqlspec.Schema and []sqlspec.Table.
func FromTable ¶
func FromTable(t *schema.Table, colFn ColumnSpecFunc, pkFn PrimaryKeySpecFunc, idxFn IndexSpecFunc, fkFn ForeignKeySpecFunc) (*sqlspec.Table, error)
FromTable converts a schema.Table to a sqlspec.Table.
func ListAttr ¶
func ListAttr(k string, litValues ...string) *schemaspec.Attr
ListAttr is a helper method for constructing *schemaspec.Attr instances that contain list values.
func LitAttr ¶
func LitAttr(k, v string) *schemaspec.Attr
LitAttr is a helper method for constructing *schemaspec.Attr instances that contain literal values.
func Marshal ¶ added in v0.2.0
func Marshal(v interface{}, marshaler schemaspec.Marshaler, schemaSpec func(schem *schema.Schema) (*sqlspec.Schema, []*sqlspec.Table, error)) ([]byte, error)
Marshal marshals v into an Atlas DDL document using a schemaspec.Marshaler. Marshal uses the given schemaSpec function to convert a *schema.Schema into *sqlspec.Schema and []*sqlspec.Table.
func NewCol ¶
func NewCol(name string, coltype *schemaspec.Type, attrs ...*schemaspec.Attr) *sqlspec.Column
NewCol is a helper method for constructing *sqlspec.Column instances.
func PrimaryKey ¶
PrimaryKey converts a sqlspec.PrimaryKey to a schema.Index.
func Realm ¶ added in v0.2.0
func Realm(schemas []*sqlspec.Schema, tables []*sqlspec.Table, convertTable ConvertTableFunc) (*schema.Realm, error)
Realm converts the schemas and tables into a schema.Realm.
func Schema ¶
func Schema(spec *sqlspec.Schema, tables []*sqlspec.Table, convertTable ConvertTableFunc) (*schema.Schema, error)
Schema converts a sqlspec.Schema with its relevant []sqlspec.Tables into a schema.Schema.
func SizeTypeAttr ¶ added in v0.2.0
func SizeTypeAttr(required bool) *schemaspec.TypeAttr
SizeTypeAttr returns a TypeAttr for a size attribute.
func StrAttr ¶ added in v0.2.0
func StrAttr(k, v string) *schemaspec.Attr
StrAttr is a helper method for constructing *schemaspec.Attr of type string.
func Table ¶
func Table(spec *sqlspec.Table, parent *schema.Schema, convertColumn ConvertColumnFunc, convertPk ConvertPrimaryKeyFunc, convertIndex ConvertIndexFunc) (*schema.Table, error)
Table converts a sqlspec.Table to a schema.Table. Table conversion is done without converting ForeignKeySpecs into ForeignKeys, as the target tables do not necessarily exist in the schema at this point. Instead, the linking is done by the Schema function.
func TypeSpec ¶ added in v0.2.0
func TypeSpec(name string, attrs ...*schemaspec.TypeAttr) *schemaspec.TypeSpec
TypeSpec returns a TypeSpec with the provided name.
func Unmarshal ¶ added in v0.2.0
func Unmarshal(data []byte, unmarshaler schemaspec.Unmarshaler, v interface{}, convertTable func(spec *sqlspec.Table, parent *schema.Schema) (*schema.Table, error)) error
Unmarshal unmarshals an Atlas DDL document using an unmarshaler into v. Unmarshal uses the given convertTable function to convert a *sqlspec.Table into a *schema.Table.
Types ¶
type ColumnSpecFunc ¶
List of convert function types.
type ColumnTypeSpecFunc ¶ added in v0.2.0
List of convert function types.
type ConvertColumnFunc ¶
List of convert function types.
type ConvertIndexFunc ¶
List of convert function types.
type ConvertPrimaryKeyFunc ¶
List of convert function types.
type ConvertTableFunc ¶
List of convert function types.
type ConvertTypeFunc ¶
List of convert function types.
type ForeignKeySpecFunc ¶
type ForeignKeySpecFunc func(fk *schema.ForeignKey) (*sqlspec.ForeignKey, error)
List of convert function types.
type IndexSpecFunc ¶
List of convert function types.
type PrimaryKeySpecFunc ¶
type PrimaryKeySpecFunc func(index *schema.Index) (*sqlspec.PrimaryKey, error)
List of convert function types.
type RegistryOption ¶ added in v0.2.0
type RegistryOption func(*TypeRegistry) error
RegistryOption configures a TypeRegistry.
func WithFormatter ¶ added in v0.2.0
func WithFormatter(formatter func(schema.Type) (string, error)) RegistryOption
WithFormatter configures the registry to use a formatting function for printing schema.Type as string.
func WithParser ¶ added in v0.2.0
func WithParser(parser func(string) (schema.Type, error)) RegistryOption
WithParser configures the registry to use a parsing function for converting a string to a schema.Type.
func WithSpecs ¶ added in v0.2.0
func WithSpecs(specs ...*schemaspec.TypeSpec) RegistryOption
WithSpecs configures the registry to register the given list of type specs.
type TableSpecFunc ¶
List of convert function types.
type TypeRegistry ¶ added in v0.2.0
type TypeRegistry struct {
// contains filtered or unexported fields
}
TypeRegistry is a collection of *schemaspec.TypeSpec.
func NewRegistry ¶ added in v0.2.0
func NewRegistry(opts ...RegistryOption) *TypeRegistry
NewRegistry creates a new *TypeRegistry, registers the provided types and panics if an error occurs.
func (*TypeRegistry) Convert ¶ added in v0.2.0
func (r *TypeRegistry) Convert(typ schema.Type) (*schemaspec.Type, error)
Convert converts the schema.Type to a *schemaspec.Type.
func (*TypeRegistry) PrintType ¶ added in v0.2.0
func (r *TypeRegistry) PrintType(typ *schemaspec.Type) (string, error)
PrintType returns the string representation of a column type which can be parsed by the driver into a schema.Type.
func (*TypeRegistry) Register ¶ added in v0.2.0
func (r *TypeRegistry) Register(specs ...*schemaspec.TypeSpec) error
Register adds one or more TypeSpec to the registry.
func (*TypeRegistry) Specs ¶ added in v0.2.0
func (r *TypeRegistry) Specs() []*schemaspec.TypeSpec
Specs returns the TypeSpecs in the registry.
func (*TypeRegistry) Type ¶ added in v0.2.0
func (r *TypeRegistry) Type(typ *schemaspec.Type, extra []*schemaspec.Attr) (schema.Type, error)
Type converts a *schemaspec.Type into a schema.Type.
Source Files