support custom logical types #429
Conversation
|
+1 |
|
Can you explain the issue you are trying to solve? Logical types are specified in the spec. |
|
@nrwiersma the spec details a set of "official" logical types that most implementations support, it is however allowed to define your own custom LogicalType's that are marshallable by their base type, this has been applied in e.g. Java [1] and Python [2]. But this PR also allows you to register your own type for a particular "official" LogicalType, e.g. the UUID type. The UUID type is backed by a string but a string can be anything. By registering a UUID compliant Go type, you get added type safety when going back and forth between Avro. I've included this as an example in the tests |
|
fixed linting errors |
gen/gen.go
Outdated
| func WithLogicalType(logicalType LogicalType) OptsFunc { | ||
| return func(g *Generator) { | ||
| if g.logicalTypes == nil { | ||
| g.logicalTypes = make(map[avro.LogicalType]LogicalType) |
There was a problem hiding this comment.
Slightly more conventional.
| g.logicalTypes = make(map[avro.LogicalType]LogicalType) | |
| g.logicalTypes = map[avro.LogicalType]LogicalType{} |
gen/gen_test.go
Outdated
| tests := map[string]struct { | ||
| config gen.Config | ||
| fileName string | ||
| }{ | ||
| "without custom logical types": { | ||
| config: gen.Config{PackageName: "Something"}, | ||
| fileName: "testdata/golden.go", | ||
| }, | ||
| "with logical types": { | ||
| config: gen.Config{PackageName: "Something", LogicalTypes: []gen.LogicalType{{ | ||
| Name: "uuid", | ||
| Typ: "uuid.UUID", | ||
| ThirdPartyImport: "github.com/google/uuid", | ||
| }}}, | ||
| fileName: "testdata/golden_logicaltype.go", | ||
| }, | ||
| } |
There was a problem hiding this comment.
I would prefer this split into 2 tests. There are other golden tests, each in their own tests, so this does not really match.
There was a problem hiding this comment.
separated tests into their own
|
resaonable suggestions, applied the fixes. |
proposal to support custom logical types (implementing TextMarshaller) when generating structs