X-Git-Url: http://git.kpe.io/?a=blobdiff_plain;f=doc%2Fref.sgml;h=bb77f598b462297d3053eea56379110cc090fced;hb=fcd7e2fa0784a586e9c8f241761d38a622cbec28;hp=0c860c16c838d9d33b7daff2c23092fe15d7786a;hpb=9a78eef71c902d3b272fb7c777bff6dd0acd8a2b;p=clsql.git

diff --git a/doc/ref.sgml b/doc/ref.sgml
index 0c860c1..bb77f59 100644
--- a/doc/ref.sgml
+++ b/doc/ref.sgml
@@ -1780,7 +1780,7 @@
       </refnamediv>
       <refsect1>
 	<title>Syntax</title>
-	<synopsis><function>query</function> <replaceable>query-expression</replaceable> &amp;key <replaceable>database</replaceable> => <returnvalue>result</returnvalue></synopsis>
+	<synopsis><function>query</function> <replaceable>query-expression</replaceable> &amp;key <replaceable>database</replaceable> <replaceable>types</replaceable> => <returnvalue>result</returnvalue></synopsis>
       </refsect1>
       <refsect1>
 	<title>Arguments and Values</title>
@@ -1803,6 +1803,50 @@
 		of <symbol>*default-database*</symbol>.</para>
 	    </listitem>
 	  </varlistentry>
+	  <varlistentry>
+	    <term><parameter>types</parameter></term>
+	    <listitem>
+	      <para>A 
+		<glossterm linkend="gloss-field-types">field type
+		  specififier</glossterm>. The default is &nil;.
+		</para>
+		<para>
+		  The purpose of this argument is cause &clsql; to
+		  import SQL numeric fields into numeric Lisp objects
+		  rather than strings. This reduces the cost of
+		  allocating a temporary string and the &clsql; users'
+		  inconvenience of converting number strings into number
+		  objects.
+		</para>
+		<para>
+		  A value of <symbol>:auto</symbol> causes &clsql;
+		  to automatically convert SQL fields into a
+		  numeric format where applicable. The default value of
+		  &nil; causes all fields to be returned as strings
+		  regardless of the SQL type. Otherwise a list is expected
+		  which has a element for each field that specifies the
+		  conversion. If the list is shorter than the number
+		  of fields, the a value of <symbol>t</symbol> is
+		  assumed for the field.  If the list is longer than
+		  the number of fields, the extra elements are
+		  ignored.
+		  <simplelist type="vert">
+		    <member><symbol>:int</symbol> Field is imported as a
+		      32-bit signed integer.
+		    </member>
+		    <member><symbol>:longlong</symbol> Field is imported as a
+		      64-bit signed integer.
+		    </member>
+		    <member><symbol>:double</symbol> Field is imported as a
+		      double-float number.
+		    </member>
+		    <member><symbol>t</symbol> Field is imported as a
+		      string.
+		    </member>
+		  </simplelist>
+		</para>
+	    </listitem>
+	  </varlistentry>
 	  <varlistentry>
 	    <term><returnvalue>result</returnvalue></term>
 	    <listitem>
@@ -1889,7 +1933,7 @@
       </refnamediv>
       <refsect1>
 	<title>Syntax</title>
-	<synopsis><function>map-query</function> <replaceable>output-type-spec</replaceable> <replaceable>function</replaceable> <replaceable>query-expression</replaceable> &amp;key <replaceable>database</replaceable> => <returnvalue>result</returnvalue></synopsis>
+	<synopsis><function>map-query</function> <replaceable>output-type-spec</replaceable> <replaceable>function</replaceable> <replaceable>query-expression</replaceable> &amp;key <replaceable>database</replaceable> <replaceable>types</replaceable> => <returnvalue>result</returnvalue></synopsis>
       </refsect1>
       <refsect1>
 	<title>Arguments and Values</title>
@@ -1929,6 +1973,17 @@
 		of <symbol>*default-database*</symbol>.</para>
 	    </listitem>
 	  </varlistentry>
+	  <varlistentry>
+	    <term><parameter>types</parameter></term>
+	    <listitem>
+	      <para>
+		A <glossterm linkend="gloss-field-types">field type specififier</glossterm>. 
+		The default is &nil;. See <link
+		linkend="query"><function>query</function></link>
+		for the semantics of this argument.  
+	      </para>
+	    </listitem>
+	  </varlistentry>
 	  <varlistentry>
 	    <term><returnvalue>result</returnvalue></term>
 	    <listitem>
@@ -2049,7 +2104,7 @@
       </refnamediv>
       <refsect1>
 	<title>Syntax</title>
-	<synopsis><function>do-query</function> ((&amp;rest <replaceable>args</replaceable>) <replaceable>query-expression</replaceable> &amp;key <replaceable>database</replaceable>) &amp;body <replaceable>body</replaceable> => <returnvalue>nil</returnvalue></synopsis>
+	<synopsis><function>do-query</function> ((&amp;rest <replaceable>args</replaceable>) <replaceable>query-expression</replaceable> &amp;key <replaceable>database</replaceable> <replaceable>types</replaceable>) &amp;body <replaceable>body</replaceable> => <returnvalue>nil</returnvalue></synopsis>
       </refsect1>
       <refsect1>
 	<title>Arguments and Values</title>
@@ -2079,6 +2134,17 @@
 		<symbol>*default-database*</symbol>.</para>
 	    </listitem>
 	  </varlistentry>
+	  <varlistentry>
+	    <term><parameter>types</parameter></term>
+	    <listitem>
+	      <para>
+		A <glossterm linkend="gloss-field-types">field type specififier</glossterm>. 
+		The default is &nil;. See <link
+		linkend="query"><function>query</function></link>
+		for the semantics of this argument.  
+	      </para>
+	    </listitem>
+	  </varlistentry>
 	  <varlistentry>
 	    <term><parameter>body</parameter></term>
 	    <listitem>