List:Commits« Previous MessageNext Message »
From:paul Date:February 6 2007 4:21pm
Subject:svn commit - mysqldoc@docsrva: r4817 - in trunk: . refman-4.1 refman-5.0 refman-5.1
View as plain text  
Author: paul
Date: 2007-02-06 17:21:21 +0100 (Tue, 06 Feb 2007)
New Revision: 4817

Log:
 r15931@frost:  paul | 2007-02-06 10:20:36 -0600
 C API binary protocol:
 Fix the description for is_unsigned.
 Add information about input data character set.


Modified:
   trunk/refman-4.1/apis-c.xml
   trunk/refman-5.0/apis-c.xml
   trunk/refman-5.1/apis-c.xml

Property changes on: trunk
___________________________________________________________________
Name: svk:merge
   - 4767c598-dc10-0410-bea0-d01b485662eb:/mysqldoc-local/mysqldoc/trunk:19415
7d8d2c4e-af1d-0410-ab9f-b038ce55645b:/mysqldoc-local/mysqldoc:15928
b5ec3a16-e900-0410-9ad2-d183a3acac99:/mysqldoc-local/mysqldoc/trunk:14218
bf112a9c-6c03-0410-a055-ad865cd57414:/mysqldoc-local/mysqldoc/trunk:13520
   + 4767c598-dc10-0410-bea0-d01b485662eb:/mysqldoc-local/mysqldoc/trunk:19415
7d8d2c4e-af1d-0410-ab9f-b038ce55645b:/mysqldoc-local/mysqldoc:15931
b5ec3a16-e900-0410-9ad2-d183a3acac99:/mysqldoc-local/mysqldoc/trunk:14218
bf112a9c-6c03-0410-a055-ad865cd57414:/mysqldoc-local/mysqldoc/trunk:13520


Modified: trunk/refman-4.1/apis-c.xml
===================================================================
--- trunk/refman-4.1/apis-c.xml	2007-02-06 15:58:47 UTC (rev 4816)
+++ trunk/refman-4.1/apis-c.xml	2007-02-06 16:21:21 UTC (rev 4817)
Changed blocks: 5, Lines Added: 47, Lines Deleted: 14; 5108 bytes

@@ -7908,7 +7908,8 @@
           returns a statement handle (that is, a pointer to a
           <literal>MYSQL_STMT</literal>). The handle is used for all
           subsequent operations with the statement until you close it
-          with <literal>mysql_stmt_close()</literal>.
+          with <literal>mysql_stmt_close()</literal>, at which point the
+          handle becomes invalid.
         </para>
 
         <para>

@@ -7978,7 +7979,7 @@
         <para>
           The <literal>MYSQL_BIND</literal> structure contains the
           following members for use by application programs. A given
-          member might are used for different purposes depending on
+          member might be used for different purposes, depending on
           whether the structure is used for input or output.
         </para>
 

@@ -8010,11 +8011,9 @@
               is a pointer to the buffer in which to return a result set
               column value. For numeric data types,
               <literal>buffer</literal> should point to a variable of
-              the proper C type. (If you are associating the variable
-              with a column that has the <literal>UNSIGNED</literal>
-              attribute, the variable should be an
-              <literal>unsigned</literal> C type. Indicate whether the
-              variable is signed or unsigned by using the
+              the proper C type. (For <literal>char</literal> or integer
+              variables, indicate whether the variable has the
+              <literal>unsigned</literal> attribute by using the
               <literal>is_unsigned</literal> member, described later in
               this list.) For date and time data types,
               <literal>buffer</literal> should point to a

@@ -8141,14 +8140,36 @@
             </para>
 
             <para>
-              This member is used for integer types. (These correspond
-              to the <literal>MYSQL_TYPE_TINY</literal>,
-              <literal>MYSQL_TYPE_SHORT</literal>,
-              <literal>MYSQL_TYPE_LONG</literal>, and
-              <literal>MYSQL_TYPE_LONGLONG</literal> type codes.)
-              <literal>is_unsigned</literal> should be set to true for
-              unsigned types and false for signed types.
+              This member is used for C variables with data types that
+              can be <literal>unsigned</literal>
+              (<literal>char</literal>, <literal>short int</literal>,
+              <literal>int</literal>, <literal>long long int</literal>).
+              integer types. Set <literal>is_unsigned</literal> to true
+              if the variable pointed to by <literal>buffer</literal> is
+              <literal>unsigned</literal> and false otherwise. For
+              example, if you bind a <literal>char</literal> variable to
+              <literal>buffer</literal>, specify a type code of
+              <literal>MYSQL_TYPE_TINY</literal> and set
+              <literal>is_unsigned</literal> to false. If you bind an
+              <literal>unsigned char</literal> insteaad, the type code
+              is the same, but <literal>is_unsigned</literal> should be
+              true.
             </para>
+
+            <para>
+              <literal>is_unsigned</literal> indicates nothing about the
+              signedness of the SQL value that you are sending or
+              receiving. For example, if you use an
+              <literal>int</literal> (signed) variable to supply a value
+              for a <literal>BIGINT UNSIGNED</literal> column,
+              <literal>is_unsigned</literal> should be false. If you use
+              an <literal>unsigned int</literal> variable to supply a
+              value for a <literal>BIGINT</literal> (signed) column,
+              <literal>is_unsigned</literal> should be true. MySQL
+              performs the proper conversion between signed and unsigned
+              values in both directions, although a warning occurs if
+              truncation results.
+            </para>
           </listitem>
 
         </itemizedlist>

@@ -8281,6 +8302,18 @@
     </para>
 
     <para>
+      For input character (non-binary) string data, the value is assumed
+      to be in the character set indicated by the
+      <literal>character_set_client</literal> system variable. If the
+      value is stored into a column with a different character set, the
+      appropriate conversion to that character set occurs. For input
+      binary string data (indicated by
+      <literal>MYSQL_TYPE_BLOB</literal>, for examplel), the value is
+      treated as having the <literal>binary</literal> character set;
+      that is, it is treated as a byte string and no conversion occurs.
+    </para>
+
+    <para>
       To determine whether string values in a result set returned from
       the server contain binary or non-binary data, check whether the
       <literal>charsetnr</literal> value of the result set metadata is


Modified: trunk/refman-5.0/apis-c.xml
===================================================================
--- trunk/refman-5.0/apis-c.xml	2007-02-06 15:58:47 UTC (rev 4816)
+++ trunk/refman-5.0/apis-c.xml	2007-02-06 16:21:21 UTC (rev 4817)
Changed blocks: 5, Lines Added: 47, Lines Deleted: 14; 5105 bytes

@@ -7999,7 +7999,8 @@
           returns a statement handle (that is, a pointer to a
           <literal>MYSQL_STMT</literal>). The handle is used for all
           subsequent operations with the statement until you close it
-          with <literal>mysql_stmt_close()</literal>.
+          with <literal>mysql_stmt_close()</literal>, at which point the
+          handle becomes invalid.
         </para>
 
         <para>

@@ -8069,7 +8070,7 @@
         <para>
           The <literal>MYSQL_BIND</literal> structure contains the
           following members for use by application programs. A given
-          member might are used for different purposes depending on
+          member might be used for different purposes, depending on
           whether the structure is used for input or output.
         </para>
 

@@ -8101,11 +8102,9 @@
               is a pointer to the buffer in which to return a result set
               column value. For numeric data types,
               <literal>buffer</literal> should point to a variable of
-              the proper C type. (If you are associating the variable
-              with a column that has the <literal>UNSIGNED</literal>
-              attribute, the variable should be an
-              <literal>unsigned</literal> C type. Indicate whether the
-              variable is signed or unsigned by using the
+              the proper C type. (For <literal>char</literal> or integer
+              variables, indicate whether the variable has the
+              <literal>unsigned</literal> attribute by using the
               <literal>is_unsigned</literal> member, described later in
               this list.) For date and time data types,
               <literal>buffer</literal> should point to a

@@ -8232,14 +8231,36 @@
             </para>
 
             <para>
-              This member is used for integer types. (These correspond
-              to the <literal>MYSQL_TYPE_TINY</literal>,
-              <literal>MYSQL_TYPE_SHORT</literal>,
-              <literal>MYSQL_TYPE_LONG</literal>, and
-              <literal>MYSQL_TYPE_LONGLONG</literal> type codes.)
-              <literal>is_unsigned</literal> should be set to true for
-              unsigned types and false for signed types.
+              This member is used for C variables with data types that
+              can be <literal>unsigned</literal>
+              (<literal>char</literal>, <literal>short int</literal>,
+              <literal>int</literal>, <literal>long long int</literal>).
+              integer types. Set <literal>is_unsigned</literal> to true
+              if the variable pointed to by <literal>buffer</literal> is
+              <literal>unsigned</literal> and false otherwise. For
+              example, if you bind a <literal>char</literal> variable to
+              <literal>buffer</literal>, specify a type code of
+              <literal>MYSQL_TYPE_TINY</literal> and set
+              <literal>is_unsigned</literal> to false. If you bind an
+              <literal>unsigned char</literal> insteaad, the type code
+              is the same, but <literal>is_unsigned</literal> should be
+              true.
             </para>
+
+            <para>
+              <literal>is_unsigned</literal> indicates nothing about the
+              signedness of the SQL value that you are sending or
+              receiving. For example, if you use an
+              <literal>int</literal> (signed) variable to supply a value
+              for a <literal>BIGINT UNSIGNED</literal> column,
+              <literal>is_unsigned</literal> should be false. If you use
+              an <literal>unsigned int</literal> variable to supply a
+              value for a <literal>BIGINT</literal> (signed) column,
+              <literal>is_unsigned</literal> should be true. MySQL
+              performs the proper conversion between signed and unsigned
+              values in both directions, although a warning occurs if
+              truncation results.
+            </para>
           </listitem>
 
           <listitem>

@@ -8397,6 +8418,18 @@
     </para>
 
     <para>
+      For input character (non-binary) string data, the value is assumed
+      to be in the character set indicated by the
+      <literal>character_set_client</literal> system variable. If the
+      value is stored into a column with a different character set, the
+      appropriate conversion to that character set occurs. For input
+      binary string data (indicated by
+      <literal>MYSQL_TYPE_BLOB</literal>, for examplel), the value is
+      treated as having the <literal>binary</literal> character set;
+      that is, it is treated as a byte string and no conversion occurs.
+    </para>
+
+    <para>
       To determine whether string values in a result set returned from
       the server contain binary or non-binary data, check whether the
       <literal>charsetnr</literal> value of the result set metadata is


Modified: trunk/refman-5.1/apis-c.xml
===================================================================
--- trunk/refman-5.1/apis-c.xml	2007-02-06 15:58:47 UTC (rev 4816)
+++ trunk/refman-5.1/apis-c.xml	2007-02-06 16:21:21 UTC (rev 4817)
Changed blocks: 5, Lines Added: 47, Lines Deleted: 14; 5105 bytes

@@ -8118,7 +8118,8 @@
           returns a statement handle (that is, a pointer to a
           <literal>MYSQL_STMT</literal>). The handle is used for all
           subsequent operations with the statement until you close it
-          with <literal>mysql_stmt_close()</literal>.
+          with <literal>mysql_stmt_close()</literal>, at which point the
+          handle becomes invalid.
         </para>
 
         <para>

@@ -8188,7 +8189,7 @@
         <para>
           The <literal>MYSQL_BIND</literal> structure contains the
           following members for use by application programs. A given
-          member might are used for different purposes depending on
+          member might be used for different purposes, depending on
           whether the structure is used for input or output.
         </para>
 

@@ -8220,11 +8221,9 @@
               is a pointer to the buffer in which to return a result set
               column value. For numeric data types,
               <literal>buffer</literal> should point to a variable of
-              the proper C type. (If you are associating the variable
-              with a column that has the <literal>UNSIGNED</literal>
-              attribute, the variable should be an
-              <literal>unsigned</literal> C type. Indicate whether the
-              variable is signed or unsigned by using the
+              the proper C type. (For <literal>char</literal> or integer
+              variables, indicate whether the variable has the
+              <literal>unsigned</literal> attribute by using the
               <literal>is_unsigned</literal> member, described later in
               this list.) For date and time data types,
               <literal>buffer</literal> should point to a

@@ -8351,14 +8350,36 @@
             </para>
 
             <para>
-              This member is used for integer types. (These correspond
-              to the <literal>MYSQL_TYPE_TINY</literal>,
-              <literal>MYSQL_TYPE_SHORT</literal>,
-              <literal>MYSQL_TYPE_LONG</literal>, and
-              <literal>MYSQL_TYPE_LONGLONG</literal> type codes.)
-              <literal>is_unsigned</literal> should be set to true for
-              unsigned types and false for signed types.
+              This member is used for C variables with data types that
+              can be <literal>unsigned</literal>
+              (<literal>char</literal>, <literal>short int</literal>,
+              <literal>int</literal>, <literal>long long int</literal>).
+              integer types. Set <literal>is_unsigned</literal> to true
+              if the variable pointed to by <literal>buffer</literal> is
+              <literal>unsigned</literal> and false otherwise. For
+              example, if you bind a <literal>char</literal> variable to
+              <literal>buffer</literal>, specify a type code of
+              <literal>MYSQL_TYPE_TINY</literal> and set
+              <literal>is_unsigned</literal> to false. If you bind an
+              <literal>unsigned char</literal> insteaad, the type code
+              is the same, but <literal>is_unsigned</literal> should be
+              true.
             </para>
+
+            <para>
+              <literal>is_unsigned</literal> indicates nothing about the
+              signedness of the SQL value that you are sending or
+              receiving. For example, if you use an
+              <literal>int</literal> (signed) variable to supply a value
+              for a <literal>BIGINT UNSIGNED</literal> column,
+              <literal>is_unsigned</literal> should be false. If you use
+              an <literal>unsigned int</literal> variable to supply a
+              value for a <literal>BIGINT</literal> (signed) column,
+              <literal>is_unsigned</literal> should be true. MySQL
+              performs the proper conversion between signed and unsigned
+              values in both directions, although a warning occurs if
+              truncation results.
+            </para>
           </listitem>
 
           <listitem>

@@ -8515,6 +8536,18 @@
     </para>
 
     <para>
+      For input character (non-binary) string data, the value is assumed
+      to be in the character set indicated by the
+      <literal>character_set_client</literal> system variable. If the
+      value is stored into a column with a different character set, the
+      appropriate conversion to that character set occurs. For input
+      binary string data (indicated by
+      <literal>MYSQL_TYPE_BLOB</literal>, for examplel), the value is
+      treated as having the <literal>binary</literal> character set;
+      that is, it is treated as a byte string and no conversion occurs.
+    </para>
+
+    <para>
       To determine whether string values in a result set returned from
       the server contain binary or non-binary data, check whether the
       <literal>charsetnr</literal> value of the result set metadata is


Thread
svn commit - mysqldoc@docsrva: r4817 - in trunk: . refman-4.1 refman-5.0 refman-5.1paul6 Feb