|  | Home · All Classes · Modules

# QSqlRelationalTableModel Class Reference
[QtSql module]

The QSqlRelationalTableModel class provides an editable data model for a single database table, with foreign key support. More...

Inherits QSqlTableModel.

### Methods

- __init__ (self, QObject parent = None, QSqlDatabase db = QSqlDatabase())
- clear (self)
- QVariant data (self, QModelIndex, int role = Qt.DisplayRole)
- bool insertRowIntoTable (self, QSqlRecord)
- QString orderByClause (self)
- QSqlRelation relation (self, int)
- QSqlTableModel relationModel (self, int)
- bool removeColumns (self, int, int, QModelIndex parent = QModelIndex())
- revertRow (self, int)
- bool select (self)
- QString selectStatement (self)
- bool setData (self, QModelIndex, QVariant, int role = Qt.EditRole)
- setRelation (self, int, QSqlRelation)
- setTable (self, QString)
- bool updateRowInTable (self, int, QSqlRecord)

## Detailed Description

The QSqlRelationalTableModel class provides an editable data model for a single database table, with foreign key support.

QSqlRelationalTableModel acts like QSqlTableModel, but allows columns to be set as foreign keys into other database tables.

The screenshot on the left shows a plain QSqlTableModel in a QTableView. Foreign keys (`city` and `country`) aren't resolved to human-readable values. The screenshot on the right shows a QSqlRelationalTableModel, with foreign keys resolved into human-readable text strings.

The following code snippet shows how the QSqlRelationalTableModel was set up:

         model->setTable("employee");

         model->setRelation(2, QSqlRelation("city", "id", "name"));
         model->setRelation(3, QSqlRelation("country", "id", "name"));

The setRelation() function calls establish a relationship between two tables. The first call specifies that column 2 in table `employee` is a foreign key that maps with field `id` of table `city`, and that the view should present the `city`'s `name` field to the user. The second call does something similar with column 3.

If you use a read-write QSqlRelationalTableModel, you probably want to use QSqlRelationalDelegate on the view. Unlike the default delegate, QSqlRelationalDelegate provides a combobox for fields that are foreign keys into other tables. To use the class, simply call QAbstractItemView.setItemDelegate() on the view with an instance of QSqlRelationalDelegate:

         QTableView *view = new QTableView;
         view->setModel(model);
         view->setItemDelegate(new QSqlRelationalDelegate(view));

The sql/relationaltablemodel example illustrates how to use QSqlRelationalTableModel in conjunction with QSqlRelationalDelegate to provide tables with foreigh key support.

Notes:

- The table must have a primary key declared.
- The table's primary key may not contain a relation to another table.
- If a relational table contains keys that refer to non-existent rows in the referenced table, the rows containing the invalid keys will not be exposed through the model. The user or the database is responsible for keeping referential integrity.
- If a relation's display column name is also used as a column name in the main table, or if it is used as display column name in more than one relation it will be aliased. The alias is is the relation's table name and display column name joined by an underscore (e.g. tablename_columnname). All occurrences of the duplicate display column name are aliased when duplication is detected, but no aliasing is done to the column names in the main table. The aliasing doesn't affect QSqlRelation, so QSqlRelation.displayColumn() will return the original display column name, but QSqlRecord.fieldName() will return aliases.
- When using setData() the role should always be Qt.EditRole, and when using data() the role should always be Qt.DisplayRole.

## Method Documentation

### QSqlRelationalTableModel.__init__ (self, QObject parent = None, QSqlDatabase db = QSqlDatabase())

The parent argument, if not None, causes self to be owned by Qt instead of PyQt.

Creates an empty QSqlRelationalTableModel and sets the parent to parent and the database connection to db. If db is not valid, the default database connection will be used.

### QSqlRelationalTableModel.clear (self)

Reimplemented from QSqlQueryModel.clear().

### QVariant QSqlRelationalTableModel.data (self, QModelIndex, int role = Qt.DisplayRole)

Reimplemented from QAbstractItemModel.data().

See also setData().

### bool QSqlRelationalTableModel.insertRowIntoTable (self, QSqlRecord)

Reimplemented from QSqlTableModel.insertRowIntoTable().

### QString QSqlRelationalTableModel.orderByClause (self)

Reimplemented from QSqlTableModel.orderByClause().

### QSqlRelation QSqlRelationalTableModel.relation (self, int)

Returns the relation for the column column, or an invalid relation if no relation is set.

See also setRelation() and QSqlRelation.isValid().

### QSqlTableModel QSqlRelationalTableModel.relationModel (self, int)

Returns a QSqlTableModel object for accessing the table for which column is a foreign key, or 0 if there is no relation for the given column.

The returned object is owned by the QSqlRelationalTableModel.

See also setRelation() and relation().

### bool QSqlRelationalTableModel.removeColumns (self, int, int, QModelIndex parent = QModelIndex())

Reimplemented from QAbstractItemModel.removeColumns().

### QSqlRelationalTableModel.revertRow (self, int)

Reimplemented from QSqlTableModel.revertRow().

### bool QSqlRelationalTableModel.select (self)

Reimplemented from QSqlTableModel.select().

### QString QSqlRelationalTableModel.selectStatement (self)

Reimplemented from QSqlTableModel.selectStatement().

### bool QSqlRelationalTableModel.setData (self, QModelIndex, QVariant, int role = Qt.EditRole)

Reimplemented from QAbstractItemModel.setData().

Sets the data for the role in the item with the specified index to the value given. Depending on the edit strategy, the value might be applied to the database at once, or it may be cached in the model.

Returns true if the value could be set, or false on error (for example, if index is out of bounds).

For relational columns, value must be the index, not the display value. The index must also exist in the referenced table, otherwise the function returns false.

See also editStrategy(), data(), submit(), and revertRow().

### QSqlRelationalTableModel.setRelation (self, int, QSqlRelation)

Lets the specified column be a foreign index specified by relation.

Example:

         model->setTable("employee");

         model->setRelation(2, QSqlRelation("city", "id", "name"));

The setRelation() call specifies that column 2 in table `employee` is a foreign key that maps with field `id` of table `city`, and that the view should present the `city`'s `name` field to the user.

Note: The table's primary key may not contain a relation to another table.

See also relation().

### QSqlRelationalTableModel.setTable (self, QString)

Reimplemented from QSqlTableModel.setTable().

### bool QSqlRelationalTableModel.updateRowInTable (self, int, QSqlRecord)

Reimplemented from QSqlTableModel.updateRowInTable().