|  | Home · All Classes · Modules

# QSqlTableModel Class Reference
[QtSql module]

The QSqlTableModel class provides an editable data model for a single database table. More...

Inherits QSqlQueryModel.

Inherited by QSqlRelationalTableModel.

### Types

- enum EditStrategy { OnFieldChange, OnRowChange, OnManualSubmit }

### Methods

- __init__ (self, QObject parent = None, QSqlDatabase db = QSqlDatabase())
- clear (self)
- QVariant data (self, QModelIndex index, int role = Qt.DisplayRole)
- QSqlDatabase database (self)
- bool deleteRowFromTable (self, int row)
- EditStrategy editStrategy (self)
- int fieldIndex (self, QString fieldName)
- QString filter (self)
- Qt.ItemFlags flags (self, QModelIndex index)
- QVariant headerData (self, int section, Qt.Orientation orientation, int role = Qt.DisplayRole)
- QModelIndex indexInQuery (self, QModelIndex item)
- bool insertRecord (self, int row, QSqlRecord record)
- bool insertRowIntoTable (self, QSqlRecord values)
- bool insertRows (self, int row, int count, QModelIndex parent = QModelIndex())
- bool isDirty (self, QModelIndex index)
- QString orderByClause (self)
- QSqlIndex primaryKey (self)
- bool removeColumns (self, int column, int count, QModelIndex parent = QModelIndex())
- bool removeRows (self, int row, int count, QModelIndex parent = QModelIndex())
- revert (self)
- revertAll (self)
- revertRow (self, int row)
- int rowCount (self, QModelIndex parent = QModelIndex())
- bool select (self)
- QString selectStatement (self)
- bool setData (self, QModelIndex index, QVariant value, int role = Qt.EditRole)
- setEditStrategy (self, EditStrategy strategy)
- setFilter (self, QString filter)
- setPrimaryKey (self, QSqlIndex key)
- setQuery (self, QSqlQuery query)
- bool setRecord (self, int row, QSqlRecord record)
- setSort (self, int column, Qt.SortOrder order)
- setTable (self, QString tableName)
- sort (self, int column, Qt.SortOrder order)
- bool submit (self)
- bool submitAll (self)
- QString tableName (self)
- bool updateRowInTable (self, int row, QSqlRecord values)

### Qt Signals

- void beforeDelete (int)
- void beforeInsert (QSqlRecord&)
- void beforeUpdate (int,QSqlRecord&)
- void primeInsert (int,QSqlRecord&)

## Detailed Description

The QSqlTableModel class provides an editable data model for a single database table.

QSqlTableModel is a high-level interface for reading and writing database records from a single table. It is build on top of the lower-level QSqlQuery and can be used to provide data to view classes such as QTableView. For example:

         QSqlTableModel *model = new QSqlTableModel;
         model->setTable("employee");
         model->setEditStrategy(QSqlTableModel.OnManualSubmit);
         model->select();
         model->removeColumn(0); // don't show the ID
         model->setHeaderData(0, Qt.Horizontal, tr("Name"));
         model->setHeaderData(1, Qt.Horizontal, tr("Salary"));

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

We set the SQL table's name and the edit strategy, then we set up the labels displayed in the view header. The edit strategy dictates when the changes done by the user in the view are actually applied to the database. The possible values are OnFieldChange, OnRowChange, and OnManualSubmit.

QSqlTableModel can also be used to access a database programmatically, without binding it to a view:

         QSqlTableModel model;
         model.setTable("employee");
         QString name = model.record(4).value("name").toString();

The code snippet above extracts the `salary` field from record 4 in the result set of the query `SELECT * from employee`.

It is possible to set filters using setFilter(), or modify the sort order using setSort(). At the end, you must call select() to populate the model with data.

The sql/tablemodel example illustrates how to use QSqlTableModel as the data source for a QTableView.

QSqlTableModel provides no direct support for foreign keys. Use the QSqlRelationalTableModel and QSqlRelationalDelegate if you want to resolve foreign keys.

## Type Documentation

### QSqlTableModel.EditStrategy

This enum type describes which strategy to choose when editing values in the database.

Constant | Value | Description
--- | --- | ---
`QSqlTableModel.OnFieldChange` | `0` | All changes to the model will be applied immediately to the database.
`QSqlTableModel.OnRowChange` | `1` | Changes to a row will be applied when the user selects a different row.
`QSqlTableModel.OnManualSubmit` | `2` | All changes will be cached in the model until either submitAll() or revertAll() is called.

Note: To prevent inserting only partly initialized rows into the database, `OnFieldChange` will behave like `OnRowChange` for newly inserted rows.

See also setEditStrategy().

## Method Documentation

### QSqlTableModel.__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 QSqlTableModel and sets the parent to parent and the database connection to db. If db is not valid, the default database connection will be used.

The default edit strategy is OnRowChange.

### QSqlTableModel.clear (self)

Reimplemented from QSqlQueryModel.clear().

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

Reimplemented from QAbstractItemModel.data().

See also setData().

### QSqlDatabase QSqlTableModel.database (self)

Returns a pointer to the used QSqlDatabase or 0 if no database was set.

### bool QSqlTableModel.deleteRowFromTable (self, int row)

Deletes the given row from the currently active database table.

This is a low-level method that operates directly on the database and should not be called directly. Use removeRow() or removeRows() to delete values. The model will decide depending on its edit strategy when to modify the database.

Returns true if the row was deleted; otherwise returns false.

See also removeRow() and removeRows().

### EditStrategy QSqlTableModel.editStrategy (self)

Returns the current edit strategy.

See also setEditStrategy().

### int QSqlTableModel.fieldIndex (self, QString fieldName)

Returns the index of the field fieldName.

### QString QSqlTableModel.filter (self)

Returns the currently set filter.

See also setFilter() and select().

### Qt.ItemFlags QSqlTableModel.flags (self, QModelIndex index)

Reimplemented from QAbstractItemModel.flags().

### QVariant QSqlTableModel.headerData (self, int section, Qt.Orientation orientation, int role = Qt.DisplayRole)

Reimplemented from QAbstractItemModel.headerData().

### QModelIndex QSqlTableModel.indexInQuery (self, QModelIndex item)

Returns the index of the value in the database result set for the given item in the model.

The return value is identical to item if no columns or rows have been inserted, removed, or moved around.

Returns an invalid model index if item is out of bounds or if item does not point to a value in the result set.

See also QSqlQueryModel.indexInQuery().

### bool QSqlTableModel.insertRecord (self, int row, QSqlRecord record)

Inserts the record after row. If row is negative, the record will be appended to the end. Calls insertRows() and setRecord() internally.

Returns true if the row could be inserted, otherwise false.

See also insertRows() and removeRows().

### bool QSqlTableModel.insertRowIntoTable (self, QSqlRecord values)

Inserts the values values into the currently active database table.

This is a low-level method that operates directly on the database and should not be called directly. Use insertRow() and setData() to insert values. The model will decide depending on its edit strategy when to modify the database.

Returns true if the values could be inserted, otherwise false. Error information can be retrieved with lastError().

See also lastError(), insertRow(), and insertRows().

### bool QSqlTableModel.insertRows (self, int row, int count, QModelIndex parent = QModelIndex())

Reimplemented from QAbstractItemModel.insertRows().

Inserts count empty rows at position row. Note that parent must be invalid, since this model does not support parent-child relations.

Only one row at a time can be inserted when using the OnFieldChange or OnRowChange update strategies.

The primeInsert() signal will be emitted for each new row. Connect to it if you want to initialize the new row with default values.

Returns false if the parameters are out of bounds; otherwise returns true.

See also primeInsert() and insertRecord().

### bool QSqlTableModel.isDirty (self, QModelIndex index)

Returns true if the value at the index index is dirty, otherwise false. Dirty values are values that were modified in the model but not yet written into the database.

If index is invalid or points to a non-existing row, false is returned.

### QString QSqlTableModel.orderByClause (self)

Returns an SQL `ORDER BY` clause based on the currently set sort order.

See also setSort() and selectStatement().

### QSqlIndex QSqlTableModel.primaryKey (self)

Returns the primary key for the current table, or an empty QSqlIndex if the table is not set or has no primary key.

See also setTable(), setPrimaryKey(), and QSqlDatabase.primaryIndex().

### bool QSqlTableModel.removeColumns (self, int column, int count, QModelIndex parent = QModelIndex())

Reimplemented from QAbstractItemModel.removeColumns().

Removes count columns from the parent model, starting at index column.

Returns if the columns were successfully removed; otherwise returns false.

See also removeRows().

### bool QSqlTableModel.removeRows (self, int row, int count, QModelIndex parent = QModelIndex())

Reimplemented from QAbstractItemModel.removeRows().

Removes count rows starting at row. Since this model does not support hierarchical structures, parent must be an invalid model index.

Emits the beforeDelete() signal before a row is deleted. When the edit strategy is OnManualSubmit signal emission is delayed until submitAll() is called.

Returns true if all rows could be removed; otherwise returns false. Detailed error information can be retrieved using lastError().

See also removeColumns() and insertRows().

### QSqlTableModel.revert (self)

This method is also a Qt slot with the C++ signature `void revert()`.

Reimplemented from QAbstractItemModel.revert().

This reimplemented slot is called by the item delegates when the user canceled editing the current row.

Reverts the changes if the model's strategy is set to OnRowChange. Does nothing for the other edit strategies.

Use revertAll() to revert all pending changes for the OnManualSubmit strategy or revertRow() to revert a specific row.

See also submit(), submitAll(), revertRow(), and revertAll().

### QSqlTableModel.revertAll (self)

This method is also a Qt slot with the C++ signature `void revertAll()`.

Reverts all pending changes.

See also revert(), revertRow(), and submitAll().

### QSqlTableModel.revertRow (self, int row)

Reverts all changes for the specified row.

See also revert(), revertAll(), submit(), and submitAll().

### int QSqlTableModel.rowCount (self, QModelIndex parent = QModelIndex())

Reimplemented from QAbstractItemModel.rowCount().

### bool QSqlTableModel.select (self)

Populates the model with data from the table that was set via setTable(), using the specified filter and sort condition, and returns true if successful; otherwise returns false.

See also setTable(), setFilter(), and selectStatement().

### QString QSqlTableModel.selectStatement (self)

Returns the SQL `SELECT` statement used internally to populate the model. The statement includes the filter and the `ORDER BY` clause.

See also filter() and orderByClause().

### bool QSqlTableModel.setData (self, QModelIndex index, QVariant value, int role = Qt.EditRole)

Reimplemented from QAbstractItemModel.setData().

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

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

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

### QSqlTableModel.setEditStrategy (self, EditStrategy strategy)

Sets the strategy for editing values in the database to strategy.

This will revert any pending changes.

See also editStrategy() and revertAll().

### QSqlTableModel.setFilter (self, QString filter)

Sets the current filter to filter.

The filter is a SQL `WHERE` clause without the keyword `WHERE` (for example, `name='Josephine')`.

If the model is already populated with data from a database, the model re-selects it with the new filter. Otherwise, the filter will be applied the next time select() is called.

See also filter(), select(), selectStatement(), and orderByClause().

### QSqlTableModel.setPrimaryKey (self, QSqlIndex key)

Protected method that allows subclasses to set the primary key to key.

Normally, the primary index is set automatically whenever you call setTable().

See also primaryKey() and QSqlDatabase.primaryIndex().

### QSqlTableModel.setQuery (self, QSqlQuery query)

This function simply calls QSqlQueryModel.setQuery(query). You should normally not call it on a QSqlTableModel. Instead, use setTable(), setSort(), setFilter(), etc., to set up the query.

See also selectStatement().

### bool QSqlTableModel.setRecord (self, int row, QSqlRecord record)

Sets the values at the specified row to the values of record. Returns true if all the values could be set; otherwise returns false.

See also record().

### QSqlTableModel.setSort (self, int column, Qt.SortOrder order)

Sets the sort order for column to order. This does not affect the current data, to refresh the data using the new sort order, call select().

See also sort(), select(), and orderByClause().

### QSqlTableModel.setTable (self, QString tableName)

Sets the database table on which the model operates to tableName. Does not select data from the table, but fetches its field information.

To populate the model with the table's data, call select().

Error information can be retrieved with lastError().

See also select(), setFilter(), and lastError().

### QSqlTableModel.sort (self, int column, Qt.SortOrder order)

Reimplemented from QAbstractItemModel.sort().

Sorts the data by column with the sort order order. This will immediately select data, use setSort() to set a sort order without populating the model with data.

See also setSort(), select(), and orderByClause().

### bool QSqlTableModel.submit (self)

This method is also a Qt slot with the C++ signature `bool submit()`.

Reimplemented from QAbstractItemModel.submit().

This reimplemented slot is called by the item delegates when the user stopped editing the current row.

Submits the currently edited row if the model's strategy is set to OnRowChange or OnFieldChange. Does nothing for the OnManualSubmit strategy.

Use submitAll() to submit all pending changes for the OnManualSubmit strategy.

Returns true on success; otherwise returns false. Use lastError() to query detailed error information.

On success the model will be repopulated. Any views presenting it will lose their selections.

See also revert(), revertRow(), submitAll(), revertAll(), and lastError().

### bool QSqlTableModel.submitAll (self)

This method is also a Qt slot with the C++ signature `bool submitAll()`.

Submits all pending changes and returns true on success. Returns false on error, detailed error information can be obtained with lastError().

On success the model will be repopulated. Any views presenting it will lose their selections.

Note: In OnManualSubmit mode, already submitted changes won't be cleared from the cache when submitAll() fails. This allows transactions to be rolled back and resubmitted again without losing data.

See also revertAll() and lastError().

### QString QSqlTableModel.tableName (self)

Returns the name of the currently selected table.

### bool QSqlTableModel.updateRowInTable (self, int row, QSqlRecord values)

Updates the given row in the currently active database table with the specified values. Returns true if successful; otherwise returns false.

This is a low-level method that operates directly on the database and should not be called directly. Use setData() to update values. The model will decide depending on its edit strategy when to modify the database.

Note that only values that have the generated-flag set are updated. The generated-flag can be set with QSqlRecord.setGenerated() and tested with QSqlRecord.isGenerated().

See also QSqlRecord.isGenerated() and setData().

## Qt Signal Documentation

### void beforeDelete (int)

This is the default overload of this signal.

This signal is emitted by deleteRowFromTable() before the row is deleted from the currently active database table.

### void beforeInsert (QSqlRecord&)

This is the default overload of this signal.

This signal is emitted by insertRowIntoTable() before a new row is inserted into the currently active database table. The values that are about to be inserted are stored in record and can be modified before they will be inserted.

### void beforeUpdate (int,QSqlRecord&)

This is the default overload of this signal.

This signal is emitted by updateRowInTable() before the row is updated in the currently active database table with the values from record.

Note that only values that are marked as generated will be updated. The generated flag can be set with QSqlRecord.setGenerated() and checked with QSqlRecord.isGenerated().

See also QSqlRecord.isGenerated().

### void primeInsert (int,QSqlRecord&)

This is the default overload of this signal.

This signal is emitted by insertRows(), when an insertion is initiated in the given row of the currently active database table. The record parameter can be written to (since it is a reference), for example to populate some fields with default values.