QSqlRecord Class

Member Function Documentation

QSqlRecord::QSqlRecord()

Constructs an empty record.

See also isEmpty(), append(), and insert().

QSqlRecord::QSqlRecord(const QSqlRecord &other)

Constructs a copy of other.

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

[noexcept, since 6.6] QSqlRecord::QSqlRecord(QSqlRecord &&other)

Move-constructs a new QSqlRecord from other.

This function was introduced in Qt 6.6.

[noexcept] QSqlRecord::~QSqlRecord()

Destroys the object and frees any allocated resources.

void QSqlRecord::append(const QSqlField &field)

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

See also insert(), replace(), and remove().

void QSqlRecord::clear()

Removes all the record's fields.

See also clearValues() and isEmpty().

void QSqlRecord::clearValues()

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

See also setValue().

bool QSqlRecord::contains(QAnyStringView name) const

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

int QSqlRecord::count() const

Returns the number of fields in the record.

See also isEmpty().

QSqlField QSqlRecord::field(int index) const

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

QSqlField QSqlRecord::field(QAnyStringView name) const

This is an overloaded function.

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

QString QSqlRecord::fieldName(int index) const

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

See also indexOf().

int QSqlRecord::indexOf(QAnyStringView name) const

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 fieldName().

void QSqlRecord::insert(int pos, const QSqlField &field)

Inserts the field field at position pos in the record.

See also append(), replace(), and remove().

bool QSqlRecord::isEmpty() const

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

See also append(), insert(), and clear().

bool QSqlRecord::isGenerated(int index) const

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().

bool QSqlRecord::isGenerated(QAnyStringView name) const

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.

See also setGenerated().

bool QSqlRecord::isNull(int index) const

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

See also setNull().

bool QSqlRecord::isNull(QAnyStringView name) const

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.

See also setNull().

QSqlRecord QSqlRecord::keyValues(const QSqlRecord &keyFields) const

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

void QSqlRecord::remove(int pos)

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

See also append(), insert(), and replace().

void QSqlRecord::replace(int pos, const QSqlField &field)

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

See also append(), insert(), and remove().

void QSqlRecord::setGenerated(QAnyStringView name, bool generated)

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 isGenerated().

void QSqlRecord::setGenerated(int index, bool generated)

Sets the generated flag for the field index to generated.

See also isGenerated().

void QSqlRecord::setNull(int index)

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

See also isNull() and setValue().

void QSqlRecord::setNull(QAnyStringView name)

This is an overloaded function.

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

void QSqlRecord::setValue(int index, const QVariant &val)

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

See also value() and setNull().

void QSqlRecord::setValue(QAnyStringView name, const QVariant &val)

This is an overloaded function.

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

See also setNull().

[noexcept, since 6.6] void QSqlRecord::swap(QSqlRecord &other)

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

This function was introduced in Qt 6.6.

QVariant QSqlRecord::value(int index) const

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(), and isNull().

QVariant QSqlRecord::value(QAnyStringView name) const

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 indexOf() and isNull().

bool QSqlRecord::operator!=(const QSqlRecord &other) const

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

See also operator==().

[noexcept, since 6.6] QSqlRecord &QSqlRecord::operator=(QSqlRecord &&other)

Move-assigns other to this QSqlRecord instance.

This function was introduced in Qt 6.6.

QSqlRecord &QSqlRecord::operator=(const QSqlRecord &other)

Sets the record equal to other.

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

bool QSqlRecord::operator==(const QSqlRecord &other) const

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!=().