src/sql/kernel/qsql.qdoc
changeset 0 1918ee327afb
child 4 3b1da2848fc7
equal deleted inserted replaced
-1:000000000000 0:1918ee327afb
       
     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     \inmodule QtSql
       
    45     \brief The QSql namespace contains miscellaneous identifiers used throughout
       
    46     the Qt SQL library.
       
    47 
       
    48     \inheaderfile QtSql
       
    49     \ingroup database
       
    50 
       
    51 
       
    52     \sa {QtSql Module}
       
    53 */
       
    54 
       
    55 /*!
       
    56     \enum QSql::Confirm
       
    57     \compat
       
    58 
       
    59     This enum type describes edit confirmations.
       
    60 
       
    61     \value Yes
       
    62     \value No
       
    63     \value Cancel
       
    64 */
       
    65 
       
    66 /*!
       
    67     \enum QSql::Op
       
    68     \compat
       
    69 
       
    70     This enum type describes edit operations.
       
    71 
       
    72     \value None
       
    73     \value Insert
       
    74     \value Update
       
    75     \value Delete
       
    76 */
       
    77 
       
    78 
       
    79 /*!
       
    80     \enum QSql::Location
       
    81 
       
    82     This enum type describes special SQL navigation locations:
       
    83 
       
    84     \value BeforeFirstRow Before the first record.
       
    85     \value AfterLastRow After the last record.
       
    86 
       
    87     \omitvalue BeforeFirst
       
    88     \omitvalue AfterLast
       
    89 
       
    90     \sa QSqlQuery::at()
       
    91 */
       
    92 
       
    93 /*!
       
    94     \enum QSql::ParamTypeFlag
       
    95 
       
    96     This enum is used to specify the type of a bind parameter.
       
    97 
       
    98     \value In  The bind parameter is used to put data into the database.
       
    99     \value Out  The bind parameter is used to receive data from the database.
       
   100     \value InOut  The bind parameter is used to put data into the
       
   101         database; it will be overwritten with output data on executing
       
   102         a query.
       
   103     \value Binary This must be OR'd with one of the other flags if
       
   104            you want to indicate that the data being transferred is
       
   105            raw binary data.
       
   106 */
       
   107 
       
   108 /*!
       
   109     \enum QSql::TableType
       
   110 
       
   111     This enum type describes types of SQL tables.
       
   112 
       
   113     \value Tables  All the tables visible to the user.
       
   114     \value SystemTables  Internal tables used by the database.
       
   115     \value Views  All the views visible to the user.
       
   116     \value AllTables  All of the above.
       
   117 */
       
   118 
       
   119 /*!
       
   120     \enum QSql::NumericalPrecisionPolicy
       
   121 
       
   122     This enum type describes at which precision levels numercial values are read from
       
   123     a database.
       
   124 
       
   125     Some databases support numerical values with a precision that is not storable in a
       
   126     C++ basic data type. The default behavior is to bind these values as a QString.
       
   127     This enum can be used to override this behavior.
       
   128 
       
   129     \value LowPrecisionInt32  Force 32bit integer values. In case of floating point numbers,
       
   130                               the fractional part is silently discarded.
       
   131     \value LowPrecisionInt64  Force 64bit integer values. In case of floating point numbers,
       
   132                               the fractional part is silently discarded.
       
   133     \value LowPrecisionDouble Force \c double values.
       
   134     \value HighPrecision      The default behavior - try to preserve maximum precision.
       
   135 
       
   136     Note: The actual behaviour if an overflow occurs is driver specific. The Oracle database
       
   137     just returns an error in this case.
       
   138 */
       
   139