MySQL options parameter fix and documentation

* db-mysql/mysql-api.lisp: Fix mysql_options UFFI parameter list
* doc/ref-connect.xml: Document the MySQL options parameter as
  part of the connection-spec.

diff --git a/ChangeLog b/ChangeLog
index ed7a0a939bd1f07efa974351334a7ba337c3e8dd..7edc1b4483c23bfbf6e4ac68152923dbe2a41ca8 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,8 @@
+2010-02-16  Kevin Rosenberg <kevin@rosenberg.net>
+       * db-mysql/mysql-api.lisp: Fix mysql_options UFFI parameter list
+       * doc/ref-connect.xml: Document the MySQL options parameter as
+       part of the connection-spec.
+       
 2010-02-15  Kevin Rosenberg <kevin@rosenberg.net>
        * db-mysql/mysql-{api,sql}.lisp: Support sending options
        to MySQL using mysql_options, which occurs between the API calls

diff --git a/db-mysql/mysql-api.lisp b/db-mysql/mysql-api.lisp
index 60b5cbe417f559f84b241eca27692f496ea876e8..089c81220749881a79d75690829c127bcc8023ab 100644 (file)
--- a/db-mysql/mysql-api.lisp
+++ b/db-mysql/mysql-api.lisp
@@ -286,7 +286,7 @@
 (uffi:def-function "mysql_options"
   ((mysql mysql-mysql)
    (option mysql-option)
-   (arg (* :void)))
+   (arg :pointer-void))
   :module "mysql"
   :returning :int)
 

diff --git a/doc/ref-connect.xml b/doc/ref-connect.xml
index d9c992e62837ec41c69a1966e6d8b2a265b0f197..a30aaf13e0a78e69c7765499a27087fbbfc5d267 100644 (file)
--- a/doc/ref-connect.xml
+++ b/doc/ref-connect.xml
@@ -379,8 +379,14 @@
         <varlistentry>
           <term><parameter>connection-spec</parameter></term>
           <listitem>
-            <para>A vendor specific connection specification supplied
-            as a list or as a string.</para>
+            <para>A SQL backend specific connection specification
+            supplied as a list or as a string.</para>
+            <para>For the MySQL backend, this list includes an
+            optional associative list of connection options. The
+            options list is parsed and supplied to the MySQL API
+            using <function>mysql_options</function> in between the
+            calls to <function>mysql_init</function>
+            and <function>mysql_real_connect</function>.</para>
           </listitem>
         </varlistentry>
         <varlistentry>