vorm

type Foreign ¶

type Foreign uint

Represents a database agnostic foreign key

func (x *Foreign) Primary() Primary

func (x *Foreign) Scan(src interface{}) error

func (x *Foreign) Uint() uint

func (x *Foreign) Value() (driver.Value, error)

type JsonStringSlice ¶

type JsonStringSlice []string

Represents a string list stored in the DB in JSON format.

func (l *JsonStringSlice) Scan(src interface{}) error

func (l *JsonStringSlice) Value() (val driver.Value, err error)

type JsonbMap ¶

type JsonbMap map[string]interface{}

Automatically converts JSON type from DB into a map[string]interface{}

func (p *JsonbMap) Scan(src interface{}) error

func (p *JsonbMap) Truncate()

func (p JsonbMap) Value() (val driver.Value, err error)

type Model ¶

type Model struct {
	*gorm.DB
}

var DB *Model

func InitDB(dataSourceName string) (*Model, error)

func InitMySQLDB(dataSourceName string) (*Model, error)

func InitOracleDB(dataSourceName string) (*Model, error)

func InitPostgresDB(dataSourceName string) (*Model, error)

type ORM ¶

type ORM struct {
	ID        Primary `gorm:"primary_key"`
	CreatedAt time.Time
	UpdatedAt time.Time
	DeletedAt *time.Time `sql:"index"`
}

Mimicks gorm.Model except ID is of type Primary

type ORMJson ¶

type ORMJson struct {
	json.RawMessage
}

Use in migrations in case the DB entry is to be made in JSON format Can use JsonbMap or JsonStringSlice to automatically unmarshal from db into the desired data type in the actual code Currently, all the supported dialects (postgres, oracle, mysql) are written so that ORMJson is assumed to be a json type. If this code is changed, we can use JsonbMap as well.

func CreateORMJson(i interface{}) ORMJson

func (j *ORMJson) Scan(src interface{}) error

func (j ORMJson) Value() (val driver.Value, err error)

type Primary ¶

type Primary uint

Represents a database agnostic primary key

func (x *Primary) Foreign() Foreign

func (x *Primary) Scan(src interface{}) error

func (x *Primary) Uint() uint

func (x *Primary) Value() (driver.Value, error)