Qt 6.x
The Qt SDK
Loading...
Searching...
No Matches
Public Types | Public Slots | Public Member Functions | Protected Member Functions | List of all members
QSqlRelationalTableModel Class Reference

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

#include <qsqlrelationaltablemodel.h>

+ Inheritance diagram for QSqlRelationalTableModel:
+ Collaboration diagram for QSqlRelationalTableModel:

Public Types

enum  JoinMode { InnerJoin , LeftJoin }
 \value InnerJoin - Inner join mode, return rows when there is at least one match in both tables. More...
 
- Public Types inherited from QSqlTableModel
enum  EditStrategy { OnFieldChange , OnRowChange , OnManualSubmit }
 This enum type describes which strategy to choose when editing values in the database. More...
 
- Public Types inherited from QAbstractItemModel
enum  LayoutChangeHint { NoLayoutChangeHint , VerticalSortHint , HorizontalSortHint }
 This enum describes the way the model changes layout. More...
 
enum class  CheckIndexOption { NoOption = 0x0000 , IndexIsValid = 0x0001 , DoNotUseParent = 0x0002 , ParentIsInvalid = 0x0004 }
 

Public Slots

void revertRow (int row) override
 \reimp
 
- Public Slots inherited from QSqlTableModel
virtual bool select ()
 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.
 
virtual bool selectRow (int row)
 
bool submit () override
 This reimplemented slot is called by the item delegates when the user stopped editing the current row.
 
void revert () override
 This reimplemented slot is called by the item delegates when the user canceled editing the current row.
 
bool submitAll ()
 Submits all pending changes and returns true on success.
 
void revertAll ()
 Reverts all pending changes.
 
- Public Slots inherited from QAbstractItemModel
virtual bool submit ()
 Lets the model know that it should submit cached information to permanent storage.
 
virtual void revert ()
 Lets the model know that it should discard cached information.
 
- Public Slots inherited from QObject
void deleteLater ()
 \threadsafe
 

Public Member Functions

 QSqlRelationalTableModel (QObject *parent=nullptr, const QSqlDatabase &db=QSqlDatabase())
 Creates an empty QSqlRelationalTableModel and sets the parent to parent and the database connection to db.
 
virtual ~QSqlRelationalTableModel ()
 Destroys the object and frees any allocated resources.
 
QVariant data (const QModelIndex &item, int role=Qt::DisplayRole) const override
 \reimp
 
bool setData (const QModelIndex &item, const QVariant &value, int role=Qt::EditRole) override
 Sets the data for the role in the item with the specified index to the value given.
 
bool removeColumns (int column, int count, const QModelIndex &parent=QModelIndex()) override
 \reimp
 
void clear () override
 \reimp
 
bool select () override
 \reimp
 
void setTable (const QString &tableName) override
 \reimp
 
virtual void setRelation (int column, const QSqlRelation &relation)
 Lets the specified column be a foreign index specified by relation.
 
QSqlRelation relation (int column) const
 Returns the relation for the column column, or an invalid relation if no relation is set.
 
virtual QSqlTableModel * relationModel (int column) const
 Returns a QSqlTableModel object for accessing the table for which column is a foreign key, or \nullptr if there is no relation for the given column.
 
void setJoinMode (QSqlRelationalTableModel::JoinMode joinMode)
 Sets the SQL joinMode to show or hide rows with NULL foreign keys.
 
- Public Member Functions inherited from QSqlTableModel
 QSqlTableModel (QObject *parent=nullptr, const QSqlDatabase &db=QSqlDatabase())
 Creates an empty QSqlTableModel and sets the parent to parent and the database connection to db.
 
virtual ~QSqlTableModel ()
 Destroys the object and frees any allocated resources.
 
virtual void setTable (const QString &tableName)
 Sets the database table on which the model operates to tableName.
 
QString tableName () const
 Returns the name of the currently selected table.
 
Qt::ItemFlags flags (const QModelIndex &index) const override
 \reimp
 
QSqlRecord record () const
 This is an overloaded function.
 
QSqlRecord record (int row) const
 
QVariant data (const QModelIndex &idx, int role=Qt::DisplayRole) const override
 \reimp
 
bool setData (const QModelIndex &index, const QVariant &value, int role=Qt::EditRole) override
 Sets the data for the item index for the role role to value.
 
bool clearItemData (const QModelIndex &index) override
 \reimp
 
QVariant headerData (int section, Qt::Orientation orientation, int role=Qt::DisplayRole) const override
 \reimp
 
bool isDirty () const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
bool isDirty (const QModelIndex &index) const
 Returns true if the value at the index index is dirty, otherwise false.
 
void clear () override
 \reimp
 
virtual void setEditStrategy (EditStrategy strategy)
 Sets the strategy for editing values in the database to strategy.
 
EditStrategy editStrategy () const
 Returns the current edit strategy.
 
QSqlIndex 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.
 
QSqlDatabase database () const
 Returns the model's database connection.
 
int fieldIndex (const QString &fieldName) const
 Returns the index of the field fieldName, or -1 if no corresponding field exists in the model.
 
void sort (int column, Qt::SortOrder order) override
 Sorts the data by column with the sort order order.
 
virtual void setSort (int column, Qt::SortOrder order)
 Sets the sort order for column to order.
 
QString filter () const
 Returns the currently set filter.
 
virtual void setFilter (const QString &filter)
 Sets the current filter to filter.
 
int rowCount (const QModelIndex &parent=QModelIndex()) const override
 \reimp
 
bool removeColumns (int column, int count, const QModelIndex &parent=QModelIndex()) override
 Removes count columns from the parent model, starting at index column.
 
bool removeRows (int row, int count, const QModelIndex &parent=QModelIndex()) override
 Removes count rows starting at row.
 
bool insertRows (int row, int count, const QModelIndex &parent=QModelIndex()) override
 Inserts count empty rows at position row.
 
bool insertRecord (int row, const QSqlRecord &record)
 Inserts the record at position row.
 
bool setRecord (int row, const QSqlRecord &record)
 Applies values to the row in the model.
 
virtual void revertRow (int row)
 Reverts all changes for the specified row.
 
- Public Member Functions inherited from QSqlQueryModel
 QSqlQueryModel (QObject *parent=nullptr)
 Creates an empty QSqlQueryModel with the given parent.
 
virtual ~QSqlQueryModel ()
 Destroys the object and frees any allocated resources.
 
int rowCount (const QModelIndex &parent=QModelIndex()) const override
 
int columnCount (const QModelIndex &parent=QModelIndex()) const override
 \reimp
 
QSqlRecord record (int row) const
 Returns the record containing information about the fields of the current query.
 
QSqlRecord record () const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Returns an empty record containing information about the fields of the current query.
 
QVariant data (const QModelIndex &item, int role=Qt::DisplayRole) const override
 Returns the value for the specified item and role.
 
QVariant headerData (int section, Qt::Orientation orientation, int role=Qt::DisplayRole) const override
 Returns the header data for the given role in the section of the header with the specified orientation.
 
bool setHeaderData (int section, Qt::Orientation orientation, const QVariant &value, int role=Qt::EditRole) override
 Sets the caption for a horizontal header for the specified role to value.
 
bool insertColumns (int column, int count, const QModelIndex &parent=QModelIndex()) override
 Inserts count columns into the model at position column.
 
bool removeColumns (int column, int count, const QModelIndex &parent=QModelIndex()) override
 Removes count columns from the model starting from position column.
 
void setQuery (QSqlQuery &&query)
 Resets the model and sets the data provider to be the given query.
 
void setQuery (const QString &query, const QSqlDatabase &db=QSqlDatabase())
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Executes the query query for the given database connection db.
 
const QSqlQuery & query (QT6_DECL_NEW_OVERLOAD) const
 Returns a reference to the const QSqlQuery object associated with this model.
 
virtual void clear ()
 Clears the model and releases any acquired resource.
 
QSqlError lastError () const
 Returns information about the last error that occurred on the database.
 
void fetchMore (const QModelIndex &parent=QModelIndex()) override
 
bool canFetchMore (const QModelIndex &parent=QModelIndex()) const override
 
QHash< int, QByteArray > roleNames () const override
 
- Public Member Functions inherited from QAbstractTableModel
 QAbstractTableModel (QObject *parent=nullptr)
 Constructs an abstract table model for the given parent.
 
 ~QAbstractTableModel ()
 Destroys the abstract table model.
 
QModelIndex index (int row, int column, const QModelIndex &parent=QModelIndex()) const override
 Returns the index of the data in row and column with parent.
 
QModelIndex sibling (int row, int column, const QModelIndex &idx) const override
 \reimp
 
bool dropMimeData (const QMimeData *data, Qt::DropAction action, int row, int column, const QModelIndex &parent) override
 \reimp
 
Qt::ItemFlags flags (const QModelIndex &index) const override
 \reimp
 
QObject * parent () const
 Returns a pointer to the parent object.
 
- Public Member Functions inherited from QAbstractItemModel
 QAbstractItemModel (QObject *parent=nullptr)
 Constructs an abstract item model with the given parent.
 
virtual ~QAbstractItemModel ()
 Destroys the abstract item model.
 
Q_INVOKABLE bool hasIndex (int row, int column, const QModelIndex &parent=QModelIndex()) const
 Returns {true} if the model returns a valid QModelIndex for row and column with parent, otherwise returns {false}.
 
virtual Q_INVOKABLE QModelIndex index (int row, int column, const QModelIndex &parent=QModelIndex()) const =0
 Returns the index of the item in the model specified by the given row, column and parent index.
 
virtual Q_INVOKABLE QModelIndex parent (const QModelIndex &child) const =0
 
virtual Q_INVOKABLE QModelIndex sibling (int row, int column, const QModelIndex &idx) const
 Returns the sibling at row and column for the item at index, or an invalid QModelIndex if there is no sibling at that location.
 
virtual Q_INVOKABLE int rowCount (const QModelIndex &parent=QModelIndex()) const =0
 Returns the number of rows under the given parent.
 
virtual Q_INVOKABLE int columnCount (const QModelIndex &parent=QModelIndex()) const =0
 Returns the number of columns for the children of the given parent.
 
virtual Q_INVOKABLE bool hasChildren (const QModelIndex &parent=QModelIndex()) const
 Returns {true} if parent has any children; otherwise returns {false}.
 
virtual Q_INVOKABLE QVariant data (const QModelIndex &index, int role=Qt::DisplayRole) const =0
 Returns the data stored under the given role for the item referred to by the index.
 
virtual Q_INVOKABLE bool setData (const QModelIndex &index, const QVariant &value, int role=Qt::EditRole)
 Sets the role data for the item at index to value.
 
virtual Q_INVOKABLE QVariant headerData (int section, Qt::Orientation orientation, int role=Qt::DisplayRole) const
 Returns the data for the given role and section in the header with the specified orientation.
 
virtual bool setHeaderData (int section, Qt::Orientation orientation, const QVariant &value, int role=Qt::EditRole)
 Sets the data for the given role and section in the header with the specified orientation to the value supplied.
 
virtual QMap< int, QVariant > itemData (const QModelIndex &index) const
 Returns a map with values for all predefined roles in the model for the item at the given index.
 
virtual bool setItemData (const QModelIndex &index, const QMap< int, QVariant > &roles)
 Sets the role data for the item at index to the associated value in roles, for every Qt::ItemDataRole.
 
virtual bool clearItemData (const QModelIndex &index)
 
virtual QStringList mimeTypes () const
 Returns the list of allowed MIME types.
 
virtual QMimeData * mimeData (const QModelIndexList &indexes) const
 Returns an object that contains serialized items of data corresponding to the list of indexes specified.
 
virtual bool canDropMimeData (const QMimeData *data, Qt::DropAction action, int row, int column, const QModelIndex &parent) const
 Returns {true} if a model can accept a drop of the data.
 
virtual bool dropMimeData (const QMimeData *data, Qt::DropAction action, int row, int column, const QModelIndex &parent)
 Handles the data supplied by a drag and drop operation that ended with the given action.
 
virtual Qt::DropActions supportedDropActions () const
 
virtual Qt::DropActions supportedDragActions () const
 Returns the actions supported by the data in this model.
 
Q_INVOKABLE Q_REVISION (6, 4) virtual bool insertRows(int row
 
Q_INVOKABLE Q_REVISION (6, 4) virtual bool insertColumns(int column
 
Q_INVOKABLE Q_REVISION (6, 4) virtual bool removeRows(int row
 
Q_INVOKABLE Q_REVISION (6, 4) virtual bool removeColumns(int column
 
Q_INVOKABLE Q_REVISION (6, 4) virtual bool moveRows(const QModelIndex &sourceParent
 
Q_INVOKABLE Q_REVISION (6, 4) virtual bool moveColumns(const QModelIndex &sourceParent
 
Q_INVOKABLE Q_REVISION (6, 4) inline bool insertRow(int row
 
Q_INVOKABLE Q_REVISION (6, 4) inline bool insertColumn(int column
 
Q_INVOKABLE Q_REVISION (6, 4) inline bool removeRow(int row
 
Q_INVOKABLE Q_REVISION (6, 4) inline bool removeColumn(int column
 
Q_INVOKABLE Q_REVISION (6, 4) inline bool moveRow(const QModelIndex &sourceParent
 
Q_INVOKABLE Q_REVISION (6, 4) inline bool moveColumn(const QModelIndex &sourceParent
 
virtual Q_INVOKABLE void fetchMore (const QModelIndex &parent)
 Fetches any available data for the items with the parent specified by the parent index.
 
virtual Q_INVOKABLE bool canFetchMore (const QModelIndex &parent) const
 Returns {true} if there is more data available for parent; otherwise returns {false}.
 
virtual Q_INVOKABLE Qt::ItemFlags flags (const QModelIndex &index) const
 Returns the item flags for the given index.
 
Q_INVOKABLE Q_REVISION (6, 4) virtual void sort(int column
 
virtual QModelIndex buddy (const QModelIndex &index) const
 Returns a model index for the buddy of the item represented by index.
 
virtual Q_INVOKABLE QModelIndexList match (const QModelIndex &start, int role, const QVariant &value, int hits=1, Qt::MatchFlags flags=Qt::MatchFlags(Qt::MatchStartsWith|Qt::MatchWrap)) const
 Returns a list of indexes for the items in the column of the start index where data stored under the given role matches the specified value.
 
virtual QSize span (const QModelIndex &index) const
 Returns the row and column span of the item represented by index.
 
virtual QHash< int, QByteArray > roleNames () const
 
bool checkIndex (const QModelIndex &index, CheckIndexOptions options=CheckIndexOption::NoOption) const
 
virtual void multiData (const QModelIndex &index, QModelRoleDataSpan roleDataSpan) const
 
QObject * parent () const
 Returns a pointer to the parent object.
 
- Public Member Functions inherited from QObject
Q_INVOKABLE QObject (QObject *parent=nullptr)
 Constructs an object with parent object parent.
 
virtual ~QObject ()
 Destroys the object, deleting all its child objects.
 
virtual bool event (QEvent *event)
 This virtual function receives events to an object and should return true if the event e was recognized and processed.
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 Filters events if this object has been installed as an event filter for the watched object.
 
QString objectName () const
 
Q_WEAK_OVERLOAD void setObjectName (const QString &name)
 Sets the object's name to name.
 
void setObjectName (QAnyStringView name)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
QBindable< QString > bindableObjectName ()
 
bool isWidgetType () const
 Returns true if the object is a widget; otherwise returns false.
 
bool isWindowType () const
 Returns true if the object is a window; otherwise returns false.
 
bool isQuickItemType () const
 Returns true if the object is a QQuickItem; otherwise returns false.
 
bool signalsBlocked () const noexcept
 Returns true if signals are blocked; otherwise returns false.
 
bool blockSignals (bool b) noexcept
 If block is true, signals emitted by this object are blocked (i.e., emitting a signal will not invoke anything connected to it).
 
QThread * thread () const
 Returns the thread in which the object lives.
 
void moveToThread (QThread *thread)
 Changes the thread affinity for this object and its children.
 
int startTimer (int interval, Qt::TimerType timerType=Qt::CoarseTimer)
 This is an overloaded function that will start a timer of type timerType and a timeout of interval milliseconds.
 
int startTimer (std::chrono::milliseconds time, Qt::TimerType timerType=Qt::CoarseTimer)
 
void killTimer (int id)
 Kills the timer with timer identifier, id.
 
template<typename T >
T findChild (const QString &aName=QString(), Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 Returns the child of this object that can be cast into type T and that is called name, or \nullptr if there is no such object.
 
template<typename T >
QList< T > findChildren (const QString &aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 Returns all children of this object with the given name that can be cast to type T, or an empty list if there are no such objects.
 
template<typename T >
QList< T > findChildren (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
const QObjectList & children () const
 Returns a list of child objects.
 
void setParent (QObject *parent)
 Makes the object a child of parent.
 
void installEventFilter (QObject *filterObj)
 Installs an event filter filterObj on this object.
 
void removeEventFilter (QObject *obj)
 Removes an event filter object obj from this object.
 
QMetaObject::Connection connect (const QObject *sender, const char *signal, const char *member, Qt::ConnectionType type=Qt::AutoConnection) const
 
bool disconnect (const char *signal=nullptr, const QObject *receiver=nullptr, const char *member=nullptr) const
 
bool disconnect (const QObject *receiver, const char *member=nullptr) const
 
void dumpObjectTree () const
 Dumps a tree of children to the debug output.
 
void dumpObjectInfo () const
 Dumps information about signal connections, etc.
 
bool setProperty (const char *name, const QVariant &value)
 Sets the value of the object's name property to value.
 
bool setProperty (const char *name, QVariant &&value)
 
QVariant property (const char *name) const
 Returns the value of the object's name property.
 
QList< QByteArray > dynamicPropertyNames () const
 
QBindingStorage * bindingStorage ()
 
const QBindingStorage * bindingStorage () const
 
QObject * parent () const
 Returns a pointer to the parent object.
 
bool inherits (const char *classname) const
 Returns true if this object is an instance of a class that inherits className or a QObject subclass that inherits className; otherwise returns false.
 

Protected Member Functions

QString selectStatement () const override
 \reimp
 
bool updateRowInTable (int row, const QSqlRecord &values) override
 \reimp
 
bool insertRowIntoTable (const QSqlRecord &values) override
 \reimp
 
QString orderByClause () const override
 \reimp
 
- Protected Member Functions inherited from QSqlTableModel
 QSqlTableModel (QSqlTableModelPrivate &dd, QObject *parent=nullptr, const QSqlDatabase &db=QSqlDatabase())
 
virtual bool updateRowInTable (int row, const QSqlRecord &values)
 Updates the given row in the currently active database table with the specified values.
 
virtual bool insertRowIntoTable (const QSqlRecord &values)
 Inserts the values values into the currently active database table.
 
virtual bool deleteRowFromTable (int row)
 Deletes the given row from the currently active database table.
 
virtual QString orderByClause () const
 Returns an SQL {ORDER BY} clause based on the currently set sort order.
 
virtual QString selectStatement () const
 Returns the SQL SELECT statement used internally to populate the model.
 
void setPrimaryKey (const QSqlIndex &key)
 Protected method that allows subclasses to set the primary key to key.
 
QModelIndex indexInQuery (const QModelIndex &item) const override
 Returns the index of the value in the database result set for the given item in the model.
 
QSqlRecord primaryValues (int row) const
 
- Protected Member Functions inherited from QSqlQueryModel
void beginInsertRows (const QModelIndex &parent, int first, int last)
 
void endInsertRows ()
 
void beginRemoveRows (const QModelIndex &parent, int first, int last)
 
void endRemoveRows ()
 
void beginInsertColumns (const QModelIndex &parent, int first, int last)
 
void endInsertColumns ()
 
void beginRemoveColumns (const QModelIndex &parent, int first, int last)
 
void endRemoveColumns ()
 
void beginResetModel ()
 
void endResetModel ()
 
virtual void queryChange ()
 This virtual function is called whenever the query changes.
 
virtual QModelIndex indexInQuery (const QModelIndex &item) const
 Returns the index of the value in the database result set for the given item in the model.
 
void setLastError (const QSqlError &error)
 Protected function which allows derived classes to set the value of the last error that occurred on the database to error.
 
 QSqlQueryModel (QSqlQueryModelPrivate &dd, QObject *parent=nullptr)
 
- Protected Member Functions inherited from QAbstractTableModel
 QAbstractTableModel (QAbstractItemModelPrivate &dd, QObject *parent)
 
- Protected Member Functions inherited from QAbstractItemModel
 QAbstractItemModel (QAbstractItemModelPrivate &dd, QObject *parent=nullptr)
 
QModelIndex createIndex (int row, int column, const void *data=nullptr) const
 Creates a model index for the given row and column with the internal pointer ptr.
 
QModelIndex createIndex (int row, int column, quintptr id) const
 Creates a model index for the given row and column with the internal identifier, id.
 
void encodeData (const QModelIndexList &indexes, QDataStream &stream) const
 
bool decodeData (int row, int column, const QModelIndex &parent, QDataStream &stream)
 
void beginInsertRows (const QModelIndex &parent, int first, int last)
 Begins a row insertion operation.
 
void endInsertRows ()
 Ends a row insertion operation.
 
void beginRemoveRows (const QModelIndex &parent, int first, int last)
 Begins a row removal operation.
 
void endRemoveRows ()
 Ends a row removal operation.
 
bool beginMoveRows (const QModelIndex &sourceParent, int sourceFirst, int sourceLast, const QModelIndex &destinationParent, int destinationRow)
 
void endMoveRows ()
 Ends a row move operation.
 
void beginInsertColumns (const QModelIndex &parent, int first, int last)
 Begins a column insertion operation.
 
void endInsertColumns ()
 Ends a column insertion operation.
 
void beginRemoveColumns (const QModelIndex &parent, int first, int last)
 Begins a column removal operation.
 
void endRemoveColumns ()
 Ends a column removal operation.
 
bool beginMoveColumns (const QModelIndex &sourceParent, int sourceFirst, int sourceLast, const QModelIndex &destinationParent, int destinationColumn)
 Begins a column move operation.
 
void endMoveColumns ()
 Ends a column move operation.
 
void beginResetModel ()
 Begins a model reset operation.
 
void endResetModel ()
 Completes a model reset operation.
 
void changePersistentIndex (const QModelIndex &from, const QModelIndex &to)
 Changes the QPersistentModelIndex that is equal to the given from model index to the given to model index.
 
void changePersistentIndexList (const QModelIndexList &from, const QModelIndexList &to)
 
QModelIndexList persistentIndexList () const
 
- Protected Member Functions inherited from QObject
QObject * sender () const
 Returns a pointer to the object that sent the signal, if called in a slot activated by a signal; otherwise it returns \nullptr.
 
int senderSignalIndex () const
 
int receivers (const char *signal) const
 Returns the number of receivers connected to the signal.
 
bool isSignalConnected (const QMetaMethod &signal) const
 
virtual void timerEvent (QTimerEvent *event)
 This event handler can be reimplemented in a subclass to receive timer events for the object.
 
virtual void childEvent (QChildEvent *event)
 This event handler can be reimplemented in a subclass to receive child events.
 
virtual void customEvent (QEvent *event)
 This event handler can be reimplemented in a subclass to receive custom events.
 
virtual void connectNotify (const QMetaMethod &signal)
 
virtual void disconnectNotify (const QMetaMethod &signal)
 
 QObject (QObjectPrivate &dd, QObject *parent=nullptr)
 

Additional Inherited Members

- Signals inherited from QSqlTableModel
void primeInsert (int row, QSqlRecord &record)
 This signal is emitted by insertRows(), when an insertion is initiated in the given row of the currently active database table.
 
void beforeInsert (QSqlRecord &record)
 This signal is emitted by insertRowIntoTable() before a new row is inserted into the currently active database table.
 
void beforeUpdate (int row, QSqlRecord &record)
 This signal is emitted by updateRowInTable() before the row is updated in the currently active database table with the values from record.
 
void beforeDelete (int row)
 This signal is emitted by deleteRowFromTable() before the row is deleted from the currently active database table.
 
- Signals inherited from QAbstractItemModel
void dataChanged (const QModelIndex &topLeft, const QModelIndex &bottomRight, const QList< int > &roles=QList< int >())
 This signal is emitted whenever the data in an existing item changes.
 
void headerDataChanged (Qt::Orientation orientation, int first, int last)
 This signal is emitted whenever a header is changed.
 
void layoutChanged (const QList< QPersistentModelIndex > &parents=QList< QPersistentModelIndex >(), QAbstractItemModel::LayoutChangeHint hint=QAbstractItemModel::NoLayoutChangeHint)
 
void layoutAboutToBeChanged (const QList< QPersistentModelIndex > &parents=QList< QPersistentModelIndex >(), QAbstractItemModel::LayoutChangeHint hint=QAbstractItemModel::NoLayoutChangeHint)
 
void rowsAboutToBeInserted (const QModelIndex &parent, int first, int last, QPrivateSignal)
 This signal is emitted just before rows are inserted into the model.
 
void rowsInserted (const QModelIndex &parent, int first, int last, QPrivateSignal)
 This signal is emitted after rows have been inserted into the model.
 
void rowsAboutToBeRemoved (const QModelIndex &parent, int first, int last, QPrivateSignal)
 This signal is emitted just before rows are removed from the model.
 
void rowsRemoved (const QModelIndex &parent, int first, int last, QPrivateSignal)
 This signal is emitted after rows have been removed from the model.
 
void columnsAboutToBeInserted (const QModelIndex &parent, int first, int last, QPrivateSignal)
 This signal is emitted just before columns are inserted into the model.
 
void columnsInserted (const QModelIndex &parent, int first, int last, QPrivateSignal)
 This signal is emitted after columns have been inserted into the model.
 
void columnsAboutToBeRemoved (const QModelIndex &parent, int first, int last, QPrivateSignal)
 This signal is emitted just before columns are removed from the model.
 
void columnsRemoved (const QModelIndex &parent, int first, int last, QPrivateSignal)
 This signal is emitted after columns have been removed from the model.
 
void modelAboutToBeReset (QPrivateSignal)
 
void modelReset (QPrivateSignal)
 
void rowsAboutToBeMoved (const QModelIndex &sourceParent, int sourceStart, int sourceEnd, const QModelIndex &destinationParent, int destinationRow, QPrivateSignal)
 
void rowsMoved (const QModelIndex &sourceParent, int sourceStart, int sourceEnd, const QModelIndex &destinationParent, int destinationRow, QPrivateSignal)
 
void columnsAboutToBeMoved (const QModelIndex &sourceParent, int sourceStart, int sourceEnd, const QModelIndex &destinationParent, int destinationColumn, QPrivateSignal)
 
void columnsMoved (const QModelIndex &sourceParent, int sourceStart, int sourceEnd, const QModelIndex &destinationParent, int destinationColumn, QPrivateSignal)
 
- Signals inherited from QObject
void destroyed (QObject *=nullptr)
 This signal is emitted immediately before the object obj is destroyed, after any instances of QPointer have been notified, and cannot be blocked.
 
void objectNameChanged (const QString &objectName, QPrivateSignal)
 This signal is emitted after the object's name has been changed.
 
- Static Public Member Functions inherited from QObject
static QMetaObject::Connection connect (const QObject *sender, const char *signal, const QObject *receiver, const char *member, Qt::ConnectionType=Qt::AutoConnection)
 \threadsafe
 
static QMetaObject::Connection connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type=Qt::AutoConnection)
 
template<typename Func1 , typename Func2 >
static QMetaObject::Connection connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const typename QtPrivate::ContextTypeForFunctor< Func2 >::ContextType *context, Func2 &&slot, Qt::ConnectionType type=Qt::AutoConnection)
 
template<typename Func1 , typename Func2 >
static QMetaObject::Connection connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, Func2 &&slot)
 
static bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *member)
 \threadsafe
 
static bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &member)
 
static bool disconnect (const QMetaObject::Connection &)
 Disconnect a connection.
 
template<typename Func1 , typename Func2 >
static bool disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const typename QtPrivate::FunctionPointer< Func2 >::Object *receiver, Func2 slot)
 
template<typename Func1 >
static bool disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const QObject *receiver, void **zero)
 
- Public Attributes inherited from QAbstractItemModel
Q_INVOKABLE int count
 
Q_INVOKABLE int const QModelIndex & parent = QModelIndex())
 Returns the parent of the model item with the given index.
 
Q_INVOKABLE int sourceRow
 
Q_INVOKABLE int int count
 
Q_INVOKABLE int int const QModelIndex & destinationParent
 
Q_INVOKABLE int int const QModelIndex int destinationChild
 
Q_INVOKABLE int sourceColumn
 
Q_INVOKABLE const QModelIndex & parent = QModelIndex())
 
Q_INVOKABLE int const QModelIndex & destinationParent
 
Q_INVOKABLE int const QModelIndex int destinationChild
 
Q_INVOKABLE Qt::SortOrder order = Qt::AscendingOrder)
 
- Protected Slots inherited from QAbstractItemModel
virtual void resetInternalData ()
 
- Protected Attributes inherited from QObject
QScopedPointer< QObjectData > d_ptr
 
- Properties inherited from QObject
QString objectName
 the name of this object
 
- Related Symbols inherited from QObject
template< class T > T qobject_cast (const QObject *object)
 Returns the given object cast to type T if the object is of type T (or of a subclass); otherwise returns \nullptr.
 
template< typename T > T qFindChildqFindChildren (const QObject *obj, const QString &name)()
 
template< typename T > QList< T > qFindChildrenqFindChildren (const QObject *obj, const QString &name)()
 
 QObjectList
 \macro Q_CLASSINFO(Name, Value)
 

Detailed Description

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

\inmodule QtSql

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

\table \row

  • \inlineimage noforeignkeys.png
  • \inlineimage foreignkeys.png \endtable

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:

\codeline

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:

The \l{relationaltablemodel} example illustrates how to use QSqlRelationalTableModel in conjunction with QSqlRelationalDelegate to provide tables with foreign key support.

Notes:

\list

  • 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 relational table, or if it is used as display column name in more than one relation it will be aliased. The alias is the relation's table name, display column name and a unique id joined by an underscore (e.g. tablename_columnname_id). QSqlRecord::fieldName() will return the aliased column name. 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.
  • The reference table name is aliased. The alias is the word "relTblAl" and the relationed column index joined by an underscore (e.g. relTblAl_2). The alias can be used to filter the table (For example, setFilter("relTblAl_2='Oslo' OR relTblAl_3='USA'")).
  • When using setData() the role should always be Qt::EditRole, and when using data() the role should always be Qt::DisplayRole. \endlist
See also
QSqlRelation, QSqlRelationalDelegate, {Relational Table Model Example}

Definition at line 47 of file qsqlrelationaltablemodel.h.

Member Enumeration Documentation

◆ JoinMode

enum QSqlRelationalTableModel::JoinMode

\value InnerJoin - Inner join mode, return rows when there is at least one match in both tables.

\value LeftJoin - Left join mode, returns all rows from the left table (table_name1), even if there are no matches in the right table (table_name2).

See also
QSqlRelationalTableModel::setJoinMode()
Since
4.8
Enumerator
InnerJoin 
LeftJoin 

Definition at line 52 of file qsqlrelationaltablemodel.h.

Constructor & Destructor Documentation

◆ QSqlRelationalTableModel()

QSqlRelationalTableModel::QSqlRelationalTableModel ( QObject *  parent = nullptr,
const QSqlDatabase &  db = QSqlDatabase() 
)
explicit

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.

Definition at line 379 of file qsqlrelationaltablemodel.cpp.

◆ ~QSqlRelationalTableModel()

QSqlRelationalTableModel::~QSqlRelationalTableModel ( )
virtual

Destroys the object and frees any allocated resources.

Definition at line 387 of file qsqlrelationaltablemodel.cpp.

Member Function Documentation

◆ clear()

void QSqlRelationalTableModel::clear ( )
overridevirtual

\reimp

Reimplemented from QSqlQueryModel.

Definition at line 630 of file qsqlrelationaltablemodel.cpp.

References QSqlQueryModel::beginResetModel(), QSqlTableModel::clear(), d, and QSqlQueryModel::endResetModel().

+ Here is the call graph for this function:

◆ data()

QVariant QSqlRelationalTableModel::data ( const QModelIndex &  item,
int  role = Qt::DisplayRole 
) const
overridevirtual

\reimp

Reimplemented from QSqlQueryModel.

Definition at line 394 of file qsqlrelationaltablemodel.cpp.

References d, QSqlTableModel::data(), QSqlTableModelPrivate::Delete, Qt::DisplayRole, QSqlTableModelPrivate::None, QSqlTableModel::OnFieldChange, QSqlTableModel::OnManualSubmit, relation(), and QVariant::value().

+ Here is the call graph for this function:

◆ insertRowIntoTable()

bool QSqlRelationalTableModel::insertRowIntoTable ( const QSqlRecord &  values)
overrideprotectedvirtual

\reimp

Reimplemented from QSqlTableModel.

Definition at line 715 of file qsqlrelationaltablemodel.cpp.

References d, and QSqlTableModel::insertRowIntoTable().

+ Here is the call graph for this function:

◆ orderByClause()

QString QSqlRelationalTableModel::orderByClause ( ) const
overrideprotectedvirtual

\reimp

Reimplemented from QSqlTableModel.

Definition at line 728 of file qsqlrelationaltablemodel.cpp.

References QSqlQueryModelSql::asc(), Qt::AscendingOrder, d, QSqlQueryModelSql::desc(), QSqlRelation::displayColumn(), QSqlRelation::isValid(), QSqlQueryModelSql::orderBy(), QSqlTableModel::orderByClause(), and QSqlRelationalTableModelSql::relTablePrefix().

Referenced by selectStatement().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ relation()

QSqlRelation QSqlRelationalTableModel::relation ( int  column) const

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

See also
setRelation(), QSqlRelation::isValid()

Definition at line 486 of file qsqlrelationaltablemodel.cpp.

References d.

Referenced by data(), relationModel(), selectStatement(), setData(), and setRelation().

+ Here is the caller graph for this function:

◆ relationModel()

QSqlTableModel * QSqlRelationalTableModel::relationModel ( int  column) const
virtual

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

The returned object is owned by the QSqlRelationalTableModel.

See also
setRelation(), relation()

Definition at line 604 of file qsqlrelationaltablemodel.cpp.

References d, QSqlRelation::isValid(), and relation().

+ Here is the call graph for this function:

◆ removeColumns()

bool QSqlRelationalTableModel::removeColumns ( int  column,
int  count,
const QModelIndex &  parent = QModelIndex() 
)
override

\reimp

Definition at line 744 of file qsqlrelationaltablemodel.cpp.

References d, i, QAbstractTableModel::parent(), and QSqlTableModel::removeColumns().

+ Here is the call graph for this function:

◆ revertRow

void QSqlRelationalTableModel::revertRow ( int  row)
overrideslot

\reimp

Definition at line 622 of file qsqlrelationaltablemodel.cpp.

References QSqlTableModel::revertRow().

+ Here is the call graph for this function:

◆ select()

bool QSqlRelationalTableModel::select ( )
overridevirtual

\reimp

Reimplemented from QSqlTableModel.

Definition at line 666 of file qsqlrelationaltablemodel.cpp.

References QSqlTableModel::select().

+ Here is the call graph for this function:

◆ selectStatement()

QString QSqlRelationalTableModel::selectStatement ( ) const
overrideprotectedvirtual

\reimp

Reimplemented from QSqlTableModel.

Definition at line 505 of file qsqlrelationaltablemodel.cpp.

References QString::arg(), QSqlQueryModelSql::as(), Qt::CaseInsensitive, QSqlQueryModelSql::comma(), QSqlQueryModelSql::concat(), QSqlRecord::count(), d, QSqlTableModel::database(), QSqlRelation::displayColumn(), QSqlQueryModelSql::eq(), QSqlQueryModelSql::et(), QSqlDriver::FieldName, QSqlRecord::fieldName(), QSqlTableModel::filter(), QSqlQueryModelSql::from(), QChar::fromLatin1(), QString::fromLatin1(), i, QSqlRelation::indexColumn(), InnerJoin, QString::isEmpty(), QSqlRelation::isValid(), QSqlQueryModelSql::leftJoin(), QString::number(), QSqlQueryModelSql::on(), orderByClause(), QSqlQueryModelSql::paren(), QSqlDatabase::record(), relation(), QSqlRelationalTableModelSql::relTablePrefix(), QString::section(), QSqlQueryModelSql::select(), QSqlTableModel::selectStatement(), QSqlDriver::TableName, QSqlRelation::tableName(), QSqlTableModel::tableName(), QString::truncate(), QHash< Key, T >::value(), and QSqlQueryModelSql::where().

+ Here is the call graph for this function:

◆ setData()

bool QSqlRelationalTableModel::setData ( const QModelIndex &  index,
const QVariant &  value,
int  role = Qt::EditRole 
)
overridevirtual

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(), revertRow()

Reimplemented from QAbstractItemModel.

Definition at line 437 of file qsqlrelationaltablemodel.cpp.

References d, Qt::EditRole, relation(), and QSqlTableModel::setData().

+ Here is the call graph for this function:

◆ setJoinMode()

void QSqlRelationalTableModel::setJoinMode ( QSqlRelationalTableModel::JoinMode  joinMode)

Sets the SQL joinMode to show or hide rows with NULL foreign keys.

In InnerJoin mode (the default) these rows will not be shown: use the LeftJoin mode if you want to show them.

See also
QSqlRelationalTableModel::JoinMode
Since
4.8

Definition at line 658 of file qsqlrelationaltablemodel.cpp.

References d.

◆ setRelation()

void QSqlRelationalTableModel::setRelation ( int  column,
const QSqlRelation &  relation 
)
virtual

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

Example:

\codeline

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

Definition at line 470 of file qsqlrelationaltablemodel.cpp.

References d, and relation().

+ Here is the call graph for this function:

◆ setTable()

void QSqlRelationalTableModel::setTable ( const QString &  tableName)
overridevirtual

\reimp

Reimplemented from QSqlTableModel.

Definition at line 674 of file qsqlrelationaltablemodel.cpp.

References d, and QSqlTableModel::setTable().

+ Here is the call graph for this function:

◆ updateRowInTable()

bool QSqlRelationalTableModel::updateRowInTable ( int  row,
const QSqlRecord &  values 
)
overrideprotectedvirtual

\reimp

Reimplemented from QSqlTableModel.

Definition at line 702 of file qsqlrelationaltablemodel.cpp.

References d, and QSqlTableModel::updateRowInTable().

+ Here is the call graph for this function:
The documentation for this class was generated from the following files: