PySide6.QtSql.QSqlRecord¶

class QSqlRecord¶

The QSqlRecord class encapsulates a database record. More…

Inherited by: QSqlIndex

Synopsis¶

Methods¶

def __init__()
def append()
def clear()
def clearValues()
def contains()
def count()
def field()
def fieldName()
def indexOf()
def insert()
def isEmpty()
def isGenerated()
def isNull()
def keyValues()
def __ne__()
def __eq__()
def remove()
def replace()
def setGenerated()
def setNull()
def setValue()
def swap()
def value()

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¶

The QSqlRecord class encapsulates the functionality and characteristics of a database record (usually a row in a table or view within the database). QSqlRecord supports adding and removing fields as well as setting and retrieving field values.

The values of a record’s fields can be set by name or position with setValue() ; if you want to set a field to null use setNull() . To find the position of a field by name use indexOf() , and to find the name of a field at a particular position use fieldName() . Use field() to retrieve a QSqlField object for a given field. Use contains() to see if the record contains a particular field name.

When queries are generated to be executed on the database only those fields for which isGenerated() is true are included in the generated SQL.

A record can have fields added with append() or insert() , replaced with replace() , and removed with remove() . All the fields can be removed with clear() . The number of fields is given by count() ; all their values can be cleared (to null) using clearValues() .

See also

QSqlField record()

__init__()¶

Constructs an empty record.

See also

isEmpty() append() insert()

__init__(other)

Parameters:: other – QSqlRecord

Constructs a copy of other.

QSqlRecord is implicitly shared. This means you can make copies of a record in constant time.

append(field)¶

Parameters:: field – QSqlField

Append a copy of field field to the end of the record.

See also

insert() replace() remove()

clear()¶

Removes all the record’s fields.

See also

clearValues() isEmpty()

clearValues()¶

Clears the value of all fields in the record and sets each field to null.

See also

setValue()

contains(name)¶

Parameters:: name – str
Return type:: bool

Returns true if there is a field in the record called name; otherwise returns false.

Note

In Qt versions prior to 6.8, this function took QString, not QAnyStringView.

count()¶

Return type:: int

Returns the number of fields in the record.

See also

isEmpty()

field(name)¶

Parameters:: name – str
Return type:: QSqlField

This is an overloaded function.

Returns the field called name. If the field called name is not found, function returns a default-constructed value.

Note

In Qt versions prior to 6.8, this function took QString, not QAnyStringView.

field(i)

Parameters:: i – int
Return type:: QSqlField

Returns the field at position index. If the index is out of range, function returns a default-constructed value.

fieldName(i)¶

Parameters:: i – int
Return type:: str

Returns the name of the field at position index. If the field does not exist, an empty string is returned.

See also

indexOf()

indexOf(name)¶

Parameters:: name – str
Return type:: int

Returns the position of the field called name within the record, or -1 if it cannot be found. Field names are not case-sensitive. If more than one field matches, the first one is returned.

Note

In Qt versions prior to 6.8, this function took QString, not QAnyStringView.

See also

fieldName()

insert(pos, field)¶

Parameters:

pos – int
field – QSqlField

Inserts the field field at position pos in the record.

See also

append() replace() remove()

isEmpty()¶

Return type:: bool

Returns true if there are no fields in the record; otherwise returns false.

See also

append() insert() clear()

isGenerated(name)¶

Parameters:: name – str
Return type:: bool

This is an overloaded function.

Returns true if the record has a field called name and this field is to be generated (the default); otherwise returns false.

Note

In Qt versions prior to 6.8, this function took QString, not QAnyStringView.

See also

setGenerated()

isGenerated(i)

Parameters:: i – int
Return type:: bool

Returns true if the record has a field at position index and this field is to be generated (the default); otherwise returns false.

See also

setGenerated()

isNull(name)¶

Parameters:: name – str
Return type:: bool

This is an overloaded function.

Returns true if the field called name is null or if there is no field called name; otherwise returns false.

Note

In Qt versions prior to 6.8, this function took QString, not QAnyStringView.

See also

setNull()

isNull(i)

Parameters:: i – int
Return type:: bool

Returns true if the field index is null or if there is no field at position index; otherwise returns false.

See also

setNull()

keyValues(keyFields)¶

Parameters:: keyFields – QSqlRecord
Return type:: QSqlRecord

Returns a record containing the fields represented in keyFields set to values that match by field name.

__ne__(other)¶

Parameters:: other – QSqlRecord
Return type:: bool

Returns true if this object is not identical to other; otherwise returns false.

See also

operator==()

__eq__(other)¶

Parameters:: other – QSqlRecord
Return type:: bool

Returns true if this object is identical to other (i.e., has the same fields in the same order); otherwise returns false.

See also

operator!=()

remove(pos)¶

Parameters:: pos – int

Removes the field at position pos. If pos is out of range, nothing happens.

See also

append() insert() replace()

replace(pos, field)¶

Parameters:

pos – int
field – QSqlField

Replaces the field at position pos with the given field. If pos is out of range, nothing happens.

See also

append() insert() remove()

setGenerated(name, generated)¶

Parameters:

name – str
generated – bool

Sets the generated flag for the field called name to generated. If the field does not exist, nothing happens. Only fields that have generated set to true are included in the SQL that is generated by QSqlQueryModel for example.

Note

In Qt versions prior to 6.8, this function took QString, not QAnyStringView.

See also

isGenerated()

setGenerated(i, generated)

Parameters:

i – int
generated – bool

Sets the generated flag for the field index to generated.

See also

isGenerated()

setNull(name)¶

Parameters:: name – str

This is an overloaded function.

Sets the value of the field called name to null. If the field does not exist, nothing happens.

Note

In Qt versions prior to 6.8, this function took QString, not QAnyStringView.

setNull(i)

Parameters:: i – int

Sets the value of field index to null. If the field does not exist, nothing happens.

See also

isNull() setValue()

setValue(name, val)¶

Parameters:

name – str
val – object

This is an overloaded function.

Sets the value of the field called name to val. If the field does not exist, nothing happens.

Note

In Qt versions prior to 6.8, this function took QString, not QAnyStringView.

See also

setNull()

setValue(i, val)

Parameters:

i – int
val – object

Sets the value of the field at position index to val. If the field does not exist, nothing happens.

See also

value() setNull()

swap(other)¶

Parameters:: other – QSqlRecord

Swaps SQL record other with this SQL record. This operation is very fast and never fails.

value(name)¶

Parameters:: name – str
Return type:: object

This is an overloaded function.

Returns the value of the field called name in the record. If field name does not exist an invalid variant is returned.

Note

In Qt versions prior to 6.8, this function took QString, not QAnyStringView.

See also

indexOf() isNull()

value(i)

Parameters:: i – int
Return type:: object

Returns the value of the field located at position index in the record. If index is out of bounds, an invalid QVariant is returned.

See also

setValue() fieldName() isNull()