README
¶
geo
Customized types and functions for our geo needs.
NOTE: If you want a full-fledged geo library we recommend using https://github.com/twpayne/go-geom instead.
Install
go get github.com/altipla-consulting/geo
This library has no external dependencies outside the Go standard library.
Usage
You can use the types of this package in your models structs when working with database/sql:
type MyModel struct {
ID int64 `db:"id,pk"`
Location geo.Point `db:"location"`
}
Contributing
You can make pull requests or create issues in GitHub. Any code you send should be formatted using gofmt.
Running tests
Start the test database:
docker-compose up -d database
Install test libs:
go get github.com/stretchr/testify
Run the tests:
go test
Shutdown the database when finished testing:
docker-compose stop database
License
Documentation
¶
Overview ¶
Package geo implements customized types and functions for our geo needs.
If you want a full-fledged geo library we recommend using https://github.com/twpayne/go-geom instead.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type NearCondition ¶ added in v1.2.0
type NearCondition struct {
// contains filtered or unexported fields
}
NearCondition stores the point and distance to filter around
func Near ¶ added in v1.2.0
func Near(column string, point Point, value float64) *NearCondition
Near filters by distance around a geographic point
func (*NearCondition) SQL ¶ added in v1.2.0
func (cond *NearCondition) SQL() string
SQL returns the built SQL to apply the filter.
func (*NearCondition) Values ¶ added in v1.2.0
func (cond *NearCondition) Values() []interface{}
Values returns the SQL placeholders to apply the filter
type Point ¶
Point maps against MySQL geographical point.
func (*Point) Scan ¶
Scan implements the SQL driver.Scanner interface and will scan the MySQL POINT(x y) into the Point struct.
Source Files