summaryrefslogtreecommitdiffstats
path: root/src/declarative/extra/qmlsqlquery.cpp
blob: 39d3aa2e887676d0058682efe2bac54ce4baace7 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
/****************************************************************************
**
** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
** Contact: Qt Software Information (qt-info@nokia.com)
**
** This file is part of the QtDeclarative module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** No Commercial Usage
** This file contains pre-release code and may not be distributed.
** You may use this file in accordance with the terms and conditions
** contained in the either Technology Preview License Agreement or the
** Beta Release License Agreement.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL included in the
** packaging of this file.  Please review the following information to
** ensure the GNU Lesser General Public License version 2.1 requirements
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Nokia gives you certain
** additional rights. These rights are described in the Nokia Qt LGPL
** Exception version 1.0, included in the file LGPL_EXCEPTION.txt in this
** package.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3.0 as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL included in the
** packaging of this file.  Please review the following information to
** ensure the GNU General Public License version 3.0 requirements will be
** met: http://www.gnu.org/copyleft/gpl.html.
**
** If you are unsure which license is appropriate for your use, please
** contact the sales department at qt-sales@nokia.com.
** $QT_END_LICENSE$
**
****************************************************************************/

#include "qmlsqlquery.h"
#include "qmlsqlconnection.h"
#include "private/qobject_p.h"

#include <QDebug>
#include <QSqlQuery>
#include <QSqlError>
#include <QSqlField>
#include <QSqlRecord>
#include <QSqlDatabase>
#include <QSqlDriver>

QT_BEGIN_NAMESPACE
QML_DEFINE_TYPE(QmlSqlBind, SqlBind);
QML_DEFINE_TYPE(QmlSqlQuery, SqlQuery);

class QmlSqlBindPrivate : public QObjectPrivate
{
    Q_DECLARE_PUBLIC(QmlSqlBind)
public:
    QmlSqlBindPrivate() {}

    QString name;
    QVariant value;
};

/*!
    \qmlclass SqlBind QmlSqlBind
    \brief the SqlBind element specifies a value binding for an SqlQuery element.
*/

/*!
    \class QmlSqlBind
    \brief the QmlSqlBind class specifies a value binding for a QmlSqlQuery.

    \qmltext

    \qml
    By using bindings its possible to cause a SqlQuery to update itself
    when values bound through the SqlBind change.  Hence in the example
    below the results for the SqlQuery will change as searchText changes.

    If the query is not a SELECT statement, the effects of the bound
    values will only apply when the SqlQuery exec() slot is called.

    <SqlQuery>
        SELECT * FROM mytable WHERE name LIKE :value
        <bindings>
            <SqlBind name=":value" value="{searchText + '%'}"/>
        </bindings>
    </SqlQuery>
    <SqlQuery>
        SELECT * FROM mytable WHERE type = ?
        <bindings>
            <SqlBind value="simple"/>
        </bindings>
    <SqlQuery>
    \endqml
    \endqmltext
*/

/*!
    \fn void QmlSqlBind::valueChanged()

    This signal is emitted when the value property of the SqlBind changes.
*/

/*!
    \qmlproperty QString SqlBind::name

    Defines the placeholder name of the bind. If no name is specified the 
    bind will use its position within the SqlQuery's bindings to bind
    into the query.
*/

/*!
    \qmlproperty QVariant SqlBind::value

    Defines the value to bind into the query.
*/

/*!
    Constructs a QmlSqlVind with the given \a parent
*/
QmlSqlBind::QmlSqlBind(QObject *parent)
: QObject(*(new QmlSqlBindPrivate()), parent)
{
}

/*!
    Destroys the QmlSqlBind.
*/
QmlSqlBind::~QmlSqlBind()
{
}

/*!
    Returns the binding's name.

    \sa setName()
*/
QString QmlSqlBind::name() const
{
    Q_D(const QmlSqlBind);
    return d->name;
}

/*!
    Returns the binding's value.

    \sa setValue()
*/
QVariant QmlSqlBind::value() const
{
    Q_D(const QmlSqlBind);
    return d->value;
}

/*!
    Sets the binding's name to the given \a name.

    \sa name()
*/
void QmlSqlBind::setName(const QString &name)
{
    Q_D(QmlSqlBind);
    d->name = name;
}

/*!
    Sets the binding's value to the given \a value.

    \sa value()
*/
void QmlSqlBind::setValue(const QVariant &value)
{
    Q_D(QmlSqlBind);
    if (d->value != value) {
        d->value = value;
        emit valueChanged();
    }
}

/*!
    \reimp
*/
void QmlSqlBind::classComplete()
{
}

class QmlSqlQueryPrivate : public QObjectPrivate
{
    Q_DECLARE_PUBLIC(QmlSqlQuery)
public:
    QmlSqlQueryPrivate(QmlSqlQuery *owner) : isSel(false), query(NULL), requireCache(false), count(-1), binds(owner) {}
    void prepareQuery() const;
    void bindQuery() const;
    void cacheQuery() const;
    void grabRoles() const;

    QString queryText;
    bool isSel;
    QVariant connectionVariant;
    mutable QSqlQuery *query;
    mutable bool requireCache;
    mutable int count;
    mutable QList<int> roles;
    mutable QStringList roleNames;
    mutable QVector< QVector< QVariant > > cache;

    class QmlSqlBindList : public QmlList<QmlSqlBind *>
    {
    public:
        QmlSqlBindList(QmlSqlQuery *owner)
            : q(owner){}

        void append(QmlSqlBind *o) {
            m_contents.append(o);
            QObject::connect(o, SIGNAL(valueChanged()), q, SLOT(resetBinds()));
        }
        void clear() { m_contents.clear(); }
        int count() const { return m_contents.count(); }
        void removeAt(int pos) { return m_contents.removeAt(pos); }
        QmlSqlBind *at(int pos) const { return m_contents.at(pos); }
        void insert(int pos, QmlSqlBind *o) { m_contents.insert(pos, o); }
    private:
        QList<QmlSqlBind *> m_contents;
        QmlSqlQuery *q;
    };

    QmlSqlBindList binds;
};

/*!
    \qmlclass SqlQuery QmlSqlQuery
    \brief The SqlQuery element describes a query into an SQL database.
*/

/*
    \class QmlSqlQuery
    \brief the QmlSqlQuery class manages a query into an SQL database.

    \qmltext
    The SqlQuery element has three parts.  The first is the query itself,
    which can either be specified using the query property or by the
    default text for the element.  The second specifies the connection
    to the database.  This can either be a bound id from an SqlConnection
    or the connections name.  If the connection is specified in a QML
    SqlConnection it is recommend to bind to the id to help ensure the
    database is complete before attempting to attach to it.  If no
    connectoin is specified the default connection is used.

    It is also possible to bind values into the query using the bindings
    property.  See SqlBind for more information on how to bind values into
    the query.

    If the query is a select statement it can be used as a model for a ListView.
    The roles will be the columns of the result set.  Use the SQL AS keyword 
    in the query if you want to override the column names from that of the
    table selected.  You should also use the AS keyword if there is no
    appropriate table column name for the result column.
        
    \qml
    <SqlQuery connection="{qmlConnectionId}" query="DELETE FROM mytable"/>
    <SqlQuery connection="connectionName">
        SELECT * FROM mytable
    </SqlQuery>
    <SqlQuery>SELECT id AS recordId, (firstName || ' ' || lastName) AS fullName FROM mytable</SqlQuery>
    \endqml
    \endqmltext
*/

/*!
    \qmlproperty QString SqlQuery::query
    \default

    Defines the query text.
*/

/*!
    \qmlproperty QVariant SqlQuery::connection

    Defines the connection to an SQL database used by the query.
*/

/*!
    \qmlproperty QString SqlQuery::lastError

    Defines the last error, if one occurred, when working with the query.
*/
    
/*!
    \qmlproperty list<SqlBind> SqlQuery::bindings

    The bindings property contains the list of values to bind into the
    query.  See SqlBind for more information.
*/

/*!
    Constructs a QmlSqlQuery with the given \a parent.
*/
QmlSqlQuery::QmlSqlQuery(QObject *parent)
: QListModelInterface(*(new QmlSqlQueryPrivate(this)), parent)
{
}

/*!
    Destroys the QmlSqlQuery.
*/
QmlSqlQuery::~QmlSqlQuery()
{
    Q_D(QmlSqlQuery);
    if (d->query)
        delete d->query;
}

/*!
    Returns the query's bound variables.
*/
QmlList<QmlSqlBind *> *QmlSqlQuery::bindings()
{
    Q_D(QmlSqlQuery);
    return &d->binds;
}

/*!
    Returns the query's bound variables.
*/
const QmlList<QmlSqlBind *> *QmlSqlQuery::bindings() const
{
    Q_D(const QmlSqlQuery);
    return &d->binds;
}

/*!
    Returns the query text.

    \sa setQuery()
*/
QString QmlSqlQuery::query() const
{
    Q_D(const QmlSqlQuery);
    return d->queryText;
}

/*!
    Sets the query text to the given \a text.
*/
void QmlSqlQuery::setQuery(const QString &text)
{
    Q_D(QmlSqlQuery);
    if (text != d->queryText) {
        d->queryText = text;

        static const QLatin1String select("select");
        d-> isSel = text.trimmed().indexOf(select, 0, Qt::CaseInsensitive) == 0;

        if (d->query)
            resetQuery();
    }
}

/*!
    Returns the query's connection specifier.

    \sa setConnection()
*/
QVariant QmlSqlQuery::connection() const
{
    Q_D(const QmlSqlQuery);
    return d->connectionVariant;
}

/*!
    Sets the query's connection specifier.

    \sa connection()
*/
void QmlSqlQuery::setConnection(const QVariant &connection)
{
    Q_D(QmlSqlQuery);
    if (connection != d->connectionVariant) {
        d->connectionVariant = connection;
        if (d->query)
            resetQuery();
        else if (d->count == 0) // data has been requested
            d->prepareQuery();
    }
}

/*!
    Returns the set of values for a given set of requested \a roles for the
    specified \a row of the query result set.  Returns an empty hash if the
    query is not a select statement.

    \sa count(), roles(), toString()
*/
QHash<int,QVariant> QmlSqlQuery::data(int row, const QList<int> &roles) const
{
    Q_D(const QmlSqlQuery);
    if (!d->query)
        d->prepareQuery();
    QHash<int, QVariant> result;

    if (!d->isSel)
        return result;

    Q_ASSERT(row >= 0 && row <= d->count);

    if (!d->requireCache)
        d->query->seek(row);

    for (int i = 0; i < roles.count(); ++i) {
        int column = roles[i];
        Q_ASSERT(column >= 0 && column < d->cache.size());
        if (d->requireCache) 
            result.insert(column, d->cache[column].at(row));
        else
            result.insert(column, d->query->value(column));
    }
    return result;
}

/*!
    Returns the number of rows in the query result set.  Returns 0 if
    the query is not a select statement.

    \sa data(), roles(), toString()
*/
int QmlSqlQuery::count() const
{
    Q_D(const QmlSqlQuery);
    if (!d->query)
        d->prepareQuery();
    return d->count;
}

/*!
    Returns the list of role integer identifiers for the query result set.
    Returns and empty list if the query is not a select statement.

    \sa data(), count(), toString()
*/
QList<int> QmlSqlQuery::roles() const
{
    Q_D(const QmlSqlQuery);
    if (!d->query)
        d->prepareQuery();

    if (!d->isSel)
        return QList<int>();

    if (d->roleNames.isEmpty() && !d->requireCache) {
        d->query->seek(0);
        d->grabRoles();
    }

    return d->roles;
}

/*!
    Returns the corresponding role name for the given \a role identifier.

    \sa data(), roles(), toString()
*/
QString QmlSqlQuery::toString(int role) const
{
    Q_D(const QmlSqlQuery);
    if (!d->query)
        d->prepareQuery();

    if (d->roleNames.isEmpty() && !d->requireCache) {
        d->query->seek(0);
        d->grabRoles();
    }

    return d->roleNames[role];
}

/*!
    Returns information about the last error that occurred on the query.
*/
QString QmlSqlQuery::lastError() const
{
    Q_D(const QmlSqlQuery);
    if (d->query)
        return d->query->lastError().text();
    return QString();
}

/*!
    \reimp
*/
void QmlSqlQuery::classComplete()
{
    Q_D(QmlSqlQuery);
    if (!d->query)
        d->prepareQuery();
}

/*!
    \internal
    Rebinds the query, and if needed, emits rows inserted or rows
    added so any attached ListView elements will correctly.

    This slot is called automatically when the SqlBind elements in
    the bindings property of the query change.
*/
void QmlSqlQuery::resetBinds()
{
    Q_D(QmlSqlQuery);
    if (!d->query)
        return;
    int oldcount = d->count;
    d->cache.resize(0);
    d->roles.clear();
    d->roleNames.clear();
    d->bindQuery();
    if (d->isSel) {
        if (!d->query->isActive()) {
            if (!d->query->exec())
                qWarning() << "failed to execute query" << d->query->lastQuery() << d->query->boundValues() << d->query->lastError().text();
        }
        d->cacheQuery(); // may finish query
        emitChanges(oldcount);
    }
}

/*!
    Executes the query.  For SELECT statements this is normally only required
    if the database changes outside of the SQL query element.  Statements that
    modify the database, such as UPDATE and INSERT, will not be applied until
    this function is called.
*/
void QmlSqlQuery::exec()
{
    Q_D(QmlSqlQuery);
    if (!d->query)
        d->prepareQuery();
    Q_ASSERT(d->query);

    if (d->isSel) {
        int oldcount = d->count;
        d->cache.resize(0);
        d->roles.clear();
        d->roleNames.clear();
        if (!d->query->exec())
            qWarning() << "failed to execute query" << d->query->lastQuery() << d->query->boundValues() << d->query->lastError().text();
        d->cacheQuery(); // may finish query
        emitChanges(oldcount);
    } else {
        if (!d->query->exec())
            qWarning() << "failed to execute query" << d->query->lastQuery() << d->query->boundValues() << d->query->lastError().text();
        d->query->finish();
    }
}

/*!
    \internal

    Resets the query and query cache.
*/
void QmlSqlQuery::resetQuery()
{
    Q_D(QmlSqlQuery);
    Q_ASSERT(d->query != 0);
    delete d->query;
    d->query = 0;
    d->cache.resize(0);
    d->roles.clear();
    d->roleNames.clear();
    int oldcount = d->count;
    d->prepareQuery();
    emitChanges(oldcount);
}

/*!
    \internal

    emits row number changes based of differences between the given
    \a oldcount and the current count of the query result set.
*/
void QmlSqlQuery::emitChanges(int oldcount)
{
    Q_D(QmlSqlQuery);
    if (d->count > oldcount)
        emit itemsInserted(oldcount, d->count-oldcount);
    else if (d->count < oldcount)
        emit itemsRemoved(d->count, oldcount-d->count);
    if (d->count > 0 && oldcount > 0)
        emit itemsChanged(0, qMin(d->count, oldcount), roles());
}

/*
    Prepares the query.  If the query starts with SELECT it is assumed to
    be a SELECT statement and the query is also executed.
*/
void QmlSqlQueryPrivate::prepareQuery() const
{
    QObject *object = qvariant_cast<QObject*>(connectionVariant);
    QmlSqlConnection *connection = qobject_cast<QmlSqlConnection *>(object);
    QString connectionString = qvariant_cast<QString>(connectionVariant);

    Q_ASSERT(query == 0);
    QSqlDatabase db = connection ? connection->database()
            : QSqlDatabase::database(connectionString.isEmpty()
                ? QLatin1String(QSqlDatabase::defaultConnection)
                : connectionString, false);

    if (!db.isOpen()) {
        count = 0;
        return;
    }

    query = new QSqlQuery(db);

    requireCache =
        query->driver()->hasFeature(QSqlDriver::SimpleLocking)
        || !query->driver()->hasFeature(QSqlDriver::QuerySize);

    if (requireCache)
        query->setForwardOnly(true);
    if (!query->prepare(queryText))
        qWarning() << "failed to prepare query" << query->lastQuery() << query->lastError().text();
    bindQuery();
    if (isSel) {
        if (!query->exec())
            qWarning() << "failed to execute query" << query->lastQuery() << query->boundValues() << query->lastError().text();
        cacheQuery();
    }
}

/*
    Binds values into the prepared query using the bindings property of the SqlQuery element.
*/
void QmlSqlQueryPrivate::bindQuery() const
{
    for (int i = 0; i < binds.count(); ++i) {
        QmlSqlBind *bind = binds.at(i);
        if (bind->name().isEmpty()) {
            query->bindValue(i, bind->value());
        } else {
            query->bindValue(bind->name(), bind->value());
        }
    }
}

/*
    If the query is connected to a database with simple locking or
    that cannot ask for the count of a result set, caches the required
    data of the query and finishes the query to release locks.

    Otherwise just caches the count of the query.
*/
void QmlSqlQueryPrivate::cacheQuery() const
{
    if (requireCache) {
        int row = 0;
        while (query->next()) {
            if (roleNames.isEmpty()) {
                grabRoles();
                cache.resize(roleNames.count());
            }
            Q_ASSERT(cache.size() > 0);
            for (int i = 0; i < cache.size(); ++i) {
                cache[i].append(query->value(i));
            }
            row++;
        }
        count = row;
        query->finish();
    } else {
        count = query->size();
    }
}

/*
    Gets the column names for the roles of the SqlQuery element.

    The query must be active and on a valid row.
*/
void QmlSqlQueryPrivate::grabRoles() const
{
    Q_ASSERT(query);
    Q_ASSERT(query->isValid());
    Q_ASSERT(roleNames.isEmpty());
    Q_ASSERT(roles.isEmpty());

    QSqlRecord record = query->record();
    for (int i = 0; i < record.count(); ++i) {
        roleNames.append(record.fieldName(i));
        roles.append(i);
    }
}
QT_END_NAMESPACE