class QSqlIndex#

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

Inheritance diagram of PySide6.QtSql.QSqlIndex

Synopsis#

Methods#

Note

This documentation may contain snippets that were automatically translated from C++ to Python. We always welcome contributions to the snippet translation. If you see an issue with the translation, you can also let us know by creating a ticket on https:/bugreports.qt.io/projects/PYSIDE

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.

__init__(other)#
Parameters:

other – QSqlIndex

Constructs a copy of other.

__init__([cursorName=""[, name=""]])
Parameters:

  • cursorName – str

  • name – str

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

append(field, desc)#
Parameters:

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.

cursorName()#
Return type:

str

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

See also

setCursorName()

isDescending(i)#
Parameters:

i – int

Return type:

bool

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

name()#
Return type:

str

Returns the name of the index.

See also

setName()

setCursorName(cursorName)#
Parameters:

cursorName – str

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

See also

cursorName()

setDescending(i, desc)#
Parameters:

  • i – int

  • desc – bool

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

setName(name)#
Parameters:

name – str

Sets the name of the index to name.

See also

name()

swap(other)#
Parameters:

other – QSqlIndex