Dox++

qgis · Nov 24, 2020 · a035f43 · a035f43
1 parent 5657fbc
commit a035f43
Show file tree

Hide file tree

Showing 2 changed files with 34 additions and 4 deletions.
diff --git a/python/core/auto_generated/qgsdatasourceuri.sip.in b/python/core/auto_generated/qgsdatasourceuri.sip.in
@@ -147,6 +147,9 @@ Sets the URI database name.
                         const QString &aKeyColumn = QString() );
 %Docstring
 Sets all data source related members at once.
+
+The ``aSql`` argument represents a subset filter string to be applied to the source, and should take the
+form of a SQL "where" clause (e.g. "VALUE > 5", "CAT IN (1,2,3)").
 %End
 
     void setAuthConfigId( const QString &authcfg );
@@ -191,7 +194,12 @@ Returns the table name stored in the URI.
 
     QString sql() const;
 %Docstring
-Returns the SQL query stored in the URI, if set.
+Returns the SQL filter stored in the URI, if set.
+
+This represents a subset filter string to be applied to the source, and takes the
+form of a SQL "where" clause (e.g. "VALUE > 5", "CAT IN (1,2,3)").
+
+.. seealso:: :py:func:`setSql`
 %End
 
     QString geometryColumn() const;
@@ -233,7 +241,12 @@ Sets the ``scheme`` for the URI.
 
     void setSql( const QString &sql );
 %Docstring
-Sets the SQL query for the URI.
+Sets the \sql filter for the URI.
+
+The ``sql`` represents a subset filter string to be applied to the source, and should take the
+form of a SQL "where" clause (e.g. "VALUE > 5", "CAT IN (1,2,3)").
+
+.. seealso:: :py:func:`sql`
 %End
 
     QString host() const;

diff --git a/src/core/qgsdatasourceuri.h b/src/core/qgsdatasourceuri.h
@@ -158,6 +158,9 @@ class CORE_EXPORT QgsDataSourceUri
 
     /**
      * Sets all data source related members at once.
+     *
+     * The \a aSql argument represents a subset filter string to be applied to the source, and should take the
+     * form of a SQL "where" clause (e.g. "VALUE > 5", "CAT IN (1,2,3)").
      */
     void setDataSource( const QString &aSchema,
                         const QString &aTable,
@@ -199,7 +202,14 @@ class CORE_EXPORT QgsDataSourceUri
     //! Returns the table name stored in the URI.
     QString table() const;
 
-    //! Returns the SQL query stored in the URI, if set.
+    /**
+     * Returns the SQL filter stored in the URI, if set.
+     *
+     * This represents a subset filter string to be applied to the source, and takes the
+     * form of a SQL "where" clause (e.g. "VALUE > 5", "CAT IN (1,2,3)").
+     *
+     * \see setSql()
+     */
     QString sql() const;
 
     //! Returns the name of the geometry column stored in the URI, if set.
@@ -226,7 +236,14 @@ class CORE_EXPORT QgsDataSourceUri
      */
     void setSchema( const QString &schema );
 
-    //! Sets the SQL query for the URI.
+    /**
+     * Sets the \sql filter for the URI.
+     *
+     * The \a sql represents a subset filter string to be applied to the source, and should take the
+     * form of a SQL "where" clause (e.g. "VALUE > 5", "CAT IN (1,2,3)").
+     *
+     * \see sql()
+     */
     void setSql( const QString &sql );
 
     //! Returns the host name stored in the URI.