base

Documentation

Index

• func BaseTable(object Base) (string, error)
• func HashObject(object Base) (uint64, error)
• func PreInsertion(object Base) error
• func SetId(object Base, newIdValue interface{}) error
• type Base
• type BaseIdentifier
  • func GetId(object Base) []BaseIdentifier
  • func InitializeId(object Base) ([]BaseIdentifier, error)
• type CompositeKey
• type CustomTabler
• type DatabaseFuncIDGenerator
• type DatabaseIDGenerator
• type DatabaseManagedID
  • func (DatabaseManagedID) DatabaseGeneratedID()
• type IDColumner
• type IDGenerator
• type LiteralStatement
• type PostInserter
• type PreInserter
• type Relationship
  • func MustRelationship(self Base, selfColumn string, target Base, targetColumn string) Relationship
  • func NewRelationship(self Base, selfColumn string, target Base, targetColumn string) (*Relationship, error)
  • func (self Relationship) Columns() (string, string)
  • func (self Relationship) Invert() *Relationship
  • func (self Relationship) Tables() (string, string)
  • func (self Relationship) Types() (reflect.Type, reflect.Type)
• type Relationshipable
• type Saveable
• type TraditionalID

Functions

func BaseTable

func BaseTable(object Base) (string, error)

func HashObject

func HashObject(object Base) (uint64, error)

func PreInsertion

func PreInsertion(object Base) error

func SetId

func SetId(object Base, newIdValue interface{}) error

Types

type Base

type Base interface{}

type BaseIdentifier

type BaseIdentifier struct {
	Column string
	Exists,
	IsSet bool
	Value interface{}
}

func GetId

func GetId(object Base) []BaseIdentifier

func InitializeId

func InitializeId(object Base) ([]BaseIdentifier, error)

type CompositeKey

type CompositeKey interface {
	CompositeKey() []string
}

type CustomTabler

type CustomTabler interface {
	TableName() string
}

type DatabaseFuncIDGenerator

type DatabaseFuncIDGenerator interface {
	DatabaseIDGenerationFunc() LiteralStatement
}

type DatabaseIDGenerator

type DatabaseIDGenerator interface {
	DatabaseGeneratedID()
}

type DatabaseManagedID

type DatabaseManagedID struct{}

func (DatabaseManagedID) DatabaseGeneratedID

func (DatabaseManagedID) DatabaseGeneratedID()

type IDColumner

type IDColumner interface {
	IDColumn() string
}

type IDGenerator

type IDGenerator interface {
	NewID() interface{}
}

type LiteralStatement

type LiteralStatement string

LiteralStatement is a string that will be directly inserted into a statement. Use great caution when using this as it will be vunerable to injection if not used properly.

type PostInserter

type PostInserter interface {
	PostInsertActions() error
}

type PreInserter

type PreInserter interface {
	PreInsertActions() error
}

type Relationship

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

Relationship is a representation of how two objects join together.

func MustRelationship

func MustRelationship(
	self Base, selfColumn string, target Base, targetColumn string,
) Relationship

func NewRelationship

func NewRelationship(
	self Base, selfColumn string, target Base, targetColumn string,
) (*Relationship, error)

func (Relationship) Columns

func (self Relationship) Columns() (string, string)

func (Relationship) Invert

func (self Relationship) Invert() *Relationship

Invert takes the relationship and swaps the self with the target. This essentially has the effect of changing:

foo.bar=baz.fizz

Into:

baz.fizz=foo.bar

func (Relationship) Tables

func (self Relationship) Tables() (string, string)

func (Relationship) Types

func (self Relationship) Types() (reflect.Type, reflect.Type)

type Relationshipable

type Relationshipable interface {
	Relationships() []Relationship
}

Relationshipable is a type that has at least on relationship.

type Saveable

type Saveable interface {
	Saved() bool
	Save()
}

type TraditionalID

type TraditionalID interface {
	SetID(interface{}) error
	ID() (interface{}, bool)
}