json

Documentation

Index

• func Column(col string) columnExpression
• func Unmarshal(input any, output any) error
• type JSON
  • func Marshal(v any) (JSON, error)
  • func Parse(v any) JSON
  • func TryParse(v any) (JSON, error)
  • func (j JSON) Array() []gjson.Result
  • func (j JSON) ForEach(iterator func(key, value gjson.Result) bool)
  • func (j JSON) Get(path string) gjson.Result
  • 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 any) error
  • func (j JSON) String() string
  • func (j JSON) Unmarshal(v any) error
  • func (j *JSON) UnmarshalJSON(b []byte) error
  • func (j JSON) Value() (driver.Value, error)
• type JSONArrayExpression
  • func JSONArrayQuery(column string) *JSONArrayExpression
  • func (json *JSONArrayExpression) Build(builder clause.Builder)
  • func (json *JSONArrayExpression) Contains(value any) *JSONArrayExpression
• type JSONMap
  • func (j JSONMap) ForEach(iterator func(key, value gjson.Result) bool)
  • func (j JSONMap) Get(path string) gjson.Result
  • 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 any) error
  • func (m *JSONMap) UnmarshalJSON(b []byte) error
  • func (m JSONMap) Value() (driver.Value, error)
• type JSONOverlapsExpression
  • func JSONOverlaps(column clause.Expression, value string) *JSONOverlapsExpression
  • func (json *JSONOverlapsExpression) Build(builder clause.Builder)
• type JSONQueryExpression
  • func JSONQuery(column string) *JSONQueryExpression
  • func (jsonQuery *JSONQueryExpression) Build(builder clause.Builder)
  • func (jsonQuery *JSONQueryExpression) Equals(value any, keys ...string) *JSONQueryExpression
  • func (jsonQuery *JSONQueryExpression) Extract(path string) *JSONQueryExpression
  • func (jsonQuery *JSONQueryExpression) HasKey(keys ...string) *JSONQueryExpression
• type JSONSetExpression
  • func JSONSet(column string) *JSONSetExpression
  • func (jsonSet *JSONSetExpression) Build(builder clause.Builder)
  • func (jsonSet *JSONSetExpression) Set(path string, value any) *JSONSetExpression

Functions

func Column

func Column(col string) columnExpression

func Unmarshal

func Unmarshal(input any, output any) error

Types

type JSON

type JSON json.RawMessage

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

func Marshal

func Marshal(v any) (JSON, error)

func Parse

func Parse(v any) JSON

func TryParse

func TryParse(v any) (JSON, error)

func (JSON) Array

func (j JSON) Array() []gjson.Result

func (JSON) ForEach

func (j JSON) ForEach(iterator func(key, value gjson.Result) bool)

func (JSON) Get

func (j JSON) Get(path string) gjson.Result

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 any) error

Scan scan value into Jsonb, implements sql.Scanner interface

func (JSON) String

func (j JSON) String() string

func (JSON) Unmarshal

func (j JSON) Unmarshal(v any) error

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 JSONArrayExpression

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

func JSONArrayQuery

func JSONArrayQuery(column string) *JSONArrayExpression

func (*JSONArrayExpression) Build

func (json *JSONArrayExpression) Build(builder clause.Builder)

Build implements clause.Expression

func (*JSONArrayExpression) Contains

func (json *JSONArrayExpression) Contains(value any) *JSONArrayExpression

type JSONMap

type JSONMap map[string]any

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

func (JSONMap) ForEach

func (j JSONMap) ForEach(iterator func(key, value gjson.Result) bool)

func (JSONMap) Get

func (j JSONMap) Get(path string) gjson.Result

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 any) 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 JSONOverlapsExpression

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

JSONOverlapsExpression JSON_OVERLAPS expression, implements clause.Expression interface to use as querier

func JSONOverlaps

func JSONOverlaps(column clause.Expression, value string) *JSONOverlapsExpression

JSONOverlaps query column as json

func (*JSONOverlapsExpression) Build

func (json *JSONOverlapsExpression) Build(builder clause.Builder)

Build implements clause.Expression only mysql support JSON_OVERLAPS

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 any, keys ...string) *JSONQueryExpression

Keys returns clause.Expression

func (*JSONQueryExpression) Extract

func (jsonQuery *JSONQueryExpression) Extract(path string) *JSONQueryExpression

Extract extract json with path

func (*JSONQueryExpression) HasKey

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

HasKey returns clause.Expression

type JSONSetExpression

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

JSONSetExpression json set expression, implements clause.Expression interface to use as updater

func JSONSet

func JSONSet(column string) *JSONSetExpression

JSONSet update fields of json column

func (*JSONSetExpression) Build

func (jsonSet *JSONSetExpression) Build(builder clause.Builder)

Build implements clause.Expression support mysql, sqlite and postgres

func (*JSONSetExpression) Set

func (jsonSet *JSONSetExpression) Set(path string, value any) *JSONSetExpression

Set return clause.Expression.

{
	"age": 20,
	"name": "json-1",
	"orgs": {"orga": "orgv"},
	"tags": ["tag1", "tag2"]
}

// In MySQL/SQLite, path is `age`, `name`, `orgs.orga`, `tags[0]`, `tags[1]`.
DB.UpdateColumn("attr", JSONSet("attr").Set("orgs.orga", 42))

// In PostgreSQL, path is `{age}`, `{name}`, `{orgs,orga}`, `{tags, 0}`, `{tags, 1}`.
DB.UpdateColumn("attr", JSONSet("attr").Set("{orgs, orga}", "bar"))