forked from guregu/null
-
Notifications
You must be signed in to change notification settings - Fork 34
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #4 from minond/readme-updates
Readme layout updates
- Loading branch information
Showing
1 changed file
with
47 additions
and
77 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,91 +1,61 @@ | ||
| ## null-extended [](https://godoc.org/github.com/volatiletech/null) [](http://gocover.io/github.com/volatiletech/null) | ||
| ## null [](https://godoc.org/github.com/volatiletech/null) [](http://gocover.io/github.com/volatiletech/null) | ||
|
|
||
| null-extended is a library with reasonable options for dealing with nullable SQL and JSON values | ||
| `null` 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`. | ||
| 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`. | ||
| 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: | ||
| ### Installation | ||
|
|
||
| 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. | ||
| please stop using gopkg.in and ensure you're using `vgo`, `dep` or vendoring to | ||
| version null. | ||
|
|
||
| ``` | ||
| go get -u "github.com/volatiletech/null" | ||
| ``` | ||
|
|
||
| ### Usage | ||
|
|
||
| The following are all types supported in this package. All types will marshal | ||
| to JSON null if Invalid or SQL source data is null. | ||
|
|
||
| | Type | Description | Notes | | ||
| |------|-------------|-------| | ||
| | `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 (bytes 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` | | | | ||
|
|
||
| `go get -u "github.com/volatiletech/null"` | ||
|
|
||
| ### null package | ||
|
|
||
| `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. | ||
|
|
||
| #### 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. | ||
| ### Bugs | ||
|
|
||
| #### null.Int64 | ||
| 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](https://github.com/golang/go/issues/4357). | ||
|
|
||
| ### 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 |