Merge pull request #60761 from nyalldawson/sql_history2

[feature] Add stored query support to Execute SQL window
qgis · Feb 26, 2025 · d8afb58 · d8afb58
2 parents 98b36d1 + afdf432
commit d8afb58
Show file tree

Hide file tree

Showing 32 changed files with 1,115 additions and 1,112 deletions.
diff --git a/images/images.qrc b/images/images.qrc
@@ -1016,6 +1016,7 @@
         <file>themes/default/stacked-diagram.svg</file>
         <file>themes/default/mIconStac.svg</file>
         <file>themes/default/mIconQt.svg</file>
+        <file>themes/default/mIconStoredQueries.svg</file>
     </qresource>
     <qresource prefix="/images/tips">
         <file alias="symbol_levels.png">qgis_tips/symbol_levels.png</file>

diff --git a/images/themes/default/mIconStoredQueries.svg b/images/themes/default/mIconStoredQueries.svg
diff --git a/python/PyQt6/core/auto_additions/qgis.py b/python/PyQt6/core/auto_additions/qgis.py
@@ -6187,6 +6187,19 @@
 Qgis.HistoryProviderBackends = lambda flags=0: Qgis.HistoryProviderBackend(flags)
 Qgis.HistoryProviderBackends.baseClass = Qgis
 HistoryProviderBackends = Qgis  # dirty hack since SIP seems to introduce the flags in module
+# monkey patching scoped based enum
+Qgis.QueryStorageBackend.LocalProfile.__doc__ = "Local user profile"
+Qgis.QueryStorageBackend.CurrentProject.__doc__ = "Current QGIS project"
+Qgis.QueryStorageBackend.__doc__ = """Stored query storage backends.
+
+.. versionadded:: 3.44
+
+* ``LocalProfile``: Local user profile
+* ``CurrentProject``: Current QGIS project
+
+"""
+# --
+Qgis.QueryStorageBackend.baseClass = Qgis
 QgsProcessing.SourceType = Qgis.ProcessingSourceType
 # monkey patching scoped based enum
 QgsProcessing.TypeMapLayer = Qgis.ProcessingSourceType.MapLayer

diff --git a/python/PyQt6/core/auto_generated/qgis.sip.in b/python/PyQt6/core/auto_generated/qgis.sip.in
@@ -1932,6 +1932,12 @@ The development version
     typedef QFlags<Qgis::HistoryProviderBackend> HistoryProviderBackends;
 
 
+    enum class QueryStorageBackend /BaseType=IntEnum/
+    {
+      LocalProfile,
+      CurrentProject,
+    };
+
     enum class ProcessingSourceType /BaseType=IntEnum/
       {
       MapLayer,

diff --git a/python/PyQt6/gui/auto_additions/qgsgui.py b/python/PyQt6/gui/auto_additions/qgsgui.py
@@ -45,6 +45,7 @@ def _force_int(v): return int(v.value) if isinstance(v, Enum) else v
     QgsGui.windowManager = staticmethod(QgsGui.windowManager)
     QgsGui.setWindowManager = staticmethod(QgsGui.setWindowManager)
     QgsGui.inputControllerManager = staticmethod(QgsGui.inputControllerManager)
+    QgsGui.storedQueryManager = staticmethod(QgsGui.storedQueryManager)
     QgsGui.higFlags = staticmethod(QgsGui.higFlags)
     QgsGui.sampleColor = staticmethod(QgsGui.sampleColor)
     QgsGui.findScreenAt = staticmethod(QgsGui.findScreenAt)

diff --git a/python/PyQt6/gui/auto_additions/qgsstoredquerymanager.py b/python/PyQt6/gui/auto_additions/qgsstoredquerymanager.py
@@ -0,0 +1,10 @@
+# The following has been generated automatically from src/gui/qgsstoredquerymanager.h
+try:
+    QgsStoredQueryManager.QueryDetails.__attribute_docs__ = {'name': 'Name of the query.', 'definition': 'Query definition.', 'backend': 'Storage backend.'}
+except (NameError, AttributeError):
+    pass
+try:
+    QgsStoredQueryManager.__attribute_docs__ = {'queryAdded': 'Emitted when a query is added to the manager.\n', 'queryChanged': 'Emitted when an existing query is changed in the manager.\n', 'queryRemoved': 'Emitted when a query is removed from the manager.\n'}
+    QgsStoredQueryManager.__signal_arguments__ = {'queryAdded': ['name: str', 'backend: Qgis.QueryStorageBackend'], 'queryChanged': ['name: str', 'backend: Qgis.QueryStorageBackend'], 'queryRemoved': ['name: str', 'backend: Qgis.QueryStorageBackend']}
+except (NameError, AttributeError):
+    pass
diff --git a/python/PyQt6/gui/auto_generated/qgsgui.sip.in b/python/PyQt6/gui/auto_generated/qgsgui.sip.in
@@ -215,6 +215,13 @@ Sets the global window ``manager``. Ownership is transferred to the QgsGui insta
 Returns the global input controller manager.
 
 .. versionadded:: 3.32
+%End
+
+    static QgsStoredQueryManager *storedQueryManager() /KeepReference/;
+%Docstring
+Returns the global stored SQL query manager.
+
+.. versionadded:: 3.44
 %End
 
     enum HigFlag /BaseType=IntEnum/

diff --git a/python/PyQt6/gui/auto_generated/qgsstoredquerymanager.sip.in b/python/PyQt6/gui/auto_generated/qgsstoredquerymanager.sip.in
@@ -0,0 +1,120 @@
+/************************************************************************
+ * This file has been generated automatically from                      *
+ *                                                                      *
+ * src/gui/qgsstoredquerymanager.h                                      *
+ *                                                                      *
+ * Do not edit manually ! Edit header and run scripts/sipify.py again   *
+ ************************************************************************/
+
+
+
+class QgsStoredQueryManager : QObject
+{
+%Docstring(signature="appended")
+A manager for stored SQL queries.
+
+:py:class:`QgsStoredQueryManager` is not usually directly created, instead
+use the instance accessible through :py:func:`QgsGui.storedQueryManager()`.
+
+.. versionadded:: 3.44
+%End
+
+%TypeHeaderCode
+#include "qgsstoredquerymanager.h"
+%End
+  public:
+
+    QgsStoredQueryManager( QObject *parent = 0 );
+%Docstring
+Constructor for QgsStoredQueryManager, with the specified
+``parent`` object.
+%End
+
+    void storeQuery( const QString &name, const QString &query, Qgis::QueryStorageBackend backend = Qgis::QueryStorageBackend::LocalProfile );
+%Docstring
+Saves a query to the manager.
+
+If a query with the same ``name`` already exists it will be overwritten with the new definition.
+
+:param name: user-set, unique name for the query.
+:param query: query definition to store
+:param backend: storage backend for query
+
+.. seealso:: :py:func:`queryAdded`
+
+.. seealso:: :py:func:`queryChanged`
+%End
+
+    void removeQuery( const QString &name, Qgis::QueryStorageBackend backend = Qgis::QueryStorageBackend::LocalProfile );
+%Docstring
+Removes the stored query with matching ``name``.
+
+:param name: name of query to remove
+:param backend: storage backend for query
+
+.. seealso:: :py:func:`queryRemoved`
+%End
+
+    QStringList allQueryNames( Qgis::QueryStorageBackend backend = Qgis::QueryStorageBackend::LocalProfile ) const;
+%Docstring
+Returns a list of the names of all stored queries for the specified ``backend``.
+%End
+
+    QString query( const QString &name, Qgis::QueryStorageBackend backend = Qgis::QueryStorageBackend::LocalProfile ) const;
+%Docstring
+Returns the query definition with matching ``name``, from the specified ``backend``.
+%End
+
+    class QueryDetails
+{
+%Docstring(signature="appended")
+Contains details about a stored query.
+
+.. versionadded:: 3.44
+%End
+
+%TypeHeaderCode
+#include "qgsstoredquerymanager.h"
+%End
+      public:
+        QString name;
+
+        QString definition;
+
+        Qgis::QueryStorageBackend backend;
+    };
+
+    QList< QgsStoredQueryManager::QueryDetails > allQueries() const;
+%Docstring
+Returns details of all queries stored in the manager.
+
+Queries will be sorted by name.
+%End
+
+  signals:
+
+    void queryAdded( const QString &name, Qgis::QueryStorageBackend backend );
+%Docstring
+Emitted when a query is added to the manager.
+%End
+
+    void queryChanged( const QString &name, Qgis::QueryStorageBackend backend );
+%Docstring
+Emitted when an existing query is changed in the manager.
+%End
+
+    void queryRemoved( const QString &name, Qgis::QueryStorageBackend backend );
+%Docstring
+Emitted when a query is removed from the manager.
+%End
+
+};
+
+
+/************************************************************************
+ * This file has been generated automatically from                      *
+ *                                                                      *
+ * src/gui/qgsstoredquerymanager.h                                      *
+ *                                                                      *
+ * Do not edit manually ! Edit header and run scripts/sipify.py again   *
+ ************************************************************************/
diff --git a/python/PyQt6/gui/gui_auto.sip b/python/PyQt6/gui/gui_auto.sip
@@ -208,6 +208,7 @@
 %Include auto_generated/qgssourceselectprovider.sip
 %Include auto_generated/qgssourceselectproviderregistry.sip
 %Include auto_generated/qgsstatusbar.sip
+%Include auto_generated/qgsstoredquerymanager.sip
 %Include auto_generated/qgsstyleitemslistwidget.sip
 %Include auto_generated/qgssublayersdialog.sip
 %Include auto_generated/qgssubstitutionlistwidget.sip

diff --git a/python/core/auto_additions/qgis.py b/python/core/auto_additions/qgis.py
@@ -6128,6 +6128,19 @@
 Qgis.HistoryProviderBackend.baseClass = Qgis
 Qgis.HistoryProviderBackends.baseClass = Qgis
 HistoryProviderBackends = Qgis  # dirty hack since SIP seems to introduce the flags in module
+# monkey patching scoped based enum
+Qgis.QueryStorageBackend.LocalProfile.__doc__ = "Local user profile"
+Qgis.QueryStorageBackend.CurrentProject.__doc__ = "Current QGIS project"
+Qgis.QueryStorageBackend.__doc__ = """Stored query storage backends.
+
+.. versionadded:: 3.44
+
+* ``LocalProfile``: Local user profile
+* ``CurrentProject``: Current QGIS project
+
+"""
+# --
+Qgis.QueryStorageBackend.baseClass = Qgis
 QgsProcessing.SourceType = Qgis.ProcessingSourceType
 # monkey patching scoped based enum
 QgsProcessing.TypeMapLayer = Qgis.ProcessingSourceType.MapLayer

diff --git a/python/core/auto_generated/qgis.sip.in b/python/core/auto_generated/qgis.sip.in
@@ -1932,6 +1932,12 @@ The development version
     typedef QFlags<Qgis::HistoryProviderBackend> HistoryProviderBackends;
 
 
+    enum class QueryStorageBackend
+    {
+      LocalProfile,
+      CurrentProject,
+    };
+
     enum class ProcessingSourceType
       {
       MapLayer,

diff --git a/python/gui/auto_additions/qgsgui.py b/python/gui/auto_additions/qgsgui.py
@@ -30,6 +30,7 @@
     QgsGui.windowManager = staticmethod(QgsGui.windowManager)
     QgsGui.setWindowManager = staticmethod(QgsGui.setWindowManager)
     QgsGui.inputControllerManager = staticmethod(QgsGui.inputControllerManager)
+    QgsGui.storedQueryManager = staticmethod(QgsGui.storedQueryManager)
     QgsGui.higFlags = staticmethod(QgsGui.higFlags)
     QgsGui.sampleColor = staticmethod(QgsGui.sampleColor)
     QgsGui.findScreenAt = staticmethod(QgsGui.findScreenAt)

diff --git a/python/gui/auto_additions/qgsstoredquerymanager.py b/python/gui/auto_additions/qgsstoredquerymanager.py
@@ -0,0 +1,10 @@
+# The following has been generated automatically from src/gui/qgsstoredquerymanager.h
+try:
+    QgsStoredQueryManager.QueryDetails.__attribute_docs__ = {'name': 'Name of the query.', 'definition': 'Query definition.', 'backend': 'Storage backend.'}
+except (NameError, AttributeError):
+    pass
+try:
+    QgsStoredQueryManager.__attribute_docs__ = {'queryAdded': 'Emitted when a query is added to the manager.\n', 'queryChanged': 'Emitted when an existing query is changed in the manager.\n', 'queryRemoved': 'Emitted when a query is removed from the manager.\n'}
+    QgsStoredQueryManager.__signal_arguments__ = {'queryAdded': ['name: str', 'backend: Qgis.QueryStorageBackend'], 'queryChanged': ['name: str', 'backend: Qgis.QueryStorageBackend'], 'queryRemoved': ['name: str', 'backend: Qgis.QueryStorageBackend']}
+except (NameError, AttributeError):
+    pass
diff --git a/python/gui/auto_generated/qgsgui.sip.in b/python/gui/auto_generated/qgsgui.sip.in
@@ -215,6 +215,13 @@ Sets the global window ``manager``. Ownership is transferred to the QgsGui insta
 Returns the global input controller manager.
 
 .. versionadded:: 3.32
+%End
+
+    static QgsStoredQueryManager *storedQueryManager() /KeepReference/;
+%Docstring
+Returns the global stored SQL query manager.
+
+.. versionadded:: 3.44
 %End
 
     enum HigFlag

diff --git a/python/gui/auto_generated/qgsstoredquerymanager.sip.in b/python/gui/auto_generated/qgsstoredquerymanager.sip.in
@@ -0,0 +1,120 @@
+/************************************************************************
+ * This file has been generated automatically from                      *
+ *                                                                      *
+ * src/gui/qgsstoredquerymanager.h                                      *
+ *                                                                      *
+ * Do not edit manually ! Edit header and run scripts/sipify.py again   *
+ ************************************************************************/
+
+
+
+class QgsStoredQueryManager : QObject
+{
+%Docstring(signature="appended")
+A manager for stored SQL queries.
+
+:py:class:`QgsStoredQueryManager` is not usually directly created, instead
+use the instance accessible through :py:func:`QgsGui.storedQueryManager()`.
+
+.. versionadded:: 3.44
+%End
+
+%TypeHeaderCode
+#include "qgsstoredquerymanager.h"
+%End
+  public:
+
+    QgsStoredQueryManager( QObject *parent = 0 );
+%Docstring
+Constructor for QgsStoredQueryManager, with the specified
+``parent`` object.
+%End
+
+    void storeQuery( const QString &name, const QString &query, Qgis::QueryStorageBackend backend = Qgis::QueryStorageBackend::LocalProfile );
+%Docstring
+Saves a query to the manager.
+
+If a query with the same ``name`` already exists it will be overwritten with the new definition.
+
+:param name: user-set, unique name for the query.
+:param query: query definition to store
+:param backend: storage backend for query
+
+.. seealso:: :py:func:`queryAdded`
+
+.. seealso:: :py:func:`queryChanged`
+%End
+
+    void removeQuery( const QString &name, Qgis::QueryStorageBackend backend = Qgis::QueryStorageBackend::LocalProfile );
+%Docstring
+Removes the stored query with matching ``name``.
+
+:param name: name of query to remove
+:param backend: storage backend for query
+
+.. seealso:: :py:func:`queryRemoved`
+%End
+
+    QStringList allQueryNames( Qgis::QueryStorageBackend backend = Qgis::QueryStorageBackend::LocalProfile ) const;
+%Docstring
+Returns a list of the names of all stored queries for the specified ``backend``.
+%End
+
+    QString query( const QString &name, Qgis::QueryStorageBackend backend = Qgis::QueryStorageBackend::LocalProfile ) const;
+%Docstring
+Returns the query definition with matching ``name``, from the specified ``backend``.
+%End
+
+    class QueryDetails
+{
+%Docstring(signature="appended")
+Contains details about a stored query.
+
+.. versionadded:: 3.44
+%End
+
+%TypeHeaderCode
+#include "qgsstoredquerymanager.h"
+%End
+      public:
+        QString name;
+
+        QString definition;
+
+        Qgis::QueryStorageBackend backend;
+    };
+
+    QList< QgsStoredQueryManager::QueryDetails > allQueries() const;
+%Docstring
+Returns details of all queries stored in the manager.
+
+Queries will be sorted by name.
+%End
+
+  signals:
+
+    void queryAdded( const QString &name, Qgis::QueryStorageBackend backend );
+%Docstring
+Emitted when a query is added to the manager.
+%End
+
+    void queryChanged( const QString &name, Qgis::QueryStorageBackend backend );
+%Docstring
+Emitted when an existing query is changed in the manager.
+%End
+
+    void queryRemoved( const QString &name, Qgis::QueryStorageBackend backend );
+%Docstring
+Emitted when a query is removed from the manager.
+%End
+
+};
+
+
+/************************************************************************
+ * This file has been generated automatically from                      *
+ *                                                                      *
+ * src/gui/qgsstoredquerymanager.h                                      *
+ *                                                                      *
+ * Do not edit manually ! Edit header and run scripts/sipify.py again   *
+ ************************************************************************/