QSqlTableModel Class Reference
[QtSql module]

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.

See also QSqlRelationalTableModel, QSqlQuery, Model/View Programming, Table Model Example, and Cached Table Example.

Member Type Documentation

enum QSqlTableModel::EditStrategy

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

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

See also setEditStrategy().

Member Function Documentation

QSqlTableModel::QSqlTableModel ( QObject * parent = 0, QSqlDatabase db = QSqlDatabase() )

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::~QSqlTableModel ()   [virtual]

Destroys the object and frees any allocated resources.

void QSqlTableModel::beforeDelete ( int row )   [signal]

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

void QSqlTableModel::beforeInsert ( QSqlRecord & record )   [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 QSqlTableModel::beforeUpdate ( int row, QSqlRecord & record )   [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().

QSqlDatabase QSqlTableModel::database () const

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

bool QSqlTableModel::deleteRowFromTable ( int row )   [virtual protected]

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 () const

Returns the current edit strategy.

See also setEditStrategy().

int QSqlTableModel::fieldIndex ( const QString & fieldName ) const

Returns the index of the field fieldName.

QString QSqlTableModel::filter () const

Returns the currently set filter.

See also setFilter() and select().

QModelIndex QSqlTableModel::indexInQuery ( const QModelIndex & item ) const   [protected]

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 ( int row, const 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 ( const QSqlRecord & values )   [virtual protected]

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 ( int row, int count, const QModelIndex & parent = QModelIndex() )   [virtual]

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.

Reimplemented from QAbstractItemModel.

See also primeInsert() and insertRecord().

bool QSqlTableModel::isDirty ( const QModelIndex & index ) const

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 () const   [virtual protected]

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

See also setSort() and selectStatement().

QSqlIndex QSqlTableModel::primaryKey () const

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().

void QSqlTableModel::primeInsert ( int row, QSqlRecord & record )   [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.

bool QSqlTableModel::removeColumns ( int column, int count, const QModelIndex & parent = QModelIndex() )   [virtual]

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

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

Reimplemented from QAbstractItemModel.

See also removeRows().

bool QSqlTableModel::removeRows ( int row, int count, const QModelIndex & parent = QModelIndex() )   [virtual]

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().

Reimplemented from QAbstractItemModel.

See also removeColumns() and insertRows().

void QSqlTableModel::revert ()   [virtual slot]

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.

Reimplemented from QAbstractItemModel.

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

void QSqlTableModel::revertAll ()   [slot]

Reverts all pending changes.

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

void QSqlTableModel::revertRow ( int row )   [virtual]

Reverts all changes for the specified row.

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

bool QSqlTableModel::select ()   [virtual]

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 () const   [virtual protected]

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 ( const QModelIndex & index, const QVariant & value, int role = Qt::EditRole )   [virtual]

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.

Reimplemented from QAbstractItemModel.

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

void QSqlTableModel::setEditStrategy ( EditStrategy strategy )   [virtual]

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

This will revert any pending changes.

See also editStrategy() and revertAll().

void QSqlTableModel::setFilter ( const QString & filter )   [virtual]

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().

void QSqlTableModel::setPrimaryKey ( const QSqlIndex & key )   [protected]

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().

void QSqlTableModel::setQuery ( const QSqlQuery & query )   [protected]

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 ( int row, const 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().

void QSqlTableModel::setSort ( int column, Qt::SortOrder order )   [virtual]

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().

void QSqlTableModel::setTable ( const QString & tableName )   [virtual]

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().

void QSqlTableModel::sort ( int column, Qt::SortOrder order )   [virtual]

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.

Reimplemented from QAbstractItemModel.

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

bool QSqlTableModel::submit ()   [virtual slot]

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.

Reimplemented from QAbstractItemModel.

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

bool QSqlTableModel::submitAll ()   [slot]

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 () const

Returns the name of the currently selected table.

bool QSqlTableModel::updateRowInTable ( int row, const QSqlRecord & values )   [virtual protected]

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().