doc/src/qsql.qdoc

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
   4 ** All rights reserved.
   5 ** Contact: Nokia Corporation (qt-info@nokia.com)
   6 **
   7 ** This file is part of the documentation of the Qt Toolkit.
   8 **
   9 ** $QT_BEGIN_LICENSE:LGPL$
  10 ** No Commercial Usage
  11 ** This file contains pre-release code and may not be distributed.
  12 ** You may use this file in accordance with the terms and conditions
  13 ** contained in the Technology Preview License Agreement accompanying
  14 ** this package.
  15 **
  16 ** GNU Lesser General Public License Usage
  17 ** Alternatively, this file may be used under the terms of the GNU Lesser
  18 ** General Public License version 2.1 as published by the Free Software
  19 ** Foundation and appearing in the file LICENSE.LGPL included in the
  20 ** packaging of this file.  Please review the following information to
  21 ** ensure the GNU Lesser General Public License version 2.1 requirements
  22 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  23 **
  24 ** In addition, as a special exception, Nokia gives you certain additional
  25 ** rights.  These rights are described in the Nokia Qt LGPL Exception
  26 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  27 **
  28 ** If you have questions regarding the use of this file, please contact
  29 ** Nokia at qt-info@nokia.com.
  30 **
  31 **
  32 **
  33 **
  34 **
  35 **
  36 **
  37 **
  38 ** $QT_END_LICENSE$
  39 **
  40 ****************************************************************************/
  41
  42 /*!
  43     \namespace QSql
  44     \brief The QSql namespace contains miscellaneous identifiers used throughout
  45     the Qt SQL library.
  46
  47     \ingroup database
  48     \mainclass
  49     \omit ### \module sql \endomit
  50
  51     \sa {QtSql Module}
  52 */
  53
  54 /*!
  55     \enum QSql::Confirm
  56     \compat
  57
  58     This enum type describes edit confirmations.
  59
  60     \value Yes
  61     \value No
  62     \value Cancel
  63 */
  64
  65 /*!
  66     \enum QSql::Op
  67     \compat
  68
  69     This enum type describes edit operations.
  70
  71     \value None
  72     \value Insert
  73     \value Update
  74     \value Delete
  75 */
  76
  77
  78 /*!
  79     \enum QSql::Location
  80
  81     This enum type describes special SQL navigation locations:
  82
  83     \value BeforeFirstRow Before the first record.
  84     \value AfterLastRow After the last record.
  85
  86     \omitvalue BeforeFirst
  87     \omitvalue AfterLast
  88
  89     \sa QSqlQuery::at()
  90 */
  91
  92 /*!
  93     \enum QSql::ParamTypeFlag
  94
  95     This enum is used to specify the type of a bind parameter.
  96
  97     \value In  The bind parameter is used to put data into the database.
  98     \value Out  The bind parameter is used to receive data from the database.
  99     \value InOut  The bind parameter is used to put data into the
 100         database; it will be overwritten with output data on executing
 101         a query.
 102     \value Binary This must be OR'd with one of the other flags if
 103            you want to indicate that the data being transferred is
 104            raw binary data.
 105 */
 106
 107 /*!
 108     \enum QSql::TableType
 109
 110     This enum type describes types of SQL tables.
 111
 112     \value Tables  All the tables visible to the user.
 113     \value SystemTables  Internal tables used by the database.
 114     \value Views  All the views visible to the user.
 115     \value AllTables  All of the above.
 116 */
 117
 118 /*!
 119     \enum QSql::NumericalPrecisionPolicy
 120
 121     This enum type describes at which precision levels numercial values are read from
 122     a database.
 123
 124     Some databases support numerical values with a precision that is not storable in a
 125     C++ basic data type. The default behavior is to bind these values as a QString.
 126     This enum can be used to override this behavior.
 127
 128     \value LowPrecisionInt32  Force 32bit integer values. In case of floating point numbers,
 129                               the fractional part is silently discarded.
 130     \value LowPrecisionInt64  Force 64bit integer values. In case of floating point numbers,
 131                               the fractional part is silently discarded.
 132     \value LowPrecisionDouble Force \c double values.
 133     \value HighPrecision      The default behavior - try to preserve maximum precision.
 134
 135     Note: The actual behaviour if an overflow occurs is driver specific. The Oracle database
 136     just returns an error in this case.
 137 */
 138