geodb

Documentation

Index

• type GeoDB
  • func NewGeoDB(licenseKey, downloadPath, downloadURL string) (*GeoDB, error)
  • func (db *GeoDB) GetLocation(ip string) (string, string, string)
  • func (db *GeoDB) Update() error
  • func (db *GeoDB) UpdateFromFile(path string) error

Types

type GeoDB

type GeoDB struct {
	// contains filtered or unexported fields
}

GeoDB maps IPs to their geological location based on MaxMinds GeoLite2 or GeoIP2 database.

func NewGeoDB

func NewGeoDB(licenseKey, downloadPath, downloadURL string) (*GeoDB, error)

NewGeoDB creates a new GeoDB for given license key. The download URL is optional and will be set to the default if empty. It must contain "LICENSE_KEY" for the license key.

func (*GeoDB) GetLocation

func (db *GeoDB) GetLocation(ip string) (string, string, string)

GetLocation looks up the country code, subdivision (region), and city for given IP. If the IP is invalid it will return an empty string. The country code is returned in lowercase.

func (*GeoDB) Update

func (db *GeoDB) Update() error

Update downloads and unpacks the MaxMind GeoLite2 database.

func (*GeoDB) UpdateFromFile

func (db *GeoDB) UpdateFromFile(path string) error

UpdateFromFile updates GeoDB from given file instead of downloading the database.