Class: QgsFeatureSink

An interface for objects which accept features via addFeature(s) methods.

Note

This is an abstract class, with methods which must be implemented by a subclass.

The following methods must be implemented: addFeatures()

List of all members, including inherited members

Class Hierarchy

Subclasses

QgsVectorLayer	Represents a vector layer which manages a vector based dataset.
QgsFeatureStore	A container for features with the same fields and crs.
QgsProxyFeatureSink	A simple feature sink which proxies feature addition onto another feature sink.
QgsRemappingProxyFeatureSink	A QgsFeatureSink which proxies incoming features to a destination feature sink, after applying transformations and field value mappings.
QgsSpatialIndex	A spatial index for QgsFeature objects.
QgsVectorDataProvider	Base class for vector data providers.
QgsVectorFileWriter	A convenience class for writing vector layers to disk based formats (e.g. Shapefiles, GeoPackage).
QgsVectorLayerExporter	A convenience class for exporting vector layers to a destination data provider.
QgsVectorLayerJoinBuffer	Manages joined fields for a vector layer.
QgsFeaturePool	A feature pool is based on a vector layer and caches features.

Enums

Flag
SinkFlag

Abstract Methods

addFeatures

Adds a list of features to the sink.

Methods

Flags
SinkFlags

Virtual Methods

In PyQGIS, only methods marked as virtual can be safely overridden in a Python subclass of QgsFeatureSink. See the FAQ for more details.

addFeature	Adds a single feature to the sink.
finalize	Finalizes the sink, flushing any buffered features to the destination.
flushBuffer	Flushes any internal buffer which may exist in the sink, causing any buffered features to be added to the sink's destination.
lastError	Returns the most recent error encountered by the sink, e.g. when a call to addFeatures() returns False.

class qgis.core.QgsFeatureSink

Bases: object

FastInsert = 2

class Flag(*values)

Bases: IntEnum

FastInsert = 2

RollBackOnErrors = 4

Flags()

RegeneratePrimaryKey = 2

RollBackOnErrors = 4

class SinkFlag(*values)

Bases: IntEnum

RegeneratePrimaryKey = 2

SinkFlags()

virtual addFeature(self, feature: QgsFeature, flags: QgsFeatureSink.Flag = QgsFeatureSink.Flags()) → bool

Adds a single feature to the sink. Feature addition behavior is controlled by the specified flags.

See also

addFeatures()

Return type:

bool

Returns:

True in case of success and False in case of failure

Parameters:

• feature (QgsFeature)

• flags (QgsFeatureSink.Flag = QgsFeatureSink.Flags())

abstract addFeatures(self, features: Iterable[QgsFeature], flags: QgsFeatureSink.Flag = QgsFeatureSink.Flags()) → bool

Adds a list of features to the sink. Feature addition behavior is controlled by the specified flags.

See also

addFeature()

Returns:

True in case of success and False in case of failure

addFeatures(self, iterator: QgsFeatureIterator, flags: QgsFeatureSink.Flag = QgsFeatureSink.Flags()) -> bool Adds all features from the specified iterator to the sink. Feature addition behavior is controlled by the specified flags.

Return type:

bool

Returns:

True if all features were added successfully, or False if any feature could not be added

Parameters:

• features (Iterable[QgsFeature])

• flags (QgsFeatureSink.Flag = QgsFeatureSink.Flags())

virtual finalize(self)

Finalizes the sink, flushing any buffered features to the destination.

Added in version 3.42.

virtual flushBuffer(self) → bool

Flushes any internal buffer which may exist in the sink, causing any buffered features to be added to the sink’s destination.

Return type:

bool

Returns:

False if any buffered features could not be added to the sink.

virtual lastError(self) → str

Returns the most recent error encountered by the sink, e.g. when a call to addFeatures() returns False.

Added in version 3.16.

Return type:

str