The QSqlRecord class encapsulates a database record. More...

#include <qsqlrecord.h>

Inheritance diagram for QSqlRecord:

Collaboration diagram for QSqlRecord:

Public Member Functions
	QSqlRecord ()
	Constructs an empty record.

	QSqlRecord (const QSqlRecord &other)
	Constructs a copy of other.

	QSqlRecord (QSqlRecord &&other) noexcept=default

QSqlRecord &	operator= (const QSqlRecord &other)
	Sets the record equal to other.

	~QSqlRecord ()
	Destroys the object and frees any allocated resources.

void	swap (QSqlRecord &other) noexcept

bool	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`.

bool	operator!= (const QSqlRecord &other) const
	Returns `true` if this object is not identical to other; otherwise returns `false`.

QVariant	value (int i) const
	Returns the value of the field located at position index in the record.

QVariant	value (QAnyStringView name) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Returns the value of the field called name in the record.

void	setValue (int i, const QVariant &val)
	Sets the value of the field at position index to val.

void	setValue (QAnyStringView name, const QVariant &val)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Sets the value of the field called name to val.

void	setNull (int i)
	Sets the value of field index to null.

void	setNull (QAnyStringView name)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Sets the value of the field called name to null.

bool	isNull (int i) const
	Returns `true` if the field index is null or if there is no field at position index; otherwise returns `false`.

bool	isNull (QAnyStringView name) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Returns `true` if the field called name is null or if there is no field called name; otherwise returns `false`.

int	indexOf (QAnyStringView name) const
	Returns the position of the field called name within the record, or -1 if it cannot be found.

QString	fieldName (int i) const
	Returns the name of the field at position index.

QSqlField	field (int i) const
	Returns the field at position index.

QSqlField	field (QAnyStringView name) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Returns the field called name.

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

bool	isGenerated (QAnyStringView name) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Returns `true` if the record has a field called name and this field is to be generated (the default); otherwise returns `false`.

void	setGenerated (QAnyStringView name, bool generated)
	Sets the generated flag for the field called name to generated.

void	setGenerated (int i, bool generated)
	Sets the generated flag for the field index to generated.

void	append (const QSqlField &field)
	Append a copy of field field to the end of the record.

void	replace (int pos, const QSqlField &field)
	Replaces the field at position pos with the given field.

void	insert (int pos, const QSqlField &field)
	Inserts the field field at position pos in the record.

void	remove (int pos)
	Removes the field at position pos.

bool	isEmpty () const
	Returns `true` if there are no fields in the record; otherwise returns `false`.

bool	contains (QAnyStringView name) const
	Returns `true` if there is a field in the record called name; otherwise returns `false`.

void	clear ()
	Removes all the record's fields.

void	clearValues ()
	Clears the value of all fields in the record and sets each field to null.

int	count () const
	Returns the number of fields in the record.

QSqlRecord	keyValues (const QSqlRecord &keyFields) const

Detailed Description

The QSqlRecord class encapsulates a database record.

\inmodule QtSql

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, QSqlQuery::record()

Definition at line 19 of file qsqlrecord.h.

Constructor & Destructor Documentation

◆ QSqlRecord() [1/3]

QSqlRecord::QSqlRecord ( )

Constructs an empty record.

See also: isEmpty(), append(), insert()

Definition at line 93 of file qsqlrecord.cpp.

◆ QSqlRecord() [2/3]

QSqlRecord::QSqlRecord ( const QSqlRecord & other )

default

Constructs a copy of other.

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

◆ QSqlRecord() [3/3]

QSqlRecord::QSqlRecord ( QSqlRecord && other )

defaultnoexcept

Since: 6.6

Move-constructs a new QSqlRecord from other.

Note: The moved-from object other is placed in a partially-formed state, in which the only valid operations are destruction and assignment of a new value.

◆ ~QSqlRecord()

QSqlRecord::~QSqlRecord ( )

default

Destroys the object and frees any allocated resources.

Member Function Documentation

◆ append()

void QSqlRecord::append ( const QSqlField & field )

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

See also: insert(), replace(), remove()

Definition at line 267 of file qsqlrecord.cpp.

◆ clear()

void QSqlRecord::clear ( )

Removes all the record's fields.

See also: clearValues(), isEmpty()

Definition at line 322 of file qsqlrecord.cpp.

◆ clearValues()

void QSqlRecord::clearValues ( )

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

See also: setValue()

Definition at line 359 of file qsqlrecord.cpp.

◆ contains()

bool QSqlRecord::contains ( QAnyStringView name ) const

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.

Definition at line 347 of file qsqlrecord.cpp.

◆ count()

int QSqlRecord::count ( ) const

Returns the number of fields in the record.

See also: isEmpty()

Definition at line 484 of file qsqlrecord.cpp.

◆ field() [1/2]

QSqlField QSqlRecord::field ( int index ) const

Returns the field at position index.

If the index is out of range, function returns a \l{default-constructed value}.

Definition at line 240 of file qsqlrecord.cpp.

◆ field() [2/2]

QSqlField QSqlRecord::field ( QAnyStringView name ) const

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Returns the field called name.

If the field called name is not found, function returns a \l{default-constructed value}.

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

Definition at line 255 of file qsqlrecord.cpp.

◆ fieldName()

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

Definition at line 211 of file qsqlrecord.cpp.

◆ 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.

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

See also: fieldName()

Definition at line 227 of file qsqlrecord.cpp.

◆ insert()

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

Inserts the field field at position pos in the record.

See also: append(), replace(), remove()

Definition at line 278 of file qsqlrecord.cpp.

◆ isEmpty()

bool QSqlRecord::isEmpty ( ) const

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

See also: append(), insert(), clear()

Definition at line 335 of file qsqlrecord.cpp.

◆ isGenerated() [1/2]

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

Definition at line 473 of file qsqlrecord.cpp.

◆ isGenerated() [2/2]

bool QSqlRecord::isGenerated ( QAnyStringView name ) const

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.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()

Definition at line 462 of file qsqlrecord.cpp.

◆ isNull() [1/2]

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

Definition at line 402 of file qsqlrecord.cpp.

◆ isNull() [2/2]

bool QSqlRecord::isNull ( QAnyStringView name ) const

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.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()

Definition at line 418 of file qsqlrecord.cpp.

◆ keyValues()

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

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

Definition at line 550 of file qsqlrecord.cpp.

◆ operator!=()

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

inline

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

See also: operator==()

Definition at line 32 of file qsqlrecord.h.

◆ operator=()

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

default

Sets the record equal to other.

Since: 6.6

Move-assigns other to this QSqlRecord instance.

Note: The moved-from object other is placed in a partially-formed state, in which the only valid operations are destruction and assignment of a new value.

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

◆ operator==()

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

Definition at line 170 of file qsqlrecord.cpp.

◆ remove()

void QSqlRecord::remove ( int pos )

Removes the field at position pos.

If pos is out of range, nothing happens.

See also: append(), insert(), replace()

Definition at line 307 of file qsqlrecord.cpp.

◆ 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(), remove()

Definition at line 291 of file qsqlrecord.cpp.

◆ setGenerated() [1/2]

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

Sets the generated flag for the field index to generated.

See also: isGenerated()

Definition at line 388 of file qsqlrecord.cpp.

◆ setGenerated() [2/2]

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.

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

See also: isGenerated()

Definition at line 377 of file qsqlrecord.cpp.

◆ setNull() [1/2]

void QSqlRecord::setNull ( int index )

Sets the value of field index to null.

If the field does not exist, nothing happens.

See also: setValue()

Definition at line 429 of file qsqlrecord.cpp.

◆ setNull() [2/2]

void QSqlRecord::setNull ( QAnyStringView name )

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.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.

Definition at line 446 of file qsqlrecord.cpp.

◆ setValue() [1/2]

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: setNull()

Definition at line 496 of file qsqlrecord.cpp.

◆ setValue() [2/2]

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

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.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()

Definition at line 515 of file qsqlrecord.cpp.

◆ swap()

void QSqlRecord::swap ( QSqlRecord & other )

inlinenoexcept

Since: 6.6 \memberswap{SQL record}

Definition at line 29 of file qsqlrecord.h.

◆ value() [1/2]

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: fieldName(), isNull()

Definition at line 183 of file qsqlrecord.cpp.

◆ value() [2/2]

QVariant QSqlRecord::value ( QAnyStringView name ) const

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.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()

Definition at line 199 of file qsqlrecord.cpp.

The documentation for this class was generated from the following files:

qtbase/src/sql/kernel/qsqlrecord.h (6b096271cf0aac38d80f292f8b37edd671a8d17f)
qtbase/src/sql/kernel/qsqlrecord.cpp (3ccb4ce781463f1b8e0cb4c9283b3067fe92a32e)

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ QSqlRecord() [1/3]

◆ QSqlRecord() [2/3]

◆ QSqlRecord() [3/3]

◆ ~QSqlRecord()

Member Function Documentation

◆ append()

◆ clear()

◆ clearValues()

◆ contains()

◆ count()

◆ field() [1/2]

◆ field() [2/2]

◆ fieldName()

◆ indexOf()

◆ insert()

◆ isEmpty()

◆ isGenerated() [1/2]

◆ isGenerated() [2/2]

◆ isNull() [1/2]

◆ isNull() [2/2]

◆ keyValues()

◆ operator!=()

◆ operator=()

◆ operator==()

◆ remove()

◆ replace()

◆ setGenerated() [1/2]

◆ setGenerated() [2/2]

◆ setNull() [1/2]

◆ setNull() [2/2]

◆ setValue() [1/2]

◆ setValue() [2/2]

◆ swap()

◆ value() [1/2]

◆ value() [2/2]