QSqlIndex#

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

Inheritance diagram of PySide6.QtSql.QSqlIndex

Synopsis#

Functions#

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.

class PySide6.QtSql.QSqlIndex(other)#

PySide6.QtSql.QSqlIndex([cursorName=””[, name=””]])

Parameters:

Constructs a copy of other.

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

PySide6.QtSql.QSqlIndex.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.

PySide6.QtSql.QSqlIndex.cursorName()#
Return type:

str

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

See also

setCursorName()

PySide6.QtSql.QSqlIndex.isDescending(i)#
Parameters:

i – int

Return type:

bool

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

PySide6.QtSql.QSqlIndex.name()#
Return type:

str

Returns the name of the index.

See also

setName()

PySide6.QtSql.QSqlIndex.setCursorName(cursorName)#
Parameters:

cursorName – str

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

See also

cursorName()

PySide6.QtSql.QSqlIndex.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()

PySide6.QtSql.QSqlIndex.setName(name)#
Parameters:

name – str

Sets the name of the index to name.

See also

name()

PySide6.QtSql.QSqlIndex.swap(other)#
Parameters:

otherPySide6.QtSql.QSqlIndex