Navigation :

PostGIS 3.1.7 Manual

The PostGIS Development Group

Abstract

PostGIS is an extension to the PostgreSQL object-relational database system which allows GIS (Geographic Information Systems) objects to be stored in the database. PostGIS includes support for GiST-based R-Tree spatial indexes, and functions for analysis and processing of GIS objects.

This is the manual for version 3.1.7

This work is licensed under a Creative Commons Attribution-Share Alike 3.0 License . Feel free to use this material any way you like, but we ask that you attribute credit to the PostGIS Project and wherever possible, a link back to http://postgis.net .

Table of Contents

1. Introduction

1.1. Project Steering Committee
1.2. Core Contributors Present
1.3. Core Contributors Past
1.4. Other Contributors

2. PostGIS Installation

2.1. Short Version

2.2. Compiling and Install from Source

2.2.1. Getting the Source
2.2.2. Install Requirements
2.2.3. Build configuration
2.2.4. Building
2.2.5. Building PostGIS Extensions and Deploying them
2.2.6. Testing
2.2.7. Installation

2.3. Installing and Using the address standardizer

2.3.1. Installing Regex::Assemble

2.4. Installing, Upgrading Tiger Geocoder and loading data

2.4.1. Tiger Geocoder Enabling your PostGIS database: Using Extension
2.4.2. Tiger Geocoder Enabling your PostGIS database: Not Using Extensions
2.4.3. Using Address Standardizer Extension with Tiger geocoder
2.4.4. Loading Tiger Data
2.4.5. Upgrading your Tiger Geocoder Install

2.5. Common Problems during installation

3. PostGIS Administration

3.1. Performance Tuning

3.1.1. Startup
3.1.2. Runtime

3.2. Configuring raster support

3.3. Creating spatial databases

3.3.1. Spatially enable database using EXTENSION
3.3.2. Spatially enable database without using EXTENSION (discouraged)
3.3.3. Create a spatially-enabled database from a template

3.4. Upgrading spatial databases

3.4.1. Soft upgrade
3.4.2. Hard upgrade

4. PostGIS Usage

4.1. Data Management

4.1.1. GIS Objects
4.1.2. PostGIS Geography Type
4.1.3. Spatial Metadata Tables
4.1.4. Geometry Validation
4.1.5. Loading Spatial Data
4.1.6. Extracting Spatial Data
4.1.7. Building Spatial Indexes

4.2. Spatial Queries

4.2.1. Determining Spatial Relationships
4.2.2. Taking Advantage of Indexes
4.2.3. Examples of Spatial SQL

4.3. Performance Tips

4.3.1. Small tables of large geometries
4.3.2. CLUSTERing on geometry indices
4.3.3. Avoiding dimension conversion

4.4. Building Applications

4.4.1. Using MapServer
4.4.2. Java Clients (JDBC)
4.4.3. C Clients (libpq)

4.5. Raster Data Management, Queries, and Applications

4.5.1. Loading and Creating Rasters
4.5.2. Raster Catalogs
4.5.3. Building Custom Applications with PostGIS Raster

4.6. Topology

4.6.1. Topology Types
4.6.2. Topology Domains
4.6.3. Topology and TopoGeometry Management
4.6.4. Topology Statistics Management
4.6.5. Topology Constructors
4.6.6. Topology Editors
4.6.7. Topology Accessors
4.6.8. Topology Processing
4.6.9. TopoGeometry Constructors
4.6.10. TopoGeometry Editors
4.6.11. TopoGeometry Accessors
4.6.12. TopoGeometry Outputs
4.6.13. Topology Spatial Relationships

4.7. Address Standardizer

4.7.1. How the Parser Works
4.7.2. Address Standardizer Types
4.7.3. Address Standardizer Tables
4.7.4. Address Standardizer Functions

4.8. PostGIS Extras

4.8.1. Tiger Geocoder

5. PostGIS Reference

5.1. PostGIS Geometry/Geography/Box Data Types

5.2. Table Management Functions

5.3. Geometry Constructors

5.4. Geometry Accessors

5.5. Geometry Editors

5.6. Geometry Validation

5.7. Spatial Reference System Functions

5.8. Geometry Input

5.8.1. Well-Known Text (WKT)
5.8.2. Well-Known Binary (WKB)
5.8.3. Other Formats

5.9. Geometry Output

5.9.1. Well-Known Text (WKT)
5.9.2. Well-Known Binary (WKB)
5.9.3. Other Formats

5.10. Operators

5.10.1. Bounding Box Operators
5.10.2. Distance Operators

5.11. Spatial Relationships

5.11.1. Topological Relationships
5.11.2. Distance Relationships

5.12. Measurement Functions

5.13. Overlay Functions

5.14. Geometry Processing

5.15. Affine Transformations

5.16. Clustering Functions

5.17. Bounding Box Functions

5.18. Linear Referencing

5.19. Trajectory Functions

5.20. SFCGAL Functions

5.21. Long Transaction Support

5.22. Version Functions

5.23. Grand Unified Custom Variables (GUCs)

5.24. Troubleshooting Functions

6. Raster Reference

6.1. Raster Support Data types

6.2. Raster Management

6.3. Raster Constructors

6.4. Raster Accessors

6.5. Raster Band Accessors

6.6. Raster Pixel Accessors and Setters

6.7. Raster Editors

6.8. Raster Band Editors

6.9. Raster Band Statistics and Analytics

6.10. Raster Inputs

6.11. Raster Outputs

6.12. Raster Processing: Map Algebra

6.13. Built-in Map Algebra Callback Functions

6.14. Raster Processing: DEM (Elevation)

6.15. Raster Processing: Raster to Geometry

6.16. Raster Operators

6.17. Raster and Raster Band Spatial Relationships

6.18. Raster Tips

6.18.1. Out-DB Rasters

7. PostGIS Frequently Asked Questions

8. PostGIS Raster Frequently Asked Questions

9. PostGIS Special Functions Index

9.1. PostGIS Aggregate Functions

9.2. PostGIS Window Functions

9.3. PostGIS SQL-MM Compliant Functions

9.4. PostGIS Geography Support Functions

9.5. PostGIS Raster Support Functions

9.6. PostGIS Geometry / Geography / Raster Dump Functions

9.7. PostGIS Box Functions

9.8. PostGIS Functions that support 3D

9.9. PostGIS Curved Geometry Support Functions

9.10. PostGIS Polyhedral Surface Support Functions

9.11. PostGIS Function Support Matrix

9.12. New, Enhanced or changed PostGIS Functions

9.12.1. PostGIS Functions new or enhanced in 3.1
9.12.2. PostGIS Functions new or enhanced in 3.0
9.12.3. PostGIS Functions new or enhanced in 2.5
9.12.4. PostGIS Functions new or enhanced in 2.4
9.12.5. PostGIS Functions new or enhanced in 2.3
9.12.6. PostGIS Functions new or enhanced in 2.2
9.12.7. PostGIS functions breaking changes in 2.2
9.12.8. PostGIS Functions new or enhanced in 2.1
9.12.9. PostGIS functions breaking changes in 2.1
9.12.10. PostGIS Functions new, behavior changed, or enhanced in 2.0
9.12.11. PostGIS Functions changed behavior in 2.0
9.12.12. PostGIS Functions new, behavior changed, or enhanced in 1.5
9.12.13. PostGIS Functions new, behavior changed, or enhanced in 1.4
9.12.14. PostGIS Functions new in 1.3

10. Reporting Problems

10.1. Reporting Software Bugs
10.2. Reporting Documentation Issues

A. Appendix