Класс QSqlRelationalTableModel
Класс QSqlRelationalTableModel предоставляет редактируемую модель данных для одной таблицы базы данных с поддержкой внешних ключей. Подробнее...
| Заголовок: | #include <QSqlRelationalTableModel> |
| CMake: | find_package(Qt6 COMPONENTS Sql REQUIRED) target_link_libraries(mytarget PRIVATE Qt6::Sql) |
| qmake: | QT += sql |
| Наследует: | QSqlTableModel |
Типы
| перечисление | JoinMode { InnerJoin, LeftJoin } |
Общедоступные функции
| QSqlRelationalTableModel(QObject *parent = nullptr, const QSqlDatabase &db = QSqlDatabase()) | |
| виртуальный | ~QSqlRelationalTableModel() |
| QSqlRelation | relation(int column) const |
| виртуальный QSqlTableModel * | relationModel(int column) const |
| void | setJoinMode(QSqlRelationalTableModel::JoinMode joinMode) |
| виртуальный void | setRelation(int column, const QSqlRelation &relation) |
Переопределенные общедоступные функции
| виртуальный void | clear() override |
| виртуальный QVariant | data(const QModelIndex &index, int role = Qt::DisplayRole) const override |
| виртуальный bool | removeColumns(int column, int count, const QModelIndex &parent = QModelIndex()) override |
| виртуальный bool | select() override |
| виртуальный bool | setData(const QModelIndex &index, const QVariant &value, int role = Qt::EditRole) override |
| виртуальный void | setTable(const QString &table) override |
Открытые слоты
| виртуальный void | revertRow(int row) override |
Переопределенные защищенные функции
| виртуальный bool | insertRowIntoTable(const QSqlRecord &values) override |
| виртуальный QString | orderByClause() const override |
| виртуальный QString | selectStatement() const override |
| виртуальный bool | updateRowInTable(int row, const QSqlRecord &values) override |
Подробное описание
QSqlRelationalTableModel ведет себя как QSqlTableModel, но позволяет задавать столбцы как внешние ключи в другие таблицы базы данных.
На левом снимке показан обычный QSqlTableModel в QTableView. Внешние ключи (city и country) не разрешаются в удобочитаемые значения. На правом снимке показан QSqlRelationalTableModel, где внешние ключи разрешены в удобочитаемые текстовые строки.
Следующий фрагмент кода демонстрирует, как был настроен QSqlRelationalTableModel:
model->setTable("employee");
model->setRelation(2, QSqlRelation("city", "id", "name"));
model->setRelation(3, QSqlRelation("country", "id", "name")); Функция setRelation() устанавливает связь между двумя таблицами. Первый вызов указывает, что столбец 2 в таблице employee является внешним ключом, который сопоставляется с полем id таблицы city, и что представление должно отображать поле city's name пользователю. Второй вызов выполняет аналогичную операцию со столбцом 3.
Если вы используете QSqlRelationalTableModel для чтения и записи, то, вероятно, вам следует использовать QSqlRelationalDelegate в представлении. В отличие от стандартного делегата, QSqlRelationalDelegate предоставляет раскрывающийся список для полей, являющихся внешними ключами в другие таблицы. Для использования класса, просто вызовите QAbstractItemView::setItemDelegate() в представлении с экземпляром QSqlRelationalDelegate:
std::unique_ptr<QTableView> view{new QTableView};
view->setModel(model);
view->setItemDelegate(new QSqlRelationalDelegate(view.get())); Пример relationaltablemodel демонстрирует, как использовать QSqlRelationalTableModel совместно с QSqlRelationalDelegate для предоставления таблиц с поддержкой внешних ключей.
Примечания:
- Таблица должна иметь объявленный первичный ключ.
- Первичный ключ таблицы не может содержать отношение к другой таблице.
- Если реляционная таблица содержит ключи, которые ссылаются на несуществующие строки в связанной таблице, строки, содержащие недействительные ключи, не будут отображаться через модель. Пользователь или база данных отвечает за поддержание целостности ссылок.
- Если имя столбца отображения отношения также используется в качестве имени столбца в реляционной таблице или используется в качестве имени столбца отображения более чем в одном отношении, оно будет переименовано. Псевдоним - это имя таблицы отношения, имя столбца отображения и уникальный идентификатор, соединенные подчеркиванием (например, tablename_columnname_id). QSqlRecord::fieldName() вернёт переименованное имя столбца. Все случаи дублирования имени столбца отображения переименовываются при обнаружении дублирования, но переименования имён столбцов в основной таблице не выполняется. Переименование не влияет на QSqlRelation, поэтому QSqlRelation::displayColumn() вернёт исходное имя столбца отображения.
- Имя таблицы ссылки переименовывается. Псевдоним - это слово "relTblAl", а индекс связанного столбца объединяется подчеркиванием (например, relTblAl_2). Псевдоним можно использовать для фильтрации таблицы (например, setFilter("relTblAl_2='Oslo' OR relTblAl_3='USA'")).
- При использовании setData() роль всегда должна быть Qt::EditRole, а при использовании data() роль всегда должна быть Qt::DisplayRole.
См. также QSqlRelation, QSqlRelationalDelegate и Пример реляционной модели таблицы.
Документация по типам членов
перечисление QSqlRelationalTableModel::JoinMode
| Постоянная | Значение | Описание |
|---|---|---|
QSqlRelationalTableModel::InnerJoin |
0 |
- Режим внутреннего соединения, возвращает строки, когда существует хотя бы одно совпадение в обеих таблицах. |
QSqlRelationalTableModel::LeftJoin |
1 |
- Режим левого соединения, возвращает все строки из левой таблицы (table_name1), даже если в правой таблице (table_name2) нет совпадений. |
См. также QSqlRelationalTableModel::setJoinMode().
Документация по функциям членов
QSqlRelationalTableModel::QSqlRelationalTableModel(QObject *parent = nullptr, const QSqlDatabase &db = QSqlDatabase())
Создаёт пустой QSqlRelationalTableModel и задаёт родителя parent и подключение к базе данных db. Если db недействительно, используется подключение к базе данных по умолчанию.
[override virtual slot] void QSqlRelationalTableModel::revertRow(int row)
Реализует: QSqlTableModel::revertRow(int row).
[virtual] QSqlRelationalTableModel::~QSqlRelationalTableModel()
Уничтожает объект и освобождает все выделенные ресурсы.
[override virtual] void QSqlRelationalTableModel::clear()
Переопределяет: QSqlTableModel::clear().
[override virtual] QVariant QSqlRelationalTableModel::data(const QModelIndex &index, int role = Qt::DisplayRole) const
Переопределяет: QSqlTableModel::data(const QModelIndex &index, int role) const.
См. также setData().
[override virtual protected] bool QSqlRelationalTableModel::insertRowIntoTable(const QSqlRecord &values)
Переопределяет: QSqlTableModel::insertRowIntoTable(const QSqlRecord &values).
[override virtual protected] QString QSqlRelationalTableModel::orderByClause() const
Переопределяет: QSqlTableModel::orderByClause() const.
QSqlRelation QSqlRelationalTableModel::relation(int column) const
Возвращает отношение для столбца column или недействительное отношение, если отношение не установлено.
См. также setRelation() и QSqlRelation::isValid().
[virtual] QSqlTableModel *QSqlRelationalTableModel::relationModel(int column) const
Возвращает объект QSqlTableModel для доступа к таблице, для которой column является внешним ключом, или nullptr если для данного column нет отношения.
Возвращаемый объект принадлежит QSqlRelationalTableModel.
См. также setRelation() и relation().
[override virtual] bool QSqlRelationalTableModel::removeColumns(int column, int count, const QModelIndex &parent = QModelIndex())
Переопределяет: QSqlTableModel::removeColumns(int column, int count, const QModelIndex &parent).
[override virtual] bool QSqlRelationalTableModel::select()
Переопределяет: QSqlTableModel::select().
[override virtual protected] QString QSqlRelationalTableModel::selectStatement() const
Переопределяет: QSqlTableModel::selectStatement() const.
[override virtual] bool QSqlRelationalTableModel::setData(const QModelIndex &index, const QVariant &value, int role = Qt::EditRole)
Переопределяет: QSqlTableModel::setData(const QModelIndex &index, const QVariant &value, int role).
Устанавливает данные для role в элементе с заданным index на value. В зависимости от стратегии редактирования, значение может быть применено к базе данных сразу или кэшировано в модели.
Возвращает true если значение можно установить или false при ошибке (например, если index выходит за пределы).
Для реляционных столбцов value должен быть индексом, а не отображаемым значением. Индекс также должен существовать в связанной таблице, в противном случае функция возвращает false.
См. также editStrategy(), data(), submit() и revertRow().
void QSqlRelationalTableModel::setJoinMode(QSqlRelationalTableModel::JoinMode joinMode)
Устанавливает режим SQL-соединения, чтобы показать или скрыть строки с NULL внешними ключами. В режиме InnerJoin (по умолчанию) эти строки не будут отображаться: используйте режим LeftJoin, если нужно отобразить их.
См. также QSqlRelationalTableModel::JoinMode.
[virtual] void QSqlRelationalTableModel::setRelation(int column, const QSqlRelation &relation)
Позволяет указанному column быть внешним индексом, заданным relation.
Пример:
model->setTable("employee");
model->setRelation(2, QSqlRelation("city", "id", "name")); Вызов setRelation() указывает, что столбец 2 в таблице employee является внешним ключом, который сопоставляется с полем id таблицы city, и что представление должно отобразить пользователю поле city's name.
Примечание: первичный ключ таблицы не может содержать отношение к другой таблице.
См. также relation().
[override virtual] void QSqlRelationalTableModel::setTable(const QString &table)
Переопределяет: QSqlTableModel::setTable(const QString &tableName).
[override virtual protected] bool QSqlRelationalTableModel::updateRowInTable(int row, const QSqlRecord &values)
Переопределяет: QSqlTableModel::updateRowInTable(int row, const QSqlRecord &values).
© The Qt Company Ltd
Licensed under the GNU Free Documentation License, Version 1.3.
https://doc.qt.io/qt-6.2/qsqlrelationaltablemodel.html