Skip to content
GitLab
Select Git revision
  • 6.2
  • dev default
  • 6.2.2
  • 5.12
  • 5.12.12
  • 6.2.1
  • 6.2.0
  • 6.1
  • 6.1.3
  • 6.0
  • 6.1.2
  • 6.1.1
  • 5.12.11
  • 6.1.0
  • 5.15
  • 6.0.0
  • 5.15.2
  • 5.12.10
  • 5.15.1
  • 5.12.9
  • v5.15.0-alpha1
  • v5.12.7
  • v5.14.1
  • v5.9.9
  • v5.14.0
  • v5.14.0-rc2
  • v5.14.0-rc1
  • v5.12.6
  • v5.14.0-beta3
  • v5.13.2
  • v5.14.0-beta2
  • v5.14.0-beta1
  • v5.14.0-alpha1
  • v5.12.5
  • v5.13.1
  • v5.13.0
  • v5.13.0-rc3
  • v5.12.4
  • v5.13.0-rc2
  • v5.13.0-rc1
Find file BlameHistoryPermalink
datastorage.qdoc 10.45 KiB
1 
/****************************************************************************
2 
**
3 
** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
4 
** Contact: http://www.qt-project.org/legal
5 
**
6 
** This file is part of the documentation of the Qt Toolkit.
7 
**
8 
** $QT_BEGIN_LICENSE:FDL$
9 
** Commercial License Usage
10 
** Licensees holding valid commercial Qt licenses may use this file in
11 
** accordance with the commercial license agreement provided with the
12 
** Software or, alternatively, in accordance with the terms contained in
13 
** a written agreement between you and Digia.  For licensing terms and
14 
** conditions see http://qt.digia.com/licensing.  For further information
15 
** use the contact form at http://qt.digia.com/contact-us.
16 
**
17 
** GNU Free Documentation License Usage
18 
** Alternatively, this file may be used under the terms of the GNU Free
19 
** Documentation License version 1.3 as published by the Free Software
20 
** Foundation and appearing in the file included in the packaging of
21 
** this file.  Please review the following information to ensure
22 
** the GNU Free Documentation License version 1.3 requirements
23 
** will be met: http://www.gnu.org/copyleft/fdl.html.
24 
** $QT_END_LICENSE$
25 
**
26 
****************************************************************************/
27
28 
/*!
29 
\page topics-data-storage.html
30 
\title Data Storage
31 
\brief Qt's data storage features
32
33 
\section1 Saving and Loading Data
34
35 
The QIODevice class is the base class for all file and data storage devices
36 
in \l {Qt Core}. All classes that are used for reading and writing data
37 
inherit from it.
38
39 
Examples of devices are QFile, QBuffer, QTcpSocket, and QProcess.
40 
QFile is used for reading and writing text, binary files, and resources.
41 
The QBuffer class provides a QIODevice interface for a QByteArray.
42 
QTcpSocket enables the developer to establish a TCP connection and transfer
43 
streams of data. QProcess is used to start external programs, and to read
44 
from and write to that process.
45
46 
\list
47 
\li \l {Input/Output and Networking} (list of I/O related classes)
48 
\li \l {File and Datastream Functions}
49 
\li \l {Serializing Qt Data Types}
50 
\endlist
51
52 
\section1 SQL support in Qt
53
54 
The \l {Qt SQL} module uses driver plugins to communicate with several database
55 
APIs. Qt has drivers for SQLite, MySQL, DB2, Borland InterBase, Oracle, ODBC,
56 
and PostgreSQL. It is also possible to develop your own driver if Qt does not
57 
provide the driver needed.
58
59 
Qt's SQL classes can be divided in 3 layers:
60 
\table
61 
    \header
62 
        \li Layer
63 
        \li Purpose
64 
        \li Example class
65 
    \row
66 
        \li
67 
            \list
68 
               \li Driver layer
69 
               \li SQL API layer
70 
               \li User Interface layer
7172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140
\endlist \li \list \li Low-level communication between database and the SQL API layer \li Provide access to databases \li Link data from a database to data-aware widgets \endlist \li \list \li QSqlDriver, QSqlDriverCreator \li QSqlDatabase, QSqlQuery \li QSqlQueryModel (readonly), QSqlTableModel (read/write), QSqlRelationalTableModel (read/write with foreign-key support) \endlist \endtable With the MySQL driver, it is possible to connect to a MySQL server. In order to build the QMYSQL Plugin for Unix or Mac OS X, you need the MySQL header files as well as the shared library, libmysqlclient.so. To compile the plugin for Windows, install MySQL. If you use the embedded MySQL Server, you do not need a MySQL server in order to use that database system. In order to do so, you need to link the Qt plugin to libmysqld instead of libmysqlclient. The Qt SQLite plugin is very suitable for local storage. SQLite is a relational database management system contained in a small (~350 KiB) C library. In contrast to other database management systems, SQLite is not a separate process that is accessed from the client application, but an integral part of it. SQLite operates on a single file, which must be set as the database name when opening a connection. If the file does not exist, SQLite will try to create it. SQLite has some restrictions regarding multiple users and multiple transactions. If you are reading or writing on a file from different transactions, your application might freeze until one transaction commits or rolls back. Once the driver part is set up, the data is accessible using the classes, QSqlQueryModel, QSqlTableModel, and QSqlRelationalTableModel. QSqlTableModel and QtSqlRelationalTableModel provide editable models that can used with Qt's item views. QSqlTableModel has read/write access to a single table, whereas QSqlRelationalTableModel has read/write access to the main table (not to the table with the foreign key). The following pages contain information about incorporating SQL into applications: \list \li \l {SQL Programming} \list \li \l{Database Classes} \li \l{Executing SQL Statements} \li \l{Using the SQL Model Classes} \li \l{Presenting Data in a Table View} \li \l{Creating Data-Aware Forms} \endlist \endlist \section1 XML Support in Qt Qt provides APIs to read and parse XML streams, and also to write to these streams. The following key classes facilitate these actions by providing the necessary infrastructure: \list \li QXmlStreamReader class provides a parser to read XML. It is a well-formed XML 1.0 parser that does not include external parsed entities. \list \li It understands and resolves XML namespaces. For example, in case of a StartElement, namespaceUri() returns the namespace the element is in, and name() returns the element's local name. The combination of namespaceUri() and name() uniquely identifies an element. \li It is not CPU-intensive, as it doesn't store the entire XML document tree in memory. It only stores the current token at the time
141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210
it is reported. \endlist \li The QXmlStreamWriter class provides an XML writer with a simple streaming API. It is the counterpart to QXmlStreamReader for writing XML, and it operates on a QIODevice specified with setDevice(). \list \li It is a simple API that provides a dedicated function for every XML token or event you want to write. \li It takes care of prefixing namespaces based on the namespaceUri specified while writing elements or attributes. If you have to use certain standardized prefixes, you can force the writer to use them by declaring the namespaces manually with either writeNamespace() or writeDefaultNamespace(). \li It can automatically format the generated XML data by adding line-breaks and indentation, making it readable. This feature can be turned on with the auto-formatting property. \li It encodes XML in UTF-8 by default. Different encodings can be enforced using setCodec(). \endlist \endlist Besides reading and writing to XML streams, Qt also provides APIs for the following additional use cases: \list \li Querying an XML data source using XQuery and XPath \li XML transformation using XSLT \li XML schema validation \endlist The following topics provide more insight into Qt XML support: \list \li \l {An Introduction to Namespaces} \li \l {XML Streaming} \li \l {A Short Path to XQuery} \li \l {XmlListModel} \li \l {Qt XML Patterns} \endlist \section1 JSON in Qt JSON is a text-based open standard for data interchange that is easy to read and parse. It is used for representing simple data structures and associative arrays, called objects. It is related to JavaScript, but is a language-independent notation form. An object can take 2 forms: \table \header \list \li Collection of name/value pairs \li Ordered list of values \endlist \row \li \list \li { "last_name": "Routledge", "first_name": "Ronald", "birth_date": 1960 } \li "colours": ["green", "blue", "yellow"] \endlist \li \endtable \list \li \l {JSON Support in Qt} \endlist
211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280
\section1 Local Storage The Local Storage API provides the ability to access local offline storage in an SQL database from QML and JavaScript. These databases are user-specific and QML-specific, but accessible to all QML applications. They are stored in the Databases subdirectory of QDeclarativeEngine::offlineStoragePath() as SQLite databases (\l {SQL Database Drivers}). The API conforms to the Synchronous API of the HTML5 Web Database API, W3C Working Draft 29 October 2009 (\l {HTML5 Web Database API}). The \l {SQL Local Storage Example} demonstrates the basics of using the Local Storage API. \list \li \l {Qt Quick Local Storage QML Types} \endlist \section1 QSettings The QSettings class provides persistent storage of application settings. An application usually remembers its settings from the previous session. Settings are stored differently on different platforms. For example, on Windows they are stored in the registry, whereas, on MAC OS X they are stored in XML files. QSettings enable you to save and restore application settings in a portable manner. Constructing and destroying a QSettings object is lightweight and fast. While creating an object of QSettings, it is a good practice to specify not only the name of the application, but also the name of your organization. For example: \code QSettings settings("MyCompany", "Accountancy"); \endcode \section1 Resources The Qt Resource System is a platform-independent mechanism for storing binary files in the application's executable. This is handy if your application frequently needs a certain file, or set of files. It also protects against loss of that particular file . Resource data can either be compiled into the binary and accessed immediately in the application code, or a binary resource can be created dynamically and registered with the resource system by the application. By default, resources are accessible from the application code by the same file name as they are stored in the source tree, with a \c{:/} prefix, or by a URL with a qrc scheme. \list \li \l {The Qt Resource System} \endlist \section1 File Archiving An archive file is a collection of files or directories which are generally compressed in order to reduce the space they would otherwise consume on a drive. Examples of archive files are ZIP, TAR, RAR and 7z. Qt has support for archives produced by zlib (see \l{How to compress data with Qt?}{qCompress() and qUncompress()}). There are also several \l{Add-ons}{3rd party libraries} which can be used. */
281