Author: paul
Date: 2008-10-27 20:03:37 +0100 (Mon, 27 Oct 2008)
New Revision: 12169
Log:
r35016@frost: paul | 2008-10-27 14:04:58 -0500
Convert 4.1 manual from <function> -> <literal>
Modified:
trunk/refman-4.1/apis-c.xml
trunk/refman-4.1/apis-libmysqld.xml
trunk/refman-4.1/data-types.xml
trunk/refman-4.1/dba-core.xml
trunk/refman-4.1/errors-problems.xml
trunk/refman-4.1/extending-mysql.xml
trunk/refman-4.1/functions-core.xml
trunk/refman-4.1/installing.xml
trunk/refman-4.1/internationalization.xml
trunk/refman-4.1/introduction.xml
trunk/refman-4.1/language-structure.xml
trunk/refman-4.1/news-3.19.xml
trunk/refman-4.1/news-3.20.xml
trunk/refman-4.1/news-3.21.xml
trunk/refman-4.1/news-3.22.xml
trunk/refman-4.1/news-3.23.xml
trunk/refman-4.1/news-4.0.xml
trunk/refman-4.1/news-4.1-core.xml
trunk/refman-4.1/optimization.xml
trunk/refman-4.1/programs-client.xml
trunk/refman-4.1/replication.xml
trunk/refman-4.1/restrictions.xml
trunk/refman-4.1/spatial-extensions.xml
trunk/refman-4.1/sql-syntax-data-definition.xml
trunk/refman-4.1/sql-syntax-data-manipulation.xml
trunk/refman-4.1/sql-syntax-prepared-statements.xml
trunk/refman-4.1/sql-syntax-replication.xml
trunk/refman-4.1/sql-syntax-server-administration.xml
trunk/refman-4.1/sql-syntax-transactions.xml
trunk/refman-4.1/sql-syntax-utility.xml
trunk/refman-4.1/tutorial.xml
Property changes on: trunk
___________________________________________________________________
Name: svk:merge
- 4767c598-dc10-0410-bea0-d01b485662eb:/mysqldoc-local/mysqldoc/trunk:35828
7d8d2c4e-af1d-0410-ab9f-b038ce55645b:/mysqldoc-local/mysqldoc:35010
b5ec3a16-e900-0410-9ad2-d183a3acac99:/mysqldoc-local/mysqldoc/trunk:14218
bf112a9c-6c03-0410-a055-ad865cd57414:/mysqldoc-local/mysqldoc/trunk:33695
+ 4767c598-dc10-0410-bea0-d01b485662eb:/mysqldoc-local/mysqldoc/trunk:35828
7d8d2c4e-af1d-0410-ab9f-b038ce55645b:/mysqldoc-local/mysqldoc:35016
b5ec3a16-e900-0410-9ad2-d183a3acac99:/mysqldoc-local/mysqldoc/trunk:14218
bf112a9c-6c03-0410-a055-ad865cd57414:/mysqldoc-local/mysqldoc/trunk:33695
Modified: trunk/refman-4.1/apis-c.xml
===================================================================
--- trunk/refman-4.1/apis-c.xml 2008-10-27 18:50:56 UTC (rev 12168)
+++ trunk/refman-4.1/apis-c.xml 2008-10-27 19:03:37 UTC (rev 12169)
Changed blocks: 364, Lines Added: 945, Lines Deleted: 945; 250218 bytes
@@ -160,7 +160,7 @@
(You cannot treat these as null-terminated strings if field
values may contain binary data, because such values may
contain null bytes internally.) Rows are obtained by calling
- <function role="capi">mysql_fetch_row()</function>.
+ <literal role="cfunc">mysql_fetch_row()</literal>.
</para>
</listitem>
@@ -178,7 +178,7 @@
field's name, type, and size. Its members are described in
more detail here. You may obtain the
<literal>MYSQL_FIELD</literal> structures for each field by
- calling <function role="capi">mysql_fetch_field()</function>
+ calling <literal role="cfunc">mysql_fetch_field()</literal>
repeatedly. Field values are not part of this structure; they
are contained in a <literal>MYSQL_ROW</literal> structure.
</para>
@@ -196,7 +196,7 @@
<para>
This is a type-safe representation of an offset into a MySQL
field list. (Used by
- <function role="capi">mysql_field_seek()</function>.) Offsets
+ <literal role="cfunc">mysql_field_seek()</literal>.) Offsets
are field numbers within a row, beginning at zero.
</para>
</listitem>
@@ -217,9 +217,9 @@
<para>
The type used for the number of rows and for
- <function role="capi">mysql_affected_rows()</function>,
- <function role="capi">mysql_num_rows()</function>, and
- <function role="capi">mysql_insert_id()</function>. This type
+ <literal role="cfunc">mysql_affected_rows()</literal>,
+ <literal role="cfunc">mysql_num_rows()</literal>, and
+ <literal role="cfunc">mysql_insert_id()</literal>. This type
provides a range of <literal>0</literal> to
<literal>1.84e19</literal>.
</para>
@@ -352,7 +352,7 @@
<para>
The default value of this field, as a null-terminated string.
This is set only if you use
- <function role="capi">mysql_list_fields()</function>.
+ <literal role="cfunc">mysql_list_fields()</literal>.
</para>
</listitem>
@@ -376,10 +376,10 @@
The maximum width of the field for the result set (the length
in bytes of the longest field value for the rows actually in
the result set). If you use
- <function role="capi">mysql_store_result()</function> or
- <function role="capi">mysql_list_fields()</function>, this
+ <literal role="cfunc">mysql_store_result()</literal> or
+ <literal role="cfunc">mysql_list_fields()</literal>, this
contains the maximum length for the field. If you use
- <function role="capi">mysql_use_result()</function>, the value
+ <literal role="cfunc">mysql_use_result()</literal>, the value
of this variable is zero.
</para>
@@ -400,9 +400,9 @@
<xref linkend="c-api-prepared-statement-datatypes"/>.) If you
want the <literal>max_length</literal> values anyway, enable
the <literal>STMT_ATTR_UPDATE_MAX_LENGTH</literal> option with
- <function role="capi">mysql_stmt_attr_set()</function> and the
+ <literal role="cfunc">mysql_stmt_attr_set()</literal> and the
lengths will be set when you call
- <function role="capi">mysql_stmt_store_result()</function>.
+ <literal role="cfunc">mysql_stmt_store_result()</literal>.
(See <xref linkend="mysql-stmt-attr-set"/>, and
<xref linkend="mysql-stmt-store-result"/>.)
</para>
@@ -845,327 +845,327 @@
<entry><emphasis role="bold">Description</emphasis></entry>
</row>
<row>
- <entry><function role="capi">my_init()</function></entry>
+ <entry><literal role="cfunc">my_init()</literal></entry>
<entry>Initialize global variables, and thread handler in thread-safe programs</entry>
</row>
<row>
- <entry><function role="capi">mysql_affected_rows()</function></entry>
+ <entry><literal role="cfunc">mysql_affected_rows()</literal></entry>
<entry>Returns the number of rows changed/deleted/inserted by the last
<literal>UPDATE</literal>, <literal>DELETE</literal>, or
<literal>INSERT</literal> query</entry>
</row>
<row>
- <entry><function role="capi">mysql_autocommit()</function></entry>
+ <entry><literal role="cfunc">mysql_autocommit()</literal></entry>
<entry>Toggles autocommit mode on/off</entry>
</row>
<row>
- <entry><function role="capi">mysql_change_user()</function></entry>
+ <entry><literal role="cfunc">mysql_change_user()</literal></entry>
<entry>Changes user and database on an open connection</entry>
</row>
<row>
- <entry><function role="capi">mysql_character_set_name()</function></entry>
+ <entry><literal role="cfunc">mysql_character_set_name()</literal></entry>
<entry>Return default character set name for current connection</entry>
</row>
<row>
- <entry><function role="capi">mysql_close()</function></entry>
+ <entry><literal role="cfunc">mysql_close()</literal></entry>
<entry>Closes a server connection</entry>
</row>
<row>
- <entry><function role="capi">mysql_commit()</function></entry>
+ <entry><literal role="cfunc">mysql_commit()</literal></entry>
<entry>Commits the transaction</entry>
</row>
<row>
- <entry><function role="capi">mysql_connect()</function></entry>
+ <entry><literal role="cfunc">mysql_connect()</literal></entry>
<entry>Connects to a MySQL server (this function is deprecated; use
- <function role="capi">mysql_real_connect()</function>
+ <literal role="cfunc">mysql_real_connect()</literal>
instead)</entry>
</row>
<row>
- <entry><function role="capi">mysql_create_db()</function></entry>
+ <entry><literal role="cfunc">mysql_create_db()</literal></entry>
<entry>Creates a database (this function is deprecated; use the SQL statement
<literal>CREATE DATABASE</literal> instead)</entry>
</row>
<row>
- <entry><function role="capi">mysql_data_seek()</function></entry>
+ <entry><literal role="cfunc">mysql_data_seek()</literal></entry>
<entry>Seeks to an arbitrary row number in a query result set</entry>
</row>
<row>
- <entry><function role="capi">mysql_debug()</function></entry>
+ <entry><literal role="cfunc">mysql_debug()</literal></entry>
<entry>Does a <literal>DBUG_PUSH</literal> with the given string</entry>
</row>
<row>
- <entry><function role="capi">mysql_drop_db()</function></entry>
+ <entry><literal role="cfunc">mysql_drop_db()</literal></entry>
<entry>Drops a database (this function is deprecated; use the SQL statement
<literal>DROP DATABASE</literal> instead)</entry>
</row>
<row>
- <entry><function role="capi">mysql_dump_debug_info()</function></entry>
+ <entry><literal role="cfunc">mysql_dump_debug_info()</literal></entry>
<entry>Makes the server write debug information to the log</entry>
</row>
<row>
- <entry><function role="capi">mysql_eof()</function></entry>
+ <entry><literal role="cfunc">mysql_eof()</literal></entry>
<entry>Determines whether the last row of a result set has been read (this
function is deprecated;
- <function role="capi">mysql_errno()</function> or
- <function role="capi">mysql_error()</function> may be used
+ <literal role="cfunc">mysql_errno()</literal> or
+ <literal role="cfunc">mysql_error()</literal> may be used
instead)</entry>
</row>
<row>
- <entry><function role="capi">mysql_errno()</function></entry>
+ <entry><literal role="cfunc">mysql_errno()</literal></entry>
<entry>Returns the error number for the most recently invoked MySQL function</entry>
</row>
<row>
- <entry><function role="capi">mysql_error()</function></entry>
+ <entry><literal role="cfunc">mysql_error()</literal></entry>
<entry>Returns the error message for the most recently invoked MySQL function</entry>
</row>
<row>
- <entry><function role="capi">mysql_escape_string()</function></entry>
+ <entry><literal role="cfunc">mysql_escape_string()</literal></entry>
<entry>Escapes special characters in a string for use in an SQL statement</entry>
</row>
<row>
- <entry><function role="capi">mysql_fetch_field()</function></entry>
+ <entry><literal role="cfunc">mysql_fetch_field()</literal></entry>
<entry>Returns the type of the next table field</entry>
</row>
<row>
- <entry><function role="capi">mysql_fetch_field_direct()</function></entry>
+ <entry><literal role="cfunc">mysql_fetch_field_direct()</literal></entry>
<entry>Returns the type of a table field, given a field number</entry>
</row>
<row>
- <entry><function role="capi">mysql_fetch_fields()</function></entry>
+ <entry><literal role="cfunc">mysql_fetch_fields()</literal></entry>
<entry>Returns an array of all field structures</entry>
</row>
<row>
- <entry><function role="capi">mysql_fetch_lengths()</function></entry>
+ <entry><literal role="cfunc">mysql_fetch_lengths()</literal></entry>
<entry>Returns the lengths of all columns in the current row</entry>
</row>
<row>
- <entry><function role="capi">mysql_fetch_row()</function></entry>
+ <entry><literal role="cfunc">mysql_fetch_row()</literal></entry>
<entry>Fetches the next row from the result set</entry>
</row>
<row>
- <entry><function role="capi">mysql_field_count()</function></entry>
+ <entry><literal role="cfunc">mysql_field_count()</literal></entry>
<entry>Returns the number of result columns for the most recent statement</entry>
</row>
<row>
- <entry><function role="capi">mysql_field_seek()</function></entry>
+ <entry><literal role="cfunc">mysql_field_seek()</literal></entry>
<entry>Puts the column cursor on a specified column</entry>
</row>
<row>
- <entry><function role="capi">mysql_field_tell()</function></entry>
+ <entry><literal role="cfunc">mysql_field_tell()</literal></entry>
<entry>Returns the position of the field cursor used for the last
- <function role="capi">mysql_fetch_field()</function></entry>
+ <literal role="cfunc">mysql_fetch_field()</literal></entry>
</row>
<row>
- <entry><function role="capi">mysql_free_result()</function></entry>
+ <entry><literal role="cfunc">mysql_free_result()</literal></entry>
<entry>Frees memory used by a result set</entry>
</row>
<row>
- <entry><function role="capi">mysql_get_client_info()</function></entry>
+ <entry><literal role="cfunc">mysql_get_client_info()</literal></entry>
<entry>Returns client version information as a string</entry>
</row>
<row>
- <entry><function role="capi">mysql_get_client_version()</function></entry>
+ <entry><literal role="cfunc">mysql_get_client_version()</literal></entry>
<entry>Returns client version information as an integer</entry>
</row>
<row>
- <entry><function role="capi">mysql_get_host_info()</function></entry>
+ <entry><literal role="cfunc">mysql_get_host_info()</literal></entry>
<entry>Returns a string describing the connection</entry>
</row>
<row>
- <entry><function role="capi">mysql_get_proto_info()</function></entry>
+ <entry><literal role="cfunc">mysql_get_proto_info()</literal></entry>
<entry>Returns the protocol version used by the connection</entry>
</row>
<row>
- <entry><function role="capi">mysql_get_server_info()</function></entry>
+ <entry><literal role="cfunc">mysql_get_server_info()</literal></entry>
<entry>Returns the server version number</entry>
</row>
<row>
- <entry><function role="capi">mysql_get_server_version()</function></entry>
+ <entry><literal role="cfunc">mysql_get_server_version()</literal></entry>
<entry>Returns version number of server as an integer</entry>
</row>
<row>
- <entry><function role="capi">mysql_hex_string()</function></entry>
+ <entry><literal role="cfunc">mysql_hex_string()</literal></entry>
<entry>Encode string in hexadecimal format</entry>
</row>
<row>
- <entry><function role="capi">mysql_info()</function></entry>
+ <entry><literal role="cfunc">mysql_info()</literal></entry>
<entry>Returns information about the most recently executed query</entry>
</row>
<row>
- <entry><function role="capi">mysql_init()</function></entry>
+ <entry><literal role="cfunc">mysql_init()</literal></entry>
<entry>Gets or initializes a <literal>MYSQL</literal> structure</entry>
</row>
<row>
- <entry><function role="capi">mysql_insert_id()</function></entry>
+ <entry><literal role="cfunc">mysql_insert_id()</literal></entry>
<entry>Returns the ID generated for an <literal>AUTO_INCREMENT</literal> column
by the previous query</entry>
</row>
<row>
- <entry><function role="capi">mysql_kill()</function></entry>
+ <entry><literal role="cfunc">mysql_kill()</literal></entry>
<entry>Kills a given thread</entry>
</row>
<row>
- <entry><function role="capi">mysql_library_end()</function></entry>
+ <entry><literal role="cfunc">mysql_library_end()</literal></entry>
<entry>Finalize the MySQL C API library</entry>
</row>
<row>
- <entry><function role="capi">mysql_library_init()</function></entry>
+ <entry><literal role="cfunc">mysql_library_init()</literal></entry>
<entry>Initialize the MySQL C API library</entry>
</row>
<row>
- <entry><function role="capi">mysql_list_dbs()</function></entry>
+ <entry><literal role="cfunc">mysql_list_dbs()</literal></entry>
<entry>Returns database names matching a simple regular expression</entry>
</row>
<row>
- <entry><function role="capi">mysql_list_fields()</function></entry>
+ <entry><literal role="cfunc">mysql_list_fields()</literal></entry>
<entry>Returns field names matching a simple regular expression</entry>
</row>
<row>
- <entry><function role="capi">mysql_list_processes()</function></entry>
+ <entry><literal role="cfunc">mysql_list_processes()</literal></entry>
<entry>Returns a list of the current server threads</entry>
</row>
<row>
- <entry><function role="capi">mysql_list_tables()</function></entry>
+ <entry><literal role="cfunc">mysql_list_tables()</literal></entry>
<entry>Returns table names matching a simple regular expression</entry>
</row>
<row>
- <entry><function role="capi">mysql_more_results()</function></entry>
+ <entry><literal role="cfunc">mysql_more_results()</literal></entry>
<entry>Checks whether any more results exist</entry>
</row>
<row>
- <entry><function role="capi">mysql_next_result()</function></entry>
+ <entry><literal role="cfunc">mysql_next_result()</literal></entry>
<entry>Returns/initiates the next result in multiple-statement executions</entry>
</row>
<row>
- <entry><function role="capi">mysql_num_fields()</function></entry>
+ <entry><literal role="cfunc">mysql_num_fields()</literal></entry>
<entry>Returns the number of columns in a result set</entry>
</row>
<row>
- <entry><function role="capi">mysql_num_rows()</function></entry>
+ <entry><literal role="cfunc">mysql_num_rows()</literal></entry>
<entry>Returns the number of rows in a result set</entry>
</row>
<row>
- <entry><function role="capi">mysql_options()</function></entry>
+ <entry><literal role="cfunc">mysql_options()</literal></entry>
<entry>Sets connect options for
- <function role="capi">mysql_real_connect()</function></entry>
+ <literal role="cfunc">mysql_real_connect()</literal></entry>
</row>
<row>
- <entry><function role="capi">mysql_ping()</function></entry>
+ <entry><literal role="cfunc">mysql_ping()</literal></entry>
<entry>Checks whether the connection to the server is working, reconnecting as
necessary</entry>
</row>
<row>
- <entry><function role="capi">mysql_query()</function></entry>
+ <entry><literal role="cfunc">mysql_query()</literal></entry>
<entry>Executes an SQL query specified as a null-terminated string</entry>
</row>
<row>
- <entry><function role="capi">mysql_real_connect()</function></entry>
+ <entry><literal role="cfunc">mysql_real_connect()</literal></entry>
<entry>Connects to a MySQL server</entry>
</row>
<row>
- <entry><function role="capi">mysql_real_escape_string()</function></entry>
+ <entry><literal role="cfunc">mysql_real_escape_string()</literal></entry>
<entry>Escapes special characters in a string for use in an SQL statement,
taking into account the current character set of the
connection</entry>
</row>
<row>
- <entry><function role="capi">mysql_real_query()</function></entry>
+ <entry><literal role="cfunc">mysql_real_query()</literal></entry>
<entry>Executes an SQL query specified as a counted string</entry>
</row>
<row>
- <entry><function role="capi">mysql_refresh()</function></entry>
+ <entry><literal role="cfunc">mysql_refresh()</literal></entry>
<entry>Flush or reset tables and caches</entry>
</row>
<row>
- <entry><function role="capi">mysql_reload()</function></entry>
+ <entry><literal role="cfunc">mysql_reload()</literal></entry>
<entry>Tells the server to reload the grant tables</entry>
</row>
<row>
- <entry><function role="capi">mysql_rollback()</function></entry>
+ <entry><literal role="cfunc">mysql_rollback()</literal></entry>
<entry>Rolls back the transaction</entry>
</row>
<row>
- <entry><function role="capi">mysql_row_seek()</function></entry>
+ <entry><literal role="cfunc">mysql_row_seek()</literal></entry>
<entry>Seeks to a row offset in a result set, using value returned from
- <function role="capi">mysql_row_tell()</function></entry>
+ <literal role="cfunc">mysql_row_tell()</literal></entry>
</row>
<row>
- <entry><function role="capi">mysql_row_tell()</function></entry>
+ <entry><literal role="cfunc">mysql_row_tell()</literal></entry>
<entry>Returns the row cursor position</entry>
</row>
<row>
- <entry><function role="capi">mysql_select_db()</function></entry>
+ <entry><literal role="cfunc">mysql_select_db()</literal></entry>
<entry>Selects a database</entry>
</row>
<row>
- <entry><function role="capi">mysql_server_end()</function></entry>
+ <entry><literal role="cfunc">mysql_server_end()</literal></entry>
<entry>Finalize the MySQL C API library</entry>
</row>
<row>
- <entry><function role="capi">mysql_server_init()</function></entry>
+ <entry><literal role="cfunc">mysql_server_init()</literal></entry>
<entry>Initialize the MySQL C API library</entry>
</row>
<row>
- <entry><function role="capi">mysql_set_character_set()</function></entry>
+ <entry><literal role="cfunc">mysql_set_character_set()</literal></entry>
<entry>Set default character set for current connection</entry>
</row>
<row>
- <entry><function role="capi">mysql_set_local_infile_default()</function></entry>
+ <entry><literal role="cfunc">mysql_set_local_infile_default()</literal></entry>
<entry>Set the <literal>LOAD DATA LOCAL INFILE</literal> handler callbacks to
their default values</entry>
</row>
<row>
- <entry><function role="capi">mysql_set_local_infile_handler()</function></entry>
+ <entry><literal role="cfunc">mysql_set_local_infile_handler()</literal></entry>
<entry>Install application-specific <literal>LOAD DATA LOCAL INFILE</literal>
handler callbacks</entry>
</row>
<row>
- <entry><function role="capi">mysql_set_server_option()</function></entry>
+ <entry><literal role="cfunc">mysql_set_server_option()</literal></entry>
<entry>Sets an option for the connection (like
<literal>multi-statements</literal>)</entry>
</row>
<row>
- <entry><function role="capi">mysql_sqlstate()</function></entry>
+ <entry><literal role="cfunc">mysql_sqlstate()</literal></entry>
<entry>Returns the SQLSTATE error code for the last error</entry>
</row>
<row>
- <entry><function role="capi">mysql_shutdown()</function></entry>
+ <entry><literal role="cfunc">mysql_shutdown()</literal></entry>
<entry>Shuts down the database server</entry>
</row>
<row>
- <entry><function role="capi">mysql_ssl_set()</function></entry>
+ <entry><literal role="cfunc">mysql_ssl_set()</literal></entry>
<entry>Prepare to establish SSL connection to server</entry>
</row>
<row>
- <entry><function role="capi">mysql_stat()</function></entry>
+ <entry><literal role="cfunc">mysql_stat()</literal></entry>
<entry>Returns the server status as a string</entry>
</row>
<row>
- <entry><function role="capi">mysql_store_result()</function></entry>
+ <entry><literal role="cfunc">mysql_store_result()</literal></entry>
<entry>Retrieves a complete result set to the client</entry>
</row>
<row>
- <entry><function role="capi">mysql_thread_end()</function></entry>
+ <entry><literal role="cfunc">mysql_thread_end()</literal></entry>
<entry>Finalize thread handler</entry>
</row>
<row>
- <entry><function role="capi">mysql_thread_id()</function></entry>
+ <entry><literal role="cfunc">mysql_thread_id()</literal></entry>
<entry>Returns the current thread ID</entry>
</row>
<row>
- <entry><function role="capi">mysql_thread_init()</function></entry>
+ <entry><literal role="cfunc">mysql_thread_init()</literal></entry>
<entry>Initialize thread handler</entry>
</row>
<row>
- <entry><function role="capi">mysql_thread_safe()</function></entry>
+ <entry><literal role="cfunc">mysql_thread_safe()</literal></entry>
<entry>Returns 1 if the clients are compiled as thread-safe</entry>
</row>
<row>
- <entry><function role="capi">mysql_use_result()</function></entry>
+ <entry><literal role="cfunc">mysql_use_result()</literal></entry>
<entry>Initiates a row-by-row result set retrieval</entry>
</row>
<row>
- <entry><function role="capi">mysql_warning_count()</function></entry>
+ <entry><literal role="cfunc">mysql_warning_count()</literal></entry>
<entry>Returns the warning count for the previous SQL statement</entry>
</row>
</tbody>
@@ -1182,7 +1182,7 @@
<listitem>
<para>
Initialize the MySQL library by calling
- <function role="capi">mysql_library_init()</function>. This
+ <literal role="cfunc">mysql_library_init()</literal>. This
function exists in both the <literal>mysqlclient</literal> C
client library and the <literal>mysqld</literal> embedded
server library, so it is used whether you build a regular
@@ -1196,9 +1196,9 @@
<listitem>
<para>
Initialize a connection handler by calling
- <function role="capi">mysql_init()</function> and connect to
+ <literal role="cfunc">mysql_init()</literal> and connect to
the server by calling
- <function role="capi">mysql_real_connect()</function>.
+ <literal role="cfunc">mysql_real_connect()</literal>.
</para>
</listitem>
@@ -1212,14 +1212,14 @@
<listitem>
<para>
Close the connection to the MySQL server by calling
- <function role="capi">mysql_close()</function>.
+ <literal role="cfunc">mysql_close()</literal>.
</para>
</listitem>
<listitem>
<para>
End use of the MySQL library by calling
- <function role="capi">mysql_library_end()</function>.
+ <literal role="cfunc">mysql_library_end()</literal>.
</para>
</listitem>
@@ -1227,12 +1227,12 @@
<para>
The purpose of calling
- <function role="capi">mysql_library_init()</function> and
- <function role="capi">mysql_library_end()</function> is to provide
+ <literal role="cfunc">mysql_library_init()</literal> and
+ <literal role="cfunc">mysql_library_end()</literal> is to provide
proper initialization and finalization of the MySQL library. For
applications that are linked with the client library, they provide
improved memory management. If you don't call
- <function role="capi">mysql_library_end()</function>, a block of
+ <literal role="cfunc">mysql_library_end()</literal>, a block of
memory remains allocated. (This does not increase the amount of
memory used by the application, but some memory leak detectors
will complain about it.) For applications that are linked with the
@@ -1240,58 +1240,58 @@
</para>
<para>
- <function role="capi">mysql_library_init()</function> and
- <function role="capi">mysql_library_end()</function> are available
+ <literal role="cfunc">mysql_library_init()</literal> and
+ <literal role="cfunc">mysql_library_end()</literal> are available
as of MySQL 4.1.10. For older versions of MySQL, you can call
- <function role="capi">mysql_server_init()</function> and
- <function role="capi">mysql_server_end()</function> instead.
+ <literal role="cfunc">mysql_server_init()</literal> and
+ <literal role="cfunc">mysql_server_end()</literal> instead.
</para>
<para>
In a non-multi-threaded environment, the call to
- <function role="capi">mysql_library_init()</function> may be
- omitted, because <function role="capi">mysql_init()</function>
+ <literal role="cfunc">mysql_library_init()</literal> may be
+ omitted, because <literal role="cfunc">mysql_init()</literal>
will invoke it automatically as necessary. However,
- <function role="capi">mysql_library_init()</function> is not
+ <literal role="cfunc">mysql_library_init()</literal> is not
thread-safe in a multi-threaded environment, and thus neither is
- <function role="capi">mysql_init()</function>, which calls
- <function role="capi">mysql_library_init()</function>. You must
- either call <function role="capi">mysql_library_init()</function>
+ <literal role="cfunc">mysql_init()</literal>, which calls
+ <literal role="cfunc">mysql_library_init()</literal>. You must
+ either call <literal role="cfunc">mysql_library_init()</literal>
prior to spawning any threads, or else use a mutex to protect the
call, whether you invoke
- <function role="capi">mysql_library_init()</function> or
- indirectly via <function role="capi">mysql_init()</function>. This
+ <literal role="cfunc">mysql_library_init()</literal> or
+ indirectly via <literal role="cfunc">mysql_init()</literal>. This
should be done prior to any other client library call.
</para>
<para>
To connect to the server, call
- <function role="capi">mysql_init()</function> to initialize a
+ <literal role="cfunc">mysql_init()</literal> to initialize a
connection handler, then call
- <function role="capi">mysql_real_connect()</function> with that
+ <literal role="cfunc">mysql_real_connect()</literal> with that
handler (along with other information such as the hostname,
username, and password). Upon connection,
- <function role="capi">mysql_real_connect()</function> sets the
+ <literal role="cfunc">mysql_real_connect()</literal> sets the
<literal>reconnect</literal> flag (part of the
<literal>MYSQL</literal> structure) to a value of
<literal>1</literal>. A value of <literal>1</literal> for this
flag indicates that if a statement cannot be performed because of
a lost connection, to try reconnecting to the server before giving
up. When you are done with the connection, call
- <function role="capi">mysql_close()</function> to terminate it.
+ <literal role="cfunc">mysql_close()</literal> to terminate it.
</para>
<para>
While a connection is active, the client may send SQL statements
- to the server using <function role="capi">mysql_query()</function>
- or <function role="capi">mysql_real_query()</function>. The
+ to the server using <literal role="cfunc">mysql_query()</literal>
+ or <literal role="cfunc">mysql_real_query()</literal>. The
difference between the two is that
- <function role="capi">mysql_query()</function> expects the query
+ <literal role="cfunc">mysql_query()</literal> expects the query
to be specified as a null-terminated string whereas
- <function role="capi">mysql_real_query()</function> expects a
+ <literal role="cfunc">mysql_real_query()</literal> expects a
counted string. If the string contains binary data (which may
include null bytes), you must use
- <function role="capi">mysql_real_query()</function>.
+ <literal role="cfunc">mysql_real_query()</literal>.
</para>
<para>
@@ -1299,7 +1299,7 @@
<literal>INSERT</literal>, <literal>UPDATE</literal>,
<literal>DELETE</literal>), you can find out how many rows were
changed (affected) by calling
- <function role="capi">mysql_affected_rows()</function>.
+ <literal role="cfunc">mysql_affected_rows()</literal>.
</para>
<para>
@@ -1314,31 +1314,31 @@
<para>
There are two ways for a client to process result sets. One way is
to retrieve the entire result set all at once by calling
- <function role="capi">mysql_store_result()</function>. This
+ <literal role="cfunc">mysql_store_result()</literal>. This
function acquires from the server all the rows returned by the
query and stores them in the client. The second way is for the
client to initiate a row-by-row result set retrieval by calling
- <function role="capi">mysql_use_result()</function>. This function
+ <literal role="cfunc">mysql_use_result()</literal>. This function
initializes the retrieval, but does not actually get any rows from
the server.
</para>
<para>
In both cases, you access rows by calling
- <function role="capi">mysql_fetch_row()</function>. With
- <function role="capi">mysql_store_result()</function>,
- <function role="capi">mysql_fetch_row()</function> accesses rows
+ <literal role="cfunc">mysql_fetch_row()</literal>. With
+ <literal role="cfunc">mysql_store_result()</literal>,
+ <literal role="cfunc">mysql_fetch_row()</literal> accesses rows
that have previously been fetched from the server. With
- <function role="capi">mysql_use_result()</function>,
- <function role="capi">mysql_fetch_row()</function> actually
+ <literal role="cfunc">mysql_use_result()</literal>,
+ <literal role="cfunc">mysql_fetch_row()</literal> actually
retrieves the row from the server. Information about the size of
the data in each row is available by calling
- <function role="capi">mysql_fetch_lengths()</function>.
+ <literal role="cfunc">mysql_fetch_lengths()</literal>.
</para>
<para>
After you are done with a result set, call
- <function role="capi">mysql_free_result()</function> to free the
+ <literal role="cfunc">mysql_free_result()</literal> to free the
memory used for it.
</para>
@@ -1346,34 +1346,34 @@
The two retrieval mechanisms are complementary. Client programs
should choose the approach that is most appropriate for their
requirements. In practice, clients tend to use
- <function role="capi">mysql_store_result()</function> more
+ <literal role="cfunc">mysql_store_result()</literal> more
commonly.
</para>
<para>
An advantage of
- <function role="capi">mysql_store_result()</function> is that
+ <literal role="cfunc">mysql_store_result()</literal> is that
because the rows have all been fetched to the client, you not only
can access rows sequentially, you can move back and forth in the
result set using
- <function role="capi">mysql_data_seek()</function> or
- <function role="capi">mysql_row_seek()</function> to change the
+ <literal role="cfunc">mysql_data_seek()</literal> or
+ <literal role="cfunc">mysql_row_seek()</literal> to change the
current row position within the result set. You can also find out
how many rows there are by calling
- <function role="capi">mysql_num_rows()</function>. On the other
+ <literal role="cfunc">mysql_num_rows()</literal>. On the other
hand, the memory requirements for
- <function role="capi">mysql_store_result()</function> may be very
+ <literal role="cfunc">mysql_store_result()</literal> may be very
high for large result sets and you are more likely to encounter
out-of-memory conditions.
</para>
<para>
An advantage of
- <function role="capi">mysql_use_result()</function> is that the
+ <literal role="cfunc">mysql_use_result()</literal> is that the
client requires less memory for the result set because it
maintains only one row at a time (and because there is less
allocation overhead,
- <function role="capi">mysql_use_result()</function> can be
+ <literal role="cfunc">mysql_use_result()</literal> can be
faster). Disadvantages are that you must process each row quickly
to avoid tying up the server, you don't have random access to rows
within the result set (you can only access rows sequentially), and
@@ -1389,49 +1389,49 @@
statements (retrieving rows only as necessary) without knowing
whether the statement is a <literal>SELECT</literal>. You can do
this by calling
- <function role="capi">mysql_store_result()</function> after each
- <function role="capi">mysql_query()</function> (or
- <function role="capi">mysql_real_query()</function>). If the
+ <literal role="cfunc">mysql_store_result()</literal> after each
+ <literal role="cfunc">mysql_query()</literal> (or
+ <literal role="cfunc">mysql_real_query()</literal>). If the
result set call succeeds, the statement was a
<literal>SELECT</literal> and you can read the rows. If the result
set call fails, call
- <function role="capi">mysql_field_count()</function> to determine
+ <literal role="cfunc">mysql_field_count()</literal> to determine
whether a result was actually to be expected. If
- <function role="capi">mysql_field_count()</function> returns zero,
+ <literal role="cfunc">mysql_field_count()</literal> returns zero,
the statement returned no data (indicating that it was an
<literal>INSERT</literal>, <literal>UPDATE</literal>,
<literal>DELETE</literal>, and so forth), and was not expected to
return rows. If
- <function role="capi">mysql_field_count()</function> is non-zero,
+ <literal role="cfunc">mysql_field_count()</literal> is non-zero,
the statement should have returned rows, but didn't. This
indicates that the statement was a <literal>SELECT</literal> that
failed. See the description for
- <function role="capi">mysql_field_count()</function> for an
+ <literal role="cfunc">mysql_field_count()</literal> for an
example of how this can be done.
</para>
<para>
- Both <function role="capi">mysql_store_result()</function> and
- <function role="capi">mysql_use_result()</function> allow you to
+ Both <literal role="cfunc">mysql_store_result()</literal> and
+ <literal role="cfunc">mysql_use_result()</literal> allow you to
obtain information about the fields that make up the result set
(the number of fields, their names and types, and so forth). You
can access field information sequentially within the row by
- calling <function role="capi">mysql_fetch_field()</function>
+ calling <literal role="cfunc">mysql_fetch_field()</literal>
repeatedly, or by field number within the row by calling
- <function role="capi">mysql_fetch_field_direct()</function>. The
+ <literal role="cfunc">mysql_fetch_field_direct()</literal>. The
current field cursor position may be changed by calling
- <function role="capi">mysql_field_seek()</function>. Setting the
+ <literal role="cfunc">mysql_field_seek()</literal>. Setting the
field cursor affects subsequent calls to
- <function role="capi">mysql_fetch_field()</function>. You can also
+ <literal role="cfunc">mysql_fetch_field()</literal>. You can also
get information for fields all at once by calling
- <function role="capi">mysql_fetch_fields()</function>.
+ <literal role="cfunc">mysql_fetch_fields()</literal>.
</para>
<para>
For detecting and reporting errors, MySQL provides access to error
information by means of the
- <function role="capi">mysql_errno()</function> and
- <function role="capi">mysql_error()</function> functions. These
+ <literal role="cfunc">mysql_errno()</literal> and
+ <literal role="cfunc">mysql_error()</literal> functions. These
return the error code or error message for the most recently
invoked function that can succeed or fail, allowing you to
determine when an error occurred and what it was.
@@ -1477,9 +1477,9 @@
<emphasis role="bold">Errors</emphasis> subsection of the function
description lists the possible types of errors. You can find out
which of these occurred by calling
- <function role="capi">mysql_errno()</function>. A string
+ <literal role="cfunc">mysql_errno()</literal>. A string
representation of the error may be obtained by calling
- <function role="capi">mysql_error()</function>.
+ <literal role="cfunc">mysql_error()</literal>.
</para>
<formalpara role="mnmas-kb">
@@ -1500,7 +1500,7 @@
<section id="mysql-affected-rows">
- <title><function role="capi">mysql_affected_rows()</function></title>
+ <title><literal role="cfunc">mysql_affected_rows()</literal></title>
<indexterm>
<primary>mysql_affected_rows()</primary>
@@ -1517,14 +1517,14 @@
<para>
After executing a statement with
- <function role="capi">mysql_query()</function> or
- <function role="capi">mysql_real_query()</function>, returns the
+ <literal role="cfunc">mysql_query()</literal> or
+ <literal role="cfunc">mysql_real_query()</literal>, returns the
number of rows changed (for <literal>UPDATE</literal>), deleted
(for <literal>DELETE</literal>), or inserted (for
<literal>INSERT</literal>). For <literal>SELECT</literal>
statements,
- <function role="capi">mysql_affected_rows()</function> works
- like <function role="capi">mysql_num_rows()</function>.
+ <literal role="cfunc">mysql_affected_rows()</literal> works
+ like <literal role="cfunc">mysql_num_rows()</literal>.
</para>
<para>
@@ -1538,10 +1538,10 @@
matched the <literal>WHERE</literal> clause in the query or that
no query has yet been executed. -1 indicates that the query
returned an error or that, for a <literal>SELECT</literal>
- query, <function role="capi">mysql_affected_rows()</function>
+ query, <literal role="cfunc">mysql_affected_rows()</literal>
was called prior to calling
- <function role="capi">mysql_store_result()</function>. Because
- <function role="capi">mysql_affected_rows()</function> returns
+ <literal role="cfunc">mysql_store_result()</literal>. Because
+ <literal role="cfunc">mysql_affected_rows()</literal> returns
an unsigned value, you can check for -1 by comparing the return
value to <literal>(my_ulonglong)-1</literal> (or to
<literal>(my_ulonglong)~0</literal>, which is equivalent).
@@ -1570,7 +1570,7 @@
For <literal>UPDATE</literal> statements, if you specify the
<literal>CLIENT_FOUND_ROWS</literal> flag when connecting to
<command>mysqld</command>,
- <function role="capi">mysql_affected_rows()</function> returns
+ <literal role="cfunc">mysql_affected_rows()</literal> returns
the number of rows matched by the <literal>WHERE</literal>
clause. Otherwise, the default behavior is to return the number
of rows actually changed.
@@ -1578,7 +1578,7 @@
<para>
Note that when you use a <literal>REPLACE</literal> command,
- <function role="capi">mysql_affected_rows()</function> returns 2
+ <literal role="cfunc">mysql_affected_rows()</literal> returns 2
if the new row replaced an old row, because in this case, one
row was inserted after the duplicate was deleted.
</para>
@@ -1586,7 +1586,7 @@
<para>
If you use <literal>INSERT ... ON DUPLICATE KEY UPDATE</literal>
to insert a row,
- <function role="capi">mysql_affected_rows()</function> returns 1
+ <literal role="cfunc">mysql_affected_rows()</literal> returns 1
if the row is inserted as a new row and 2 if an existing row is
updated.
</para>
@@ -1595,7 +1595,7 @@
<section id="mysql-autocommit">
- <title><function role="capi">mysql_autocommit()</function></title>
+ <title><literal role="cfunc">mysql_autocommit()</literal></title>
<indexterm>
<primary>mysql_autocommit()</primary>
@@ -1639,7 +1639,7 @@
<section id="mysql-change-user">
- <title><function role="capi">mysql_change_user()</function></title>
+ <title><literal role="cfunc">mysql_change_user()</literal></title>
<indexterm>
<primary>mysql_change_user()</primary>
@@ -1667,7 +1667,7 @@
</para>
<para>
- <function role="capi">mysql_change_user()</function> fails if
+ <literal role="cfunc">mysql_change_user()</literal> fails if
the connected user cannot be authenticated or doesn't have
permission to use the database. In this case, the user and
database are not changed.
@@ -1688,7 +1688,7 @@
Session system variables are reset to the values of the
corresponding global system variables. Prepared statements are
released and <literal>HANDLER</literal> variables are closed.
- Locks acquired with <function role="sql">GET_LOCK()</function>
+ Locks acquired with <literal role="func">GET_LOCK()</literal>
are released. These effects occur even if the user didn't
change.
</para>
@@ -1707,7 +1707,7 @@
<para>
The same that you can get from
- <function role="capi">mysql_real_connect()</function>.
+ <literal role="cfunc">mysql_real_connect()</literal>.
</para>
<itemizedlist>
@@ -1821,7 +1821,7 @@
<section id="mysql-character-set-name">
- <title><function role="capi">mysql_character_set_name()</function></title>
+ <title><literal role="cfunc">mysql_character_set_name()</literal></title>
<indexterm>
<primary>mysql_character_set_name()</primary>
@@ -1861,7 +1861,7 @@
<section id="mysql-close">
- <title><function role="capi">mysql_close()</function></title>
+ <title><literal role="cfunc">mysql_close()</literal></title>
<indexterm>
<primary>mysql_close()</primary>
@@ -1877,11 +1877,11 @@
<para>
Closes a previously opened connection.
- <function role="capi">mysql_close()</function> also deallocates
+ <literal role="cfunc">mysql_close()</literal> also deallocates
the connection handle pointed to by <literal>mysql</literal> if
the handle was allocated automatically by
- <function role="capi">mysql_init()</function> or
- <function role="capi">mysql_connect()</function>.
+ <literal role="cfunc">mysql_init()</literal> or
+ <literal role="cfunc">mysql_connect()</literal>.
</para>
<para>
@@ -1904,7 +1904,7 @@
<section id="mysql-commit">
- <title><function role="capi">mysql_commit()</function></title>
+ <title><literal role="cfunc">mysql_commit()</literal></title>
<indexterm>
<primary>mysql_commit()</primary>
@@ -1946,7 +1946,7 @@
<section id="mysql-connect">
- <title><function role="capi">mysql_connect()</function></title>
+ <title><literal role="cfunc">mysql_connect()</literal></title>
<indexterm>
<primary>mysql_connect()</primary>
@@ -1967,31 +1967,31 @@
<para>
This function is deprecated. Use
- <function role="capi">mysql_real_connect()</function> instead.
+ <literal role="cfunc">mysql_real_connect()</literal> instead.
</para>
<para>
- <function role="capi">mysql_connect()</function> attempts to
+ <literal role="cfunc">mysql_connect()</literal> attempts to
establish a connection to a MySQL database engine running on
<literal>host</literal>.
- <function role="capi">mysql_connect()</function> must complete
+ <literal role="cfunc">mysql_connect()</literal> must complete
successfully before you can execute any of the other API
functions, with the exception of
- <function role="capi">mysql_get_client_info()</function>.
+ <literal role="cfunc">mysql_get_client_info()</literal>.
</para>
<para>
The meanings of the parameters are the same as for the
corresponding parameters for
- <function role="capi">mysql_real_connect()</function> with the
+ <literal role="cfunc">mysql_real_connect()</literal> with the
difference that the connection parameter may be
<literal>NULL</literal>. In this case, the C API allocates
memory for the connection structure automatically and frees it
- when you call <function role="capi">mysql_close()</function>.
+ when you call <literal role="cfunc">mysql_close()</literal>.
The disadvantage of this approach is that you can't retrieve an
error message if the connection fails. (To get error information
- from <function role="capi">mysql_errno()</function> or
- <function role="capi">mysql_error()</function>, you must provide
+ from <literal role="cfunc">mysql_errno()</literal> or
+ <literal role="cfunc">mysql_error()</literal>, you must provide
a valid <literal>MYSQL</literal> pointer.)
</para>
@@ -2001,7 +2001,7 @@
<para>
Same as for
- <function role="capi">mysql_real_connect()</function>.
+ <literal role="cfunc">mysql_real_connect()</literal>.
</para>
<para>
@@ -2010,14 +2010,14 @@
<para>
Same as for
- <function role="capi">mysql_real_connect()</function>.
+ <literal role="cfunc">mysql_real_connect()</literal>.
</para>
</section>
<section id="mysql-create-db">
- <title><function role="capi">mysql_create_db()</function></title>
+ <title><literal role="cfunc">mysql_create_db()</literal></title>
<indexterm>
<primary>mysql_create_db()</primary>
@@ -2043,7 +2043,7 @@
<para>
This function is deprecated. It is preferable to use
- <function role="capi">mysql_query()</function> to issue an SQL
+ <literal role="cfunc">mysql_query()</literal> to issue an SQL
<literal>CREATE DATABASE</literal> statement instead.
</para>
@@ -2120,7 +2120,7 @@
<section id="mysql-data-seek">
- <title><function role="capi">mysql_data_seek()</function></title>
+ <title><literal role="cfunc">mysql_data_seek()</literal></title>
<indexterm>
<primary>mysql_data_seek()</primary>
@@ -2139,16 +2139,16 @@
Seeks to an arbitrary row in a query result set. The
<literal>offset</literal> value is a row number and should be in
the range from <literal>0</literal> to
- <function role="capi">mysql_num_rows(result)-1</function>.
+ <literal role="cfunc">mysql_num_rows(result)-1</literal>.
</para>
<para>
This function requires that the result set structure contains
the entire result of the query, so
- <function role="capi">mysql_data_seek()</function> may be used
+ <literal role="cfunc">mysql_data_seek()</literal> may be used
only in conjunction with
- <function role="capi">mysql_store_result()</function>, not with
- <function role="capi">mysql_use_result()</function>.
+ <literal role="cfunc">mysql_store_result()</literal>, not with
+ <literal role="cfunc">mysql_use_result()</literal>.
</para>
<para>
@@ -2171,7 +2171,7 @@
<section id="mysql-debug">
- <title><function role="capi">mysql_debug()</function></title>
+ <title><literal role="cfunc">mysql_debug()</literal></title>
<indexterm>
<primary>mysql_debug()</primary>
@@ -2187,7 +2187,7 @@
<para>
Does a <literal>DBUG_PUSH</literal> with the given string.
- <function role="capi">mysql_debug()</function> uses the Fred
+ <literal role="cfunc">mysql_debug()</literal> uses the Fred
Fish debug library. To use this function, you must compile the
client library to support debugging. See
<ulink url="http://forge.mysql.com/wiki/MySQL_Internals_Porting">MySQL
@@ -2228,7 +2228,7 @@
<section id="mysql-drop-db">
- <title><function role="capi">mysql_drop_db()</function></title>
+ <title><literal role="cfunc">mysql_drop_db()</literal></title>
<indexterm>
<primary>mysql_drop_db()</primary>
@@ -2253,7 +2253,7 @@
<para>
This function is deprecated. It is preferable to use
- <function role="capi">mysql_query()</function> to issue an SQL
+ <literal role="cfunc">mysql_query()</literal> to issue an SQL
<literal>DROP DATABASE</literal> statement instead.
</para>
@@ -2328,7 +2328,7 @@
<section id="mysql-dump-debug-info">
- <title><function role="capi">mysql_dump_debug_info()</function></title>
+ <title><literal role="cfunc">mysql_dump_debug_info()</literal></title>
<indexterm>
<primary>mysql_dump_debug_info()</primary>
@@ -2409,7 +2409,7 @@
<section id="mysql-eof">
- <title><function role="capi">mysql_eof()</function></title>
+ <title><literal role="cfunc">mysql_eof()</literal></title>
<indexterm>
<primary>mysql_eof()</primary>
@@ -2429,55 +2429,55 @@
<para>
This function is deprecated.
- <function role="capi">mysql_errno()</function> or
- <function role="capi">mysql_error()</function> may be used
+ <literal role="cfunc">mysql_errno()</literal> or
+ <literal role="cfunc">mysql_error()</literal> may be used
instead.
</para>
<para>
- <function role="capi">mysql_eof()</function> determines whether
+ <literal role="cfunc">mysql_eof()</literal> determines whether
the last row of a result set has been read.
</para>
<para>
If you acquire a result set from a successful call to
- <function role="capi">mysql_store_result()</function>, the
+ <literal role="cfunc">mysql_store_result()</literal>, the
client receives the entire set in one operation. In this case, a
<literal>NULL</literal> return from
- <function role="capi">mysql_fetch_row()</function> always means
+ <literal role="cfunc">mysql_fetch_row()</literal> always means
the end of the result set has been reached and it is unnecessary
- to call <function role="capi">mysql_eof()</function>. When used
- with <function role="capi">mysql_store_result()</function>,
- <function role="capi">mysql_eof()</function> always returns
+ to call <literal role="cfunc">mysql_eof()</literal>. When used
+ with <literal role="cfunc">mysql_store_result()</literal>,
+ <literal role="cfunc">mysql_eof()</literal> always returns
true.
</para>
<para>
On the other hand, if you use
- <function role="capi">mysql_use_result()</function> to initiate
+ <literal role="cfunc">mysql_use_result()</literal> to initiate
a result set retrieval, the rows of the set are obtained from
the server one by one as you call
- <function role="capi">mysql_fetch_row()</function> repeatedly.
+ <literal role="cfunc">mysql_fetch_row()</literal> repeatedly.
Because an error may occur on the connection during this
process, a <literal>NULL</literal> return value from
- <function role="capi">mysql_fetch_row()</function> does not
+ <literal role="cfunc">mysql_fetch_row()</literal> does not
necessarily mean the end of the result set was reached normally.
In this case, you can use
- <function role="capi">mysql_eof()</function> to determine what
- happened. <function role="capi">mysql_eof()</function> returns a
+ <literal role="cfunc">mysql_eof()</literal> to determine what
+ happened. <literal role="cfunc">mysql_eof()</literal> returns a
non-zero value if the end of the result set was reached and zero
if an error occurred.
</para>
<para>
- Historically, <function role="capi">mysql_eof()</function>
+ Historically, <literal role="cfunc">mysql_eof()</literal>
predates the standard MySQL error functions
- <function role="capi">mysql_errno()</function> and
- <function role="capi">mysql_error()</function>. Because those
+ <literal role="cfunc">mysql_errno()</literal> and
+ <literal role="cfunc">mysql_error()</literal>. Because those
error functions provide the same information, their use is
- preferred over <function role="capi">mysql_eof()</function>,
+ preferred over <literal role="cfunc">mysql_eof()</literal>,
which is deprecated. (In fact, they provide more information,
- because <function role="capi">mysql_eof()</function> returns
+ because <literal role="cfunc">mysql_eof()</literal> returns
only a boolean value whereas the error functions indicate a
reason for the error when one occurs.)
</para>
@@ -2505,7 +2505,7 @@
<para>
The following example shows how you might use
- <function role="capi">mysql_eof()</function>:
+ <literal role="cfunc">mysql_eof()</literal>:
</para>
<programlisting>
@@ -2543,7 +2543,7 @@
<section id="mysql-errno">
- <title><function role="capi">mysql_errno()</function></title>
+ <title><literal role="cfunc">mysql_errno()</literal></title>
<indexterm>
<primary>mysql_errno()</primary>
@@ -2559,7 +2559,7 @@
<para>
For the connection specified by <literal>mysql</literal>,
- <function role="capi">mysql_errno()</function> returns the error
+ <literal role="cfunc">mysql_errno()</literal> returns the error
code for the most recently invoked API function that can succeed
or fail. A return value of zero means that no error occurred.
Client error message numbers are listed in the MySQL
@@ -2570,26 +2570,26 @@
<para>
Note that some functions like
- <function role="capi">mysql_fetch_row()</function> don't set
- <function role="capi">mysql_errno()</function> if they succeed.
+ <literal role="cfunc">mysql_fetch_row()</literal> don't set
+ <literal role="cfunc">mysql_errno()</literal> if they succeed.
</para>
<para>
A rule of thumb is that all functions that have to ask the
server for information reset
- <function role="capi">mysql_errno()</function> if they succeed.
+ <literal role="cfunc">mysql_errno()</literal> if they succeed.
</para>
<para>
MySQL-specific error numbers returned by
- <function role="capi">mysql_errno()</function> differ from
+ <literal role="cfunc">mysql_errno()</literal> differ from
SQLSTATE values returned by
- <function role="capi">mysql_sqlstate()</function>. For example,
+ <literal role="cfunc">mysql_sqlstate()</literal>. For example,
the <command>mysql</command> client program displays errors
using the following format, where <literal>1146</literal> is the
- <function role="capi">mysql_errno()</function> value and
+ <literal role="cfunc">mysql_errno()</literal> value and
<literal>'42S02'</literal> is the corresponding
- <function role="capi">mysql_sqlstate()</function> value:
+ <literal role="cfunc">mysql_sqlstate()</literal> value:
</para>
<programlisting>
@@ -2619,7 +2619,7 @@
<section id="mysql-error">
- <title><function role="capi">mysql_error()</function></title>
+ <title><literal role="cfunc">mysql_error()</literal></title>
<indexterm>
<primary>mysql_error()</primary>
@@ -2635,23 +2635,23 @@
<para>
For the connection specified by <literal>mysql</literal>,
- <function role="capi">mysql_error()</function> returns a
+ <literal role="cfunc">mysql_error()</literal> returns a
null-terminated string containing the error message for the most
recently invoked API function that failed. If a function didn't
fail, the return value of
- <function role="capi">mysql_error()</function> may be the
+ <literal role="cfunc">mysql_error()</literal> may be the
previous error or an empty string to indicate no error.
</para>
<para>
A rule of thumb is that all functions that have to ask the
server for information reset
- <function role="capi">mysql_error()</function> if they succeed.
+ <literal role="cfunc">mysql_error()</literal> if they succeed.
</para>
<para>
For functions that reset
- <function role="capi">mysql_error()</function>, the following
+ <literal role="cfunc">mysql_error()</literal>, the following
two tests are equivalent:
</para>
@@ -2695,7 +2695,7 @@
<section id="mysql-escape-string">
- <title><function role="capi">mysql_escape_string()</function></title>
+ <title><literal role="cfunc">mysql_escape_string()</literal></title>
<indexterm>
<primary>mysql_escape_string()</primary>
@@ -2703,18 +2703,18 @@
<para>
You should use
- <function role="capi">mysql_real_escape_string()</function>
+ <literal role="cfunc">mysql_real_escape_string()</literal>
instead!
</para>
<para>
This function is identical to
- <function role="capi">mysql_real_escape_string()</function>
+ <literal role="cfunc">mysql_real_escape_string()</literal>
except that
- <function role="capi">mysql_real_escape_string()</function>
+ <literal role="cfunc">mysql_real_escape_string()</literal>
takes a connection handler as its first argument and escapes the
string according to the current character set.
- <function role="capi">mysql_escape_string()</function> does not
+ <literal role="cfunc">mysql_escape_string()</literal> does not
take a connection argument and does not respect the current
character set.
</para>
@@ -2723,7 +2723,7 @@
<section id="mysql-fetch-field">
- <title><function role="capi">mysql_fetch_field()</function></title>
+ <title><literal role="cfunc">mysql_fetch_field()</literal></title>
<indexterm>
<primary>mysql_fetch_field()</primary>
@@ -2742,25 +2742,25 @@
Returns the definition of one column of a result set as a
<literal>MYSQL_FIELD</literal> structure. Call this function
repeatedly to retrieve information about all columns in the
- result set. <function role="capi">mysql_fetch_field()</function>
+ result set. <literal role="cfunc">mysql_fetch_field()</literal>
returns <literal>NULL</literal> when no more fields are left.
</para>
<para>
- <function role="capi">mysql_fetch_field()</function> is reset to
+ <literal role="cfunc">mysql_fetch_field()</literal> is reset to
return information about the first field each time you execute a
new <literal>SELECT</literal> query. The field returned by
- <function role="capi">mysql_fetch_field()</function> is also
+ <literal role="cfunc">mysql_fetch_field()</literal> is also
affected by calls to
- <function role="capi">mysql_field_seek()</function>.
+ <literal role="cfunc">mysql_field_seek()</literal>.
</para>
<para>
- If you've called <function role="capi">mysql_query()</function>
+ If you've called <literal role="cfunc">mysql_query()</literal>
to perform a <literal>SELECT</literal> on a table but have not
- called <function role="capi">mysql_store_result()</function>,
+ called <literal role="cfunc">mysql_store_result()</literal>,
MySQL returns the default blob length (8KB) if you call
- <function role="capi">mysql_fetch_field()</function> to ask for
+ <literal role="cfunc">mysql_fetch_field()</literal> to ask for
the length of a <literal>BLOB</literal> field. (The 8KB size is
chosen because MySQL doesn't know the maximum length for the
<literal>BLOB</literal>. This should be made configurable
@@ -2803,7 +2803,7 @@
<section id="mysql-fetch-field-direct">
- <title><function role="capi">mysql_fetch_field_direct()</function></title>
+ <title><literal role="cfunc">mysql_fetch_field_direct()</literal></title>
<indexterm>
<primary>mysql_fetch_field_direct()</primary>
@@ -2825,7 +2825,7 @@
function to retrieve the definition for an arbitrary column. The
value of <literal>fieldnr</literal> should be in the range from
0 to
- <function role="capi">mysql_num_fields(result)-1</function>.
+ <literal role="cfunc">mysql_num_fields(result)-1</literal>.
</para>
<para>
@@ -2866,7 +2866,7 @@
<section id="mysql-fetch-fields">
- <title><function role="capi">mysql_fetch_fields()</function></title>
+ <title><literal role="cfunc">mysql_fetch_fields()</literal></title>
<indexterm>
<primary>mysql_fetch_fields()</primary>
@@ -2925,7 +2925,7 @@
<section id="mysql-fetch-lengths">
- <title><function role="capi">mysql_fetch_lengths()</function></title>
+ <title><literal role="cfunc">mysql_fetch_lengths()</literal></title>
<indexterm>
<primary>mysql_fetch_lengths()</primary>
@@ -2956,7 +2956,7 @@
The length for empty columns and for columns containing
<literal>NULL</literal> values is zero. To see how to
distinguish these two cases, see the description for
- <function role="capi">mysql_fetch_row()</function>.
+ <literal role="cfunc">mysql_fetch_row()</literal>.
</para>
<para>
@@ -2974,10 +2974,10 @@
</para>
<para>
- <function role="capi">mysql_fetch_lengths()</function> is valid
+ <literal role="cfunc">mysql_fetch_lengths()</literal> is valid
only for the current row of the result set. It returns
<literal>NULL</literal> if you call it before calling
- <function role="capi">mysql_fetch_row()</function> or after
+ <literal role="cfunc">mysql_fetch_row()</literal> or after
retrieving all rows in the result.
</para>
@@ -3008,7 +3008,7 @@
<section id="mysql-fetch-row">
- <title><function role="capi">mysql_fetch_row()</function></title>
+ <title><literal role="cfunc">mysql_fetch_row()</literal></title>
<indexterm>
<primary>mysql_fetch_row()</primary>
@@ -3024,21 +3024,21 @@
<para>
Retrieves the next row of a result set. When used after
- <function role="capi">mysql_store_result()</function>,
- <function role="capi">mysql_fetch_row()</function> returns
+ <literal role="cfunc">mysql_store_result()</literal>,
+ <literal role="cfunc">mysql_fetch_row()</literal> returns
<literal>NULL</literal> when there are no more rows to retrieve.
When used after
- <function role="capi">mysql_use_result()</function>,
- <function role="capi">mysql_fetch_row()</function> returns
+ <literal role="cfunc">mysql_use_result()</literal>,
+ <literal role="cfunc">mysql_fetch_row()</literal> returns
<literal>NULL</literal> when there are no more rows to retrieve
or if an error occurred.
</para>
<para>
The number of values in the row is given by
- <function role="capi">mysql_num_fields(result)</function>. If
+ <literal role="cfunc">mysql_num_fields(result)</literal>. If
<literal>row</literal> holds the return value from a call to
- <function role="capi">mysql_fetch_row()</function>, pointers to
+ <literal role="cfunc">mysql_fetch_row()</literal>, pointers to
the values are accessed as <literal>row[0]</literal> to
<literal>row[mysql_num_fields(result)-1]</literal>.
<literal>NULL</literal> values in the row are indicated by
@@ -3047,7 +3047,7 @@
<para>
The lengths of the field values in the row may be obtained by
- calling <function role="capi">mysql_fetch_lengths()</function>.
+ calling <literal role="cfunc">mysql_fetch_lengths()</literal>.
Empty fields and fields containing <literal>NULL</literal> both
have length 0; you can distinguish these by checking the pointer
for the field value. If the pointer is <literal>NULL</literal>,
@@ -3071,7 +3071,7 @@
<para>
Note that error is not reset between calls to
- <function role="capi">mysql_fetch_row()</function>
+ <literal role="cfunc">mysql_fetch_row()</literal>
</para>
<itemizedlist>
@@ -3125,7 +3125,7 @@
<section id="mysql-field-count">
- <title><function role="capi">mysql_field_count()</function></title>
+ <title><literal role="cfunc">mysql_field_count()</literal></title>
<indexterm>
<primary>mysql_field_count()</primary>
@@ -3152,12 +3152,12 @@
<para>
The normal use of this function is when
- <function role="capi">mysql_store_result()</function> returned
+ <literal role="cfunc">mysql_store_result()</literal> returned
<literal>NULL</literal> (and thus you have no result set
pointer). In this case, you can call
- <function role="capi">mysql_field_count()</function> to
+ <literal role="cfunc">mysql_field_count()</literal> to
determine whether
- <function role="capi">mysql_store_result()</function> should
+ <literal role="cfunc">mysql_store_result()</literal> should
have produced a non-empty result. This allows the client program
to take proper action without knowing whether the query was a
<literal>SELECT</literal> (or <literal>SELECT</literal>-like)
@@ -3225,13 +3225,13 @@
<para>
An alternative is to replace the
- <function role="capi">mysql_field_count(&mysql)</function>
+ <literal role="cfunc">mysql_field_count(&mysql)</literal>
call with
- <function role="capi">mysql_errno(&mysql)</function>. In
+ <literal role="cfunc">mysql_errno(&mysql)</literal>. In
this case, you are checking directly for an error from
- <function role="capi">mysql_store_result()</function> rather
+ <literal role="cfunc">mysql_store_result()</literal> rather
than inferring from the value of
- <function role="capi">mysql_field_count()</function> whether the
+ <literal role="cfunc">mysql_field_count()</literal> whether the
statement was a <literal>SELECT</literal>.
</para>
@@ -3239,7 +3239,7 @@
<section id="mysql-field-seek">
- <title><function role="capi">mysql_field_seek()</function></title>
+ <title><literal role="cfunc">mysql_field_seek()</literal></title>
<indexterm>
<primary>mysql_field_seek()</primary>
@@ -3256,7 +3256,7 @@
<para>
Sets the field cursor to the given offset. The next call to
- <function role="capi">mysql_fetch_field()</function> retrieves
+ <literal role="cfunc">mysql_fetch_field()</literal> retrieves
the field definition of the column associated with that offset.
</para>
@@ -3285,7 +3285,7 @@
<section id="mysql-field-tell">
- <title><function role="capi">mysql_field_tell()</function></title>
+ <title><literal role="cfunc">mysql_field_tell()</literal></title>
<indexterm>
<primary>mysql_field_tell()</primary>
@@ -3302,9 +3302,9 @@
<para>
Returns the position of the field cursor used for the last
- <function role="capi">mysql_fetch_field()</function>. This value
+ <literal role="cfunc">mysql_fetch_field()</literal>. This value
can be used as an argument to
- <function role="capi">mysql_field_seek()</function>.
+ <literal role="cfunc">mysql_field_seek()</literal>.
</para>
<para>
@@ -3327,7 +3327,7 @@
<section id="mysql-free-result">
- <title><function role="capi">mysql_free_result()</function></title>
+ <title><literal role="cfunc">mysql_free_result()</literal></title>
<indexterm>
<primary>mysql_free_result()</primary>
@@ -3343,12 +3343,12 @@
<para>
Frees the memory allocated for a result set by
- <function role="capi">mysql_store_result()</function>,
- <function role="capi">mysql_use_result()</function>,
- <function role="capi">mysql_list_dbs()</function>, and so forth.
+ <literal role="cfunc">mysql_store_result()</literal>,
+ <literal role="cfunc">mysql_use_result()</literal>,
+ <literal role="cfunc">mysql_list_dbs()</literal>, and so forth.
When you are done with a result set, you must free the memory it
uses by calling
- <function role="capi">mysql_free_result()</function>.
+ <literal role="cfunc">mysql_free_result()</literal>.
</para>
<para>
@@ -3375,7 +3375,7 @@
<section id="mysql-get-client-info">
- <title><function role="capi">mysql_get_client_info()</function></title>
+ <title><literal role="cfunc">mysql_get_client_info()</literal></title>
<indexterm>
<primary>mysql_get_client_info()</primary>
@@ -3414,7 +3414,7 @@
<section id="mysql-get-client-version">
- <title><function role="capi">mysql_get_client_version()</function></title>
+ <title><literal role="cfunc">mysql_get_client_version()</literal></title>
<indexterm>
<primary>mysql_get_client_version()</primary>
@@ -3462,7 +3462,7 @@
<section id="mysql-get-host-info">
- <title><function role="capi">mysql_get_host_info()</function></title>
+ <title><literal role="cfunc">mysql_get_host_info()</literal></title>
<indexterm>
<primary>mysql_get_host_info()</primary>
@@ -3502,7 +3502,7 @@
<section id="mysql-get-proto-info">
- <title><function role="capi">mysql_get_proto_info()</function></title>
+ <title><literal role="cfunc">mysql_get_proto_info()</literal></title>
<indexterm>
<primary>mysql_get_proto_info()</primary>
@@ -3542,7 +3542,7 @@
<section id="mysql-get-server-info">
- <title><function role="capi">mysql_get_server_info()</function></title>
+ <title><literal role="cfunc">mysql_get_server_info()</literal></title>
<indexterm>
<primary>mysql_get_server_info()</primary>
@@ -3581,7 +3581,7 @@
<section id="mysql-get-server-version">
- <title><function role="capi">mysql_get_server_version()</function></title>
+ <title><literal role="cfunc">mysql_get_server_version()</literal></title>
<indexterm>
<primary>mysql_get_server_version()</primary>
@@ -3639,7 +3639,7 @@
<section id="mysql-hex-string">
- <title><function role="capi">mysql_hex_string()</function></title>
+ <title><literal role="cfunc">mysql_hex_string()</literal></title>
<indexterm>
<primary>mysql_hex_string()</primary>
@@ -3671,7 +3671,7 @@
<literal>length</literal> bytes long. You must allocate the
<literal>to</literal> buffer to be at least
<literal>length*2+1</literal> bytes long. When
- <function role="capi">mysql_hex_string()</function> returns, the
+ <literal role="cfunc">mysql_hex_string()</literal> returns, the
contents of <literal>to</literal> is a null-terminated string.
The return value is the length of the encoded string, not
including the terminating null character.
@@ -3687,7 +3687,7 @@
</para>
<para>
- <function role="capi">mysql_hex_string()</function> was added in
+ <literal role="cfunc">mysql_hex_string()</literal> was added in
MySQL 4.0.23 and 4.1.8.
</para>
@@ -3740,7 +3740,7 @@
<section id="mysql-info">
- <title><function role="capi">mysql_info()</function></title>
+ <title><literal role="cfunc">mysql_info()</literal></title>
<indexterm>
<primary>mysql_info()</primary>
@@ -3757,7 +3757,7 @@
<para>
Retrieves a string providing information about the most recently
executed statement, but only for the statements listed here. For
- other statements, <function role="capi">mysql_info()</function>
+ other statements, <literal role="cfunc">mysql_info()</literal>
returns <literal>NULL</literal>. The format of the string varies
depending on the type of statement, as described here. The
numbers are illustrative only; the string contains values
@@ -3825,7 +3825,7 @@
</itemizedlist>
<para>
- Note that <function role="capi">mysql_info()</function> returns
+ Note that <literal role="cfunc">mysql_info()</literal> returns
a non-<literal>NULL</literal> value for <literal>INSERT ...
VALUES</literal> only for the multiple-row form of the statement
(that is, only if multiple value lists are specified).
@@ -3853,7 +3853,7 @@
<section id="mysql-init">
- <title><function role="capi">mysql_init()</function></title>
+ <title><literal role="cfunc">mysql_init()</literal></title>
<indexterm>
<primary>mysql_init()</primary>
@@ -3870,14 +3870,14 @@
<para>
Allocates or initializes a <literal>MYSQL</literal> object
suitable for
- <function role="capi">mysql_real_connect()</function>. If
+ <literal role="cfunc">mysql_real_connect()</literal>. If
<literal>mysql</literal> is a <literal>NULL</literal> pointer,
the function allocates, initializes, and returns a new object.
Otherwise, the object is initialized and the address of the
object is returned. If
- <function role="capi">mysql_init()</function> allocates a new
+ <literal role="cfunc">mysql_init()</literal> allocates a new
object, it is freed when
- <function role="capi">mysql_close()</function> is called to
+ <literal role="cfunc">mysql_close()</literal> is called to
close the connection.
</para>
@@ -3904,7 +3904,7 @@
<section id="mysql-insert-id">
- <title><function role="capi">mysql_insert_id()</function></title>
+ <title><literal role="cfunc">mysql_insert_id()</literal></title>
<indexterm>
<primary>mysql_insert_id()</primary>
@@ -3927,12 +3927,12 @@
an <literal>AUTO_INCREMENT</literal> field, or have used
<literal>INSERT</literal> or <literal>UPDATE</literal> to set a
column value with
- <function role="sql">LAST_INSERT_ID(<replaceable>expr</replaceable>)</function>.
+ <literal role="func">LAST_INSERT_ID(<replaceable>expr</replaceable>)</literal>.
</para>
<para>
More precisely,
- <function role="capi">mysql_insert_id()</function> is updated
+ <literal role="cfunc">mysql_insert_id()</literal> is updated
under these conditions:
</para>
@@ -3953,7 +3953,7 @@
<para>
In the case of a multiple-row <literal>INSERT</literal>
statement,
- <function role="capi">mysql_insert_id()</function> returns
+ <literal role="cfunc">mysql_insert_id()</literal> returns
the <emphasis>first</emphasis> automatically generated
<literal>AUTO_INCREMENT</literal> value; if no such value is
generated, it returns the <emphasis>last</emphasis> explicit
@@ -3966,16 +3966,16 @@
<para>
<literal>INSERT</literal> statements that generate an
<literal>AUTO_INCREMENT</literal> value by inserting
- <function role="sql">LAST_INSERT_ID(<replaceable>expr</replaceable>)</function>
+ <literal role="func">LAST_INSERT_ID(<replaceable>expr</replaceable>)</literal>
into any column or by updating any column to
- <function role="sql">LAST_INSERT_ID(<replaceable>expr</replaceable>)</function>.
+ <literal role="func">LAST_INSERT_ID(<replaceable>expr</replaceable>)</literal>.
</para>
</listitem>
<listitem>
<para>
If the previous statement returned an error, the value of
- <function role="capi">mysql_insert_id()</function> is
+ <literal role="cfunc">mysql_insert_id()</literal> is
undefined.
</para>
</listitem>
@@ -3983,35 +3983,35 @@
</itemizedlist>
<para>
- <function role="capi">mysql_insert_id()</function> returns
+ <literal role="cfunc">mysql_insert_id()</literal> returns
<literal>0</literal> if the previous statement does not use an
<literal>AUTO_INCREMENT</literal> value. If you need to save the
value for later, be sure to call
- <function role="capi">mysql_insert_id()</function> immediately
+ <literal role="cfunc">mysql_insert_id()</literal> immediately
after the statement that generates the value.
</para>
<para>
- The value of <function role="capi">mysql_insert_id()</function>
+ The value of <literal role="cfunc">mysql_insert_id()</literal>
is not affected by statements such as <literal>SELECT</literal>
that return a result set.
</para>
<para>
- The value of <function role="capi">mysql_insert_id()</function>
+ The value of <literal role="cfunc">mysql_insert_id()</literal>
is affected only by statements issued within the current client
connection. It is not affected by statements issued by other
clients.
</para>
<para>
- The <function role="sql">LAST_INSERT_ID()</function> SQL
+ The <literal role="func">LAST_INSERT_ID()</literal> SQL
function returns the most recently generated
<literal>AUTO_INCREMENT</literal> value, and is not reset
between statements because the value of that function is
maintained in the server. Another difference from
- <function role="capi">mysql_insert_id()</function> is that
- <function role="sql">LAST_INSERT_ID()</function> is not updated
+ <literal role="cfunc">mysql_insert_id()</literal> is that
+ <literal role="func">LAST_INSERT_ID()</literal> is not updated
if you set an <literal>AUTO_INCREMENT</literal> column to a
specific non-special value. See
<xref linkend="information-functions"/>.
@@ -4019,11 +4019,11 @@
<para>
The reason for the differences between
- <function role="sql">LAST_INSERT_ID()</function> and
- <function role="capi">mysql_insert_id()</function> is that
- <function role="sql">LAST_INSERT_ID()</function> is made easy to
+ <literal role="func">LAST_INSERT_ID()</literal> and
+ <literal role="cfunc">mysql_insert_id()</literal> is that
+ <literal role="func">LAST_INSERT_ID()</literal> is made easy to
use in scripts while
- <function role="capi">mysql_insert_id()</function> tries to
+ <literal role="cfunc">mysql_insert_id()</literal> tries to
provide more exact information about what happens to the
<literal>AUTO_INCREMENT</literal> column.
</para>
@@ -4048,7 +4048,7 @@
<section id="mysql-kill">
- <title><function role="capi">mysql_kill()</function></title>
+ <title><literal role="cfunc">mysql_kill()</literal></title>
<indexterm>
<primary>mysql_kill()</primary>
@@ -4074,7 +4074,7 @@
<para>
This function is deprecated. It is preferable to use
- <function role="capi">mysql_query()</function> to issue an SQL
+ <literal role="cfunc">mysql_query()</literal> to issue an SQL
<literal>KILL</literal> statement instead.
</para>
@@ -4138,7 +4138,7 @@
<section id="mysql-library-end">
- <title><function role="capi">mysql_library_end()</function></title>
+ <title><literal role="cfunc">mysql_library_end()</literal></title>
<indexterm>
<primary>mysql_library_end()</primary>
@@ -4161,11 +4161,11 @@
client program linked against the
<literal>libmysqlclient</literal> library by using the
<option>-lmysqlclient</option> flag,
- <function role="capi">mysql_library_end()</function> performs
+ <literal role="cfunc">mysql_library_end()</literal> performs
some memory management to clean up. For an embedded server
application linked against the <literal>libmysqld</literal>
library by using the <option>-lmysqld</option> flag,
- <function role="capi">mysql_library_end()</function> shuts down
+ <literal role="cfunc">mysql_library_end()</literal> shuts down
the embedded server and then cleans up.
</para>
@@ -4176,16 +4176,16 @@
</para>
<para>
- <function role="capi">mysql_library_end()</function> was added
+ <literal role="cfunc">mysql_library_end()</literal> was added
in MySQL 4.1.10. For older versions of MySQL, call
- <function role="capi">mysql_server_end()</function> instead.
+ <literal role="cfunc">mysql_server_end()</literal> instead.
</para>
</section>
<section id="mysql-library-init">
- <title><function role="capi">mysql_library_init()</function></title>
+ <title><literal role="cfunc">mysql_library_init()</literal></title>
<indexterm>
<primary>mysql_library_init()</primary>
@@ -4212,7 +4212,7 @@
<para>
After your application is done using the MySQL library, call
- <function role="capi">mysql_library_end()</function> to clean
+ <literal role="cfunc">mysql_library_end()</literal> to clean
up. See <xref linkend="mysql-library-end"/>.
</para>
@@ -4227,19 +4227,19 @@
<para>
In a non-multi-threaded environment, the call to
- <function role="capi">mysql_library_init()</function> may be
- omitted, because <function role="capi">mysql_init()</function>
+ <literal role="cfunc">mysql_library_init()</literal> may be
+ omitted, because <literal role="cfunc">mysql_init()</literal>
will invoke it automatically as necessary. However,
- <function role="capi">mysql_library_init()</function> is not
+ <literal role="cfunc">mysql_library_init()</literal> is not
thread-safe in a multi-threaded environment, and thus neither is
- <function role="capi">mysql_init()</function>, which calls
- <function role="capi">mysql_library_init()</function>. You must
+ <literal role="cfunc">mysql_init()</literal>, which calls
+ <literal role="cfunc">mysql_library_init()</literal>. You must
either call
- <function role="capi">mysql_library_init()</function> prior to
+ <literal role="cfunc">mysql_library_init()</literal> prior to
spawning any threads, or else use a mutex to protect the call,
whether you invoke
- <function role="capi">mysql_library_init()</function> or
- indirectly via <function role="capi">mysql_init()</function>.
+ <literal role="cfunc">mysql_library_init()</literal> or
+ indirectly via <literal role="cfunc">mysql_init()</literal>.
This should be done prior to any other client library call.
</para>
@@ -4252,8 +4252,8 @@
arguments for the server. This is the usual case for
applications intended for use only as regular (non-embedded)
clients, and the call typically is written as
- <function role="capi">mysql_library_init(0, NULL,
- NULL)</function>.
+ <literal role="cfunc">mysql_library_init(0, NULL,
+ NULL)</literal>.
</para>
<programlisting>
@@ -4279,7 +4279,7 @@
greater than <literal>0</literal>), the first element of
<literal>argv</literal> is ignored (it typically contains the
program name).
- <function role="capi">mysql_library_init()</function> makes a
+ <literal role="cfunc">mysql_library_init()</literal> makes a
copy of the arguments so it is safe to destroy
<literal>argv</literal> or <literal>groups</literal> after the
call.
@@ -4333,9 +4333,9 @@
</programlisting>
<para>
- <function role="capi">mysql_library_init()</function> was added
+ <literal role="cfunc">mysql_library_init()</literal> was added
in MySQL 4.1.10. For older versions of MySQL, call
- <function role="capi">mysql_server_init()</function> instead.
+ <literal role="cfunc">mysql_server_init()</literal> instead.
</para>
<para>
@@ -4350,7 +4350,7 @@
<section id="mysql-list-dbs">
- <title><function role="capi">mysql_list_dbs()</function></title>
+ <title><literal role="cfunc">mysql_list_dbs()</literal></title>
<indexterm>
<primary>mysql_list_dbs()</primary>
@@ -4373,14 +4373,14 @@
<quote><literal>%</literal></quote> or
<quote><literal>_</literal></quote>, or may be a
<literal>NULL</literal> pointer to match all databases. Calling
- <function role="capi">mysql_list_dbs()</function> is similar to
+ <literal role="cfunc">mysql_list_dbs()</literal> is similar to
executing the query <literal>SHOW databases [LIKE
<replaceable>wild</replaceable>]</literal>.
</para>
<para>
You must free the result set with
- <function role="capi">mysql_free_result()</function>.
+ <literal role="cfunc">mysql_free_result()</literal>.
</para>
<para>
@@ -4454,7 +4454,7 @@
<section id="mysql-list-fields">
- <title><function role="capi">mysql_list_fields()</function></title>
+ <title><literal role="cfunc">mysql_list_fields()</literal></title>
<indexterm>
<primary>mysql_list_fields()</primary>
@@ -4477,7 +4477,7 @@
characters <quote><literal>%</literal></quote> or
<quote><literal>_</literal></quote>, or may be a
<literal>NULL</literal> pointer to match all fields. Calling
- <function role="capi">mysql_list_fields()</function> is similar
+ <literal role="cfunc">mysql_list_fields()</literal> is similar
to executing the query <literal>SHOW COLUMNS FROM
<replaceable>tbl_name</replaceable> [LIKE
<replaceable>wild</replaceable>]</literal>.
@@ -4486,12 +4486,12 @@
<para>
Note that it's recommended that you use <literal>SHOW COLUMNS
FROM <replaceable>tbl_name</replaceable></literal> instead of
- <function role="capi">mysql_list_fields()</function>.
+ <literal role="cfunc">mysql_list_fields()</literal>.
</para>
<para>
You must free the result set with
- <function role="capi">mysql_free_result()</function>.
+ <literal role="cfunc">mysql_free_result()</literal>.
</para>
<para>
@@ -4555,7 +4555,7 @@
<section id="mysql-list-processes">
- <title><function role="capi">mysql_list_processes()</function></title>
+ <title><literal role="cfunc">mysql_list_processes()</literal></title>
<indexterm>
<primary>mysql_list_processes()</primary>
@@ -4578,7 +4578,7 @@
<para>
You must free the result set with
- <function role="capi">mysql_free_result()</function>.
+ <literal role="cfunc">mysql_free_result()</literal>.
</para>
<para>
@@ -4642,7 +4642,7 @@
<section id="mysql-list-tables">
- <title><function role="capi">mysql_list_tables()</function></title>
+ <title><literal role="cfunc">mysql_list_tables()</literal></title>
<indexterm>
<primary>mysql_list_tables()</primary>
@@ -4672,17 +4672,17 @@
<para>
You must free the result set with
- <function role="capi">mysql_free_result()</function>.
+ <literal role="cfunc">mysql_free_result()</literal>.
</para>
<para>
- <function role="capi">mysql_num_rows()</function> is intended
+ <literal role="cfunc">mysql_num_rows()</literal> is intended
for use with statements that return a result set, such as
<literal>SELECT</literal>. For statements such as
<literal>INSERT</literal>, <literal>UPDATE</literal>, or
<literal>DELETE</literal>, the number of affected rows can be
obtained with
- <function role="capi">mysql_affected_rows()</function>.
+ <literal role="cfunc">mysql_affected_rows()</literal>.
</para>
<para>
@@ -4746,7 +4746,7 @@
<section id="mysql-more-results">
- <title><function role="capi">mysql_more_results()</function></title>
+ <title><literal role="cfunc">mysql_more_results()</literal></title>
<indexterm>
<primary>mysql_more_results()</primary>
@@ -4766,10 +4766,10 @@
</para>
<para>
- <function role="capi">mysql_more_results()</function> true if
+ <literal role="cfunc">mysql_more_results()</literal> true if
more results exist from the currently executed statement, in
which case the application must call
- <function role="capi">mysql_next_result()</function> to fetch
+ <literal role="cfunc">mysql_next_result()</literal> to fetch
the results.
</para>
@@ -4788,7 +4788,7 @@
<para>
In most cases, you can call
- <function role="capi">mysql_next_result()</function> instead to
+ <literal role="cfunc">mysql_next_result()</literal> instead to
test whether more results exist and initiate retrieval if so.
</para>
@@ -4809,7 +4809,7 @@
<section id="mysql-next-result">
- <title><function role="capi">mysql_next_result()</function></title>
+ <title><literal role="cfunc">mysql_next_result()</literal></title>
<indexterm>
<primary>mysql_next_result()</primary>
@@ -4830,41 +4830,41 @@
<para>
If more statement results exist,
- <function role="capi">mysql_next_result()</function> reads the
+ <literal role="cfunc">mysql_next_result()</literal> reads the
next statement result and returns the status back to the
application.
</para>
<para>
Before calling
- <function role="capi">mysql_next_result()</function>, you must
- call <function role="capi">mysql_free_result()</function> for
+ <literal role="cfunc">mysql_next_result()</literal>, you must
+ call <literal role="cfunc">mysql_free_result()</literal> for
the preceding statement if it is a query that returned a result
set.
</para>
<para>
After calling
- <function role="capi">mysql_next_result()</function> the state
+ <literal role="cfunc">mysql_next_result()</literal> the state
of the connection is as if you had called
- <function role="capi">mysql_real_query()</function> or
- <function role="capi">mysql_query()</function> for the next
+ <literal role="cfunc">mysql_real_query()</literal> or
+ <literal role="cfunc">mysql_query()</literal> for the next
statement. This means that you can call
- <function role="capi">mysql_store_result()</function>,
- <function role="capi">mysql_warning_count()</function>,
- <function role="capi">mysql_affected_rows()</function>, and so
+ <literal role="cfunc">mysql_store_result()</literal>,
+ <literal role="cfunc">mysql_warning_count()</literal>,
+ <literal role="cfunc">mysql_affected_rows()</literal>, and so
forth.
</para>
<para>
- If <function role="capi">mysql_next_result()</function> returns
+ If <literal role="cfunc">mysql_next_result()</literal> returns
an error, no other statements are executed and there are no more
results to fetch.
</para>
<para>
For an example that shows how to use
- <function role="capi">mysql_next_result()</function>, see
+ <literal role="cfunc">mysql_next_result()</literal>, see
<xref linkend="c-api-multiple-queries"/>.
</para>
@@ -4915,7 +4915,7 @@
<para>
Commands were executed in an improper order. For example if
you didn't call
- <function role="capi">mysql_use_result()</function> for a
+ <literal role="cfunc">mysql_use_result()</literal> for a
previous result set.
</para>
</listitem>
@@ -4956,7 +4956,7 @@
<section id="mysql-num-fields">
- <title><function role="capi">mysql_num_fields()</function></title>
+ <title><literal role="cfunc">mysql_num_fields()</literal></title>
<indexterm>
<primary>mysql_num_fields()</primary>
@@ -4998,13 +4998,13 @@
Note that you can get the number of columns either from a
pointer to a result set or to a connection handle. You would use
the connection handle if
- <function role="capi">mysql_store_result()</function> or
- <function role="capi">mysql_use_result()</function> returned
+ <literal role="cfunc">mysql_store_result()</literal> or
+ <literal role="cfunc">mysql_use_result()</literal> returned
<literal>NULL</literal> (and thus you have no result set
pointer). In this case, you can call
- <function role="capi">mysql_field_count()</function> to
+ <literal role="cfunc">mysql_field_count()</literal> to
determine whether
- <function role="capi">mysql_store_result()</function> should
+ <literal role="cfunc">mysql_store_result()</literal> should
have produced a non-empty result. This allows the client program
to take proper action without knowing whether the query was a
<literal>SELECT</literal> (or <literal>SELECT</literal>-like)
@@ -5073,9 +5073,9 @@
<para>
An alternative (if you know that your query should have returned
a result set) is to replace the
- <function role="capi">mysql_errno(&mysql)</function> call
+ <literal role="cfunc">mysql_errno(&mysql)</literal> call
with a check whether
- <function role="capi">mysql_field_count(&mysql)</function>
+ <literal role="cfunc">mysql_field_count(&mysql)</literal>
returns 0. This happens only if something went wrong.
</para>
@@ -5083,7 +5083,7 @@
<section id="mysql-num-rows">
- <title><function role="capi">mysql_num_rows()</function></title>
+ <title><literal role="cfunc">mysql_num_rows()</literal></title>
<indexterm>
<primary>mysql_num_rows()</primary>
@@ -5103,16 +5103,16 @@
</para>
<para>
- The use of <function role="capi">mysql_num_rows()</function>
+ The use of <literal role="cfunc">mysql_num_rows()</literal>
depends on whether you use
- <function role="capi">mysql_store_result()</function> or
- <function role="capi">mysql_use_result()</function> to return
+ <literal role="cfunc">mysql_store_result()</literal> or
+ <literal role="cfunc">mysql_use_result()</literal> to return
the result set. If you use
- <function role="capi">mysql_store_result()</function>,
- <function role="capi">mysql_num_rows()</function> may be called
+ <literal role="cfunc">mysql_store_result()</literal>,
+ <literal role="cfunc">mysql_num_rows()</literal> may be called
immediately. If you use
- <function role="capi">mysql_use_result()</function>,
- <function role="capi">mysql_num_rows()</function> does not
+ <literal role="cfunc">mysql_use_result()</literal>,
+ <literal role="cfunc">mysql_num_rows()</literal> does not
return the correct value until all the rows in the result set
have been retrieved.
</para>
@@ -5137,7 +5137,7 @@
<section id="mysql-options">
- <title><function role="capi">mysql_options()</function></title>
+ <title><literal role="cfunc">mysql_options()</literal></title>
<indexterm>
<primary>mysql_options()</primary>
@@ -5159,10 +5159,10 @@
</para>
<para>
- <function role="capi">mysql_options()</function> should be
- called after <function role="capi">mysql_init()</function> and
- before <function role="capi">mysql_connect()</function> or
- <function role="capi">mysql_real_connect()</function>.
+ <literal role="cfunc">mysql_options()</literal> should be
+ called after <literal role="cfunc">mysql_init()</literal> and
+ before <literal role="cfunc">mysql_connect()</literal> or
+ <literal role="cfunc">mysql_real_connect()</literal>.
</para>
<para>
@@ -5530,7 +5530,7 @@
<row>
<entry><literal>interactive-timeout=<replaceable>seconds</replaceable></literal></entry>
<entry>Same as specifying <literal>CLIENT_INTERACTIVE</literal> to
- <function role="capi">mysql_real_connect()</function>.
+ <literal role="cfunc">mysql_real_connect()</literal>.
See <xref linkend="mysql-real-connect"/>.</entry>
</row>
<row>
@@ -5571,7 +5571,7 @@
</row>
<row>
<entry><literal>return-found-rows</literal></entry>
- <entry>Tell <function role="capi">mysql_info()</function> to return found rows
+ <entry>Tell <literal role="cfunc">mysql_info()</literal> to return found rows
instead of updated rows when using
<literal>UPDATE</literal>.</entry>
</row>
@@ -5663,7 +5663,7 @@
<section id="mysql-ping">
- <title><function role="capi">mysql_ping()</function></title>
+ <title><literal role="cfunc">mysql_ping()</literal></title>
<indexterm>
<primary>mysql_ping()</primary>
@@ -5682,7 +5682,7 @@
connection has gone down and auto-reconnect is enabled an
attempt to reconnect is made. If the connection is down and
auto-reconnect is disabled,
- <function role="capi">mysql_ping()</function> returns an error.
+ <literal role="cfunc">mysql_ping()</literal> returns an error.
</para>
<para>
@@ -5690,19 +5690,19 @@
</para>
<para>
- <function role="capi">mysql_ping()</function> can be used by
+ <literal role="cfunc">mysql_ping()</literal> can be used by
clients that remain idle for a long while, to check whether the
server has closed the connection and reconnect if necessary.
</para>
<para>
- If <function role="capi">mysql_ping()</function>) does cause a
+ If <literal role="cfunc">mysql_ping()</literal>) does cause a
reconnect, there is no explicit indication of it. To determine
whether a reconnect occurs, call
- <function role="capi">mysql_thread_id()</function> to get the
+ <literal role="cfunc">mysql_thread_id()</literal> to get the
original connection identifier before calling
- <function role="capi">mysql_ping()</function>, and then call
- <function role="capi">mysql_thread_id()</function> again to see
+ <literal role="cfunc">mysql_ping()</literal>, and then call
+ <literal role="cfunc">mysql_thread_id()</literal> again to see
whether the identifier has changed.
</para>
@@ -5765,7 +5765,7 @@
<section id="mysql-query">
- <title><function role="capi">mysql_query()</function></title>
+ <title><literal role="cfunc">mysql_query()</literal></title>
<indexterm>
<primary>mysql_query()</primary>
@@ -5792,19 +5792,19 @@
</para>
<para>
- <function role="capi">mysql_query()</function> cannot be used
+ <literal role="cfunc">mysql_query()</literal> cannot be used
for statements that contain binary data; you must use
- <function role="capi">mysql_real_query()</function> instead.
+ <literal role="cfunc">mysql_real_query()</literal> instead.
(Binary data may contain the
<quote><literal>\0</literal></quote> character, which
- <function role="capi">mysql_query()</function> interprets as the
+ <literal role="cfunc">mysql_query()</literal> interprets as the
end of the statement string.)
</para>
<para>
If you want to know whether the statement should return a result
set, you can use
- <function role="capi">mysql_field_count()</function> to check
+ <literal role="cfunc">mysql_field_count()</literal> to check
for this. See <xref linkend="mysql-field-count"/>.
</para>
@@ -5869,7 +5869,7 @@
<section id="mysql-real-connect">
- <title><function role="capi">mysql_real_connect()</function></title>
+ <title><literal role="cfunc">mysql_real_connect()</literal></title>
<indexterm>
<primary>mysql_real_connect()</primary>
@@ -5887,10 +5887,10 @@
</para>
<para>
- <function role="capi">mysql_real_connect()</function> attempts
+ <literal role="cfunc">mysql_real_connect()</literal> attempts
to establish a connection to a MySQL database engine running on
<literal>host</literal>.
- <function role="capi">mysql_real_connect()</function> must
+ <literal role="cfunc">mysql_real_connect()</literal> must
complete successfully before you can execute any other API
functions that require a valid <literal>MYSQL</literal>
connection handle structure.
@@ -5906,11 +5906,11 @@
<para>
The first parameter should be the address of an existing
<literal>MYSQL</literal> structure. Before calling
- <function role="capi">mysql_real_connect()</function> you
- must call <function role="capi">mysql_init()</function> to
+ <literal role="cfunc">mysql_real_connect()</literal> you
+ must call <literal role="cfunc">mysql_init()</literal> to
initialize the <literal>MYSQL</literal> structure. You can
change a lot of connect options with the
- <function role="capi">mysql_options()</function> call. See
+ <literal role="cfunc">mysql_options()</literal> call. See
<xref linkend="mysql-options"/>.
</para>
</listitem>
@@ -5928,7 +5928,7 @@
connections, you can also influence the type of connection
to use with the <literal>MYSQL_OPT_PROTOCOL</literal> or
<literal>MYSQL_OPT_NAMED_PIPE</literal> options to
- <function role="capi">mysql_options()</function>. The type
+ <literal role="cfunc">mysql_options()</literal>. The type
of connection must be supported by the server. For a
<literal>host</literal> value of <literal>"."</literal> on
Windows, the client connects using a named pipe, if the
@@ -5965,7 +5965,7 @@
<note>
<para>
Do not attempt to encrypt the password before calling
- <function role="capi">mysql_real_connect()</function>;
+ <literal role="cfunc">mysql_real_connect()</literal>;
password encryption is handled automatically by the client
API.
</para>
@@ -5978,9 +5978,9 @@
parameters use whatever character set has been configured
for the <literal>MYSQL</literal> object. By default, this is
<literal>latin1</literal>, but can be changed by calling
- <function role="capi">mysql_options(mysql,
+ <literal role="cfunc">mysql_options(mysql,
MYSQL_SET_CHARSET_NAME,
- "<replaceable>charset_name</replaceable>")</function> prior
+ "<replaceable>charset_name</replaceable>")</literal> prior
to connecting.
</para>
</listitem>
@@ -6095,9 +6095,9 @@
<entry>Use SSL (encrypted protocol). This option should not be set by
application programs; it is set internally in the
client library. Instead, use
- <function role="capi">mysql_ssl_set()</function>
+ <literal role="cfunc">mysql_ssl_set()</literal>
before calling
- <function role="capi">mysql_real_connect()</function>.</entry>
+ <literal role="cfunc">mysql_real_connect()</literal>.</entry>
</row>
</tbody>
</tgroup>
@@ -6110,10 +6110,10 @@
If you enable <literal>CLIENT_MULTI_STATEMENTS</literal> or
<literal>CLIENT_MULTI_RESULTS</literal>, you should process the
result for every call to
- <function role="capi">mysql_query()</function> or
- <function role="capi">mysql_real_query()</function> by using a
+ <literal role="cfunc">mysql_query()</literal> or
+ <literal role="cfunc">mysql_real_query()</literal> by using a
loop that calls
- <function role="capi">mysql_next_result()</function> to
+ <literal role="cfunc">mysql_next_result()</literal> to
determine whether there are more results. For an example, see
<xref linkend="c-api-multiple-queries"/>.
</para>
@@ -6121,13 +6121,13 @@
<para>
For some parameters, it is possible to have the value taken from
an option file rather than from an explicit value in the
- <function role="capi">mysql_real_connect()</function> call. To
- do this, call <function role="capi">mysql_options()</function>
+ <literal role="cfunc">mysql_real_connect()</literal> call. To
+ do this, call <literal role="cfunc">mysql_options()</literal>
with the <literal>MYSQL_READ_DEFAULT_FILE</literal> or
<literal>MYSQL_READ_DEFAULT_GROUP</literal> option before
- calling <function role="capi">mysql_real_connect()</function>.
+ calling <literal role="cfunc">mysql_real_connect()</literal>.
Then, in the
- <function role="capi">mysql_real_connect()</function> call,
+ <literal role="cfunc">mysql_real_connect()</literal> call,
specify the <quote>no-value</quote> value for each parameter to
be read from an option file:
</para>
@@ -6154,7 +6154,7 @@
For <literal>passwd</literal>, specify a value of
<literal>NULL</literal>. (For the password, a value of the
empty string in the
- <function role="capi">mysql_real_connect()</function> call
+ <literal role="cfunc">mysql_real_connect()</literal> call
cannot be overridden in an option file, because the empty
string indicates explicitly that the MySQL account must have
an empty password.)
@@ -6342,7 +6342,7 @@
</programlisting>
<para>
- By using <function role="capi">mysql_options()</function> the
+ By using <literal role="cfunc">mysql_options()</literal> the
MySQL library reads the <literal>[client]</literal> and
<literal>[your_prog_name]</literal> sections in the
<filename>my.cnf</filename> file which ensures that your program
@@ -6352,7 +6352,7 @@
<para>
Note that upon connection,
- <function role="capi">mysql_real_connect()</function> sets the
+ <literal role="cfunc">mysql_real_connect()</literal> sets the
<literal>reconnect</literal> flag (part of the
<literal>MYSQL</literal> structure) to a value of
<literal>1</literal>. A value of <literal>1</literal> for this
@@ -6365,7 +6365,7 @@
<section id="mysql-real-escape-string">
- <title><function role="capi">mysql_real_escape_string()</function></title>
+ <title><literal role="cfunc">mysql_real_escape_string()</literal></title>
<indexterm>
<primary>mysql_real_escape_string()</primary>
@@ -6415,7 +6415,7 @@
<literal>length*2+1</literal> bytes long. (In the worst case,
each character may need to be encoded as using two bytes, and
you need room for the terminating null byte.) When
- <function role="capi">mysql_real_escape_string()</function>
+ <literal role="cfunc">mysql_real_escape_string()</literal>
returns, the contents of <literal>to</literal> is a
null-terminated string. The return value is the length of the
encoded string, not including the terminating null character.
@@ -6424,13 +6424,13 @@
<para>
If you need to change the character set of the connection, you
should use the
- <function role="capi">mysql_set_character_set()</function>
+ <literal role="cfunc">mysql_set_character_set()</literal>
function rather than executing a <literal>SET NAMES</literal>
(or <literal>SET CHARACTER SET</literal>) statement.
- <function role="capi">mysql_set_character_set()</function> works
+ <literal role="cfunc">mysql_set_character_set()</literal> works
like <literal>SET NAMES</literal> but also affects the character
set used by
- <function role="capi">mysql_real_escape_string()</function>,
+ <literal role="cfunc">mysql_real_escape_string()</literal>,
which <literal>SET NAMES</literal> does not.
</para>
@@ -6486,7 +6486,7 @@
<section id="mysql-real-query">
- <title><function role="capi">mysql_real_query()</function></title>
+ <title><literal role="cfunc">mysql_real_query()</literal></title>
<indexterm>
<primary>mysql_real_query()</primary>
@@ -6514,15 +6514,15 @@
</para>
<para>
- <function role="capi">mysql_query()</function> cannot be used
+ <literal role="cfunc">mysql_query()</literal> cannot be used
for statements that contain binary data; you must use
- <function role="capi">mysql_real_query()</function> instead.
+ <literal role="cfunc">mysql_real_query()</literal> instead.
(Binary data may contain the
<quote><literal>\0</literal></quote> character, which
- <function role="capi">mysql_query()</function> interprets as the
+ <literal role="cfunc">mysql_query()</literal> interprets as the
end of the statement string.) In addition,
- <function role="capi">mysql_real_query()</function> is faster
- than <function role="capi">mysql_query()</function> because it
+ <literal role="cfunc">mysql_real_query()</literal> is faster
+ than <literal role="cfunc">mysql_query()</literal> because it
does not call <literal>strlen()</literal> on the statement
string.
</para>
@@ -6530,7 +6530,7 @@
<para>
If you want to know whether the statement should return a result
set, you can use
- <function role="capi">mysql_field_count()</function> to check
+ <literal role="cfunc">mysql_field_count()</literal> to check
for this. See <xref linkend="mysql-field-count"/>.
</para>
@@ -6595,7 +6595,7 @@
<section id="mysql-refresh">
- <title><function role="capi">mysql_refresh()</function></title>
+ <title><literal role="cfunc">mysql_refresh()</literal></title>
<indexterm>
<primary>mysql_refresh()</primary>
@@ -6773,7 +6773,7 @@
<section id="mysql-reload">
- <title><function role="capi">mysql_reload()</function></title>
+ <title><literal role="cfunc">mysql_reload()</literal></title>
<indexterm>
<primary>mysql_reload()</primary>
@@ -6798,7 +6798,7 @@
<para>
This function is deprecated. It is preferable to use
- <function role="capi">mysql_query()</function> to issue an SQL
+ <literal role="cfunc">mysql_query()</literal> to issue an SQL
<literal>FLUSH PRIVILEGES</literal> statement instead.
</para>
@@ -6862,7 +6862,7 @@
<section id="mysql-rollback">
- <title><function role="capi">mysql_rollback()</function></title>
+ <title><literal role="cfunc">mysql_rollback()</literal></title>
<indexterm>
<primary>mysql_rollback()</primary>
@@ -6904,7 +6904,7 @@
<section id="mysql-row-seek">
- <title><function role="capi">mysql_row_seek()</function></title>
+ <title><literal role="cfunc">mysql_row_seek()</literal></title>
<indexterm>
<primary>mysql_row_seek()</primary>
@@ -6923,20 +6923,20 @@
Sets the row cursor to an arbitrary row in a query result set.
The <literal>offset</literal> value is a row offset that should
be a value returned from
- <function role="capi">mysql_row_tell()</function> or from
- <function role="capi">mysql_row_seek()</function>. This value is
+ <literal role="cfunc">mysql_row_tell()</literal> or from
+ <literal role="cfunc">mysql_row_seek()</literal>. This value is
not a row number; if you want to seek to a row within a result
set by number, use
- <function role="capi">mysql_data_seek()</function> instead.
+ <literal role="cfunc">mysql_data_seek()</literal> instead.
</para>
<para>
This function requires that the result set structure contains
the entire result of the query, so
- <function role="capi">mysql_row_seek()</function> may be used
+ <literal role="cfunc">mysql_row_seek()</literal> may be used
only in conjunction with
- <function role="capi">mysql_store_result()</function>, not with
- <function role="capi">mysql_use_result()</function>.
+ <literal role="cfunc">mysql_store_result()</literal>, not with
+ <literal role="cfunc">mysql_use_result()</literal>.
</para>
<para>
@@ -6946,7 +6946,7 @@
<para>
The previous value of the row cursor. This value may be passed
to a subsequent call to
- <function role="capi">mysql_row_seek()</function>.
+ <literal role="cfunc">mysql_row_seek()</literal>.
</para>
<para>
@@ -6961,7 +6961,7 @@
<section id="mysql-row-tell">
- <title><function role="capi">mysql_row_tell()</function></title>
+ <title><literal role="cfunc">mysql_row_tell()</literal></title>
<indexterm>
<primary>mysql_row_tell()</primary>
@@ -6978,16 +6978,16 @@
<para>
Returns the current position of the row cursor for the last
- <function role="capi">mysql_fetch_row()</function>. This value
+ <literal role="cfunc">mysql_fetch_row()</literal>. This value
can be used as an argument to
- <function role="capi">mysql_row_seek()</function>.
+ <literal role="cfunc">mysql_row_seek()</literal>.
</para>
<para>
- You should use <function role="capi">mysql_row_tell()</function>
+ You should use <literal role="cfunc">mysql_row_tell()</literal>
only after
- <function role="capi">mysql_store_result()</function>, not after
- <function role="capi">mysql_use_result()</function>.
+ <literal role="cfunc">mysql_store_result()</literal>, not after
+ <literal role="cfunc">mysql_use_result()</literal>.
</para>
<para>
@@ -7010,7 +7010,7 @@
<section id="mysql-select-db">
- <title><function role="capi">mysql_select_db()</function></title>
+ <title><literal role="cfunc">mysql_select_db()</literal></title>
<indexterm>
<primary>mysql_select_db()</primary>
@@ -7034,7 +7034,7 @@
</para>
<para>
- <function role="capi">mysql_select_db()</function> fails unless
+ <literal role="cfunc">mysql_select_db()</literal> fails unless
the connected user can be authenticated as having permission to
use the database.
</para>
@@ -7099,7 +7099,7 @@
<section id="mysql-set-character-set">
- <title><function role="capi">mysql_set_character_set()</function></title>
+ <title><literal role="cfunc">mysql_set_character_set()</literal></title>
<indexterm>
<primary>mysql_set_character_set()</primary>
@@ -7122,7 +7122,7 @@
function works like the <literal>SET NAMES</literal> statement,
but also sets the value of <literal>mysql->charset</literal>,
and thus affects the character set used by
- <function role="capi">mysql_real_escape_string()</function>
+ <literal role="cfunc">mysql_real_escape_string()</literal>
</para>
<para>
@@ -7162,7 +7162,7 @@
<section id="mysql-set-local-infile-default">
- <title><function role="capi">mysql_set_local_infile_default()</function></title>
+ <title><literal role="cfunc">mysql_set_local_infile_default()</literal></title>
<indexterm>
<primary>mysql_set_local_infile_default()</primary>
@@ -7185,14 +7185,14 @@
Sets the <literal>LOAD LOCAL DATA INFILE</literal> handler
callback functions to the defaults used internally by the C
client library. The library calls this function automatically if
- <function role="capi">mysql_set_local_infile_handler()</function>
+ <literal role="cfunc">mysql_set_local_infile_handler()</literal>
has not been called or does not supply valid functions for each
of its callbacks.
</para>
<para>
The
- <function role="capi">mysql_set_local_infile_default()</function>
+ <literal role="cfunc">mysql_set_local_infile_default()</literal>
function was added in MySQL 4.1.2.
</para>
@@ -7216,7 +7216,7 @@
<section id="mysql-set-local-infile-handler">
- <title><function role="capi">mysql_set_local_infile_handler()</function></title>
+ <title><literal role="cfunc">mysql_set_local_infile_handler()</literal></title>
<para>
<literal>void mysql_set_local_infile_handler(MYSQL *mysql, int
@@ -7242,7 +7242,7 @@
<para>
To use
- <function role="capi">mysql_set_local_infile_handler()</function>,
+ <literal role="cfunc">mysql_set_local_infile_handler()</literal>,
you must write the following callback functions:
</para>
@@ -7261,7 +7261,7 @@
callbacks can use this pointed-to value to maintain state
information. The <literal>userdata</literal> argument is the
same value that is passed to
- <function role="capi">mysql_set_local_infile_handler()</function>.
+ <literal role="cfunc">mysql_set_local_infile_handler()</literal>.
</para>
<para>
@@ -7334,11 +7334,11 @@
<para>
After calling
- <function role="capi">mysql_set_local_infile_handler()</function>
+ <literal role="cfunc">mysql_set_local_infile_handler()</literal>
in your C code and passing pointers to your callback functions,
you can then issue a <literal>LOAD DATA LOCAL INFILE</literal>
statement (for example, by using
- <function role="capi">mysql_query()</function>). The client
+ <literal role="cfunc">mysql_query()</literal>). The client
library automatically invokes your callbacks. The filename
specified in <literal>LOAD DATA LOCAL INFILE</literal> will be
passed as the second parameter to the
@@ -7347,7 +7347,7 @@
<para>
The
- <function role="capi">mysql_set_local_infile_handler()</function>
+ <literal role="cfunc">mysql_set_local_infile_handler()</literal>
function was added in MySQL 4.1.2.
</para>
@@ -7371,7 +7371,7 @@
<section id="mysql-set-server-option">
- <title><function role="capi">mysql_set_server_option()</function></title>
+ <title><literal role="cfunc">mysql_set_server_option()</literal></title>
<indexterm>
<primary>mysql_set_server_option()</primary>
@@ -7411,10 +7411,10 @@
<para>
If you enable multiple-statement support, you should retrieve
results from calls to
- <function role="capi">mysql_query()</function> or
- <function role="capi">mysql_real_query()</function> by using a
+ <literal role="cfunc">mysql_query()</literal> or
+ <literal role="cfunc">mysql_real_query()</literal> by using a
loop that calls
- <function role="capi">mysql_next_result()</function> to
+ <literal role="cfunc">mysql_next_result()</literal> to
determine whether there are more results. For an example, see
<xref linkend="c-api-multiple-queries"/>.
</para>
@@ -7424,7 +7424,7 @@
<literal>MYSQL_OPTION_MULTI_STATEMENTS_ON</literal> does not
have quite the same effect as enabling it by passing the
<literal>CLIENT_MULTI_STATEMENTS</literal> flag to
- <function role="capi">mysql_real_connect()</function>:
+ <literal role="cfunc">mysql_real_connect()</literal>:
<literal>CLIENT_MULTI_STATEMENTS</literal> also enables
<literal>CLIENT_MULTI_RESULTS</literal>.
</para>
@@ -7484,7 +7484,7 @@
<para>
The server didn't support
- <function role="capi">mysql_set_server_option()</function>
+ <literal role="cfunc">mysql_set_server_option()</literal>
(which is the case that the server is older than 4.1.1) or
the server didn't support the option one tried to set.
</para>
@@ -7496,7 +7496,7 @@
<section id="mysql-shutdown">
- <title><function role="capi">mysql_shutdown()</function></title>
+ <title><literal role="cfunc">mysql_shutdown()</literal></title>
<indexterm>
<primary>mysql_shutdown()</primary>
@@ -7521,7 +7521,7 @@
are planned to make it possible to choose the desired level.
Dynamically linked executables which have been compiled with
older versions of the <literal>libmysqlclient</literal> headers
- and call <function role="capi">mysql_shutdown()</function> need
+ and call <literal role="cfunc">mysql_shutdown()</literal> need
to be used with the old <literal>libmysqlclient</literal>
dynamic library.
</para>
@@ -7591,7 +7591,7 @@
<section id="mysql-sqlstate">
- <title><function role="capi">mysql_sqlstate()</function></title>
+ <title><literal role="cfunc">mysql_sqlstate()</literal></title>
<indexterm>
<primary>mysql_sqlstate()</primary>
@@ -7616,14 +7616,14 @@
<para>
SQLSTATE values returned by
- <function role="capi">mysql_sqlstate()</function> differ from
+ <literal role="cfunc">mysql_sqlstate()</literal> differ from
MySQL-specific error numbers returned by
- <function role="capi">mysql_errno()</function>. For example, the
+ <literal role="cfunc">mysql_errno()</literal>. For example, the
<command>mysql</command> client program displays errors using
the following format, where <literal>1146</literal> is the
- <function role="capi">mysql_errno()</function> value and
+ <literal role="cfunc">mysql_errno()</literal> value and
<literal>'42S02'</literal> is the corresponding
- <function role="capi">mysql_sqlstate()</function> value:
+ <literal role="cfunc">mysql_sqlstate()</literal> value:
</para>
<programlisting>
@@ -7638,9 +7638,9 @@
</para>
<para>
- If you call <function role="capi">mysql_sqlstate()</function>
- after <function role="capi">mysql_real_connect()</function>
- fails, <function role="capi">mysql_sqlstate()</function> might
+ If you call <literal role="cfunc">mysql_sqlstate()</literal>
+ after <literal role="cfunc">mysql_real_connect()</literal>
+ fails, <literal role="cfunc">mysql_sqlstate()</literal> might
not return a useful value. For example, this happens if a host
is blocked by the server and the connection is closed without
any SQLSTATE value being sent to the client.
@@ -7673,7 +7673,7 @@
<section id="mysql-ssl-set">
- <title><function role="capi">mysql_ssl_set()</function></title>
+ <title><literal role="cfunc">mysql_ssl_set()</literal></title>
<indexterm>
<primary>mysql_ssl_set()</primary>
@@ -7690,19 +7690,19 @@
</para>
<para>
- <function role="capi">mysql_ssl_set()</function> is used for
+ <literal role="cfunc">mysql_ssl_set()</literal> is used for
establishing secure connections using SSL. It must be called
- before <function role="capi">mysql_real_connect()</function>.
+ before <literal role="cfunc">mysql_real_connect()</literal>.
</para>
<para>
- <function role="capi">mysql_ssl_set()</function> does nothing
+ <literal role="cfunc">mysql_ssl_set()</literal> does nothing
unless OpenSSL support is enabled in the client library.
</para>
<para>
<literal>mysql</literal> is the connection handler returned from
- <function role="capi">mysql_init()</function>. The other
+ <literal role="cfunc">mysql_init()</literal>. The other
parameters are specified as follows:
</para>
@@ -7756,7 +7756,7 @@
<para>
This function always returns <literal>0</literal>. If SSL setup
is incorrect,
- <function role="capi">mysql_real_connect()</function> returns an
+ <literal role="cfunc">mysql_real_connect()</literal> returns an
error when you attempt to connect.
</para>
@@ -7764,7 +7764,7 @@
<section id="mysql-stat">
- <title><function role="capi">mysql_stat()</function></title>
+ <title><literal role="cfunc">mysql_stat()</literal></title>
<indexterm>
<primary>mysql_stat()</primary>
@@ -7846,7 +7846,7 @@
<section id="mysql-store-result">
- <title><function role="capi">mysql_store_result()</function></title>
+ <title><literal role="cfunc">mysql_store_result()</literal></title>
<indexterm>
<primary>mysql_store_result()</primary>
@@ -7861,38 +7861,38 @@
</para>
<para>
- After invoking <function role="capi">mysql_query()</function> or
- <function role="capi">mysql_real_query()</function>, you must
- call <function role="capi">mysql_store_result()</function> or
- <function role="capi">mysql_use_result()</function> for every
+ After invoking <literal role="cfunc">mysql_query()</literal> or
+ <literal role="cfunc">mysql_real_query()</literal>, you must
+ call <literal role="cfunc">mysql_store_result()</literal> or
+ <literal role="cfunc">mysql_use_result()</literal> for every
statement that successfully produces a result set
(<literal>SELECT</literal>, <literal>SHOW</literal>,
<literal>DESCRIBE</literal>, <literal>EXPLAIN</literal>,
<literal>CHECK TABLE</literal>, and so forth). You must also
- call <function role="capi">mysql_free_result()</function> after
+ call <literal role="cfunc">mysql_free_result()</literal> after
you are done with the result set.
</para>
<para>
You don't have to call
- <function role="capi">mysql_store_result()</function> or
- <function role="capi">mysql_use_result()</function> for other
+ <literal role="cfunc">mysql_store_result()</literal> or
+ <literal role="cfunc">mysql_use_result()</literal> for other
statements, but it does not do any harm or cause any notable
performance degradation if you call
- <function role="capi">mysql_store_result()</function> in all
+ <literal role="cfunc">mysql_store_result()</literal> in all
cases. You can detect whether the statement has a result set by
checking whether
- <function role="capi">mysql_store_result()</function> returns a
+ <literal role="cfunc">mysql_store_result()</literal> returns a
non-zero value (more about this later on).
</para>
<para>
If you enable multiple-statement support, you should retrieve
results from calls to
- <function role="capi">mysql_query()</function> or
- <function role="capi">mysql_real_query()</function> by using a
+ <literal role="cfunc">mysql_query()</literal> or
+ <literal role="cfunc">mysql_real_query()</literal> by using a
loop that calls
- <function role="capi">mysql_next_result()</function> to
+ <literal role="cfunc">mysql_next_result()</literal> to
determine whether there are more results. For an example, see
<xref linkend="c-api-multiple-queries"/>.
</para>
@@ -7900,31 +7900,31 @@
<para>
If you want to know whether a statement should return a result
set, you can use
- <function role="capi">mysql_field_count()</function> to check
+ <literal role="cfunc">mysql_field_count()</literal> to check
for this. See <xref linkend="mysql-field-count"/>.
</para>
<para>
- <function role="capi">mysql_store_result()</function> reads the
+ <literal role="cfunc">mysql_store_result()</literal> reads the
entire result of a query to the client, allocates a
<literal>MYSQL_RES</literal> structure, and places the result
into this structure.
</para>
<para>
- <function role="capi">mysql_store_result()</function> returns a
+ <literal role="cfunc">mysql_store_result()</literal> returns a
null pointer if the statement didn't return a result set (for
example, if it was an <literal>INSERT</literal> statement).
</para>
<para>
- <function role="capi">mysql_store_result()</function> also
+ <literal role="cfunc">mysql_store_result()</literal> also
returns a null pointer if reading of the result set failed. You
can check whether an error occurred by checking whether
- <function role="capi">mysql_error()</function> returns a
- non-empty string, <function role="capi">mysql_errno()</function>
+ <literal role="cfunc">mysql_error()</literal> returns a
+ non-empty string, <literal role="cfunc">mysql_errno()</literal>
returns non-zero, or
- <function role="capi">mysql_field_count()</function> returns
+ <literal role="cfunc">mysql_field_count()</literal> returns
zero.
</para>
@@ -7936,17 +7936,17 @@
<para>
After you have called
- <function role="capi">mysql_store_result()</function> and gotten
+ <literal role="cfunc">mysql_store_result()</literal> and gotten
back a result that isn't a null pointer, you can call
- <function role="capi">mysql_num_rows()</function> to find out
+ <literal role="cfunc">mysql_num_rows()</literal> to find out
how many rows are in the result set.
</para>
<para>
- You can call <function role="capi">mysql_fetch_row()</function>
+ You can call <literal role="cfunc">mysql_fetch_row()</literal>
to fetch rows from the result set, or
- <function role="capi">mysql_row_seek()</function> and
- <function role="capi">mysql_row_tell()</function> to obtain or
+ <literal role="cfunc">mysql_row_seek()</literal> and
+ <literal role="cfunc">mysql_row_tell()</literal> to obtain or
set the current row position within the result set.
</para>
@@ -7968,9 +7968,9 @@
</para>
<para>
- <function role="capi">mysql_store_result()</function> resets
- <function role="capi">mysql_error()</function> and
- <function role="capi">mysql_errno()</function> if it succeeds.
+ <literal role="cfunc">mysql_store_result()</literal> resets
+ <literal role="cfunc">mysql_error()</literal> and
+ <literal role="cfunc">mysql_errno()</literal> if it succeeds.
</para>
<itemizedlist>
@@ -8031,7 +8031,7 @@
<section id="mysql-thread-id">
- <title><function role="capi">mysql_thread_id()</function></title>
+ <title><literal role="cfunc">mysql_thread_id()</literal></title>
<indexterm>
<primary>mysql_thread_id()</primary>
@@ -8048,13 +8048,13 @@
<para>
Returns the thread ID of the current connection. This value can
be used as an argument to
- <function role="capi">mysql_kill()</function> to kill the
+ <literal role="cfunc">mysql_kill()</literal> to kill the
thread.
</para>
<para>
If the connection is lost and you reconnect with
- <function role="capi">mysql_ping()</function>, the thread ID
+ <literal role="cfunc">mysql_ping()</literal>, the thread ID
changes. This means you should not get the thread ID and store
it for later. You should get it when you need it.
</para>
@@ -8079,7 +8079,7 @@
<section id="mysql-use-result">
- <title><function role="capi">mysql_use_result()</function></title>
+ <title><literal role="cfunc">mysql_use_result()</literal></title>
<indexterm>
<primary>mysql_use_result()</primary>
@@ -8094,29 +8094,29 @@
</para>
<para>
- After invoking <function role="capi">mysql_query()</function> or
- <function role="capi">mysql_real_query()</function>, you must
- call <function role="capi">mysql_store_result()</function> or
- <function role="capi">mysql_use_result()</function> for every
+ After invoking <literal role="cfunc">mysql_query()</literal> or
+ <literal role="cfunc">mysql_real_query()</literal>, you must
+ call <literal role="cfunc">mysql_store_result()</literal> or
+ <literal role="cfunc">mysql_use_result()</literal> for every
statement that successfully produces a result set
(<literal>SELECT</literal>, <literal>SHOW</literal>,
<literal>DESCRIBE</literal>, <literal>EXPLAIN</literal>,
<literal>CHECK TABLE</literal>, and so forth). You must also
- call <function role="capi">mysql_free_result()</function> after
+ call <literal role="cfunc">mysql_free_result()</literal> after
you are done with the result set.
</para>
<para>
- <function role="capi">mysql_use_result()</function> initiates a
+ <literal role="cfunc">mysql_use_result()</literal> initiates a
result set retrieval but does not actually read the result set
into the client like
- <function role="capi">mysql_store_result()</function> does.
+ <literal role="cfunc">mysql_store_result()</literal> does.
Instead, each row must be retrieved individually by making calls
- to <function role="capi">mysql_fetch_row()</function>. This
+ to <literal role="cfunc">mysql_fetch_row()</literal>. This
reads the result of a query directly from the server without
storing it in a temporary table or local buffer, which is
somewhat faster and uses much less memory than
- <function role="capi">mysql_store_result()</function>. The
+ <literal role="cfunc">mysql_store_result()</literal>. The
client allocates memory only for the current row and a
communication buffer that may grow up to
<literal>max_allowed_packet</literal> bytes.
@@ -8124,7 +8124,7 @@
<para>
On the other hand, you shouldn't use
- <function role="capi">mysql_use_result()</function> if you are
+ <literal role="cfunc">mysql_use_result()</literal> if you are
doing a lot of processing for each row on the client side, or if
the output is sent to a screen on which the user may type a
<literal>^S</literal> (stop scroll). This ties up the server and
@@ -8133,9 +8133,9 @@
</para>
<para>
- When using <function role="capi">mysql_use_result()</function>,
+ When using <literal role="cfunc">mysql_use_result()</literal>,
you must execute
- <function role="capi">mysql_fetch_row()</function> until a
+ <literal role="cfunc">mysql_fetch_row()</literal> until a
<literal>NULL</literal> value is returned, otherwise, the
unfetched rows are returned as part of the result set for your
next query. The C API gives the error <literal>Commands out of
@@ -8145,23 +8145,23 @@
<para>
You may not use
- <function role="capi">mysql_data_seek()</function>,
- <function role="capi">mysql_row_seek()</function>,
- <function role="capi">mysql_row_tell()</function>,
- <function role="capi">mysql_num_rows()</function>, or
- <function role="capi">mysql_affected_rows()</function> with a
+ <literal role="cfunc">mysql_data_seek()</literal>,
+ <literal role="cfunc">mysql_row_seek()</literal>,
+ <literal role="cfunc">mysql_row_tell()</literal>,
+ <literal role="cfunc">mysql_num_rows()</literal>, or
+ <literal role="cfunc">mysql_affected_rows()</literal> with a
result returned from
- <function role="capi">mysql_use_result()</function>, nor may you
+ <literal role="cfunc">mysql_use_result()</literal>, nor may you
issue other queries until
- <function role="capi">mysql_use_result()</function> has
+ <literal role="cfunc">mysql_use_result()</literal> has
finished. (However, after you have fetched all the rows,
- <function role="capi">mysql_num_rows()</function> accurately
+ <literal role="cfunc">mysql_num_rows()</literal> accurately
returns the number of rows fetched.)
</para>
<para>
You must call
- <function role="capi">mysql_free_result()</function> once you
+ <literal role="cfunc">mysql_free_result()</literal> once you
are done with the result set.
</para>
@@ -8169,7 +8169,7 @@
When using the <literal>libmysqld</literal> embedded server, the
memory benefits are essentially lost because memory usage
incrementally increases with each row retrieved until
- <function role="capi">mysql_free_result()</function> is called.
+ <literal role="cfunc">mysql_free_result()</literal> is called.
</para>
<para>
@@ -8186,9 +8186,9 @@
</para>
<para>
- <function role="capi">mysql_use_result()</function> resets
- <function role="capi">mysql_error()</function> and
- <function role="capi">mysql_errno()</function> if it succeeds.
+ <literal role="cfunc">mysql_use_result()</literal> resets
+ <literal role="cfunc">mysql_error()</literal> and
+ <literal role="cfunc">mysql_errno()</literal> if it succeeds.
</para>
<itemizedlist>
@@ -8249,7 +8249,7 @@
<section id="mysql-warning-count">
- <title><function role="capi">mysql_warning_count()</function></title>
+ <title><literal role="cfunc">mysql_warning_count()</literal></title>
<indexterm>
<primary>mysql_warning_count()</primary>
@@ -8301,7 +8301,7 @@
As of MySQL 4.1, the client/server protocol provides for the use
of prepared statements. This capability uses the
<literal>MYSQL_STMT</literal> statement handler data structure
- returned by the <function role="capi">mysql_stmt_init()</function>
+ returned by the <literal role="cfunc">mysql_stmt_init()</literal>
initialization function. Prepared execution is an efficient way to
execute a statement more than once. The statement is first parsed
to prepare it for execution. Then it is executed one or more times
@@ -8382,7 +8382,7 @@
<listitem>
<para>
To prepare a statement, pass the statement string to
- <function role="capi">mysql_stmt_init()</function>, which
+ <literal role="cfunc">mysql_stmt_init()</literal>, which
returns a pointer to a <literal>MYSQL_STMT</literal> data
structure.
</para>
@@ -8392,10 +8392,10 @@
<para>
To provide input parameters for a prepared statement, set up
<literal>MYSQL_BIND</literal> structures and pass them to
- <function role="capi">mysql_stmt_bind_param()</function>. To
+ <literal role="cfunc">mysql_stmt_bind_param()</literal>. To
receive output column values, set up
<literal>MYSQL_BIND</literal> structures and pass them to
- <function role="capi">mysql_stmt_bind_result()</function>.
+ <literal role="cfunc">mysql_stmt_bind_result()</literal>.
</para>
</listitem>
@@ -8427,11 +8427,11 @@
<para>
This structure represents a prepared statement. A statement is
created by calling
- <function role="capi">mysql_stmt_init()</function>, which
+ <literal role="cfunc">mysql_stmt_init()</literal>, which
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 <function role="capi">mysql_stmt_close()</function>, at
+ with <literal role="cfunc">mysql_stmt_close()</literal>, at
which point the handle becomes invalid.
</para>
@@ -8470,18 +8470,18 @@
<listitem>
<para>
For input, <literal>MYSQL_BIND</literal> is used with
- <function role="capi">mysql_stmt_bind_param()</function>
+ <literal role="cfunc">mysql_stmt_bind_param()</literal>
to bind parameter data values to buffers for use by
- <function role="capi">mysql_stmt_execute()</function>.
+ <literal role="cfunc">mysql_stmt_execute()</literal>.
</para>
</listitem>
<listitem>
<para>
For output, <literal>MYSQL_BIND</literal> is used with
- <function role="capi">mysql_stmt_bind_result()</function>
+ <literal role="cfunc">mysql_stmt_bind_result()</literal>
to bind result set buffers for use in fetching rows with
- <function role="capi">mysql_stmt_fetch()</function>.
+ <literal role="cfunc">mysql_stmt_fetch()</literal>.
</para>
</listitem>
@@ -8541,7 +8541,7 @@
For input, <literal>buffer</literal> is a pointer to the
variable in which a statement parameter's data value is
stored. When you call
- <function role="capi">mysql_stmt_execute()</function>,
+ <literal role="cfunc">mysql_stmt_execute()</literal>,
MySQL takes the value that you have stored in the variable
and uses it in place of the corresponding parameter marker
in the statement.
@@ -8551,7 +8551,7 @@
For output, <literal>buffer</literal> is a pointer to the
variable in which to return a result set column value.
When you call
- <function role="capi">mysql_stmt_fetch()</function>, MySQL
+ <literal role="cfunc">mysql_stmt_fetch()</literal>, MySQL
returns a column value and stores it in this variable. You
can access the value when the call returns.
</para>
@@ -8590,11 +8590,11 @@
stored in the buffer. For character and binary C data, the
<literal>buffer_length</literal> value specifies the
length of <literal>*buffer</literal> when used with
- <function role="capi">mysql_stmt_bind_param()</function>
+ <literal role="cfunc">mysql_stmt_bind_param()</literal>
to specify input values, or the maximum number of output
data bytes that can be fetched into the buffer when used
with
- <function role="capi">mysql_stmt_bind_result()</function>.
+ <literal role="cfunc">mysql_stmt_bind_result()</literal>.
</para>
</listitem>
@@ -8616,12 +8616,12 @@
long</literal> variable that indicates the actual length
of the parameter value stored in
<literal>*buffer</literal>; this is used by
- <function role="capi">mysql_stmt_execute()</function>.
+ <literal role="cfunc">mysql_stmt_execute()</literal>.
</para>
<para>
For output value binding, the return value of
- <function role="capi">mysql_stmt_fetch()</function>
+ <literal role="cfunc">mysql_stmt_fetch()</literal>
determines the interpretation of the length:
</para>
@@ -8629,7 +8629,7 @@
<listitem>
<para>
- If <function role="capi">mysql_stmt_fetch()</function>
+ If <literal role="cfunc">mysql_stmt_fetch()</literal>
returns 0, <literal>*length</literal> indicates the
actual length of the parameter value.
</para>
@@ -8637,7 +8637,7 @@
<listitem>
<para>
- If <function role="capi">mysql_stmt_fetch()</function>
+ If <literal role="cfunc">mysql_stmt_fetch()</literal>
returns <literal>MYSQL_DATA_TRUNCATED</literal>,
<literal>*length</literal> indicates the non-truncated
length of the parameter value. In this case, the
@@ -8658,7 +8658,7 @@
<para>
If you need to be able to determine the length of a
returned value before fetching it with
- <function role="capi">mysql_stmt_fetch()</function>, see
+ <literal role="cfunc">mysql_stmt_fetch()</literal>, see
<xref linkend="mysql-stmt-fetch"/>, for some strategies.
</para>
</listitem>
@@ -9144,10 +9144,10 @@
<literal>'12.345'</literal>. If you specify
<literal>MYSQL_TYPE_NEWDECIMAL</literal> and bind a string
buffer to the <literal>MYSQL_BIND</literal> structure,
- <function role="capi">mysql_stmt_fetch()</function> stores the
+ <literal role="cfunc">mysql_stmt_fetch()</literal> stores the
value in the buffer without conversion. If instead you specify
a numeric variable and type code,
- <function role="capi">mysql_stmt_fetch()</function> converts
+ <literal role="cfunc">mysql_stmt_fetch()</literal> converts
the string-format <literal>DECIMAL</literal> value to numeric
form.
</para>
@@ -9185,9 +9185,9 @@
check the type codes for each column of the result set. This might
be desirable if you want to determine which variable types would
be best to use to avoid type conversions. To get the type codes,
- call <function role="capi">mysql_stmt_result_metadata()</function>
+ call <literal role="cfunc">mysql_stmt_result_metadata()</literal>
after executing the prepared statement with
- <function role="capi">mysql_stmt_execute()</function>. The
+ <literal role="cfunc">mysql_stmt_execute()</literal>. The
metadata provides access to the type codes for the result set as
described in <xref linkend="mysql-stmt-result-metadata"/>, and
<xref linkend="c-api-datatypes"/>.
@@ -9197,7 +9197,7 @@
If you cause the <literal>max_length</literal> member of the
<literal>MYSQL_FIELD</literal> column metadata structures to be
set (by calling
- <function role="capi">mysql_stmt_attr_set()</function>), be aware
+ <literal role="cfunc">mysql_stmt_attr_set()</literal>), be aware
that the <literal>max_length</literal> values for the result set
indicate the lengths of the longest string representation of the
result values, not the lengths of the binary representation. That
@@ -9274,120 +9274,120 @@
<entry><emphasis role="bold">Description</emphasis></entry>
</row>
<row>
- <entry><function role="capi">mysql_stmt_affected_rows()</function></entry>
+ <entry><literal role="cfunc">mysql_stmt_affected_rows()</literal></entry>
<entry>Returns the number of rows changed, deleted, or inserted by prepared
<literal>UPDATE</literal>, <literal>DELETE</literal>, or
<literal>INSERT</literal> statement</entry>
</row>
<row>
- <entry><function role="capi">mysql_stmt_attr_get()</function></entry>
+ <entry><literal role="cfunc">mysql_stmt_attr_get()</literal></entry>
<entry>Get value of an attribute for a prepared statement</entry>
</row>
<row>
- <entry><function role="capi">mysql_stmt_attr_set()</function></entry>
+ <entry><literal role="cfunc">mysql_stmt_attr_set()</literal></entry>
<entry>Sets an attribute for a prepared statement</entry>
</row>
<row>
- <entry><function role="capi">mysql_stmt_bind_param()</function></entry>
+ <entry><literal role="cfunc">mysql_stmt_bind_param()</literal></entry>
<entry>Associates application data buffers with the parameter markers in a
prepared SQL statement</entry>
</row>
<row>
- <entry><function role="capi">mysql_stmt_bind_result()</function></entry>
+ <entry><literal role="cfunc">mysql_stmt_bind_result()</literal></entry>
<entry>Associates application data buffers with columns in the result set</entry>
</row>
<row>
- <entry><function role="capi">mysql_stmt_close()</function></entry>
+ <entry><literal role="cfunc">mysql_stmt_close()</literal></entry>
<entry>Frees memory used by prepared statement</entry>
</row>
<row>
- <entry><function role="capi">mysql_stmt_data_seek()</function></entry>
+ <entry><literal role="cfunc">mysql_stmt_data_seek()</literal></entry>
<entry>Seeks to an arbitrary row number in a statement result set</entry>
</row>
<row>
- <entry><function role="capi">mysql_stmt_errno()</function></entry>
+ <entry><literal role="cfunc">mysql_stmt_errno()</literal></entry>
<entry>Returns the error number for the last statement execution</entry>
</row>
<row>
- <entry><function role="capi">mysql_stmt_error()</function></entry>
+ <entry><literal role="cfunc">mysql_stmt_error()</literal></entry>
<entry>Returns the error message for the last statement execution</entry>
</row>
<row>
- <entry><function role="capi">mysql_stmt_execute()</function></entry>
+ <entry><literal role="cfunc">mysql_stmt_execute()</literal></entry>
<entry>Executes the prepared statement</entry>
</row>
<row>
- <entry><function role="capi">mysql_stmt_fetch()</function></entry>
+ <entry><literal role="cfunc">mysql_stmt_fetch()</literal></entry>
<entry>Fetches the next row of data from the result set and returns data for
all bound columns</entry>
</row>
<row>
- <entry><function role="capi">mysql_stmt_fetch_column()</function></entry>
+ <entry><literal role="cfunc">mysql_stmt_fetch_column()</literal></entry>
<entry>Fetch data for one column of the current row of the result set</entry>
</row>
<row>
- <entry><function role="capi">mysql_stmt_field_count()</function></entry>
+ <entry><literal role="cfunc">mysql_stmt_field_count()</literal></entry>
<entry>Returns the number of result columns for the most recent statement</entry>
</row>
<row>
- <entry><function role="capi">mysql_stmt_free_result()</function></entry>
+ <entry><literal role="cfunc">mysql_stmt_free_result()</literal></entry>
<entry>Free the resources allocated to the statement handle</entry>
</row>
<row>
- <entry><function role="capi">mysql_stmt_init()</function></entry>
+ <entry><literal role="cfunc">mysql_stmt_init()</literal></entry>
<entry>Allocates memory for <literal>MYSQL_STMT</literal> structure and
initializes it</entry>
</row>
<row>
- <entry><function role="capi">mysql_stmt_insert_id()</function></entry>
+ <entry><literal role="cfunc">mysql_stmt_insert_id()</literal></entry>
<entry>Returns the ID generated for an <literal>AUTO_INCREMENT</literal> column
by prepared statement</entry>
</row>
<row>
- <entry><function role="capi">mysql_stmt_num_rows()</function></entry>
+ <entry><literal role="cfunc">mysql_stmt_num_rows()</literal></entry>
<entry>Returns total row count from the buffered statement result set</entry>
</row>
<row>
- <entry><function role="capi">mysql_stmt_param_count()</function></entry>
+ <entry><literal role="cfunc">mysql_stmt_param_count()</literal></entry>
<entry>Returns the number of parameters in a prepared SQL statement</entry>
</row>
<row>
- <entry><function role="capi">mysql_stmt_param_metadata()</function></entry>
+ <entry><literal role="cfunc">mysql_stmt_param_metadata()</literal></entry>
<entry>(Return parameter metadata in the form of a result set.) Currently, this
function does nothing</entry>
</row>
<row>
- <entry><function role="capi">mysql_stmt_prepare()</function></entry>
+ <entry><literal role="cfunc">mysql_stmt_prepare()</literal></entry>
<entry>Prepares an SQL string for execution</entry>
</row>
<row>
- <entry><function role="capi">mysql_stmt_reset()</function></entry>
+ <entry><literal role="cfunc">mysql_stmt_reset()</literal></entry>
<entry>Reset the statement buffers in the server</entry>
</row>
<row>
- <entry><function role="capi">mysql_stmt_result_metadata()</function></entry>
+ <entry><literal role="cfunc">mysql_stmt_result_metadata()</literal></entry>
<entry>Returns prepared statement metadata in the form of a result set</entry>
</row>
<row>
- <entry><function role="capi">mysql_stmt_row_seek()</function></entry>
+ <entry><literal role="cfunc">mysql_stmt_row_seek()</literal></entry>
<entry>Seeks to a row offset in a statement result set, using value returned
from
- <function role="capi">mysql_stmt_row_tell()</function></entry>
+ <literal role="cfunc">mysql_stmt_row_tell()</literal></entry>
</row>
<row>
- <entry><function role="capi">mysql_stmt_row_tell()</function></entry>
+ <entry><literal role="cfunc">mysql_stmt_row_tell()</literal></entry>
<entry>Returns the statement row cursor position</entry>
</row>
<row>
- <entry><function role="capi">mysql_stmt_send_long_data()</function></entry>
+ <entry><literal role="cfunc">mysql_stmt_send_long_data()</literal></entry>
<entry>Sends long data in chunks to server</entry>
</row>
<row>
- <entry><function role="capi">mysql_stmt_sqlstate()</function></entry>
+ <entry><literal role="cfunc">mysql_stmt_sqlstate()</literal></entry>
<entry>Returns the SQLSTATE error code for the last statement execution</entry>
</row>
<row>
- <entry><function role="capi">mysql_stmt_store_result()</function></entry>
+ <entry><literal role="cfunc">mysql_stmt_store_result()</literal></entry>
<entry>Retrieves the complete result set to the client</entry>
</row>
</tbody>
@@ -9395,31 +9395,31 @@
</informaltable>
<para>
- Call <function role="capi">mysql_stmt_init()</function> to create
+ Call <literal role="cfunc">mysql_stmt_init()</literal> to create
a statement handle, then
- <function role="capi">mysql_stmt_prepare()</function> to prepare
- it, <function role="capi">mysql_stmt_bind_param()</function> to
+ <literal role="cfunc">mysql_stmt_prepare()</literal> to prepare
+ it, <literal role="cfunc">mysql_stmt_bind_param()</literal> to
supply the parameter data, and
- <function role="capi">mysql_stmt_execute()</function> to execute
+ <literal role="cfunc">mysql_stmt_execute()</literal> to execute
the statement. You can repeat the
- <function role="capi">mysql_stmt_execute()</function> by changing
+ <literal role="cfunc">mysql_stmt_execute()</literal> by changing
parameter values in the respective buffers supplied through
- <function role="capi">mysql_stmt_bind_param()</function>.
+ <literal role="cfunc">mysql_stmt_bind_param()</literal>.
</para>
<para>
If the statement is a <literal>SELECT</literal> or any other
statement that produces a result set,
- <function role="capi">mysql_stmt_prepare()</function> also returns
+ <literal role="cfunc">mysql_stmt_prepare()</literal> also returns
the result set metadata information in the form of a
<literal>MYSQL_RES</literal> result set through
- <function role="capi">mysql_stmt_result_metadata()</function>.
+ <literal role="cfunc">mysql_stmt_result_metadata()</literal>.
</para>
<para>
You can supply the result buffers using
- <function role="capi">mysql_stmt_bind_result()</function>, so that
- the <function role="capi">mysql_stmt_fetch()</function>
+ <literal role="cfunc">mysql_stmt_bind_result()</literal>, so that
+ the <literal role="cfunc">mysql_stmt_fetch()</literal>
automatically returns data to these buffers. This is row-by-row
fetching.
</para>
@@ -9427,23 +9427,23 @@
<para>
You can also send the text or binary data in chunks to server
using
- <function role="capi">mysql_stmt_send_long_data()</function>. See
+ <literal role="cfunc">mysql_stmt_send_long_data()</literal>. See
<xref linkend="mysql-stmt-send-long-data"/>.
</para>
<para>
When statement execution has been completed, the statement handle
must be closed using
- <function role="capi">mysql_stmt_close()</function> so that all
+ <literal role="cfunc">mysql_stmt_close()</literal> so that all
resources associated with it can be freed.
</para>
<para>
If you obtained a <literal>SELECT</literal> statement's result set
metadata by calling
- <function role="capi">mysql_stmt_result_metadata()</function>, you
+ <literal role="cfunc">mysql_stmt_result_metadata()</literal>, you
should also free the metadata using
- <function role="capi">mysql_free_result()</function>.
+ <literal role="cfunc">mysql_free_result()</literal>.
</para>
<para>
@@ -9460,9 +9460,9 @@
<listitem>
<para>
Create a prepared statement handle with
- <function role="capi">mysql_stmt_init()</function>. To prepare
+ <literal role="cfunc">mysql_stmt_init()</literal>. To prepare
the statement on the server, call
- <function role="capi">mysql_stmt_prepare()</function> and pass
+ <literal role="cfunc">mysql_stmt_prepare()</literal> and pass
it a string containing the SQL statement.
</para>
</listitem>
@@ -9470,7 +9470,7 @@
<listitem>
<para>
If the statement produces a result set, call
- <function role="capi">mysql_stmt_result_metadata()</function>
+ <literal role="cfunc">mysql_stmt_result_metadata()</literal>
to obtain the result set metadata. This metadata is itself in
the form of result set, albeit a separate one from the one
that contains the rows returned by the query. The metadata
@@ -9482,7 +9482,7 @@
<listitem>
<para>
Set the values of any parameters using
- <function role="capi">mysql_stmt_bind_param()</function>. All
+ <literal role="cfunc">mysql_stmt_bind_param()</literal>. All
parameters must be set. Otherwise, statement execution returns
an error or produces unexpected results.
</para>
@@ -9490,7 +9490,7 @@
<listitem>
<para>
- Call <function role="capi">mysql_stmt_execute()</function> to
+ Call <literal role="cfunc">mysql_stmt_execute()</literal> to
execute the statement.
</para>
</listitem>
@@ -9499,14 +9499,14 @@
<para>
If the statement produces a result set, bind the data buffers
to use for retrieving the row values by calling
- <function role="capi">mysql_stmt_bind_result()</function>.
+ <literal role="cfunc">mysql_stmt_bind_result()</literal>.
</para>
</listitem>
<listitem>
<para>
Fetch the data into the buffers row by row by calling
- <function role="capi">mysql_stmt_fetch()</function> repeatedly
+ <literal role="cfunc">mysql_stmt_fetch()</literal> repeatedly
until no more rows are found.
</para>
</listitem>
@@ -9521,7 +9521,7 @@
</orderedlist>
<para>
- When <function role="capi">mysql_stmt_prepare()</function> is
+ When <literal role="cfunc">mysql_stmt_prepare()</literal> is
called, the MySQL client/server protocol performs these actions:
</para>
@@ -9548,7 +9548,7 @@
</itemizedlist>
<para>
- When <function role="capi">mysql_stmt_execute()</function> is
+ When <literal role="cfunc">mysql_stmt_execute()</literal> is
called, the MySQL client/server protocol performs these actions:
</para>
@@ -9575,7 +9575,7 @@
</itemizedlist>
<para>
- When <function role="capi">mysql_stmt_fetch()</function> is
+ When <literal role="cfunc">mysql_stmt_fetch()</literal> is
called, the MySQL client/server protocol performs these actions:
</para>
@@ -9596,9 +9596,9 @@
<para>
If an error occurs, you can get the statement error code, error
message, and SQLSTATE value using
- <function role="capi">mysql_stmt_errno()</function>,
- <function role="capi">mysql_stmt_error()</function>, and
- <function role="capi">mysql_stmt_sqlstate()</function>,
+ <literal role="cfunc">mysql_stmt_errno()</literal>,
+ <literal role="cfunc">mysql_stmt_error()</literal>, and
+ <literal role="cfunc">mysql_stmt_sqlstate()</literal>,
respectively.
</para>
@@ -9608,8 +9608,8 @@
<para>
For prepared statements that are executed with the
- <function role="capi">mysql_stmt_prepare()</function> and
- <function role="capi">mysql_stmt_execute()</function> C API
+ <literal role="cfunc">mysql_stmt_prepare()</literal> and
+ <literal role="cfunc">mysql_stmt_execute()</literal> C API
functions, the server writes <literal>Prepare</literal> and
<literal>Execute</literal> lines to the general query log so that
you can tell when statements are prepared and executed.
@@ -9623,14 +9623,14 @@
<listitem>
<para>
- Call <function role="capi">mysql_stmt_prepare()</function> to
+ Call <literal role="cfunc">mysql_stmt_prepare()</literal> to
prepare the statement string <literal>"SELECT ?"</literal>.
</para>
</listitem>
<listitem>
<para>
- Call <function role="capi">mysql_stmt_bind_param()</function>
+ Call <literal role="cfunc">mysql_stmt_bind_param()</literal>
to bind the value <literal>3</literal> to the parameter in the
prepared statement.
</para>
@@ -9638,7 +9638,7 @@
<listitem>
<para>
- Call <function role="capi">mysql_stmt_execute()</function> to
+ Call <literal role="cfunc">mysql_stmt_execute()</literal> to
execute the prepared statement.
</para>
</listitem>
@@ -9704,43 +9704,43 @@
</row>
<row>
<entry><function>mysql_bind_param()</function></entry>
- <entry><function role="capi">mysql_stmt_bind_param()</function></entry>
+ <entry><literal role="cfunc">mysql_stmt_bind_param()</literal></entry>
</row>
<row>
<entry><function>mysql_bind_result()</function></entry>
- <entry><function role="capi">mysql_stmt_bind_result()</function></entry>
+ <entry><literal role="cfunc">mysql_stmt_bind_result()</literal></entry>
</row>
<row>
<entry><function>mysql_prepare()</function></entry>
- <entry><function role="capi">mysql_stmt_prepare()</function></entry>
+ <entry><literal role="cfunc">mysql_stmt_prepare()</literal></entry>
</row>
<row>
<entry><function>mysql_execute()</function></entry>
- <entry><function role="capi">mysql_stmt_execute()</function></entry>
+ <entry><literal role="cfunc">mysql_stmt_execute()</literal></entry>
</row>
<row>
<entry><function>mysql_fetch()</function></entry>
- <entry><function role="capi">mysql_stmt_fetch()</function></entry>
+ <entry><literal role="cfunc">mysql_stmt_fetch()</literal></entry>
</row>
<row>
<entry><function>mysql_fetch_column()</function></entry>
- <entry><function role="capi">mysql_stmt_fetch_column()</function></entry>
+ <entry><literal role="cfunc">mysql_stmt_fetch_column()</literal></entry>
</row>
<row>
<entry><function>mysql_param_count()</function></entry>
- <entry><function role="capi">mysql_stmt_param_count()</function></entry>
+ <entry><literal role="cfunc">mysql_stmt_param_count()</literal></entry>
</row>
<row>
<entry><function>mysql_param_result()</function></entry>
- <entry><function role="capi">mysql_stmt_param_metadata()</function></entry>
+ <entry><literal role="cfunc">mysql_stmt_param_metadata()</literal></entry>
</row>
<row>
<entry><function>mysql_get_metadata()</function></entry>
- <entry><function role="capi">mysql_stmt_result_metadata()</function></entry>
+ <entry><literal role="cfunc">mysql_stmt_result_metadata()</literal></entry>
</row>
<row>
<entry><function>mysql_send_long_data()</function></entry>
- <entry><function role="capi">mysql_stmt_send_long_data()</function></entry>
+ <entry><literal role="cfunc">mysql_stmt_send_long_data()</literal></entry>
</row>
</tbody>
</tgroup>
@@ -9753,16 +9753,16 @@
<para>
Also in 4.1.2, the signature of the
- <function role="capi">mysql_stmt_prepare()</function> function was
+ <literal role="cfunc">mysql_stmt_prepare()</literal> function was
changed to <literal>int mysql_stmt_prepare(MYSQL_STMT *stmt, const
char *query, unsigned long length)</literal>. To create a
<literal>MYSQL_STMT</literal> handle, you should use the
- <function role="capi">mysql_stmt_init()</function> function.
+ <literal role="cfunc">mysql_stmt_init()</literal> function.
</para>
<section id="mysql-stmt-affected-rows">
- <title><function role="capi">mysql_stmt_affected_rows()</function></title>
+ <title><literal role="cfunc">mysql_stmt_affected_rows()</literal></title>
<indexterm>
<primary>mysql_stmt_affected_rows()</primary>
@@ -9780,12 +9780,12 @@
<para>
Returns the total number of rows changed, deleted, or inserted
by the last executed statement. May be called immediately after
- <function role="capi">mysql_stmt_execute()</function> for
+ <literal role="cfunc">mysql_stmt_execute()</literal> for
<literal>UPDATE</literal>, <literal>DELETE</literal>, or
<literal>INSERT</literal> statements. For
<literal>SELECT</literal> statements,
- <function role="capi">mysql_stmt_affected_rows()</function>
- works like <function role="capi">mysql_num_rows()</function>.
+ <literal role="cfunc">mysql_stmt_affected_rows()</literal>
+ works like <literal role="cfunc">mysql_num_rows()</literal>.
</para>
<para>
@@ -9804,11 +9804,11 @@
that no query has yet been executed. -1 indicates that the query
returned an error or that, for a <literal>SELECT</literal>
query,
- <function role="capi">mysql_stmt_affected_rows()</function> was
+ <literal role="cfunc">mysql_stmt_affected_rows()</literal> was
called prior to calling
- <function role="capi">mysql_stmt_store_result()</function>.
+ <literal role="cfunc">mysql_stmt_store_result()</literal>.
Because
- <function role="capi">mysql_stmt_affected_rows()</function>
+ <literal role="cfunc">mysql_stmt_affected_rows()</literal>
returns an unsigned value, you can check for -1 by comparing the
return value to <literal>(my_ulonglong)-1</literal> (or to
<literal>(my_ulonglong)~0</literal>, which is equivalent).
@@ -9833,7 +9833,7 @@
<para>
For the usage of
- <function role="capi">mysql_stmt_affected_rows()</function>,
+ <literal role="cfunc">mysql_stmt_affected_rows()</literal>,
refer to the Example from <xref linkend="mysql-stmt-execute"/>.
</para>
@@ -9841,7 +9841,7 @@
<section id="mysql-stmt-attr-get">
- <title><function role="capi">mysql_stmt_attr_get()</function></title>
+ <title><literal role="cfunc">mysql_stmt_attr_get()</literal></title>
<indexterm>
<primary>mysql_stmt_attr_get()</primary>
@@ -9876,7 +9876,7 @@
<note>
<para>
In MySQL ¤t-series;,
- <function role="capi">mysql_stmt_attr_get()</function> uses
+ <literal role="cfunc">mysql_stmt_attr_get()</literal> uses
<literal>unsigned int *</literal>, not <literal>my_bool
*</literal>, for
<literal>STMT_ATTR_UPDATE_MAX_LENGTH</literal>. This is
@@ -9909,7 +9909,7 @@
<section id="mysql-stmt-attr-set">
- <title><function role="capi">mysql_stmt_attr_set()</function></title>
+ <title><literal role="cfunc">mysql_stmt_attr_set()</literal></title>
<indexterm>
<primary>mysql_stmt_attr_set()</primary>
@@ -9932,14 +9932,14 @@
<literal>my_bool *</literal>. If <literal>arg</literal> points
to the value <literal>1</literal>, then the metadata
<literal>MYSQL_FIELD->max_length</literal> in
- <function role="capi">mysql_stmt_store_result()</function> is
+ <literal role="cfunc">mysql_stmt_store_result()</literal> is
updated when the prepared statement is executed.
</para>
<note>
<para>
In MySQL ¤t-series;,
- <function role="capi">mysql_stmt_attr_get()</function> uses
+ <literal role="cfunc">mysql_stmt_attr_get()</literal> uses
<literal>unsigned int *</literal>, not <literal>my_bool
*</literal>, for
<literal>STMT_ATTR_UPDATE_MAX_LENGTH</literal>. This is
@@ -9973,7 +9973,7 @@
<section id="mysql-stmt-bind-param">
- <title><function role="capi">mysql_stmt_bind_param()</function></title>
+ <title><literal role="cfunc">mysql_stmt_bind_param()</literal></title>
<indexterm>
<primary>mysql_stmt_bind_param()</primary>
@@ -9989,10 +9989,10 @@
</para>
<para>
- <function role="capi">mysql_stmt_bind_param()</function> is used
+ <literal role="cfunc">mysql_stmt_bind_param()</literal> is used
to bind input data for the parameter markers in the SQL
statement that was passed to
- <function role="capi">mysql_stmt_prepare()</function>. It uses
+ <literal role="cfunc">mysql_stmt_prepare()</literal>. It uses
<literal>MYSQL_BIND</literal> structures to supply the data.
<literal>bind</literal> is the address of an array of
<literal>MYSQL_BIND</literal> structures. The client library
@@ -10084,7 +10084,7 @@
<para>
For the usage of
- <function role="capi">mysql_stmt_bind_param()</function>, refer
+ <literal role="cfunc">mysql_stmt_bind_param()</literal>, refer
to the Example from <xref linkend="mysql-stmt-execute"/>.
</para>
@@ -10092,7 +10092,7 @@
<section id="mysql-stmt-bind-result">
- <title><function role="capi">mysql_stmt_bind_result()</function></title>
+ <title><literal role="cfunc">mysql_stmt_bind_result()</literal></title>
<indexterm>
<primary>mysql_stmt_bind_result()</primary>
@@ -10108,23 +10108,23 @@
</para>
<para>
- <function role="capi">mysql_stmt_bind_result()</function> is
+ <literal role="cfunc">mysql_stmt_bind_result()</literal> is
used to associate (that is, bind) output columns in the result
set to data buffers and length buffers. When
- <function role="capi">mysql_stmt_fetch()</function> is called to
+ <literal role="cfunc">mysql_stmt_fetch()</literal> is called to
fetch data, the MySQL client/server protocol places the data for
the bound columns into the specified buffers.
</para>
<para>
All columns must be bound to buffers prior to calling
- <function role="capi">mysql_stmt_fetch()</function>.
+ <literal role="cfunc">mysql_stmt_fetch()</literal>.
<literal>bind</literal> is the address of an array of
<literal>MYSQL_BIND</literal> structures. The client library
expects the array to contain one element for each column of the
result set. If you do not bind columns to
<literal>MYSQL_BIND</literal> structures,
- <function role="capi">mysql_stmt_fetch()</function> simply
+ <literal role="cfunc">mysql_stmt_fetch()</literal> simply
ignores the data fetch. The buffers should be large enough to
hold the data values, because the protocol doesn't return data
values in chunks.
@@ -10134,19 +10134,19 @@
A column can be bound or rebound at any time, even after a
result set has been partially retrieved. The new binding takes
effect the next time
- <function role="capi">mysql_stmt_fetch()</function> is called.
+ <literal role="cfunc">mysql_stmt_fetch()</literal> is called.
Suppose that an application binds the columns in a result set
- and calls <function role="capi">mysql_stmt_fetch()</function>.
+ and calls <literal role="cfunc">mysql_stmt_fetch()</literal>.
The client/server protocol returns data in the bound buffers.
Then suppose that the application binds the columns to a
different set of buffers. The protocol places data into the
newly bound buffers when the next call to
- <function role="capi">mysql_stmt_fetch()</function> occurs.
+ <literal role="cfunc">mysql_stmt_fetch()</literal> occurs.
</para>
<para>
To bind a column, an application calls
- <function role="capi">mysql_stmt_bind_result()</function> and
+ <literal role="cfunc">mysql_stmt_bind_result()</literal> and
passes the type, address, and length of the output buffer into
which the value should be stored.
<xref linkend="c-api-prepared-statement-datatypes"/>, describes
@@ -10213,7 +10213,7 @@
<para>
For the usage of
- <function role="capi">mysql_stmt_bind_result()</function>, refer
+ <literal role="cfunc">mysql_stmt_bind_result()</literal>, refer
to the Example from <xref linkend="mysql-stmt-fetch"/>.
</para>
@@ -10221,7 +10221,7 @@
<section id="mysql-stmt-close">
- <title><function role="capi">mysql_stmt_close()</function></title>
+ <title><literal role="cfunc">mysql_stmt_close()</literal></title>
<indexterm>
<primary>mysql_stmt_close()</primary>
@@ -10237,7 +10237,7 @@
<para>
Closes the prepared statement.
- <function role="capi">mysql_stmt_close()</function> also
+ <literal role="cfunc">mysql_stmt_close()</literal> also
deallocates the statement handle pointed to by
<literal>stmt</literal>.
</para>
@@ -10294,7 +10294,7 @@
<para>
For the usage of
- <function role="capi">mysql_stmt_close()</function>, refer to
+ <literal role="cfunc">mysql_stmt_close()</literal>, refer to
the Example from <xref linkend="mysql-stmt-execute"/>.
</para>
@@ -10302,7 +10302,7 @@
<section id="mysql-stmt-data-seek">
- <title><function role="capi">mysql_stmt_data_seek()</function></title>
+ <title><literal role="cfunc">mysql_stmt_data_seek()</literal></title>
<indexterm>
<primary>mysql_stmt_data_seek()</primary>
@@ -10321,15 +10321,15 @@
Seeks to an arbitrary row in a statement result set. The
<literal>offset</literal> value is a row number and should be in
the range from <literal>0</literal> to
- <function role="capi">mysql_stmt_num_rows(stmt)-1</function>.
+ <literal role="cfunc">mysql_stmt_num_rows(stmt)-1</literal>.
</para>
<para>
This function requires that the statement result set structure
contains the entire result of the last executed query, so
- <function role="capi">mysql_stmt_data_seek()</function> may be
+ <literal role="cfunc">mysql_stmt_data_seek()</literal> may be
used only in conjunction with
- <function role="capi">mysql_stmt_store_result()</function>.
+ <literal role="cfunc">mysql_stmt_store_result()</literal>.
</para>
<para>
@@ -10356,7 +10356,7 @@
<section id="mysql-stmt-errno">
- <title><function role="capi">mysql_stmt_errno()</function></title>
+ <title><literal role="cfunc">mysql_stmt_errno()</literal></title>
<indexterm>
<primary>mysql_stmt_errno()</primary>
@@ -10373,7 +10373,7 @@
<para>
For the statement specified by <literal>stmt</literal>,
- <function role="capi">mysql_stmt_errno()</function> returns the
+ <literal role="cfunc">mysql_stmt_errno()</literal> returns the
error code for the most recently invoked statement API function
that can succeed or fail. A return value of zero means that no
error occurred. Client error message numbers are listed in the
@@ -10407,7 +10407,7 @@
<section id="mysql-stmt-error">
- <title><function role="capi">mysql_stmt_error()</function></title>
+ <title><literal role="cfunc">mysql_stmt_error()</literal></title>
<indexterm>
<primary>mysql_stmt_error()</primary>
@@ -10424,7 +10424,7 @@
<para>
For the statement specified by <literal>stmt</literal>,
- <function role="capi">mysql_stmt_error()</function> returns a
+ <literal role="cfunc">mysql_stmt_error()</literal> returns a
null-terminated string containing the error message for the most
recently invoked statement API function that can succeed or
fail. An empty string (<literal>""</literal>) is returned if no
@@ -10475,7 +10475,7 @@
<section id="mysql-stmt-execute">
- <title><function role="capi">mysql_stmt_execute()</function></title>
+ <title><literal role="cfunc">mysql_stmt_execute()</literal></title>
<indexterm>
<primary>mysql_stmt_execute()</primary>
@@ -10490,7 +10490,7 @@
</para>
<para>
- <function role="capi">mysql_stmt_execute()</function> executes
+ <literal role="cfunc">mysql_stmt_execute()</literal> executes
the prepared query associated with the statement handle. The
currently bound parameter marker values are sent to server
during this call, and the server replaces the markers with this
@@ -10502,10 +10502,10 @@
<literal>DELETE</literal>, or <literal>INSERT</literal>, the
total number of changed, deleted, or inserted rows can be found
by calling
- <function role="capi">mysql_stmt_affected_rows()</function>. If
+ <literal role="cfunc">mysql_stmt_affected_rows()</literal>. If
this is a statement such as <literal>SELECT</literal> that
generates a result set, you must call
- <function role="capi">mysql_stmt_fetch()</function> to fetch the
+ <literal role="cfunc">mysql_stmt_fetch()</literal> to fetch the
data prior to calling any other functions that result in query
processing. For more information on how to fetch the results,
refer to <xref linkend="mysql-stmt-fetch"/>.
@@ -10513,11 +10513,11 @@
<para>
For statements that generate a result set, you can request that
- <function role="capi">mysql_stmt_execute()</function> open a
+ <literal role="cfunc">mysql_stmt_execute()</literal> open a
cursor for the statement by calling
- <function role="capi">mysql_stmt_attr_set()</function> before
+ <literal role="cfunc">mysql_stmt_attr_set()</literal> before
executing the statement. If you execute a statement multiple
- times, <function role="capi">mysql_stmt_execute()</function>
+ times, <literal role="cfunc">mysql_stmt_execute()</literal>
closes any open cursor before opening a new one.
</para>
@@ -10528,14 +10528,14 @@
<!--
<para>
- <function role="capi">mysql_stmt_execute()</function> opens no cursor for
+ <literal role="cfunc">mysql_stmt_execute()</literal> opens no cursor for
result sets that contain zero rows or one row. It also opens no
cursor for <literal>EXPLAIN</literal> or <literal>SHOW</literal>
statements (such as <literal>SHOW VARIABLES</literal>) that are
not based on the contents of
<literal>INFORMATION_SCHEMA</literal>. In such cases, the result
set is transferred to the client implicitly with
- <function role="capi">mysql_stmt_store_result()</function>.
+ <literal role="cfunc">mysql_stmt_store_result()</literal>.
</para>
-->
@@ -10615,12 +10615,12 @@
<para>
The following example demonstrates how to create and populate a
- table using <function role="capi">mysql_stmt_init()</function>,
- <function role="capi">mysql_stmt_prepare()</function>,
- <function role="capi">mysql_stmt_param_count()</function>,
- <function role="capi">mysql_stmt_bind_param()</function>,
- <function role="capi">mysql_stmt_execute()</function>, and
- <function role="capi">mysql_stmt_affected_rows()</function>. The
+ table using <literal role="cfunc">mysql_stmt_init()</literal>,
+ <literal role="cfunc">mysql_stmt_prepare()</literal>,
+ <literal role="cfunc">mysql_stmt_param_count()</literal>,
+ <literal role="cfunc">mysql_stmt_bind_param()</literal>,
+ <literal role="cfunc">mysql_stmt_execute()</literal>, and
+ <literal role="cfunc">mysql_stmt_affected_rows()</literal>. The
<literal>mysql</literal> variable is assumed to be a valid
connection handle.
</para>
@@ -10800,7 +10800,7 @@
<section id="mysql-stmt-fetch">
- <title><function role="capi">mysql_stmt_fetch()</function></title>
+ <title><literal role="cfunc">mysql_stmt_fetch()</literal></title>
<indexterm>
<primary>mysql_stmt_fetch()</primary>
@@ -10815,31 +10815,31 @@
</para>
<para>
- <function role="capi">mysql_stmt_fetch()</function> returns the
+ <literal role="cfunc">mysql_stmt_fetch()</literal> returns the
next row in the result set. It can be called only while the
result set exists; that is, after a call to
- <function role="capi">mysql_stmt_execute()</function> for a
+ <literal role="cfunc">mysql_stmt_execute()</literal> for a
statement such as <literal>SELECT</literal> that creates a
result set.
</para>
<para>
- <function role="capi">mysql_stmt_fetch()</function> returns row
+ <literal role="cfunc">mysql_stmt_fetch()</literal> returns row
data using the buffers bound by
- <function role="capi">mysql_stmt_bind_result()</function>. It
+ <literal role="cfunc">mysql_stmt_bind_result()</literal>. It
returns the data in those buffers for all the columns in the
current row set and the lengths are returned to the
<literal>length</literal> pointer. All columns must be bound by
the application before it calls
- <function role="capi">mysql_stmt_fetch()</function>.
+ <literal role="cfunc">mysql_stmt_fetch()</literal>.
</para>
<para>
By default, result sets are fetched unbuffered a row at a time
from the server. To buffer the entire result set on the client,
- call <function role="capi">mysql_stmt_store_result()</function>
+ call <literal role="cfunc">mysql_stmt_store_result()</literal>
after binding the data buffers and before caling
- <function role="capi">mysql_stmt_fetch()</function>.
+ <literal role="cfunc">mysql_stmt_fetch()</literal>.
</para>
<para>
@@ -10936,8 +10936,8 @@
<row>
<entry>1</entry>
<entry>Error occurred. Error code and message can be obtained by calling
- <function role="capi">mysql_stmt_errno()</function> and
- <function role="capi">mysql_stmt_error()</function>.</entry>
+ <literal role="cfunc">mysql_stmt_errno()</literal> and
+ <literal role="cfunc">mysql_stmt_error()</literal>.</entry>
</row>
<row>
<entry><literal>MYSQL_NO_DATA</literal></entry>
@@ -10954,7 +10954,7 @@
<para>
<literal>MYSQL_DATA_TRUNCATED</literal> is not returned unless
truncation reporting is enabled with
- <function role="capi">mysql_options()</function>. To determine
+ <literal role="cfunc">mysql_options()</literal>. To determine
which parameters were truncated when this value is returned,
check the <literal>error</literal> members of the
<literal>MYSQL_BIND</literal> parameter structures.
@@ -11035,7 +11035,7 @@
<listitem>
<para>
All other unsupported conversion errors are returned from
- <function role="capi">mysql_stmt_bind_result()</function>.
+ <literal role="cfunc">mysql_stmt_bind_result()</literal>.
</para>
</listitem>
@@ -11048,9 +11048,9 @@
<para>
The following example demonstrates how to fetch data from a
table using
- <function role="capi">mysql_stmt_result_metadata()</function>,
- <function role="capi">mysql_stmt_bind_result()</function>, and
- <function role="capi">mysql_stmt_fetch()</function>. (This
+ <literal role="cfunc">mysql_stmt_result_metadata()</literal>,
+ <literal role="cfunc">mysql_stmt_bind_result()</literal>, and
+ <literal role="cfunc">mysql_stmt_fetch()</literal>. (This
example expects to retrieve the two rows inserted by the example
shown in <xref linkend="mysql-stmt-execute"/>.) The
<literal>mysql</literal> variable is assumed to be a valid
@@ -11240,7 +11240,7 @@
<para>
In some cases you might want to determine the length of a column
value before fetching it with
- <function role="capi">mysql_stmt_fetch()</function>. For
+ <literal role="cfunc">mysql_stmt_fetch()</literal>. For
example, the value might be a long string or
<literal>BLOB</literal> value for which you want to know how
much space must be allocated. To accomplish this, you can use
@@ -11252,17 +11252,17 @@
<listitem>
<para>
Before invoking
- <function role="capi">mysql_stmt_fetch()</function> to
+ <literal role="cfunc">mysql_stmt_fetch()</literal> to
retrieve individual rows, invoke
- <function role="capi">mysql_stmt_store_result()</function>
+ <literal role="cfunc">mysql_stmt_store_result()</literal>
to buffer the entire result on the client side. Then the
maximal length of column values will be indicated by the
<literal>max_length</literal> member of the result set
metadata returned by
- <function role="capi">mysql_stmt_result_metadata()</function>.
+ <literal role="cfunc">mysql_stmt_result_metadata()</literal>.
This strategy requires that you pass
<literal>STMT_ATTR_UPDATE_MAX_LENGTH</literal> to
- <function role="capi">mysql_stmt_attr_set()</function> or
+ <literal role="cfunc">mysql_stmt_attr_set()</literal> or
the <literal>max_length</literal> values will not be
calculated.
</para>
@@ -11270,11 +11270,11 @@
<listitem>
<para>
- Invoke <function role="capi">mysql_stmt_fetch()</function>
+ Invoke <literal role="cfunc">mysql_stmt_fetch()</literal>
with a zero-length buffer for the column in question and a
pointer in which the real length can be stored. Then use the
real length with
- <function role="capi">mysql_stmt_fetch_column()</function>.
+ <literal role="cfunc">mysql_stmt_fetch_column()</literal>.
</para>
<programlisting>
@@ -11302,7 +11302,7 @@
<section id="mysql-stmt-fetch-column">
- <title><function role="capi">mysql_stmt_fetch_column()</function></title>
+ <title><literal role="cfunc">mysql_stmt_fetch_column()</literal></title>
<indexterm>
<primary>mysql_stmt_fetch_column()</primary>
@@ -11322,7 +11322,7 @@
Fetch one column from the current result set row.
<literal>bind</literal> provides the buffer where data should be
placed. It should be set up the same way as for
- <function role="capi">mysql_stmt_bind_result()</function>.
+ <literal role="cfunc">mysql_stmt_bind_result()</literal>.
<literal>column</literal> indicates which column to fetch. The
first column is numbered 0. <literal>offset</literal> is the
offset within the data value at which to begin retrieving data.
@@ -11375,7 +11375,7 @@
<section id="mysql-stmt-field-count">
- <title><function role="capi">mysql_stmt_field_count()</function></title>
+ <title><literal role="cfunc">mysql_stmt_field_count()</literal></title>
<indexterm>
<primary>mysql_stmt_field_count()</primary>
@@ -11398,9 +11398,9 @@
</para>
<para>
- <function role="capi">mysql_stmt_field_count()</function> can be
+ <literal role="cfunc">mysql_stmt_field_count()</literal> can be
called after you have prepared a statement by invoking
- <function role="capi">mysql_stmt_prepare()</function>.
+ <literal role="cfunc">mysql_stmt_prepare()</literal>.
</para>
<para>
@@ -11428,7 +11428,7 @@
<section id="mysql-stmt-free-result">
- <title><function role="capi">mysql_stmt_free_result()</function></title>
+ <title><literal role="cfunc">mysql_stmt_free_result()</literal></title>
<indexterm>
<primary>mysql_stmt_free_result()</primary>
@@ -11447,7 +11447,7 @@
Releases memory associated with the result set produced by
execution of the prepared statement. If there is a cursor open
for the statement,
- <function role="capi">mysql_stmt_free_result()</function> closes
+ <literal role="cfunc">mysql_stmt_free_result()</literal> closes
it.
</para>
@@ -11472,7 +11472,7 @@
<section id="mysql-stmt-init">
- <title><function role="capi">mysql_stmt_init()</function></title>
+ <title><literal role="cfunc">mysql_stmt_init()</literal></title>
<indexterm>
<primary>mysql_stmt_init()</primary>
@@ -11488,8 +11488,8 @@
<para>
Create a <literal>MYSQL_STMT</literal> handle. The handle should
- be freed with <function role="capi">mysql_stmt_close(MYSQL_STMT
- *)</function>.
+ be freed with <literal role="cfunc">mysql_stmt_close(MYSQL_STMT
+ *)</literal>.
</para>
<para>
@@ -11527,7 +11527,7 @@
<section id="mysql-stmt-insert-id">
- <title><function role="capi">mysql_stmt_insert_id()</function></title>
+ <title><literal role="cfunc">mysql_stmt_insert_id()</literal></title>
<indexterm>
<primary>mysql_stmt_insert_id()</primary>
@@ -11567,7 +11567,7 @@
Value for <literal>AUTO_INCREMENT</literal> column which was
automatically generated or explicitly set during execution of
prepared statement, or value generated by
- <function role="sql">LAST_INSERT_ID(<replaceable>expr</replaceable>)</function>
+ <literal role="func">LAST_INSERT_ID(<replaceable>expr</replaceable>)</literal>
function. Return value is undefined if statement does not set
<literal>AUTO_INCREMENT</literal> value.
</para>
@@ -11591,7 +11591,7 @@
<section id="mysql-stmt-num-rows">
- <title><function role="capi">mysql_stmt_num_rows()</function></title>
+ <title><literal role="cfunc">mysql_stmt_num_rows()</literal></title>
<indexterm>
<primary>mysql_stmt_num_rows()</primary>
@@ -11612,28 +11612,28 @@
<para>
The use of
- <function role="capi">mysql_stmt_num_rows()</function> depends
+ <literal role="cfunc">mysql_stmt_num_rows()</literal> depends
on whether you used
- <function role="capi">mysql_stmt_store_result()</function> to
+ <literal role="cfunc">mysql_stmt_store_result()</literal> to
buffer the entire result set in the statement handle.
</para>
<para>
If you use
- <function role="capi">mysql_stmt_store_result()</function>,
- <function role="capi">mysql_stmt_num_rows()</function> may be
+ <literal role="cfunc">mysql_stmt_store_result()</literal>,
+ <literal role="cfunc">mysql_stmt_num_rows()</literal> may be
called immediately. Otherwise, the row count is unavailable
unless you count the rows as you fetch them.
</para>
<para>
- <function role="capi">mysql_stmt_num_rows()</function> is
+ <literal role="cfunc">mysql_stmt_num_rows()</literal> is
intended for use with statements that return a result set, such
as <literal>SELECT</literal>. For statements such as
<literal>INSERT</literal>, <literal>UPDATE</literal>, or
<literal>DELETE</literal>, the number of affected rows can be
obtained with
- <function role="capi">mysql_stmt_affected_rows()</function>.
+ <literal role="cfunc">mysql_stmt_affected_rows()</literal>.
</para>
<para>
@@ -11660,7 +11660,7 @@
<section id="mysql-stmt-param-count">
- <title><function role="capi">mysql_stmt_param_count()</function></title>
+ <title><literal role="cfunc">mysql_stmt_param_count()</literal></title>
<indexterm>
<primary>mysql_stmt_param_count()</primary>
@@ -11707,7 +11707,7 @@
<para>
For the usage of
- <function role="capi">mysql_stmt_param_count()</function>, refer
+ <literal role="cfunc">mysql_stmt_param_count()</literal>, refer
to the Example from <xref linkend="mysql-stmt-execute"/>.
</para>
@@ -11715,7 +11715,7 @@
<section id="mysql-stmt-param-metadata">
- <title><function role="capi">mysql_stmt_param_metadata()</function></title>
+ <title><literal role="cfunc">mysql_stmt_param_metadata()</literal></title>
<indexterm>
<primary>mysql_stmt_param_metadata()</primary>
@@ -11750,7 +11750,7 @@
<section id="mysql-stmt-prepare">
- <title><function role="capi">mysql_stmt_prepare()</function></title>
+ <title><literal role="cfunc">mysql_stmt_prepare()</literal></title>
<indexterm>
<primary>mysql_stmt_prepare()</primary>
@@ -11767,7 +11767,7 @@
<para>
Given the statement handle returned by
- <function role="capi">mysql_stmt_init()</function>, prepares the
+ <literal role="cfunc">mysql_stmt_init()</literal>, prepares the
SQL statement pointed to by the string
<literal>stmt_str</literal> and returns a status value. The
string length should be given by the <literal>length</literal>
@@ -11801,7 +11801,7 @@
<para>
The parameter markers must be bound to application variables
- using <function role="capi">mysql_stmt_bind_param()</function>
+ using <literal role="cfunc">mysql_stmt_bind_param()</literal>
before executing the statement.
</para>
@@ -11878,9 +11878,9 @@
<para>
If the prepare operation was unsuccessful (that is,
- <function role="capi">mysql_stmt_prepare()</function> returns
+ <literal role="cfunc">mysql_stmt_prepare()</literal> returns
non-zero), the error message can be obtained by calling
- <function role="capi">mysql_stmt_error()</function>.
+ <literal role="cfunc">mysql_stmt_error()</literal>.
</para>
<para>
@@ -11889,7 +11889,7 @@
<para>
For the usage of
- <function role="capi">mysql_stmt_prepare()</function>, refer to
+ <literal role="cfunc">mysql_stmt_prepare()</literal>, refer to
the Example from <xref linkend="mysql-stmt-execute"/>.
</para>
@@ -11897,7 +11897,7 @@
<section id="mysql-stmt-reset">
- <title><function role="capi">mysql_stmt_reset()</function></title>
+ <title><literal role="cfunc">mysql_stmt_reset()</literal></title>
<indexterm>
<primary>mysql_stmt_reset()</primary>
@@ -11914,13 +11914,13 @@
<para>
Reset the prepared statement on the client and server to state
after prepare. This is mainly used to reset data sent with
- <function role="capi">mysql_stmt_send_long_data()</function>.
+ <literal role="cfunc">mysql_stmt_send_long_data()</literal>.
Any open cursor for the statement is closed.
</para>
<para>
To re-prepare the statement with another query, use
- <function role="capi">mysql_stmt_prepare()</function>.
+ <literal role="cfunc">mysql_stmt_prepare()</literal>.
</para>
<para>
@@ -11988,7 +11988,7 @@
<section id="mysql-stmt-result-metadata">
- <title><function role="capi">mysql_stmt_result_metadata()</function></title>
+ <title><literal role="cfunc">mysql_stmt_result_metadata()</literal></title>
<indexterm>
<primary>mysql_stmt_result_metadata</primary>
@@ -12005,9 +12005,9 @@
<para>
If a statement passed to
- <function role="capi">mysql_stmt_prepare()</function> is one
+ <literal role="cfunc">mysql_stmt_prepare()</literal> is one
that produces a result set,
- <function role="capi">mysql_stmt_result_metadata()</function>
+ <literal role="cfunc">mysql_stmt_result_metadata()</literal>
returns the result set metadata in the form of a pointer to a
<literal>MYSQL_RES</literal> structure that can be used to
process the meta information such as total number of fields and
@@ -12020,49 +12020,49 @@
<listitem>
<para>
- <function role="capi">mysql_num_fields()</function>
+ <literal role="cfunc">mysql_num_fields()</literal>
</para>
</listitem>
<listitem>
<para>
- <function role="capi">mysql_fetch_field()</function>
+ <literal role="cfunc">mysql_fetch_field()</literal>
</para>
</listitem>
<listitem>
<para>
- <function role="capi">mysql_fetch_field_direct()</function>
+ <literal role="cfunc">mysql_fetch_field_direct()</literal>
</para>
</listitem>
<listitem>
<para>
- <function role="capi">mysql_fetch_fields()</function>
+ <literal role="cfunc">mysql_fetch_fields()</literal>
</para>
</listitem>
<listitem>
<para>
- <function role="capi">mysql_field_count()</function>
+ <literal role="cfunc">mysql_field_count()</literal>
</para>
</listitem>
<listitem>
<para>
- <function role="capi">mysql_field_seek()</function>
+ <literal role="cfunc">mysql_field_seek()</literal>
</para>
</listitem>
<listitem>
<para>
- <function role="capi">mysql_field_tell()</function>
+ <literal role="cfunc">mysql_field_tell()</literal>
</para>
</listitem>
<listitem>
<para>
- <function role="capi">mysql_free_result()</function>
+ <literal role="cfunc">mysql_free_result()</literal>
</para>
</listitem>
@@ -12071,17 +12071,17 @@
<para>
The result set structure should be freed when you are done with
it, which you can do by passing it to
- <function role="capi">mysql_free_result()</function>. This is
+ <literal role="cfunc">mysql_free_result()</literal>. This is
similar to the way you free a result set obtained from a call to
- <function role="capi">mysql_store_result()</function>.
+ <literal role="cfunc">mysql_store_result()</literal>.
</para>
<para>
The result set returned by
- <function role="capi">mysql_stmt_result_metadata()</function>
+ <literal role="cfunc">mysql_stmt_result_metadata()</literal>
contains only metadata. It does not contain any row results. The
rows are obtained by using the statement handle with
- <function role="capi">mysql_stmt_fetch()</function>.
+ <literal role="cfunc">mysql_stmt_fetch()</literal>.
</para>
<para>
@@ -12132,7 +12132,7 @@
<para>
For the usage of
- <function role="capi">mysql_stmt_result_metadata()</function>,
+ <literal role="cfunc">mysql_stmt_result_metadata()</literal>,
refer to the Example from <xref linkend="mysql-stmt-fetch"/>.
</para>
@@ -12140,7 +12140,7 @@
<section id="mysql-stmt-row-seek">
- <title><function role="capi">mysql_stmt_row_seek()</function></title>
+ <title><literal role="cfunc">mysql_stmt_row_seek()</literal></title>
<indexterm>
<primary>mysql_stmt_row_seek()</primary>
@@ -12159,19 +12159,19 @@
Sets the row cursor to an arbitrary row in a statement result
set. The <literal>offset</literal> value is a row offset that
should be a value returned from
- <function role="capi">mysql_stmt_row_tell()</function> or from
- <function role="capi">mysql_stmt_row_seek()</function>. This
+ <literal role="cfunc">mysql_stmt_row_tell()</literal> or from
+ <literal role="cfunc">mysql_stmt_row_seek()</literal>. This
value is not a row number; if you want to seek to a row within a
result set by number, use
- <function role="capi">mysql_stmt_data_seek()</function> instead.
+ <literal role="cfunc">mysql_stmt_data_seek()</literal> instead.
</para>
<para>
This function requires that the result set structure contains
the entire result of the query, so
- <function role="capi">mysql_stmt_row_seek()</function> may be
+ <literal role="cfunc">mysql_stmt_row_seek()</literal> may be
used only in conjunction with
- <function role="capi">mysql_stmt_store_result()</function>.
+ <literal role="cfunc">mysql_stmt_store_result()</literal>.
</para>
<para>
@@ -12185,7 +12185,7 @@
<para>
The previous value of the row cursor. This value may be passed
to a subsequent call to
- <function role="capi">mysql_stmt_row_seek()</function>.
+ <literal role="cfunc">mysql_stmt_row_seek()</literal>.
</para>
<para>
@@ -12200,7 +12200,7 @@
<section id="mysql-stmt-row-tell">
- <title><function role="capi">mysql_stmt_row_tell()</function></title>
+ <title><literal role="cfunc">mysql_stmt_row_tell()</literal></title>
<indexterm>
<primary>mysql_stmt_row_tell()</primary>
@@ -12217,16 +12217,16 @@
<para>
Returns the current position of the row cursor for the last
- <function role="capi">mysql_stmt_fetch()</function>. This value
+ <literal role="cfunc">mysql_stmt_fetch()</literal>. This value
can be used as an argument to
- <function role="capi">mysql_stmt_row_seek()</function>.
+ <literal role="cfunc">mysql_stmt_row_seek()</literal>.
</para>
<para>
You should use
- <function role="capi">mysql_stmt_row_tell()</function> only
+ <literal role="cfunc">mysql_stmt_row_tell()</literal> only
after
- <function role="capi">mysql_stmt_store_result()</function>.
+ <literal role="cfunc">mysql_stmt_store_result()</literal>.
</para>
<para>
@@ -12253,7 +12253,7 @@
<section id="mysql-stmt-send-long-data">
- <title><function role="capi">mysql_stmt_send_long_data()</function></title>
+ <title><literal role="cfunc">mysql_stmt_send_long_data()</literal></title>
<indexterm>
<primary>mysql_stmt_send_long_data()</primary>
@@ -12272,8 +12272,8 @@
<para>
Allows an application to send parameter data to the server in
pieces (or <quote>chunks</quote>). Call this function after
- <function role="capi">mysql_stmt_bind_param()</function> and
- before <function role="capi">mysql_stmt_execute()</function>. It
+ <literal role="cfunc">mysql_stmt_bind_param()</literal> and
+ before <literal role="cfunc">mysql_stmt_execute()</literal>. It
can be called multiple times to send the parts of a character or
binary data value for a column, which must be one of the
<literal>TEXT</literal> or <literal>BLOB</literal> data types.
@@ -12289,19 +12289,19 @@
<note>
<para>
- The next <function role="capi">mysql_stmt_execute()</function>
+ The next <literal role="cfunc">mysql_stmt_execute()</literal>
call ignores the bind buffer for all parameters that have been
used with
- <function role="capi">mysql_stmt_send_long_data()</function>
+ <literal role="cfunc">mysql_stmt_send_long_data()</literal>
since last
- <function role="capi">mysql_stmt_execute()</function> or
- <function role="capi">mysql_stmt_reset()</function>.
+ <literal role="cfunc">mysql_stmt_execute()</literal> or
+ <literal role="cfunc">mysql_stmt_reset()</literal>.
</para>
</note>
<para>
If you want to reset/forget the sent data, you can do it with
- <function role="capi">mysql_stmt_reset()</function>. See
+ <literal role="cfunc">mysql_stmt_reset()</literal>. See
<xref linkend="mysql-stmt-reset"/>.
</para>
@@ -12441,7 +12441,7 @@
<section id="mysql-stmt-sqlstate">
- <title><function role="capi">mysql_stmt_sqlstate()</function></title>
+ <title><literal role="cfunc">mysql_stmt_sqlstate()</literal></title>
<indexterm>
<primary>mysql_stmt_sqlstate()</primary>
@@ -12458,7 +12458,7 @@
<para>
For the statement specified by <literal>stmt</literal>,
- <function role="capi">mysql_stmt_sqlstate()</function> returns a
+ <literal role="cfunc">mysql_stmt_sqlstate()</literal> returns a
null-terminated string containing the SQLSTATE error code for
the most recently invoked prepared statement API function that
can succeed or fail. The error code consists of five characters.
@@ -12490,7 +12490,7 @@
<section id="mysql-stmt-store-result">
- <title><function role="capi">mysql_stmt_store_result()</function></title>
+ <title><literal role="cfunc">mysql_stmt_store_result()</literal></title>
<indexterm>
<primary>mysql_stmt_store_result()</primary>
@@ -12511,34 +12511,34 @@
<literal>EXPLAIN</literal>. By default, result sets for
successfully executed prepared statements are not buffered on
the client and
- <function role="capi">mysql_stmt_fetch()</function> fetches them
+ <literal role="cfunc">mysql_stmt_fetch()</literal> fetches them
one at a time from the server. To cause the complete result set
to be buffered on the client, call
- <function role="capi">mysql_stmt_store_result()</function> after
+ <literal role="cfunc">mysql_stmt_store_result()</literal> after
binding data buffers with
- <function role="capi">mysql_stmt_bind_result()</function> and
+ <literal role="cfunc">mysql_stmt_bind_result()</literal> and
before calling
- <function role="capi">mysql_stmt_fetch()</function> to fetch
+ <literal role="cfunc">mysql_stmt_fetch()</literal> to fetch
rows. (For an example, see <xref linkend="mysql-stmt-fetch"/>.)
</para>
<para>
- <function role="capi">mysql_stmt_store_result()</function> is
+ <literal role="cfunc">mysql_stmt_store_result()</literal> is
optional for result set processing, unless you will call
- <function role="capi">mysql_stmt_data_seek()</function>,
- <function role="capi">mysql_stmt_row_seek()</function>, or
- <function role="capi">mysql_stmt_row_tell()</function>. Those
+ <literal role="cfunc">mysql_stmt_data_seek()</literal>,
+ <literal role="cfunc">mysql_stmt_row_seek()</literal>, or
+ <literal role="cfunc">mysql_stmt_row_tell()</literal>. Those
functions require a seekable result set.
</para>
<para>
It is unnecessary to call
- <function role="capi">mysql_stmt_store_result()</function> after
+ <literal role="cfunc">mysql_stmt_store_result()</literal> after
executing an SQL statement that does not produce a result set,
but if you do, it does not harm or cause any notable performance
problem. You can detect whether the statement produced a result
set by checking if
- <function role="capi">mysql_stmt_result_metadata()</function>
+ <literal role="cfunc">mysql_stmt_result_metadata()</literal>
returns <literal>NULL</literal>. For more information, refer to
<xref linkend="mysql-stmt-result-metadata"/>.
</para>
@@ -12547,14 +12547,14 @@
<para>
MySQL doesn't by default calculate
<literal>MYSQL_FIELD->max_length</literal> for all columns
- in <function role="capi">mysql_stmt_store_result()</function>
+ in <literal role="cfunc">mysql_stmt_store_result()</literal>
because calculating this would slow down
- <function role="capi">mysql_stmt_store_result()</function>
+ <literal role="cfunc">mysql_stmt_store_result()</literal>
considerably and most applications doesn't need
<literal>max_length</literal>. If you want
<literal>max_length</literal> to be updated, you can call
- <function role="capi">mysql_stmt_attr_set(MYSQL_STMT,
- STMT_ATTR_UPDATE_MAX_LENGTH, &flag)</function> to enable
+ <literal role="cfunc">mysql_stmt_attr_set(MYSQL_STMT,
+ STMT_ATTR_UPDATE_MAX_LENGTH, &flag)</literal> to enable
this. See <xref linkend="mysql-stmt-attr-set"/>.
</para>
</note>
@@ -12660,7 +12660,7 @@
<literal>TIME</literal>, <literal>TIMESTAMP</literal>, and
<literal>DATETIME</literal> do not support parts of seconds
(for example, from
- <function role="sql">DATE_FORMAT()</function>).
+ <literal role="func">DATE_FORMAT()</literal>).
</para>
</listitem>
@@ -12670,7 +12670,7 @@
<literal>ZEROFILL</literal> is honored with prepared
statements in some cases where the MySQL server doesn't print
the leading zeros. (For example, with
- <function role="sql">MIN(<replaceable>number-with-zerofill</replaceable>)</function>).
+ <literal role="func">MIN(<replaceable>number-with-zerofill</replaceable>)</literal>).
</para>
</listitem>
@@ -12700,8 +12700,8 @@
<title>C API Handling of Multiple Statement Execution</title>
<para>
- By default, <function role="capi">mysql_query()</function> and
- <function role="capi">mysql_real_query()</function> interpret
+ By default, <literal role="cfunc">mysql_query()</literal> and
+ <literal role="cfunc">mysql_real_query()</literal> interpret
their statement string argument as a single statement to be
executed, and you process the result according to whether the
statement produces a result set (a set of rows, as for
@@ -12716,9 +12716,9 @@
(<quote><literal>;</literal></quote>) characters. This capability
is enabled by special options that are specified either when you
connect to the server with
- <function role="capi">mysql_real_connect()</function> or after
+ <literal role="cfunc">mysql_real_connect()</literal> or after
connecting by calling`
- <function role="capi">mysql_set_server_option()</function>.
+ <literal role="cfunc">mysql_set_server_option()</literal>.
</para>
<para>
@@ -12728,8 +12728,8 @@
handling the result from the first statement, it is necessary to
check whether more results exist and process them in turn if so.
To support multiple-result processing, the C API includes the
- <function role="capi">mysql_more_results()</function> and
- <function role="capi">mysql_next_result()</function> functions.
+ <literal role="cfunc">mysql_more_results()</literal> and
+ <literal role="cfunc">mysql_next_result()</literal> functions.
These functions are used at the end of a loop that iterates as
long as more results are available. <emphasis>Failure to process
the result this way may result in a dropped connection to the
@@ -12738,8 +12738,8 @@
<para>
The multiple statement and result capabilities can be used only
- with <function role="capi">mysql_query()</function> or
- <function role="capi">mysql_real_query()</function>. They cannot
+ with <literal role="cfunc">mysql_query()</literal> or
+ <literal role="cfunc">mysql_real_query()</literal>. They cannot
be used with the prepared statement interface. Prepared statement
handles are defined to work only with strings that contain a
single statement. See <xref linkend="c-api-prepared-statements"/>.
@@ -12754,7 +12754,7 @@
<listitem>
<para>
- The <function role="capi">mysql_real_connect()</function>
+ The <literal role="cfunc">mysql_real_connect()</literal>
function has a <literal>flags</literal> argument for which two
option values are relevent:
</para>
@@ -12771,14 +12771,14 @@
<listitem>
<para>
<literal>CLIENT_MULTI_STATEMENTS</literal> enables
- <function role="capi">mysql_query()</function> and
- <function role="capi">mysql_real_query()</function> to
+ <literal role="cfunc">mysql_query()</literal> and
+ <literal role="cfunc">mysql_real_query()</literal> to
execute statement strings containing multiple statements
separated by semicolons. This option also enables
<literal>CLIENT_MULTI_RESULTS</literal> implicitly, so a
<literal>flags</literal> argument of
<literal>CLIENT_MULTI_STATEMENTS</literal> to
- <function role="capi">mysql_real_connect()</function> is
+ <literal role="cfunc">mysql_real_connect()</literal> is
equivalent to an argument of
<literal>CLIENT_MULTI_STATEMENTS |
CLIENT_MULTI_RESULTS</literal>. That is,
@@ -12795,7 +12795,7 @@
<para>
After the connection to the server has been established, you
can use the
- <function role="capi">mysql_set_server_option()</function>
+ <literal role="cfunc">mysql_set_server_option()</literal>
function to enable or disable multiple-statement execution by
passing it an argument of
<literal>MYSQL_OPTION_MULTI_STATEMENTS_ON</literal> or
@@ -12815,7 +12815,7 @@
<listitem>
<para>
Pass <literal>CLIENT_MULTI_STATEMENTS</literal> to
- <function role="capi">mysql_real_connect()</function>, to
+ <literal role="cfunc">mysql_real_connect()</literal>, to
fully enable multiple-statement execution and multiple-result
processing.
</para>
@@ -12823,8 +12823,8 @@
<listitem>
<para>
- After calling <function role="capi">mysql_query()</function>
- or <function role="capi">mysql_real_query()</function> and
+ After calling <literal role="cfunc">mysql_query()</literal>
+ or <literal role="cfunc">mysql_real_query()</literal> and
verifying that it succeeds, enter a loop within which you
process statement results.
</para>
@@ -12841,7 +12841,7 @@
<listitem>
<para>
At the end of the loop, call
- <function role="capi">mysql_next_result()</function> to check
+ <literal role="cfunc">mysql_next_result()</literal> to check
whether another result exists and initiate retrieval for it if
so. If no more results are available, exit the loop.
</para>
@@ -12853,7 +12853,7 @@
One possible implementation of the preceding strategy is shown
following. The final part of the loop can be reduced to a simple
test of whether
- <function role="capi">mysql_next_result()</function> returns
+ <literal role="cfunc">mysql_next_result()</literal> returns
non-zero. The code as written distinguishes between no more
results and an error, which allows a message to be printed for the
latter occurrence.
@@ -12933,9 +12933,9 @@
<para>
To send temporal data values, create a prepared statement using
- <function role="capi">mysql_stmt_prepare()</function>. Then,
+ <literal role="cfunc">mysql_stmt_prepare()</literal>. Then,
before calling
- <function role="capi">mysql_stmt_execute()</function> to execute
+ <literal role="cfunc">mysql_stmt_execute()</literal> to execute
the statement, use the following procedure to set up each temporal
parameter:
</para>
@@ -12977,9 +12977,9 @@
</orderedlist>
<para>
- Use <function role="capi">mysql_stmt_bind_param()</function> to
+ Use <literal role="cfunc">mysql_stmt_bind_param()</literal> to
bind the parameter data to the statement. Then you can call
- <function role="capi">mysql_stmt_execute()</function>.
+ <literal role="cfunc">mysql_stmt_execute()</literal>.
</para>
<para>
@@ -12988,9 +12988,9 @@
value you expect to receive, and the <literal>buffer</literal>
member to the address of a <literal>MYSQL_TIME</literal> structure
into which the returned value should be placed. Use
- <function role="capi">mysql_stmt_bind_result()</function> to bind
+ <literal role="cfunc">mysql_stmt_bind_result()</literal> to bind
the buffers to the statement after calling
- <function role="capi">mysql_stmt_execute()</function> and before
+ <literal role="cfunc">mysql_stmt_execute()</literal> and before
fetching the results.
</para>
@@ -13061,7 +13061,7 @@
<section id="my-init">
- <title><function role="capi">my_init()</function></title>
+ <title><literal role="cfunc">my_init()</literal></title>
<indexterm>
<primary>my_init()</primary>
@@ -13076,30 +13076,30 @@
</para>
<para>
- <function role="capi">my_init()</function> initializes some
+ <literal role="cfunc">my_init()</literal> initializes some
global variables that MySQL needs. If you are using a
thread-safe client library, it also calls
- <function role="capi">mysql_thread_init()</function> for this
+ <literal role="cfunc">mysql_thread_init()</literal> for this
thread.
</para>
<para>
- It is necessary for <function role="capi">my_init()</function>
+ It is necessary for <literal role="cfunc">my_init()</literal>
to be called early in the initialization phase of a program's
use of the MySQL library. However,
- <function role="capi">my_init()</function> is automatically
- called by <function role="capi">mysql_init()</function>,
- <function role="capi">mysql_library_init()</function>,
- <function role="capi">mysql_server_init()</function>, and
- <function role="capi">mysql_connect()</function>. If you ensure
+ <literal role="cfunc">my_init()</literal> is automatically
+ called by <literal role="cfunc">mysql_init()</literal>,
+ <literal role="cfunc">mysql_library_init()</literal>,
+ <literal role="cfunc">mysql_server_init()</literal>, and
+ <literal role="cfunc">mysql_connect()</literal>. If you ensure
that your program invokes one of those functions before any
other MySQL calls, there is no need to invoke
- <function role="capi">my_init()</function> explicitly.
+ <literal role="cfunc">my_init()</literal> explicitly.
</para>
<para>
To access the prototype for
- <function role="capi">my_init()</function>, your program should
+ <literal role="cfunc">my_init()</literal>, your program should
include these header files:
</para>
@@ -13120,7 +13120,7 @@
<section id="mysql-thread-end">
- <title><function role="capi">mysql_thread_end()</function></title>
+ <title><literal role="cfunc">mysql_thread_end()</literal></title>
<indexterm>
<primary>mysql_thread_end()</primary>
@@ -13137,11 +13137,11 @@
<para>
This function needs to be called before calling
<literal>pthread_exit()</literal> to free memory allocated by
- <function role="capi">mysql_thread_init()</function>.
+ <literal role="cfunc">mysql_thread_init()</literal>.
</para>
<para>
- <function role="capi">mysql_thread_end()</function> <emphasis>is
+ <literal role="cfunc">mysql_thread_end()</literal> <emphasis>is
not invoked automatically by the client library</emphasis>. It
must be called explicitly to avoid a memory leak.
</para>
@@ -13158,7 +13158,7 @@
<section id="mysql-thread-init">
- <title><function role="capi">mysql_thread_init()</function></title>
+ <title><literal role="cfunc">mysql_thread_init()</literal></title>
<indexterm>
<primary>mysql_thread_init()</primary>
@@ -13176,16 +13176,16 @@
This function must be called early within each created thread to
initialize thread-specific variables. However, you may not
necessarily need to invoke it explicitly:
- <function role="capi">mysql_thread_init()</function> is
+ <literal role="cfunc">mysql_thread_init()</literal> is
automatically called by
- <function role="capi">my_init()</function>, which itself is
+ <literal role="cfunc">my_init()</literal>, which itself is
automatically called by
- <function role="capi">mysql_init()</function>,
- <function role="capi">mysql_library_init()</function>,
- <function role="capi">mysql_server_init()</function>, and
- <function role="capi">mysql_connect()</function>. If you invoke
+ <literal role="cfunc">mysql_init()</literal>,
+ <literal role="cfunc">mysql_library_init()</literal>,
+ <literal role="cfunc">mysql_server_init()</literal>, and
+ <literal role="cfunc">mysql_connect()</literal>. If you invoke
any of those functions,
- <function role="capi">mysql_thread_init()</function> will be
+ <literal role="cfunc">mysql_thread_init()</literal> will be
called for you.
</para>
@@ -13201,7 +13201,7 @@
<section id="mysql-thread-safe">
- <title><function role="capi">mysql_thread_safe()</function></title>
+ <title><literal role="cfunc">mysql_thread_safe()</literal></title>
<indexterm>
<primary>mysql_thread_safe()</primary>
@@ -13245,25 +13245,25 @@
using the <option>-lmysqlclient</option> flag. However, the calls
to initialize and finalize the library are the same whether you
write a client application or one that uses the embedded server:
- Call <function role="capi">mysql_library_init()</function> to
+ Call <literal role="cfunc">mysql_library_init()</literal> to
initialize the library and
- <function role="capi">mysql_library_end()</function> when you are
+ <literal role="cfunc">mysql_library_end()</literal> when you are
done with it. See <xref linkend="c-api-function-overview"/>.
</para>
<para>
- <function role="capi">mysql_library_init()</function> and
- <function role="capi">mysql_library_end()</function> are available
+ <literal role="cfunc">mysql_library_init()</literal> and
+ <literal role="cfunc">mysql_library_end()</literal> are available
as of MySQL 4.1.10. For earlier versions of MySQL
¤t-series;, call
- <function role="capi">mysql_server_init()</function> and
- <function role="capi">mysql_server_end()</function> instead, which
+ <literal role="cfunc">mysql_server_init()</literal> and
+ <literal role="cfunc">mysql_server_end()</literal> instead, which
are equivalent.
- <function role="capi">mysql_library_init()</function> and
- <function role="capi">mysql_library_end()</function> actually are
+ <literal role="cfunc">mysql_library_init()</literal> and
+ <literal role="cfunc">mysql_library_end()</literal> actually are
<literal>#define</literal> symbols that make them equivalent to
- <function role="capi">mysql_server_init()</function> and
- <function role="capi">mysql_server_end()</function>, but the names
+ <literal role="cfunc">mysql_server_init()</literal> and
+ <literal role="cfunc">mysql_server_end()</literal>, but the names
more clearly indicate that they should be called when beginning
and ending use of a MySQL C API library no matter whether the
application uses <literal>libmysqlclient</literal> or
@@ -13272,7 +13272,7 @@
<section id="mysql-server-init">
- <title><function role="capi">mysql_server_init()</function></title>
+ <title><literal role="cfunc">mysql_server_init()</literal></title>
<indexterm>
<primary>mysql_server_init()</primary>
@@ -13294,9 +13294,9 @@
<para>
As of MySQL 4.1.10,
- <function role="capi">mysql_server_init()</function> is
+ <literal role="cfunc">mysql_server_init()</literal> is
deprecated and you should call
- <function role="capi">mysql_library_init()</function> instead.
+ <literal role="cfunc">mysql_library_init()</literal> instead.
See <xref linkend="mysql-library-init"/>.
</para>
@@ -13312,7 +13312,7 @@
<section id="mysql-server-end">
- <title><function role="capi">mysql_server_end()</function></title>
+ <title><literal role="cfunc">mysql_server_end()</literal></title>
<indexterm>
<primary>mysql_server_end()</primary>
@@ -13333,9 +13333,9 @@
<para>
As of MySQL 4.1.10,
- <function role="capi">mysql_server_end()</function> is
+ <literal role="cfunc">mysql_server_end()</literal> is
deprecated and you should call
- <function role="capi">mysql_library_end()</function> instead.
+ <literal role="cfunc">mysql_library_end()</literal> instead.
See <xref linkend="mysql-library-end"/>.
</para>
@@ -13365,9 +13365,9 @@
<para>
If the connection has gone down, the
- <function role="capi">mysql_ping()</function> function performs a
+ <literal role="cfunc">mysql_ping()</literal> function performs a
reconnect if auto-reconnect is enabled. If auto-reconnect is
- disabled, <function role="capi">mysql_ping()</function> returns an
+ disabled, <literal role="cfunc">mysql_ping()</literal> returns an
error instead.
</para>
@@ -13380,12 +13380,12 @@
<para>
If an automatic reconnection does occur (for example, as a result
- of calling <function role="capi">mysql_ping()</function>), there
+ of calling <literal role="cfunc">mysql_ping()</literal>), there
is no explicit indication of it. To check for reconnection, call
- <function role="capi">mysql_thread_id()</function> to get the
+ <literal role="cfunc">mysql_thread_id()</literal> to get the
original connection identifier before calling
- <function role="capi">mysql_ping()</function>, and then call
- <function role="capi">mysql_thread_id()</function> again to see
+ <literal role="cfunc">mysql_ping()</literal>, and then call
+ <literal role="cfunc">mysql_thread_id()</literal> again to see
whether the identifier has changed.
</para>
@@ -13448,14 +13448,14 @@
<listitem>
<para>
- The value of <function role="sql">LAST_INSERT_ID()</function>
+ The value of <literal role="func">LAST_INSERT_ID()</literal>
is reset to 0.
</para>
</listitem>
<listitem>
<para>
- Locks acquired with <function role="sql">GET_LOCK()</function>
+ Locks acquired with <literal role="func">GET_LOCK()</literal>
are released.
</para>
</listitem>
@@ -13468,7 +13468,7 @@
running if the server has not yet detected that the client is no
longer connected. In this case, any locks held by the original
connection still belong to that session, so you may want to kill
- it by calling <function role="capi">mysql_kill()</function>.
+ it by calling <literal role="cfunc">mysql_kill()</literal>.
</para>
</section>
@@ -13501,15 +13501,15 @@
<section id="null-mysql-store-result">
- <title>Why <function role="capi">mysql_store_result()</function> Sometimes
+ <title>Why <literal role="cfunc">mysql_store_result()</literal> Sometimes
Returns <literal>NULL</literal> After
- <function role="capi">mysql_query()</function> Returns Success</title>
+ <literal role="cfunc">mysql_query()</literal> Returns Success</title>
<para>
It is possible for
- <function role="capi">mysql_store_result()</function> to return
+ <literal role="cfunc">mysql_store_result()</literal> to return
<literal>NULL</literal> following a successful call to
- <function role="capi">mysql_query()</function>. When this
+ <literal role="cfunc">mysql_query()</literal>. When this
happens, it means one of the following conditions occurred:
</para>
@@ -13542,22 +13542,22 @@
<para>
You can always check whether the statement should have produced
a non-empty result by calling
- <function role="capi">mysql_field_count()</function>. If
- <function role="capi">mysql_field_count()</function> returns
+ <literal role="cfunc">mysql_field_count()</literal>. If
+ <literal role="cfunc">mysql_field_count()</literal> returns
zero, the result is empty and the last query was a statement
that does not return values (for example, an
<literal>INSERT</literal> or a <literal>DELETE</literal>). If
- <function role="capi">mysql_field_count()</function> returns a
+ <literal role="cfunc">mysql_field_count()</literal> returns a
non-zero value, the statement should have produced a non-empty
result. See the description of the
- <function role="capi">mysql_field_count()</function> function
+ <literal role="cfunc">mysql_field_count()</literal> function
for an example.
</para>
<para>
You can test for an error by calling
- <function role="capi">mysql_error()</function> or
- <function role="capi">mysql_errno()</function>.
+ <literal role="cfunc">mysql_error()</literal> or
+ <literal role="cfunc">mysql_errno()</literal>.
</para>
</section>
@@ -13575,7 +13575,7 @@
<listitem>
<para>
- <function role="capi">mysql_affected_rows()</function>
+ <literal role="cfunc">mysql_affected_rows()</literal>
returns the number of rows affected by the last query when
doing an <literal>INSERT</literal>,
<literal>UPDATE</literal>, or <literal>DELETE</literal>.
@@ -13586,7 +13586,7 @@
<literal>DELETE</literal> is used without a
<literal>WHERE</literal> clause. In this case, the table is
re-created as an empty table and
- <function role="capi">mysql_affected_rows()</function>
+ <literal role="cfunc">mysql_affected_rows()</literal>
returns zero for the number of records affected. In MySQL
4.0 and later, <literal>DELETE</literal> always returns the
correct number of rows deleted. For a fast re-create, use
@@ -13596,23 +13596,23 @@
<listitem>
<para>
- <function role="capi">mysql_num_rows()</function> returns
+ <literal role="cfunc">mysql_num_rows()</literal> returns
the number of rows in a result set. With
- <function role="capi">mysql_store_result()</function>,
- <function role="capi">mysql_num_rows()</function> may be
+ <literal role="cfunc">mysql_store_result()</literal>,
+ <literal role="cfunc">mysql_num_rows()</literal> may be
called as soon as
- <function role="capi">mysql_store_result()</function>
+ <literal role="cfunc">mysql_store_result()</literal>
returns. With
- <function role="capi">mysql_use_result()</function>,
- <function role="capi">mysql_num_rows()</function> may be
+ <literal role="cfunc">mysql_use_result()</literal>,
+ <literal role="cfunc">mysql_num_rows()</literal> may be
called only after you have fetched all the rows with
- <function role="capi">mysql_fetch_row()</function>.
+ <literal role="cfunc">mysql_fetch_row()</literal>.
</para>
</listitem>
<listitem>
<para>
- <function role="capi">mysql_insert_id()</function> returns
+ <literal role="cfunc">mysql_insert_id()</literal> returns
the ID generated by the last query that inserted a row into
a table with an <literal>AUTO_INCREMENT</literal> index. See
<xref linkend="mysql-insert-id"/>.
@@ -13625,11 +13625,11 @@
<literal>INSERT INTO ... SELECT ...</literal>,
<literal>UPDATE</literal>) return additional information.
The result is returned by
- <function role="capi">mysql_info()</function>. See the
+ <literal role="cfunc">mysql_info()</literal>. See the
description for
- <function role="capi">mysql_info()</function> for the format
+ <literal role="cfunc">mysql_info()</literal> for the format
of the string that it returns.
- <function role="capi">mysql_info()</function> returns a
+ <literal role="cfunc">mysql_info()</literal> returns a
<literal>NULL</literal> pointer if there is no additional
information.
</para>
@@ -13666,7 +13666,7 @@
If you insert a record into a table that contains an
<literal>AUTO_INCREMENT</literal> column, you can obtain the
value stored into that column by calling the
- <function role="capi">mysql_insert_id()</function> function.
+ <literal role="cfunc">mysql_insert_id()</literal> function.
</para>
<para>
@@ -13691,19 +13691,19 @@
When a new <literal>AUTO_INCREMENT</literal> value has been
generated, you can also obtain it by executing a <literal>SELECT
LAST_INSERT_ID()</literal> statement with
- <function role="capi">mysql_query()</function> and retrieving
+ <literal role="cfunc">mysql_query()</literal> and retrieving
the value from the result set returned by the statement.
</para>
<para>
- For <function role="sql">LAST_INSERT_ID()</function>, the most
+ For <literal role="func">LAST_INSERT_ID()</literal>, the most
recently generated ID is maintained in the server on a
per-connection basis. It is not changed by another client. It is
not even changed if you update another
<literal>AUTO_INCREMENT</literal> column with a non-magic value
(that is, a value that is not <literal>NULL</literal> and not
<literal>0</literal>). Using
- <function role="sql">LAST_INSERT_ID()</function> and
+ <literal role="func">LAST_INSERT_ID()</literal> and
<literal>AUTO_INCREMENT</literal> columns simultaneously from
multiple clients is perfectly valid. Each client will receive
the last inserted ID for the last statement
@@ -13724,17 +13724,17 @@
</programlisting>
<para>
- Note that <function role="capi">mysql_insert_id()</function>
+ Note that <literal role="cfunc">mysql_insert_id()</literal>
returns the value stored into an
<literal>AUTO_INCREMENT</literal> column, whether that value is
automatically generated by storing <literal>NULL</literal> or
<literal>0</literal> or was specified as an explicit value.
- <function role="sql">LAST_INSERT_ID()</function> returns only
+ <literal role="func">LAST_INSERT_ID()</literal> returns only
automatically generated <literal>AUTO_INCREMENT</literal>
values. If you store an explicit value other than
<literal>NULL</literal> or <literal>0</literal>, it does not
affect the value returned by
- <function role="sql">LAST_INSERT_ID()</function>.
+ <literal role="func">LAST_INSERT_ID()</literal>.
</para>
<para>
@@ -13747,7 +13747,7 @@
<listitem>
<para>
For information on
- <function role="sql">LAST_INSERT_ID()</function>, which can
+ <literal role="func">LAST_INSERT_ID()</literal>, which can
be used within an SQL statement, see
<xref linkend="information-functions"/>.
</para>
@@ -13756,7 +13756,7 @@
<listitem>
<para>
For information on
- <function role="capi">mysql_insert_id()</function>, the
+ <literal role="cfunc">mysql_insert_id()</literal>, the
function you use from within the C API, see
<xref linkend="mysql-insert-id"/>.
</para>
@@ -13928,16 +13928,16 @@
<para>
Beginning with version 4.0.6, MySQL blocks
<literal>SIGPIPE</literal> on the first call to
- <function role="capi">mysql_server_init()</function>,
- <function role="capi">mysql_init()</function>, or
- <function role="capi">mysql_connect()</function>. This is done
+ <literal role="cfunc">mysql_server_init()</literal>,
+ <literal role="cfunc">mysql_init()</literal>, or
+ <literal role="cfunc">mysql_connect()</literal>. This is done
to avoid aborting the program when a connection terminates. If
you want to use your own <literal>SIGPIPE</literal> handler, you
should first call
- <function role="capi">mysql_server_init()</function> and then
+ <literal role="cfunc">mysql_server_init()</literal> and then
install your handler. As of MySQL 4.1.10, use
- <function role="capi">mysql_library_init()</function> instead of
- <function role="capi">mysql_server_init()</function>.
+ <literal role="cfunc">mysql_library_init()</literal> instead of
+ <literal role="cfunc">mysql_server_init()</literal>.
</para>
</note>
@@ -13975,32 +13975,32 @@
interrupts, you can make great use of the routines in the
<filename>thr_alarm.c</filename> file. If you are using routines
from the <literal>mysys</literal> library, the only thing you must
- remember is to call <function role="capi">my_init()</function>
+ remember is to call <literal role="cfunc">my_init()</literal>
first! See <xref linkend="c-thread-functions"/>.
</para>
<para>
In all cases, be sure to initialize the client library by calling
- <function role="capi">mysql_library_init()</function> before
+ <literal role="cfunc">mysql_library_init()</literal> before
calling any other MySQL functions. When you are done with the
library, call
- <function role="capi">mysql_library_end()</function>.
+ <literal role="cfunc">mysql_library_end()</literal>.
</para>
<para>
- <function role="capi">mysql_real_connect()</function> is not
+ <literal role="cfunc">mysql_real_connect()</literal> is not
thread-safe by default. The following notes describe how to
compile a thread-safe client library and use it in a thread-safe
manner. (The notes below for
- <function role="capi">mysql_real_connect()</function> also apply
- to the older <function role="capi">mysql_connect()</function>
+ <literal role="cfunc">mysql_real_connect()</literal> also apply
+ to the older <literal role="cfunc">mysql_connect()</literal>
routine as well, although
- <function role="capi">mysql_connect()</function> is deprecated and
+ <literal role="cfunc">mysql_connect()</literal> is deprecated and
should no longer be used.)
</para>
<para>
- To make <function role="capi">mysql_real_connect()</function>
+ To make <literal role="cfunc">mysql_real_connect()</literal>
thread-safe, you must configure your MySQL distribution with this
command:
</para>
@@ -14025,8 +14025,8 @@
Two threads can't send a query to the MySQL server at the same
time on the same connection. In particular, you have to ensure
that between calls to
- <function role="capi">mysql_query()</function> and
- <function role="capi">mysql_store_result()</function>, no
+ <literal role="cfunc">mysql_query()</literal> and
+ <literal role="cfunc">mysql_store_result()</literal>, no
other thread is using the same connection.
</para>
</listitem>
@@ -14035,18 +14035,18 @@
<para>
Many threads can access different result sets that are
retrieved with
- <function role="capi">mysql_store_result()</function>.
+ <literal role="cfunc">mysql_store_result()</literal>.
</para>
</listitem>
<listitem>
<para>
If you use
- <function role="capi">mysql_use_result()</function>, you must
+ <literal role="cfunc">mysql_use_result()</literal>, you must
ensure that no other thread is using the same connection until
the result set is closed. However, it really is best for
threaded clients that share the same connection to use
- <function role="capi">mysql_store_result()</function>.
+ <literal role="cfunc">mysql_store_result()</literal>.
</para>
</listitem>
@@ -14054,9 +14054,9 @@
<para>
If you want to use multiple threads on the same connection,
you must have a mutex lock around your pair of
- <function role="capi">mysql_query()</function> and
- <function role="capi">mysql_store_result()</function> calls.
- Once <function role="capi">mysql_store_result()</function> is
+ <literal role="cfunc">mysql_query()</literal> and
+ <literal role="cfunc">mysql_store_result()</literal> calls.
+ Once <literal role="cfunc">mysql_store_result()</literal> is
ready, the lock can be released and other threads may query
the same connection.
</para>
@@ -14073,7 +14073,7 @@
<listitem>
<para>
- <function role="capi">mysql_ping()</function> does not attempt
+ <literal role="cfunc">mysql_ping()</literal> does not attempt
a reconnection if the connection is down. It returns an error
instead.
</para>
@@ -14087,11 +14087,11 @@
</para>
<para>
- When you call <function role="capi">mysql_init()</function>, MySQL
+ When you call <literal role="cfunc">mysql_init()</literal>, MySQL
creates a thread-specific variable for the thread that is used by
the debug library (among other things). If you call a MySQL
function before the thread has called
- <function role="capi">mysql_init()</function>, the thread does not
+ <literal role="cfunc">mysql_init()</literal>, the thread does not
have the necessary thread-specific variables in place and you are
likely to end up with a core dump sooner or later. To get things
to work smoothly you must do the following:
@@ -14101,7 +14101,7 @@
<listitem>
<para>
- Call <function role="capi">mysql_library_init()</function>
+ Call <literal role="cfunc">mysql_library_init()</literal>
before any other MySQL functions. It is not thread-safe, so
call it before threads are created, or protect the call with a
mutex.
@@ -14111,18 +14111,18 @@
<listitem>
<para>
Arrange for
- <function role="capi">mysql_thread_init()</function> to be
+ <literal role="cfunc">mysql_thread_init()</literal> to be
called early in the thread handler before calling any MySQL
function. If you call
- <function role="capi">mysql_init()</function>, they will call
- <function role="capi">mysql_thread_init()</function> for you.
+ <literal role="cfunc">mysql_init()</literal>, they will call
+ <literal role="cfunc">mysql_thread_init()</literal> for you.
</para>
</listitem>
<listitem>
<para>
In the thread, call
- <function role="capi">mysql_thread_end()</function> before
+ <literal role="cfunc">mysql_thread_end()</literal> before
calling <literal>pthread_exit()</literal>. This frees the
memory used by MySQL thread-specific variables.
</para>
@@ -14132,9 +14132,9 @@
<para>
The preceding notes regarding
- <function role="capi">mysql_init()</function> also apply to
- <function role="capi">mysql_connect()</function>, which calls
- <function role="capi">mysql_init()</function>.
+ <literal role="cfunc">mysql_init()</literal> also apply to
+ <literal role="cfunc">mysql_connect()</literal>, which calls
+ <literal role="cfunc">mysql_init()</literal>.
</para>
<para>
Modified: trunk/refman-4.1/apis-libmysqld.xml
===================================================================
--- trunk/refman-4.1/apis-libmysqld.xml 2008-10-27 18:50:56 UTC (rev 12168)
+++ trunk/refman-4.1/apis-libmysqld.xml 2008-10-27 19:03:37 UTC (rev 12169)
Changed blocks: 2, Lines Added: 7, Lines Deleted: 7; 2517 bytes
@@ -46,20 +46,20 @@
<entry><emphasis role="bold">When to Call</emphasis></entry>
</row>
<row>
- <entry><function role="capi">mysql_library_init()</function></entry>
+ <entry><literal role="cfunc">mysql_library_init()</literal></entry>
<entry>Should be called before any other MySQL function is called, preferably
early in the <literal>main()</literal> function.</entry>
</row>
<row>
- <entry><function role="capi">mysql_library_end()</function></entry>
+ <entry><literal role="cfunc">mysql_library_end()</literal></entry>
<entry>Should be called before your program exits.</entry>
</row>
<row>
- <entry><function role="capi">mysql_thread_init()</function></entry>
+ <entry><literal role="cfunc">mysql_thread_init()</literal></entry>
<entry>Should be called in each thread you create that accesses MySQL.</entry>
</row>
<row>
- <entry><function role="capi">mysql_thread_end()</function></entry>
+ <entry><literal role="cfunc">mysql_thread_end()</literal></entry>
<entry>Should be called before calling <literal>pthread_exit()</literal></entry>
</row>
</tbody>
@@ -271,14 +271,14 @@
Any options that may be given with the <command>mysqld</command>
server daemon, may be used with an embedded server library. Server
options may be given in an array as an argument to the
- <function role="capi">mysql_library_init()</function>, which
+ <literal role="cfunc">mysql_library_init()</literal>, which
initializes the server. They also may be given in an option file
like <filename>my.cnf</filename>. To specify an option file for a
C program, use the <option>--defaults-file</option> option as one
of the elements of the second argument of the
- <function role="capi">mysql_library_init()</function> function.
+ <literal role="cfunc">mysql_library_init()</literal> function.
See <xref linkend="mysql-library-init"/>, for more information on
- the <function role="capi">mysql_library_init()</function>
+ the <literal role="cfunc">mysql_library_init()</literal>
function.
</para>
Modified: trunk/refman-4.1/data-types.xml
===================================================================
--- trunk/refman-4.1/data-types.xml 2008-10-27 18:50:56 UTC (rev 12168)
+++ trunk/refman-4.1/data-types.xml 2008-10-27 19:03:37 UTC (rev 12169)
Changed blocks: 20, Lines Added: 49, Lines Deleted: 49; 12672 bytes
@@ -564,9 +564,9 @@
<listitem>
<para>
In
- <function role="sql">MIN(<replaceable>col_name</replaceable>)</function>
+ <literal role="func">MIN(<replaceable>col_name</replaceable>)</literal>
or
- <function role="sql">MAX(<replaceable>col_name</replaceable>)</function>,
+ <literal role="func">MAX(<replaceable>col_name</replaceable>)</literal>,
where <replaceable>col_name</replaceable> refers to
a <literal>BIGINT</literal> column.
</para>
@@ -575,9 +575,9 @@
<listitem>
<para>
When using operators
- (<function role="sqlop" condition="plus">+</function>,
- <function role="sqlop" condition="minus">-</function>,
- <function role="sqlop" condition="times">*</function>,
+ (<literal role="op" condition="plus">+</literal>,
+ <literal role="op" condition="minus">-</literal>,
+ <literal role="op" condition="times">*</literal>,
and so on) where both operands are integers.
</para>
</listitem>
@@ -598,10 +598,10 @@
<listitem>
<para>
The
- <function role="sqlop" condition="minus">-</function>,
- <function role="sqlop" condition="plus">+</function>,
+ <literal role="op" condition="minus">-</literal>,
+ <literal role="op" condition="plus">+</literal>,
and
- <function role="sqlop" condition="times">*</function>
+ <literal role="op" condition="times">*</literal>
operators use <literal>BIGINT</literal> arithmetic when
both operands are integer values. This means that if you
multiply two big integers (or results from functions
@@ -1218,8 +1218,8 @@
</itemizedlist>
<para>
- The <function role="sql">SUM()</function> and
- <function role="sql">AVG()</function> aggregate functions do not
+ The <literal role="func">SUM()</literal> and
+ <literal role="func">AVG()</literal> aggregate functions do not
work with temporal values. (They convert the values to numbers,
which loses the part after the first non-numeric character.) To
work around this problem, you can convert to numeric units,
@@ -2111,10 +2111,10 @@
constant; it cannot be a function or an expression. This means,
for example, that you cannot set the default for a date column
to be the value of a function such as
- <function role="sql">NOW()</function> or
- <function role="sql">CURRENT_DATE</function>. The exception is
+ <literal role="func">NOW()</literal> or
+ <literal role="func">CURRENT_DATE</literal>. The exception is
that you can specify
- <function role="sql">CURRENT_TIMESTAMP</function> as the default
+ <literal role="func">CURRENT_TIMESTAMP</literal> as the default
for a <literal>TIMESTAMP</literal> column as of MySQL 4.1.2. See
<xref linkend="timestamp"/>.
</para>
@@ -2652,8 +2652,8 @@
you simply store the date as <literal>'2009-00-00'</literal> or
<literal>'2009-01-00'</literal>. If you store dates such as these,
you should not expect to get correct results for functions such as
- <function role="sql">DATE_SUB()</function> or
- <function role="sql">DATE_ADD()</function> that require complete
+ <literal role="func">DATE_SUB()</literal> or
+ <literal role="func">DATE_ADD()</literal> that require complete
dates.
</para>
@@ -2958,8 +2958,8 @@
As the result of a function that returns a value that is
acceptable in a <literal>DATETIME</literal>,
<literal>DATE</literal>, or <literal>TIMESTAMP</literal>
- context, such as <function role="sql">NOW()</function> or
- <function role="sql">CURRENT_DATE</function>.
+ context, such as <literal role="func">NOW()</literal> or
+ <literal role="func">CURRENT_DATE</literal>.
</para>
</listitem>
@@ -3259,8 +3259,8 @@
also can be assigned the current date and time by setting it
to <literal>NULL</literal> or to any function that produces
the current date and time
- (<function role="sql">NOW()</function>,
- <function role="sql">CURRENT_TIMESTAMP</function>).
+ (<literal role="func">NOW()</literal>,
+ <literal role="func">CURRENT_TIMESTAMP</literal>).
</para>
<para>
@@ -3311,7 +3311,7 @@
<para>
Another way to maintain a column that records row-creation
time is to use a <literal>DATETIME</literal> column that you
- initialize to <function role="sql">NOW()</function> when the
+ initialize to <literal role="func">NOW()</literal> when the
row is created and do not modify for subsequent updates.
</para>
@@ -3443,7 +3443,7 @@
<para>
If you need to print the timestamps for external
applications, you can use
- <function role="sql">MID()</function> to extract the
+ <literal role="func">MID()</literal> to extract the
relevant part of the timestamp: for example, to imitate
the <literal>TIMESTAMP(4)</literal> display format.
</para>
@@ -3454,17 +3454,17 @@
Although <literal>TIMESTAMP</literal> values are stored to
full precision, the only function that operates directly
on the underlying stored value is
- <function role="sql">UNIX_TIMESTAMP()</function>. Other
+ <literal role="func">UNIX_TIMESTAMP()</literal>. Other
functions operate on the formatted retrieved value. This
means you cannot use a function such as
- <function role="sql">HOUR()</function> or
- <function role="sql">SECOND()</function> unless the
+ <literal role="func">HOUR()</literal> or
+ <literal role="func">SECOND()</literal> unless the
relevant part of the <literal>TIMESTAMP</literal> value is
included in the formatted value. For example, the
<literal>HH</literal> part of a
<literal>TIMESTAMP</literal> column is not displayed
unless the display size is at least 10, so trying to use
- <function role="sql">HOUR()</function> on shorter
+ <literal role="func">HOUR()</literal> on shorter
<literal>TIMESTAMP</literal> values produces a meaningless
result.
</para>
@@ -3814,18 +3814,18 @@
<listitem>
<para>
- <function role="sql">CURRENT_TIMESTAMP</function> or any
+ <literal role="func">CURRENT_TIMESTAMP</literal> or any
of its synonyms
- (<function role="sql">CURRENT_TIMESTAMP()</function>,
- <function role="sql">NOW()</function>,
- <function role="sql">LOCALTIME</function>,
- <function role="sql">LOCALTIME()</function>,
- <function role="sql">LOCALTIMESTAMP</function>, or
- <function role="sql">LOCALTIMESTAMP()</function>) can be
+ (<literal role="func">CURRENT_TIMESTAMP()</literal>,
+ <literal role="func">NOW()</literal>,
+ <literal role="func">LOCALTIME</literal>,
+ <literal role="func">LOCALTIME()</literal>,
+ <literal role="func">LOCALTIMESTAMP</literal>, or
+ <literal role="func">LOCALTIMESTAMP()</literal>) can be
used in the <literal>DEFAULT</literal> and <literal>ON
UPDATE</literal> clauses. They all mean <quote>the current
timestamp.</quote>
- (<function role="sql">UTC_TIMESTAMP</function> is not
+ (<literal role="func">UTC_TIMESTAMP</literal> is not
allowed. Its range of values does not align with those of
the <literal>TIMESTAMP</literal> column anyway unless the
current time zone is <literal>UTC</literal>.)
@@ -3939,14 +3939,14 @@
<listitem>
<para>
Its default value is defined as
- <function role="sql">CURRENT_TIMESTAMP</function>
+ <literal role="func">CURRENT_TIMESTAMP</literal>
</para>
</listitem>
<listitem>
<para>
- <function role="sql">NOW()</function> or
- <function role="sql">CURRENT_TIMESTAMP</function> is
+ <literal role="func">NOW()</literal> or
+ <literal role="func">CURRENT_TIMESTAMP</literal> is
inserted into the column
</para>
</listitem>
@@ -4102,7 +4102,7 @@
<para>
As the result of a function that returns a value that is
acceptable in a <literal>TIME</literal> context, such as
- <function role="sql">CURRENT_TIME</function>.
+ <literal role="func">CURRENT_TIME</literal>.
</para>
</listitem>
@@ -4252,7 +4252,7 @@
<para>
As the result of a function that returns a value that is
acceptable in a <literal>YEAR</literal> context, such as
- <function role="sql">NOW()</function>.
+ <literal role="func">NOW()</literal>.
</para>
</listitem>
@@ -4396,16 +4396,16 @@
</para>
<para>
- Some functions like <function role="sql">MIN()</function> and
- <function role="sql">MAX()</function> convert a
+ Some functions like <literal role="func">MIN()</literal> and
+ <literal role="func">MAX()</literal> convert a
<literal>TIMESTAMP</literal> or <literal>YEAR</literal> to a
number. This means that a value with a two-digit year does not
work properly with these functions. The fix in this case is to
convert the <literal>TIMESTAMP</literal> or
<literal>YEAR</literal> to four-digit year format or use
something like
- <function role="sql">MIN(DATE_ADD(timestamp,INTERVAL 0
- DAY))</function>.
+ <literal role="func">MIN(DATE_ADD(timestamp,INTERVAL 0
+ DAY))</literal>.
</para>
</section>
@@ -5003,7 +5003,7 @@
you want more than <literal>max_sort_length</literal> bytes
to be significant is to convert the column value into a
fixed-length object. The standard way to do this is with the
- <function role="sql">SUBSTRING()</function> function. For
+ <literal role="func">SUBSTRING()</literal> function. For
example, the following statement causes 2000 bytes of the
<literal>comment</literal> column to be taken into account
for sorting:
@@ -5354,8 +5354,8 @@
</para>
<para>
- Functions such as <function role="sql">SUM()</function> or
- <function role="sql">AVG()</function> that expect a numeric
+ Functions such as <literal role="func">SUM()</literal> or
+ <literal role="func">AVG()</literal> that expect a numeric
argument cast the argument to a number if necessary. For
<literal>ENUM</literal> values, the cast operation causes the
index number to be used.
@@ -5585,8 +5585,8 @@
</para>
<para>
- Functions such as <function role="sql">SUM()</function> or
- <function role="sql">AVG()</function> that expect a numeric
+ Functions such as <literal role="func">SUM()</literal> or
+ <literal role="func">AVG()</literal> that expect a numeric
argument cast the argument to a number if necessary. For
<literal>SET</literal> values, the cast operation causes the
numeric value to be used.
@@ -5594,8 +5594,8 @@
<para>
Normally, you search for <literal>SET</literal> values using the
- <function role="sql">FIND_IN_SET()</function> function or the
- <function role="sqlop">LIKE</function> operator:
+ <literal role="func">FIND_IN_SET()</literal> function or the
+ <literal role="op">LIKE</literal> operator:
</para>
<programlisting>
Modified: trunk/refman-4.1/dba-core.xml
===================================================================
--- trunk/refman-4.1/dba-core.xml 2008-10-27 18:50:56 UTC (rev 12168)
+++ trunk/refman-4.1/dba-core.xml 2008-10-27 19:03:37 UTC (rev 12169)
Changed blocks: 52, Lines Added: 83, Lines Deleted: 83; 27709 bytes
@@ -871,8 +871,8 @@
<para>
Read the default DES keys from this file. These keys are
- used by the <function role="sql">DES_ENCRYPT()</function>
- and <function role="sql">DES_DECRYPT()</function> functions.
+ used by the <literal role="func">DES_ENCRYPT()</literal>
+ and <literal role="func">DES_DECRYPT()</literal> functions.
</para>
</listitem>
@@ -3497,7 +3497,7 @@
values to strings. This variable is available as a global,
local, or command-line option.
<replaceable>format_str</replaceable> can be specified
- conveniently using the <function role="sql">GET_FORMAT()</function>
+ conveniently using the <literal role="func">GET_FORMAT()</literal>
function. See <xref linkend="date-and-time-functions"/>.
</para>
-->
@@ -3518,7 +3518,7 @@
<literal>DATETIME</literal> values to strings. This variable
is available as a global, local, or command-line option.
<replaceable>format_str</replaceable> can be specified
- conveniently using the <function role="sql">GET_FORMAT()</function>
+ conveniently using the <literal role="func">GET_FORMAT()</literal>
function. See <xref linkend="date-and-time-functions"/>.
</para>
-->
@@ -3531,7 +3531,7 @@
<para>
The default mode value to use for the
- <function role="sql">WEEK()</function> function. See
+ <literal role="func">WEEK()</literal> function. See
<xref linkend="date-and-time-functions"/>. This variable is
available as of MySQL 4.0.14.
</para>
@@ -3843,7 +3843,7 @@
<para>
The maximum allowed result length in bytes for the
- <function role="sql">GROUP_CONCAT()</function> function. The
+ <literal role="func">GROUP_CONCAT()</literal> function. The
default is 1024. This variable was added in MySQL 4.1.0.
</para>
</listitem>
@@ -3894,8 +3894,8 @@
<literal>YES</literal> if the <literal>zlib</literal>
compression library is available to the server,
<literal>NO</literal> if not. If not, the
- <function role="sql">COMPRESS()</function> and
- <function role="sql">UNCOMPRESS()</function> functions
+ <literal role="func">COMPRESS()</literal> and
+ <literal role="func">UNCOMPRESS()</literal> functions
cannot be used. This variable was added in MySQL 4.1.1.
</para>
</listitem>
@@ -3909,7 +3909,7 @@
<literal>YES</literal> if the <function>crypt()</function>
system call is available to the server,
<literal>NO</literal> if not. If not, the
- <function role="sql">ENCRYPT()</function> function cannot be
+ <literal role="func">ENCRYPT()</literal> function cannot be
used. This variable was added in MySQL 4.0.10.
</para>
</listitem>
@@ -4182,7 +4182,7 @@
interactive connection before closing it. An interactive
client is defined as a client that uses the
<literal>CLIENT_INTERACTIVE</literal> option to
- <function role="capi">mysql_real_connect()</function>. See
+ <literal role="cfunc">mysql_real_connect()</literal>. See
also <literal>wait_timeout</literal>.
</para>
</listitem>
@@ -4388,9 +4388,9 @@
This variable specifies the locale that controls the
language used to display day and month names and
abbreviations. This variable affects the output from the
- <function role="sql">DATE_FORMAT()</function>,
- <function role="sql">DAYNAME()</function> and
- <function role="sql">MONTHNAME()</function> functions.
+ <literal role="func">DATE_FORMAT()</literal>,
+ <literal role="func">DAYNAME()</literal> and
+ <literal role="func">MONTHNAME()</literal> functions.
Locale names are POSIX-style values such as
<literal>'ja_JP'</literal> or <literal>'pt_BR'</literal>.
The default value is <literal>'en_US'</literal> regardless
@@ -6183,7 +6183,7 @@
values to strings. This variable is available as a global,
local, or command-line option.
<replaceable>format_str</replaceable> can be specified
- conveniently using the <function role="sql">GET_FORMAT()</function>
+ conveniently using the <literal role="func">GET_FORMAT()</literal>
function. See <xref linkend="date-and-time-functions"/>.
</para>
-->
@@ -6429,7 +6429,7 @@
global <literal>interactive_timeout</literal> value,
depending on the type of client (as defined by the
<literal>CLIENT_INTERACTIVE</literal> connect option to
- <function role="capi">mysql_real_connect()</function>). See
+ <literal role="cfunc">mysql_real_connect()</literal>). See
also <literal>interactive_timeout</literal>.
</para>
</listitem>
@@ -6736,12 +6736,12 @@
<para>
Set the value to be returned from
- <function role="sql">LAST_INSERT_ID()</function>. This is
+ <literal role="func">LAST_INSERT_ID()</literal>. This is
stored in the binary log when you use
- <function role="sql">LAST_INSERT_ID()</function> in a
+ <literal role="func">LAST_INSERT_ID()</literal> in a
statement that updates a table. Setting this variable does
not update the value returned by the
- <function role="capi">mysql_insert_id()</function> C API
+ <literal role="cfunc">mysql_insert_id()</literal> C API
function.
</para>
</listitem>
@@ -7365,10 +7365,10 @@
</remark>
<para>
- With a <function role="sqlop">LIKE</function> clause, the
+ With a <literal role="op">LIKE</literal> clause, the
statement displays only those variables that match the pattern.
To obtain a specific variable name, use a
- <function role="sqlop">LIKE</function> clause as shown:
+ <literal role="op">LIKE</literal> clause as shown:
</para>
<programlisting>
@@ -7379,7 +7379,7 @@
<para>
To get a list of variables whose name match a pattern, use the
<quote><literal>%</literal></quote> wildcard character in a
- <function role="sqlop">LIKE</function> clause:
+ <literal role="op">LIKE</literal> clause:
</para>
<programlisting>
@@ -7654,7 +7654,7 @@
<para>
However, the following statement does not work. The variable
is not interpreted as a compound name, but as a simple string
- for a <function role="sqlop">LIKE</function> pattern-matching
+ for a <literal role="op">LIKE</literal> pattern-matching
operation:
</para>
@@ -8850,7 +8850,7 @@
a result, identifiers that are the same as function names
must be quoted as described in
<xref linkend="identifiers"/>. For example, because there is
- a <function role="sql">COUNT()</function> function, the use
+ a <literal role="func">COUNT()</literal> function, the use
of <literal>count</literal> as a table name in the following
statement causes an error:
</para>
@@ -9094,10 +9094,10 @@
</para>
<para>
- Treat <function role="sqlop" condition="or">||</function> as
+ Treat <literal role="op" condition="or">||</literal> as
a string concatenation operator (same as
- <function role="sql">CONCAT()</function>) rather than as a
- synonym for <function role="sqlop">OR</function>. (Added in
+ <literal role="func">CONCAT()</literal>) rather than as a
+ synonym for <literal role="op">OR</literal>. (Added in
MySQL 4.0.0)
</para>
</listitem>
@@ -11270,8 +11270,8 @@
Do not store any plain-text passwords in your database. If
your computer becomes compromised, the intruder can take the
full list of passwords and use them. Instead, use
- <function role="sql">MD5()</function>,
- <function role="sql">SHA1()</function>, or some other
+ <literal role="func">MD5()</literal>,
+ <literal role="func">SHA1()</literal>, or some other
one-way hashing function and store the hash value.
</para>
</listitem>
@@ -11457,7 +11457,7 @@
<listitem>
<para>
MySQL C API: Use the
- <function role="capi">mysql_real_escape_string()</function>
+ <literal role="cfunc">mysql_real_escape_string()</literal>
API call.
</para>
</listitem>
@@ -12153,8 +12153,8 @@
<option>--enable-local-infile</option> option, <literal>LOAD
DATA LOCAL</literal> cannot be used by any client unless it
is written explicitly to invoke
- <function role="capi">mysql_options(...
- MYSQL_OPT_LOCAL_INFILE, 0)</function>. See
+ <literal role="cfunc">mysql_options(...
+ MYSQL_OPT_LOCAL_INFILE, 0)</literal>. See
<xref linkend="mysql-options"/>.
</para>
</listitem>
@@ -13646,7 +13646,7 @@
<quote><literal>_</literal></quote> in
<literal>Host</literal> column values. These have the same
meaning as for pattern-matching operations performed with
- the <function role="sqlop">LIKE</function> operator. For
+ the <literal role="op">LIKE</literal> operator. For
example, a <literal>Host</literal> value of
<literal>'%'</literal> matches any hostname, whereas a value
of <literal>'%.mysql.com'</literal> matches any host in the
@@ -13820,7 +13820,7 @@
MySQL does not store passwords in plaintext form for anyone to
see. Rather, the password supplied by a user who is attempting
to connect is encrypted (using the
- <function role="sql">PASSWORD()</function> function). The
+ <literal role="func">PASSWORD()</literal> function). The
encrypted password then is used during the connection process
when checking whether the password is correct. (This is done
without the encrypted password ever traveling over the
@@ -14072,7 +14072,7 @@
are not what you expect, you probably are being authenticated as
some other account. To find out what account the server used to
authenticate you, use the
- <function role="sql">CURRENT_USER()</function> function. (See
+ <literal role="func">CURRENT_USER()</literal> function. (See
<xref linkend="information-functions"/>.) It returns a value in
<literal><replaceable>user_name</replaceable>@<replaceable>host_name</replaceable></literal>
format that indicates the <literal>User</literal> and
@@ -14099,7 +14099,7 @@
</para>
<para>
- The <function role="sql">CURRENT_USER()</function> function is
+ The <literal role="func">CURRENT_USER()</literal> function is
available as of MySQL 4.0.6. See
<xref linkend="information-functions"/>. Another way to diagnose
authentication problems is to print out the
@@ -14173,7 +14173,7 @@
<literal>Host</literal> and <literal>Db</literal> columns of
either table. These have the same meaning as for
pattern-matching operations performed with the
- <function role="sqlop">LIKE</function> operator. If you want
+ <literal role="op">LIKE</literal> operator. If you want
to use either character literally when granting privileges,
you must escape it with a backslash. For example, to include
<quote><literal>_</literal></quote> character as part of a
@@ -14284,7 +14284,7 @@
and <quote><literal>_</literal></quote> can be used in the
<literal>Host</literal> column. These have the same meaning
as for pattern-matching operations performed with the
- <function role="sqlop">LIKE</function> operator.
+ <literal role="op">LIKE</literal> operator.
</para>
</listitem>
@@ -14844,9 +14844,9 @@
If you change a password by using <literal>SET
PASSWORD</literal>, <literal>INSERT</literal>, or
<literal>UPDATE</literal>, you must encrypt the password
- using the <function role="sql">PASSWORD()</function>
+ using the <literal role="func">PASSWORD()</literal>
function. If you do not use
- <function role="sql">PASSWORD()</function> for these
+ <literal role="func">PASSWORD()</literal> for these
statements, the password will not work. For example, the
following statement sets a password, but fails to encrypt
it, so the user is not able to connect afterward:
@@ -14865,12 +14865,12 @@
</programlisting>
<para>
- The <function role="sql">PASSWORD()</function> function is
+ The <literal role="func">PASSWORD()</literal> function is
unnecessary when you specify a password using the
<literal>GRANT</literal> statement or the
<command>mysqladmin password</command> command. Each of
those automatically uses
- <function role="sql">PASSWORD()</function> to encrypt the
+ <literal role="func">PASSWORD()</literal> to encrypt the
password. See <xref linkend="passwords"/>.
</para>
</listitem>
@@ -14977,7 +14977,7 @@
<para>
(Note that if you are running a version of MySQL older than
3.23.11, the output from
- <function role="sql">USER()</function> does not include the
+ <literal role="func">USER()</literal> does not include the
hostname. In this case, you must restart the server with the
<option>--log</option> option, then obtain the hostname from
the log.)
@@ -15307,7 +15307,7 @@
<literal>user</literal> table is not the plaintext version of
the password, but a hash value computed from it. Password hash
values are computed by the
- <function role="sql">PASSWORD()</function> function.
+ <literal role="func">PASSWORD()</literal> function.
</para>
<para>
@@ -15333,7 +15333,7 @@
privileges) set or change the password hashes for accounts
listed in the <literal>user</literal> table. The client can
do this by using the
- <function role="sql">PASSWORD()</function> function to
+ <literal role="func">PASSWORD()</literal> function to
generate a password hash, or by using the
<literal>GRANT</literal> or <literal>SET PASSWORD</literal>
statements.
@@ -15347,7 +15347,7 @@
during authentication when a client first attempts to connect.
The server <emphasis>generates</emphasis> hash values if a
connected client invokes the
- <function role="sql">PASSWORD()</function> function or uses a
+ <literal role="func">PASSWORD()</literal> function or uses a
<literal>GRANT</literal> or <literal>SET PASSWORD</literal>
statement to set or change a password.
</para>
@@ -15403,7 +15403,7 @@
<para>
Prior to MySQL 4.1, password hashes computed by the
- <function role="sql">PASSWORD()</function> function are 16 bytes
+ <literal role="func">PASSWORD()</literal> function are 16 bytes
long. Such hashes look like this:
</para>
@@ -15423,7 +15423,7 @@
</para>
<para>
- As of MySQL 4.1, the <function role="sql">PASSWORD()</function>
+ As of MySQL 4.1, the <literal role="func">PASSWORD()</literal>
function has been modified to produce a longer 41-byte hash
value:
</para>
@@ -15597,7 +15597,7 @@
server notices that long hashes cannot fit into it and
generates only short hashes when a client performs
password-changing operations using
- <function role="sql">PASSWORD()</function>,
+ <literal role="func">PASSWORD()</literal>,
<literal>GRANT</literal>, or <literal>SET
PASSWORD</literal>. This is the behavior that occurs if you
have upgraded to 4.1 but have not yet run the
@@ -15610,7 +15610,7 @@
<para>
If the <literal>Password</literal> column is wide, it can
store either short or long password hashes. In this case,
- <function role="sql">PASSWORD()</function>,
+ <literal role="func">PASSWORD()</literal>,
<literal>GRANT</literal>, and <literal>SET
PASSWORD</literal> generate long hashes unless the server
was started with the <option>--old-passwords</option>
@@ -15716,7 +15716,7 @@
<listitem>
<para>
For connected clients, password hash-generating operations
- involving <function role="sql">PASSWORD()</function>,
+ involving <literal role="func">PASSWORD()</literal>,
<literal>GRANT</literal>, or <literal>SET PASSWORD</literal>
use short hashes exclusively. Any change to an account's
password results in that account having a short password
@@ -15767,7 +15767,7 @@
<listitem>
<para>
For connected clients, password hash-generating operations
- involving <function role="sql">PASSWORD()</function>,
+ involving <literal role="func">PASSWORD()</literal>,
<literal>GRANT</literal>, or <literal>SET PASSWORD</literal>
use long hashes exclusively. A change to an account's
password results in that account having a long password
@@ -15782,7 +15782,7 @@
possible for accounts that have a short password hash to become
inaccessible to pre-4.1 clients. A change to such an account's
password made via <literal>GRANT</literal>,
- <function role="sql">PASSWORD()</function>, or <literal>SET
+ <literal role="func">PASSWORD()</literal>, or <literal>SET
PASSWORD</literal> results in the account being given a long
password hash. From that point on, no pre-4.1 client can
authenticate to that account until the client upgrades to 4.1.
@@ -15800,7 +15800,7 @@
<para>
To change the password but create a short hash, use the
- <function role="sql">OLD_PASSWORD()</function> function instead:
+ <literal role="func">OLD_PASSWORD()</literal> function instead:
</para>
<programlisting>
@@ -15808,7 +15808,7 @@
</programlisting>
<para>
- <function role="sql">OLD_PASSWORD()</function> is useful for
+ <literal role="func">OLD_PASSWORD()</literal> is useful for
situations in which you explicitly want to generate a short
hash.
</para>
@@ -15847,7 +15847,7 @@
<listitem>
<para>
For connected clients, password hash-generating operations
- involving <function role="sql">PASSWORD()</function>,
+ involving <literal role="func">PASSWORD()</literal>,
<literal>GRANT</literal>, or <literal>SET PASSWORD</literal>
use short hashes exclusively. Any change to an account's
password results in that account having a short password
@@ -15881,7 +15881,7 @@
<para>
In scenario 2, accounts with short hashes become inaccessible to
pre-4.1 clients if you change their passwords without explicitly
- using <function role="sql">OLD_PASSWORD()</function>.
+ using <literal role="func">OLD_PASSWORD()</literal>.
</para>
<para>
@@ -15899,36 +15899,36 @@
<para>
An upgrade to MySQL 4.1 can cause a compatibility issue for
applications that use
- <function role="sql">PASSWORD()</function> to generate
+ <literal role="func">PASSWORD()</literal> to generate
passwords for their own purposes. Applications really should
not do this, because
- <function role="sql">PASSWORD()</function> should be used only
+ <literal role="func">PASSWORD()</literal> should be used only
to manage passwords for MySQL accounts. But some applications
- use <function role="sql">PASSWORD()</function> for their own
+ use <literal role="func">PASSWORD()</literal> for their own
purposes anyway.
</para>
<para>
If you upgrade to 4.1 and run the server under conditions
where it generates long password hashes, an application that
- uses <function role="sql">PASSWORD()</function> for its own
+ uses <literal role="func">PASSWORD()</literal> for its own
passwords breaks. The recommended course of action is to
modify the application to use another function, such as
- <function role="sql">SHA1()</function> or
- <function role="sql">MD5()</function>, to produce hashed
+ <literal role="func">SHA1()</literal> or
+ <literal role="func">MD5()</literal>, to produce hashed
values. If that is not possible, you can use the
- <function role="sql">OLD_PASSWORD()</function> function, which
+ <literal role="func">OLD_PASSWORD()</literal> function, which
is provided to generate short hashes in the old format. But
- note that <function role="sql">OLD_PASSWORD()</function> may
+ note that <literal role="func">OLD_PASSWORD()</literal> may
one day no longer be supported.
</para>
<para>
If the server is running under circumstances where it
generates short hashes,
- <function role="sql">OLD_PASSWORD()</function> is available
+ <literal role="func">OLD_PASSWORD()</literal> is available
but is equivalent to
- <function role="sql">PASSWORD()</function>.
+ <literal role="func">PASSWORD()</literal>.
</para>
<para>
@@ -15958,10 +15958,10 @@
<listitem>
<para>
- The <function role="sql">PASSWORD()</function> function is
+ The <literal role="func">PASSWORD()</literal> function is
non-repeatable. That is, with a given argument
<replaceable>X</replaceable>, successive calls to
- <function role="sql">PASSWORD(<replaceable>X</replaceable>)</function>
+ <literal role="func">PASSWORD(<replaceable>X</replaceable>)</literal>
generate different results.
</para>
</listitem>
@@ -16129,12 +16129,12 @@
encryption is different from that used during the Unix login
process. MySQL password encryption is the same as that
implemented by the
- <function role="sql">PASSWORD()</function> SQL function.
+ <literal role="func">PASSWORD()</literal> SQL function.
Unix password encryption is the same as that implemented by
- the <function role="sql">ENCRYPT()</function> SQL function.
+ the <literal role="func">ENCRYPT()</literal> SQL function.
See the descriptions of the
- <function role="sql">PASSWORD()</function> and
- <function role="sql">ENCRYPT()</function> functions in
+ <literal role="func">PASSWORD()</literal> and
+ <literal role="func">ENCRYPT()</literal> functions in
<xref linkend="encryption-functions"/>. From version 4.1 on,
MySQL employs a stronger authentication method that has
better password protection during the connection process
@@ -16446,10 +16446,10 @@
<para>
The reason for using the
- <function role="sql">PASSWORD()</function> function with
+ <literal role="func">PASSWORD()</literal> function with
<literal>INSERT</literal> is to encrypt the password. The
<literal>GRANT</literal> statement encrypts the password for
- you, so <function role="sql">PASSWORD()</function> is
+ you, so <literal role="func">PASSWORD()</literal> is
unnecessary.
</para>
@@ -17003,8 +17003,8 @@
When you assign an account a non-empty password using
<literal>SET PASSWORD</literal>, <literal>INSERT</literal>, or
<literal>UPDATE</literal>, you must use the
- <function role="sql">PASSWORD()</function> function to encrypt
- it. <function role="sql">PASSWORD()</function> is necessary
+ <literal role="func">PASSWORD()</literal> function to encrypt
+ it. <literal role="func">PASSWORD()</literal> is necessary
because the <literal>user</literal> table stores passwords in
encrypted form, not as plaintext. If you forget that fact, you
are likely to set passwords like this:
@@ -17024,7 +17024,7 @@
<para>
When the user <literal>jeffrey</literal> attempts to connect to
the server using this password, the <command>mysql</command>
- client encrypts it with <function role="sql">PASSWORD()</function>, generates
+ client encrypts it with <literal role="func">PASSWORD()</literal>, generates
an authentication vector based on the
<emphasis>encrypted</emphasis> password and a random number
obtained from the server, and sends the result to the server.
@@ -17052,13 +17052,13 @@
BY</literal> statement or the <command>mysqladmin
password</command> command, they both take care of encrypting
the password for you. The
- <function role="sql">PASSWORD()</function> function is
+ <literal role="func">PASSWORD()</literal> function is
unnecessary.
</para>
<note>
<para>
- <function role="sql">PASSWORD()</function> encryption is
+ <literal role="func">PASSWORD()</literal> encryption is
different from Unix password encryption. See
<xref linkend="user-names"/>.
</para>
@@ -17553,9 +17553,9 @@
<para>
To establish a secure connection from within an application
program, use the
- <function role="capi">mysql_ssl_set()</function> C API
+ <literal role="cfunc">mysql_ssl_set()</literal> C API
function to set the appropriate certificate options before
- calling <function role="capi">mysql_real_connect()</function>.
+ calling <literal role="cfunc">mysql_real_connect()</literal>.
See <xref linkend="mysql-ssl-set"/>.
</para>
@@ -19034,9 +19034,9 @@
<para>
In a C program, you can specify the socket file or port
number arguments in the
- <function role="capi">mysql_real_connect()</function> call.
+ <literal role="cfunc">mysql_real_connect()</literal> call.
You can also have the program read option files by calling
- <function role="capi">mysql_options()</function>. See
+ <literal role="cfunc">mysql_options()</literal>. See
<xref linkend="c-api-functions"/>.
</para>
</listitem>
Modified: trunk/refman-4.1/errors-problems.xml
===================================================================
--- trunk/refman-4.1/errors-problems.xml 2008-10-27 18:50:56 UTC (rev 12168)
+++ trunk/refman-4.1/errors-problems.xml 2008-10-27 19:03:37 UTC (rev 12169)
Changed blocks: 25, Lines Added: 45, Lines Deleted: 45; 12962 bytes
@@ -806,7 +806,7 @@
Reset the password to pre-4.1 style for each user that
needs to use a pre-4.1 client program. This can be done
using the <literal>SET PASSWORD</literal> statement and
- the <function role="sql">OLD_PASSWORD()</function>
+ the <literal role="func">OLD_PASSWORD()</literal>
function:
</para>
@@ -866,7 +866,7 @@
the <literal>Host</literal> and
<literal>User</literal> values and assign a password
using the
- <function role="sql">OLD_PASSWORD()</function>
+ <literal role="func">OLD_PASSWORD()</literal>
function and either <literal>SET PASSWORD</literal> or
<literal>UPDATE</literal>, as described earlier.
</para>
@@ -1073,7 +1073,7 @@
If not, correct the query and try again. Otherwise, you can
invoke <command>mysql</command> with the
<option>--quick</option> option. This causes it to use the
- <function role="capi">mysql_use_result()</function> C API
+ <literal role="cfunc">mysql_use_result()</literal> C API
function to retrieve the result set, which places less of a
load on the client (but more on the server).
</para>
@@ -1178,10 +1178,10 @@
<para>
You got a timeout from the TCP/IP connection on the client
side. This may happen if you have been using the commands:
- <function role="capi">mysql_options(...,
- MYSQL_OPT_READ_TIMEOUT,...)</function> or
- <function role="capi">mysql_options(...,
- MYSQL_OPT_WRITE_TIMEOUT,...)</function>. In this case
+ <literal role="cfunc">mysql_options(...,
+ MYSQL_OPT_READ_TIMEOUT,...)</literal> or
+ <literal role="cfunc">mysql_options(...,
+ MYSQL_OPT_WRITE_TIMEOUT,...)</literal>. In this case
increasing the timeout may help solve the problem.
</para>
</listitem>
@@ -1220,7 +1220,7 @@
<para>
The solution to this is to either do a
- <function role="capi">mysql_ping()</function> on the
+ <literal role="cfunc">mysql_ping()</literal> on the
connection if there has been a long time since the last
query (this is what <literal>MyODBC</literal> does) or set
<literal>wait_timeout</literal> on the
@@ -1545,7 +1545,7 @@
<listitem>
<para>
The client program did not call
- <function role="capi">mysql_close()</function> before
+ <literal role="cfunc">mysql_close()</literal> before
exiting.
</para>
</listitem>
@@ -2086,13 +2086,13 @@
<para>
This can happen, for example, if you are using
- <function role="capi">mysql_use_result()</function> and try to
+ <literal role="cfunc">mysql_use_result()</literal> and try to
execute a new query before you have called
- <function role="capi">mysql_free_result()</function>. It can
+ <literal role="cfunc">mysql_free_result()</literal>. It can
also happen if you try to execute two queries that return data
without calling
- <function role="capi">mysql_use_result()</function> or
- <function role="capi">mysql_store_result()</function> in
+ <literal role="cfunc">mysql_use_result()</literal> or
+ <literal role="cfunc">mysql_store_result()</literal> in
between.
</para>
@@ -2159,10 +2159,10 @@
You have specified a password in the
<literal>user</literal> table without using the
- <function role="sql">PASSWORD()</function> function. Use
+ <literal role="func">PASSWORD()</literal> function. Use
<command>mysql</command> to update the account in the
<literal>user</literal> table with a new password, making
- sure to use the <function role="sql">PASSWORD()</function>
+ sure to use the <literal role="func">PASSWORD()</literal>
function:
</para>
@@ -3772,7 +3772,7 @@
If you have a problem with <literal>SELECT NOW()</literal>
returning values in UTC and not your local time, you have to
tell the server your current time zone. The same applies if
- <function role="sql">UNIX_TIMESTAMP()</function> returns the
+ <literal role="func">UNIX_TIMESTAMP()</literal> returns the
wrong value. This should be done for the environment in which
the server runs; for example, in
<command>mysqld_safe</command> or
@@ -3936,8 +3936,8 @@
<para>
To determine whether a value will compare as a non-binary or
binary string, use the
- <function role="sql">COLLATION()</function> function. This
- example shows that <function role="sql">VERSION()</function>
+ <literal role="func">COLLATION()</literal> function. This
+ example shows that <literal role="func">VERSION()</literal>
returns a string that has a case-insensitive collation, so
comparisons are case insensitive:
</para>
@@ -4052,7 +4052,7 @@
<para>
When you use any other comparison method than those just
listed, such as <literal>IN</literal> or
- <function role="sql">STRCMP()</function>.
+ <literal role="func">STRCMP()</literal>.
</para>
</listitem>
@@ -4107,7 +4107,7 @@
</programlisting>
<para>
- <function role="sql">STRCMP()</function> is a string function,
+ <literal role="func">STRCMP()</literal> is a string function,
so it converts <literal>idate</literal> to a string in
<literal>'YYYY-MM-DD'</literal> format and performs a string
comparison. It does not convert <literal>'20030505'</literal>
@@ -4166,9 +4166,9 @@
<para>
To help with <literal>NULL</literal> handling, you can use the
- <function role="sqlop">IS NULL</function> and
- <function role="sqlop">IS NOT NULL</function> operators and
- the <function role="sql">IFNULL()</function> function.
+ <literal role="op">IS NULL</literal> and
+ <literal role="op">IS NOT NULL</literal> operators and
+ the <literal role="func">IFNULL()</literal> function.
</para>
<para>
@@ -4199,7 +4199,7 @@
<para>
To look for <literal>NULL</literal> values, you must use the
- <function role="sqlop">IS NULL</function> test. The following
+ <literal role="op">IS NULL</literal> test. The following
statements show how to find the <literal>NULL</literal> phone
number and the empty phone number:
</para>
@@ -4257,11 +4257,11 @@
<para>
Aggregate (summary) functions such as
- <function role="sql">COUNT()</function>,
- <function role="sql">MIN()</function>, and
- <function role="sql">SUM()</function> ignore
+ <literal role="func">COUNT()</literal>,
+ <literal role="func">MIN()</literal>, and
+ <literal role="func">SUM()</literal> ignore
<literal>NULL</literal> values. The exception to this is
- <function role="sql">COUNT(*)</function>, which counts rows
+ <literal role="func">COUNT(*)</literal>, which counts rows
and not individual column values. For example, the following
statement produces two counts. The first is a count of the
number of rows in the table, and the second is a count of the
@@ -4704,7 +4704,7 @@
<para>
The problem cannot be solved by using
- <function role="sql">ROUND()</function> or similar functions,
+ <literal role="func">ROUND()</literal> or similar functions,
because the result is still a floating-point number:
</para>
@@ -5320,7 +5320,7 @@
<para>
Fixed in MySQL 4.1.10: Using <literal>HAVING</literal>,
you can get a crash or wrong result if you use an alias to
- a <function role="sql">RAND()</function> function. This
+ a <literal role="func">RAND()</literal> function. This
will not be fixed in 4.0 because the fix may break
compatability with some applications.
</para>
@@ -5372,11 +5372,11 @@
<listitem>
<para>
- When using the <function role="sql">RPAD()</function>
+ When using the <literal role="func">RPAD()</literal>
function (or any function adding spaces to the right) in a
query that had to be resolved by using a temporary table,
all resulting strings had rightmost spaces removed (i.e.
- <function role="sql">RPAD()</function> did not work).
+ <literal role="func">RPAD()</literal> did not work).
</para>
</listitem>
@@ -5444,7 +5444,7 @@
MySQL to remember the case used for databases and table
names), MySQL does not remember the case used for database
names for the function
- <function role="sql">DATABASE()</function> or within the
+ <literal role="func">DATABASE()</literal> or within the
various logs (on case-insensitive systems).
</para>
</listitem>
@@ -5469,7 +5469,7 @@
<para>
<literal>DISTINCT</literal> with <literal>ORDER
BY</literal> doesn't work inside
- <function role="sql">GROUP_CONCAT()</function> if you
+ <literal role="func">GROUP_CONCAT()</literal> if you
don't use all and only those columns that are in the
<literal>DISTINCT</literal> list.
</para>
@@ -5751,8 +5751,8 @@
You can't use <quote><literal>_</literal></quote> or
<quote><literal>%</literal></quote> with
<literal>ESCAPE</literal> in
- <function role="sqlop" condition="like">LIKE ...
- ESCAPE</function>.
+ <literal role="op" condition="like">LIKE ...
+ ESCAPE</literal>.
</para>
</listitem>
@@ -5803,7 +5803,7 @@
depends on the function. The general rule is that bit
functions are performed with <literal>BIGINT</literal>
precision, <literal>IF</literal> and
- <function role="sql">ELT()</function> with
+ <literal role="func">ELT()</literal> with
<literal>BIGINT</literal> or <literal>DOUBLE</literal>
precision, and the rest with <literal>DOUBLE</literal>
precision. You should try to avoid using unsigned long
@@ -5823,8 +5823,8 @@
<listitem>
<para>
- In <function role="sql">MIN()</function>,
- <function role="sql">MAX()</function>, and other aggregate
+ In <literal role="func">MIN()</literal>,
+ <literal role="func">MAX()</literal>, and other aggregate
functions, MySQL currently compares
<literal>ENUM</literal> and <literal>SET</literal> columns
by their string value rather than by the string's relative
@@ -6004,21 +6004,21 @@
<listitem>
<para>
MySQL error code: Call
- <function role="capi">mysql_errno()</function>
+ <literal role="cfunc">mysql_errno()</literal>
</para>
</listitem>
<listitem>
<para>
SQLSTATE value: Call
- <function role="capi">mysql_sqlstate()</function>
+ <literal role="cfunc">mysql_sqlstate()</literal>
</para>
</listitem>
<listitem>
<para>
Error message: Call
- <function role="capi">mysql_error()</function>
+ <literal role="cfunc">mysql_error()</literal>
</para>
</listitem>
@@ -6026,9 +6026,9 @@
<para>
For prepared statements, the corresponding error functions are
- <function role="capi">mysql_stmt_errno()</function>,
- <function role="capi">mysql_stmt_sqlstate()</function>, and
- <function role="capi">mysql_stmt_error()</function>. All error
+ <literal role="cfunc">mysql_stmt_errno()</literal>,
+ <literal role="cfunc">mysql_stmt_sqlstate()</literal>, and
+ <literal role="cfunc">mysql_stmt_error()</literal>. All error
functions are described in <xref linkend="c"/>.
</para>
Modified: trunk/refman-4.1/extending-mysql.xml
===================================================================
--- trunk/refman-4.1/extending-mysql.xml 2008-10-27 18:50:56 UTC (rev 12168)
+++ trunk/refman-4.1/extending-mysql.xml 2008-10-27 19:03:37 UTC (rev 12169)
Changed blocks: 3, Lines Added: 4, Lines Deleted: 4; 1463 bytes
@@ -377,8 +377,8 @@
<para>
Whichever method you use to add new functions, they can be invoked
in SQL statements just like native functions such as
- <function role="sql">ABS()</function> or
- <function role="sql">SOUNDEX()</function>.
+ <literal role="func">ABS()</literal> or
+ <literal role="func">SOUNDEX()</literal>.
</para>
<para>
@@ -661,7 +661,7 @@
<para>
For aggregate functions that work like
- <function role="sql">SUM()</function>, you must also provide the
+ <literal role="func">SUM()</literal>, you must also provide the
following functions:
</para>
@@ -1249,7 +1249,7 @@
<literal>0</literal>. A constant argument is an expression
that uses only constants, such as <literal>3</literal> or
<literal>4*7-2</literal> or
- <function role="sql">SIN(3.14)</function>. A non-constant
+ <literal role="func">SIN(3.14)</literal>. A non-constant
argument is an expression that refers to values that may
change from row to row, such as column names or functions
that are called with non-constant arguments.
Modified: trunk/refman-4.1/functions-core.xml
===================================================================
--- trunk/refman-4.1/functions-core.xml 2008-10-27 18:50:56 UTC (rev 12168)
+++ trunk/refman-4.1/functions-core.xml 2008-10-27 19:03:37 UTC (rev 12169)
Changed blocks: 520, Lines Added: 832, Lines Deleted: 832; 240469 bytes
@@ -61,7 +61,7 @@
option. (See <xref linkend="server-sql-mode"/>.) Individual client
programs can request this behavior by using the
<literal>CLIENT_IGNORE_SPACE</literal> option for
- <function role="capi">mysql_real_connect()</function>. In either
+ <literal role="cfunc">mysql_real_connect()</literal>. In either
case, all function names become reserved words.
</para>
@@ -152,9 +152,9 @@
</programlisting>
<para>
- The <function role="sqlop" condition="or">||</function> operator
+ The <literal role="op" condition="or">||</literal> operator
has a precedence between
- <function role="sqlop" condition="bitwise-xor">^</function> and
+ <literal role="op" condition="bitwise-xor">^</literal> and
the unary operators if the <literal>PIPES_AS_CONCAT</literal>
SQL mode is enabled.
</para>
@@ -221,9 +221,9 @@
<para>
It is also possible to perform explicit conversions. If you want
to convert a number to a string explicitly, use the
- <function role="sql">CAST()</function> or
- <function role="sql">CONCAT()</function> function
- (<function role="sql">CAST()</function> is preferable, but is
+ <literal role="func">CAST()</literal> or
+ <literal role="func">CONCAT()</literal> function
+ (<literal role="func">CAST()</literal> is preferable, but is
unavailable before MySQL 4.0.2):
</para>
@@ -246,7 +246,7 @@
If one or both arguments are <literal>NULL</literal>, the
result of the comparison is <literal>NULL</literal>, except
for the <literal>NULL</literal>-safe
- <function role="sqlop" condition="equal-to"><=></function>
+ <literal role="op" condition="equal-to"><=></literal>
equality comparison operator. For <literal>NULL <=>
NULL</literal>, the result is true.
</para>
@@ -289,7 +289,7 @@
a constant, the constant is converted to a timestamp before
the comparison is performed. This is done to be more
ODBC-friendly. Note that this is not done for the arguments
- to <function role="sql">IN()</function>! To be safe, always
+ to <literal role="func">IN()</literal>! To be safe, always
use complete datetime, date, or time strings when doing
comparisons.
</para>
@@ -376,7 +376,7 @@
The results shown will vary on different systems, and can be
affected by factors such as computer architecture or the
compiler version or optimization level. One way to avoid such
- problems is to use <function role="sql">CAST()</function> so
+ problems is to use <literal role="func">CAST()</literal> so
that a value will not be converted implicitly to a float-point
number:
</para>
@@ -424,8 +424,8 @@
<para>
Some of the functions in this section (such as
- <function role="sql">LEAST()</function> and
- <function role="sql">GREATEST()</function>) return values other
+ <literal role="func">LEAST()</literal> and
+ <literal role="func">GREATEST()</literal>) return values other
than <literal>1</literal> (<literal>TRUE</literal>),
<literal>0</literal> (<literal>FALSE</literal>), or
<literal>NULL</literal>. However, the value they return is based
@@ -435,9 +435,9 @@
<para>
To convert a value to a specific type for comparison purposes,
- you can use the <function role="sql">CAST()</function> function.
+ you can use the <literal role="func">CAST()</literal> function.
String values can be converted to a different character set
- using <function role="sql">CONVERT()</function>. See
+ using <literal role="func">CONVERT()</literal>. See
<xref linkend="cast-functions"/>.
</para>
@@ -464,7 +464,7 @@
<primary>equal (=)</primary>
</indexterm>
- <function role="sqlop" condition="equal">=</function>
+ <literal role="op" condition="equal">=</literal>
</para>
<para>
@@ -504,7 +504,7 @@
<primary><=> (equal to)</primary>
</indexterm>
- <function role="sqlop" condition="equal-to"><=></function>
+ <literal role="op" condition="equal-to"><=></literal>
</para>
<remark role="help-syntax-end"/>
@@ -514,7 +514,7 @@
<para>
<literal>NULL</literal>-safe equal. This operator performs
an equality comparison like the
- <function role="sqlop" condition="equal">=</function>
+ <literal role="op" condition="equal">=</literal>
operator, but returns <literal>1</literal> rather than
<literal>NULL</literal> if both operands are
<literal>NULL</literal>, and <literal>0</literal> rather
@@ -564,8 +564,8 @@
<primary>not equal (!=)</primary>
</indexterm>
- <function role="sqlop" condition="not-equal"><></function>,
- <function role="sqlop" condition="not-equal">!=</function>
+ <literal role="op" condition="not-equal"><></literal>,
+ <literal role="op" condition="not-equal">!=</literal>
</para>
<remark role="help-syntax-end"/>
@@ -604,7 +604,7 @@
<primary>less than or equal (<=)</primary>
</indexterm>
- <function role="sqlop" condition="less-than-or-equal"><=</function>
+ <literal role="op" condition="less-than-or-equal"><=</literal>
</para>
<remark role="help-syntax-end"/>
@@ -639,7 +639,7 @@
<primary>less than (<)</primary>
</indexterm>
- <function role="sqlop" condition="less-than"><</function>
+ <literal role="op" condition="less-than"><</literal>
</para>
<remark role="help-syntax-end"/>
@@ -674,7 +674,7 @@
<primary>greater than or equal (>=)</primary>
</indexterm>
- <function role="sqlop" condition="greater-than-or-equal">>=</function>
+ <literal role="op" condition="greater-than-or-equal">>=</literal>
</para>
<remark role="help-syntax-end"/>
@@ -709,7 +709,7 @@
<primary>greater than (>)</primary>
</indexterm>
- <function role="sqlop" condition="greater-than">></function>
+ <literal role="op" condition="greater-than">></literal>
</para>
<remark role="help-syntax-end"/>
@@ -749,8 +749,8 @@
<primary>IS NULL</primary>
</indexterm>
- <function role="sqlop" condition="is-null">IS
- NULL</function>
+ <literal role="op" condition="is-null">IS
+ NULL</literal>
</para>
<remark role="help-syntax-end"/>
@@ -782,7 +782,7 @@
To work well with ODBC programs, MySQL supports the
following extra features when using
- <function role="sqlop">IS NULL</function>:
+ <literal role="op">IS NULL</literal>:
</para>
<itemizedlist>
@@ -848,8 +848,8 @@
<primary>IS NOT NULL</primary>
</indexterm>
- <function role="sqlop" condition="is-null">IS NOT
- NULL</function>
+ <literal role="op" condition="is-null">IS NOT
+ NULL</literal>
</para>
<remark role="help-syntax-end"/>
@@ -884,9 +884,9 @@
<primary>BETWEEN ... AND</primary>
</indexterm>
- <function role="sqlop" condition="between"><replaceable>expr</replaceable>
+ <literal role="op" condition="between"><replaceable>expr</replaceable>
BETWEEN <replaceable>min</replaceable> AND
- <replaceable>max</replaceable></function>
+ <replaceable>max</replaceable></literal>
</para>
<remark role="help-syntax-end"/>
@@ -898,7 +898,7 @@
to <replaceable>min</replaceable> and
<replaceable>expr</replaceable> is less than or equal to
<replaceable>max</replaceable>,
- <function role="sqlop">BETWEEN</function> returns
+ <literal role="op">BETWEEN</literal> returns
<literal>1</literal>, otherwise it returns
<literal>0</literal>. This is equivalent to the expression
<literal>(<replaceable>min</replaceable> <=
@@ -935,9 +935,9 @@
<para>
For best results when using
- <function role="sqlop">BETWEEN</function> with date or time
+ <literal role="op">BETWEEN</literal> with date or time
values, you should use
- <function role="sql">CAST()</function> to explicitly convert
+ <literal role="func">CAST()</literal> to explicitly convert
the values to the desired data type. Examples: If you
compare a <literal>DATETIME</literal> to two
<literal>DATE</literal> values, convert the
@@ -959,9 +959,9 @@
<primary>NOT BETWEEN</primary>
</indexterm>
- <function role="sqlop" condition="not-between"><replaceable>expr</replaceable>
+ <literal role="op" condition="not-between"><replaceable>expr</replaceable>
NOT BETWEEN <replaceable>min</replaceable> AND
- <replaceable>max</replaceable></function>
+ <replaceable>max</replaceable></literal>
</para>
<remark role="help-syntax-end"/>
@@ -993,7 +993,7 @@
<primary>COALESCE()</primary>
</indexterm>
- <function role="sql">COALESCE(<replaceable>value</replaceable>,...)</function>
+ <literal role="func">COALESCE(<replaceable>value</replaceable>,...)</literal>
</para>
<remark role="help-syntax-end"/>
@@ -1018,7 +1018,7 @@
</programlisting>
<para>
- <function role="sql">COALESCE()</function> was added in
+ <literal role="func">COALESCE()</literal> was added in
MySQL 3.23.3.
</para>
</listitem>
@@ -1033,7 +1033,7 @@
<primary>GREATEST()</primary>
</indexterm>
- <function role="sql">GREATEST(<replaceable>value1</replaceable>,<replaceable>value2</replaceable>,...)</function>
+ <literal role="func">GREATEST(<replaceable>value1</replaceable>,<replaceable>value2</replaceable>,...)</literal>
</para>
<remark role="help-syntax-end"/>
@@ -1044,7 +1044,7 @@
With two or more arguments, returns the largest
(maximum-valued) argument. The arguments are compared using
the same rules as for
- <function role="sql">LEAST()</function>.
+ <literal role="func">LEAST()</literal>.
</para>
<remark role="help-description-end"/>
@@ -1061,15 +1061,15 @@
</programlisting>
<para>
- <function role="sql">GREATEST()</function> returns
+ <literal role="func">GREATEST()</literal> returns
<literal>NULL</literal> only if all arguments are
<literal>NULL</literal>.
</para>
<para>
Before MySQL 3.22.5, you can use
- <function role="sql">MAX()</function> instead of
- <function role="sql">GREATEST()</function>.
+ <literal role="func">MAX()</literal> instead of
+ <literal role="func">GREATEST()</literal>.
</para>
</listitem>
@@ -1083,8 +1083,8 @@
<primary>IN</primary>
</indexterm>
- <function role="sql" condition="in"><replaceable>expr</replaceable>
- IN (<replaceable>value</replaceable>,...)</function>
+ <literal role="func" condition="in"><replaceable>expr</replaceable>
+ IN (<replaceable>value</replaceable>,...)</literal>
</para>
<remark role="help-syntax-end"/>
@@ -1170,8 +1170,8 @@
<primary>NOT IN</primary>
</indexterm>
- <function role="sql" condition="not-in"><replaceable>expr</replaceable>
- NOT IN (<replaceable>value</replaceable>,...)</function>
+ <literal role="func" condition="not-in"><replaceable>expr</replaceable>
+ NOT IN (<replaceable>value</replaceable>,...)</literal>
</para>
<remark role="help-syntax-end"/>
@@ -1197,7 +1197,7 @@
<primary>ISNULL()</primary>
</indexterm>
- <function role="sql">ISNULL(<replaceable>expr</replaceable>)</function>
+ <literal role="func">ISNULL(<replaceable>expr</replaceable>)</literal>
</para>
<remark role="help-syntax-end"/>
@@ -1207,7 +1207,7 @@
<para>
If <replaceable>expr</replaceable> is
<literal>NULL</literal>,
- <function role="sql">ISNULL()</function> returns
+ <literal role="func">ISNULL()</literal> returns
<literal>1</literal>, otherwise it returns
<literal>0</literal>.
</para>
@@ -1224,21 +1224,21 @@
</programlisting>
<para>
- <function role="sql">ISNULL()</function> can be used instead
- of <function role="sqlop" condition="equal">=</function> to
+ <literal role="func">ISNULL()</literal> can be used instead
+ of <literal role="op" condition="equal">=</literal> to
test whether a value is <literal>NULL</literal>. (Comparing
a value to <literal>NULL</literal> using
- <function role="sqlop" condition="equal">=</function> always
+ <literal role="op" condition="equal">=</literal> always
yields false.)
</para>
<para>
- The <function role="sql">ISNULL()</function> function shares
+ The <literal role="func">ISNULL()</literal> function shares
some special behaviors with the
- <function role="sqlop" condition="is-null">IS
- NULL</function> comparison operator. See the description of
- <function role="sqlop" condition="is-null">IS
- NULL</function>.
+ <literal role="op" condition="is-null">IS
+ NULL</literal> comparison operator. See the description of
+ <literal role="op" condition="is-null">IS
+ NULL</literal>.
</para>
</listitem>
@@ -1252,7 +1252,7 @@
<primary>INTERVAL()</primary>
</indexterm>
- <function role="sql">INTERVAL(<replaceable>N</replaceable>,<replaceable>N1</replaceable>,<replaceable>N2</replaceable>,<replaceable>N3</replaceable>,...)</function>
+ <literal role="func">INTERVAL(<replaceable>N</replaceable>,<replaceable>N1</replaceable>,<replaceable>N2</replaceable>,<replaceable>N3</replaceable>,...)</literal>
</para>
<remark role="help-syntax-end"/>
@@ -1298,7 +1298,7 @@
<primary>LEAST()</primary>
</indexterm>
- <function role="sql">LEAST(<replaceable>value1</replaceable>,<replaceable>value2</replaceable>,...)</function>
+ <literal role="func">LEAST(<replaceable>value1</replaceable>,<replaceable>value2</replaceable>,...)</literal>
</para>
<remark role="help-syntax-end"/>
@@ -1359,15 +1359,15 @@
</programlisting>
<para>
- <function role="sql">LEAST()</function> returns
+ <literal role="func">LEAST()</literal> returns
<literal>NULL</literal> only if all arguments are
<literal>NULL</literal>.
</para>
<para>
Before MySQL 3.22.5, you can use
- <function role="sql">MIN()</function> instead of
- <function role="sql">LEAST()</function>.
+ <literal role="func">MIN()</literal> instead of
+ <literal role="func">LEAST()</literal>.
</para>
<para>
@@ -1457,8 +1457,8 @@
<primary>! (logical NOT)</primary>
</indexterm>
- <function role="sqlop">NOT</function>,
- <function role="sqlop" condition="not">!</function>
+ <literal role="op">NOT</literal>,
+ <literal role="op" condition="not">!</literal>
</para>
<remark role="help-syntax-end"/>
@@ -1515,8 +1515,8 @@
<primary>&& (logical AND)</primary>
</indexterm>
- <function role="sqlop">AND</function>,
- <function role="sqlop" condition="and">&&</function>
+ <literal role="op">AND</literal>,
+ <literal role="op" condition="and">&&</literal>
</para>
<remark role="help-syntax-end"/>
@@ -1580,8 +1580,8 @@
<primary>|| (logical OR)</primary>
</indexterm>
- <function role="sqlop">OR</function>,
- <function role="sqlop" condition="or">||</function>
+ <literal role="op">OR</literal>,
+ <literal role="op" condition="or">||</literal>
</para>
<remark role="help-syntax-end"/>
@@ -1629,7 +1629,7 @@
<secondary>logical</secondary>
</indexterm>
- <function role="sqlop">XOR</function>
+ <literal role="op">XOR</literal>
</para>
<remark role="help-syntax-end"/>
@@ -1665,7 +1665,7 @@
</para>
<para>
- <function role="sqlop">XOR</function> was added in MySQL
+ <literal role="op">XOR</literal> was added in MySQL
4.0.2.
</para>
</listitem>
@@ -1709,22 +1709,22 @@
<primary>CASE</primary>
</indexterm>
- <function role="sqlop" condition="case">CASE
+ <literal role="op" condition="case">CASE
<replaceable>value</replaceable> WHEN
[<replaceable>compare_value</replaceable>] THEN
<replaceable>result</replaceable> [WHEN
[<replaceable>compare_value</replaceable>] THEN
<replaceable>result</replaceable> ...] [ELSE
- <replaceable>result</replaceable>] END</function>
+ <replaceable>result</replaceable>] END</literal>
</para>
<para>
- <function role="sqlop" condition="case">CASE WHEN
+ <literal role="op" condition="case">CASE WHEN
[<replaceable>condition</replaceable>] THEN
<replaceable>result</replaceable> [WHEN
[<replaceable>condition</replaceable>] THEN
<replaceable>result</replaceable> ...] [ELSE
- <replaceable>result</replaceable>] END</function>
+ <replaceable>result</replaceable>] END</literal>
</para>
<remark role="help-syntax-end"/>
@@ -1767,7 +1767,7 @@
</para>
<para>
- Note that <function role="sqlop">CASE</function> evaluation
+ Note that <literal role="op">CASE</literal> evaluation
depends also on the context in which it is used. If used in
string context, the result is returned as a string. If used in
numeric context, the result is returned decimal, real, or
@@ -1775,7 +1775,7 @@
</para>
<para>
- <function role="sqlop">CASE</function> was added in MySQL
+ <literal role="op">CASE</literal> was added in MySQL
3.23.3.
</para>
</listitem>
@@ -1794,7 +1794,7 @@
<primary>IF()</primary>
</indexterm>
- <function role="sql">IF(<replaceable>expr1</replaceable>,<replaceable>expr2</replaceable>,<replaceable>expr3</replaceable>)</function>
+ <literal role="func">IF(<replaceable>expr1</replaceable>,<replaceable>expr2</replaceable>,<replaceable>expr3</replaceable>)</literal>
</para>
<remark role="help-syntax-end"/>
@@ -1806,10 +1806,10 @@
(<literal><replaceable>expr1</replaceable> <>
0</literal> and <literal><replaceable>expr1</replaceable>
<> NULL</literal>) then
- <function role="sql">IF()</function> returns
+ <literal role="func">IF()</literal> returns
<replaceable>expr2</replaceable>; otherwise it returns
<replaceable>expr3</replaceable>.
- <function role="sql">IF()</function> returns a numeric or
+ <literal role="func">IF()</literal> returns a numeric or
string value, depending on the context in which it is used.
</para>
@@ -1830,7 +1830,7 @@
If only one of <replaceable>expr2</replaceable> or
<replaceable>expr3</replaceable> is explicitly
<literal>NULL</literal>, the result type of the
- <function role="sql">IF()</function> function is the type of
+ <literal role="func">IF()</literal> function is the type of
non-<literal>NULL</literal> expression. (This behavior was
implemented in MySQL 4.0.3.)
</para>
@@ -1850,10 +1850,10 @@
<para>
In the first case shown,
- <function role="sql">IF(0.1)</function> returns
+ <literal role="func">IF(0.1)</literal> returns
<literal>0</literal> because <literal>0.1</literal> is
converted to an integer value, resulting in a test of
- <function role="sql">IF(0)</function>. This may not be what
+ <literal role="func">IF(0)</literal>. This may not be what
you expect. In the second case, the comparison tests the
original floating-point value to see whether it is non-zero.
The result of the comparison is used as an integer.
@@ -1861,7 +1861,7 @@
<para>
The default return type of
- <function role="sql">IF()</function> (which may matter when it
+ <literal role="func">IF()</literal> (which may matter when it
is stored into a temporary table) is calculated in MySQL 3.23
as follows:
</para>
@@ -1917,7 +1917,7 @@
<primary>IFNULL()</primary>
</indexterm>
- <function role="sql">IFNULL(<replaceable>expr1</replaceable>,<replaceable>expr2</replaceable>)</function>
+ <literal role="func">IFNULL(<replaceable>expr1</replaceable>,<replaceable>expr2</replaceable>)</literal>
</para>
<remark role="help-syntax-end"/>
@@ -1927,10 +1927,10 @@
<para>
If <replaceable>expr1</replaceable> is not
<literal>NULL</literal>,
- <function role="sql">IFNULL()</function> returns
+ <literal role="func">IFNULL()</literal> returns
<replaceable>expr1</replaceable>; otherwise it returns
<replaceable>expr2</replaceable>.
- <function role="sql">IFNULL()</function> returns a numeric or
+ <literal role="func">IFNULL()</literal> returns a numeric or
string value, depending on the context in which it is used.
</para>
@@ -1951,13 +1951,13 @@
<para>
In MySQL 4.0.6 and above, the default result value of
- <function role="sql">IFNULL(<replaceable>expr1</replaceable>,<replaceable>expr2</replaceable>)</function>
+ <literal role="func">IFNULL(<replaceable>expr1</replaceable>,<replaceable>expr2</replaceable>)</literal>
is the more <quote>general</quote> of the two expressions, in
the order <literal>STRING</literal>, <literal>REAL</literal>,
or <literal>INTEGER</literal>. The difference from earlier
MySQL versions is mostly notable when you create a table based
on expressions or MySQL has to internally store a value from
- <function role="sql">IFNULL()</function> in a temporary table.
+ <literal role="func">IFNULL()</literal> in a temporary table.
</para>
<programlisting>
@@ -1987,7 +1987,7 @@
<primary>NULLIF()</primary>
</indexterm>
- <function role="sql">NULLIF(<replaceable>expr1</replaceable>,<replaceable>expr2</replaceable>)</function>
+ <literal role="func">NULLIF(<replaceable>expr1</replaceable>,<replaceable>expr2</replaceable>)</literal>
</para>
<remark role="help-syntax-end"/>
@@ -1999,10 +1999,10 @@
<literal><replaceable>expr1</replaceable> =
<replaceable>expr2</replaceable></literal> is true, otherwise
returns <replaceable>expr1</replaceable>. This is the same as
- <function role="sqlop" condition="case">CASE WHEN
+ <literal role="op" condition="case">CASE WHEN
<replaceable>expr1</replaceable> =
<replaceable>expr2</replaceable> THEN NULL ELSE
- <replaceable>expr1</replaceable> END</function>.
+ <replaceable>expr1</replaceable> END</literal>.
</para>
<remark role="help-description-end"/>
@@ -2022,7 +2022,7 @@
</para>
<para>
- <function role="sql">NULLIF()</function> was added in MySQL
+ <literal role="func">NULLIF()</literal> was added in MySQL
3.23.15.
</para>
</listitem>
@@ -2081,7 +2081,7 @@
<primary>ASCII()</primary>
</indexterm>
- <function role="sql">ASCII(<replaceable>str</replaceable>)</function>
+ <literal role="func">ASCII(<replaceable>str</replaceable>)</literal>
</para>
<remark role="help-syntax-end"/>
@@ -2094,7 +2094,7 @@
<literal>0</literal> if <replaceable>str</replaceable> is the
empty string. Returns <literal>NULL</literal> if
<replaceable>str</replaceable> is <literal>NULL</literal>.
- <function role="sql">ASCII()</function> works for 8-bit
+ <literal role="func">ASCII()</literal> works for 8-bit
characters.
</para>
@@ -2112,7 +2112,7 @@
</programlisting>
<para>
- See also the <function role="sql">ORD()</function> function.
+ See also the <literal role="func">ORD()</literal> function.
</para>
</listitem>
@@ -2126,7 +2126,7 @@
<primary>BIN()</primary>
</indexterm>
- <function role="sql">BIN(<replaceable>N</replaceable>)</function>
+ <literal role="func">BIN(<replaceable>N</replaceable>)</literal>
</para>
<remark role="help-syntax-end"/>
@@ -2138,7 +2138,7 @@
<replaceable>N</replaceable>, where
<replaceable>N</replaceable> is a longlong
(<literal>BIGINT</literal>) number. This is equivalent to
- <function role="sql">CONV(<replaceable>N</replaceable>,10,2)</function>.
+ <literal role="func">CONV(<replaceable>N</replaceable>,10,2)</literal>.
Returns <literal>NULL</literal> if
<replaceable>N</replaceable> is <literal>NULL</literal>.
</para>
@@ -2163,7 +2163,7 @@
<primary>BIT_LENGTH()</primary>
</indexterm>
- <function role="sql">BIT_LENGTH(<replaceable>str</replaceable>)</function>
+ <literal role="func">BIT_LENGTH(<replaceable>str</replaceable>)</literal>
</para>
<remark role="help-syntax-end"/>
@@ -2185,7 +2185,7 @@
</programlisting>
<para>
- <function role="sql">BIT_LENGTH()</function> was added in
+ <literal role="func">BIT_LENGTH()</literal> was added in
MySQL 4.0.2.
</para>
</listitem>
@@ -2200,8 +2200,8 @@
<primary>CHAR()</primary>
</indexterm>
- <function role="sql">CHAR(<replaceable>N</replaceable>,...
- [USING <replaceable>charset_name</replaceable>])</function>
+ <literal role="func">CHAR(<replaceable>N</replaceable>,...
+ [USING <replaceable>charset_name</replaceable>])</literal>
</para>
<remark role="help-syntax-end"/>
@@ -2209,7 +2209,7 @@
<remark role="help-description-begin"/>
<para>
- <function role="sql">CHAR()</function> interprets each
+ <literal role="func">CHAR()</literal> interprets each
argument <replaceable>N</replaceable> as an integer and
returns a string consisting of the characters given by the
code values of those integers. <literal>NULL</literal> values
@@ -2230,7 +2230,7 @@
<remark role="help-description-begin"/>
<para>
- <function role="sql">CHAR()</function> returns a string in the
+ <literal role="func">CHAR()</literal> returns a string in the
connection character set. As of MySQL 4.1.16, the optional
<literal>USING</literal> clause may be used to produce a
string in a given character set:
@@ -2258,7 +2258,7 @@
<primary>CHAR_LENGTH()</primary>
</indexterm>
- <function role="sql">CHAR_LENGTH(<replaceable>str</replaceable>)</function>
+ <literal role="func">CHAR_LENGTH(<replaceable>str</replaceable>)</literal>
</para>
<remark role="help-syntax-end"/>
@@ -2270,9 +2270,9 @@
<replaceable>str</replaceable>, measured in characters. A
multi-byte character counts as a single character. This means
that for a string containing five two-byte characters,
- <function role="sql">LENGTH()</function> returns
+ <literal role="func">LENGTH()</literal> returns
<literal>10</literal>, whereas
- <function role="sql">CHAR_LENGTH()</function> returns
+ <literal role="func">CHAR_LENGTH()</literal> returns
<literal>5</literal>.
</para>
@@ -2289,7 +2289,7 @@
<primary>CHARACTER_LENGTH()</primary>
</indexterm>
- <function role="sql">CHARACTER_LENGTH(<replaceable>str</replaceable>)</function>
+ <literal role="func">CHARACTER_LENGTH(<replaceable>str</replaceable>)</literal>
</para>
<remark role="help-syntax-end"/>
@@ -2297,8 +2297,8 @@
<remark role="help-description-begin"/>
<para>
- <function role="sql">CHARACTER_LENGTH()</function> is a
- synonym for <function role="sql">CHAR_LENGTH()</function>.
+ <literal role="func">CHARACTER_LENGTH()</literal> is a
+ synonym for <literal role="func">CHAR_LENGTH()</literal>.
</para>
<remark role="help-description-end"/>
@@ -2314,7 +2314,7 @@
<primary>CONCAT()</primary>
</indexterm>
- <function role="sql">CONCAT(<replaceable>str1</replaceable>,<replaceable>str2</replaceable>,...)</function>
+ <literal role="func">CONCAT(<replaceable>str1</replaceable>,<replaceable>str2</replaceable>,...)</literal>
</para>
<remark role="help-syntax-end"/>
@@ -2336,7 +2336,7 @@
</programlisting>
<para>
- <function role="sql">CONCAT()</function> returns
+ <literal role="func">CONCAT()</literal> returns
<literal>NULL</literal> if any argument is
<literal>NULL</literal>.
</para>
@@ -2365,7 +2365,7 @@
<primary>CONCAT_WS()</primary>
</indexterm>
- <function role="sql">CONCAT_WS(<replaceable>separator</replaceable>,<replaceable>str1</replaceable>,<replaceable>str2</replaceable>,...)</function>
+ <literal role="func">CONCAT_WS(<replaceable>separator</replaceable>,<replaceable>str1</replaceable>,<replaceable>str2</replaceable>,...)</literal>
</para>
<remark role="help-syntax-end"/>
@@ -2373,9 +2373,9 @@
<remark role="help-description-begin"/>
<para>
- <function role="sql">CONCAT_WS()</function> stands for
+ <literal role="func">CONCAT_WS()</literal> stands for
Concatenate With Separator and is a special form of
- <function role="sql">CONCAT()</function>. The first argument
+ <literal role="func">CONCAT()</literal>. The first argument
is the separator for the rest of the arguments. The separator
is added between the strings to be concatenated. The separator
can be a string, as can the rest of the arguments. If the
@@ -2395,10 +2395,10 @@
</programlisting>
<para>
- <function role="sql">CONCAT_WS()</function> skips any
+ <literal role="func">CONCAT_WS()</literal> skips any
<literal>NULL</literal> values after the separator argument.
Before MySQL 4.0.14,
- <function role="sql">CONCAT_WS()</function> skips empty
+ <literal role="func">CONCAT_WS()</literal> skips empty
strings as well as <literal>NULL</literal> values.
</para>
</listitem>
@@ -2413,7 +2413,7 @@
<primary>ELT()</primary>
</indexterm>
- <function role="sql">ELT(<replaceable>N</replaceable>,<replaceable>str1</replaceable>,<replaceable>str2</replaceable>,<replaceable>str3</replaceable>,...)</function>
+ <literal role="func">ELT(<replaceable>N</replaceable>,<replaceable>str1</replaceable>,<replaceable>str2</replaceable>,<replaceable>str3</replaceable>,...)</literal>
</para>
<remark role="help-syntax-end"/>
@@ -2428,8 +2428,8 @@
on. Returns <literal>NULL</literal> if
<replaceable>N</replaceable> is less than <literal>1</literal>
or greater than the number of arguments.
- <function role="sql">ELT()</function> is the complement of
- <function role="sql">FIELD()</function>.
+ <literal role="func">ELT()</literal> is the complement of
+ <literal role="func">FIELD()</literal>.
</para>
<remark role="help-description-end"/>
@@ -2454,7 +2454,7 @@
<primary>EXPORT_SET()</primary>
</indexterm>
- <function role="sql">EXPORT_SET(<replaceable>bits</replaceable>,<replaceable>on</replaceable>,<replaceable>off</replaceable>[,<replaceable>separator</replaceable>[,<replaceable>number_of_bits</replaceable>]])</function>
+ <literal role="func">EXPORT_SET(<replaceable>bits</replaceable>,<replaceable>on</replaceable>,<replaceable>off</replaceable>[,<replaceable>separator</replaceable>[,<replaceable>number_of_bits</replaceable>]])</literal>
</para>
<remark role="help-syntax-end"/>
@@ -2498,7 +2498,7 @@
<primary>FIELD()</primary>
</indexterm>
- <function role="sql">FIELD(<replaceable>str</replaceable>,<replaceable>str1</replaceable>,<replaceable>str2</replaceable>,<replaceable>str3</replaceable>,...)</function>
+ <literal role="func">FIELD(<replaceable>str</replaceable>,<replaceable>str1</replaceable>,<replaceable>str2</replaceable>,<replaceable>str3</replaceable>,...)</literal>
</para>
<remark role="help-syntax-end"/>
@@ -2515,7 +2515,7 @@
</para>
<para>
- If all arguments to <function role="sql">FIELD()</function>
+ If all arguments to <literal role="func">FIELD()</literal>
are strings, all arguments are compared as strings. If all
arguments are numbers, they are compared as numbers.
Otherwise, the arguments are compared as double.
@@ -2525,8 +2525,8 @@
If <replaceable>str</replaceable> is <literal>NULL</literal>,
the return value is <literal>0</literal> because
<literal>NULL</literal> fails equality comparison with any
- value. <function role="sql">FIELD()</function> is the
- complement of <function role="sql">ELT()</function>.
+ value. <literal role="func">FIELD()</literal> is the
+ complement of <literal role="func">ELT()</literal>.
</para>
<remark role="help-description-end"/>
@@ -2551,7 +2551,7 @@
<primary>FIND_IN_SET()</primary>
</indexterm>
- <function role="sql">FIND_IN_SET(<replaceable>str</replaceable>,<replaceable>strlist</replaceable>)</function>
+ <literal role="func">FIND_IN_SET(<replaceable>str</replaceable>,<replaceable>strlist</replaceable>)</literal>
</para>
<remark role="help-syntax-end"/>
@@ -2568,7 +2568,7 @@
<quote><literal>,</literal></quote> characters. If the first
argument is a constant string and the second is a column of
type <literal>SET</literal>, the
- <function role="sql">FIND_IN_SET()</function> function is
+ <literal role="func">FIND_IN_SET()</literal> function is
optimized to use bit arithmetic. Returns <literal>0</literal>
if <replaceable>str</replaceable> is not in
<replaceable>strlist</replaceable> or if
@@ -2599,7 +2599,7 @@
<primary>FORMAT()</primary>
</indexterm>
- <function role="sql">FORMAT(<replaceable>X</replaceable>,<replaceable>D</replaceable>)</function>
+ <literal role="func">FORMAT(<replaceable>X</replaceable>,<replaceable>D</replaceable>)</literal>
</para>
<remark role="help-syntax-end"/>
@@ -2639,7 +2639,7 @@
<primary>HEX()</primary>
</indexterm>
- <function role="sql">HEX(<replaceable>N_or_S</replaceable>)</function>
+ <literal role="func">HEX(<replaceable>N_or_S</replaceable>)</literal>
</para>
<remark role="help-syntax-end"/>
@@ -2652,7 +2652,7 @@
<replaceable>N</replaceable>, where
<replaceable>N</replaceable> is a longlong
(<literal>BIGINT</literal>) number. This is equivalent to
- <function role="sql">CONV(<replaceable>N</replaceable>,10,16)</function>.
+ <literal role="func">CONV(<replaceable>N</replaceable>,10,16)</literal>.
</para>
<para>
@@ -2661,7 +2661,7 @@
<replaceable>N_or_S</replaceable> where each character in
<replaceable>N_or_S</replaceable> is converted to two
hexadecimal digits. The inverse of this operation is performed
- by the <function role="sql">UNHEX()</function> function.
+ by the <literal role="func">UNHEX()</literal> function.
</para>
<remark role="help-description-end"/>
@@ -2692,7 +2692,7 @@
<primary>INSERT()</primary>
</indexterm>
- <function role="sql">INSERT(<replaceable>str</replaceable>,<replaceable>pos</replaceable>,<replaceable>len</replaceable>,<replaceable>newstr</replaceable>)</function>
+ <literal role="func">INSERT(<replaceable>str</replaceable>,<replaceable>pos</replaceable>,<replaceable>len</replaceable>,<replaceable>newstr</replaceable>)</literal>
</para>
<remark role="help-syntax-end"/>
@@ -2740,7 +2740,7 @@
<primary>INSTR()</primary>
</indexterm>
- <function role="sql">INSTR(<replaceable>str</replaceable>,<replaceable>substr</replaceable>)</function>
+ <literal role="func">INSTR(<replaceable>str</replaceable>,<replaceable>substr</replaceable>)</literal>
</para>
<remark role="help-syntax-end"/>
@@ -2751,7 +2751,7 @@
Returns the position of the first occurrence of substring
<replaceable>substr</replaceable> in string
<replaceable>str</replaceable>. This is the same as the
- two-argument form of <function role="sql">LOCATE()</function>,
+ two-argument form of <literal role="func">LOCATE()</literal>,
except that the order of the arguments is reversed.
</para>
@@ -2783,7 +2783,7 @@
<primary>LCASE()</primary>
</indexterm>
- <function role="sql">LCASE(<replaceable>str</replaceable>)</function>
+ <literal role="func">LCASE(<replaceable>str</replaceable>)</literal>
</para>
<remark role="help-syntax-end"/>
@@ -2791,8 +2791,8 @@
<remark role="help-description-begin"/>
<para>
- <function role="sql">LCASE()</function> is a synonym for
- <function role="sql">LOWER()</function>.
+ <literal role="func">LCASE()</literal> is a synonym for
+ <literal role="func">LOWER()</literal>.
</para>
<remark role="help-description-end"/>
@@ -2808,7 +2808,7 @@
<primary>LEFT()</primary>
</indexterm>
- <function role="sql">LEFT(<replaceable>str</replaceable>,<replaceable>len</replaceable>)</function>
+ <literal role="func">LEFT(<replaceable>str</replaceable>,<replaceable>len</replaceable>)</literal>
</para>
<remark role="help-syntax-end"/>
@@ -2840,7 +2840,7 @@
<primary>LENGTH()</primary>
</indexterm>
- <function role="sql">LENGTH(<replaceable>str</replaceable>)</function>
+ <literal role="func">LENGTH(<replaceable>str</replaceable>)</literal>
</para>
<remark role="help-syntax-end"/>
@@ -2852,9 +2852,9 @@
<replaceable>str</replaceable>, measured in bytes. A
multi-byte character counts as multiple bytes. This means that
for a string containing five two-byte characters,
- <function role="sql">LENGTH()</function> returns
+ <literal role="func">LENGTH()</literal> returns
<literal>10</literal>, whereas
- <function role="sql">CHAR_LENGTH()</function> returns
+ <literal role="func">CHAR_LENGTH()</literal> returns
<literal>5</literal>.
</para>
@@ -2882,7 +2882,7 @@
<primary>LOAD_FILE()</primary>
</indexterm>
- <function role="sql">LOAD_FILE(<replaceable>file_name</replaceable>)</function>
+ <literal role="func">LOAD_FILE(<replaceable>file_name</replaceable>)</literal>
</para>
<remark role="help-syntax-end"/>
@@ -2934,8 +2934,8 @@
<primary>LOCATE()</primary>
</indexterm>
- <function role="sql">LOCATE(<replaceable>substr</replaceable>,<replaceable>str</replaceable>)</function>,
- <function role="sql">LOCATE(<replaceable>substr</replaceable>,<replaceable>str</replaceable>,<replaceable>pos</replaceable>)</function>
+ <literal role="func">LOCATE(<replaceable>substr</replaceable>,<replaceable>str</replaceable>)</literal>,
+ <literal role="func">LOCATE(<replaceable>substr</replaceable>,<replaceable>str</replaceable>,<replaceable>pos</replaceable>)</literal>
</para>
<remark role="help-syntax-end"/>
@@ -2984,7 +2984,7 @@
<primary>LOWER()</primary>
</indexterm>
- <function role="sql">LOWER(<replaceable>str</replaceable>)</function>
+ <literal role="func">LOWER(<replaceable>str</replaceable>)</literal>
</para>
<remark role="help-syntax-end"/>
@@ -3004,8 +3004,8 @@
</programlisting>
<para>
- <function role="sql">LOWER()</function> (and
- <function role="sql">UPPER()</function>) are ineffective when
+ <literal role="func">LOWER()</literal> (and
+ <literal role="func">UPPER()</literal>) are ineffective when
applied to binary strings (<literal>BINARY</literal>,
<literal>VARBINARY</literal>, <literal>BLOB</literal>). To
perform lettercase conversion, convert the string to a
@@ -3039,7 +3039,7 @@
<primary>LPAD()</primary>
</indexterm>
- <function role="sql">LPAD(<replaceable>str</replaceable>,<replaceable>len</replaceable>,<replaceable>padstr</replaceable>)</function>
+ <literal role="func">LPAD(<replaceable>str</replaceable>,<replaceable>len</replaceable>,<replaceable>padstr</replaceable>)</literal>
</para>
<para>
@@ -3077,7 +3077,7 @@
<primary>LTRIM()</primary>
</indexterm>
- <function role="sql">LTRIM(<replaceable>str</replaceable>)</function>
+ <literal role="func">LTRIM(<replaceable>str</replaceable>)</literal>
</para>
<remark role="help-syntax-end"/>
@@ -3113,7 +3113,7 @@
<primary>MAKE_SET()</primary>
</indexterm>
- <function role="sql">MAKE_SET(<replaceable>bits</replaceable>,<replaceable>str1</replaceable>,<replaceable>str2</replaceable>,...)</function>
+ <literal role="func">MAKE_SET(<replaceable>bits</replaceable>,<replaceable>str1</replaceable>,<replaceable>str2</replaceable>,...)</literal>
</para>
<remark role="help-syntax-end"/>
@@ -3159,7 +3159,7 @@
<primary>MID()</primary>
</indexterm>
- <function role="sql">MID(<replaceable>str</replaceable>,<replaceable>pos</replaceable>,<replaceable>len</replaceable>)</function>
+ <literal role="func">MID(<replaceable>str</replaceable>,<replaceable>pos</replaceable>,<replaceable>len</replaceable>)</literal>
</para>
<remark role="help-syntax-end"/>
@@ -3167,9 +3167,9 @@
<remark role="help-description-begin"/>
<para>
- <function role="sql">MID(<replaceable>str</replaceable>,<replaceable>pos</replaceable>,<replaceable>len</replaceable>)</function>
+ <literal role="func">MID(<replaceable>str</replaceable>,<replaceable>pos</replaceable>,<replaceable>len</replaceable>)</literal>
is a synonym for
- <function role="sql">SUBSTRING(<replaceable>str</replaceable>,<replaceable>pos</replaceable>,<replaceable>len</replaceable>)</function>.
+ <literal role="func">SUBSTRING(<replaceable>str</replaceable>,<replaceable>pos</replaceable>,<replaceable>len</replaceable>)</literal>.
</para>
<remark role="help-description-end"/>
@@ -3185,7 +3185,7 @@
<primary>OCTET_LENGTH()</primary>
</indexterm>
- <function role="sql">OCTET_LENGTH(<replaceable>str</replaceable>)</function>
+ <literal role="func">OCTET_LENGTH(<replaceable>str</replaceable>)</literal>
</para>
<remark role="help-syntax-end"/>
@@ -3193,8 +3193,8 @@
<remark role="help-description-begin"/>
<para>
- <function role="sql">OCTET_LENGTH()</function> is a synonym
- for <function role="sql">LENGTH()</function>.
+ <literal role="func">OCTET_LENGTH()</literal> is a synonym
+ for <literal role="func">LENGTH()</literal>.
</para>
<remark role="help-description-end"/>
@@ -3210,7 +3210,7 @@
<primary>ORD()</primary>
</indexterm>
- <function role="sql">ORD(<replaceable>str</replaceable>)</function>
+ <literal role="func">ORD(<replaceable>str</replaceable>)</literal>
</para>
<remark role="help-syntax-end"/>
@@ -3232,8 +3232,8 @@
<para>
If the leftmost character is not a multi-byte character,
- <function role="sql">ORD()</function> returns the same value
- as the <function role="sql">ASCII()</function> function.
+ <literal role="func">ORD()</literal> returns the same value
+ as the <literal role="func">ASCII()</literal> function.
</para>
<remark role="help-description-end"/>
@@ -3256,8 +3256,8 @@
<primary>POSITION()</primary>
</indexterm>
- <function role="sql">POSITION(<replaceable>substr</replaceable>
- IN <replaceable>str</replaceable>)</function>
+ <literal role="func">POSITION(<replaceable>substr</replaceable>
+ IN <replaceable>str</replaceable>)</literal>
</para>
<remark role="help-syntax-end"/>
@@ -3265,9 +3265,9 @@
<remark role="help-description-begin"/>
<para>
- <function role="sql">POSITION(<replaceable>substr</replaceable>
- IN <replaceable>str</replaceable>)</function> is a synonym for
- <function role="sql">LOCATE(<replaceable>substr</replaceable>,<replaceable>str</replaceable>)</function>.
+ <literal role="func">POSITION(<replaceable>substr</replaceable>
+ IN <replaceable>str</replaceable>)</literal> is a synonym for
+ <literal role="func">LOCATE(<replaceable>substr</replaceable>,<replaceable>str</replaceable>)</literal>.
</para>
<remark role="help-description-end"/>
@@ -3283,7 +3283,7 @@
<primary>QUOTE()</primary>
</indexterm>
- <function role="sql">QUOTE(<replaceable>str</replaceable>)</function>
+ <literal role="func">QUOTE(<replaceable>str</replaceable>)</literal>
</para>
<remark role="help-syntax-end"/>
@@ -3299,7 +3299,7 @@
<literal>NUL</literal>, and Control-Z preceded by a backslash.
If the argument is <literal>NULL</literal>, the return value
is the word <quote>NULL</quote> without enclosing single
- quotes. The <function role="sql">QUOTE()</function> function
+ quotes. The <literal role="func">QUOTE()</literal> function
was added in MySQL 4.0.3.
</para>
@@ -3325,7 +3325,7 @@
<primary>REPEAT()</primary>
</indexterm>
- <function role="sql">REPEAT(<replaceable>str</replaceable>,<replaceable>count</replaceable>)</function>
+ <literal role="func">REPEAT(<replaceable>str</replaceable>,<replaceable>count</replaceable>)</literal>
</para>
<remark role="help-syntax-end"/>
@@ -3362,7 +3362,7 @@
<primary>REPLACE()</primary>
</indexterm>
- <function role="sql">REPLACE(<replaceable>str</replaceable>,<replaceable>from_str</replaceable>,<replaceable>to_str</replaceable>)</function>
+ <literal role="func">REPLACE(<replaceable>str</replaceable>,<replaceable>from_str</replaceable>,<replaceable>to_str</replaceable>)</literal>
</para>
<remark role="help-syntax-end"/>
@@ -3373,7 +3373,7 @@
Returns the string <replaceable>str</replaceable> with all
occurrences of the string <replaceable>from_str</replaceable>
replaced by the string <replaceable>to_str</replaceable>.
- <function role="sql">REPLACE()</function> performs a
+ <literal role="func">REPLACE()</literal> performs a
case-sensitive match when searching for
<replaceable>from_str</replaceable>.
</para>
@@ -3402,7 +3402,7 @@
<primary>REVERSE()</primary>
</indexterm>
- <function role="sql">REVERSE(<replaceable>str</replaceable>)</function>
+ <literal role="func">REVERSE(<replaceable>str</replaceable>)</literal>
</para>
<remark role="help-syntax-end"/>
@@ -3438,7 +3438,7 @@
<primary>RIGHT()</primary>
</indexterm>
- <function role="sql">RIGHT(<replaceable>str</replaceable>,<replaceable>len</replaceable>)</function>
+ <literal role="func">RIGHT(<replaceable>str</replaceable>,<replaceable>len</replaceable>)</literal>
</para>
<remark role="help-syntax-end"/>
@@ -3474,7 +3474,7 @@
<primary>RPAD()</primary>
</indexterm>
- <function role="sql">RPAD(<replaceable>str</replaceable>,<replaceable>len</replaceable>,<replaceable>padstr</replaceable>)</function>
+ <literal role="func">RPAD(<replaceable>str</replaceable>,<replaceable>len</replaceable>,<replaceable>padstr</replaceable>)</literal>
</para>
<remark role="help-syntax-end"/>
@@ -3516,7 +3516,7 @@
<primary>RTRIM()</primary>
</indexterm>
- <function role="sql">RTRIM(<replaceable>str</replaceable>)</function>
+ <literal role="func">RTRIM(<replaceable>str</replaceable>)</literal>
</para>
<remark role="help-syntax-end"/>
@@ -3552,7 +3552,7 @@
<primary>SOUNDEX()</primary>
</indexterm>
- <function role="sql">SOUNDEX(<replaceable>str</replaceable>)</function>
+ <literal role="func">SOUNDEX(<replaceable>str</replaceable>)</literal>
</para>
<remark role="help-syntax-end"/>
@@ -3563,9 +3563,9 @@
Returns a soundex string from <replaceable>str</replaceable>.
Two strings that sound almost the same should have identical
soundex strings. A standard soundex string is four characters
- long, but the <function role="sql">SOUNDEX()</function>
+ long, but the <literal role="func">SOUNDEX()</literal>
function returns an arbitrarily long string. You can use
- <function role="sql">SUBSTRING()</function> on the result to
+ <literal role="func">SUBSTRING()</literal> on the result to
get a standard soundex string. All non-alphabetic characters
in <replaceable>str</replaceable> are ignored. All
international alphabetic characters outside the A-Z range are
@@ -3574,7 +3574,7 @@
<important>
<para>
- When using <function role="sql">SOUNDEX()</function>, you
+ When using <literal role="func">SOUNDEX()</literal>, you
should be aware of the following limitations:
</para>
</important>
@@ -3641,8 +3641,8 @@
<primary>SOUNDS LIKE</primary>
</indexterm>
- <function role="sqlop" condition="sounds-like"><replaceable>expr1</replaceable>
- SOUNDS LIKE <replaceable>expr2</replaceable></function>
+ <literal role="op" condition="sounds-like"><replaceable>expr1</replaceable>
+ SOUNDS LIKE <replaceable>expr2</replaceable></literal>
</para>
<remark role="help-syntax-end"/>
@@ -3651,8 +3651,8 @@
<para>
This is the same as
- <function role="sql">SOUNDEX(<replaceable>expr1</replaceable>)
- = SOUNDEX(<replaceable>expr2</replaceable>)</function>. It is
+ <literal role="func">SOUNDEX(<replaceable>expr1</replaceable>)
+ = SOUNDEX(<replaceable>expr2</replaceable>)</literal>. It is
available beginning with MySQL 4.1.0.
</para>
@@ -3669,7 +3669,7 @@
<primary>SPACE()</primary>
</indexterm>
- <function role="sql">SPACE(<replaceable>N</replaceable>)</function>
+ <literal role="func">SPACE(<replaceable>N</replaceable>)</literal>
</para>
<remark role="help-syntax-end"/>
@@ -3696,7 +3696,7 @@
<literal>'9'</literal>, <literal>'A'</literal> ..
<literal>'F'</literal>, <literal>'a'</literal> ..
<literal>'f'</literal>. If
- <function role="sql">UNHEX()</function> encounters any
+ <literal role="func">UNHEX()</literal> encounters any
non-hexadecimal digits in the argument, it returns
<literal>NULL</literal>:
</para>
@@ -3712,14 +3712,14 @@
<para>
A <literal>NULL</literal> result can occur if the argument to
- <function role="sql">UNHEX()</function> is a
+ <literal role="func">UNHEX()</literal> is a
<literal>BINARY</literal> column, because values are padded
with 0x00 bytes when stored but those bytes are not stripped
on retrieval. For example <literal>'aa'</literal> is stored
into a <literal>CHAR(3)</literal> column as
<literal>'aa '</literal> and retrieved as
<literal>'aa'</literal> (with the trailing pad space
- stripped), so <function role="sql">UNHEX()</function> for the
+ stripped), so <literal role="func">UNHEX()</literal> for the
column value returns <literal>'A'</literal>. By contrast
<literal>'aa'</literal> is stored into a
<literal>BINARY(3)</literal> column as
@@ -3727,7 +3727,7 @@
<literal>'aa\0'</literal> (with the trailing pad
<literal>0x00</literal> byte not stripped).
<literal>'\0'</literal> is not a legal hexadecimal digit, so
- <function role="sql">UNHEX()</function> for the column value
+ <literal role="func">UNHEX()</literal> for the column value
returns <literal>NULL</literal>.
</para>
</listitem>
@@ -3742,13 +3742,13 @@
<primary>SUBSTR()</primary>
</indexterm>
- <function role="sql">SUBSTR(<replaceable>str</replaceable>,<replaceable>pos</replaceable>)</function>,
- <function role="sql">SUBSTR(<replaceable>str</replaceable>
- FROM <replaceable>pos</replaceable>)</function>,
- <function role="sql">SUBSTR(<replaceable>str</replaceable>,<replaceable>pos</replaceable>,<replaceable>len</replaceable>)</function>,
- <function role="sql">SUBSTR(<replaceable>str</replaceable>
+ <literal role="func">SUBSTR(<replaceable>str</replaceable>,<replaceable>pos</replaceable>)</literal>,
+ <literal role="func">SUBSTR(<replaceable>str</replaceable>
+ FROM <replaceable>pos</replaceable>)</literal>,
+ <literal role="func">SUBSTR(<replaceable>str</replaceable>,<replaceable>pos</replaceable>,<replaceable>len</replaceable>)</literal>,
+ <literal role="func">SUBSTR(<replaceable>str</replaceable>
FROM <replaceable>pos</replaceable> FOR
- <replaceable>len</replaceable>)</function>
+ <replaceable>len</replaceable>)</literal>
</para>
<remark role="help-syntax-end"/>
@@ -3756,8 +3756,8 @@
<remark role="help-description-begin"/>
<para>
- <function role="sql">SUBSTR()</function> is a synonym for
- <function role="sql">SUBSTRING()</function>. It was added in
+ <literal role="func">SUBSTR()</literal> is a synonym for
+ <literal role="func">SUBSTRING()</literal>. It was added in
MySQL 4.1.1.
</para>
@@ -3774,13 +3774,13 @@
<primary>SUBSTRING()</primary>
</indexterm>
- <function role="sql">SUBSTRING(<replaceable>str</replaceable>,<replaceable>pos</replaceable>)</function>,
- <function role="sql">SUBSTRING(<replaceable>str</replaceable>
- FROM <replaceable>pos</replaceable>)</function>,
- <function role="sql">SUBSTRING(<replaceable>str</replaceable>,<replaceable>pos</replaceable>,<replaceable>len</replaceable>)</function>,
- <function role="sql">SUBSTRING(<replaceable>str</replaceable>
+ <literal role="func">SUBSTRING(<replaceable>str</replaceable>,<replaceable>pos</replaceable>)</literal>,
+ <literal role="func">SUBSTRING(<replaceable>str</replaceable>
+ FROM <replaceable>pos</replaceable>)</literal>,
+ <literal role="func">SUBSTRING(<replaceable>str</replaceable>,<replaceable>pos</replaceable>,<replaceable>len</replaceable>)</literal>,
+ <literal role="func">SUBSTRING(<replaceable>str</replaceable>
FROM <replaceable>pos</replaceable> FOR
- <replaceable>len</replaceable>)</function>
+ <replaceable>len</replaceable>)</literal>
</para>
<remark role="help-syntax-end"/>
@@ -3805,7 +3805,7 @@
</para>
<para>
- For all forms of <function role="sql">SUBSTRING()</function>,
+ For all forms of <literal role="func">SUBSTRING()</literal>,
the position of the first character in the string from which
the substring is to be extracted is reckoned as
<literal>1</literal>.
@@ -3850,7 +3850,7 @@
<primary>SUBSTRING_INDEX()</primary>
</indexterm>
- <function role="sql">SUBSTRING_INDEX(<replaceable>str</replaceable>,<replaceable>delim</replaceable>,<replaceable>count</replaceable>)</function>
+ <literal role="func">SUBSTRING_INDEX(<replaceable>str</replaceable>,<replaceable>delim</replaceable>,<replaceable>count</replaceable>)</literal>
</para>
<remark role="help-syntax-end"/>
@@ -3867,7 +3867,7 @@
returned. If <replaceable>count</replaceable> is negative,
everything to the right of the final delimiter (counting from
the right) is returned.
- <function role="sql">SUBSTRING_INDEX()</function> performs a
+ <literal role="func">SUBSTRING_INDEX()</literal> performs a
case-sensitive match when searching for
<replaceable>delim</replaceable>.
</para>
@@ -3902,11 +3902,11 @@
<primary>TRIM()</primary>
</indexterm>
- <function role="sql">TRIM([{BOTH | LEADING | TRAILING}
+ <literal role="func">TRIM([{BOTH | LEADING | TRAILING}
[<replaceable>remstr</replaceable>] FROM]
- <replaceable>str</replaceable>)</function>,
- <function role="sql">TRIM([<replaceable>remstr</replaceable>
- FROM] <replaceable>str</replaceable>)</function>
+ <replaceable>str</replaceable>)</literal>,
+ <literal role="func">TRIM([<replaceable>remstr</replaceable>
+ FROM] <replaceable>str</replaceable>)</literal>
</para>
<remark role="help-syntax-end"/>
@@ -3953,7 +3953,7 @@
<primary>UCASE()</primary>
</indexterm>
- <function role="sql">UCASE(<replaceable>str</replaceable>)</function>
+ <literal role="func">UCASE(<replaceable>str</replaceable>)</literal>
</para>
<remark role="help-syntax-end"/>
@@ -3961,8 +3961,8 @@
<remark role="help-description-begin"/>
<para>
- <function role="sql">UCASE()</function> is a synonym for
- <function role="sql">UPPER()</function>.
+ <literal role="func">UCASE()</literal> is a synonym for
+ <literal role="func">UPPER()</literal>.
</para>
<remark role="help-description-end"/>
@@ -3982,12 +3982,12 @@
<primary>UNHEX()</primary>
</indexterm>
- <function role="sql">UNHEX(<replaceable>str</replaceable>)</function>
+ <literal role="func">UNHEX(<replaceable>str</replaceable>)</literal>
</para>
<para>
Performs the inverse operation of
- <function role="sql">HEX(<replaceable>str</replaceable>)</function>.
+ <literal role="func">HEX(<replaceable>str</replaceable>)</literal>.
That is, it interprets each pair of hexadecimal digits in the
argument as a number and converts it to the character
represented by the number. The resulting characters are
@@ -4010,7 +4010,7 @@
</programlisting>
<para>
- <function role="sql">UNHEX()</function> was added in MySQL
+ <literal role="func">UNHEX()</literal> was added in MySQL
4.1.2.
</para>
</listitem>
@@ -4025,7 +4025,7 @@
<primary>UPPER()</primary>
</indexterm>
- <function role="sql">UPPER(<replaceable>str</replaceable>)</function>
+ <literal role="func">UPPER(<replaceable>str</replaceable>)</literal>
</para>
<remark role="help-syntax-end"/>
@@ -4045,10 +404
