Scroll to navigation

GDAL-VECTOR-SET-FIELD-TYPE(1) GDAL GDAL-VECTOR-SET-FIELD-TYPE(1)

NAME

gdal-vector-set-field-type - Modify the type of a field of a vector dataset

Added in version 3.12.

SYNOPSIS

Usage: gdal vector set-field-type [OPTIONS] <INPUT> <OUTPUT>
Modify the type of a field of a vector dataset.
Positional arguments:


  -i, --input <INPUT>                                  Input vector datasets [required] [not available in pipelines]


  -o, --output <OUTPUT>                                Output vector dataset [required] [not available in pipelines]
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:


  -l, --layer, --input-layer <INPUT-LAYER>             Input layer name(s) [may be repeated] [not available in pipelines]


  -f, --of, --format, --output-format <OUTPUT-FORMAT>  Output format ("GDALG" allowed) [not available in pipelines]


  --co, --creation-option <KEY>=<VALUE>                Creation option [may be repeated] [not available in pipelines]


  --lco, --layer-creation-option <KEY>=<VALUE>         Layer creation option [may be repeated] [not available in pipelines]


  --overwrite                                          Whether overwriting existing output dataset is allowed [not available in pipelines]


  --update                                             Whether to open existing dataset in update mode [not available in pipelines]


  --overwrite-layer                                    Whether overwriting existing output layer is allowed [not available in pipelines]


  --append                                             Whether appending to existing layer is allowed [not available in pipelines]


                                                       Mutually exclusive with --upsert


  --output-layer <OUTPUT-LAYER>                        Output layer name [not available in pipelines]


  --skip-errors                                        Skip errors when writing features [not available in pipelines]


  --active-layer <ACTIVE-LAYER>                        Set active layer (if not specified, all)


  --field-name <FIELD-NAME>                            Field name [required]


                                                       Mutually exclusive with --input-field-type


  --input-field-type <INPUT-FIELD-TYPE>                Source field type or subtype [required]


                                                       Mutually exclusive with --field-name


  --output-field-type, --field-type <FIELD-TYPE>       Target field type or subtype [required]
Advanced Options:


  --if, --input-format <INPUT-FORMAT>                  Input formats [may be repeated] [not available in pipelines]


  --oo, --open-option <KEY>=<VALUE>                    Open options [may be repeated] [not available in pipelines]


  --output-oo, --output-open-option <KEY>=<VALUE>      Output open options [may be repeated] [not available in pipelines]


  --upsert                                             Upsert features (implies 'append') [not available in pipelines]


                                                       Mutually exclusive with --append


DESCRIPTION

gdal vector set-field-type can be used to modify the field type of a vector dataset:

set-field-type can also be used as a step of gdal vector pipeline.

GDALG OUTPUT (ON-THE-FLY / STREAMED DATASET)

This program supports serializing the command line as a JSON file using the GDALG output format. The resulting file can then be opened as a vector dataset using the GDALG: GDAL Streamed Algorithm driver, and apply the specified pipeline in a on-the-fly / streamed way.

PROGRAM-SPECIFIC OPTIONS

The name of the field to modify.

Mutually exclusive with --input-field-type. One of them is required.


The new field type. Valid values are: Integer, IntegerList, Real, RealList, String, StringList, Binary, ` Date, Time, DateTime, Integer64, Integer64List. A field subtype can be specified instead of a field type. Valid values are: Boolean, Int16, Float32, JSON, UUID. The field type will be derived from the subtype.

The field type of the fields to modify. Valid values are: Integer, IntegerList, Real, RealList, String, StringList, Binary, ` Date, Time, DateTime, Integer64, Integer64List. A field subtype can be specified instead of a field type. Valid values are: Boolean, Int16, Float32, JSON, UUID.

Mutually exclusive with --field-name. One of them is required.


STANDARD OPTIONS

Set the active layer. When it is specified, only the layer specified by its name will be subject to the processing. Other layers will be not modified. If this option is not specified, all layers will be subject to the processing.

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

Many formats have one or more optional dataset creation options that can be used to control particulars about the file created. For instance, 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 options supported for a format can be listed with the --formats command line option but the documentation for the format is the definitive 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.


Format/driver name to be attempted to open the input file(s). It is generally not necessary to specify it, but it can be used to skip automatic driver detection, when it fails to select the appropriate driver. This option can be repeated several times to specify several candidate drivers. Note that it does not force those drivers to open the dataset. In particular, some drivers have requirements on file extensions.

May be repeated.


Specifies the name of one or more layers to process. By default, all layers will be processed. To read and write all layers but only process a subset, use --active-layer.

Many formats have one or more optional layer creation options that can be used to control particulars about the layer created. For instance, 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 options supported for a format can be listed with the --formats command line option but the documentation for the format is the definitive 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.


Dataset open option (format specific).

May be repeated.


Which output vector format to use. Allowed values may be given by gdal --formats | grep vector | grep rw | sort

Specifies the name of the layer to which features will be written. If not specified, output layer names will be the same as input layer names.

Added in version 3.12.

Dataset open option for output dataset (format specific).

May be repeated.


Allow program to overwrite existing target file or dataset. Otherwise, by default, gdal errors out if the target file or dataset already exists.

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

Added in version 3.12.

Whether failures to write feature(s) should be ignored. Note that this option sets the size of the transaction unit to one feature at a time, which may cause severe slowdown when inserting into databases.


Whether to open an existing output dataset in update mode.

Added in version 3.12.

Variant of --append where the OGRLayer::UpsertFeature() operation is used to insert or update features instead of appending with OGRLayer::CreateFeature().

This is currently implemented only in a few drivers: GPKG -- GeoPackage vector, Elasticsearch: Geographically Encoded Objects for Elasticsearch and MongoDBv3 (drivers that implement upsert expose the GDAL_DCAP_UPSERT capability).

The upsert operation uses the FID of the input feature, when it is set (and the FID column name is not the empty string), as the key to update existing features. It is crucial to make sure that the FID in the source and target layers are consistent.

For the GPKG driver, it is also possible to upsert features whose FID is unset or non-significant (the --unset-fid option of gdal vector edit can be used to ignore the FID from the source feature), when there is a UNIQUE column that is not the integer primary key.


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 successful execution).

EXAMPLES

Example 1: Change the type of a field given by its name to Integer

$ gdal vector set-field-type input.gpkg output.gpkg --field-name myfield --field-type Integer


Example 2: Change the type of all fields of type Date to DateTime

$ gdal vector set-field-type input.gpkg output.gpkg --input-field-type Date --output-field-type DateTime


AUTHOR

Alessandro Pasotti <elpaso@itopen.it>

COPYRIGHT

1998-2026

May 8, 2026