PySide6.QtSql.QSqlIndex¶

class QSqlIndex¶

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

Details

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.

Synopsis¶

Properties¶

cursorNameᅟ
nameᅟ

Methods¶

def __init__()
def append()
def cursorName()
def isDescending()
def name()
def setCursorName()
def setDescending()
def setName()
def swap()

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

Note

Properties can be used directly when from __feature__ import true_property is used or via accessor functions otherwise.

property cursorNameᅟ: str¶

This property holds the name of the cursor which the index is associated with.

Access functions:

cursorName()
setCursorName()

property nameᅟ: str¶

This property holds the name of the index.

Access functions:

name()
setName()

__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:

field – QSqlField
desc – bool

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 cursorName.

See also

setCursorName()

Getter of property cursorNameᅟ .

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.

See also

setName()

Getter of property nameᅟ .

setCursorName(cursorName)¶

Parameters:: cursorName – str

Sets cursorName to cursorName.

See also

cursorName()

Setter of property 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 name to name.

See also

name()

Setter of property nameᅟ .

swap(other)¶

Parameters:: other – QSqlIndex