QSqlField Class
La clase QSqlField permite manipular los campos de las tablas y vistas de una base de datos SQL. Más información...
| Encabezado: | #include <QSqlField> |
| CMake: | find_package(Qt6 REQUIRED COMPONENTS Sql) target_link_libraries(mytarget PRIVATE Qt6::Sql) |
| qmake: | QT += sql |
- Lista de todos los miembros, incluidos los miembros heredados
- Miembros obsoletos
- QSqlField forma parte de las clases de bases de datos y de las clases compartidas implícitamente.
Tipos públicos
| enum | RequiredStatus { Required, Optional, Unknown } |
Propiedades
|
Funciones públicas
(since 6.0) | QSqlField(const QString &fieldName = QString(), QMetaType type = QMetaType(), const QString &table = QString()) |
| QSqlField(const QSqlField &other) | |
| QSqlField(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 |
Descripción detallada
QSqlField representa las características de una sola columna de una tabla o vista de una base de datos, como el tipo de datos y el nombre de la columna. Un campo también contiene el valor de la columna de la base de datos, que se puede visualizar o modificar.
Los valores de los datos de los campos se almacenan como QVariants. No se permite el uso de tipos incompatibles. Por ejemplo:
Sin embargo, el campo intentará convertir ciertos tipos de datos al tipo de datos del campo siempre que sea posible:
QSqlField field("age", QMetaType::fromType<int>());
field.setValue(QString("123")); // casts QString to intLos objetos QSqlField rara vez se crean explícitamente en el código de la aplicación. Por lo general, se accede a ellos de forma indirecta a través de objetos « QSqlRecord» que ya contienen una lista de campos. Por ejemplo:
QSqlQuery query;
...
QSqlRecord record = query.record();
QSqlField field = record.field("country");Un objeto QSqlField puede proporcionar algunos metadatos sobre el campo, por ejemplo, su name(), variant metaType(), length(), precision(), defaultValue(), typeID(), así como su requiredStatus(), isGenerated() y isReadOnly(). Se pueden comprobar los datos del campo para ver si e isNull() y recuperar su value(). Al editar, los datos se pueden establecer con setValue() o fijarse en NULL con clear().
Véase también QSqlRecord.
Documentación sobre tipos de miembros
enum QSqlField::RequiredStatus
Indica si el campo es obligatorio u opcional.
| Constante | Valor | Descripción |
|---|---|---|
QSqlField::Required | 1 | El campo debe especificarse al insertar registros. |
QSqlField::Optional | 0 | No es necesario especificar el campo al insertar registros. |
QSqlField::Unknown | -1 | El controlador de la base de datos no ha podido determinar si el campo es obligatorio u opcional. |
Véase también requiredStatus.
Documentación de la propiedad
[since 6.8] autoValue : bool
Si el valor lo genera automáticamente la base de datos —por ejemplo, los valores de clave primaria autoincrementables—, dicho valor es « true ».
Nota: Al escribir un nuevo registro en la base de datos, el campo « autoValue » solo contendrá el nuevo valor generado por la base de datos una vez que el registro se haya enviado a la base de datos. Al utilizar el controlador ODBC, debido a las limitaciones de la API de ODBC, el campo « isAutoValue() » solo se rellena en un objeto « QSqlField » resultante de un objeto « QSqlRecord » obtenido al ejecutar una consulta « SELECT ». Es « false » para un objeto « QSqlField » resultante de un objeto « QSqlRecord » devuelto por « QSqlDatabase::record()» o « QSqlDatabase::primaryIndex()».
Esta enumeración se introdujo en Qt 6.8.
Funciones de acceso:
| bool | isAutoValue() const |
| void | setAutoValue(bool autoVal) |
[since 6.8] defaultValue : QVariant
Esta propiedad contiene el valor por defecto de este campo. Solo algunos controladores de bases de datos admiten esta propiedad. Actualmente son SQLite, PostgreSQL, Oracle y MySQL/MariaDB.
Esta enumeración se introdujo en Qt 6.8.
Funciones de acceso:
| QVariant | defaultValue() const |
| void | setDefaultValue(const QVariant &value) |
[since 6.8] generated : bool
Esta propiedad contiene el estado generado. Si « generated » es « false », no se generará ningún código SQL para este campo; en caso contrario, las clases de Qt como « QSqlQueryModel » y « QSqlTableModel » generarán código SQL para este campo.
Esta enumeración se introdujo en Qt 6.8.
Funciones de acceso:
| bool | isGenerated() const |
| void | setGenerated(bool gen) |
[since 6.8] length : int
Esta propiedad contiene la longitud del campo.
Si el valor es negativo, significa que la información no está disponible en la base de datos. En el caso de las cadenas, se trata del número máximo de caracteres que puede contener la cadena; el significado varía para otros tipos.
Esta enumeración se introdujo en Qt 6.8.
Funciones de acceso:
[since 6.8] metaType : QMetaType
Esta propiedad contiene el tipo del campo tal y como está almacenado en la base de datos. Ten en cuenta que el valor real puede tener un tipo diferente; los valores numéricos que son demasiado grandes para almacenarse en un «long int» o un «double» suelen almacenarse como cadenas para evitar la pérdida de precisión.
Esta enumeración se introdujo en Qt 6.8.
Funciones de acceso:
| QMetaType | metaType() const |
| void | setMetaType(QMetaType type) |
Véase también QSqlDatabase::numericalPrecisionPolicy.
name : QString
Esta propiedad contiene el nombre del campo. Puede ser el nombre de la columna o un alias definido por el usuario.
Funciones de Access:
[since 6.8] precision : int
Esta propiedad indica la precisión del campo; solo tiene sentido para los tipos numéricos.
Si el valor devuelto es negativo, significa que la información no está disponible en la base de datos.
Esta enumeración se introdujo en Qt 6.8.
Funciones de acceso:
| int | precision() const |
| void | setPrecision(int precision) |
[since 6.8] readOnly : bool
Cuando esta propiedad es « true », entonces este « QSqlField » no se puede modificar. El valor de un campo de solo lectura no se puede establecer mediante « setValue()» ni se puede poner a NULL con « clear()».
Esta enumeración se introdujo en Qt 6.8.
Funciones de acceso:
| bool | isReadOnly() const |
| void | setReadOnly(bool readOnly) |
[since 6.8] requiredStatus : RequiredStatus
Esta propiedad contiene el « RequiredStatus » del campo. Una « INSERT » fallará si un campo obligatorio no tiene ningún valor.
Esta enumeración se introdujo en Qt 6.8.
Funciones de acceso:
| QSqlField::RequiredStatus | requiredStatus() const |
| void | setRequiredStatus(QSqlField::RequiredStatus required) |
Véase también RequiredStatus.
[since 6.8] tableName : QString
Esta propiedad contiene el nombre de la tabla (tableName) del campo.
Nota: Al utilizar el controlador QPSQL, debido a las limitaciones de la biblioteca libpq, el campo « tableName() » no se rellena en un objeto « QSqlField » resultante de un objeto « QSqlRecord » obtenido mediante « QSqlQuery::record()» de una consulta de solo avance.
Esta enumeración se introdujo en Qt 6.8.
Funciones de acceso:
| QString | tableName() const |
| void | setTableName(const QString &tableName) |
[since 6.8] value : QVariant
Esta propiedad contiene el ` value ` como un QVariant
Establecer un « value » en un « QSqlField » de solo lectura no produce ningún efecto. Si el tipo de datos de « value » difiere del tipo de datos actual del campo, se intenta convertirlo al tipo adecuado. Esto conserva el tipo de datos del campo en caso de asignación; por ejemplo, un « QString » a un tipo de datos entero.
Para establecer el valor en NULL, utiliza clear().
Esta enumeración se introdujo en Qt 6.8.
Funciones de acceso:
Documentación de las funciones miembro
[explicit, since 6.0] QSqlField::QSqlField(const QString &fieldName = QString(), QMetaType type = QMetaType(), const QString &table = QString())
Crea un campo vacío llamado « fieldName » de tipo « type » en « table ».
Esta es una función sobrecargada.
Esta función se introdujo en Qt 6.0.
QSqlField::QSqlField(const QSqlField &other)
Crea una copia de other.
[noexcept default] QSqlField::QSqlField(QSqlField &&other)
Crea una instancia de ` QSqlField` mediante la construcción «move».
[noexcept] QSqlField::~QSqlField()
Destruye el objeto y libera los recursos asignados.
void QSqlField::clear()
Borra el valor del campo y lo establece en NULL. Si el campo es de solo lectura, no ocurre nada.
QVariant QSqlField::defaultValue() const
Establece el valor de `defaultValue`.
Nota: Funcióngetter para la propiedad defaultValue.
Véase también setDefaultValue().
bool QSqlField::isAutoValue() const
Devuelve el valor de ` autoValue`.
Nota: Funcióngetter para la propiedad ` autoValue`.
bool QSqlField::isGenerated() const
Devuelve el valor de ` generated`.
Nota: Funcióngetter para la propiedad generated.
bool QSqlField::isNull() const
Devuelve « true » si el valor del campo es NULL; en caso contrario, devuelve «false».
Véase también value.
bool QSqlField::isReadOnly() const
Devuelve el valor de « readOnly ».
Nota: Funcióngetter para la propiedad readOnly.
bool QSqlField::isValid() const
Devuelve « true » si el tipo de variante del campo es válido; en caso contrario, devuelve « false ».
int QSqlField::length() const
Devuelve el valor de «length».
Nota: Funcióngetter para la propiedad «length».
Véase también ` setLength()`.
QMetaType QSqlField::metaType() const
Devuelve el valor de metaType.
Nota: Funcióngetter para la propiedad metaType.
Véase también setMetaType().
QString QSqlField::name() const
Devuelve el valor de «name».
Nota: Funcióngetter para la propiedad «name».
Véase también setName().
int QSqlField::precision() const
Devuelve el valor de «precision».
Nota: Funcióngetter para la propiedad «precision».
Véase también setPrecision().
QSqlField::RequiredStatus QSqlField::requiredStatus() const
Devuelve el valor de requiredStatus.
Nota: Funcióngetter para la propiedad requiredStatus.
Véase también setRequiredStatus().
void QSqlField::setAutoValue(bool autoVal)
Establece el valor de « autoValue » en « autoVal ».
Nota: Funciónde asignación para la propiedad autoValue.
Véase también isAutoValue().
void QSqlField::setDefaultValue(const QVariant &value)
Establece el valor de « defaultValue » en « value ».
Nota: Funciónde asignación para la propiedad defaultValue.
Véase también defaultValue().
void QSqlField::setGenerated(bool gen)
Establece el valor de « generated » en « gen ».
Nota: Funciónde asignación para la propiedad generated.
Véase también isGenerated().
void QSqlField::setLength(int fieldLength)
Establece « length » en « fieldLength ».
Nota: Funciónde asignación para la propiedad length.
Véase también length().
void QSqlField::setMetaType(QMetaType type)
Establece el valor de « metaType » en « type ».
Nota: Funciónde asignación para la propiedad metaType.
Véase también metaType().
void QSqlField::setName(const QString &name)
Establece el valor de « name » en « name ».
Nota: Funciónde asignación para la propiedad name.
Véase también name().
void QSqlField::setPrecision(int precision)
Establece el valor de « precision » en « precision ».
Nota: Funciónde asignación para la propiedad precision.
Véase también precision().
void QSqlField::setReadOnly(bool readOnly)
Establece el valor de « readOnly » en « readOnly ».
Nota: Funciónde asignación para la propiedad readOnly.
Véase también isReadOnly().
void QSqlField::setRequired(bool required)
Establece el estado requerido de este campo en « Required » si « required » es verdadero; en caso contrario, lo establece en « Optional ».
Véase también « requiredStatus ».
void QSqlField::setRequiredStatus(QSqlField::RequiredStatus required)
Establece el valor de « requiredStatus » en « required ».
Nota: Funciónde asignación para la propiedad requiredStatus.
Véase también requiredStatus().
void QSqlField::setTableName(const QString &tableName)
Establece el valor de « tableName » en « tableName ».
Nota: Funciónde asignación para la propiedad tableName.
Véase también tableName().
void QSqlField::setValue(const QVariant &value)
Establece el valor de « value » en « value ».
Nota: Funciónde asignación para la propiedad value.
Véase también value().
[noexcept, since 6.6] void QSqlField::swap(QSqlField &other)
Intercambia este campo con other. Esta operación es muy rápida y nunca falla.
Esta función se introdujo en Qt 6.6.
QString QSqlField::tableName() const
Devuelve el nombre de la tabla (tableName).
Nota: Funcióngetter para la propiedad tableName.
Véase también setTableName().
QVariant QSqlField::value() const
Devuelve el valor de «value».
Nota: Funcióngetter para la propiedad «value».
Véase también setValue().
bool QSqlField::operator!=(const QSqlField &other) const
Devuelve « true » si el campo no es igual a « other »; en caso contrario, devuelve «false».
QSqlField &QSqlField::operator=(const QSqlField &other)
Establece el valor del campo en « other ».
bool QSqlField::operator==(const QSqlField &other) const
Devuelve « true » si el campo es igual a « other »; en caso contrario, devuelve «false».
© 2026 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.