Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help 
GDAL-VECTOR-INDEX(1)		      GDAL		    GDAL-VECTOR-INDEX(1)

NAME
     gdal-vector-index - Create a vector index of vector datasets

     Added in version 3.12.

SYNOPSIS
	Usage: gdal vector index [OPTIONS] <INPUT>... <OUTPUT>

	Create a vector index of vector datasets.

	Positional arguments:
	  -i, --input <INPUT>				       Input vector datasets [may be repeated] [required]
	  -o, --output <OUTPUT> 			       Output vector dataset [required]

	Common Options:
	  -h, --help					       Display help message and exit
	  --json-usage					       Display usage as JSON document and exit
	  --config <KEY>=<VALUE>			       Configuration option [may be repeated]
	  -q, --quiet					       Quiet mode (no progress bar or warning message) [not available in pipelines]

	Options:
	  -f, --of, --format, --output-format <OUTPUT-FORMAT>  Output format
	  --co, --creation-option <KEY>=<VALUE> 	       Creation option [may be repeated]
	  --lco, --layer-creation-option <KEY>=<VALUE>	       Layer creation option [may be repeated]
	  --overwrite					       Whether overwriting existing output dataset is allowed
							       Mutually exclusive with --update
	  --update					       Whether to open existing dataset in update mode
							       Mutually exclusive with --overwrite
	  --overwrite-layer				       Whether overwriting existing output layer is allowed
	  --append					       Whether appending to existing layer is allowed
	  --nln, --output-layer <OUTPUT-LAYER>		       Output layer name
	  --recursive					       Whether input directories should be explored recursively.
	  --filename-filter <FILENAME-FILTER>		       Pattern that the filenames in input directories should follow ('*' and '?' wildcard) [may be repeated]
	  --location-name <LOCATION-NAME>		       Name of the field with the vector path (default: location)
	  --absolute-path				       Whether the path to the input datasets should be stored as an absolute path
	  --output-crs <OUTPUT-CRS>			       Output CRS
	  --metadata <KEY>=<VALUE>			       Add dataset metadata item [may be repeated]
	  --source-crs-field-name <SOURCE-CRS-FIELD-NAME>      Name of the field to store the CRS of each dataset
	  --source-crs-format <SOURCE-CRS-FORMAT>	       Format in which the CRS of each dataset must be written. SOURCE-CRS-FORMAT=auto|WKT|EPSG|PROJ (default: auto)
	  --source-layer-name <SOURCE-LAYER-NAME>	       Add layer of specified name from each source file in the tile index [may be repeated]
	  --source-layer-index <SOURCE-LAYER-INDEX>	       Add layer of specified index (0-based) from each source file in the tile index [may be repeated]
	  --accept-different-crs			       Whether layers with different CRS are accepted
	  --accept-different-schemas			       Whether layers with different schemas are accepted
	  --dataset-name-only				       Whether to write the dataset name only, instead of suffixed with the layer index

DESCRIPTION
     gdal  vector  index  creates  a vector dataset with a record for each input
     vector file, an attribute containing the filename (suffixed with comma  and
     the index of the layer within the dataset) and a polygon geometry outlining
     the  (rectangular)  extent.  This output is suitable for use with MapServer
     as a vector tileindex

PROGRAM-SPECIFIC OPTIONS
     --absolute-path
	    The absolute path to the vector files is stored in the  index  file.
	    By	default  the vector filenames will be put in the file exactly as
	    they are specified on the command line.

     --accept-different-crs
	    Whether layers with different CRS are accepted.  By default,  unless
	    --output-crs  is  specified, layers that do not have the same CRS as
	    the    first    index    layer    will    be    skipped.	 Setting
	    --accept-different-crs  may  be  useful to avoid the CRS consistency
	    check.

     --accept-different-schemas
	    Whether layers with different schemas  are	accepted.   By	default,
	    layers  that  do  not have the same schemas as the first index layer
	    will be skipped.

     --dataset-name-only
	    Whether to write the dataset name only, instead of suffixed with the
	    layer index.

	    WARNING:
	       Setting this option will generate a location  not  compatible  of
	       MapServer.

     --filename-filter <FILENAME-FILTER>
	    Pattern  that  the	filenames  contained in input directories should
	    follow.  '*' is a wildcard character that matches any number of  any
	    characters	including none. '?' is a wildcard character that matches
	    a single character.  Comparisons are done in a case insensitive way.
	    Several filters may be specified.

	    For example: --filename-filter "*.shp,*.gpkg"

     --location-name <LOCATION-NAME>
	    The output field name to hold the file path/location to the  indexed
	    vectors. The default field name is location.

     --metadata <KEY>=<VALUE>
	    Write  an  arbitrary  layer  metadata item, for formats that support
	    layer metadata.  This option may be repeated.

     --output-crs <OUTPUT-CRS>
	    Envelopes of the input files will be transformed to the desired tar-
	    get coordinate reference system.  Default creates simple rectangular
	    polygons in the same coordinate reference system as the  input  vec-
	    tors.

     --recursive
	    Whether input directories should be explored recursively.

     --source-crs-field-name <SOURCE-CRS-FIELD-NAME>
	    The name of the field to store the CRS of each tile. This field name
	    can be used as the value of the TILESRS keyword in MapServer

     --source-crs-format auto|WKT|EPSG|PROJ
	    The  format in which the CRS of each tile must be written. Types can
	    be auto, WKT, EPSG, PROJ.  This option should be used together  with
	    --source-crs-field-name.

     --source-layer-name <SOURCE-LAYER-NAME>
	    Add  layer of specified name from each source file in the tile index
	    [may be repeated] If none of

     --source-layer-index <SOURCE-LAYER-INDEX>
	    Add layer of specified index (0-based) from each source file in  the
	    tile index [may be repeated]

STANDARD OPTIONS
     --append
	    Whether  appending	features  to existing layer(s) is allowed.  This
	    also creates the output dataset if it does not exist yet.

     --co, --creation-option <NAME>=<VALUE>
	    Many formats have one or more optional dataset creation options that
	    can be used to control particulars about the file created.	For  in-
	    stance,  the  GeoPackage driver supports creation options to control
	    the version.

	    May be repeated.

	    The dataset creation options available vary by  format  driver,  and
	    some  simple  formats have no creation options at all. A list of op-
	    tions supported for a format can be listed with the  --formats  com-
	    mand line option but the documentation for the format is the defini-
	    tive  source  of information on driver creation options.  See Vector
	    drivers format specific documentation for legal creation options for
	    each format.

	    Note that dataset creation options are different from layer creation
	    options.

     --lco, --layer-creation-option <NAME>=<VALUE>
	    Many formats have one or more optional layer creation  options  that
	    can  be used to control particulars about the layer created. For in-
	    stance, the GeoPackage driver supports  layer  creation  options  to
	    control  the feature identifier or geometry column name, setting the
	    identifier or description, etc.

	    May be repeated.

	    The layer creation options available vary by format driver, and some
	    simple formats have no layer creation options at all. A list of  op-
	    tions  supported  for a format can be listed with the --formats com-
	    mand line option but the documentation for the format is the defini-
	    tive source of information on driver creation options.   See  Vector
	    drivers format specific documentation for legal creation options for
	    each format.

	    Note that layer creation options are different from dataset creation
	    options.

     -f, --of, --format, --output-format <OUTPUT-FORMAT>
	    Which  output  vector  format to use. Allowed values may be given by
	    gdal --formats | grep vector | grep rw | sort

     --nln, --output-layer <LAYER>
	    Provides a name for the output vector layer.

     --overwrite
	    Allow program to overwrite existing target file or dataset.   Other-
	    wise,  by default, gdal errors out if the target file or dataset al-
	    ready exists.

     --overwrite-layer
	    Whether overwriting the existing output vector layer is allowed.

     --update
	    Whether to open an existing output dataset in update mode.

RETURN STATUS CODE
     The program returns status code 0 in case of success, and non-zero in  case
     of  error (non-blocking errors emitted as warnings are considered as a suc-
     cessful execution).

EXAMPLES
   Example 1
     Produce a GeoPackage with a record for every layer that the  utility  found
     in  the  countries folder. Each record holds information that points to the
     location of each input vector file and  also  a  bounding	rectangle  shape
     showing its bounds:

	gdal vector index countries/*.shp index.gpkg

   Example 2
     The  --output-crs option can also be used to transform all input vector en-
     velopes into the same output projection:

	gdal vector index --output-crs EPSG:4326 --source-crs-field-name=src_srs countries/*.shp index.gpkg

AUTHOR
     Even Rouault <even.rouault@spatialys.com>

COPYRIGHT
     1998-2026

				  Jun 05, 2026		    GDAL-VECTOR-INDEX(1)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=gdal-vector-index&sektion=1&manpath=FreeBSD+Ports+15.1.quarterly>

home | help