Qt
Internal/Contributor docs for the Qt SDK. <b>Note:</b> These are NOT official API docs; those are found <a href='https://doc.qt.io/'>here</a>.
Loading...
Searching...
No Matches
QSqlQueryModel Class Reference

The QSqlQueryModel class provides a read-only data model for SQL result sets. More...

#include <qsqlquerymodel.h>

+ Inheritance diagram for QSqlQueryModel:
+ Collaboration diagram for QSqlQueryModel:

Public Member Functions

 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
 If the database supports returning the size of a query (see QSqlDriver::hasFeature()), the number of rows of the current query is returned.
 
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 QSqlQueryquery (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
 Fetches more rows from a database.
 
bool canFetchMore (const QModelIndex &parent=QModelIndex()) const override
 Returns true if it is possible to read more rows from the database.
 
QHash< int, QByteArrayroleNames () 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
 
QObjectparent () 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 bool setData (const QModelIndex &index, const QVariant &value, int role=Qt::EditRole)
 Sets the role data for the item at index to value.
 
virtual QMap< int, QVariantitemData (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 QMimeDatamimeData (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 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
 
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.
 
bool checkIndex (const QModelIndex &index, CheckIndexOptions options=CheckIndexOption::NoOption) const
 
virtual void multiData (const QModelIndex &index, QModelRoleDataSpan roleDataSpan) const
 
QObjectparent () 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< QStringbindableObjectName ()
 
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).
 
QThreadthread () const
 Returns the thread in which the object lives.
 
bool moveToThread (QThread *thread QT6_DECL_NEW_OVERLOAD_TAIL)
 Changes the thread affinity for this object and its children and returns true on success.
 
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::nanoseconds time, Qt::TimerType timerType=Qt::CoarseTimer)
 
void killTimer (int id)
 Kills the timer with timer identifier, id.
 
void killTimer (Qt::TimerId id)
 
template<typename T >
findChild (QAnyStringView aName, 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 (QAnyStringView 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 >
findChild (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.
 
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 QObjectListchildren () 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< QByteArraydynamicPropertyNames () const
 
QBindingStoragebindingStorage ()
 
const QBindingStoragebindingStorage () const
 
QObjectparent () 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

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

- 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 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
 
- 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 QModelIndexparent = 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 QModelIndexdestinationParent
 
Q_INVOKABLE int int const QModelIndex int destinationChild
 
Q_INVOKABLE int sourceColumn
 
Q_INVOKABLE const QModelIndexparent = QModelIndex())
 
Q_INVOKABLE int const QModelIndexdestinationParent
 
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< QObjectDatad_ptr
 
- Properties inherited from QObject
QString objectName
 the name of this object
 

Detailed Description

The QSqlQueryModel class provides a read-only data model for SQL result sets.

\inmodule QtSql

QSqlQueryModel is a high-level interface for executing SQL statements and traversing the result set. It is built on top of the lower-level QSqlQuery and can be used to provide data to view classes such as QTableView. For example:

model->setQuery("SELECT name, salary FROM employee");
view->show();

We set the model's query, then we set up the labels displayed in the view header.

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

model.setQuery("SELECT name, salary FROM employee");
int salary = model.record(4).value("salary").toInt();

The code snippet above extracts the salary field from record 4 in the result set of the SELECT query. Since salary is the 2nd column (or column index 1), we can rewrite the last line as follows:

The model is read-only by default. To make it read-write, you must subclass it and reimplement setData() and flags(). Another option is to use QSqlTableModel, which provides a read-write model based on a single database table.

The \l{querymodel} example illustrates how to use QSqlQueryModel to display the result of a query. It also shows how to subclass QSqlQueryModel to customize the contents of the data before showing it to the user, and how to create a read-write model based on QSqlQueryModel.

If the database doesn't return the number of selected rows in a query, the model will fetch rows incrementally. See fetchMore() for more information.

See also
QSqlTableModel, QSqlRelationalTableModel, QSqlQuery, {Model/View Programming}, {Query Model Example}

Definition at line 20 of file qsqlquerymodel.h.

Constructor & Destructor Documentation

◆ QSqlQueryModel() [1/2]

QSqlQueryModel::QSqlQueryModel ( QObject * parent = nullptr)
explicit

Creates an empty QSqlQueryModel with the given parent.

Definition at line 120 of file qsqlquerymodel.cpp.

◆ ~QSqlQueryModel()

QSqlQueryModel::~QSqlQueryModel ( )
virtual

Destroys the object and frees any allocated resources.

See also
clear()

Definition at line 137 of file qsqlquerymodel.cpp.

◆ QSqlQueryModel() [2/2]

QSqlQueryModel::QSqlQueryModel ( QSqlQueryModelPrivate & dd,
QObject * parent = nullptr )
protected

Definition at line 127 of file qsqlquerymodel.cpp.

Member Function Documentation

◆ beginInsertColumns()

void QSqlQueryModel::beginInsertColumns ( const QModelIndex & parent,
int first,
int last )
protected

Definition at line 239 of file qsqlquerymodel.cpp.

References QAbstractItemModel::beginInsertColumns(), d, and QAbstractTableModel::parent().

Referenced by insertColumns().

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

◆ beginInsertRows()

void QSqlQueryModel::beginInsertRows ( const QModelIndex & parent,
int first,
int last )
protected

Definition at line 203 of file qsqlquerymodel.cpp.

References QAbstractItemModel::beginInsertRows(), d, and QAbstractTableModel::parent().

Referenced by QSqlTableModel::insertRows().

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

◆ beginRemoveColumns()

void QSqlQueryModel::beginRemoveColumns ( const QModelIndex & parent,
int first,
int last )
protected

Definition at line 257 of file qsqlquerymodel.cpp.

References QAbstractItemModel::beginRemoveColumns(), d, and QAbstractTableModel::parent().

Referenced by removeColumns().

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

◆ beginRemoveRows()

void QSqlQueryModel::beginRemoveRows ( const QModelIndex & parent,
int first,
int last )
protected

Definition at line 221 of file qsqlquerymodel.cpp.

References QAbstractItemModel::beginRemoveRows(), d, and QAbstractTableModel::parent().

+ Here is the call graph for this function:

◆ beginResetModel()

void QSqlQueryModel::beginResetModel ( )
protected

Definition at line 275 of file qsqlquerymodel.cpp.

References QAbstractItemModel::beginResetModel(), and d.

Referenced by clear(), QSqlRelationalTableModel::clear(), QSqlTableModel::clear(), QSqlTableModel::select(), and setQuery().

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

◆ canFetchMore()

bool QSqlQueryModel::canFetchMore ( const QModelIndex & parent = QModelIndex()) const
overridevirtual

Returns true if it is possible to read more rows from the database.

This only affects databases that don't report back the size of a query (see QSqlDriver::hasFeature()).

parent should always be an invalid QModelIndex.

See also
fetchMore()

Reimplemented from QAbstractItemModel.

Definition at line 171 of file qsqlquerymodel.cpp.

References d, and QAbstractTableModel::parent().

+ Here is the call graph for this function:

◆ clear()

void QSqlQueryModel::clear ( )
virtual

Clears the model and releases any acquired resource.

Reimplemented in QSqlRelationalTableModel, and QSqlTableModel.

Definition at line 475 of file qsqlquerymodel.cpp.

References beginResetModel(), d, and endResetModel().

Referenced by QSqlTableModel::clear(), and QQmlTableModel::columns_clear().

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

◆ columnCount()

◆ data()

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

Returns the value for the specified item and role.

If item is out of bounds or if an error occurred, an invalid QVariant is returned.

See also
lastError()

Implements QAbstractItemModel.

Reimplemented in QSqlTableModel, and QSqlRelationalTableModel.

Definition at line 326 of file qsqlquerymodel.cpp.

References d, Qt::DisplayRole, Qt::EditRole, QSqlQueryModelPrivate::error, indexInQuery(), and item.

Referenced by QSqlTableModel::data(), QSortedModelEngine::filter(), for(), main(), QSqlQueryModel_snippets(), QItemDelegate::setModelData(), QStyledItemDelegate::setModelData(), QSortedModelEngine::sortOrder(), and QTestPrivate::testDataGuiRoles().

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

◆ endInsertColumns()

void QSqlQueryModel::endInsertColumns ( )
protected

Definition at line 248 of file qsqlquerymodel.cpp.

References d, and QAbstractItemModel::endInsertColumns().

Referenced by insertColumns().

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

◆ endInsertRows()

void QSqlQueryModel::endInsertRows ( )
protected

Definition at line 212 of file qsqlquerymodel.cpp.

References d, and QAbstractItemModel::endInsertRows().

Referenced by QSqlTableModel::insertRows().

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

◆ endRemoveColumns()

void QSqlQueryModel::endRemoveColumns ( )
protected

Definition at line 266 of file qsqlquerymodel.cpp.

References d, and QAbstractItemModel::endRemoveColumns().

Referenced by removeColumns().

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

◆ endRemoveRows()

void QSqlQueryModel::endRemoveRows ( )
protected

Definition at line 230 of file qsqlquerymodel.cpp.

References d, and QAbstractItemModel::endRemoveRows().

Referenced by QTreeWidgetItem::takeChild().

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

◆ endResetModel()

void QSqlQueryModel::endResetModel ( )
protected

Definition at line 285 of file qsqlquerymodel.cpp.

References d, and QAbstractItemModel::endResetModel().

Referenced by clear(), QSqlRelationalTableModel::clear(), QSqlTableModel::clear(), QSqlTableModel::select(), and setQuery().

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

◆ fetchMore()

void QSqlQueryModel::fetchMore ( const QModelIndex & parent = QModelIndex())
overridevirtual

Fetches more rows from a database.

This only affects databases that don't report back the size of a query (see QSqlDriver::hasFeature()).

To force fetching of the entire result set, you can use the following:

while (myModel->canFetchMore())
myModel->fetchMore();

parent should always be an invalid QModelIndex.

See also
canFetchMore()

Reimplemented from QAbstractItemModel.

Definition at line 154 of file qsqlquerymodel.cpp.

References d, QAbstractTableModel::parent(), qMax(), and QSQL_PREFETCH.

Referenced by MyModel::fetchModel(), and setQuery().

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

◆ headerData()

QVariant QSqlQueryModel::headerData ( int section,
Qt::Orientation orientation,
int role = Qt::DisplayRole ) const
overridevirtual

Returns the header data for the given role in the section of the header with the specified orientation.

Reimplemented from QAbstractItemModel.

Reimplemented in QSqlTableModel.

Definition at line 354 of file qsqlquerymodel.cpp.

References d, Qt::DisplayRole, Qt::EditRole, QAbstractItemModel::headerData(), Qt::Horizontal, and QVariant::value().

Referenced by QSqlTableModel::headerData().

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

◆ indexInQuery()

QModelIndex QSqlQueryModel::indexInQuery ( const QModelIndex & item) const
protectedvirtual

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
QSqlTableModel::indexInQuery(), insertColumns(), removeColumns()

Reimplemented in QSqlTableModel.

Definition at line 669 of file qsqlquerymodel.cpp.

References QAbstractItemModel::createIndex(), d, and item.

Referenced by data(), and QSqlTableModel::indexInQuery().

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

◆ insertColumns()

bool QSqlQueryModel::insertColumns ( int column,
int count,
const QModelIndex & parent = QModelIndex() )
override

Inserts count columns into the model at position column.

The parent parameter must always be an invalid QModelIndex, since the model does not support parent-child relationships.

Returns true if column is within bounds; otherwise returns false.

By default, inserted columns are empty. To fill them with data, reimplement data() and handle any inserted column separately:

QVariant MyModel::data(const QModelIndex &item, int role) const
{
if (item.column() == m_specialColumnNo) {
// handle column separately
}
return QSqlQueryModel::data(item, role);
}
See also
removeColumns()

Definition at line 604 of file qsqlquerymodel.cpp.

References beginInsertColumns(), QAbstractItemModel::count, d, endInsertColumns(), i, QAbstractTableModel::parent(), Q_ASSERT, QSqlField::setGenerated(), and QSqlField::setReadOnly().

+ Here is the call graph for this function:

◆ lastError()

QSqlError QSqlQueryModel::lastError ( ) const

Returns information about the last error that occurred on the database.

See also
query()

Definition at line 534 of file qsqlquerymodel.cpp.

References d.

Referenced by checkSqlQueryModel(), MyModel::fetchModel(), and QSqlTableModel::select().

+ Here is the caller graph for this function:

◆ query()

const QSqlQuery & QSqlQueryModel::query ( QT6_DECL_NEW_OVERLOAD ) const

Returns a reference to the const QSqlQuery object associated with this model.

See also
setQuery()

Definition at line 522 of file qsqlquerymodel.cpp.

References d.

◆ queryChange()

void QSqlQueryModel::queryChange ( )
protectedvirtual

This virtual function is called whenever the query changes.

The default implementation does nothing.

query() returns the new query.

See also
query(), setQuery()

Definition at line 377 of file qsqlquerymodel.cpp.

Referenced by setQuery().

+ Here is the caller graph for this function:

◆ record() [1/2]

QSqlRecord QSqlQueryModel::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.

If the model is not initialized, an empty record will be returned.

See also
QSqlRecord::isEmpty()

Definition at line 584 of file qsqlquerymodel.cpp.

References d.

Referenced by QSqlTableModel::primaryValues(), QSqlTableModel::record(), QSqlTableModel::record(), QSqlTableModel::removeRows(), QSqlTableModel::setData(), and QSqlTableModel::setRecord().

+ Here is the caller graph for this function:

◆ record() [2/2]

QSqlRecord QSqlQueryModel::record ( int row) const

Returns the record containing information about the fields of the current query.

If row is the index of a valid row, the record will be populated with values from that row.

If the model is not initialized, an empty record will be returned.

See also
QSqlRecord::isEmpty()

Definition at line 562 of file qsqlquerymodel.cpp.

References QSqlRecord::count(), QAbstractItemModel::createIndex(), d, Qt::EditRole, i, and QSqlRecord::setValue().

Referenced by QSqlQueryModel_snippets(), QSqlTableModel_snippets(), and sql_intro_snippets().

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

◆ removeColumns()

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

Removes count columns from the model starting from position column.

The parent parameter must always be an invalid QModelIndex, since the model does not support parent-child relationships.

Removing columns effectively hides them. It does not affect the underlying QSqlQuery.

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

Definition at line 639 of file qsqlquerymodel.cpp.

References beginRemoveColumns(), QAbstractItemModel::count, d, endRemoveColumns(), i, and QAbstractTableModel::parent().

+ Here is the call graph for this function:

◆ roleNames()

QHash< int, QByteArray > QSqlQueryModel::roleNames ( ) const
overridevirtual
Since
5.10 \reimp

Returns the model's role names.

Qt defines only one role for the QSqlQueryModel:

\table \header

Reimplemented from QAbstractItemModel.

Definition at line 194 of file qsqlquerymodel.cpp.

References Qt::DisplayRole, and QByteArrayLiteral.

◆ rowCount()

int QSqlQueryModel::rowCount ( const QModelIndex & parent = QModelIndex()) const
overridevirtual

If the database supports returning the size of a query (see QSqlDriver::hasFeature()), the number of rows of the current query is returned.

Otherwise, returns the number of rows currently cached on the client.

parent should always be an invalid QModelIndex.

See also
canFetchMore(), QSqlDriver::hasFeature()

Implements QAbstractItemModel.

Reimplemented in QSqlTableModel.

Definition at line 304 of file qsqlquerymodel.cpp.

References d.

Referenced by QListWidgetItem::QListWidgetItem(), QListWidgetItem::QListWidgetItem(), QListWidgetItem::QListWidgetItem(), QAbstractProxyModelPrivate::_q_sourceModelRowsAboutToBeInserted(), QAbstractProxyModelPrivate::_q_sourceModelRowsRemoved(), QItemSelectionModelPrivate::columnsAboutToBeRemoved(), QConcatenateTablesProxyModelPrivate::computeRowsPrior(), QSortFilterProxyModelPrivate::create_mapping(), QItemSelectionModelPrivate::expandSelection(), QUnsortedModelEngine::filter(), QCompletionEngine::filter(), QUnsortedModelEngine::filterOnDemand(), QSortedModelEngine::indexHint(), QItemSelectionModelPrivate::layoutAboutToBeChanged(), QItemSelectionModelPrivate::layoutChanged(), main(), QAbstractProxyModelPrivate::mapDropCoordinatesToSource(), QSqlQueryModel_snippets(), QSortFilterProxyModelPrivate::recursiveChildAcceptsRow(), QSqlTableModel::rowCount(), QSortedModelEngine::sortOrder(), QSortFilterProxyModelPrivate::source_items_inserted(), QConcatenateTablesProxyModelPrivate::sourceModelForRow(), sql_intro_snippets(), and src_gui_itemviews_qstandarditemmodel::wrapper0().

+ Here is the caller graph for this function:

◆ setHeaderData()

bool QSqlQueryModel::setHeaderData ( int section,
Qt::Orientation orientation,
const QVariant & value,
int role = Qt::EditRole )
overridevirtual

Sets the caption for a horizontal header for the specified role to value.

This is useful if the model is used to display data in a view (e.g., QTableView).

Returns true if orientation is Qt::Horizontal and the section refers to a valid section; otherwise returns false.

Note that this function cannot be used to modify values in the database since the model is read-only.

See also
data()

Reimplemented from QAbstractItemModel.

Definition at line 503 of file qsqlquerymodel.cpp.

References columnCount(), d, emit, QAbstractItemModel::headerDataChanged(), Qt::Horizontal, and qMax().

Referenced by QSqlTableModel_snippets().

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

◆ setLastError()

void QSqlQueryModel::setLastError ( const QSqlError & error)
protected

Protected function which allows derived classes to set the value of the last error that occurred on the database to error.

See also
lastError()

Definition at line 546 of file qsqlquerymodel.cpp.

References d, and error.

◆ setQuery() [1/2]

void QSqlQueryModel::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.

If no database (or an invalid database) is specified, the default connection is used.

lastError() can be used to retrieve verbose information if there was an error setting the query.

Example:

model.setQuery("select * from MyTable");
See also
query(), queryChange(), lastError()

Definition at line 467 of file qsqlquerymodel.cpp.

References db, and setQuery().

+ Here is the call graph for this function:

◆ setQuery() [2/2]

void QSqlQueryModel::setQuery ( QSqlQuery && query)

Resets the model and sets the data provider to be the given query.

Note that the query must be active and must not be isForwardOnly().

lastError() can be used to retrieve verbose information if there was an error setting the query.

Note
Calling setQuery() will remove any inserted columns.
Since
6.2
See also
query(), QSqlQuery::isActive(), QSqlQuery::setForwardOnly(), lastError()

Definition at line 408 of file qsqlquerymodel.cpp.

References beginResetModel(), QSqlError::ConnectionError, QAbstractItemModel::createIndex(), d, endResetModel(), fetchMore(), queryChange(), and QSqlDriver::QuerySize.

Referenced by checkSqlQueryModel(), MyModel::fetchModel(), QSqlQueryModel_snippets(), QSqlTableModel::select(), setQuery(), and sql_intro_snippets().

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

The documentation for this class was generated from the following files: