diff options
Diffstat (limited to 'src/sql/doc/src/sql-driver.qdoc')
| -rw-r--r-- | src/sql/doc/src/sql-driver.qdoc | 503 |
1 files changed, 375 insertions, 128 deletions
diff --git a/src/sql/doc/src/sql-driver.qdoc b/src/sql/doc/src/sql-driver.qdoc index feff1bef6f..4cc5b0d050 100644 --- a/src/sql/doc/src/sql-driver.qdoc +++ b/src/sql/doc/src/sql-driver.qdoc @@ -1,29 +1,5 @@ -/**************************************************************************** -** -** Copyright (C) 2020 The Qt Company Ltd. -** Contact: https://www.qt.io/licensing/ -** -** This file is part of the documentation of the Qt Toolkit. -** -** $QT_BEGIN_LICENSE:FDL$ -** 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 Free Documentation License Usage -** Alternatively, this file may be used under the terms of the GNU Free -** Documentation License version 1.3 as published by the Free Software -** Foundation and appearing in the file included in the packaging of -** this file. Please review the following information to ensure -** the GNU Free Documentation License version 1.3 requirements -** will be met: https://www.gnu.org/licenses/fdl-1.3.html. -** $QT_END_LICENSE$ -** -****************************************************************************/ +// Copyright (C) 2020 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only /*! \page sql-driver.html @@ -47,7 +23,7 @@ \table \header \li Driver name \li DBMS \row \li \l{#QDB2}{QDB2} \li IBM DB2 (version 7.1 and above) - \row \li \l{#QIBASE}{QIBASE} \li Borland InterBase + \row \li \l{#QIBASE}{QIBASE} \li Borland InterBase / Firebird \row \li \l{#QMYSQL}{QMYSQL / MARIADB} \li MySQL or MariaDB (version 5.6 and above) \row \li \l{#QOCI}{QOCI} \li Oracle Call Interface Driver (version 12.1 and above) \row \li \l{#QODBC}{QODBC} @@ -55,6 +31,7 @@ ODBC-compliant databases \row \li \l{#QPSQL}{QPSQL} \li PostgreSQL (versions 7.3 and above) \row \li \l{#QSQLITE}{QSQLITE} \li SQLite version 3 + \row \li \l{#QMIMER}{QMIMER} \li Mimer SQL (version 11 and above) \endtable SQLite is the in-process database system with the best test coverage @@ -63,7 +40,7 @@ Linux. The completeness of the support for other systems depends on the availability and quality of client libraries. - \b{Note:} To build a driver plugin you need to have the appropriate + \note To build a driver plugin you need to have the appropriate client library for your Database Management System (DBMS). This provides access to the API exposed by the DBMS, and is typically shipped with it. Most installation programs also allow you to install "development @@ -77,6 +54,8 @@ \target building \section1 Building the Drivers + \target DriverWithQt + \section2 Compile Qt with a specific driver The Qt \c configure script tries to automatically detect the available client libraries on your @@ -87,36 +66,53 @@ The \c configure script cannot detect the necessary libraries and include files if they are not in the standard paths, so it - may be necessary to specify these paths using the \c *_INCDIR=, - \c *_LIBDIR=, or \c *_PREFIX= command-line options. For example, - if your MySQL files are installed in \c /usr/local/mysql (or in - \c{C:/Program Files/MySQL/MySQL Connector C 6.1} on Windows), then pass the - following parameter to configure: \c MYSQL_PREFIX=/usr/local/mysql - (or \c{MYSQL_PREFIX="C:/Program Files/MySQL/MySQL Connector C 6.1"} for Windows). + may be necessary to specify these paths using either + driver-specific include and library path variables or \c CMAKE_INCLUDE_PATH + and \c CMAKE_LIBRARY_PATH. For example, if your MySQL files are + installed in \c{C:\mysql-connector-c-6.1.11-winx64} on Windows, then pass + the following parameter to double-dash part of configure line: + \snippet code/doc_src_sql-driver.qdoc 42 + When you configure drivers in the manner described above, CMake skips any + dependency checks and uses the provided paths as is. This is especially + useful if the package provides its own set of system libraries that + should not be recognized by the build routine. + + In some cases it's more convenient to use \c CMAKE_INCLUDE_PATH + and \c CMAKE_LIBRARY_PATH variables to locate required libraries. + You should prefer this method if module needs to set properties + for the provided target libraries (e.g. this is required for PostgreSQL + and SQLite). + For example, you can do this as follows, to locate MySQL: + \snippet code/doc_src_sql-driver.qdoc 43 + The particulars for each driver are explained below. - \note If something goes wrong and you want qmake to recheck your - available drivers, you must remove \e{config.cache} in - \e{<QTDIR>/qtbase/src/plugins/sqldrivers} - otherwise qmake will not - search for the available drivers again. If you encounter an error during - the qmake stage, open \e{config.log} to see what went wrong. + \note If something goes wrong and you want CMake to recheck your + available drivers, you might need to remove \e{CMakeCache.txt} from the build + directory. + + \target DriverStandalone + \section2 Compile only a specific sql driver - A typical qmake run (in this case to configure for MySQL) looks like this: + A typical \c qt-cmake run (in this case to configure for MySQL) looks like this: \snippet code/doc_src_sql-driver.qdoc 41 + \note As mentioned in \l{#DriverWithQt}{Compile Qt with a specific driver}, + if the driver could not be found or is not enabled, start over by removing + \e{CMakeCache.txt}. Due to the practicalities of dealing with external dependencies, - only the SQLite3 plugin is shipped with binary builds of Qt. + only the SQLite plugin is shipped with binary builds of Qt. + Binary builds of Qt for Windows also include the ODBC plugin. To be able to add additional drivers to the Qt installation without re-building all of Qt, it is possible to configure and build the \c qtbase/src/plugins/sqldrivers directory outside of a full Qt build directory. Note that it is not possible to \e configure each driver separately, only all of them at once. Drivers can be \e built separately, though. - If the Qt build is configured with \c{-prefix}, it is necessary to - install the plugins after building them, too. For example: - \snippet code/doc_src_sql-driver.qdoc 4 + \note You need to specify \c{CMAKE_INSTALL_PREFIX}, if you want to install + plugins after the build is finished. \section1 Driver Specifics @@ -131,7 +127,7 @@ \section3 QMYSQL Stored Procedure Support - MySQL 5 has stored procedure support at the SQL level, but no + MySQL has stored procedure support at the SQL level, but no API to control IN, OUT, and INOUT parameters. Therefore, parameters have to be set and read using SQL commands instead of QSqlQuery::bindValue(). @@ -143,7 +139,7 @@ \snippet code/doc_src_sql-driver.cpp 2 - \b{Note:} \c{@outval1} and \c{@outval2} are variables local to the current + \note \c{@outval1} and \c{@outval2} are variables local to the current connection and will not be affected by queries sent from another host or connection. @@ -155,29 +151,119 @@ To use the embedded MySQL server, simply link the Qt plugin to \c libmysqld instead of \c libmysqlclient. This can be done by adding - \c MYSQL_LIBS=-lmysqld to the configure command line. + \c{-DMySQL_LIBRARY=<path/to/mysqld/>libmysqld.<so|lib|dylib>} to the configure command line. Please refer to the MySQL documentation, chapter "libmysqld, the Embedded MySQL Server Library" for more information about the MySQL embedded server. + \section3 Connection options + The Qt MySQL/MariaDB plugin honors the following connection options: + \table + \header \li Attribute \li Possible value + \row + \li CLIENT_COMPRESS + \li If set, switches to compressed protocol after successful authentication + \row + \li CLIENT_FOUND_ROWS + \li If set, send found rows instead of affected rows + \row + \li CLIENT_IGNORE_SPACE + \li If set, ignore spaces before '(' + \row + \li CLIENT_NO_SCHEMA + \li If set, don't allow database.table.column + \row + \li CLIENT_INTERACTIVE + \li If set, client is treated as interactive + \row + \li MYSQL_OPT_PROTOCOL + \li explicitly specify the protocol to use:\br + MYSQL_PROTOCOL_TCP: use tcp connection (ip/hostname specified through setHostname()) + MYSQL_PROTOCOL_SOCKET: connect through a socket specified in UNIX_SOCKET + MYSQL_PROTOCOL_PIPE: connect through a named pipe specified in UNIX_SOCKET + MYSQL_PROTOCOL_MEMORY: connect through shared memory specified in MYSQL_SHARED_MEMORY_BASE_NAME + \row + \li UNIX_SOCKET + \li Specifies the socket or named pipe to use, even it's called UNIX_SOCKET it + can also be used on windows + \row + \li MYSQL_SHARED_MEMORY_BASE_NAME + \li Specified the shared memory segment name to use + \row + \li MYSQL_OPT_RECONNECT + \li TRUE or 1: Automatically reconnect after connection loss\br + FALSE or 0: No automatic reconnect after connection loss (default)\br + See \l {https://dev.mysql.com/doc/c-api/8.0/en/c-api-auto-reconnect.html} + {Automatic Reconnection Control} + \row + \li MYSQL_OPT_CONNECT_TIMEOUT + \li The connect timeout in seconds + \row + \li MYSQL_OPT_READ_TIMEOUT + \li The timeout in seconds for each attempt to read from the server + \row + \li MYSQL_OPT_WRITE_TIMEOUT + \li The timeout in seconds for each attempt to write to the server + \row + \li MYSQL_OPT_LOCAL_INFILE + \li Set to 1 to enable the support for local + \l {https://dev.mysql.com/doc/refman/8.0/en/load-data.html} {LOAD_DATA}, + disabled if not set or 0 + \row + \li MYSQL_OPT_SSL_MODE + \li The security state to use for the connection to the server: SSL_MODE_DISABLED, + SSL_MODE_PREFERRED, SSL_MODE_REQUIRED, SSL_MODE_VERIFY_CA, SSL_MODE_VERIFY_IDENTITY. + \row + \li MYSQL_OPT_TLS_VERSION + \li A list of protocols the client permits for encrypted connections. The value can be + a combination of 'TLSv1' ,' TLSv1.1', 'TLSv1.2' or 'TLSv1.3' depending on the used \l + {https://dev.mysql.com/doc/refman/8.0/en/encrypted-connection-protocols-ciphers.html#encrypted-connection-protocol-configuration} + {MySQL server} version. + \row + \li MYSQL_OPT_SSL_KEY / SSL_KEY (deprecated) + \li The path name of the client private key file + \row + \li MYSQL_OPT_SSL_CERT / SSL_CERT (deprecated) + \li The path name of the client public key certificate file + \row + \li MYSQL_OPT_SSL_CA / SSL_CA (deprecated) + \li The path name of the Certificate Authority (CA) certificate file + \row + \li MYSQL_OPT_SSL_CAPATH / SSL_CAPATH (deprecated) + \li The path name of the directory that contains trusted SSL CA certificate files + \row + \li MYSQL_OPT_SSL_CIPHER / SSL_CIPHER (deprecated) + \li The list of permissible ciphers for SSL encryption + \row + \li MYSQL_OPT_SSL_CRL + \li The path name of the file containing certificate revocation lists + \row + \li MYSQL_OPT_SSL_CRLPATH + \li The path name of the directory that contains files containing certificate revocation lists + \endtable + For more detailed information about the connect options please refer + to the \l {https://dev.mysql.com/doc/c-api/8.0/en/mysql-options.html} + {mysql_options()} MySQL documentation. + + \section3 How to Build the QMYSQL Plugin on Unix and \macos You need the MySQL / MariaDB header files, as well as the shared library - \c{libmysqlclient.so} / \c{libmariadb.so}. Depending on your Linux distribution, + \c{libmysqlclient.<so|dylib>} / \c{libmariadb.<so|dylib>}. Depending on your Linux distribution, you may need to install a package which is usually called "mysql-devel" or "mariadb-devel". - Tell \l qmake where to find the MySQL / MariaDB header files and shared + Tell \c qt-cmake where to find the MySQL / MariaDB header files and shared libraries (here it is assumed that MySQL / MariaDB is installed in - \c{/usr/local}) and run \c{make}: + \c{/usr/local}) and build: \snippet code/doc_src_sql-driver.qdoc 3 \section3 How to Build the QMYSQL Plugin on Windows You need to get the MySQL installation files (e.g. - \l {https://dev.mysql.com/downloads/installer/}{mysql-installer-web-community-8.0.18.0.msi}) or - \l {https://downloads.mariadb.org/connector-c/3.1.5/}{mariadb-connector-c-3.1.5-win64.msi}. + \l {https://dev.mysql.com/downloads/installer/}{MySQL web installer} or + \l {https://downloads.mariadb.com/Connectors/c/}{MariaDB C Connector}). Run the installer, select custom installation and install the MySQL C Connector which matches your Qt installation (x86 or x64). @@ -200,13 +286,10 @@ \l{https://downloads.mariadb.org/connector-c/}{MariaDB C Connector}. Build the plugin as follows (here it is assumed that \c{<MySQL dir>} is - \c{C:/Program Files/MySQL/MySQL Connector C 6.1}): + \c{C:\mysql-8.0.22-winx64}): \snippet code/doc_src_sql-driver.qdoc 5 - If you are not using a Microsoft compiler, replace \c nmake with \c - mingw32-make above. - When you distribute your application, remember to include \e libmysql.dll / \e libmariadb.dll in your installation package. It must be placed in the same folder as the application executable. \e libmysql.dll additionally needs the @@ -245,33 +328,50 @@ BLOBs are bound to placeholders or QSqlTableModel, which uses a prepared query to do this internally. + \section3 Connection options + The Qt OCI plugin honors the following connection options: + \table + \header \li Attribute \li Possible value + \row + \li OCI_ATTR_PREFETCH_ROWS + \li Sets the OCI attribute + \l {https://docs.oracle.com/database/121/LNOCI/oci04sql.htm#LNOCI16355} + {OCI_ATTR_PREFETCH_ROWS} to the specified value + \row + \li OCI_ATTR_PREFETCH_MEMORY + \li Sets the OCI attribute + \l {https://docs.oracle.com/database/121/LNOCI/oci04sql.htm#LNOCI16355} + {OCI_ATTR_PREFETCH_MEMORY} to the specified value + \row + \li OCI_AUTH_MODE + \li OCI_SYSDBA: authenticate for SYSDBA access\br + OCI_SYSOPER: authenticate for SYSOPER access\br + OCI_DEFAULT: authenticate with normal access\br + see \l {https://docs.oracle.com/cd/B10500_01/appdev.920/a96584/oci15r13.htm} + {OCISessionBegin} for more information about the access modes + \endtable + \section3 How to Build the OCI Plugin on Unix and \macos - All you need is the "Instant Client Package - Basic" and "Instant Client + All you need is the " - Basic" and "Instant Client Package - SDK". Oracle library files required to build the driver: \list - \li \c libclntsh.so (all versions) + \li \c libclntsh.<so|dylib> (all versions) \endlist - Tell \c qmake where to find the Oracle header files and shared - libraries and run make: + Tell \c qt-cmake where to find the Oracle header files and shared + libraries and build. We assume that you installed the RPM packages of the Instant Client Package SDK (you need to adjust the version number accordingly): \snippet code/doc_src_sql-driver.qdoc 7 - \b{Note:} If you are using the Oracle Instant Client package, + \note If you are using the Oracle Instant Client package, 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 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: - \snippet code/doc_src_sql-driver.qdoc 33 + and when running an application that uses the OCI SQL plugin. \section3 How to Build the OCI Plugin on Windows @@ -281,13 +381,10 @@ the "Call Interface (OCI)" option if it is available. Build the plugin as follows (here it is assumed that Oracle Client is - installed in \c{C:\oracle}): + installed in \c{C:\oracle} and SDK is installed in \c{C:\oracle\sdk}): \snippet code/doc_src_sql-driver.qdoc 8 - If you are not using a Microsoft compiler, replace \c nmake with \c - mingw32-make in the line above. - When you run your application, you will also need to add the \c oci.dll path to your \c PATH environment variable: @@ -303,19 +400,24 @@ 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 the native driver, if it is available, instead + \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. + On Windows, an ODBC driver manager is installed by default. For Unix systems, there are some implementations which must be installed first. Note that every end user of your application is required to have an ODBC driver manager installed, otherwise the QODBC plugin will not work. When connecting to an ODBC datasource, you should pass the name - of the ODBC datasource to the QSqlDatabase::setDatabaseName() + of the ODBC datasource (DSN) to the QSqlDatabase::setDatabaseName() function, rather than the actual database name. + It's also possible to pass a FILEDSN (*.dsn) filename or a complete + ODBC driver string. When passing a driver string you must make sure, + that all parameters (username, password, ...) are properly escaped. + Passing the username or password through the QSqlDatabase functions, + the escaping is done by the QODBC plugin. The QODBC Plugin needs an ODBC compliant driver manager version 2.0 or later. Some ODBC drivers claim to be version-2.0-compliant, @@ -339,17 +441,11 @@ e.g., the SQLSTATEs. Before setting this connect option, consult your ODBC documentation about behavior differences you can expect. - When using the SAP HANA database, the connection has to be - established using the option "SCROLLABLERESULT=TRUE", as the - HANA ODBC driver does not provide scrollable results by default, e.g.: - - \snippet code/doc_src_sql-driver.cpp 39 - If you experience very slow access of the ODBC datasource, make sure that ODBC call tracing is turned off in the ODBC datasource manager. Some drivers do not support scrollable cursors. In that case, only - queries in forwardOnly mode can be used successfully. + queries in \l QSqlQuery::setForwardOnly() mode can be used successfully. \section3 ODBC Stored Procedure Support @@ -360,18 +456,68 @@ \snippet code/doc_src_sql-driver.cpp 10 - \b{Note:} The value returned by the stored procedure's return statement + \note The value returned by the stored procedure's return statement is discarded. \section3 ODBC Unicode Support The QODBC Plugin will use the Unicode API if UNICODE is defined. On - Windows NT based systems, this is the default. Note that the ODBC + Windows based systems, this is the default. Note that the ODBC driver and the DBMS must also support Unicode. For the Oracle 9 ODBC driver (Windows), it is necessary to check "SQL_WCHAR support" in the ODBC driver manager otherwise Oracle - will convert all Unicode strings to local 8-bit. + will convert all Unicode strings to local 8-bit representation. + + \section3 Connection options + The Qt ODBC plugin honors the following connection options: + \table + \header \li Attribute \li Possible value + \row + \li SQL_ATTR_ACCESS_MODE + \li SQL_MODE_READ_ONLY: open the database in read-only mode\br + SQL_MODE_READ_WRITE: open the database in read-write mode (default) + \row + \li SQL_ATTR_LOGIN_TIMEOUT + \li Number of seconds to wait for the database connection + during login (a value of 0 will wait forever) + \row + \li SQL_ATTR_CONNECTION_TIMEOUT + \li Number of seconds to wait for any request to the database + (a value of 0 will wait forever) + \row + \li SQL_ATTR_CURRENT_CATALOG + \li The catalog (database) to use for this connection + \row + \li SQL_ATTR_METADATA_ID + \li SQL_TRUE: the string argument of catalog functions are treated + as identifiers\br + SQL_FALSE: the string arguments of catalog functions are not + treated as identifiers + \row + \li SQL_ATTR_PACKET_SIZE + \li Specifies the network packet size in bytes + \row + \li SQL_ATTR_TRACEFILE + \li A string containing the name of the trace file + \row + \li SQL_ATTR_TRACE + \li SQL_OPT_TRACE_ON: Enable database query tracing\br + SQL_OPT_TRACE_OFF: Disable database query tracing (default) + \row + \li SQL_ATTR_CONNECTION_POOLING + \li Enable or disable connection pooling at the environment level.\br + SQL_CP_DEFAULT, SQL_CP_OFF: Connection pooling is turned off (default)\br + SQL_CP_ONE_PER_DRIVER: A single connection pool is supported for each driver\br + SQL_CP_ONE_PER_HENV: A single connection pool is supported for each environment + \row + \li SQL_ATTR_ODBC_VERSION + \li SQL_OV_ODBC3: The driver should act as a ODBC 3.x driver\br + SQL_OV_ODBC2: The driver should act as a ODBC 2.x driver (default) + \endtable + For more detailed information about the connect options please refer + to the \l {https://learn.microsoft.com/en-us/sql/odbc/reference/syntax/sqlsetconnectattr-function} + {SQLSetConnectAttr()} ODBC documentation. \section3 How to Build the ODBC Plugin on Unix and \macos @@ -379,9 +525,9 @@ version and ODBC drivers at \l http://www.unixodbc.org. You need the unixODBC header files and shared libraries. - Tell \c qmake where to find the unixODBC header files and shared + Tell \c qt-cmake where to find the unixODBC header files and shared libraries (here it is assumed that unixODBC is installed in - \c{/usr/local/unixODBC}) and run \c{make}: + \c{/usr/local/unixODBC}) and build: \snippet code/doc_src_sql-driver.qdoc 11 @@ -392,11 +538,8 @@ \snippet code/doc_src_sql-driver.qdoc 12 - If you are not using a Microsoft compiler, replace \c nmake with \c - mingw32-make in the line above. - \target QPSQL - \section2 QPSQL for PostgreSQL (Version 7.3 and Above) + \section2 QPSQL for PostgreSQL (Version 7.3 and above) The QPSQL driver supports version 7.3 and higher of the PostgreSQL server. @@ -465,7 +608,7 @@ database connections, or if we execute query2 after the while loop. \note Some methods of QSqlDatabase like tables(), primaryIndex() - implicity execute SQL queries, so these also cannot be used while + implicitly execute SQL queries, so these also cannot be used while navigating the results of forward-only query. \note QPSQL will print the following warning if it detects a loss of @@ -473,20 +616,25 @@ \snippet code/doc_src_sql-driver.qdoc 38 + \section3 Connection options + The Qt PostgreSQL plugin honors all connection options specified in the + \l {https://www.postgresql.org/docs/current/libpq-connect.html#LIBPQ-PARAMKEYWORDS} + {connect()} PostgreSQL documentation. + \section3 How to Build the QPSQL Plugin on Unix and \macos You need the PostgreSQL client library and headers installed. - To make \c qmake find the PostgreSQL header files and shared - libraries, run \c qmake the following way (assuming that the - PostgreSQL client is installed in \c{/usr}): + To make \c qt-cmake find the PostgreSQL header files and shared + libraries, build the plugin the following way (assuming that the + PostgreSQL client is installed in \c{/usr/local/pgsql}): \snippet code/doc_src_sql-driver.qdoc 13 \section3 How to Build the QPSQL Plugin on Windows Install the appropriate PostgreSQL developer libraries for your - compiler. Assuming that PostgreSQL was installed in \c{C:\psql}, + compiler. Assuming that PostgreSQL was installed in \c{C:\pgsql}, build the plugin as follows: \snippet code/doc_src_sql-driver.qdoc 15 @@ -499,7 +647,7 @@ as the application executable. \target QDB2 - \section2 QDB2 for IBM DB2 (Version 7.1 and Above) + \section2 QDB2 for IBM DB2 (Version 7.1 and above) The Qt DB2 plugin makes it possible to access IBM DB2 databases. It has been tested with IBM DB2 v7.1 and 7.2. You must install the IBM @@ -512,6 +660,20 @@ We suggest using a forward-only query when calling stored procedures in DB2 (see QSqlQuery::setForwardOnly()). + \section3 Connection options + The Qt IBM DB2 plugin honors the following connection options: + \table + \header \li Attribute \li Possible value + \row + \li SQL_ATTR_ACCESS_MODE + \li SQL_MODE_READ_ONLY: open the database in read-only mode\br + SQL_MODE_READ_WRITE: open the database in read-write mode (default) + \row + \li SQL_ATTR_LOGIN_TIMEOUT + \li Number of seconds to wait for the database connection + during login (max: 32767, a value of 0 will wait forever) + \endtable + \section3 How to Build the QDB2 Plugin on Unix and \macos \snippet code/doc_src_sql-driver.qdoc 18 @@ -523,11 +685,8 @@ \snippet code/doc_src_sql-driver.qdoc 20 - If you are not using a Microsoft compiler, replace \c nmake - with \c mingw32-make in the line above. - \target QSQLITE - \section2 QSQLITE for SQLite (Version 3 and Above) + \section2 QSQLITE for SQLite (Version 3 and above) The Qt SQLite plugin makes it possible to access SQLite databases. SQLite is an in-process database, which means that it @@ -560,24 +719,77 @@ You can find information about SQLite on \l{http://www.sqlite.org}. + \section3 Connection options + The Qt SQLite plugin honors the following connection options: + \table + \header \li Attribute \li Possible value + \row + \li QSQLITE_BUSY_TIMEOUT + \li Busy handler timeout in milliseconds (val <= 0: disabled), + see \l {https://www.sqlite.org/c3ref/busy_timeout.html} + {SQLite documentation} for more information + + \row + \li QSQLITE_USE_QT_VFS + \li If set, the database is opened using Qt's VFS which allows to + open databases using QFile. This way it can open databases from + any read-write locations (e.g.android shared storage) but also + from read-only resources (e.g. qrc or android assets). Be aware + that when opening databases from read-only resources make sure + you add QSQLITE_OPEN_READONLY attribute as well. + Otherwise it will fail to open it. + + \row + \li QSQLITE_OPEN_READONLY + \li If set, the database is open in read-only mode which will fail + if no database exists. Otherwise the database will be opened in + read-write mode and created if the database file does not yet + exist (default) + \row + \li QSQLITE_OPEN_URI + \li The given filename is interpreted as an uri, see + \l {https://www.sqlite.org/c3ref/open.html} {SQLITE_OPEN_URI} + \row + \li QSQLITE_ENABLE_SHARED_CACHE + \li If set, the database is opened in + \l {https://www.sqlite.org/sharedcache.html} {shared cache mode}, + otherwise in private cache mode + \row + \li QSQLITE_ENABLE_REGEXP + \li If set, the plugin defines a function 'regex' which can be used + in queries, QRegularExpression is used for evaluation of the regex query + \row + \li QSQLITE_NO_USE_EXTENDED_RESULT_CODES + \li Disables the usage of the \l {https://www.sqlite.org/c3ref/extended_result_codes.html} + {extended result code} feature in SQLite + \row + \li QSQLITE_ENABLE_NON_ASCII_CASE_FOLDING + \li If set, the plugin replaces the functions 'lower' and 'upper' with + QString functions for correct case folding of non-ascii characters + \row + \li QSQLITE_OPEN_NOFOLLOW + \li If set, the database filename is not allowed to contain a symbolic link + \endtable + \section3 How to Build the QSQLITE Plugin SQLite version 3 is included as a third-party library within Qt. - It can be built by passing the \c{-qt-sqlite} parameter to the - configure script. + It can be built by passing the \c{-DFEATURE_system_sqlite=OFF} parameter to the + \c qt-cmake command line. If you do not want to use the SQLite library included with Qt, you - can pass \c{-system-sqlite} to the configure script to use the SQLite - libraries of the operating system. This is recommended whenever possible, - as it reduces the installation size and removes one component for which - you need to track security advisories. + can pass \c{-DFEATURE_system_sqlite=ON} to the \c qt-cmake command + line to use the SQLite libraries of the operating system. This is + recommended whenever possible, as it reduces the installation size + and removes one component for which you need to track security + advisories. On Unix and \macos (replace \c $SQLITE with the directory where SQLite resides): \snippet code/doc_src_sql-driver.qdoc 21 - On Windows: + On Windows (assuming that SQLite is installed in \c{C:\SQLITE}): \snippet code/doc_src_sql-driver.qdoc 23 @@ -614,6 +826,47 @@ Some versions of SQLite can be forced to write a specific file format by setting the \c{SQLITE_DEFAULT_FILE_FORMAT} define when building SQLite. + \target QMIMER + \section2 QMIMER for Mimer SQL version 11 and higher + + The Qt Mimer SQL plugin makes it possible to work with the Mimer SQL RDBMS. + Mimer SQL provides small footprint, scalable and robust relational database + solutions that conform to international ISO SQL standards. Mimer SQL is available + on Windows, Linux, \macos, and OpenVMS as well as several embedded platforms like QNX, Android, + and embedded Linux. + + Mimer SQL fully support Unicode. To work with Unicode data the column types National Character (NCHAR), + National Character Varying (NVARCHAR), or National Character Large Object (NCLOB) must be used. + For more information about Mimer SQL and unicode, see \l{https://developer.mimer.com/features/multilingual-support} + + \section3 QMIMER Stored Procedure Support + + Mimer SQL have stored procedures according to the SQL standard (PSM) and + the plugin fully support IN, OUT, INOUT parameters as well as resultset procedures. + + Example stored procedure with INOUT and OUT parameters: + + \snippet code/doc_src_sql-driver.qdoc 44 + + Source code to access the INOUT and OUT values: + + \snippet code/doc_src_sql-driver.cpp 40 + + \section3 How to Build the QMIMER Plugin on Unix and \macos + + You need the Mimer SQL header files and shared libraries. Get them by installing + any of the Mimer SQL variants found at \l{https://developer.mimer.com}. + + + \snippet code/doc_src_sql-driver.qdoc 31 + + \section3 How to Build the QMIMER Plugin on Windows + + You need the Mimer SQL header files and shared libraries. Get them by installing + any of the Mimer SQL variants found at \l{https://developer.mimer.com}. + + \snippet code/doc_src_sql-driver.qdoc 32 + \target QIBASE \section2 QIBASE for Borland InterBase @@ -627,6 +880,17 @@ database file, no matter whether it is stored locally or on another server. + \section3 Connection options + The Qt Borland InterBase plugin honors the following connection options: + \table + \header \li Attribute \li Possible value + \row + \li ISC_DPB_SQL_ROLE_NAME + \li Specifies the login role name + \endtable + + + \section3 How to Build the QIBASE Plugin \snippet code/doc_src_sql-driver.cpp 24 You need the InterBase/Firebird development headers and libraries @@ -636,20 +900,6 @@ Edition are not allowed to link this plugin to the commercial editions of InterBase. Please use Firebird or the free edition of InterBase. - \section3 QIBASE Unicode Support and Text Encoding - - By default the driver connects to the database using UNICODE_FSS. This can - be overridden by setting the ISC_DPB_LC_CTYPE parameter with - QSqlDatabase::setConnectOptions() before opening the connection. - - \snippet code/doc_src_sql-driver.cpp 25 - - If Qt does not support the given text encoding the driver will issue a - warning message and connect to the database using UNICODE_FSS. - - Note that if the text encoding set when connecting to the database is - not the same as in the database, problems with transliteration might arise. - \section3 QIBASE Stored procedures InterBase/Firebird return OUT values as result set, so when calling stored @@ -680,13 +930,10 @@ \snippet code/doc_src_sql-driver.qdoc 29 - If you are using Firebird, the Firebird library has to be set explicitly: + If you are using Firebird: \snippet code/doc_src_sql-driver.qdoc 30 - If you are not using a Microsoft compiler, replace \c nmake - with \c mingw32-make in the line above. - Note that \c{C:\interbase\bin} must be in the \c PATH. \target troubleshooting @@ -694,7 +941,7 @@ You should always use client libraries that have been compiled with the same compiler as you are using for your project. If you cannot get - a source distibution to compile the client libraries yourself, you + a source distribution to compile the client libraries yourself, you must make sure that the pre-compiled library is compatible with your compiler, otherwise you will get a lot of "undefined symbols" errors. Some compilers have tools to convert libraries, e.g. Borland @@ -715,7 +962,7 @@ Qt Creator, you can update the \c PATH environment variable in the \gui Run section of the \gui Project panel to include the path to the folder containing the client libraries. - \li Compile Qt with \c{QT_DEBUG_COMPONENT} defined to get very verbose + \li Compile Qt with \c{QT_DEBUG_PLUGINS} defined to get very verbose debug output when loading plugins. \endlist |