Back to Qt.io
Contact Us Blog Download Qt

QSqlField Class

QSqlField 类可操作 SQL 数据库表和视图中的字段。更多

Header： #include <QSqlField>
CMake.QSqlField 类 find_package(Qt6 REQUIRED COMPONENTS Sql)
target_link_libraries(mytarget PRIVATE Qt6::Sql)
qmake： QT += sql

公共类型

enum RequiredStatus { Required, Optional, Unknown }

属性

公共功能

(since 6.0) QSqlField(const QString &fieldName = QString(), QMetaType type = QMetaType(), const QString &table = QString())
QSqlField(const QSqlField &other)
~QSqlField()
void clear()
QVariant defaultValue() const
bool isAutoValue() const
bool isGenerated() const
bool isNull() const
bool isReadOnly() const
bool isValid() const
int length() const
QMetaType metaType() const
QString name() const
int precision() const
QSqlField::RequiredStatus requiredStatus() const
void setAutoValue(bool autoVal)
void setDefaultValue(const QVariant &value)
void setGenerated(bool gen)
void setLength(int fieldLength)
void setMetaType(QMetaType type)
void setName(const QString &name)
void setPrecision(int precision)
void setReadOnly(bool readOnly)
void setRequired(bool required)
void setRequiredStatus(QSqlField::RequiredStatus required)
void setTableName(const QString &tableName)
void setValue(const QVariant &value)
(since 6.6) void swap(QSqlField &other)
QString tableName() const
QVariant value() const
bool operator!=(const QSqlField &other) const
QSqlField &operator=(const QSqlField &other)
bool operator==(const QSqlField &other) const

详细说明

QSqlField 表示数据库表或视图中单列的特征，如数据类型和列名。字段还包含可查看或更改的数据库列值。

字段数据值存储为 QVariants。不允许使用不兼容的类型。例如

    QSqlField field("age", QMetaType::fromType<int>());
    field.setValue(QPixmap());  // WRONG

不过，在可能的情况下，字段会尝试将某些数据类型转换为字段数据类型：

    QSqlField field("age", QMetaType::fromType<int>());
    field.setValue(QString("123"));  // casts QString to int

QSqlField 对象很少在应用程序代码中明确创建。它们通常是通过已包含字段列表的QSqlRecords 间接访问的。例如

    QSqlQuery query;
    ...
    QSqlRecord record = query.record();
    QSqlField field = record.field("country");

QSqlField 对象可以提供一些有关字段的元数据，例如，它的name(), 变体类型(),length(),precision(),defaultValue(), typeID(), 以及它的requiredStatus(),isGenerated() 和isReadOnly() 。可以检查字段的数据是否为isNull() 和value() 。编辑时，可使用setValue() 设置数据，或使用clear() 设置数据为空。

另请参阅 QSqlRecord 。

成员类型文档

enum QSqlField::RequiredStatus

指定字段是必填字段还是可选字段。

常数值说明
QSqlField::Required1插入记录时必须指定字段。
QSqlField::Optional0插入记录时不必指定字段。
QSqlField::Unknown-1数据库驱动程序无法确定该字段是必填字段还是可选字段。

另请参阅 requiredStatus 。

属性文档

[since 6.8] autoValue : bool

如果值是由数据库自动生成的，例如自动递增主键值，则该值为true 。

注意： 在使用 ODBC 驱动程序时，由于 ODBC API 的限制，isAutoValue() 字段只在通过执行SELECT 查询获得的QSqlRecord 产生的QSqlField 中填充。在通过QSqlDatabase::record() 或QSqlDatabase::primaryIndex() 返回的QSqlRecord 所生成的QSqlField 中，该字段为false 。

此属性在 Qt 6.8 中引入。

访问函数：

bool isAutoValue() const
void setAutoValue(bool autoVal)

[since 6.8] defaultValue : QVariant

此属性保留此字段的默认值。只有部分数据库驱动程序支持此属性。目前有 SQLite、PostgreSQL、Oracle 和 MySQL/MariaDB。

此属性在 Qt 6.8 中引入。

访问函数：

QVariant defaultValue() const
void setDefaultValue(const QVariant &value)

[since 6.8] generated : bool

此属性保存生成的状态。如果generated 是false ，则不会为该字段生成 SQL；否则，Qt 类（如QSqlQueryModel 和QSqlTableModel ）将为该字段生成 SQL。

此属性在 Qt 6.8 中引入。

访问函数：

bool isGenerated() const
void setGenerated(bool gen)

[since 6.8] length : int

该属性表示字段的长度。

如果该值为负数，则表示数据库中没有该信息。对于字符串，这是字符串可容纳的最大字符数；对于其他类型，其含义有所不同。

该属性在 Qt 6.8 中引入。

访问函数：

int length() const
void setLength(int fieldLength)

[since 6.8] metaType : QMetaType

该属性保存数据库中存储的字段类型。请注意，实际值可能有不同的类型，数值太大而无法存储在 long int 或 double 中时，通常会存储为字符串，以防止精度降低。

此属性在 Qt 6.8 中引入。

访问函数：

QMetaType metaType() const
void setMetaType(QMetaType type)

另请参阅 QSqlDatabase::numericalPrecisionPolicy 。

name : QString

该属性包含字段的名称。可以是列名或用户给定的别名。

访问功能：

QString name() const
void setName(const QString &name)

[since 6.8] precision : int

该属性表示字段的精度；仅对数值类型有意义。

如果返回值为负数，则表示数据库中没有该信息。

此属性在 Qt 6.8 中引入。

访问函数：

int precision() const
void setPrecision(int precision)

[since 6.8] readOnly : bool

如果该属性为true ，则不能修改QSqlField 。只读字段不能用setValue() 设置其值，也不能用clear() 清除为 NULL。

此属性在 Qt 6.8 中引入。

访问函数：

bool isReadOnly() const
void setReadOnly(bool readOnly)

[since 6.8] requiredStatus : RequiredStatus

该属性保存字段的RequiredStatus 。如果必填字段没有值，INSERT 将失败。

此属性在 Qt 6.8 中引入。

访问函数：

QSqlField::RequiredStatus requiredStatus() const
void setRequiredStatus(QSqlField::RequiredStatus required)

另请参阅 RequiredStatus 。

[since 6.8] tableName : QString

该属性包含字段的 tableName。

注意： 在使用 QPSQL 驱动程序时，由于 libpq 库的限制，只向前查询的QSqlQuery::record() 得到的QSqlRecord 所产生的QSqlField 中不会填充tableName() 字段。

此属性在 Qt 6.8 中引入。

访问函数：

QString tableName() const
void setTableName(const QString &tableName)

[since 6.8] value : QVariant

该属性将value 作为QVariant

将value 设置为只读QSqlField 是不可行的。如果value 的数据类型与字段的当前数据类型不同，则会尝试将其转换为适当的类型。这样可以在赋值时保留字段的数据类型，例如将QString 转换为整数数据类型。

要将值设置为 NULL，请使用clear() 。

此属性在 Qt 6.8 中引入。

访问函数：

QVariant value() const
void setValue(const QVariant &value)

成员函数文档

[explicit, since 6.0] QSqlField::QSqlField(const QString &fieldName = QString(), QMetaType type = QMetaType(), const QString &table = QString())

这是一个重载函数。

在table 中构造一个名为fieldName 的空字段，其类型为type 。

该函数在 Qt 6.0 中引入。

QSqlField::QSqlField(const QSqlField &other)

构造other 的副本。

[noexcept] QSqlField::~QSqlField()

销毁对象并释放已分配的资源。

void QSqlField::clear()

清除字段的值并将其设置为 NULL。如果字段是只读的，则不会发生任何操作。

QVariant QSqlField::defaultValue() const

设置 defaultValue 的值。

注： 属性 defaultValue 的获取函数。

另请参阅 setDefaultValue().

bool QSqlField::isAutoValue() const

返回autoValue 的值。

注： 属性autoValue 的获取函数。

bool QSqlField::isGenerated() const

返回generated 的值。

注： 属性generated 的获取函数。

bool QSqlField::isNull() const

如果字段值为 NULL，则返回true ；否则返回 false。

另请参见 value 。

bool QSqlField::isReadOnly() const

返回readOnly 的值。

注： 属性readOnly 的获取函数。

bool QSqlField::isValid() const

如果字段的变量类型有效，则返回true ；否则返回false 。

int QSqlField::length() const

返回 length 的值。

注： 属性 length 的获取函数。

另请参阅 setLength().

QMetaType QSqlField::metaType() const

返回 metaType 的值。

注： 属性 metaType 的获取函数。

另请参阅 setMetaType().

QString QSqlField::name() const

返回 name 的值。

注： 属性名称的获取函数。

另请参阅 setName().

int QSqlField::precision() const

返回精度值。

注： 精度属性的获取函数。

另请参阅 setPrecision().

QSqlField::RequiredStatus QSqlField::requiredStatus() const

返回 requiredStatus 的值。

注：requiredStatus 属性的获取函数。

另请参阅 setRequiredStatus().

void QSqlField::setAutoValue(bool autoVal)

将autoValue 设置为autoVal 。

注： 属性autoValue 的设置函数。

另请参阅 isAutoValue() 。

void QSqlField::setDefaultValue(const QVariant &value)

将defaultValue 设置为value 。

注： 属性defaultValue 的设置函数。

另请参阅 defaultValue() 。

void QSqlField::setGenerated(bool gen)

将generated 设置为gen 。

注： 属性generated 的设置函数。

另请参阅 isGenerated() 。

void QSqlField::setLength(int fieldLength)

将length 设置为fieldLength 。

注： 属性length 的设置函数。

另请参阅 length() 。

void QSqlField::setMetaType(QMetaType type)

将metaType 设置为type 。

注： 属性metaType 的设置函数。

另请参阅 metaType() 。

void QSqlField::setName(const QString &name)

将name 设置为name 。

注： 属性name 的设置函数。

另请参阅 name() 。

void QSqlField::setPrecision(int precision)

将precision 设置为precision 。

注： 属性precision 的设置函数。

另请参阅 precision() 。

void QSqlField::setReadOnly(bool readOnly)

将readOnly 设置为readOnly 。

注： 属性readOnly 的设置函数。

另请参阅 isReadOnly() 。

void QSqlField::setRequired(bool required)

如果required 为 true，则将该字段的必填状态设置为Required ；否则将其设置为Optional 。

另请参阅 requiredStatus 。

void QSqlField::setRequiredStatus(QSqlField::RequiredStatus required)

将requiredStatus 设置为required 。

注： 属性requiredStatus 的设置函数。

另请参阅 requiredStatus() 。

void QSqlField::setTableName(const QString &tableName)

将tableName 设置为tableName 。

注： 属性tableName 的设置函数。

另请参阅 tableName() 。

void QSqlField::setValue(const QVariant &value)

将value 设置为value 。

注： 属性value 的设置函数。

另请参阅 value() 。

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

将该字段与other 互换。该操作速度非常快，而且从未出现过故障。

此功能在 Qt 6.6 中引入。

QString QSqlField::tableName() const

返回表名。

注： 属性 tableName 的获取函数。

另请参阅 setTableName()。

QVariant QSqlField::value() const

返回 value 的值。

注： 属性值的获取函数。

另请参阅 setValue().

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

如果字段不等于other ，则返回true ；否则返回 false。

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

设置字段等于other 。

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

如果字段等于other ，则返回true ；否则返回 false。

© 2025 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.