datatype

README

GORM Data Types

JSON

sqlite, mysql, postgres supported

import "gorm.io/datatypes"

type UserWithJSON struct {
	gorm.Model
	Name       string
	Attributes datatypes.JSON
}

DB.Create(&User{
	Name:       "json-1",
	Attributes: datatypes.JSON([]byte(`{"name": "jinzhu", "age": 18, "tags": ["tag1", "tag2"], "orgs": {"orga": "orga"}}`)),
}

// Check JSON has keys
datatypes.JSONQuery("attributes").HasKey(value, keys...)

db.Find(&user, datatypes.JSONQuery("attributes").HasKey("role"))
db.Find(&user, datatypes.JSONQuery("attributes").HasKey("orgs", "orga"))
// MySQL
// SELECT * FROM `users` WHERE JSON_EXTRACT(`attributes`, '$.role') IS NOT NULL
// SELECT * FROM `users` WHERE JSON_EXTRACT(`attributes`, '$.orgs.orga') IS NOT NULL

// PostgreSQL
// SELECT * FROM "user" WHERE "attributes"::jsonb ? 'role'
// SELECT * FROM "user" WHERE "attributes"::jsonb -> 'orgs' ? 'orga'


// Check JSON extract value from keys equal to value
datatypes.JSONQuery("attributes").Equals(value, keys...)

DB.First(&user, datatypes.JSONQuery("attributes").Equals("jinzhu", "name"))
DB.First(&user, datatypes.JSONQuery("attributes").Equals("orgb", "orgs", "orgb"))
// MySQL
// SELECT * FROM `user` WHERE JSON_EXTRACT(`attributes`, '$.name') = "jinzhu"
// SELECT * FROM `user` WHERE JSON_EXTRACT(`attributes`, '$.orgs.orgb') = "orgb"

// PostgreSQL
// SELECT * FROM "user" WHERE json_extract_path_text("attributes"::json,'name') = 'jinzhu'
// SELECT * FROM "user" WHERE json_extract_path_text("attributes"::json,'orgs','orgb') = 'orgb'

NOTE: SQlite need to build with json1 tag, e.g: go build --tags json1, refer https://github.com/mattn/go-sqlite3#usage

Date

import "gorm.io/datatypes"

type UserWithDate struct {
	gorm.Model
	Name string
	Date datatypes.Date
}

user := UserWithDate{Name: "jinzhu", Date: datatypes.Date(time.Now())}
DB.Create(&user)
// INSERT INTO `user_with_dates` (`name`,`date`) VALUES ("jinzhu","2020-07-17 00:00:00")

DB.First(&result, "name = ? AND date = ?", "jinzhu", datatypes.Date(curTime))
// SELECT * FROM user_with_dates WHERE name = "jinzhu" AND date = "2020-07-17 00:00:00" ORDER BY `user_with_dates`.`id` LIMIT 1

Time

MySQL, PostgreSQL, SQLite, SQLServer are supported.

Time with nanoseconds is supported for some databases which support for time with fractional second scale.

import "gorm.io/datatypes"

type UserWithTime struct {
    gorm.Model
    Name string
    Time datatypes.Time
}

user := UserWithTime{Name: "jinzhu", Time: datatypes.NewTime(1, 2, 3, 0)}
DB.Create(&user)
// INSERT INTO `user_with_times` (`name`,`time`) VALUES ("jinzhu","01:02:03")

DB.First(&result, "name = ? AND time = ?", "jinzhu", datatypes.NewTime(1, 2, 3, 0))
// SELECT * FROM user_with_times WHERE name = "jinzhu" AND time = "01:02:03" ORDER BY `user_with_times`.`id` LIMIT 1

NOTE: If the current using database is SQLite, the field column type is defined as TEXT type when GORM AutoMigrate because SQLite doesn't have time type.

Documentation

Index

• type Date
  • func (date *Date) GobDecode(b []byte) error
  • func (date Date) GobEncode() ([]byte, error)
  • func (date Date) GormDataType() string
  • func (date Date) MarshalJSON() ([]byte, error)
  • func (date *Date) Scan(value interface{}) (err error)
  • func (date *Date) UnmarshalJSON(b []byte) error
  • func (date Date) Value() (driver.Value, error)
• type IPPrefix
  • func (r IPPrefix) Contains(ip netip.Addr) bool
  • func (IPPrefix) GormDBDataType(db *gorm.DB, field *schema.Field) string
  • func (IPPrefix) GormDataType() string
  • func (m IPPrefix) MarshalJSON() ([]byte, error)
  • func (m *IPPrefix) Scan(val interface{}) error
  • func (m *IPPrefix) UnmarshalJSON(b []byte) error
  • func (m IPPrefix) Value() (driver.Value, error)
• type Int64
  • func NewInt64(i int64) *Int64
  • func (r *Int64) Add(n int64) int64
  • func (r *Int64) CAS(old, new int64) bool
  • func (r *Int64) Dec() int64
  • func (Int64) GormDBDataType(db *gorm.DB, field *schema.Field) string
  • func (Int64) GormDataType() string
  • func (r *Int64) Inc() int64
  • func (r *Int64) Load() int64
  • func (r *Int64) Scan(val interface{}) error
  • func (r *Int64) Store(n int64)
  • func (r *Int64) Sub(n int64) int64
  • func (r *Int64) Swap(n int64) int64
  • func (r *Int64) Value() (driver.Value, error)
• type JSON
  • func (JSON) GormDBDataType(db *gorm.DB, field *schema.Field) string
  • func (JSON) GormDataType() string
  • func (js JSON) GormValue(ctx context.Context, db *gorm.DB) clause.Expr
  • func (j JSON) MarshalJSON() ([]byte, error)
  • func (j *JSON) Scan(value interface{}) error
  • func (j JSON) String() string
  • func (j *JSON) UnmarshalJSON(b []byte) error
  • func (j JSON) Value() (driver.Value, error)
• type JSONMap
  • func (JSONMap) GormDBDataType(db *gorm.DB, field *schema.Field) string
  • func (m JSONMap) GormDataType() string
  • func (jm JSONMap) GormValue(ctx context.Context, db *gorm.DB) clause.Expr
  • func (m JSONMap) MarshalJSON() ([]byte, error)
  • func (m *JSONMap) Scan(val interface{}) error
  • func (m *JSONMap) UnmarshalJSON(b []byte) error
  • func (m JSONMap) Value() (driver.Value, error)
• type JSONQueryExpression
  • func JSONQuery(column string) *JSONQueryExpression
  • func (jsonQuery *JSONQueryExpression) Build(builder clause.Builder)
  • func (jsonQuery *JSONQueryExpression) Equals(value interface{}, keys ...string) *JSONQueryExpression
  • func (jsonQuery *JSONQueryExpression) HasKey(keys ...string) *JSONQueryExpression
• type Time
  • func NewTime(hour, min, sec, nsec int) Time
  • func (Time) GormDBDataType(db *gorm.DB, field *schema.Field) string
  • func (Time) GormDataType() string
  • func (t Time) MarshalJSON() ([]byte, error)
  • func (t *Time) Scan(src interface{}) error
  • func (t Time) String() string
  • func (t *Time) UnmarshalJSON(data []byte) error
  • func (t Time) Value() (driver.Value, error)
• type URL
  • func (URL) GormDBDataType(db *gorm.DB, field *schema.Field) string
  • func (URL) GormDataType() string
  • func (u URL) MarshalJSON() ([]byte, error)
  • func (u *URL) Scan(value interface{}) error
  • func (u *URL) String() string
  • func (u *URL) UnmarshalJSON(data []byte) error
  • func (u URL) Value() (driver.Value, error)

Types

type Date

type Date time.Time

func (*Date) GobDecode

func (date *Date) GobDecode(b []byte) error

func (Date) GobEncode

func (date Date) GobEncode() ([]byte, error)

func (Date) GormDataType

func (date Date) GormDataType() string

GormDataType gorm common data type

func (Date) MarshalJSON

func (date Date) MarshalJSON() ([]byte, error)

func (*Date) Scan

func (date *Date) Scan(value interface{}) (err error)

func (*Date) UnmarshalJSON

func (date *Date) UnmarshalJSON(b []byte) error

func (Date) Value

func (date Date) Value() (driver.Value, error)

type IPPrefix

type IPPrefix []netip.Prefix

func (IPPrefix) Contains

func (r IPPrefix) Contains(ip netip.Addr) bool

func (IPPrefix) GormDBDataType

func (IPPrefix) GormDBDataType(db *gorm.DB, field *schema.Field) string

func (IPPrefix) GormDataType

func (IPPrefix) GormDataType() string

func (IPPrefix) MarshalJSON

func (m IPPrefix) MarshalJSON() ([]byte, error)

func (*IPPrefix) Scan

func (m *IPPrefix) Scan(val interface{}) error

func (*IPPrefix) UnmarshalJSON

func (m *IPPrefix) UnmarshalJSON(b []byte) error

func (IPPrefix) Value

func (m IPPrefix) Value() (driver.Value, error)

type Int64

type Int64 int64

Int64 is an atomic wrapper around an int64.

func NewInt64

func NewInt64(i int64) *Int64

func (*Int64) Add

func (r *Int64) Add(n int64) int64

Add atomically adds to the wrapped int64 and returns the new value.

func (*Int64) CAS

func (r *Int64) CAS(old, new int64) bool

CAS is an atomic compare-and-swap.

func (*Int64) Dec

func (r *Int64) Dec() int64

Dec atomically decrements the wrapped int64 and returns the new value.

func (Int64) GormDBDataType

func (Int64) GormDBDataType(db *gorm.DB, field *schema.Field) string

func (Int64) GormDataType

func (Int64) GormDataType() string

func (*Int64) Inc

func (r *Int64) Inc() int64

Inc atomically increments the wrapped int64 and returns the new value.

func (*Int64) Load

func (r *Int64) Load() int64

Load atomically loads the wrapped value.

func (*Int64) Scan

func (r *Int64) Scan(val interface{}) error

func (*Int64) Store

func (r *Int64) Store(n int64)

Store atomically stores the passed value.

func (*Int64) Sub

func (r *Int64) Sub(n int64) int64

Sub atomically subtracts from the wrapped int64 and returns the new value.

func (*Int64) Swap

func (r *Int64) Swap(n int64) int64

Swap atomically swaps the wrapped int64 and returns the old value.

func (*Int64) Value

func (r *Int64) Value() (driver.Value, error)

type JSON

type JSON json.RawMessage

JSON defined JSON data type, need to implements driver.Valuer, sql.Scanner interface

func (JSON) GormDBDataType

func (JSON) GormDBDataType(db *gorm.DB, field *schema.Field) string

GormDBDataType gorm db data type

func (JSON) GormDataType

func (JSON) GormDataType() string

GormDataType gorm common data type

func (JSON) GormValue

func (js JSON) GormValue(ctx context.Context, db *gorm.DB) clause.Expr

func (JSON) MarshalJSON

func (j JSON) MarshalJSON() ([]byte, error)

MarshalJSON to output non base64 encoded []byte

func (*JSON) Scan

func (j *JSON) Scan(value interface{}) error

Scan scan value into Jsonb, implements sql.Scanner interface

func (JSON) String

func (j JSON) String() string

func (*JSON) UnmarshalJSON

func (j *JSON) UnmarshalJSON(b []byte) error

UnmarshalJSON to deserialize []byte

func (JSON) Value

func (j JSON) Value() (driver.Value, error)

Value return json value, implement driver.Valuer interface

type JSONMap

type JSONMap map[string]interface{}

JSONMap defined JSON data type, need to implements driver.Valuer, sql.Scanner interface

func (JSONMap) GormDBDataType

func (JSONMap) GormDBDataType(db *gorm.DB, field *schema.Field) string

GormDBDataType gorm db data type

func (JSONMap) GormDataType

func (m JSONMap) GormDataType() string

GormDataType gorm common data type

func (JSONMap) GormValue

func (jm JSONMap) GormValue(ctx context.Context, db *gorm.DB) clause.Expr

func (JSONMap) MarshalJSON

func (m JSONMap) MarshalJSON() ([]byte, error)

MarshalJSON to output non base64 encoded []byte

func (*JSONMap) Scan

func (m *JSONMap) Scan(val interface{}) error

Scan scan value into Jsonb, implements sql.Scanner interface

func (*JSONMap) UnmarshalJSON

func (m *JSONMap) UnmarshalJSON(b []byte) error

UnmarshalJSON to deserialize []byte

func (JSONMap) Value

func (m JSONMap) Value() (driver.Value, error)

Value return json value, implement driver.Valuer interface

type JSONQueryExpression

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

JSONQueryExpression json query expression, implements clause.Expression interface to use as querier

func JSONQuery

func JSONQuery(column string) *JSONQueryExpression

JSONQuery query column as json

func (*JSONQueryExpression) Build

func (jsonQuery *JSONQueryExpression) Build(builder clause.Builder)

Build implements clause.Expression

func (*JSONQueryExpression) Equals

func (jsonQuery *JSONQueryExpression) Equals(value interface{}, keys ...string) *JSONQueryExpression

Keys returns clause.Expression

func (*JSONQueryExpression) HasKey

func (jsonQuery *JSONQueryExpression) HasKey(keys ...string) *JSONQueryExpression

HasKey returns clause.Expression

type Time

type Time time.Duration

Time is time data type.

func NewTime

func NewTime(hour, min, sec, nsec int) Time

NewTime is a constructor for Time and returns new Time.

func (Time) GormDBDataType

func (Time) GormDBDataType(db *gorm.DB, field *schema.Field) string

GormDBDataType returns gorm DB data type based on the current using database.

func (Time) GormDataType

func (Time) GormDataType() string

GormDataType returns gorm common data type. This type is used for the field's column type.

func (Time) MarshalJSON

func (t Time) MarshalJSON() ([]byte, error)

MarshalJSON implements json.Marshaler to convert Time to json serialization.

func (*Time) Scan

func (t *Time) Scan(src interface{}) error

Scan implements sql.Scanner interface and scans value into Time,

func (Time) String

func (t Time) String() string

String implements fmt.Stringer interface.

func (*Time) UnmarshalJSON

func (t *Time) UnmarshalJSON(data []byte) error

UnmarshalJSON implements json.Unmarshaler to deserialize json data.

func (Time) Value

func (t Time) Value() (driver.Value, error)

Value implements driver.Valuer interface and returns string format of Time.

type URL

type URL url.URL

func (URL) GormDBDataType

func (URL) GormDBDataType(db *gorm.DB, field *schema.Field) string

func (URL) GormDataType

func (URL) GormDataType() string

func (URL) MarshalJSON

func (u URL) MarshalJSON() ([]byte, error)

func (*URL) Scan

func (u *URL) Scan(value interface{}) error

func (*URL) String

func (u *URL) String() string

func (*URL) UnmarshalJSON

func (u *URL) UnmarshalJSON(data []byte) error

func (URL) Value

func (u URL) Value() (driver.Value, error)