Mutations¶

Basic Mutator¶

REL uses mutator to define inserts and updates operation. Using basic mutator won't update created_at and updated_at fields.

Mutator	Description
`Dec(field string)`	Decrement a field value by `1`
`DecBy(field string, n int)`	Decrement a field value by `n`
`Inc(field string)`	Increase a field value by `1`
`IncBy(field string, n int)`	Increase a field value by `n`
`Set(field string, value interface{})`	Set a value to a field
`SetFragment(raw string, args ...interface{})`	Set a value of a field using SQL fragment

Set title and category values:

Example

err := repo.Update(ctx, &book,
    rel.Set("title", "REL for Dummies"),
    rel.Set("category", "technology"),
)

Mock

repo.ExpectUpdate(
    rel.Set("title", "REL for Dummies"),
    rel.Set("category", "technology"),
).For(&book)

Decrement stock:

Example

err := repo.Update(ctx, &book, rel.DecBy("stock", 2))

Mock

repo.ExpectUpdate(rel.DecBy("stock", 2)).For(&book)

Update title using SQL fragment:

Example

err := repo.Update(ctx, &book, rel.SetFragment("title=?", "REL for dummies"))

Mock

repo.ExpectUpdate(rel.SetFragment("title=?", "REL for dummies")).For(&book)

Structset¶

Structset is a mutator that generates list of Set mutators based on a struct value. Using Structset will result in replacing the intire record in the database using provided struct, It'll always clear a has many association and re-insert it on updates if it's loaded. Changeset can be used to avoid clearing has many association on updates.

Note

Structset is the default mutator used when none is provided explicitly.

Inserting a struct using structset mutator:

Example

structset := rel.NewStructset(&book, false)
err := repo.Insert(ctx, &book, structset)

Mock

repo.ExpectInsert().For(&book)

Changeset¶

Changeset allows you to track and update only updated values and asssociation to database. This is very efficient when dealing with a complex struct that contains a lot of fields and associations.

Update only price and discount field using changeset:

Example

changeset := rel.NewChangeset(&book)
book.Price = 10
if changeset.FieldChanged("price") {
    book.Discount = false
}

err := repo.Update(ctx, &book, changeset)

Mock

repo.ExpectUpdate().ForType("main.Book")

Map¶

Map allows to define group of Set mutator, this is intended to be use internally and not to be exposed directly to user. Mutation defined in the map will be applied to the struct passed as the first argument. Insert/Update using map wont update created_at or updated_at field.

Insert books and its author using Map:

Example

data := rel.Map{
    "title":    "Rel for dummies",
    "category": "education",
    "author": rel.Map{
        "name": "CZ2I28 Delta",
    },
}

// Insert using map.
err := repo.Insert(ctx, &book, data)

Mock

data := rel.Map{
    "title":    "Rel for dummies",
    "category": "education",
    "author": rel.Map{
        "name": "CZ2I28 Delta",
    },
}

repo.ExpectInsert(data).ForType("main.Book")

Reloading Updated Struct¶

By default, only Inc, IncBy, Dec, DecBy and SetFragment will reload struct from database, Reload mutator can be used to manually trigger reload after inserts/update operations.

Update title and force reload:

Example

err := repo.Update(ctx, &book,
    rel.Set("title", "REL for Dummies"),
    rel.Reload(true),
)

Mock

repo.ExpectUpdate(
    rel.Set("title", "REL for Dummies"),
    rel.Reload(true),
).For(&book)

Cascade Operations¶

REL supports insert/update/delete record and it's associations.

Disable cascade insert (default enabled):

Example

err := repo.Insert(ctx, &book, rel.Cascade(false))

Mock

repo.ExpectInsert(rel.Cascade(false)).For(&book)

Enable cascade delete (default disabled):

Example

err := repo.Delete(ctx, &book, rel.Cascade(true))

Mock

repo.ExpectDelete(rel.Cascade(true)).For(&book)

Last update: 2024-08-16