Author: mcbrown
Date: 2006-05-01 18:07:24 +0200 (Mon, 01 May 2006)
New Revision: 1977
Log:
Documenting Docs Bug #16783
Also changed function to method (where relevant)
Fixed some cosmetic changes
Modified:
trunk/refman-5.1/custom-engine.xml
Modified: trunk/refman-5.1/custom-engine.xml
===================================================================
--- trunk/refman-5.1/custom-engine.xml 2006-05-01 00:49:08 UTC (rev 1976)
+++ trunk/refman-5.1/custom-engine.xml 2006-05-01 16:07:24 UTC (rev 1977)
@@ -163,10 +163,10 @@
<para>
The <literal>handlerton</literal> (short for <quote>handler
singleton</quote>) defines the storage engine and contains
- function pointers to those functions that apply to the storage
- engine as a whole, as opposed to functions that work on a
- per-table basis. Some examples of such functions include
- transaction functions to handle commits and rollbacks.
+ method pointers to those methods that apply to the storage
+ engine as a whole, as opposed to methods that work on a
+ per-table basis. Some examples of such methods include
+ transaction methods to handle commits and rollbacks.
</para>
<para>
@@ -257,7 +257,7 @@
<para>
There are a total of 30 handlerton elements, only a few of which
are mandatory (specifically the first four elements and the
- <function>create()</function> function).
+ <function>create()</function> method).
</para>
<orderedlist>
@@ -308,8 +308,8 @@
<listitem>
<para>
- A function pointer to the storage engine initializer. This
- function is only called once when the server starts to allow
+ A method pointer to the storage engine initializer. This
+ method is only called once when the server starts to allow
the storage engine class to perform any housekeeping that is
necessary before handlers are instanced.
</para>
@@ -370,8 +370,8 @@
<listitem>
<para>
- A function pointer to the handler's
- <function>savepoint_set()</function> function. This is used to
+ A method pointer to the handler's
+ <function>savepoint_set()</function> method. This is used to
create a savepoint and store it in memory of the requested
size.
</para>
@@ -386,8 +386,8 @@
<listitem>
<para>
- A function pointer to the handler's
- <function>rollback_to_savepoint()</function> function. This is
+ A method pointer to the handler's
+ <function>rollback_to_savepoint()</function> method. This is
used to return to a savepoint during a transaction. It's only
populated for storage engines that support savepoints.
</para>
@@ -402,8 +402,8 @@
<listitem>
<para>
- A function pointer to the handler's
- <function>release_savepoint()</function> function. This is
+ A method pointer to the handler's
+ <function>release_savepoint()</function> method. This is
used to release the resources of a savepoint during a
transaction. It's optionally populated for storage engines
that support savepoints.
@@ -419,8 +419,8 @@
<listitem>
<para>
- A function pointer to the handler's
- <function>commit()</function> function. This is used to commit
+ A method pointer to the handler's
+ <function>commit()</function> method. This is used to commit
a transaction. It's only populated for storage engines that
support transactions.
</para>
@@ -435,8 +435,8 @@
<listitem>
<para>
- A function pointer to the handler's
- <function>rollback()</function> function. This is used to roll
+ A method pointer to the handler's
+ <function>rollback()</function> method. This is used to roll
back a transaction. It's only populated for storage engines
that support transactions.
</para>
@@ -536,7 +536,7 @@
<listitem>
<para>
- Cleanup function called during server shutdown and crashes.
+ Cleanup method called during server shutdown and crashes.
</para>
</listitem>
@@ -544,7 +544,7 @@
<listitem>
<para>
- <literal>InnoDB</literal>-specific function.
+ <literal>InnoDB</literal>-specific method.
</para>
</listitem>
@@ -552,7 +552,7 @@
<listitem>
<para>
- <literal>InnoDB</literal>-specific function called at start of
+ <literal>InnoDB</literal>-specific method called at start of
<literal>SHOW ENGINE InnoDB STATUS</literal>.
</para>
</listitem>
@@ -561,7 +561,7 @@
<listitem>
<para>
- Function called to begin a consistent read.
+ Method called to begin a consistent read.
</para>
</listitem>
@@ -588,7 +588,7 @@
<listitem>
<para>
- <literal>InnoDB</literal>-specific function used for
+ <literal>InnoDB</literal>-specific method used for
replication.
</para>
</listitem>
@@ -648,8 +648,8 @@
<para>
Before the <literal>handlerton</literal> is defined in the storage
- engine source file, a function header for the instantiation
- function must be defined. Here is an example from the
+ engine source file, a method header for the instantiation
+ method must be defined. Here is an example from the
<literal>CSV</literal> engine:
</para>
@@ -658,20 +658,20 @@
</programlisting>
<para>
- As you can see, the function accepts a pointer to the table the
+ As you can see, the method accepts a pointer to the table the
handler is intended to manage, and returns a handler object.
</para>
<para>
- After the function header is defined, the function is named with a
- function pointer in the <function>create()</function>
- <literal>handlerton</literal> element, identifying the function as
+ After the method header is defined, the method is named with a
+ method pointer in the <function>create()</function>
+ <literal>handlerton</literal> element, identifying the method as
being responsible for generating new handler instances.
</para>
<para>
Here is an example of the <literal>MyISAM</literal> storage
- engine's instantiation function:
+ engine's instantiation method:
</para>
<programlisting>
@@ -747,7 +747,7 @@
<para>
This array is returned when the
<link linkend="custom-engine-api-reference-bas_ext"><literal>bas_ext()</literal></link>
- function is called:
+ method is called:
</para>
<programlisting>
@@ -779,7 +779,7 @@
Your storage engine must implement the
<link
linkend="custom-engine-api-reference-create"><function>create()</function></link>
- virtual function:
+ virtual method:
</para>
<programlisting>
@@ -787,7 +787,7 @@
</programlisting>
<para>
- This function should create all necessary files but does not need
+ This method should create all necessary files but does not need
to open the table. The MySQL server will call for the table to be
opened later on.
</para>
@@ -881,7 +881,7 @@
<para>
The <literal>my_create</literal> and <literal>my_close</literal>
- functions are helper functions defined in
+ methods are helper methods defined in
<filename>src/include/my_sys.h</filename>.
</para>
@@ -984,13 +984,13 @@
<section id="custom-engine-scanning-store">
- <title>Implementing the <function>store_lock()</function> Function</title>
+ <title>Implementing the <function>store_lock()</function> Method</title>
<para>
The
<link
linkend="custom-engine-api-reference-store_lock"><function>store_lock()</function></link>
- function is called before any reading or writing is performed.
+ method is called before any reading or writing is performed.
</para>
<para>
@@ -1075,13 +1075,13 @@
<section id="custom-engine-scanning-external">
- <title>Implementing the <function>external_lock()</function> Function</title>
+ <title>Implementing the <function>external_lock()</function> Method</title>
<para>
The
<link
linkend="custom-engine-api-reference-external_lock"><function>external_lock()</function></link>
- function is called at the start of a statement or when a
+ method is called at the start of a statement or when a
<literal>LOCK TABLES</literal> statement is issued.
</para>
@@ -1105,12 +1105,12 @@
<section id="custom-engine-scanning-init">
- <title>Implementing the <function>rnd_init()</function> Function</title>
+ <title>Implementing the <function>rnd_init()</function> Method</title>
<para>
- The function called before any table scan is the
+ The method called before any table scan is the
<link linkend="custom-engine-api-reference-rnd_init"><function>rnd_init()</function></link>
- function. The <function>rnd_init()</function> function is used
+ method. The <function>rnd_init()</function> method is used
to prepare for a table scan, resetting counters and pointers to
the start of the table.
</para>
@@ -1143,12 +1143,12 @@
<section id="custom-engine-scanning-info">
- <title>Implementing the <function>info()</function> Function</title>
+ <title>Implementing the <function>info()</function> Method</title>
<para>
Prior to commencing a table scan, the
<link linkend="custom-engine-api-reference-info"><function>info()</function></link>
- function is called to provide extra table information to the
+ method is called to provide extra table information to the
optimizer.
</para>
@@ -1161,7 +1161,7 @@
<para>
In addition to being used by the optimizer, many of the values
- set during a call to the <function>info()</function> function
+ set during a call to the <function>info()</function> method
are also used for the <literal>SHOW TABLE STATUS</literal>
statement.
@@ -1210,13 +1210,13 @@
<section id="custom-engine-scanning-extra">
- <title>Implementing the <function>extra()</function> Function</title>
+ <title>Implementing the <function>extra()</function> Method</title>
<para>
Prior to some operations, the
<link
linkend="custom-engine-api-reference-extra"><function>extra()</function></link>
- function is called to provide extra hints to the storage engine
+ method is called to provide extra hints to the storage engine
on how to perform certain operations.
</para>
@@ -1238,21 +1238,21 @@
<section id="custom-engine-table-scanning-next">
- <title>Implementing the <function>rnd_next()</function> Function</title>
+ <title>Implementing the <function>rnd_next()</function> Method</title>
<para>
After the table is initialized, the MySQL server will call the
handler's
<link
linkend="custom-engine-api-reference-rnd_next"><function>rnd_next()</function></link>
- function once for every row to be scanned until the server's
+ method once for every row to be scanned until the server's
search condition is satisfied or an end of file is reached, in
which case the handler returns
<literal>HA_ERR_END_OF_FILE</literal>.
</para>
<para>
- The <function>rnd_next()</function> function takes a single byte
+ The <function>rnd_next()</function> method takes a single byte
array parameter named <literal>*buf</literal>. The
<literal>*buf</literal> parameter must be populated with the
contents of the table row in the internal MySQL format.
@@ -1331,7 +1331,7 @@
<para>
The conversion from the internal row format to CSV row format is
performed in the <function>find_current_row()</function>
- function:
+ method:
</para>
<programlisting>
@@ -1440,7 +1440,7 @@
<para>
All <literal>INSERT</literal> operations are handled through the
<link linkend="custom-engine-api-reference-write_row"><function>write_row()</function></link>
- function:
+ method:
</para>
<programlisting>
@@ -1453,7 +1453,7 @@
could simply advance to the end of the data file and append the
contents of the buffer directly (this would also make reading rows
easier as you could read the row and pass it directly into the
- buffer parameter of the <function>rnd_next()</function> function.
+ buffer parameter of the <function>rnd_next()</function> method.
</para>
<para>
@@ -1502,7 +1502,7 @@
<literal>UPDATE</literal> statement, then calling the
<link
linkend="custom-engine-api-reference-update_row"><function>update_row()</function>
- function:</link>
+ method:</link>
</para>
<programlisting>
@@ -1575,10 +1575,10 @@
The MySQL server executes <literal>DELETE</literal> statements
using the same approach as for <literal>UPDATE</literal>
statements: It advances to the row to be deleted using the
- <function>rnd_next()</function> function and then calls the
+ <function>rnd_next()</function> method and then calls the
<link
linkend="custom-engine-api-reference-delete_row"><function>delete_row()</function></link>
- function to delete the row:
+ method to delete the row:
</para>
<programlisting>
@@ -1626,19 +1626,19 @@
<para>
In addition to table scanning, storage engines can implement
- functions for non-sequential reading. The MySQL server uses these
- functions for certain sort operations.
+ methods for non-sequential reading. The MySQL server uses these
+ methods for certain sort operations.
</para>
<section id="custom-engine-non-sequential-position">
- <title>Implementing the <function>position()</function> Function</title>
+ <title>Implementing the <function>position()</function> Method</title>
<para>
The
<link
linkend="custom-engine-api-reference-position"><function>position()</function></link>
- function is called after every call to
+ method is called after every call to
<function>rnd_next()</function> if the data needs to be
reordered:
</para>
@@ -1658,13 +1658,13 @@
<section id="custom-engine-non-sequential-rnd_pos">
- <title>Implementing the <function>rnd_pos()</function> Function</title>
+ <title>Implementing the <function>rnd_pos()</function> Method</title>
<para>
The
<link linkend="custom-engine-api-reference-rnd_pos"><function>rnd_pos()</function></link>
- function behaves in a similar fashion to the
- <function>rnd_next()</function> function but takes an additional
+ method behaves in a similar fashion to the
+ <function>rnd_next()</function> method but takes an additional
parameter:
</para>
@@ -1675,7 +1675,7 @@
<para>
The <literal>*pos</literal> parameter contains positioning
information previously recorded using the
- <function>position()</function> function.
+ <function>position()</function> method.
</para>
<para>
@@ -1723,7 +1723,7 @@
</para>
<para>
- The following example shows the function calls made during an
+ The following example shows the method calls made during an
<literal>UPDATE</literal> query that uses an index, such as
<literal>UPDATE foo SET ts = now() WHERE id = 1</literal>:
</para>
@@ -1763,7 +1763,7 @@
The table index information is contained within the
<literal>key_info</literal> structure of the
<literal>TABLE</literal> argument of the
- <function>create()</function> function.
+ <function>create()</function> method.
</para>
<para>
@@ -1841,7 +1841,7 @@
<para>
In general, the storage engine will have to use row information
- passed in functions such as
+ passed in methods such as
<link linkend="custom-engine-api-reference-write_row"><function>write_row()</function></link>,
<link linkend="custom-engine-api-reference-delete_row"><function>delete_row()</function></link>,
and
@@ -1943,13 +1943,13 @@
<section id="custom-engine-index-optimizer-info">
- <title>Implementing the <function>info()</function> Function</title>
+ <title>Implementing the <function>info()</function> Method</title>
<para>
The optimizer requests an update of table information by
calling the
<link linkend="custom-engine-api-reference-info"><function>handler::info()</function></link>
- function. The <function>info()</function> function does not
+ method. The <function>info()</function> method does not
have a return value, instead it is expected that the storage
engine will set a variety of public variables that the server
will then read as needed. These values are also used to
@@ -2046,12 +2046,12 @@
<section id="custom-engine-index-optimizer-range">
- <title>Implementing the <function>records_in_range</function> Function</title>
+ <title>Implementing the <function>records_in_range</function> Method</title>
<para>
The
<link linkend="custom-engine-api-reference-records_in_range"><function>records_in_range()</function></link>
- function is called by the optimizer to assist in choosing
+ method is called by the optimizer to assist in choosing
which index on a table to use for a query or join. It is
defined as follows:
</para>
@@ -2159,7 +2159,7 @@
<para>
The
<link linkend="custom-engine-api-reference-index_init"><literal>index_init()</literal></link>
- function is called before an index is used to allow the storage
+ method is called before an index is used to allow the storage
engine to perform any necessary preparation or optimization:
</para>
@@ -2186,11 +2186,11 @@
<para>
The
<link linkend="custom-engine-api-reference-index_end"><function>index_end()</function></link>
- function is a counterpart to the
- <function>index_init()</function> function. The purpose of the
- <function>index_end()</function> function is to clean up any
+ method is a counterpart to the
+ <function>index_init()</function> method. The purpose of the
+ <function>index_end()</function> method is to clean up any
preparations made by the <function>index_init()</function>
- function.
+ method.
</para>
<para>
@@ -2203,12 +2203,12 @@
<section id="custom-engine-index-read">
- <title>Implementing the <function>index_read()</function> Function</title>
+ <title>Implementing the <function>index_read()</function> Method</title>
<para>
The
<link linkend="custom-engine-api-reference-index_read"><function>index_read()</function></link>
- function is used to retrieve a row based on a key:
+ method is used to retrieve a row based on a key:
</para>
<programlisting>
@@ -2238,14 +2238,14 @@
</para>
<programlisting>
+HA_READ_AFTER_KEY
+HA_READ_BEFORE_KEY
HA_READ_KEY_EXACT
HA_READ_KEY_OR_NEXT
+HA_READ_KEY_OR_PREV
+HA_READ_PREFIX
HA_READ_PREFIX_LAST
HA_READ_PREFIX_LAST_OR_PREV
-HA_READ_BEFORE_KEY
-HA_READ_AFTER_KEY
-HA_READ_KEY_OR_NEXT
-HA_READ_KEY_OR_PREV
</programlisting>
<para>
@@ -2272,13 +2272,13 @@
<section id="custom-engine-index-read-idx">
- <title>Implementing the <function>index_read_idx()</function> Function</title>
+ <title>Implementing the <function>index_read_idx()</function> Method</title>
<para>
The
<link
linkend="custom-engine-api-reference-index_read_idx"><function>index_read_idx()</function></link>
- function is identical to the
+ method is identical to the
<link
linkend="custom-engine-index-read"><function>index_read()</function></link>
with the exception that <function>index_read_idx()</function>
@@ -2297,7 +2297,7 @@
</para>
<para>
- As with the <function>index_read()</function> function, the
+ As with the <function>index_read()</function> method, the
storage engine must return the row that matches the key
according to the <literal>find_flag</literal> and set a cursor
for future reads.
@@ -2307,12 +2307,12 @@
<section id="custom-engine-index-next">
- <title>Implementing the <function>index_next()</function> Function</title>
+ <title>Implementing the <function>index_next()</function> Method</title>
<para>
The
<link linkend="custom-engine-api-reference-index_next"><function>index_next()</function></link>
- function is used for index scanning:
+ method is used for index scanning:
</para>
<programlisting>
@@ -2331,12 +2331,12 @@
<section id="custom-engine-index-prev">
- <title>Implementing the <function>index_prev()</function> Function</title>
+ <title>Implementing the <function>index_prev()</function> Method</title>
<para>
The
<link linkend="custom-engine-api-reference-index_prev"><function>index_prev()</function></link>
- function is used for reverse index scanning:
+ method is used for reverse index scanning:
</para>
<programlisting>
@@ -2355,12 +2355,12 @@
<section id="custom-engine-index-first">
- <title>Implementing the <function>index_first()</function> Function</title>
+ <title>Implementing the <function>index_first()</function> Method</title>
<para>
The
<link linkend="custom-engine-api-reference-index_first"><function>index_first()</function></link>
- function is used for index scanning:
+ method is used for index scanning:
</para>
<programlisting>
@@ -2376,12 +2376,12 @@
<section id="custom-engine-index-last">
- <title>Implementing the <function>index_last()</function> Function</title>
+ <title>Implementing the <function>index_last()</function> Method</title>
<para>
The
<link linkend="custom-engine-api-reference-index_last"><function>index_last()</function></link>
- function is used for reverse index scanning:
+ method is used for reverse index scanning:
</para>
<programlisting>
@@ -2424,7 +2424,7 @@
Transactions are not explicitly started on the storage engine
level, but are instead implicitly started through calls to
either <function>start_stmt()</function> or
- <function>external_lock()</function>. If the preceding functions
+ <function>external_lock()</function>. If the preceding methods
are called and a transaction already exists the transaction is
not replaced.
</para>
@@ -2445,8 +2445,8 @@
<para>
After work is completed, the MySQL server will call either the
- <function>commit()</function> function or the
- <function>rollback()</function> function defined in the storage
+ <function>commit()</function> method or the
+ <function>rollback()</function> method defined in the storage
engine's handlerton.
</para>
@@ -2459,7 +2459,7 @@
<para>
A transaction is started by the storage engine in response to a
call to either the <function>start_stmt()</function> or
- <function>external_lock()</function> functions.
+ <function>external_lock()</function> methods.
</para>
<para>
@@ -2474,9 +2474,9 @@
<title>Starting a Transaction from a <function>start_stmt()</function> Call</title>
<para>
- The first function call that can start a transaction is the
+ The first method call that can start a transaction is the
<link linkend="custom-engine-transactions-starting-start-stmt"><function>start_stmt()</function></link>
- function.
+ method.
</para>
<para>
@@ -2527,7 +2527,7 @@
<section id="custom-engine-transactions-starting-external_lock">
<title>Starting a Transaction from a <function>external_lock()</function>
- Function</title>
+ Method</title>
<para>
MySQL calls
@@ -2544,8 +2544,8 @@
<function>handler::external_lock()</function> is called for
all these tables. That is, if an <literal>INSERT</literal>
fires a trigger, which calls a stored procedure, that invokes
- a stored function, and so forth, all tables used in the
- trigger, stored procedure, function, etc., are locked in the
+ a stored method, and so forth, all tables used in the
+ trigger, stored procedure, method, etc., are locked in the
beginning of the <literal>INSERT</literal>. Additionally, if
there's a construct like
@@ -2626,7 +2626,7 @@
Every storage engine must call
<function>trans_register_ha()</function> every time it starts
a transaction. The <function>trans_register_ha()</function>
- function registers a transaction with the MySQL server to
+ method registers a transaction with the MySQL server to
allow for future <literal>COMMIT</literal> and
<literal>ROLLBACK</literal> calls.
</para>
@@ -2654,7 +2654,7 @@
</para>
<para>
- To support <literal>ROLLBACK</literal>, create a function that
+ To support <literal>ROLLBACK</literal>, create a method that
matches this definition:
</para>
@@ -2663,7 +2663,7 @@
</programlisting>
<para>
- The function name is then listed in the
+ The method name is then listed in the
<literal>rollback</literal> (thirteenth) entry of
<link linkend="custom-engine-handlerton">the handlerton</link>.
</para>
@@ -2697,7 +2697,7 @@
</para>
<para>
- To support <literal>COMMIT</literal>, create a function that
+ To support <literal>COMMIT</literal>, create a method that
matches this definition:
</para>
@@ -2706,7 +2706,7 @@
</programlisting>
<para>
- The function name is then listed in the
+ The method name is then listed in the
<literal>commit</literal> (twelfth) entry of
<link linkend="custom-engine-handlerton">the handlerton</link>.
</para>
@@ -2804,10 +2804,10 @@
<section id="custom-engine-savepoint-set">
- <title>Implementing the <function>savepoint_set</function> Function</title>
+ <title>Implementing the <function>savepoint_set</function> Method</title>
<para>
- The <function>savepoint_set()</function> function is called
+ The <function>savepoint_set()</function> method is called
whenever a user issues the <literal>SAVEPOINT</literal>
statement:
</para>
@@ -2834,10 +2834,10 @@
<section id="custom-engine-savepoint-rollback">
- <title>Implementing the <function>savepoint_rollback() Function</function></title>
+ <title>Implementing the <function>savepoint_rollback() Method</function></title>
<para>
- The <function>savepoint_rollback()</function> function is
+ The <function>savepoint_rollback()</function> method is
called whenever a user issues the <literal>ROLLBACK TO
SAVEPOINT</literal> statement:
</para>
@@ -2849,17 +2849,17 @@
<para>
The <literal>*sv</literal> parameter points to the storage
area that was previously passed to the
- <function>savepoint_set()</function> function.
+ <function>savepoint_set()</function> method.
</para>
</section>
<section id="custom-engine-savepoint-release">
- <title>Implementing the <function>savepoint_release() Function</function></title>
+ <title>Implementing the <function>savepoint_release()</function> Method</title>
<para>
- The <function>savepoint_release()</function> function is
+ The <function>savepoint_release()</function> method is
called whenever a user issues the <literal>RELEASE
SAVEPOINT</literal> statement:
</para>
@@ -2871,7 +2871,7 @@
<para>
The <literal>*sv</literal> parameter points to the storage
area that was previously passed to the
- <function>savepoint_set()</function> function.
+ <function>savepoint_set()</function> method.
</para>
</section>
@@ -3457,14 +3457,14 @@
By providing a list of extensions, storage engines can in many
cases omit the
<link linkend="custom-engine-api-reference-delete_table"><function>delete_table()</function></link>
- function as the MySQL server will close all references to the
+ method as the MySQL server will close all references to the
table and delete all files with the specified extension.
</para>
<bridgehead>Parameters</bridgehead>
<para>
- There are no parameters for this function.
+ There are no parameters for this method.
</para>
<bridgehead>Return Values</bridgehead>
@@ -4728,7 +4728,7 @@
</para>
<para>
- If the handler doesn't support this, then this function will
+ If the handler doesn't support this, then this method will
return <literal>HA_ERR_WRONG_COMMAND</literal> and MySQL will
delete the rows one by one.
</para>
@@ -4976,7 +4976,7 @@
<bridgehead>Usage</bridgehead>
<para>
- Most storage engines can omit implementing this function.
+ Most storage engines can omit implementing this method.
</para>
</section>
@@ -5857,7 +5857,7 @@
</para>
<para>
- The <quote>locking functions for mysql</quote> section in
+ The <quote>locking methods for mysql</quote> section in
<literal>lock.cc</literal> has additional comments on this topic
that may be useful to read.
</para>
@@ -9258,20 +9258,20 @@
<para>
This is the <function>index_end</function> method. Generally it
is used as a counterpart to the <function>index_init</function>
- function, cleaning up any resources allocated for index
+ method, cleaning up any resources allocated for index
scanning.
</para>
<bridgehead>Parameters</bridgehead>
<para>
- This function has no parameters.
+ This method has no parameters.
</para>
<bridgehead>Return Values</bridgehead>
<para>
- This function has no return values.
+ This method has no return values.
</para>
<bridgehead>Usage</bridgehead>
@@ -9505,7 +9505,7 @@
<para>
This is the <function>index_init</function> method. This
- function is called before an index scan, allowing the storage
+ method is called before an index scan, allowing the storage
engine to allocate resources and make preparations.
</para>
@@ -9542,7 +9542,7 @@
<bridgehead>Usage</bridgehead>
<para>
- This function can typically just return 0 if there is no
+ This method can typically just return 0 if there is no
preparation needed.
</para>
@@ -9614,7 +9614,7 @@
<bridgehead>Return Values</bridgehead>
<para>
- This function has no return values.
+ This method has no return values.
</para>
<bridgehead>Usage</bridgehead>
@@ -9684,7 +9684,7 @@
<bridgehead>Return Values</bridgehead>
<para>
- This function has no return values.
+ This method has no return values.
</para>
<bridgehead>Usage</bridgehead>
@@ -9755,7 +9755,7 @@
<bridgehead>Return Values</bridgehead>
<para>
- This function has no return values.
+ This method has no return values.
</para>
<bridgehead>Usage</bridgehead>
@@ -9867,7 +9867,7 @@
<bridgehead>Return Values</bridgehead>
<para>
- This function has no return values.
+ This method has no return values.
</para>
<bridgehead>Usage</bridgehead>
@@ -9965,7 +9965,7 @@
<bridgehead>Return Values</bridgehead>
<para>
- This function has no return values.
+ This method has no return values.
</para>
<bridgehead>Usage</bridgehead>
@@ -12014,7 +12014,7 @@
<bridgehead>Return Values</bridgehead>
<para>
- This function has no return values.
+ This method has no return values.
</para>
<bridgehead>Usage</bridgehead>
@@ -12194,7 +12194,7 @@
<bridgehead>Purpose</bridgehead>
<para>
- Print error that we got from handler function
+ Print error that we got from handler method
</para>
<bridgehead>Synopsis</bridgehead>
@@ -14058,7 +14058,7 @@
<bridgehead>Return Values</bridgehead>
<para>
- This function has no return values.
+ This method has no return values.
</para>
<bridgehead>Usage</bridgehead>
@@ -14505,7 +14505,7 @@
<bridgehead>Return Values</bridgehead>
<para>
- This function has no return values.
+ This method has no return values.
</para>
<bridgehead>Usage</bridgehead>
| Thread |
|---|
| • svn commit - mysqldoc@docsrva: r1977 - trunk/refman-5.1 | mcbrown | 1 May |
