sij/mapnik
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

reformat PostGIS and PgRaster plugin parameter tables 

- move default values into the first column with parameter name
- move remaining default value notes into the description column
- remove the fourth column, making more room for the description
Mickey Rose 2019-08-12 16:13:05 +02:00
parent 28efa3ead7
commit 9a60fb21b6
2 changed files with 49 additions and 49 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

50
PgRaster.md

@ -16,31 +16,31 @@ To check if the gdal plugin built and was installed correctly you can do:
## Parameters
| *parameter* | *value* | *description* | *default* |
|:------------------|----------|---------------|----------:|
| host | string | name of the postgres host | |
| port | integer | name of the postgres port | |
| dbname | string | name of the database | |
| user | string | username to use for connecting | |
| password | string | user password to use for connecting | |
| table | string | name of the table to fetch, this can be a sub-query; subquery has to use syntax of: '( ) as subquery'. | |
| raster_field | string | name of the raster field, in case you have more than one in a single table. | Deduced from metadata tables if possible |
| raster_table | string | name of the table containing the returned raster; for determining SRIDs with subselects | |
| srid | integer | srid of the table, if this is > 0 then fetching data will avoid an extra database query for knowing the srid of the table | 0 |
| extent | string | maxextent of the rasters | determined by querying the metadata for the table |
| extent_from_subquery | boolean | evaluate the extent of the subquery, this might be a performance issue | false |
| estimate_extent | boolean | estimate extent from statistics table if not specified | false |
| connect_timeout | integer | timeout is seconds for the connection to take place | 4 |
| persist_connection | boolean | choose whether to share the same connection for subsequent queries | true |
| row_limit | integer | max number of rows to return when querying data, 0 means no limit | 0 |
| cursor_size | integer | if this is > 0 then server cursor will be used, and will prefetch this number of features | 0 |
| initial_size | integer | initial size of the stateless connection pool | 1 |
| max_size | integer | max size of the stateless connection pool | 10 |
| prescale_rasters | boolean | whether to automatically scale input rasters | false |
| use_overviews | boolean | whether to use raster overviews when available | false |
| clip_rasters | boolean | whether to automatically clip input rasters | false |
| max_async_connection | integer | max number of PostGIS queries for rendering one map in asynchronous mode. Full doc [here](Postgis-async). | 1 |
| band | integer | request for a specific raster band index (1-based). 0 means to read all bands. Note that a band read from a single band raster gets interpreted as Grayscale if band=0 is specified while they retain their original value when explicitly referenced with the "band" parameter. This affects effectiveness of [[RasterColorizer]] | 0 |
| *name = default value* | *type* | *description* |
|:-----------------------------|:--------|:--------------|
| host | string | name of the postgres host |
| port | integer | name of the postgres port |
| dbname | string | name of the database |
| user | string | username to use for connecting |
| password | string | user password to use for connecting |
| table | string | name of the table to fetch, this can be a sub-query; subquery has to use syntax of: '( ) as subquery'. |
| raster_field | string | name of the raster field, in case you have more than one in a single table. Deduced from metadata tables if possible |
| raster_table | string | name of the table containing the returned raster; for determining SRIDs with subselects |
| srid = 0 | integer | srid of the table, if this is > 0 then fetching data will avoid an extra database query for knowing the srid of the table |
| extent | string | maxextent of the rasters; if omitted, the extent will be determined by querying the metadata for the table |
| extent_from_subquery = false | boolean | evaluate the extent of the subquery, this might be a performance issue |
| estimate_extent = false | boolean | estimate extent from statistics table if not specified |
| connect_timeout = 4 | integer | timeout is seconds for the connection to take place |
| persist_connection = true | boolean | choose whether to share the same connection for subsequent queries |
| row_limit = 0 | integer | max number of rows to return when querying data, 0 means no limit |
| cursor_size = 0 | integer | if this is > 0 then server cursor will be used, and will prefetch this number of features |
| initial_size = 1 | integer | initial size of the stateless connection pool |
| max_size = 10 | integer | max size of the stateless connection pool |
| prescale_rasters = false | boolean | whether to automatically scale input rasters |
| use_overviews = false | boolean | whether to use raster overviews when available |
| clip_rasters = false | boolean | whether to automatically clip input rasters |
| max_async_connection = 1 | integer | max number of PostGIS queries for rendering one map in asynchronous mode. Full doc [here](Postgis-async). |
| band = 0 | integer | request for a specific raster band index (1-based). 0 means to read all bands. Note that a band read from a single band raster gets interpreted as Grayscale if band=0 is specified while they retain their original value when explicitly referenced with the "band" parameter. This affects effectiveness of [[RasterColorizer]] |
# Styling

48
PostGIS.md

@ -6,30 +6,30 @@ See also a performance tuning page: [[OptimizeRenderingWithPostGIS]]
## Parameters
| *parameter* | *value* | *description* | *default* |
|:------------------|----------|---------------|----------:|
| host | string | name of the postgres host | |
| port | integer | name of the postgres port | |
| dbname | string | name of the database | |
| user | string | username to use for connecting | |
| password | string | user password to use for connecting | |
| table | string | name of the table to fetch, this can be a sub-query; subquery has to use syntax of: '( ) as subquery'. | |
| geometry_field | string | name of the geometry field, in case you have more than one in a single table. This field and the SRID will be deduced from the query in most cases, but may need to be manually specified in some cases.| |
| geometry_table | string | name of the table containing the returned geometry; for determining RIDs with subselects | |
| srid | integer | srid of the table, if this is > 0 then fetching data will avoid an extra database query for knowing the srid of the table | 0 |
| extent | string | maxextent of the geometries | determined by querying the metadata for the table |
| extent_from_subquery | boolean | evaluate the extent of the subquery, this might be a performance issue | false |
| connect_timeout | integer | timeout is seconds for the connection to take place | 4 |
| persist_connection | boolean | choose whether to share the same connection for subsequent queries | true |
| row_limit | integer | max number of rows to return when querying data, 0 means no limit | 0 |
| cursor_size | integer | if this is > 0 then server cursor will be used, and will prefetch this number of features | 0 |
| initial_size | integer | initial size of the stateless connection pool | 1 |
| max_size | integer | max size of the stateless connection pool | 10 |
| multiple_geometries | boolean | whether to use multiple different objects or a single one when dealing with multi-objects (this is mainly related to how the label are used in the map, one label for a multi-polygon or one label for each polygon of a multi-polygon)| false |
| encoding | string | internal file encoding | utf-8 |
| simplify_geometries | boolean | whether to automatically [reduce input vertices](http://blog.cartodb.com/post/20163722809/speeding-up-tiles-rendering). Only effective when output projection matches (or is similar to) input projection. Available from version 2.1.x up. | false |
| ~~asynchronous_request~~ | boolean | ~~Postgres queries are sent asynchronously : while rendering a layer, queries for further layers will run in parallel in the remote server. Available from version 2.3.x up.~~ | *DEPRECATED* (automatically set internally based on `max_async_connection > 1` condition) |
| max_async_connection | integer | max number of PostGIS queries for rendering one map in asynchronous mode. Full doc [here](Postgis-async). ~~Used only when asynchronous_request=true.~~ Default value (1) has no effect. | 1 |
| *name = default value* | *type* | *description* |
|:-----------------------------|:--------|:--------------|
| host | string | name of the postgres host |
| port | integer | name of the postgres port |
| dbname | string | name of the database |
| user | string | username to use for connecting |
| password | string | user password to use for connecting |
| table | string | name of the table to fetch, this can be a sub-query; subquery has to use syntax of: '( ) as subquery'. |
| geometry_field | string | name of the geometry field, in case you have more than one in a single table. This field and the SRID will be deduced from the query in most cases, but may need to be manually specified in some cases. |
| geometry_table | string | name of the table containing the returned geometry; for determining RIDs with subselects |
| srid = 0 | integer | srid of the table, if this is > 0 then fetching data will avoid an extra database query for knowing the srid of the table |
| extent | string | maxextent of the geometries; if omitted, the extent will be determined by querying the metadata for the table |
| extent_from_subquery = false | boolean | evaluate the extent of the subquery, this might be a performance issue |
| connect_timeout = 4 | integer | timeout is seconds for the connection to take place |
| persist_connection = true | boolean | choose whether to share the same connection for subsequent queries |
| row_limit = 0 | integer | max number of rows to return when querying data, 0 means no limit |
| cursor_size = 0 | integer | if this is > 0 then server cursor will be used, and will prefetch this number of features |
| initial_size = 1 | integer | initial size of the stateless connection pool |
| max_size = 10 | integer | max size of the stateless connection pool |
| multiple_geometries = false | boolean | whether to use multiple different objects or a single one when dealing with multi-objects (this is mainly related to how the label are used in the map, one label for a multi-polygon or one label for each polygon of a multi-polygon) |
| encoding = utf-8 | string | internal file encoding |
| simplify_geometries = false | boolean | whether to automatically [reduce input vertices](http://blog.cartodb.com/post/20163722809/speeding-up-tiles-rendering). Only effective when output projection matches (or is similar to) input projection. Available from version 2.1.x up. |
| ~~asynchronous_request~~ | boolean | ~~Postgres queries are sent asynchronously : while rendering a layer, queries for further layers will run in parallel in the remote server. Available from version 2.3.x up.~~ <br>*DEPRECATED* (automatically set internally based on `max_async_connection > 1` condition) |
| max_async_connection = 1 | integer | max number of PostGIS queries for rendering one map in asynchronous mode. Full doc [here](Postgis-async). ~~Used only when asynchronous_request=true.~~ Default value (1) has no effect. |
## Usage