QSqlIndex Class

The QSqlIndex class provides functions to manipulate and describe database indexes. More...

Header:	#include <QSqlIndex>
CMake:	find_package(Qt6 REQUIRED COMPONENTS Sql) target_link_libraries(mytarget PRIVATE Qt6::Sql)
qmake:	QT += sql
Inherits:	QSqlRecord

List of all members, including inherited members
QSqlIndex is part of Database Classes.

Public Functions

	QSqlIndex(const QString &cursorname = QString(), const QString &name = QString())
	QSqlIndex(const QSqlIndex &other)
	~QSqlIndex()
void	append(const QSqlField &field)
void	append(const QSqlField &field, bool desc)
QString	cursorName() const
bool	isDescending(int i) const
QString	name() const
void	setCursorName(const QString &cursorName)
void	setDescending(int i, bool desc)
void	setName(const QString &name)
QSqlIndex &	operator=(const QSqlIndex &other)

Detailed Description

An index refers to a single table or view in a database. Information about the fields that comprise the index can be used to generate SQL statements.

Member Function Documentation

`[explicit]` QSqlIndex::QSqlIndex(const QString &cursorname = QString(), const QString &name = QString())

Constructs an empty index using the cursor name cursorname and index name name.

QSqlIndex::QSqlIndex(const QSqlIndex &other)

Constructs a copy of other.

QSqlIndex::~QSqlIndex()

Destroys the object and frees any allocated resources.

void QSqlIndex::append(const QSqlField &field)

Appends the field field to the list of indexed fields. The field is appended with an ascending sort order.

void QSqlIndex::append(const QSqlField &field, bool desc)

This is an overloaded function.

Appends the field field to the list of indexed fields. The field is appended with an ascending sort order, unless desc is true.

QString QSqlIndex::cursorName() const

Returns the name of the cursor which the index is associated with.

See also setCursorName().

bool QSqlIndex::isDescending(int i) const

Returns true if field i in the index is sorted in descending order; otherwise returns false.

QString QSqlIndex::name() const

Returns the name of the index.

See also setName().

void QSqlIndex::setCursorName(const QString &cursorName)

Sets the name of the cursor that the index is associated with to cursorName.

See also cursorName().

void QSqlIndex::setDescending(int i, bool desc)

If desc is true, field i is sorted in descending order. Otherwise, field i is sorted in ascending order (the default). If the field does not exist, nothing happens.

See also isDescending().

void QSqlIndex::setName(const QString &name)

Sets the name of the index to name.

See also name().

QSqlIndex &QSqlIndex::operator=(const QSqlIndex &other)

Sets the index equal to other.

© 2024 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.