diff options
Diffstat (limited to 'doc/src/partitions.qdoc')
-rw-r--r-- | doc/src/partitions.qdoc | 58 |
1 files changed, 58 insertions, 0 deletions
diff --git a/doc/src/partitions.qdoc b/doc/src/partitions.qdoc new file mode 100644 index 0000000..64911c2 --- /dev/null +++ b/doc/src/partitions.qdoc @@ -0,0 +1,58 @@ +/**************************************************************************** +** +** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies). +** Contact: http://www.qt-project.org/ +** +** This file is part of the documentation of the Qt Toolkit. +** +** $QT_BEGIN_LICENSE:FDL$ +** GNU Free Documentation License +** 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. +** +** Other Usage +** Alternatively, this file may be used in accordance with the terms +** and conditions contained in a signed written agreement between you +** and Nokia. +** +** +** +** +** +** $QT_END_LICENSE$ +** +****************************************************************************/ + +/*! +\page partitions.html +\title Partitions + +\section1 Introduction + +JSON DB may be configured as a number of partitions, each with its +own unique name. All operations in JSON DB operate on exactly one partition at +a time. + +\section1 Accessing Partitions + +The various partitions in a set are accessed via the \l {Partition} element in QML. In +C++, the partition is selected by \c setPartition() on a +\l {QJsonDbReadRequest}, \l {QJsonDbWriteRequest} or \l {QJsonDbWatcher}. + +\section1 The Ephemeral Partition + +JSON DB offers a partition called \c Ephemeral. Objects written to this +partition are not persistent, but rather stored entirely in memory. The +entire partition is cleared every time the database server is restarted. This +partition can be very useful for storing frequently updated data since it does not +cause any disk I/O. + +\code +QJsonDbReadRequest *request = new QJsonDbReadRequest(this); +request->setQuery("[?_type=\"Status\"]"); +request->setPartition("Ephemeral"); +\endcode + +*/ |