From: Regina Obe Date: Mon, 13 Oct 2014 18:08:39 +0000 (+0000) Subject: get rid of windows breaks X-Git-Tag: 2.2.0rc1~786 X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=997d34948203ee3fcd3d0db1f67ad4a952d3d531;p=postgis get rid of windows breaks git-svn-id: http://svn.osgeo.org/postgis/trunk@13064 b70326c6-7e19-0410-871a-916f4a2858ee --- diff --git a/doc/reference_guc.xml b/doc/reference_guc.xml index d3d55f502..04ae4b6bc 100644 --- a/doc/reference_guc.xml +++ b/doc/reference_guc.xml @@ -1,235 +1,235 @@ - - - - - This section lists custom PostGIS Grand Unified Custom Variables(GUC). These can be set globally, by database, by session or by transaction. Best set at global or database level. - - - PostGIS Grand Unified Custom Variables (GUCs) - - - - postgis.backend - The backend to service a function where GEOS and SFCGAL overlap. Options: geos or sfcgal. Defaults to geos. - - - - Description - This GUC is only relevant if you compiled PostGIS with sfcgal support. By default geos backend is used for functions where both GEOS and SFCGAL have the same named function. This variable allows you to override and make sfcgal the backend to service the request. - Availability: 2.1.0 - - - - Examples - Sets backend just for life of connection - set postgis.backend = sfcgal; - - Sets backend for new connections to database - ALTER DATABASE mygisdb SET postgis.backend = sfcgal; - - - See Also - - - - - - - postgis.gdal_datapath - - A configuration option to assign the value of GDAL's GDAL_DATA option. If not set, the environmentally set GDAL_DATA variable is used. - - - - - Description - - A PostgreSQL GUC variable for setting the value of GDAL's GDAL_DATA option. The postgis.gdal_datapath value should be the complete physical path to GDAL's data files. - - - This configuration option is of most use for Windows platforms where GDAL's data files path is not hard-coded. This option should also be set when GDAL's data files are not located in GDAL's expected path. - - - - - This option can be set in PostgreSQL's configuration file postgresql.conf. It can also be set by connection or transaction. - - - Availability: 2.2.0 - - - - Additional information about GDAL_DATA is available at GDAL's Configuration Options. - - - - - - - Examples - Set and reset postgis.gdal_datapath - - -SET postgis.gdal_datapath TO '/usr/local/share/gdal.hidden'; -SET postgis.gdal_datapath TO default; - - - Setting on windows for a particular database - ALTER DATABASE gisdb -SET postgis.gdal_datapath = 'C:/Program Files/PostgreSQL/9.3/gdal-data'; - - - - See Also - - , - - - - - - - postgis.gdal_enabled_drivers - - A configuration option to set the enabled GDAL drivers in the PostGIS environment. Affects the GDAL configuration variable GDAL_SKIP. - - - - - Description - - A configuration option to set the enabled GDAL drivers in the PostGIS environment. Affects the GDAL configuration variable GDAL_SKIP. This option can be set in PostgreSQL's configuration file: postgresql.conf. It can also be set by connection or transaction. - - - - The initial value of postgis.gdal_enabled_drivers may also be set by passing the environment variable POSTGIS_GDAL_ENABLED_DRIVERS with the list of enabled drivers to the process starting PostgreSQL. - - - - Enabled GDAL specified drivers can be specified by the driver's short-name or code. Driver short-names or codes can be found at GDAL Raster Formats. Multiple drivers can be specified by putting a space between each driver. - - - - - There are three special codes available for postgis.gdal_enabled_drivers. The codes are case-sensitive. - - - - DISABLE_ALL disables all GDAL drivers. If present, DISABLE_ALL overrides all other values in postgis.gdal_enabled_drivers. - - - ENABLE_ALL enables all GDAL drivers. - - - VSICURL enables GDAL's /vsicurl/ virtual file system. - - - - - When postgis.gdal_enabled_drivers is set to DISABLE_ALL, attempts to use out-db rasters, ST_FromGDALRaster(), ST_AsGDALRaster(), ST_AsTIFF(), ST_AsJPEG() and ST_AsPNG() will result in error messages. - - - - - - In the standard PostGIS installation, postgis.gdal_enabled_drivers is set to DISABLE_ALL. - - - - - - Additional information about GDAL_SKIP is available at GDAL's Configuration Options. - - - - Availability: 2.2.0 - - - - - Examples - Set and reset postgis.gdal_enabled_drivers - - -SET postgis.gdal_enabled_drivers TO 'GTiff PNG JPEG'; -SET postgis.gdal_enabled_drivers = default; - - - Enable all GDAL Drivers - -SET postgis.gdal_enabled_drivers = 'ENABLE_ALL'; - - - Disable all GDAL Drivers - -SET postgis.gdal_enabled_drivers = 'DISABLE_ALL'; - - - - - See Also - - , - , - , - , - , - - - - - - - - postgis.enable_outdb_rasters - - A boolean configuration option to enable access to out-db raster bands. - - - - - Description - - A boolean configuration option to enable access to out-db raster bands. This option can be set in PostgreSQL's configuration file: postgresql.conf. It can also be set by connection or transaction. - - - - The initial value of postgis.enable_outdb_rasters may also be set by passing the environment variable POSTGIS_ENABLE_OUTDB_RASTERS with a non-zero value to the process starting PostgreSQL. - - - - - Even if postgis.enable_outdb_rasters is True, the GUC postgis.enable_outdb_rasters determines the accessible raster formats. - - - - - - In the standard PostGIS installation, postgis.enable_outdb_rasters is set to False. - - - - Availability: 2.2.0 - - - - - Examples - Set and reset postgis.enable_outdb_rasters - - -SET postgis.enable_outdb_rasters TO True; -SET postgis.enable_outdb_rasters = default; -SET postgis.enable_outdb_rasters = True; -SET postgis.enable_outdb_rasters = False; - - - - - See Also - - - - - - + + + + + This section lists custom PostGIS Grand Unified Custom Variables(GUC). These can be set globally, by database, by session or by transaction. Best set at global or database level. + + + PostGIS Grand Unified Custom Variables (GUCs) + + + + postgis.backend + The backend to service a function where GEOS and SFCGAL overlap. Options: geos or sfcgal. Defaults to geos. + + + + Description + This GUC is only relevant if you compiled PostGIS with sfcgal support. By default geos backend is used for functions where both GEOS and SFCGAL have the same named function. This variable allows you to override and make sfcgal the backend to service the request. + Availability: 2.1.0 + + + + Examples + Sets backend just for life of connection + set postgis.backend = sfcgal; + + Sets backend for new connections to database + ALTER DATABASE mygisdb SET postgis.backend = sfcgal; + + + See Also + + + + + + + postgis.gdal_datapath + + A configuration option to assign the value of GDAL's GDAL_DATA option. If not set, the environmentally set GDAL_DATA variable is used. + + + + + Description + + A PostgreSQL GUC variable for setting the value of GDAL's GDAL_DATA option. The postgis.gdal_datapath value should be the complete physical path to GDAL's data files. + + + This configuration option is of most use for Windows platforms where GDAL's data files path is not hard-coded. This option should also be set when GDAL's data files are not located in GDAL's expected path. + + + + + This option can be set in PostgreSQL's configuration file postgresql.conf. It can also be set by connection or transaction. + + + Availability: 2.2.0 + + + + Additional information about GDAL_DATA is available at GDAL's Configuration Options. + + + + + + + Examples + Set and reset postgis.gdal_datapath + + +SET postgis.gdal_datapath TO '/usr/local/share/gdal.hidden'; +SET postgis.gdal_datapath TO default; + + + Setting on windows for a particular database + ALTER DATABASE gisdb +SET postgis.gdal_datapath = 'C:/Program Files/PostgreSQL/9.3/gdal-data'; + + + + See Also + + , + + + + + + + postgis.gdal_enabled_drivers + + A configuration option to set the enabled GDAL drivers in the PostGIS environment. Affects the GDAL configuration variable GDAL_SKIP. + + + + + Description + + A configuration option to set the enabled GDAL drivers in the PostGIS environment. Affects the GDAL configuration variable GDAL_SKIP. This option can be set in PostgreSQL's configuration file: postgresql.conf. It can also be set by connection or transaction. + + + + The initial value of postgis.gdal_enabled_drivers may also be set by passing the environment variable POSTGIS_GDAL_ENABLED_DRIVERS with the list of enabled drivers to the process starting PostgreSQL. + + + + Enabled GDAL specified drivers can be specified by the driver's short-name or code. Driver short-names or codes can be found at GDAL Raster Formats. Multiple drivers can be specified by putting a space between each driver. + + + + + There are three special codes available for postgis.gdal_enabled_drivers. The codes are case-sensitive. + + + + DISABLE_ALL disables all GDAL drivers. If present, DISABLE_ALL overrides all other values in postgis.gdal_enabled_drivers. + + + ENABLE_ALL enables all GDAL drivers. + + + VSICURL enables GDAL's /vsicurl/ virtual file system. + + + + + When postgis.gdal_enabled_drivers is set to DISABLE_ALL, attempts to use out-db rasters, ST_FromGDALRaster(), ST_AsGDALRaster(), ST_AsTIFF(), ST_AsJPEG() and ST_AsPNG() will result in error messages. + + + + + + In the standard PostGIS installation, postgis.gdal_enabled_drivers is set to DISABLE_ALL. + + + + + + Additional information about GDAL_SKIP is available at GDAL's Configuration Options. + + + + Availability: 2.2.0 + + + + + Examples + Set and reset postgis.gdal_enabled_drivers + + +SET postgis.gdal_enabled_drivers TO 'GTiff PNG JPEG'; +SET postgis.gdal_enabled_drivers = default; + + + Enable all GDAL Drivers + +SET postgis.gdal_enabled_drivers = 'ENABLE_ALL'; + + + Disable all GDAL Drivers + +SET postgis.gdal_enabled_drivers = 'DISABLE_ALL'; + + + + + See Also + + , + , + , + , + , + + + + + + + + postgis.enable_outdb_rasters + + A boolean configuration option to enable access to out-db raster bands. + + + + + Description + + A boolean configuration option to enable access to out-db raster bands. This option can be set in PostgreSQL's configuration file: postgresql.conf. It can also be set by connection or transaction. + + + + The initial value of postgis.enable_outdb_rasters may also be set by passing the environment variable POSTGIS_ENABLE_OUTDB_RASTERS with a non-zero value to the process starting PostgreSQL. + + + + + Even if postgis.enable_outdb_rasters is True, the GUC postgis.enable_outdb_rasters determines the accessible raster formats. + + + + + + In the standard PostGIS installation, postgis.enable_outdb_rasters is set to False. + + + + Availability: 2.2.0 + + + + + Examples + Set and reset postgis.enable_outdb_rasters + + +SET postgis.enable_outdb_rasters TO True; +SET postgis.enable_outdb_rasters = default; +SET postgis.enable_outdb_rasters = True; +SET postgis.enable_outdb_rasters = False; + + + + + See Also + + + + + +