postgis

package
v0.15.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: May 25, 2022 License: MIT Imports: 27 Imported by: 4

README

PostGIS

The PostGIS provider manages querying for tile requests against a Postgres database with the PostGIS extension installed. The connection between tegola and Postgis is configured in a tegola.toml file. An example minimum connection config:

[[providers]]
name = "test_postgis"       # provider name is referenced from map layers (required)
type = "postgis"            # the type of data provider must be "postgis" for this data provider (required)

uri = "postgres://tegola:supersecret@localhost:5432/tegola?sslmode=prefer" # PostGIS connection string (required)

host = "localhost"                # PostGIS database host (deprecated)
port = 5432                       # PostGIS database port (deprecated)
database = "tegola"               # PostGIS database name (deprecated)
user = "tegola"                   # PostGIS database user (deprecated)
password = "supersecret"          # PostGIS database password (deprecated)
max_connections = 10              # PostGIS max connections (deprecated)
max_connection_idle_time = "30m"  # PostGIS max connection idle time (deprecated)
max_connection_lifetime = "1h"    # PostGIS max connection life time (deprecated)
Connection Properties

Establishing a connection via connection string (uri) will become the default connection method as of v0.16.0. Connecting via host/port/database is flagged for deprecation as of v0.15.0 but will be possible until v0.16.0 still.

  • uri (string): [Required] PostGIS connection string
  • name (string): [Required] provider name is referenced from map layers
  • type (string): [Required] the type of data provider. must be "postgis" to use this data provider
  • srid (int): [Optional] The default SRID for the provider. Defaults to WebMercator (3857) but also supports WGS84 (4326)
Connection string properties

Example

# {protocol}://{user}:{password}@{host}:{port}/{database}?{options}=
postgres://tegola:supersecret@localhost:5432/tegola?sslmode=prefer&pool_max_conns=10

Options

  • sslmode: [Optional] PostGIS SSL mode. Default: "prefer"
  • pool_max_conns: [Optional] The max connections to maintain in the connection pool. Defaults to 100. 0 means no max.
  • pool_max_conn_idle_time: [Optional] The maximum time an idle connection is kept alive. Defaults to "30m".
  • max_connection_lifetime [Optional] The maximum time a connection lives before it is terminated and recreated. Defaults to "1h".
[DEPRECATED] Connection Properties
  • uri (string): [Required] PostGIS connection string
  • name (string): [Required] provider name is referenced from map layers
  • type (string): [Required] the type of data provider. must be "postgis" to use this data provider
  • host (string): [deprecated] PostGIS database host
  • port (int): [deprecated] PostGIS database port (required)
  • database (string): [deprecated] PostGIS database name
  • user (string): [deprecated] PostGIS database user
  • password (string): [deprecated] PostGIS database password
  • srid (int): [Optional] The default SRID for the provider. Defaults to WebMercator (3857) but also supports WGS84 (4326)
  • ssl_mode: (string): [Optional]. PostGIS SSL mode. Default is "prefer".
  • max_connections (int): [deprecated] The max connections to maintain in the connection pool. Defaults to 100. 0 means no max.
  • max_connection_idle_time (duration string): [deprecated] The maximum time an idle connection is kept alive.
  • max_connection_lifetime (duration string): [deprecated] The maximum time a connection lives before it is terminated and recreated.

Provider Layers

In addition to the connection configuration above, Provider Layers need to be configured. A Provider Layer tells tegola how to query PostGIS for a certain layer. An example minimum config:

[[providers.layers]]
name = "landuse"
# this table uses "geom" for the geometry_fieldname and "gid" for the id_fieldname so they don't need to be configured
tablename = "gis.zoning_base_3857"
Provider Layers Properties
  • name (string): [Required] the name of the layer. This is used to reference this layer from map layers.
  • tablename (string): [*Required] the name of the database table to query against. Required if sql is not defined.
  • geometry_fieldname (string): [Optional] the name of the filed which contains the geometry for the feature. defaults to geom.
  • id_fieldname (string): [Optional] the name of the feature id field. defaults to gid.
  • fields ([]string): [Optional] a list of fields to include alongside the feature. Can be used if sql is not defined.
  • srid (int): [Optional] the SRID of the layer. Supports 3857 (WebMercator) or 4326 (WGS84).
  • geometry_type (string): [Optional] the layer geometry type. If not set, the table will be inspected at startup to try and infer the gemetry type. Valid values are: Point, LineString, Polygon, MultiPoint, MultiLineString, MultiPolygon, GeometryCollection.
  • sql (string): [*Required] custom SQL to use use. Required if tablename is not defined. Supports the following tokens:
    • !BBOX! - [Required] will be replaced with the bounding box of the tile before the query is sent to the database. !bbox! and!BOX! are supported as well for compatibilitiy with queries from Mapnik and MapServer styles.
    • !ZOOM! - [Optional] will be replaced with the "Z" (zoom) value of the requested tile.
    • !X! - [Optional] will be replaced with the "X" value of the requested tile.
    • !Y! - [Optional] will be replaced with the "Y" value of the requested tile.
    • !Z! - [Optional] will be replaced with the "Z" value of the requested tile.
    • !SCALE_DENOMINATOR! - [Optional] scale denominator, assuming 90.7 DPI (i.e. 0.28mm pixel size)
    • !PIXEL_WIDTH! - [Optional] the pixel width in meters, assuming 256x256 tiles
    • !PIXEL_HEIGHT! - [Optional] the pixel height in meters, assuming 256x256 tiles
    • !ID_FIELD! - [Optional] the id field name
    • !GEOM_FIELD! - [Optional] the geom field name
    • !GEOM_TYPE! - [Optional] the geom type field name

*Required: either the tablename or sql must be defined, but not both.

Example minimum custom SQL config

[[providers.layers]]
name = "rivers"
# custom SQL to be used for this layer. Note: that the geometery field is wrapped
# in ST_AsBinary() and a !BBOX! token is supplied for querying the table with the tile bounds
sql = "SELECT gid, ST_AsBinary(geom) AS geom FROM gis.rivers WHERE geom && !BBOX!"

Environment Variable support

Helpful debugging environment variables:

  • TEGOLA_SQL_DEBUG: specify the type of SQL debug information to output. Supports the following values:
    • LAYER_SQL: print layer SQL as they’re parsed from the config file.
    • EXECUTE_SQL: print SQL that is executed for each tile request and the number of items it returns or an error.
    • LAYER_SQL:EXECUTE_SQL: print LAYER_SQL and EXECUTE_SQL.

Example:

$ TEGOLA_SQL_DEBUG=LAYER_SQL tegola serve --config=/path/to/conf.toml

Testing

Testing is designed to work against a live PostGIS database. To see how to set up a database check this github actions script. To run the PostGIS tests, the following environment variables need to be set:

$ export RUN_POSTGIS_TESTS=yes
$ export PGHOST="localhost"
$ export PGPORT=5432
$ export PGDATABASE="tegola"
$ export PGUSER="postgres"
$ export PGUSER_NO_ACCESS="tegola_no_access" # used for testing errors when user does not have read permissions on a table
$ export PGPASSWORD=""
$ export PGSSLMODE="disable"

If you're testing SSL, the following additional env vars can be set:

$ export PGSSLMODE="" // disable, allow, prefer, require, verify-ca, verify-full
$ export PGSSLKEY=""
$ export PGSSLCERT=""
$ export PGSSLROOTCERT=""

Documentation

Index

Constants

View Source 
const (
	EnvSQLDebugName    = "TEGOLA_SQL_DEBUG"
	EnvSQLDebugLayer   = "LAYER_SQL"
	EnvSQLDebugExecute = "EXECUTE_SQL"
)
View Source 
const (
	DefaultURI             = ""
	DefaultPort            = 5432
	DefaultSRID            = tegola.WebMercator
	DefaultMaxConn         = 100
	DefaultMaxConnIdleTime = "30m"
	DefaultMaxConnLifetime = "1h"
	DefaultSSLMode         = "prefer"
	DefaultSSLKey          = ""
	DefaultSSLCert         = ""
)
View Source 
const (
	ConfigKeyURI             = "uri"
	ConfigKeyHost            = "host"
	ConfigKeyPort            = "port"
	ConfigKeyDB              = "database"
	ConfigKeyUser            = "user"
	ConfigKeyPassword        = "password"
	ConfigKeySSLMode         = "ssl_mode"
	ConfigKeySSLKey          = "ssl_key"
	ConfigKeySSLCert         = "ssl_cert"
	ConfigKeySSLRootCert     = "ssl_root_cert"
	ConfigKeyMaxConn         = "max_connections"
	ConfigKeyMaxConnIdleTime = "max_connection_idle_time"
	ConfigKeyMaxConnLifetime = "max_connection_lifetime"
	ConfigKeySRID            = "srid"
	ConfigKeyLayers          = "layers"
	ConfigKeyLayerName       = "name"
	ConfigKeyTablename       = "tablename"
	ConfigKeySQL             = "sql"
	ConfigKeyFields          = "fields"
	ConfigKeyGeomField       = "geometry_fieldname"
	ConfigKeyGeomIDField     = "id_fieldname"
	ConfigKeyGeomType        = "geometry_type"
)
View Source 
const (
	MVTProviderType = "mvt_postgis"
	ProviderType    = "postgis"
)
View Source 
const Name = "postgis"

Variables

View Source 
var (
	ErrNilLayer = errors.New("layer is nil")
)

Functions

func BuildDBConfig added in v0.15.0 

func BuildDBConfig(uri string) (*pgxpool.Config, error)

BuildDBConfig build db config with defaults

func BuildURI added in v0.15.0 

func BuildURI(config dict.Dicter) (*url.URL, *url.Values, error)

TODO: (iwpnd) to be removed/refactored in v0.17.0 BuildURI creates a database URI from config

func Cleanup added in v0.8.0 

func Cleanup()

Cleanup will close all database connections and destroy all previously instantiated Provider instances

func ConfigTLS added in v0.7.0 

func ConfigTLS(sslMode string, sslKey string, sslCert string, sslRootCert string, cc *pgxpool.Config) error

derived from github.com/jackc/pgx configTLS (https://github.com/jackc/pgx/blob/master/conn.go)

func NewMVTTileProvider added in v0.12.0 

func NewMVTTileProvider(config dict.Dicter) (provider.MVTTiler, error)

func NewTileProvider added in v0.6.0 

func NewTileProvider(config dict.Dicter) (provider.Tiler, error)

NewTileProvider instantiates and returns a new postgis provider or an error. The function will validate that the config object looks good before trying to create a driver. This Provider supports the following fields in the provided map[string]interface{} map: 

host (string): [Required] postgis database host
port (int): [Required] postgis database port (required)
database (string): [Required] postgis database name
user (string): [Required] postgis database user
password (string): [Required] postgis database password
srid (int): [Optional] The default SRID for the provider. Defaults to WebMercator (3857) but also supports WGS84 (4326)
max_connections : [Optional] The max connections to maintain in the connection pool. Default is 100. 0 means no max.
layers (map[string]struct{})  — This is map of layers keyed by the layer name. supports the following properties

	name (string): [Required] the name of the layer. This is used to reference this layer from map layers.
	tablename (string): [*Required] the name of the database table to query against. Required if sql is not defined.
	geometry_fieldname (string): [Optional] the name of the filed which contains the geometry for the feature. defaults to geom
	id_fieldname (string): [Optional] the name of the feature id field. defaults to gid
	fields ([]string): [Optional] a list of fields to include alongside the feature. Can be used if sql is not defined.
	srid (int): [Optional] the SRID of the layer. Supports 3857 (WebMercator) or 4326 (WGS84).
	sql (string): [*Required] custom SQL to use use. Required if tablename is not defined. Supports the following tokens:

		!BBOX! - [Required] will be replaced with the bounding box of the tile before the query is sent to the database.
		!ZOOM! - [Optional] will be replaced with the "Z" (zoom) value of the requested tile.

Types

type ErrGeomFieldNotFound added in v0.9.0 

type ErrGeomFieldNotFound struct {
	GeomFieldName string
	LayerName     string
}

func (ErrGeomFieldNotFound) Error added in v0.9.0 

func (e ErrGeomFieldNotFound) Error() string

type ErrInvalidSSLMode added in v0.7.0 

type ErrInvalidSSLMode string

func (ErrInvalidSSLMode) Error added in v0.7.0 

func (e ErrInvalidSSLMode) Error() string

type ErrInvalidURI added in v0.15.0 

type ErrInvalidURI struct {
	Err error
	Msg string
}

func (ErrInvalidURI) Error added in v0.15.0 

func (e ErrInvalidURI) Error() string

func (ErrInvalidURI) Unwrap added in v0.15.0 

func (e ErrInvalidURI) Unwrap() error

type ErrLayerNotFound added in v0.6.0 

type ErrLayerNotFound struct {
	LayerName string
}

func (ErrLayerNotFound) Error added in v0.6.0 

func (e ErrLayerNotFound) Error() string

type ErrUnclosedToken added in v0.8.0 

type ErrUnclosedToken string

func (ErrUnclosedToken) Error added in v0.8.0 

func (e ErrUnclosedToken) Error() string

type Layer added in v0.4.0 

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

layer holds information about a query.

func (Layer) GeomFieldName added in v0.4.0 

func (l Layer) GeomFieldName() string

func (Layer) GeomType added in v0.4.0 

func (l Layer) GeomType() geom.Geometry

func (Layer) IDFieldName added in v0.4.0 

func (l Layer) IDFieldName() string

func (Layer) Name added in v0.4.0 

func (l Layer) Name() string

func (Layer) SRID added in v0.4.0 

func (l Layer) SRID() uint64

type Provider 

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

Provider provides the postgis data provider.

func CreateProvider added in v0.12.0 

func CreateProvider(config dict.Dicter, providerType string) (*Provider, error)

CreateProvider instantiates and returns a new postgis provider or an error. The function will validate that the config object looks good before trying to create a driver. This Provider supports the following fields in the provided map[string]interface{} map: 

host (string): [Required] postgis database host
port (int): [Required] postgis database port (required)
database (string): [Required] postgis database name
user (string): [Required] postgis database user
password (string): [Required] postgis database password
srid (int): [Optional] The default SRID for the provider. Defaults to WebMercator (3857) but also supports WGS84 (4326)
max_connections : [Optional] The max connections to maintain in the connection pool. Default is 100. 0 means no max.
layers (map[string]struct{})  — This is map of layers keyed by the layer name. supports the following properties

	name (string): [Required] the name of the layer. This is used to reference this layer from map layers.
	tablename (string): [*Required] the name of the database table to query against. Required if sql is not defined.
	geometry_fieldname (string): [Optional] the name of the filed which contains the geometry for the feature. defaults to geom
	id_fieldname (string): [Optional] the name of the feature id field. defaults to gid
	fields ([]string): [Optional] a list of fields to include alongside the feature. Can be used if sql is not defined.
	srid (int): [Optional] the SRID of the layer. Supports 3857 (WebMercator) or 4326 (WGS84).
	sql (string): [*Required] custom SQL to use use. Required if tablename is not defined. Supports the following tokens:

		!BBOX! - [Required] will be replaced with the bounding box of the tile before the query is sent to the database.
		!ZOOM! - [Optional] will be replaced with the "Z" (zoom) value of the requested tile.

func (*Provider) Close added in v0.8.0 

func (p *Provider) Close()

Close will close the Provider's database connectio

func (*Provider) Collectors added in v0.14.0 

func (p *Provider) Collectors(prefix string, cfgFn func(configKey string) map[string]interface{}) ([]observability.Collector, error)

func (*Provider) Layer added in v0.4.0 

func (p *Provider) Layer(name string) (Layer, bool)

Layer fetches an individual layer from the provider, if it's configured if no name is provider, the first layer is returned

func (Provider) Layers added in v0.4.0 

func (p Provider) Layers() ([]provider.LayerInfo, error)

Layers returns meta data about the various layers which are configured with the provider

func (Provider) MVTForLayers added in v0.12.0 

func (p Provider) MVTForLayers(ctx context.Context, tile provider.Tile, layers []provider.Layer) ([]byte, error)

func (Provider) TileFeatures added in v0.6.0 

func (p Provider) TileFeatures(ctx context.Context, layer string, tile provider.Tile, fn func(f *provider.Feature) error) error

TileFeatures adheres to the provider.Tiler interface

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.