README
¶
flat (BSON variant)
forked from nqd/flat
Take a mongo bson.M and flatten it or unflatten a map with delimited key.
Forked from This work inspired by the nodejs flat package
Method
Flatten
Flatten given map, returns a map one level deep.
in := bson.M{
"a": "b",
"c": bson.M{
"d": "e",
"f": "g",
},
"z": bson.A{2, 1.4567},
}
out, err := flat.Flatten(in, nil)
// out = bson.M{
// "a": "b",
// "c.d": "e",
// "c.f": "g",
// "z.0": 2,
// "z.1": 1.4567,
// }
Unflatten
Since there is flatten, flat should have unflatten.
in := bson.M{
"foo.bar": bson.M{"t": 123},
"foo": bson.M{"k": 456},
}
out, err := flat.Unflatten(in, nil)
// out = bson.M{
// "foo": bson.M{
// "bar": bson.M{
// "t": 123,
// },
// "k": 456,
// },
// }
Options
Delimiter
Use a custom delimiter for flattening/unflattening your objects. Default value is ..
in := bson.M{
"hello": bson.M{
"world": bson.M{
"again": "good morning",
}
},
}
out, err := flat.Flatten(in, &flat.Options{
Delimiter: ":",
})
// out = bson.M{
// "hello:world:again": "good morning",
// }
Safe
When Safe is true, fatten will preserve arrays and their contents. Default Safe value is false.
in := bson.M{
"hello": bson.M{
"world": bson.A{
"one",
"two",
}
},
}
out, err := flat.Flatten(in, &flat.Options{
Delimiter: ".",
Safe: true,
})
// out = bson.M{
// "hello.world": bson.A{"one", "two"},
// }
MaxDepth
MaxDepth is the maximum number of nested objects to flatten. MaxDepth can be any integer number. MaxDepth = 0 means no limit.
Default MaxDepth value is 0.
in := bson.M{
"hello": bson.M{
"world": bson.M{
"again": "good morning",
}
},
}
out, err := flat.Flatten(in, &flat.Options{
Delimiter: ".",
MaxDepth: 2,
})
// out = bson.M{
// "hello.world": bson.M{"again": "good morning"},
// }
Todos
- Safe option for Unflatten
- Overwrite
Documentation
¶
Overview ¶
Package flat flattens a nested Golang map into a one level deep map. Flat also supports unflatten, turn a one level map into nested one.
You can flatten a Go map
in = map[string]interface{}{
"foo": map[string]interface{}{
"bar": map[string]interface{}{
"t": 123,
},
"k": 456,
},
}
out, err := flat.Flatten(in, nil)
// out = map[string]interface{}{
// "foo.bar.t": 123,
// "foo.k": 456,
// }
and a reverse with unflatten
in = map[string]interface{}{
"foo.bar.t": 123,
"foo.k": 456,
}
out, err := flat.Unflatten(in, nil)
// out = map[string]interface{}{
// "foo": map[string]interface{}{
// "bar": map[string]interface{}{
// "t": 123,
// },
// "k": 456,
// },
// }
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Source Files