]> git.ipfire.org Git - thirdparty/asterisk.git/commitdiff
func_odbc.conf.sample: Clarify sample documentation
authorSean Bright <sean.bright@gmail.com>
Sun, 15 Mar 2020 14:07:03 +0000 (10:07 -0400)
committerGeorge Joseph <gjoseph@digium.com>
Tue, 17 Mar 2020 13:18:51 +0000 (08:18 -0500)
ASTERISK-20325 #close

Change-Id: I06cb9b467b0fd06c8af2a5aee049f872c09cc4b6

configs/samples/func_odbc.conf.sample

index c3df9bc910de0f09a84c9181d57d8eba7f932e55..b533602abeab3e8b2656fac42b347c611fd97bed 100644 (file)
 ;
 ; The following options are available in this configuration file:
 ;
+; dsn          An alias for "writehandle."
 ; readhandle   A comma-separated list of DSNs (from res_odbc.conf) to use when
 ;              executing the readsql statement.  Each DSN is tried, in
 ;              succession, until the statement succeeds.  You may specify up to
 ;              5 DSNs per function class.  If not specified, it will default to
-;              the value of writehandle or dsn, if specified.
+;              the value of "writehandle" or "dsn," if specified.
 ; writehandle  A comma-separated list of DSNs (from res_odbc.conf) to use when
 ;              executing the writesql statement.  The same rules apply as to
-;              readhandle.  "dsn" is a synonym for "writehandle".
+;              readhandle.
 ; readsql      The statement to execute when reading from the function class.
 ; writesql     The statement to execute when writing to the function class.
 ; insertsql    The statement to execute when writing to the function class
@@ -60,6 +61,8 @@
 ;              off is incompatible with the functionality of HASH().
 ; synopsis     Appears in the synopsis field for the command
 ;              'core show function <function name>'
+; syntax       Appears in the syntax field for the command
+;              'core show function <function name>'
 ; mode         This option may be set to 'multirow' to allow the function
 ;              specified to return more than a single row.  However, this
 ;              changes the way that func_odbc normally works.  Instead of the
@@ -88,7 +91,7 @@
 
 ; ODBC_SQL - Allow an SQL statement to be built entirely in the dialplan
 [SQL]
-dsn=mysql1
+writehandle=mysql1
 readsql=${ARG1}
 
 ; ODBC_ANTISOLICIT - A blacklist for known solicitors.
@@ -104,6 +107,6 @@ synopsis=Check if a specified callerid is contained in the known solicitors data
 
 ; ODBC_PRESENCE - Retrieve and update presence
 [PRESENCE]
-dsn=mysql1
+writehandle=mysql1
 readsql=SELECT location FROM presence WHERE id='${SQL_ESC(${ARG1})}'
 writesql=UPDATE presence SET location='${SQL_ESC(${VAL1})}' WHERE id='${SQL_ESC(${ARG1})}'