QSqlRecord#
The QSqlRecord
class encapsulates a database record. More…
Inherited by: QSqlIndex
Synopsis#
Functions#
def
append
(field)def
clear
()def
clearValues
()def
contains
(name)def
count
()def
field
(name)def
field
(i)def
fieldName
(i)def
indexOf
(name)def
insert
(pos, field)def
isEmpty
()def
isGenerated
(name)def
isGenerated
(i)def
isNull
(i)def
isNull
(name)def
keyValues
(keyFields)def
__ne__
(other)def
__eq__
(other)def
remove
(pos)def
replace
(pos, field)def
setGenerated
(name, generated)def
setGenerated
(i, generated)def
setNull
(name)def
setNull
(i)def
setValue
(name, val)def
setValue
(i, val)def
swap
(other)def
value
(name)def
value
(i)
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()
.
- class PySide6.QtSql.QSqlRecord#
PySide6.QtSql.QSqlRecord(other)
- Parameters:
other –
PySide6.QtSql.QSqlRecord
Constructs an empty record.
Constructs a copy of other
.
QSqlRecord
is implicitly shared. This means you can make copies of a record in constant time.
- PySide6.QtSql.QSqlRecord.append(field)#
- Parameters:
field –
PySide6.QtSql.QSqlField
Append a copy of field field
to the end of the record.
- PySide6.QtSql.QSqlRecord.clear()#
Removes all the record’s fields.
See also
- PySide6.QtSql.QSqlRecord.clearValues()#
Clears the value of all fields in the record and sets each field to null.
See also
- PySide6.QtSql.QSqlRecord.contains(name)#
- Parameters:
name – str
- Return type:
bool
Returns true
if there is a field in the record called name
; otherwise returns false
.
- PySide6.QtSql.QSqlRecord.count()#
- Return type:
int
Returns the number of fields in the record.
See also
- PySide6.QtSql.QSqlRecord.field(name)#
- Parameters:
name – str
- Return type:
This is an overloaded function.
Returns the field called name
.
- PySide6.QtSql.QSqlRecord.field(i)
- Parameters:
i – int
- Return type:
Returns the field at position index
. If the index
is out of range, function returns a default-constructed value.
- PySide6.QtSql.QSqlRecord.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
- PySide6.QtSql.QSqlRecord.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.
See also
- PySide6.QtSql.QSqlRecord.insert(pos, field)#
- Parameters:
pos – int
field –
PySide6.QtSql.QSqlField
Inserts the field field
at position pos
in the record.
- PySide6.QtSql.QSqlRecord.isEmpty()#
- Return type:
bool
Returns true
if there are no fields in the record; otherwise returns false
.
- PySide6.QtSql.QSqlRecord.isGenerated(name)#
- Parameters:
name – str
- Return type:
bool
Returns true
if the record has a field called name
and this field is to be generated (the default); otherwise returns false
.
See also
- PySide6.QtSql.QSqlRecord.isGenerated(i)
- Parameters:
i – int
- Return type:
bool
This is an overloaded function.
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
- PySide6.QtSql.QSqlRecord.isNull(i)#
- Parameters:
i – int
- Return type:
bool
This is an overloaded function.
Returns true
if the field index
is null or if there is no field at position index
; otherwise returns false
.
- PySide6.QtSql.QSqlRecord.isNull(name)
- Parameters:
name – str
- Return type:
bool
Returns true
if the field called name
is null or if there is no field called name
; otherwise returns false
.
See also
- PySide6.QtSql.QSqlRecord.keyValues(keyFields)#
- Parameters:
keyFields –
PySide6.QtSql.QSqlRecord
- Return type:
Returns a record containing the fields represented in keyFields
set to values that match by field name.
- PySide6.QtSql.QSqlRecord.__ne__(other)#
- Parameters:
other –
PySide6.QtSql.QSqlRecord
- Return type:
bool
Returns true
if this object is not identical to other
; otherwise returns false
.
See also
operator==()
- PySide6.QtSql.QSqlRecord.__eq__(other)#
- Parameters:
other –
PySide6.QtSql.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!=()
- PySide6.QtSql.QSqlRecord.remove(pos)#
- Parameters:
pos – int
Removes the field at position pos
. If pos
is out of range, nothing happens.
- PySide6.QtSql.QSqlRecord.replace(pos, field)#
- Parameters:
pos – int
field –
PySide6.QtSql.QSqlField
Replaces the field at position pos
with the given field
. If pos
is out of range, nothing happens.
- PySide6.QtSql.QSqlRecord.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.
See also
- PySide6.QtSql.QSqlRecord.setGenerated(i, generated)
- Parameters:
i – int
generated – bool
This is an overloaded function.
Sets the generated flag for the field index
to generated
.
See also
- PySide6.QtSql.QSqlRecord.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.
- PySide6.QtSql.QSqlRecord.setNull(i)
- Parameters:
i – int
Sets the value of field index
to null. If the field does not exist, nothing happens.
See also
- PySide6.QtSql.QSqlRecord.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.
- PySide6.QtSql.QSqlRecord.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.
- PySide6.QtSql.QSqlRecord.swap(other)#
- Parameters:
other –
PySide6.QtSql.QSqlRecord
Swaps SQL record other
with this SQL record. This operation is very fast and never fails.
- PySide6.QtSql.QSqlRecord.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.
See also
- PySide6.QtSql.QSqlRecord.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