lbry.go/extras/null/README.md

## null-extended [![GoDoc](https://godoc.org/github.com/nullbio/null?status.svg)](https://godoc.org/github.com/nullbio/null) [![Coverage](http://gocover.io/_badge/github.com/nullbio/null)](http://gocover.io/github.com/nullbio/null)

*Forked from https://github.com/nullbio/null*

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:

`go get -u "gopkg.in/nullbio/null.v6"`

### null package

`import "gopkg.in/nullbio/null.v6"`

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

#### null.JSON
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.

#### null.Bytes
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.

#### null.String
Nullable string.

#### null.Byte
Nullable byte.

#### null.Bool
Nullable bool.

#### null.Time
Nullable time.Time

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

#### null.Float32
Nullable float32.

#### null.Float64
Nullable float64.

#### null.Int
Nullable int.

#### null.Int8
Nullable int8.

#### null.Int16
Nullable int16.

#### null.Int32
Nullable int32.

#### null.Int64
Nullable int64.

#### null.Uint
Nullable uint.

#### null.Uint8
Nullable uint8.

#### null.Uint16
Nullable uint16.

#### null.Uint32
Nullable int32.

#### null.Int64
Nullable uint64.

### Bugs
`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](https://github.com/golang/go/issues/4357).

### License
BSD
Fix README, fix Valuer methods * Fix import paths 2016-06-08 05:53:02 +02:00			`## null-extended [![GoDoc](https://godoc.org/github.com/nullbio/null?status.svg)](https://godoc.org/github.com/nullbio/null) [![Coverage](http://gocover.io/_badge/github.com/nullbio/null)](http://gocover.io/github.com/nullbio/null)`
add gopkg.in import to README 2014-09-01 07:38:26 +02:00
remove .idea from gitignore 2018-02-23 15:22:36 +01:00			`Forked from https://github.com/nullbio/null`

Update for v6 2016-11-12 02:52:19 +01:00			`null-extended is a library with reasonable options for dealing with nullable SQL and JSON values`
change README formatting 2014-08-31 10:30:01 +02:00
Update for v6 2016-11-12 02:52:19 +01:00			Types in `null` will only be considered null on null input, and will JSON encode to `null`.
change README formatting 2014-08-31 10:30:01 +02:00
Fix README, fix Valuer methods * Fix import paths 2016-06-08 05:53:02 +02:00			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`.
refactor into 2 packages 2014-08-31 10:28:34 +02:00
Update README.md 2016-11-12 02:57:45 +01:00			`---`

			`Install:`

			`go get -u "gopkg.in/nullbio/null.v6"`

prefer JSON errors when unmarshaling, better docs Invalid JSON input will return a *json.SyntaxError instead of a cryptic error from this package. 2015-09-10 13:05:24 +02:00			`### null package`
add Floats and Bools 2014-09-01 06:46:40 +02:00
Update for v6 2016-11-12 02:40:19 +01:00			`import "gopkg.in/nullbio/null.v6"`
Update readme to include v5 changes 2016-09-07 15:00:53 +02:00
Update README.md 2016-11-12 02:57:45 +01:00			`The following are all types supported in this package. All types will marshal to JSON null if Invalid or SQL source data is null.`

Update readme to include v5 changes 2016-09-07 15:00:53 +02:00			`#### null.JSON`
			`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.

			`#### null.Bytes`
			`Nullable []byte.`

Update README.md 2016-11-12 02:57:45 +01:00			`[]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.`
add Floats and Bools 2014-09-01 06:46:40 +02:00
refactor to use package zero instead of null, and null instead of nuller 2014-09-01 20:22:17 +02:00			`#### null.String`
prefer JSON errors when unmarshaling, better docs Invalid JSON input will return a *json.SyntaxError instead of a cryptic error from this package. 2015-09-10 13:05:24 +02:00			`Nullable string.`
docs and tweaks 2014-08-29 03:29:17 +02:00
Update README.md 2016-11-12 02:57:45 +01:00			`#### null.Byte`
			`Nullable byte.`
Add all int and float null types * Add Scan and Value methods for non sql.Int64 and sql.Float64 types * Change NullInt to use int in the code opposed to int64 * Rename Float to Float64 * Add support for all missing key int and float types: float32, int8, int16, int32, int64, uint8, uint16, uint32, uint64 * Update README to include new additions/changes 2016-05-17 14:02:36 +02:00
			`#### null.Bool`
			`Nullable bool.`

			`#### null.Time`
Update README.md 2016-11-12 02:57:45 +01:00			`Nullable time.Time`
Add all int and float null types * Add Scan and Value methods for non sql.Int64 and sql.Float64 types * Change NullInt to use int in the code opposed to int64 * Rename Float to Float64 * Add support for all missing key int and float types: float32, int8, int16, int32, int64, uint8, uint16, uint32, uint64 * Update README to include new additions/changes 2016-05-17 14:02:36 +02:00
Update README.md 2016-11-12 02:57:45 +01:00			Marshals to JSON null if SQL source data is null. Uses `time.Time`'s marshaler.
Add all int and float null types * Add Scan and Value methods for non sql.Int64 and sql.Float64 types * Change NullInt to use int in the code opposed to int64 * Rename Float to Float64 * Add support for all missing key int and float types: float32, int8, int16, int32, int64, uint8, uint16, uint32, uint64 * Update README to include new additions/changes 2016-05-17 14:02:36 +02:00
			`#### null.Float32`
			`Nullable float32.`

			`#### null.Float64`
			`Nullable float64.`

refactor to use package zero instead of null, and null instead of nuller 2014-09-01 20:22:17 +02:00			`#### null.Int`
Add all int and float null types * Add Scan and Value methods for non sql.Int64 and sql.Float64 types * Change NullInt to use int in the code opposed to int64 * Rename Float to Float64 * Add support for all missing key int and float types: float32, int8, int16, int32, int64, uint8, uint16, uint32, uint64 * Update README to include new additions/changes 2016-05-17 14:02:36 +02:00			`Nullable int.`
update docs 2014-08-30 17:03:04 +02:00
Add all int and float null types * Add Scan and Value methods for non sql.Int64 and sql.Float64 types * Change NullInt to use int in the code opposed to int64 * Rename Float to Float64 * Add support for all missing key int and float types: float32, int8, int16, int32, int64, uint8, uint16, uint32, uint64 * Update README to include new additions/changes 2016-05-17 14:02:36 +02:00			`#### null.Int8`
			`Nullable int8.`
add Floats and Bools 2014-09-01 06:46:40 +02:00
Add all int and float null types * Add Scan and Value methods for non sql.Int64 and sql.Float64 types * Change NullInt to use int in the code opposed to int64 * Rename Float to Float64 * Add support for all missing key int and float types: float32, int8, int16, int32, int64, uint8, uint16, uint32, uint64 * Update README to include new additions/changes 2016-05-17 14:02:36 +02:00			`#### null.Int16`
			`Nullable int16.`
add Floats and Bools 2014-09-01 06:46:40 +02:00
Add all int and float null types * Add Scan and Value methods for non sql.Int64 and sql.Float64 types * Change NullInt to use int in the code opposed to int64 * Rename Float to Float64 * Add support for all missing key int and float types: float32, int8, int16, int32, int64, uint8, uint16, uint32, uint64 * Update README to include new additions/changes 2016-05-17 14:02:36 +02:00			`#### null.Int32`
			`Nullable int32.`
Time docs, tweaks, tests 2015-09-13 22:07:53 +02:00
Add all int and float null types * Add Scan and Value methods for non sql.Int64 and sql.Float64 types * Change NullInt to use int in the code opposed to int64 * Rename Float to Float64 * Add support for all missing key int and float types: float32, int8, int16, int32, int64, uint8, uint16, uint32, uint64 * Update README to include new additions/changes 2016-05-17 14:02:36 +02:00			`#### null.Int64`
			`Nullable int64.`

			`#### null.Uint`
			`Nullable uint.`

			`#### null.Uint8`
			`Nullable uint8.`

			`#### null.Uint16`
			`Nullable uint16.`

			`#### null.Uint32`
			`Nullable int32.`

			`#### null.Int64`
			`Nullable uint64.`

docs and tweaks 2014-08-29 03:29:17 +02:00			`### Bugs`
prefer JSON errors when unmarshaling, better docs Invalid JSON input will return a *json.SyntaxError instead of a cryptic error from this package. 2015-09-10 13:05:24 +02:00			`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](https://github.com/golang/go/issues/4357).
docs and tweaks 2014-08-29 03:29:17 +02:00
			`### License`
Fix a typo 2015-10-21 00:13:05 +02:00			`BSD`