diff options
| -rw-r--r-- | src/sql/doc/src/sql-driver.qdoc | 54 | ||||
| -rw-r--r-- | src/sql/doc/src/sql-programming.qdoc | 13 |
2 files changed, 33 insertions, 34 deletions
diff --git a/src/sql/doc/src/sql-driver.qdoc b/src/sql/doc/src/sql-driver.qdoc index 364d733e92..4f3f2ce007 100644 --- a/src/sql/doc/src/sql-driver.qdoc +++ b/src/sql/doc/src/sql-driver.qdoc @@ -62,7 +62,7 @@ \endtable SQLite is the in-process database system with the best test coverage - and support on all platforms. Oracle via OCI, and PostreSQL and MySQL + and support on all platforms. Oracle via OCI, PostgreSQL, and MySQL through either ODBC or a native driver are well-tested on Windows and Linux. The completeness of the support for other systems depends on the availability and quality of client libraries. @@ -92,7 +92,7 @@ on Windows), then pass the following parameter to configure: \c -I/usr/local/mysql (or \c{-I C:\mysql\include} for Windows). - On Windows the \c -I parameter doesn't accept spaces in + On Windows, the \c -I parameter doesn't accept spaces in filenames, so use the 8.3 name instead; for example, use \c{C:\progra~1\mysql} instead of \c{C:\Program Files\mysql}. @@ -110,7 +110,7 @@ \section3 QMYSQL Stored Procedure Support MySQL 5 introduces stored procedure support at the SQL level, but no - API to control IN, OUT and INOUT parameters. Therefore, parameters + API to control IN, OUT, and INOUT parameters. Therefore, parameters have to be set and read using SQL commands instead of QSqlQuery::bindValue(). Example stored procedure: @@ -141,8 +141,8 @@ \section3 How to Build the QMYSQL Plugin on Unix and \macos - You need the MySQL header files and as well as the shared library - \c{libmysqlclient.so}. Depending on your Linux distribution you may + You need the MySQL header files, as well as the shared library + \c{libmysqlclient.so}. Depending on your Linux distribution, you may need to install a package which is usually called "mysql-devel". Tell \l qmake where to find the MySQL header files and shared @@ -168,10 +168,10 @@ If you are not using a Microsoft compiler, replace \c nmake with \c make in the line above. - \note Including \c{"-o Makefile"} as an argument to \l qmake to - tell it where to build the makefile can cause the plugin to be - built in release mode only. If you are expecting a debug version - to be built as well, don't use the \c{"-o Makefile"} option. + \note Including \c{"-o Makefile"} as an argument to \l qmake, to + tell it where to build the makefile, can cause the plugin to be + built in release mode only. If you intend to build a debug version + as well, don't use the \c{"-o Makefile"} option. \target QOCI \section2 QOCI for the Oracle Call Interface (OCI) @@ -184,7 +184,7 @@ It's possible to connect to a Oracle database without a tnsnames.ora file. This requires that the database SID is passed to the driver as the database - name and that a hostname is given. + name, and that a hostname is given. \section3 OCI User Authentication @@ -230,13 +230,13 @@ \snippet code/doc_src_sql-driver.qdoc 7 \b{Note:} If you are using the Oracle Instant Client package, - you will need to set LD_LIBRARY_PATH when building the OCI SQL plugin + you will need to set LD_LIBRARY_PATH when building the OCI SQL plugin, and when running an application that uses the OCI SQL plugin. You can - avoid this requirement by setting and RPATH and listing all of the + avoid this requirement by setting RPATH, and listing all of the libraries to link to. Here is an example: \snippet code/doc_src_sql-driver.qdoc 32 - If you wish to build the OCI plugin manually with this method the procedure looks like this: + If you wish to build the OCI plugin manually with this method, the procedure looks like this: \snippet code/doc_src_sql-driver.qdoc 33 \section3 How to Build the OCI Plugin on Windows @@ -254,7 +254,7 @@ If you are not using a Microsoft compiler, replace \c nmake with \c make in the line above. - When you run your application you will also need to add the \c oci.dll + When you run your application, you will also need to add the \c oci.dll path to your \c PATH environment variable: \snippet code/doc_src_sql-driver.qdoc 9 @@ -271,25 +271,25 @@ driver manager that is installed on your system. The QODBC plugin then allows you to use these data sources in your Qt applications. - \b{Note:} You should use native drivers in preference to the ODBC - driver where they are available. ODBC support can be used as a fallback - for compliant databases if no native drivers are available. + \b{Note:} You should use the native driver, if it is available, instead + of the ODBC driver. ODBC support can be used as a fallback for compliant + databases if no native driver is available. - On Windows an ODBC driver manager should be installed by default. - For Unix systems there are some implementations which must be + On Windows, an ODBC driver manager should be installed by default. + For Unix systems, there are some implementations which must be installed first. Note that every client that uses your application is required to have an ODBC driver manager installed, otherwise the QODBC plugin will not work. - Be aware that when connecting to an ODBC datasource you must pass in - the name of the ODBC datasource to the QSqlDatabase::setDatabaseName() - function rather than the actual database name. + When connecting to an ODBC datasource, you should pass the name + of the ODBC datasource to the QSqlDatabase::setDatabaseName() + function, rather than the actual database name. The QODBC Plugin needs an ODBC compliant driver manager version 2.0 or - later to work. Some ODBC drivers claim to be version 2.0 compliant, + later. Some ODBC drivers claim to be version-2.0-compliant, but do not offer all the necessary functionality. The QODBC plugin therefore checks whether the data source can be used after a - connection has been established and refuses to work if the check + connection has been established, and refuses to work if the check fails. If you don't like this behavior, you can remove the \c{#define ODBC_CHECK_DRIVER} line from the file \c{qsql_odbc.cpp}. Do this at your own risk! @@ -332,7 +332,7 @@ driver and the DBMS must also support Unicode. Some driver managers and drivers don't support UNICODE. To use the - QODBC plugin with such drivers it has to be compiled with the + QODBC plugin with such drivers, it has to be compiled with Q_ODBC_VERSION_2 defined. For the Oracle 9 ODBC driver (Windows), it is necessary to check @@ -368,9 +368,9 @@ The QPSQL driver supports version 7.3 and higher of the PostgreSQL server. We recommend that you use a client library from version 7.3.15, 7.4.13, - 8.0.8, 8.1.4 or more recent as these versions contain security fixes, and + 8.0.8, 8.1.4, or more recent, as these versions contain security fixes, and as the QPSQL driver might not build with older versions of the client - library depending on your platform. + library, depending on your platform. For more information about PostgreSQL visit \l http://www.postgresql.org. diff --git a/src/sql/doc/src/sql-programming.qdoc b/src/sql/doc/src/sql-programming.qdoc index 39381ff296..ece89a30ab 100644 --- a/src/sql/doc/src/sql-programming.qdoc +++ b/src/sql/doc/src/sql-programming.qdoc @@ -227,7 +227,7 @@ Databases, please refer to \l{Data Types for Qt-supported Database Systems} {this table}. - You can iterate back and forth using QSqlQuery::next(), + You can navigate within the dataset using QSqlQuery::next(), QSqlQuery::previous(), QSqlQuery::first(), QSqlQuery::last(), and QSqlQuery::seek(). The current row index is returned by QSqlQuery::at(), and the total number of rows in the result set @@ -242,11 +242,10 @@ \snippet sqldatabase/sqldatabase.cpp 33 - If you iterate through a result set only using next() and seek() - with positive values, you can call - QSqlQuery::setForwardOnly(true) before calling exec(). This is an - easy optimization that will speed up the query significantly when - operating on large result sets. + If you navigate within a result set, and use next() and seek() + only for browsing forward, you can call QSqlQuery::setForwardOnly(true) + before calling exec(). This is an easy optimization that will speed up + the query significantly when operating on large result sets. \section2 Inserting, Updating, and Deleting Records @@ -592,7 +591,7 @@ QDataWidgetMapper operates on a specific database table, mapping items in the table on a row-by-row or column-by-column basis. As a result, - using QDataWidgetMapper with a SQL model is as simple as using it with + using QDataWidgetMapper with an SQL model is as simple as using it with any other table model. \image qdatawidgetmapper-simple.png |