georm

README

GEOrm

Библиотека была создана для адаптации типов геометрии в GORM

georm изначально создан для работы с PostGIS (PostgreSQL) и может не подойти для работы с другими СУБД.

Основой для географических / геометрических типов является библиотека go-geom

Для обмена геоданными используется ewkb формат, серилизация и десерилизация происходит при помощи библиотеки go-geom/encoding

Features

• Работающая авто-миграция для таблиц с геометрическими типами.
• Возможность создания и получения записей без написания sql, используя только gorm методы.
• Использование бинарного формата в SQL запросах, увеличивает производительность и уменьшает объем трафика
• Метод String, возвращает данные о геометрии в человеко читаемом wkt формате

Geometry types

• Point
• LineString
• Polygon
• MultiPoint
• MultiLineString
• MultiPolygon
• GeometryCollection

License

Released under the MIT Licence

Relation: go-geom under the BSD-2-Clause

Documentation

Index

• Variables
• type Geometry
  • func New[T geom.T](geom T) Geometry[T]
  • func (g Geometry[T]) GormDataType() string
  • func (g *Geometry[T]) Scan(value interface{}) (err error)
  • func (g Geometry[T]) String() string
  • func (g Geometry[T]) Value() (driver.Value, error)
• type GeometryCollection
• type LineString
• type MultiLineString
• type MultiPoint
• type MultiPolygon
• type Point
• type Polygon

Examples

• Geometry.String

Variables

var (
	ErrUnexpectedGeometryType = errors.New("unexpected geometry type")
	ErrUnexpectedValueType    = errors.New("unexpected value type")
)

var SRID = 4326

Types

type Geometry

type Geometry[T geom.T] struct{ Geom T }

func New

func New[T geom.T](geom T) Geometry[T]

func (Geometry[T]) GormDataType

func (g Geometry[T]) GormDataType() string

GormDataType impl schema.GormDataTypeInterface

func (*Geometry[T]) Scan

func (g *Geometry[T]) Scan(value interface{}) (err error)

Scan impl sql.Scanner

func (Geometry[T]) String

func (g Geometry[T]) String() string

String returns geometry formatted using WKT format

Example

point := Geometry[geom.T]{
	Geom: geom.NewPoint(geom.XY).MustSetCoords(geom.Coord{42, 42}),
}

polygon := Geometry[geom.T]{
	Geom: geom.NewPolygon(geom.XY).MustSetCoords(
		[][]geom.Coord{{{42, 42}, {1, 1}, {2, 2}, {42, 42}}}),
}

fmt.Println(point.String())
fmt.Println(polygon.String())

Output:

POINT (42 42)
POLYGON ((42 42, 1 1, 2 2, 42 42))

func (Geometry[T]) Value

func (g Geometry[T]) Value() (driver.Value, error)

Value impl driver.Valuer

type GeometryCollection

type GeometryCollection = Geometry[*geom.GeometryCollection]

type LineString

type LineString = Geometry[*geom.LineString]

type MultiLineString

type MultiLineString = Geometry[*geom.MultiLineString]

type MultiPoint

type MultiPoint = Geometry[*geom.MultiPoint]

type MultiPolygon

type MultiPolygon = Geometry[*geom.MultiPolygon]

type Point

type Point = Geometry[*geom.Point]

type Polygon

type Polygon = Geometry[*geom.Polygon]