Need help with mergo?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

Global Rank
#47,693
Topics of expertise
cloudwa...
kinesis
toml
remarkj...
rds
redshif...
route53
dynamod...
Location
Barcelona
1.5K Stars 189 Forks BSD 3-Clause "New" or "Revised" License 295 Commits 15 Opened issues

Description

Mergo: merging Go structs and maps since 2013.

Services available

!
?

Need anything else?

Contributors list

Mergo

GoDoc GitHub release GoCard Build Status Coverage Status Sourcegraph FOSSA Status

GoCenter Kudos

A helper to merge structs and maps in Golang. Useful for configuration default values, avoiding messy if-statements.

Mergo merges same-type structs and maps by setting default values in zero-value fields. Mergo won't merge unexported (private) fields. It will do recursively any exported one. It also won't merge structs inside maps (because they are not addressable using Go reflection).

Also a lovely comune (municipality) in the Province of Ancona in the Italian region of Marche.

Status

It is ready for production use. It is used in several projects by Docker, Google, The Linux Foundation, VMWare, Shopify, etc.

Important note

Please keep in mind that a problematic PR broke 0.3.9. I reverted it in 0.3.10, and I consider it stable but not bug-free. Also, this version adds suppot for go modules.

Keep in mind that in 0.3.2, Mergo changed

Merge()
and
Map()
signatures to support transformers. I added an optional/variadic argument so that it won't break the existing code.

If you were using Mergo before April 6th, 2015, please check your project works as intended after updating your local copy with

go get -u github.com/imdario/mergo
. I apologize for any issue caused by its previous behavior and any future bug that Mergo could cause in existing projects after the change (release 0.2.0).

Donations

If Mergo is useful to you, consider buying me a coffee, a beer, or making a monthly donation to allow me to keep building great free software. :heart_eyes:

Buy Me a Coffee at ko-fi.com Beerpay Beerpay Donate using Liberapay

Mergo in the wild

Install

go get github.com/imdario/mergo

// use in your .go code import ( "github.com/imdario/mergo" )

Usage

You can only merge same-type structs with exported fields initialized as zero value of their type and same-types maps. Mergo won't merge unexported (private) fields but will do recursively any exported one. It won't merge empty structs value as they are zero values too. Also, maps will be merged recursively except for structs inside maps (because they are not addressable using Go reflection).

if err := mergo.Merge(&dst, src); err != nil {
    // ...
}

Also, you can merge overwriting values using the transformer

WithOverride
.
if err := mergo.Merge(&dst, src, mergo.WithOverride); err != nil {
    // ...
}

Additionally, you can map a

map[string]interface{}
to a struct (and otherwise, from struct to map), following the same restrictions as in
Merge()
. Keys are capitalized to find each corresponding exported field.
if err := mergo.Map(&dst, srcMap); err != nil {
    // ...
}

Warning: if you map a struct to map, it won't do it recursively. Don't expect Mergo to map struct members of your struct as

map[string]interface{}
. They will be just assigned as values.

Here is a nice example:

package main

import ( "fmt" "github.com/imdario/mergo" )

type Foo struct { A string B int64 }

func main() { src := Foo{ A: "one", B: 2, } dest := Foo{ A: "two", } mergo.Merge(&dest, src) fmt.Println(dest) // Will print // {two 2} }

Note: if test are failing due missing package, please execute:

go get gopkg.in/yaml.v2

Transformers

Transformers allow to merge specific types differently than in the default behavior. In other words, now you can customize how some types are merged. For example,

time.Time
is a struct; it doesn't have zero value but IsZero can return true because it has fields with zero value. How can we merge a non-zero
time.Time
?
package main

import ( "fmt" "github.com/imdario/mergo" "reflect" "time" )

type timeTransformer struct { }

func (t timeTransformer) Transformer(typ reflect.Type) func(dst, src reflect.Value) error { if typ == reflect.TypeOf(time.Time{}) { return func(dst, src reflect.Value) error { if dst.CanSet() { isZero := dst.MethodByName("IsZero") result := isZero.Call([]reflect.Value{}) if result[0].Bool() { dst.Set(src) } } return nil } } return nil }

type Snapshot struct { Time time.Time // ... }

func main() { src := Snapshot{time.Now()} dest := Snapshot{} mergo.Merge(&dest, src, mergo.WithTransformers(timeTransformer{})) fmt.Println(dest) // Will print // { 2018-01-12 01:15:00 +0000 UTC m=+0.000000001 } }

Contact me

If I can help you, you have an idea or you are using Mergo in your projects, don't hesitate to drop me a line (or a pull request): @im_dario

About

Written by Dario Castañé.

Top Contributors

0 1 2 3 4 5 6 7

License

BSD 3-Clause license, as Go language.

FOSSA Status

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.