354 lines
8.6 KiB
C++
354 lines
8.6 KiB
C++
/****************************************************************************
|
|
**
|
|
** Copyright (C) 2016 The Qt Company Ltd.
|
|
** Contact: https://www.qt.io/licensing/
|
|
**
|
|
** This file is part of the QtSql module of the Qt Toolkit.
|
|
**
|
|
** $QT_BEGIN_LICENSE:LGPL$
|
|
** Commercial License Usage
|
|
** Licensees holding valid commercial Qt licenses may use this file in
|
|
** accordance with the commercial license agreement provided with the
|
|
** Software or, alternatively, in accordance with the terms contained in
|
|
** a written agreement between you and The Qt Company. For licensing terms
|
|
** and conditions see https://www.qt.io/terms-conditions. For further
|
|
** information use the contact form at https://www.qt.io/contact-us.
|
|
**
|
|
** GNU Lesser General Public License Usage
|
|
** Alternatively, this file may be used under the terms of the GNU Lesser
|
|
** General Public License version 3 as published by the Free Software
|
|
** Foundation and appearing in the file LICENSE.LGPL3 included in the
|
|
** packaging of this file. Please review the following information to
|
|
** ensure the GNU Lesser General Public License version 3 requirements
|
|
** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
|
|
**
|
|
** GNU General Public License Usage
|
|
** Alternatively, this file may be used under the terms of the GNU
|
|
** General Public License version 2.0 or (at your option) the GNU General
|
|
** Public license version 3 or any later version approved by the KDE Free
|
|
** Qt Foundation. The licenses are as published by the Free Software
|
|
** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
|
|
** included in the packaging of this file. Please review the following
|
|
** information to ensure the GNU General Public License requirements will
|
|
** be met: https://www.gnu.org/licenses/gpl-2.0.html and
|
|
** https://www.gnu.org/licenses/gpl-3.0.html.
|
|
**
|
|
** $QT_END_LICENSE$
|
|
**
|
|
****************************************************************************/
|
|
|
|
#include "qsqlerror.h"
|
|
#include "qdebug.h"
|
|
|
|
QT_BEGIN_NAMESPACE
|
|
|
|
#ifndef QT_NO_DEBUG_STREAM
|
|
QDebug operator<<(QDebug dbg, const QSqlError &s)
|
|
{
|
|
QDebugStateSaver saver(dbg);
|
|
dbg.nospace();
|
|
dbg << "QSqlError(" << s.nativeErrorCode() << ", " << s.driverText()
|
|
<< ", " << s.databaseText() << ')';
|
|
return dbg;
|
|
}
|
|
#endif
|
|
|
|
class QSqlErrorPrivate
|
|
{
|
|
public:
|
|
QString driverError;
|
|
QString databaseError;
|
|
QSqlError::ErrorType errorType;
|
|
QString errorCode;
|
|
};
|
|
|
|
|
|
/*!
|
|
\class QSqlError
|
|
\brief The QSqlError class provides SQL database error information.
|
|
|
|
\ingroup database
|
|
\inmodule QtSql
|
|
|
|
A QSqlError object can provide database-specific error data,
|
|
including the driverText() and databaseText() messages (or both
|
|
concatenated together as text()), and the nativeErrorCode() and
|
|
type().
|
|
|
|
\sa QSqlDatabase::lastError(), QSqlQuery::lastError()
|
|
*/
|
|
|
|
/*!
|
|
\enum QSqlError::ErrorType
|
|
|
|
This enum type describes the context in which the error occurred, e.g., a connection error, a statement error, etc.
|
|
|
|
\value NoError No error occurred.
|
|
\value ConnectionError Connection error.
|
|
\value StatementError SQL statement syntax error.
|
|
\value TransactionError Transaction failed error.
|
|
\value UnknownError Unknown error.
|
|
*/
|
|
|
|
/*!
|
|
\obsolete
|
|
|
|
Constructs an error containing the driver error text \a
|
|
driverText, the database-specific error text \a databaseText, the
|
|
type \a type and the optional error number \a number.
|
|
*/
|
|
|
|
#if QT_DEPRECATED_SINCE(5, 3)
|
|
QSqlError::QSqlError(const QString& driverText, const QString& databaseText, ErrorType type,
|
|
int number)
|
|
{
|
|
d = new QSqlErrorPrivate;
|
|
|
|
d->driverError = driverText;
|
|
d->databaseError = databaseText;
|
|
d->errorType = type;
|
|
if (number != -1)
|
|
d->errorCode = QString::number(number);
|
|
}
|
|
#endif
|
|
|
|
/*!
|
|
Constructs an error containing the driver error text \a
|
|
driverText, the database-specific error text \a databaseText, the
|
|
type \a type and the error code \a code.
|
|
*/
|
|
|
|
QSqlError::QSqlError(const QString &driverText, const QString &databaseText,
|
|
ErrorType type, const QString &code)
|
|
{
|
|
d = new QSqlErrorPrivate;
|
|
|
|
d->driverError = driverText;
|
|
d->databaseError = databaseText;
|
|
d->errorType = type;
|
|
d->errorCode = code;
|
|
}
|
|
|
|
|
|
/*!
|
|
Creates a copy of \a other.
|
|
*/
|
|
QSqlError::QSqlError(const QSqlError& other)
|
|
{
|
|
d = new QSqlErrorPrivate;
|
|
|
|
*d = *other.d;
|
|
}
|
|
|
|
/*!
|
|
Assigns the \a other error's values to this error.
|
|
*/
|
|
|
|
QSqlError& QSqlError::operator=(const QSqlError& other)
|
|
{
|
|
*d = *other.d;
|
|
return *this;
|
|
}
|
|
|
|
/*!
|
|
Compare the \a other error's values to this error and returns \c true, if it equal.
|
|
*/
|
|
|
|
bool QSqlError::operator==(const QSqlError& other) const
|
|
{
|
|
return (d->errorType == other.d->errorType);
|
|
}
|
|
|
|
|
|
/*!
|
|
Compare the \a other error's values to this error and returns \c true if it is not equal.
|
|
*/
|
|
|
|
bool QSqlError::operator!=(const QSqlError& other) const
|
|
{
|
|
return (d->errorType != other.d->errorType);
|
|
}
|
|
|
|
|
|
/*!
|
|
Destroys the object and frees any allocated resources.
|
|
*/
|
|
|
|
QSqlError::~QSqlError()
|
|
{
|
|
delete d;
|
|
}
|
|
|
|
/*!
|
|
Returns the text of the error as reported by the driver. This may
|
|
contain database-specific descriptions. It may also be empty.
|
|
|
|
\sa databaseText(), text()
|
|
*/
|
|
QString QSqlError::driverText() const
|
|
{
|
|
return d->driverError;
|
|
}
|
|
|
|
/*!
|
|
\fn void QSqlError::setDriverText(const QString &driverText)
|
|
\obsolete
|
|
|
|
Sets the driver error text to the value of \a driverText.
|
|
|
|
Use QSqlError(const QString &driverText, const QString &databaseText,
|
|
ErrorType type, int number) instead
|
|
|
|
\sa driverText(), setDatabaseText(), text()
|
|
*/
|
|
|
|
#if QT_DEPRECATED_SINCE(5, 1)
|
|
void QSqlError::setDriverText(const QString& driverText)
|
|
{
|
|
d->driverError = driverText;
|
|
}
|
|
#endif
|
|
|
|
/*!
|
|
Returns the text of the error as reported by the database. This
|
|
may contain database-specific descriptions; it may be empty.
|
|
|
|
\sa driverText(), text()
|
|
*/
|
|
|
|
QString QSqlError::databaseText() const
|
|
{
|
|
return d->databaseError;
|
|
}
|
|
|
|
/*!
|
|
\fn void QSqlError::setDatabaseText(const QString &databaseText)
|
|
\obsolete
|
|
|
|
Sets the database error text to the value of \a databaseText.
|
|
|
|
Use QSqlError(const QString &driverText, const QString &databaseText,
|
|
ErrorType type, int number) instead
|
|
|
|
\sa databaseText(), setDriverText(), text()
|
|
*/
|
|
|
|
#if QT_DEPRECATED_SINCE(5, 1)
|
|
void QSqlError::setDatabaseText(const QString& databaseText)
|
|
{
|
|
d->databaseError = databaseText;
|
|
}
|
|
#endif
|
|
|
|
/*!
|
|
Returns the error type, or -1 if the type cannot be determined.
|
|
*/
|
|
|
|
QSqlError::ErrorType QSqlError::type() const
|
|
{
|
|
return d->errorType;
|
|
}
|
|
|
|
/*!
|
|
\fn void QSqlError::setType(ErrorType type)
|
|
\obsolete
|
|
|
|
Sets the error type to the value of \a type.
|
|
|
|
Use QSqlError(const QString &driverText, const QString &databaseText,
|
|
ErrorType type, int number) instead
|
|
|
|
\sa type()
|
|
*/
|
|
|
|
#if QT_DEPRECATED_SINCE(5, 1)
|
|
void QSqlError::setType(ErrorType type)
|
|
{
|
|
d->errorType = type;
|
|
}
|
|
#endif
|
|
|
|
/*!
|
|
\fn int QSqlError::number() const
|
|
\obsolete
|
|
|
|
Returns the database-specific error number, or -1 if it cannot be
|
|
determined.
|
|
|
|
Returns 0 if the error code is not an integer.
|
|
|
|
\warning Some databases use alphanumeric error codes, which makes
|
|
number() unreliable if such a database is used.
|
|
|
|
Use nativeErrorCode() instead
|
|
|
|
\sa nativeErrorCode()
|
|
*/
|
|
|
|
#if QT_DEPRECATED_SINCE(5, 3)
|
|
int QSqlError::number() const
|
|
{
|
|
return d->errorCode.isEmpty() ? -1 : d->errorCode.toInt();
|
|
}
|
|
#endif
|
|
|
|
/*!
|
|
\fn void QSqlError::setNumber(int number)
|
|
\obsolete
|
|
|
|
Sets the database-specific error number to \a number.
|
|
|
|
Use QSqlError(const QString &driverText, const QString &databaseText,
|
|
ErrorType type, int number) instead
|
|
|
|
\sa number()
|
|
*/
|
|
|
|
#if QT_DEPRECATED_SINCE(5, 1)
|
|
void QSqlError::setNumber(int number)
|
|
{
|
|
d->errorCode = QString::number(number);
|
|
}
|
|
#endif
|
|
|
|
/*!
|
|
Returns the database-specific error code, or an empty string if
|
|
it cannot be determined.
|
|
*/
|
|
|
|
QString QSqlError::nativeErrorCode() const
|
|
{
|
|
return d->errorCode;
|
|
}
|
|
|
|
/*!
|
|
This is a convenience function that returns databaseText() and
|
|
driverText() concatenated into a single string.
|
|
|
|
\sa driverText(), databaseText()
|
|
*/
|
|
|
|
QString QSqlError::text() const
|
|
{
|
|
QString result = d->databaseError;
|
|
if (!d->databaseError.endsWith(QLatin1String("\n")))
|
|
result += QLatin1Char(' ');
|
|
result += d->driverError;
|
|
return result;
|
|
}
|
|
|
|
/*!
|
|
Returns \c true if an error is set, otherwise false.
|
|
|
|
Example:
|
|
\snippet code/src_sql_kernel_qsqlerror.cpp 0
|
|
|
|
\sa type()
|
|
*/
|
|
bool QSqlError::isValid() const
|
|
{
|
|
return d->errorType != NoError;
|
|
}
|
|
|
|
QT_END_NAMESPACE
|