sqlops Document return values for sql_query()

(cherry picked from commit 639574e79200b5ffae4274b862ad595bd209da24)
kamailio · May 27, 2016 · 9bbe982 · 9bbe982
1 parent d6710fd
commit 9bbe982
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 2 deletions.
diff --git a/modules/sqlops/README b/modules/sqlops/README
@@ -248,7 +248,9 @@ if (sql_xquery("ca", "select * from domain", "ra") == 1) {
        the type of the columns. Please note that only these two datatypes
        are supported, other datatypes will/may be converted to string.
 
-   This function can be used from ANY_ROUTE.
+   This function can be used from ANY_ROUTE. Returns -1 on Error, 1 on
+   successful query, 2 if query provided no result set, 3 if result is
+   ignored (no result parameter given)
 
    Example 1.5. sql_pvquery() usage
 ...

diff --git a/modules/sqlops/doc/sqlops_admin.xml b/modules/sqlops/doc/sqlops_admin.xml
@@ -338,7 +338,9 @@ if (sql_xquery("ca", "select * from domain", "ra") == 1) {
 		</listitem>
 		</itemizedlist>
 		<para>
-			This function can be used from ANY_ROUTE.
+			This function can be used from ANY_ROUTE. Returns -1 on Error,
+			1 on successful query, 2 if query provided no result set,
+			3 if result is ignored (no result parameter given)
 		</para>
 		<example>
 		<title><function>sql_pvquery()</function> usage</title>