https://github.com/go-rel/changeset

Changeset for Golang
https://github.com/go-rel/changeset

database go golang hacktoberfest orm

Last synced: 8 days ago
JSON representation

Changeset for Golang

• Host: GitHub
• URL: https://github.com/go-rel/changeset
• Owner: go-rel
• License: mit
• Created: 2020-06-12T18:12:03.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-10-07T00:08:27.000Z (about 1 month ago)
• Last Synced: 2024-10-29T16:20:40.997Z (16 days ago)
• Topics: database, go, golang, hacktoberfest, orm
• Language: Go
• Homepage:
• Size: 165 KB
• Stars: 11
• Watchers: 3
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: change.go
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# changeset

[![GoDoc](https://godoc.org/github.com/go-rel/changeset?status.svg)](https://godoc.org/github.com/go-rel/changeset) 

[![Build Status](https://travis-ci.org/go-rel/changeset.svg?branch=master)](https://travis-ci.org/go-rel/changeset) 

[![Go Report Card](https://goreportcard.com/badge/github.com/go-rel/changeset)](https://goreportcard.com/report/github.com/go-rel/changeset)

[![codecov](https://codecov.io/gh/go-rel/changeset/branch/master/graph/badge.svg?token=LCJN4KR9N8)](https://codecov.io/gh/go-rel/changeset)

[![Gitter chat](https://badges.gitter.im/go-rel/rel.png)](https://gitter.im/go-rel/rel)

Changeset mutator for [REL](https://github.com/go-rel/rel). Changesets allow filtering, casting, validation and definition of constraints when manipulating structs.

## Install

```bash

go get github.com/go-rel/changeset

```

## Example

```golang

package main

import (

	"time"

	"github.com/go-rel/rel"

	"github.com/go-rel/rel/adapter/mysql"

	"github.com/go-rel/changeset"

	"github.com/go-rel/changeset/params"

)

type Product struct {

	ID        int

	Name      string

	Price     int

	CreatedAt time.Time

	UpdatedAt time.Time

}

// ChangeProduct prepares data before database operation.

// Such as casting value to appropriate types and perform validations.

func ChangeProduct(product interface{}, params params.Params) *changeset.Changeset {

	ch := changeset.Cast(product, params, []string{"name", "price"})

	changeset.ValidateRequired(ch, []string{"name", "price"})

	changeset.ValidateMin(ch, "price", 100)

	return ch

}

func main() {

    // initialize mysql adapter.

    adapter, _ := mysql.Open(dsn)

    defer adapter.Close()

    // initialize rel's repo.

    repo := rel.New(adapter)

	var product Product

	// Inserting Products.

	// Changeset is used when creating or updating your data.

	ch := ChangeProduct(product, params.Map{

		"name":  "shampoo",

		"price": 1000,

	})

	if ch.Error() != nil {

		// handle error

	}

	// Changeset can also be created directly from json string.

	jsonch := ChangeProduct(product, params.ParseJSON(`{

		"name":  "soap",

		"price": 2000,

	}`))

	// Create products with changeset and return the result to &product,

	if err := repo.Insert(context.TODO(), &product, ch); err != nil {

		// handle error

	}

}

```

## License

Released under the [MIT License](https://github.com/go-rel/changeset/blob/master/LICENSE)