JSON & Full Text

JSON field definition

type Product struct {
    oro.Model
    Code string
    Meta oro.JSONRaw
}

func (Product) Define(s *oro.SchemaBuilder) {
    s.Table("products")
    s.Field("Code").String().Unique()
    s.Field("Meta").JSON().Nullable()
}

oro.JSONRaw stores raw JSON payloads. You can also map JSON into custom types through normal scanner/valuer patterns when needed.

JSON path conditions

rows, err := db.Use[Product]().Where(
    oro.JSON("Meta").Path("profile", "country").Eq("CN"),
).Get(ctx)

rows, err := db.Use[Product]().Where(
    oro.JSON("Meta").Path("flags", "featured").Eq(true),
).Get(ctx)

rows, err := db.Use[Product]().Where(
    oro.JSON("Meta").Path("profile", "city").Like("%Shanghai%"),
).Get(ctx)

Path(...).Like(value) runs a SQL LIKE against the text value at the JSON path (works on SQLite/MySQL/PostgreSQL).

Supported JSON helpers include equality, inequality, null checks, existence checks, contains-style predicates, and LIKE matching where the dialect supports them.

JSON and table queries

Model queries use Go field names:

db.Use[Product]().Where(oro.JSON("Meta").Path("color").Eq("blue"))

Table queries use database column names:

db.Table("products").Where(oro.JSON("meta").Path("color").Eq("blue"))

Full-text index definition

func (Post) Define(s *oro.SchemaBuilder) {
    s.Table("posts")
    s.Field("Title").String().FullText()
    s.Field("Body").Text()
    s.FullText("ft_posts_title_body", "Title", "Body")
}

Full-text query

posts, err := db.Use[Post]().Where(
    oro.FullText("Title", "Body").Match("generic orm"),
).Get(ctx)

Full-text score

posts, err := db.Use[Post]().
    Select("ID", "Title", oro.FullText("Title", "Body").Score("generic orm").As("score")).
    Where(oro.FullText("Title", "Body").Match("generic orm")).
    OrderByDesc("score").
    Get(ctx)

Dialect notes