24.1.9. Metadata tools

24.1.9.1. Add history metadata

Adds a new history entry to the layer’s metadata.

Parameters

Label	Name	Type	Description
Layer	INPUT	[layer]	The input layer (vector, raster, etc.) to which the history entry will be added.
History entry	HISTORY	[string]	The text to be appended as a new entry in the layer’s history metadata. This will be added to any existing history entries.

Outputs

Label	Name	Type	Description
Output	OUTPUT	[same as input]	The resulting layer with the updated history in its Metadata properties.

Python code

Algorithm ID: native:addhistorymetadata

import processing
processing.run("algorithm_id", {parameter_dictionary})

The algorithm id is displayed when you hover over the algorithm in the Processing Toolbox. The parameter dictionary provides the parameter NAMEs and values. See Using processing algorithms from the console for details on how to run processing algorithms from the Python console.

24.1.9.2. Copy Layer Metadata

Copies metadata from a source layer to a target layer. Any existing metadata in the target layer will be replaced with the metadata from the source layer. This includes all metadata fields, such as history, abstract, and other properties.

Parameters

Label	Name	Type	Description
Source layer	SOURCE	[layer]	The layer from which metadata will be copied.
Target layer	TARGET	[layer]	The layer to which metadata will be pasted. Any existing metadata in this layer will be replaced.
Save metadata as default	DEFAULT	[boolean] Default: False	If checked, the metadata information will be saved with the layer, hence available in subsequent projects.

Outputs

Label	Name	Type	Description
Output layer	OUTPUT	[layer]	The target layer with the metadata replaced by the metadata from the source layer. This includes all metadata fields, such as history, abstract, and other properties.

Python code

Algorithm ID: native:copylayermetadata

import processing
processing.run("algorithm_id", {parameter_dictionary})

The algorithm id is displayed when you hover over the algorithm in the Processing Toolbox. The parameter dictionary provides the parameter NAMEs and values. See Using processing algorithms from the console for details on how to run processing algorithms from the Python console.

24.1.9.3. Export Layer Metadata

Exports the metadata of a layer to a QMD file.

Parameters

Label	Name	Type	Description
Layer	INPUT	[layer]	The layer whose metadata will be exported.
Output	OUTPUT	[file] Default: [Save to temporary file]	Specification of the output file. One of: Save to a Temporary File Save to File…

Outputs

Label	Name	Type	Description
Output file	OUTPUT	[file]	The QMD file containing the exported metadata. This file can be used to import metadata into another layer.

Python code

Algorithm ID: native:exportlayermetadata

import processing
processing.run("algorithm_id", {parameter_dictionary})

The algorithm id is displayed when you hover over the algorithm in the Processing Toolbox. The parameter dictionary provides the parameter NAMEs and values. See Using processing algorithms from the console for details on how to run processing algorithms from the Python console.

24.1.9.4. Set Layer Metadata

Applies metadata to a layer from a QMD file.

Parameters

Label	Name	Type	Description
Layer	INPUT	[layer]	The layer to which the metadata will be applied.
Metadata file	METADATA	[file]	The QMD file containing the metadata to be applied.
Save metadata as default	DEFAULT	[boolean] Default: False	If checked, the metadata information will be saved with the layer, hence available in subsequent projects.

Outputs

Label	Name	Type	Description
Output layer	OUTPUT	[same as input]	The input layer with the metadata replaced by the metadata from the QMD file.

Python code

Algorithm ID: native:setlayermetadata

import processing
processing.run("algorithm_id", {parameter_dictionary})

The algorithm id is displayed when you hover over the algorithm in the Processing Toolbox. The parameter dictionary provides the parameter NAMEs and values. See Using processing algorithms from the console for details on how to run processing algorithms from the Python console.

24.1.9.5. Set Metadata Fields

Sets various metadata fields for a layer.

Parameters

Label	Name	Type	Description
Layer	INPUT	[layer]	The layer whose metadata fields will be updated
Identifier Optional	IDENTIFIER	[string]	A unique identifier for the layer
Parent identifier Optional	PARENT_IDENTIFIER	[string]	The identifier of the parent resource, if applicable
Title Optional	TITLE	[string]	The title of the layer
Type Optional	TYPE	[string]	The type of data stored in the layer
Language Optional	LANGUAGE	[string]	The language of the metadata
Encoding Optional	ENCODING	[string]	The character encoding used in the metadata
Abstract Optional	ABSTRACT	[string]	A brief description or abstract of the layer
Coordinate reference system Optional	CRS	[crs]	The coordinate reference system of the layer
Fees Optional	FEES	[string]	Information about any fees associated with accessing the layer
Ignore empty fields	IGNORE_EMPTY	[boolean] Default: False	If checked, no update will be done to metadata fields that are not filled

Outputs

Label	Name	Type	Description
Output layer	OUTPUT	[same as input]	The input layer with the specified metadata fields updated.

Python code

Algorithm ID: native:setmetadatafields

import processing
processing.run("algorithm_id", {parameter_dictionary})

The algorithm id is displayed when you hover over the algorithm in the Processing Toolbox. The parameter dictionary provides the parameter NAMEs and values. See Using processing algorithms from the console for details on how to run processing algorithms from the Python console.

24.1.9.6. Update Layer Metadata

Copies all non-empty metadata fields from a source layer to a target layer. Leaves empty input fields unchanged in the target.

Parameters

Label	Name	Type	Description
Source layer	SOURCE	[layer]	The layer from which non-empty metadata fields will be copied
Target layer	TARGET	[layer]	The layer to which non-empty metadata fields will be pasted. Empty fields in the source layer will not overwrite existing metadata in the target layer.

Outputs

Label	Name	Type	Description
Target layer	OUTPUT	[layer]	The target layer with updated metadata.

Python code

Algorithm ID: native:updatelayermetadata

import processing
processing.run("algorithm_id", {parameter_dictionary})

The algorithm id is displayed when you hover over the algorithm in the Processing Toolbox. The parameter dictionary provides the parameter NAMEs and values. See Using processing algorithms from the console for details on how to run processing algorithms from the Python console.