qsqlfield.cpp

Go to the documentation of this file.

// Copyright (C) 2016 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only
// Qt-Security score:significant reason:default
 
#include "qsqlfield.h"
#include "qdebug.h"
 
QT_BEGIN_NAMESPACE
 
class QSqlFieldPrivate : public QSharedData
{
public:
    QSqlFieldPrivate(const QString &name,
                     QMetaType type, const QString &tableName) :
        nm(name), table(tableName), def(QVariant()), type(type),
        req(QSqlField::Unknown), len(-1), prec(-1), tp(-1),
        ro(false), gen(true), autoval(false)
    {}
 
    bool operator==(const QSqlFieldPrivate& other) const
    {
        return (nm == other.nm
                && table == other.table
                && def == other.def
                && type == other.type
                && req == other.req
                && len == other.len
                && prec == other.prec
                && ro == other.ro
                && gen == other.gen
                && autoval == other.autoval);
    }
 
    QString nm;
    QString table;
    QVariant def;
    QMetaType type;
    QSqlField::RequiredStatus req;
    int len;
    int prec;
    int tp;
    bool ro: 1;
    bool gen: 1;
    bool autoval: 1;
};
QT_DEFINE_QESDP_SPECIALIZATION_DTOR(QSqlFieldPrivate)
 
 
/*!
    \class QSqlField
    \brief The QSqlField class manipulates the fields in SQL database tables
    and views.
 
    \ingroup database
    \ingroup shared
    \inmodule QtSql
 
    QSqlField represents the characteristics of a single column in a
    database table or view, such as the data type and column name. A
    field also contains the value of the database column, which can be
    viewed or changed.
 
    Field data values are stored as QVariants. Using an incompatible
    type is not permitted. For example:
 
    \snippet sqldatabase/sqldatabase.cpp 2
 
    However, the field will attempt to cast certain data types to the
    field data type where possible:
 
    \snippet sqldatabase/sqldatabase.cpp 3
 
    QSqlField objects are rarely created explicitly in application
    code. They are usually accessed indirectly through \l{QSqlRecord}s
    that already contain a list of fields. For example:
 
    \snippet sqldatabase/sqldatabase.cpp 4
    \dots
    \snippet sqldatabase/sqldatabase.cpp 5
    \snippet sqldatabase/sqldatabase.cpp 6
 
    A QSqlField object can provide some meta-data about the field, for
    example, its name(), variant metaType(), length(), precision(),
    defaultValue(), typeID(), and its requiredStatus(),
    isGenerated() and isReadOnly(). The field's data can be
    checked to see if it isNull(), and its value() retrieved. When
    editing the data can be set with setValue() or set to NULL with
    clear().
 
    \sa QSqlRecord
*/
 
/*!
    \enum QSqlField::RequiredStatus
 
    Specifies whether the field is required or optional.
 
    \value Required  The field must be specified when inserting records.
    \value Optional  The fields doesn't have to be specified when inserting records.
    \value Unknown  The database driver couldn't determine whether the field is required or
                    optional.
 
    \sa requiredStatus
*/
 
/*!
    \fn QSqlField::QSqlField(const QString &fieldName, QVariant::Type type, const QString &table)
    \deprecated [6.0] Use the constructor taking a QMetaType instead.
    \overload
 
    Constructs an empty field called \a fieldName of variant type \a
    type in \a table.
*/
 
/*!
    \fn void QSqlField::swap(QSqlField &other)
    \since 6.6
    \memberswap{field}
*/
 
/*!
    \since 6.0
 
    \overload
    Constructs an empty field called \a fieldName of type \a
    type in \a table.
*/
QSqlField::QSqlField(const QString &fieldName, QMetaType type, const QString &table)
    : val(QVariant(type, nullptr)),
      d(new QSqlFieldPrivate(fieldName, type, table))
{
}
 
/*!
    Constructs a copy of \a other.
*/
 
QSqlField::QSqlField(const QSqlField &other)
    = default;
 
/*!
    Sets the field equal to \a other.
*/
 
QSqlField& QSqlField::operator=(const QSqlField& other)
    = default;
 
/*! \fn bool QSqlField::operator!=(const QSqlField &other) const
    Returns \c true if the field is unequal to \a other; otherwise returns
    false.
*/
 
/*!
    Returns \c true if the field is equal to \a other; otherwise returns
    false.
*/
bool QSqlField::operator==(const QSqlField& other) const
{
    return ((d == other.d || *d == *other.d)
            && val == other.val);
}
 
/*!
    Destroys the object and frees any allocated resources.
*/
 
QSqlField::~QSqlField()
    = default;
 
/*!
    Sets \l requiredStatus to \a required.
*/
void QSqlField::setRequiredStatus(RequiredStatus required)
{
    detach();
    d->req = required;
}
 
/*! \fn void QSqlField::setRequired(bool required)
 
    Sets the required status of this field to \l Required if \a
    required is true; otherwise sets it to \l Optional.
 
    \sa requiredStatus
*/
 
/*!
    Sets \l length to \a fieldLength.
*/
void QSqlField::setLength(int fieldLength)
{
    detach();
    d->len = fieldLength;
}
 
/*!
    Sets \l precision to \a precision.
*/
void QSqlField::setPrecision(int precision)
{
    detach();
    d->prec = precision;
}
 
/*!
    \property QSqlField::defaultValue
    \since 6.8
 
    This property holds the default value for this field.
    Only some database drivers supports this property. Currently
    those are SQLite, PostgreSQL, Oracle and MySQL/MariaDB.
*/
 
/*!
    Sets \l defaultValue to \a value.
*/
void QSqlField::setDefaultValue(const QVariant &value)
{
    detach();
    d->def = value;
}
 
#if QT_DEPRECATED_SINCE(6, 8)
/*!
    \internal
    \deprecated [6.8] This internal value is no longer used.
*/
void QSqlField::setSqlType(int type)
{
    detach();
    d->tp = type;
}
#endif
 
/*!
    Sets \l generated to \a gen.
*/
void QSqlField::setGenerated(bool gen)
{
    detach();
    d->gen = gen;
}
 
 
/*!
    \property QSqlField::value
    \since 6.8
 
    This property holds the \a value as a QVariant
 
    Setting a \a value to a read-only QSqlField is a no-op.
    If the data type of \a value differs from the field's current
    data type, an attempt is made to cast it to the proper type. This
    preserves the data type of the field in the case of assignment,
    e.g. a QString to an integer data type.
 
    To set the value to NULL, use clear().
*/
 
/*!
    \fn QVariant QSqlField::value() const
 
    Returns the value of \l value.
*/
/*!
    Sets \l value to \a value.
*/
void QSqlField::setValue(const QVariant& value)
{
    if (isReadOnly())
        return;
    val = value;
}
 
/*!
    Clears the value of the field and sets it to NULL.
    If the field is read-only, nothing happens.
*/
 
void QSqlField::clear()
{
    if (isReadOnly())
        return;
    val = QVariant(d->type, nullptr);
}
 
 
/*!
    Sets \l name to \a name.
*/
void QSqlField::setName(const QString& name)
{
    detach();
    d->nm = name;
}
 
/*!
    Sets \l readOnly to \a readOnly.
*/
void QSqlField::setReadOnly(bool readOnly)
{
    detach();
    d->ro = readOnly;
}
 
/*!
    \property QSqlField::name
 
    This property holds the name of the field.
    This can be the column name or a user given alias.
*/
 
/*!
    Returns the value of \l name.
*/
QString QSqlField::name() const
{
    return d->nm;
}
 
/*!
    \property QSqlField::metaType
    \since 6.8
 
    This property holds the field's type as stored in the database.
    Note that the actual value might have a different type,
    Numerical values that are too large to store in a long
    int or double are usually stored as strings to prevent
    precision loss.
 
    \sa QSqlDatabase::numericalPrecisionPolicy
*/
 
/*!
    Returns the value of \l metaType.
*/
QMetaType QSqlField::metaType() const
{
    return d->type;
}
 
/*!
    Sets \l metaType to \a type.
*/
void QSqlField::setMetaType(QMetaType type)
{
    detach();
    d->type = type;
    if (!val.isValid())
        val = QVariant(type, nullptr);
}
 
/*!
    \fn QVariant::Type QSqlField::type() const
    \deprecated [6.0] Use metaType() instead.
 
    Returns the field's type as stored in the database.
    Note that the actual value might have a different type,
    Numerical values that are too large to store in a long
    int or double are usually stored as strings to prevent
    precision loss.
 
    \sa metaType
*/
 
/*!
    \fn void QSqlField::setType(QVariant::Type type)
    \deprecated [6.0] Use setMetaType() instead.
 
    Sets the field's variant type to \a type.
 
    \sa metaType
*/
 
/*!
    \property QSqlField::readOnly
    \since 6.8
 
    When this property is \c true then this QSqlField cannot be modified.
    A read-only field cannot have its value set with setValue() and
    cannot be cleared to NULL with clear().
*/
 
/*!
    Returns the value of \l readOnly.
*/
bool QSqlField::isReadOnly() const
{
    return d->ro;
}
 
/*!
    Returns \c true if the field's value is NULL; otherwise returns
    false.
 
    \sa value
*/
bool QSqlField::isNull() const
{
    return val.isNull();
}
 
/*! \internal
*/
void QSqlField::detach()
{
    d.detach();
}
 
/*!
    \property QSqlField::requiredStatus
    \since 6.8
 
    This property holds the RequiredStatus of the field.
    An \c INSERT will fail if a required field does not have a value.
 
    \sa RequiredStatus
*/
 
/*!
    Returns the value of \l requiredStatus.
*/
QSqlField::RequiredStatus QSqlField::requiredStatus() const
{
    return d->req;
}
 
/*!
    \property QSqlField::length
    \since 6.8
 
    This property holds the field's length.
 
    If the value is negative, it means that the information
    is not available from the database.
    For strings this is the maximum number of characters the string
    can hold; the meaning varies for other types.
*/
 
/*!
    Returns the value of \l length.
*/
int QSqlField::length() const
{
    return d->len;
}
 
/*!
    \property QSqlField::precision
    \since 6.8
 
    This property holds the field's precision; this is only meaningful
    for numeric types.
 
    If the returned value is negative, it means that the information
    is not available from the database.
*/
/*!
    Returns the value of \l precision.
*/
int QSqlField::precision() const
{
    return d->prec;
}
 
/*!
    Sets the value of \l defaultValue.
*/
QVariant QSqlField::defaultValue() const
{
    return d->def;
}
 
#if QT_DEPRECATED_SINCE(6, 8)
/*!
    \internal
    \deprecated [6.8] This internal value is no longer used.
 
    Returns the type ID for the field.
 
    If the returned value is negative, it means that the information
    is not available from the database.
*/
int QSqlField::typeID() const
{
    return d->tp;
}
#endif
 
/*!
    \property QSqlField::generated
    \since 6.8
 
    This property holds the generated state. If \a generated is \c false,
    no SQL will be generated for this field; otherwise, Qt classes such as
    QSqlQueryModel and QSqlTableModel will generate SQL for this field.
*/
 
/*!
    Returns the value of \l generated.
*/
bool QSqlField::isGenerated() const
{
    return d->gen;
}
 
/*!
    Returns \c true if the field's variant type is valid; otherwise
    returns \c false.
*/
bool QSqlField::isValid() const
{
    return d->type.isValid();
}
 
#ifndef QT_NO_DEBUG_STREAM
QDebug operator<<(QDebug dbg, const QSqlField &f)
{
    QDebugStateSaver saver(dbg);
    dbg.nospace();
    dbg << "QSqlField(" << f.name() << ", " << f.metaType().name();
    dbg << ", tableName: " << (f.tableName().isEmpty() ? QStringLiteral("(not specified)") : f.tableName());
    if (f.length() >= 0)
        dbg << ", length: " << f.length();
    if (f.precision() >= 0)
        dbg << ", precision: " << f.precision();
    if (f.requiredStatus() != QSqlField::Unknown)
        dbg << ", required: "
            << (f.requiredStatus() == QSqlField::Required ? "yes" : "no");
    dbg  << ", generated: " << (f.isGenerated() ? "yes" : "no");
    if (!f.defaultValue().isNull())
        dbg << ", defaultValue: \"" << f.defaultValue() << '\"';
    dbg << ", autoValue: " << f.isAutoValue()
        << ", readOnly: " << f.isReadOnly() << ')';
    return dbg;
}
#endif
 
/*!
    \property QSqlField::autoValue
    \since 6.8
 
    If the value is auto-generated by the database,
    for example auto-increment primary key values, this value is \c true.
 
    \note When writing a new record to the database, an \c autoValue field will
    only hold the new value generated by the database once the record has been
    submitted to the database. When using the ODBC driver, due to limitations
    in the ODBC API, the \c isAutoValue() field is only populated in a
    QSqlField resulting from a QSqlRecord obtained by executing a \c SELECT
    query. It is \c false for a QSqlField resulting from a QSqlRecord returned
    from QSqlDatabase::record() or QSqlDatabase::primaryIndex().
*/
 
/*!
    Returns the value of \l autoValue.
*/
bool QSqlField::isAutoValue() const
{
    return d->autoval;
}
 
/*!
    Sets \l autoValue to \a autoVal.
*/
void QSqlField::setAutoValue(bool autoVal)
{
    detach();
    d->autoval = autoVal;
}
 
/*!
    Sets \l tableName to \a tableName.
*/
void QSqlField::setTableName(const QString &tableName)
{
    detach();
    d->table = tableName;
}
 
/*!
    \property QSqlField::tableName
    \since 6.8
 
    This property holds the tableName of the field.
 
    \note When using the QPSQL driver, due to limitations in the libpq library,
    the \c tableName() field is not populated in a QSqlField resulting
    from a QSqlRecord obtained by QSqlQuery::record() of a forward-only query.
*/
/*!
    Returns the \l tableName.
*/
QString QSqlField::tableName() const
{
    return d->table;
}
 
QT_END_NAMESPACE
 
#include "moc_qsqlfield.cpp"