styque / null Goto Github PK

null-extended is a library with reasonable options for dealing with nullable SQL and JSON values

Types in null will only be considered null on null input, and will JSON encode to null.

All types implement sql.Scanner and driver.Valuer, so you can use this library in place of sql.NullXXX. All types also implement: encoding.TextMarshaler, encoding.TextUnmarshaler, json.Marshaler, json.Unmarshaler and sql.Scanner.

Install:

Null used to be versioned with gopkg.in, so once you upgrade to v8 and beyond please stop using gopkg.in and ensure you're using vgo, dep or vendoring to version null.

go get -u "github.com/volatiletech/null"

import "github.com/volatiletech/null"

The following are all types supported in this package. All types will marshal to JSON null if Invalid or SQL source data is null.

Nullable []byte.

Will marshal to JSON null if Invalid. []byte{} input will not produce an Invalid JSON, but []byte(nil) will. This should be used for storing raw JSON in the database.

Also has null.JSON.Marshal and null.JSON.Unmarshal helpers to marshal and unmarshal foreign objects.

Nullable []byte.

[]byte{} input will not produce an Invalid Bytes, but []byte(nil) will. This should be used for storing binary data (bytea in PSQL for example) in the database.

Nullable string.

Nullable byte.

Nullable bool.

Nullable time.Time

Marshals to JSON null if SQL source data is null. Uses time.Time's marshaler.

Nullable float32.

Nullable float64.

Nullable int.

Nullable int8.

Nullable int16.

Nullable int32.

Nullable int64.

Nullable uint.

Nullable uint8.

Nullable uint16.

Nullable int32.

Nullable uint64.

json's ",omitempty" struct tag does not work correctly right now. It will never omit a null or empty String. This might be fixed eventually.

BSD