Nullable

The nullable package provides an Active Support inspired syntax on top of the nullable data types provided by Go's standard database/sql package. Because nullable wraps the standard package, it is a simple drop-in replacement. The goal is to help improve the readability of database interfacing application code. The interface should feel natural to those who are familiar with Rails.

Here is the full documentation.

Quick Examples

Usage within struct definition.

type IceCream struct {
    // Using the nullable package.
    Flavor nullable.String `db:"flavor"`

    // Using the database/sql package.
    Topping sql.NullString `db:"topping"`
}

Here is an example using the String type.

// Constructing the value is identical to the standard type.
nullable.String{Value: "hello", Valid: true}

// An equivalent convenience function is provided.
nullable.NewString("hello")

// Check if the underlying string is NULL. There is also a Nil() function
// alias for those that prefer a more Go-like syntax.
if value.Null() || value.Nil() {
    log.Println("i am stored as NULL in the database")
}

// Check if the underlying value is a non-empty string.
if value.Present() {
    log.Println("i am a non-empty value")
}

// Check if the underlying value is either NULL or an empty string.
if value.Empty() {
    log.Println("i am an empty string")
}

Utility Functions

Nullable also provides useful utility functions. The plan is to add more subtle functions over time.

// Get the hexadecimal string representation of the underlying value.
value.HexString()

Continuous Integration

Contributing

Contributions of any kind are welcome! If you are going to submit a PR, please follow Go's commit message structure.

Motivation