postgis.gdal_enabled_drivers
Prev | 8.23. Grand Unified Custom Variables (GUCs) | Next

## Name

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`

Sets backend for all new connections to database

    ALTER DATABASE mygisdb SET postgis.gdal_enabled_drivers TO 'GTiff PNG JPEG';

Sets default enabled drivers for all new connections to server. Requires super user access and PostgreSQL 9.4+. Also note that database, session, and user settings override this.

    ALTER SYSTEM SET postgis.gdal_enabled_drivers TO 'GTiff PNG JPEG';
    SELECT pg_reload_conf();

    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

ST_FromGDALRaster, ST_AsGDALRaster, ST_AsTIFF, ST_AsPNG, ST_AsJPEG, postgis.enable_outdb_rasters

Prev | Up | Next
postgis.gdal_datapath | Home | postgis.enable_outdb_rasters