Class: QgsVectorLayerEditBuffer

Stores queued vector layer edit operations prior to committing changes to the layer’s data provider.

Class Hierarchy

Base classes

QObject

Subclasses

QgsVectorLayerEditPassthrough

An edit buffer which directly passes commands through, used when a layer is within a transaction.

class qgis.core.QgsVectorLayerEditBuffer

Bases: QObject

virtual addAttribute(self, field: QgsField) → bool

Adds an attribute field (but does not commit it) returns True if the field was added

Parameters:

field (QgsField)

Return type:

bool

virtual addFeature(self, f: QgsFeature) → bool

Adds a feature

Parameters:

f (QgsFeature) – feature to add

Return type:

bool

Returns:

True in case of success and False in case of error

virtual addFeatures(self, features: Iterable[QgsFeature]) → bool

Insert a copy of the given features into the layer (but does not commit it)

Parameters:

features (Iterable[QgsFeature])

Return type:

bool

addedAttributes(self) → Any

Returns a list of added attributes fields which are not committed.

Return type:

Any

addedFeatures(self) → Any

Returns a map of new features which are not committed.

See also

isFeatureAdded()

Return type:

Any

allAddedOrEditedFeatures(self) → Any

Returns a list of the features IDs for all newly added or edited features in the buffer.

Added in version 3.20.

Return type:

Any

signal attributeAdded

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

signal attributeDeleted

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

signal attributeRenamed

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

signal attributeValueChanged

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

virtual changeAttributeValue(self, fid: int, field: int, newValue: Any, oldValue: Any = None) → bool

Changed an attribute value (but does not commit it)

Parameters:

• fid (int)

• field (int)

• newValue (Any)

• oldValue (Any = None)

Return type:

bool

virtual changeAttributeValues(self, fid: int, newValues: Dict[int, Any], oldValues: Dict[int, Any]) → bool

Changes values of attributes (but does not commit it).

Return type:

bool

Returns:

True if attributes are well updated, False otherwise

Parameters:

• fid (int)

• newValues (Dict[int, Any])

• oldValues (Dict[int, Any])

virtual changeGeometry(self, fid: int, geom: QgsGeometry) → bool

Change feature’s geometry

Parameters:

• fid (int)

• geom (QgsGeometry)

Return type:

bool

changedAttributeValues(self) → Any

Returns a map of features with changed attributes values which are not committed.

See also

isFeatureAttributesChanged()

Return type:

Any

changedGeometries(self) → Any

Returns a map of features with changed geometries which are not committed.

See also

isFeatureGeometryChanged()

Return type:

Any

virtual commitChanges(self, commitErrors: Iterable[str | None]) → bool

Attempts to commit any changes to disk. Returns the result of the attempt. If a commit fails, the in-memory changes are left alone.

This allows editing to continue if the commit failed on e.g. a disallowed value in a Postgres database - the user can re-edit and try again.

The commits occur in distinct stages, (add attributes, add features, change attribute values, change geometries, delete features, delete attributes) so if a stage fails, it’s difficult to roll back cleanly. Therefore any error message also includes which stage failed so that the user has some chance of repairing the damage cleanly.

Parameters:

commitErrors (Iterable[Optional[str]])

Return type:

bool

signal committedAttributeValuesChanges

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

signal committedAttributesAdded

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

signal committedAttributesDeleted

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

signal committedAttributesRenamed

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

signal committedFeaturesAdded

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

signal committedFeaturesRemoved

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

signal committedGeometriesChanges

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

virtual deleteAttribute(self, attr: int) → bool

Deletes an attribute field (but does not commit it)

Parameters:

attr (int)

Return type:

bool

virtual deleteFeature(self, fid: int) → bool

Delete a feature from the layer (but does not commit it)

Parameters:

fid (int)

Return type:

bool

virtual deleteFeatures(self, fid: Any) → bool

Deletes a set of features from the layer (but does not commit it)

Parameters:

fid (Any)

Return type:

bool

deletedAttributeIds(self) → List[int]

Returns a list of deleted attributes fields which are not committed. The list is kept sorted.

See also

isAttributeDeleted()

Return type:

List[int]

deletedFeatureIds(self) → Any

Returns a list of deleted feature IDs which are not committed.

See also

isFeatureDeleted()

Return type:

Any

editBufferGroup(self) → QgsVectorLayerEditBufferGroup | None

Returns the parent edit buffer group for this edit buffer, or None if not part of a group.

Added in version 3.26.

Return type:

Optional[QgsVectorLayerEditBufferGroup]

signal featureAdded

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

signal featureDeleted

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

signal geometryChanged

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

handleAttributeAdded(self, index: int, field: QgsField)

Update added and changed features after addition of an attribute

Parameters:

• index (int)

• field (QgsField)

handleAttributeDeleted(self, index: int)

Update added and changed features after removal of an attribute

Parameters:

index (int)

isAttributeDeleted(self, index: int) → bool

Returns True if the specified attribute has been deleted but not committed.

Parameters:

index (int) – attribute index

See also

deletedAttributeIds()

Return type:

bool

isFeatureAdded(self, id: int) → bool

Returns True if the specified feature ID has been added but not committed.

Parameters:

id (int) – feature ID

See also

addedFeatures()

Return type:

bool

isFeatureAttributesChanged(self, id: int) → bool

Returns True if the specified feature ID has had an attribute changed but not committed.

Parameters:

id (int) – feature ID

See also

changedAttributeValues()

Return type:

bool

isFeatureDeleted(self, id: int) → bool

Returns True if the specified feature ID has been deleted but not committed.

Parameters:

id (int) – feature ID

See also

deletedFeatureIds()

Return type:

bool

isFeatureGeometryChanged(self, id: int) → bool

Returns True if the specified feature ID has had its geometry changed but not committed.

Parameters:

id (int) – feature ID

See also

changedGeometries()

Return type:

bool

virtual isModified(self) → bool

Returns True if the provider has been modified since the last commit

Return type:

bool

signal layerModified

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

virtual renameAttribute(self, attr: int, newName: str | None) → bool

Renames an attribute field (but does not commit it)

Parameters:

• attr (int) – attribute index

• newName (Optional[str]) – new name of field

Return type:

bool

virtual rollBack(self)

Stop editing and discard the edits

setEditBufferGroup(self, editBufferGroup: QgsVectorLayerEditBufferGroup | None)

Set the parent edit buffer group for this edit buffer.

Added in version 3.26.

Parameters:

editBufferGroup (Optional[QgsVectorLayerEditBufferGroup])

undoIndexChanged(self, index: int)

Parameters:

index (int)

updateAttributeMapIndex(self, attrs: Dict[int, Any], index: int, offset: int)

Updates an index in an attribute map to a new value (for updates of changed attributes)

Parameters:

• attrs (Dict[int, Any])

• index (int)

• offset (int)

updateChangedAttributes(self, f: QgsFeature)

Update feature with uncommitted attribute updates

Parameters:

f (QgsFeature)

updateFeatureGeometry(self, f: QgsFeature)

Update feature with uncommitted geometry updates

Parameters:

f (QgsFeature)

updateLayerFields(self)