QSqlIndex

Synopsis

Functions

• def append (field, desc)
• def createField (i, prefix, verbose)
• def cursorName ()
• def isDescending (i)
• def name ()
• def setCursorName (cursorName)
• def setDescending (i, desc)
• def setName (name)

Detailed Description

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

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

class PySide.QtSql.QSqlIndex([cursorName=""[, name=""]])

Parameters:

• cursorName – unicode
• other – PySide.QtSql.QSqlIndex
• name – unicode

Constructs a copy of other .

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

PySide.QtSql.QSqlIndex.append(field, desc)

Parameters:

• field – PySide.QtSql.QSqlField
• desc – PySide.QtCore.bool

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.

PySide.QtSql.QSqlIndex.createField(i, prefix, verbose)

Parameters:

• i – PySide.QtCore.int
• prefix – unicode
• verbose – PySide.QtCore.bool

Return type:

unicode

PySide.QtSql.QSqlIndex.cursorName()

Return type:unicode

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

See also

PySide.QtSql.QSqlIndex.setCursorName()

PySide.QtSql.QSqlIndex.isDescending(i)

Parameters:i – PySide.QtCore.int Return type:PySide.QtCore.bool

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

PySide.QtSql.QSqlIndex.name()

Return type:unicode

Returns the name of the index.

See also

PySide.QtSql.QSqlIndex.setName()

PySide.QtSql.QSqlIndex.setCursorName(cursorName)

Parameters:cursorName – unicode

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

See also

PySide.QtSql.QSqlIndex.cursorName()

PySide.QtSql.QSqlIndex.setDescending(i, desc)

Parameters:

• i – PySide.QtCore.int
• desc – PySide.QtCore.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

PySide.QtSql.QSqlIndex.isDescending()

PySide.QtSql.QSqlIndex.setName(name)

Parameters:name – unicode

Sets the name of the index to name .

See also

PySide.QtSql.QSqlIndex.name()