Skip to content

Commit

Permalink
Little documentation clean up
Browse files Browse the repository at this point in the history
  • Loading branch information
slegrand45 committed Feb 4, 2016
1 parent 11a6529 commit 18b1503
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 11 deletions.
15 changes: 7 additions & 8 deletions docs/Mp_client.html
Original file line number Diff line number Diff line change
Expand Up @@ -291,12 +291,14 @@ <h1>Module <a href="type_Mp_client.html">Mp_client</a></h1>

insert_id can be negative in two cases:<ul>
<li>the auto_increment value is indeed negative (SIGNED field).</li>
<li>the returned value overflows Int64 maximum (BIGINT UNSIGNED field).
<li>the returned value overflows Int64 maximum (BIGINT UNSIGNED field).</li>
</ul>

Unfortunately, the protocol gives no way to differentiate these two
cases (see https://bugs.mysql.com/bug.php?id=69228).
So we return two values:</li>
cases (see <a href="https://bugs.mysql.com/bug.php?id=69228"> this bug report</a>).
So we return two values:<ul>
<li>the first one is a Int64 and must be used when the
auto_increment is _not_ a BIGINT UNSIGNED field.</li>
auto_increment is <b>_not_</b> a BIGINT UNSIGNED field.</li>
<li>the second one is a Big_int and must be used when the
auto_increment is a BIGINT UNSIGNED field.</li>
</ul>
Expand All @@ -310,10 +312,7 @@ <h1>Module <a href="type_Mp_client.html">Mp_client</a></h1>
<code>&nbsp;&nbsp;</code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTprepare_result.prepare_handler">prepare_handler</span>&nbsp;: <code class="type">Int64.t</code>;</code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" ><div class="info ">
id<br>
</div>
</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>

</tr>
<tr>
<td align="left" valign="top" >
Expand Down
7 changes: 4 additions & 3 deletions src/mp_client.mli
Original file line number Diff line number Diff line change
Expand Up @@ -82,11 +82,12 @@ type connection = {
insert_id can be negative in two cases:
- the auto_increment value is indeed negative (SIGNED field).
- the returned value overflows Int64 maximum (BIGINT UNSIGNED field).
Unfortunately, the protocol gives no way to differentiate these two
cases (see https://bugs.mysql.com/bug.php?id=69228).
cases (see {{:https://bugs.mysql.com/bug.php?id=69228} this bug report}).
So we return two values:
- the first one is a Int64 and must be used when the
auto_increment is _not_ a BIGINT UNSIGNED field.
auto_increment is {b _not_} a BIGINT UNSIGNED field.
- the second one is a Big_int and must be used when the
auto_increment is a BIGINT UNSIGNED field.
*)
Expand All @@ -102,7 +103,7 @@ type dml_dcl_result = {
Result for a prepare command.
*)
type prepare_result = {
prepare_handler : Int64.t; (** id *)
prepare_handler : Int64.t;
prepare_nb_columns : int;
prepare_nb_parameters : int;
prepare_warning_count : int;
Expand Down

0 comments on commit 18b1503

Please sign in to comment.