Layer relations via Python

Question

Is it possible to, through Python, to create the relations that it's possible to create in Layers/Properties/Fields/Relations, and if so how? I first thought these were saved in the styles, but that was not the case.

Answer 1

Yes, that is possible:

rel = QgsRelation()
rel.setReferencingLayer( 'child_layer_id' )
rel.setReferencedLayer( 'parent_layer_id' )
rel.addFieldPair( 'fk_field', 'pk_field' )
rel.setRelationId( 'my_relation' )
rel.setRelationName( 'Related Features' )
# rel.isValid() # It will only be added if it is valid. If not, check the ids and field names
QgsProject.instance().relationManager().addRelation( rel )

For inclusion in the layer style, please open a feature request on the issue page.

• user28233: I can't find the QgsRelation class in QGIS API Documentation. Is it not documented yet?
• Jakob: Your looking at the 2.0 API. The relation stuff is available from version 2.2: qgis.org/api/2.2/…
• user28233: I've been at it, but despite heeding the tip about checking that the ids and field names, can't seem to get it to work. As a guide, I'm looking at the saved .qgs project file where the relations have been created via the UI, and used this as a guid for ids, field and layer names placement. Prior to this I've loaded all layers programmatically and can verify that they are within the Layer TOC. Using the Python console in QGIS I'm trying to create the relations I can see the .qgs project file, but the final relation is never valid. Am I missing something?
• Matthias Kuhn: Make sure to use the layer's id and not its name. Use QgsMapLayerRegistry.instance().mapLayers() to check for layer ids and [f.name() for f in QgsMapLayerRegistry.instance().mapLayers()[layer id].pendingFields()] to check for a layer's fields.
• user28233: Extremely grateful for the pointers...