sigmasternchen/php-doc-en
1
0
Fork 0
mirror of https://github.com/sigmasternchen/php-doc-en synced 2025-03-27 06:18:56 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
php-doc-en/reference/mysqlnd_uh/constants.xml
Richard Quadling 1aa2b162ea W/S, Tab removal 
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@317866 c90b9560-bf6c-de11-be94-00142212c4b1
2011-10-07 14:14:17 +00:00

1095 lines
26 KiB
XML
Raw Blame History

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<appendix xml:id="mysqlnd-uh.constants" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
&reftitle.constants;
&extension.constants;
<para>
Most of the constants refer to details of the MySQL Client Server Protocol.
Please, refer to the MySQL reference manual to learn about their meaning.
To avoid content duplication, only short descriptions are given.
</para>
<para>
<emphasis role="bold">MysqlndUhConnection::simpleCommand() related</emphasis>
</para>
<para>
The following constants can be used to detect what command is to be send
through <literal>MysqlndUhConnection::simpleCommand()</literal>.
</para>
<para>
<variablelist>
<varlistentry>
<term>
<constant>MYSQLND_UH_MYSQLND_COM_SLEEP</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
MySQL Client Server protocol command: COM_SLEEP.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>MYSQLND_UH_MYSQLND_COM_QUIT</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
MySQL Client Server protocol command: COM_QUIT.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>MYSQLND_UH_MYSQLND_COM_INIT_DB</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
MySQL Client Server protocol command: COM_INIT_DB.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>MYSQLND_UH_MYSQLND_COM_QUERY</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
MySQL Client Server protocol command: COM_QUERY.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>MYSQLND_UH_MYSQLND_COM_FIELD_LIST</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
MySQL Client Server protocol command: COM_FIELD_LIST.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>MYSQLND_UH_MYSQLND_COM_CREATE_DB</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
MySQL Client Server protocol command: COM_CREATE_DB.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>MYSQLND_UH_MYSQLND_COM_DROP_DB</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
MySQL Client Server protocol command: COM_DROP_DB.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>MYSQLND_UH_MYSQLND_COM_REFRESH</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
MySQL Client Server protocol command: COM_REFRESH.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>MYSQLND_UH_MYSQLND_COM_SHUTDOWN</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
MySQL Client Server protocol command: COM_SHUTDOWN.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>MYSQLND_UH_MYSQLND_COM_STATISTICS</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
MySQL Client Server protocol command: COM_STATISTICS.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>MYSQLND_UH_MYSQLND_COM_PROCESS_INFO</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
MySQL Client Server protocol command: COM_PROCESS_INFO.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>MYSQLND_UH_MYSQLND_COM_CONNECT</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
MySQL Client Server protocol command: COM_CONNECT.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>MYSQLND_UH_MYSQLND_COM_PROCESS_KILL</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
MySQL Client Server protocol command: COM_PROCESS_KILL.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>MYSQLND_UH_MYSQLND_COM_DEBUG</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
MySQL Client Server protocol command: COM_DEBUG.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>MYSQLND_UH_MYSQLND_COM_PING</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
MySQL Client Server protocol command: COM_PING.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>MYSQLND_UH_MYSQLND_COM_TIME</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
MySQL Client Server protocol command: COM_TIME.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>MYSQLND_UH_MYSQLND_COM_DELAYED_INSERT</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
MySQL Client Server protocol command: COM_DELAYED_INSERT.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>MYSQLND_UH_MYSQLND_COM_CHANGE_USER</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
MySQL Client Server protocol command: COM_CHANGE_USER.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>MYSQLND_UH_MYSQLND_COM_BINLOG_DUMP</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
MySQL Client Server protocol command: COM_BINLOG_DUMP.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>MYSQLND_UH_MYSQLND_COM_TABLE_DUMP</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
MySQL Client Server protocol command: COM_TABLE_DUMP.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>MYSQLND_UH_MYSQLND_COM_CONNECT_OUT</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
MySQL Client Server protocol command: COM_CONNECT_OUT.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>MYSQLND_UH_MYSQLND_COM_REGISTER_SLAVED</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
MySQL Client Server protocol command: COM_REGISTER_SLAVED.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>MYSQLND_UH_MYSQLND_COM_STMT_PREPARE</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
MySQL Client Server protocol command: COM_STMT_PREPARE.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>MYSQLND_UH_MYSQLND_COM_STMT_EXECUTE</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
MySQL Client Server protocol command: COM_STMT_EXECUTE.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>MYSQLND_UH_MYSQLND_COM_STMT_SEND_LONG_DATA</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
MySQL Client Server protocol command: COM_STMT_SEND_LONG_DATA.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>MYSQLND_UH_MYSQLND_COM_STMT_CLOSE</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
MySQL Client Server protocol command: COM_STMT_CLOSE.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>MYSQLND_UH_MYSQLND_COM_STMT_RESET</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
MySQL Client Server protocol command: COM_STMT_RESET.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>MYSQLND_UH_MYSQLND_COM_SET_OPTION</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
MySQL Client Server protocol command: COM_SET_OPTION.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>MYSQLND_UH_MYSQLND_COM_STMT_FETCH</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
MySQL Client Server protocol command: COM_STMT_FETCH.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>MYSQLND_UH_MYSQLND_COM_DAEMON</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
MySQL Client Server protocol command: COM_DAEMON.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>MYSQLND_UH_MYSQLND_COM_END</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
MySQL Client Server protocol command: COM_END.
</simpara>
</listitem>
</varlistentry>
</variablelist>
</para>
<para>
The following constants can be used to analyze the <literal>ok_packet</literal>
argument of <literal>MysqlndUhConnection::simpleCommand()</literal>.
</para>
<para>
<variablelist>
<varlistentry>
<term>
<constant>MYSQLND_UH_MYSQLND_PROT_GREET_PACKET</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
MySQL Client Server protocol packet: greeting.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>MYSQLND_UH_MYSQLND_PROT_AUTH_PACKET</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
MySQL Client Server protocol packet: authentification.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>MYSQLND_UH_MYSQLND_PROT_OK_PACKET</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
MySQL Client Server protocol packet: OK.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>MYSQLND_UH_MYSQLND_PROT_EOF_PACKET</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
MySQL Client Server protocol packet: EOF.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>MYSQLND_UH_MYSQLND_PROT_CMD_PACKET</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
MySQL Client Server protocol packet: command.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>MYSQLND_UH_MYSQLND_PROT_RSET_HEADER_PACKET</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
MySQL Client Server protocol packet: result set header.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>MYSQLND_UH_MYSQLND_PROT_RSET_FLD_PACKET</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
MySQL Client Server protocol packet: resultset field.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>MYSQLND_UH_MYSQLND_PROT_ROW_PACKET</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
MySQL Client Server protocol packet: row.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>MYSQLND_UH_MYSQLND_PROT_STATS_PACKET</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
MySQL Client Server protocol packet: stats.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>MYSQLND_UH_MYSQLND_PREPARE_RESP_PACKET</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
MySQL Client Server protocol packet: prepare response.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>MYSQLND_UH_MYSQLND_CHG_USER_RESP_PACKET</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
MySQL Client Server protocol packet: change user response.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>MYSQLND_UH_MYSQLND_PROT_LAST</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
No practical meaning. Last entry marker of internal C data structure list.
</simpara>
</listitem>
</varlistentry>
</variablelist>
</para>
<para>
<emphasis role="bold">MysqlndUhConnection::close() related</emphasis>
</para>
<para>
The following constants can be used to detect why a connection has been
closed through <literal>MysqlndUhConnection::close()</literal>.
</para>
<para>
<variablelist>
<varlistentry>
<term>
<constant>MYSQLND_UH_MYSQLND_CLOSE_EXPLICIT</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
User has called mysqlnd to close the connection.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>MYSQLND_UH_MYSQLND_CLOSE_IMPLICIT</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Implicity close, for example, during garbage connection.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>MYSQLND_UH_MYSQLND_CLOSE_DISCONNECTED</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Connection error.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>MYSQLND_UH_MYSQLND_CLOSE_LAST</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
No practical meaning. Last entry marker of internal C data structure list.
</simpara>
</listitem>
</varlistentry>
</variablelist>
</para>
<para>
<emphasis role="bold">MysqlndUhConnection::setServerOption() related</emphasis>
</para>
<para>
The following constants can be used to detect which option is set through
<literal>MysqlndUhConnection::setServerOption()</literal>.
</para>
<para>
<variablelist>
<varlistentry>
<term>
<constant>MYSQLND_UH_SERVER_OPTION_MULTI_STATEMENTS_ON</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Option: enables multi statement support.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>MYSQLND_UH_SERVER_OPTION_MULTI_STATEMENTS_OFF</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Option: disables multi statement support.
</simpara>
</listitem>
</varlistentry>
</variablelist>
</para>
<para>
<emphasis role="bold">MysqlndUhConnection::setClientOption() related</emphasis>
</para>
<para>
The following constants can be used to detect which option is set through
<literal>MysqlndUhConnection::setClientOption()</literal>.
</para>
<para>
<variablelist>
<varlistentry>
<term>
<constant>MYSQLND_UH_MYSQLND_OPTION_OPT_CONNECT_TIMEOUT</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Option: connection timeout.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>MYSQLND_UH_MYSQLND_OPTION_OPT_COMPRESS</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Option: wheter the MySQL compressed protocol is to be used.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>MYSQLND_UH_MYSQLND_OPTION_OPT_NAMED_PIPE</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Option: named pipe to use for connection (Windows).
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>MYSQLND_UH_MYSQLND_OPTION_INIT_COMMAND</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Option: init command to execute upon connect.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>MYSQLND_UH_MYSQLND_READ_DEFAULT_FILE</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Option: MySQL server default file to read upon connect.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>MYSQLND_UH_MYSQLND_READ_DEFAULT_GROUP</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Option: MySQL server default file group to read upon connect.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>MYSQLND_UH_MYSQLND_SET_CHARSET_DIR</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Option: charset description files directory.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>MYSQLND_UH_MYSQLND_SET_CHARSET_NAME</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Option: charset name.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>MYSQLND_UH_MYSQLND_OPT_LOCAL_INFILE</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Option: Wheter to allow <literal>LOAD DATA LOCAL INFILE</literal> use.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>MYSQLND_UH_MYSQLND_OPT_PROTOCOL</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Option: supported protocol version.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>MYSQLND_UH_MYSQLND_SHARED_MEMORY_BASE_NAME</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Option: shared memory base name for shared memory connections.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>MYSQLND_UH_MYSQLND_OPT_READ_TIMEOUT</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Option: connection read timeout.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>MYSQLND_UH_MYSQLND_OPT_WRITE_TIMEOUT</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Option: connection write timeout.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>MYSQLND_UH_MYSQLND_OPT_USE_RESULT</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Option: unbuffered result sets.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>MYSQLND_UH_MYSQLND_OPT_USE_REMOTE_CONNECTION</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Embedded server related.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>MYSQLND_UH_MYSQLND_OPT_USE_EMBEDDED_CONNECTION</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Embedded server related.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>MYSQLND_UH_MYSQLND_OPT_GUESS_CONNECTION</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
TODO
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>MYSQLND_UH_MYSQLND_SET_CLIENT_IP</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
TODO
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>MYSQLND_UH_MYSQLND_SECURE_AUTH</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
TODO
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>MYSQLND_UH_MYSQLND_REPORT_DATA_TRUNCATION</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Option: Wheter to report data truncation.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>MYSQLND_UH_MYSQLND_OPT_RECONNECT</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Option: Wheter to reconnect automatically.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>MYSQLND_UH_MYSQLND_OPT_SSL_VERIFY_SERVER_CERT</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Option: TODO
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>MYSQLND_UH_MYSQLND_OPT_NET_CMD_BUFFER_SIZE</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Option: mysqlnd network buffer size for commands.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>MYSQLND_UH_MYSQLND_OPT_NET_READ_BUFFER_SIZE</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Option: mysqlnd network buffer size for reading from the server.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>MYSQLND_UH_MYSQLND_OPT_SSL_KEY</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Option: SSL key.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>MYSQLND_UH_MYSQLND_OPT_SSL_CERT</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Option: SSL certificate.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>MYSQLND_UH_MYSQLND_OPT_SSL_CA</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Option: SSL CA.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>MYSQLND_UH_MYSQLND_OPT_SSL_CAPATH</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Option: Path to SSL CA.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>MYSQLND_UH_MYSQLND_OPT_SSL_CIPHER</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Option: SSL cipher.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>MYSQLND_UH_MYSQLND_OPT_SSL_PASSPHRASE</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Option: SSL passphrase.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>MYSQLND_UH_SERVER_OPTION_PLUGIN_DIR</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Option: server plugin directory.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>MYSQLND_UH_SERVER_OPTION_DEFAULT_AUTH</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Option: default authentification method.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>MYSQLND_UH_SERVER_OPTION_SET_CLIENT_IP</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
TODO
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>MYSQLND_UH_MYSQLND_OPT_MAX_ALLOWED_PACKET</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Option: maximum allowd packet size. Available as of <literal>PHP 5.4.0</literal>.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>MYSQLND_UH_MYSQLND_OPT_AUTH_PROTOCOL</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Option: TODO. Available as of <literal>PHP 5.4.0</literal>.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>MYSQLND_UH_MYSQLND_OPT_INT_AND_FLOAT_NATIVE</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Option: make mysqlnd return integer and float columns as long even
when using the MySQL Client Server text protocol. Only
available with a custom build of mysqlnd.
</simpara>
</listitem>
</varlistentry>
</variablelist>
</para>
<para>
<emphasis role="bold">Other</emphasis>
</para>
<para>
The plugins version number can be obtained using
<constant>MYSQLND_UH_VERSION</constant> or
<constant>MYSQLND_UH_VERSION_ID</constant>.
<constant>MYSQLND_UH_VERSION</constant>
is the string representation of the numerical version number
<constant>MYSQLND_UH_VERSION_ID</constant>, which is an integer such as 10000.
Developers can calculate the version number as follows.
</para>
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>Version (part)</entry>
<entry>Example</entry>
</row>
</thead>
<tbody>
<row>
<entry>Major*10000</entry>
<entry>1*10000 = 10000</entry>
</row>
<row>
<entry>Minor*100</entry>
<entry>0*100 = 0</entry>
</row>
<row>
<entry>Patch</entry>
<entry>0 = 0</entry>
</row>
<row>
<entry>MYSQLND_UH_VERSION_ID</entry>
<entry>10000</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
<para>
<variablelist>
<varlistentry>
<term>
<constant>MYSQLND_UH_VERSION</constant>
(<type>string</type>)
</term>
<listitem>
<simpara>
Plugin version string, for example, <quote>1.0.0-alpha</quote>.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>MYSQLND_UH_VERSION_ID</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Plugin version number, for example, 10000.
</simpara>
</listitem>
</varlistentry>
</variablelist>
</para>
</appendix>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
Reference in a new issue View git blame Copy permalink