Synopsis#

Methods#

def __init__()
def displayColumn()
def indexColumn()
def isValid()
def swap()
def tableName()

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#

QSqlRelation is a helper class for QSqlRelationalTableModel . See setRelation() and relation() for details.

See also

QSqlRelationalTableModel QSqlRelationalDelegate Relational Table Model Example

__init__()#

Constructs an invalid QSqlRelation object.

For such an object, the tableName() , indexColumn() , and displayColumn() functions return an empty string.

See also

isValid()

__init__(aTableName, indexCol, displayCol)

Parameters:

aTableName – str
indexCol – str
displayCol – str

Constructs a QSqlRelation object, where tableName is the SQL table name to which a foreign key refers, indexColumn is the foreign key, and displayColumn is the field that should be presented to the user.

See also

tableName() indexColumn() displayColumn()

displayColumn()#

Return type:: str

Returns the column from table tableName() that should be presented to the user instead of a foreign key.

indexColumn()#

Return type:: str

Returns the index column from table tableName() to which a foreign key refers.

isValid()#

Return type:: bool

Returns true if the QSqlRelation object is valid; otherwise returns false.

swap(other)#

Parameters:: other – QSqlRelation

Swaps this with other.

tableName()#

Return type:: str

Returns the name of the table to which a foreign key refers.