File: qgsdbquerylog.sip.in

package info (click to toggle)
qgis 3.40.11%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 1,183,800 kB
  • sloc: cpp: 1,595,841; python: 372,637; xml: 23,474; sh: 3,761; perl: 3,664; ansic: 2,257; sql: 2,137; yacc: 1,068; lex: 577; javascript: 540; lisp: 411; makefile: 154
file content (127 lines) | stat: -rw-r--r-- 2,939 bytes parent folder | download | duplicates (14)
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
/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/core/qgsdbquerylog.h                                             *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.py again   *
 ************************************************************************/



class QgsDatabaseQueryLogEntry
{
%Docstring(signature="appended")
Encapsulates a logged database query.

.. versionadded:: 3.24
%End

%TypeHeaderCode
#include "qgsdbquerylog.h"
%End
  public:

    QgsDatabaseQueryLogEntry( const QString &query = QString() );
%Docstring
Constructor for QgsDatabaseQueryLogEntry.
%End

    int queryId;

    QString uri;

    QString provider;

    QString query;

    quint64 startedTime;

    quint64 finishedTime;

    QString initiatorClass;

    QString origin;

    long long fetchedRows;

    QString error;

    bool canceled;

};


class QgsDatabaseQueryLog: QObject
{
%Docstring(signature="appended")
Handles logging of database queries.

:py:class:`QgsDatabaseQueryLog` is not usually directly created, but
rather accessed through :py:func:`QgsApplication.databaseQueryLog()`.
Generally, clients should only access the static :py:func:`~log` method
to register their queries.

Example
-------------------------------------

.. code-block:: python

       # Log a database query
       QgsDatabaseQueryLog.log('SELECT * FROM my_table')

.. versionadded:: 3.24
%End

%TypeHeaderCode
#include "qgsdbquerylog.h"
%End
  public:

    QgsDatabaseQueryLog( QObject *parent = 0 );
%Docstring
Creates a new query log.

QgsDatabaseQueryLog is not usually directly created, but rather accessed
through :py:func:`QgsApplication.databaseQueryLog()`.
%End


    static bool enabled();
%Docstring
Returns ``True`` if logging is enabled.

.. seealso:: :py:func:`setEnabled`
%End

    static void log( const QgsDatabaseQueryLogEntry &query );
%Docstring
Logs a database ``query`` as starting.

This method can be safely called from any thread.
%End

    static void finished( const QgsDatabaseQueryLogEntry &query );
%Docstring
Records that the database ``query`` has finished.

This method can be safely called from any thread.
%End

  public slots:



  signals:



};


/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/core/qgsdbquerylog.h                                             *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.py again   *
 ************************************************************************/