<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>The mysqli class</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="mysqli.summary.html">The MySQLi Extension Function Summary</a></div>
<div class="next" style="text-align: right; float: right;"><a href="mysqli.affected-rows.html">mysqli::$affected_rows</a></div>
<div class="up"><a href="book.mysqli.html">Mysqli</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="class.mysqli" class="reference">
<h1 class="title">The mysqli class</h1>
<div class="partintro"><p class="verinfo">(PHP 5)</p>
<div class="section" id="mysqli.intro">
<h2 class="title">Introduction</h2>
<p class="para">
Represents a connection between PHP and a MySQL database.
</p>
</div>
<div class="section" id="mysqli.synopsis">
<h2 class="title">Class synopsis</h2>
<div class="classsynopsis">
<div class="ooclass"></div>
<div class="classsynopsisinfo">
<span class="ooclass">
<strong class="classname">mysqli</strong>
</span>
{</div>
<div class="classsynopsisinfo classsynopsisinfo_comment">/* Properties */</div>
<div class="fieldsynopsis"><span class="type">int</span> <var class="varname"><a href="mysqli.affected-rows.html">$<var class="varname">affected_rows</var></a></var>;</div>
<div class="fieldsynopsis"><span class="type">string</span> <var class="varname"><a href="mysqli.client-info.html">$<var class="varname">client_info</var></a></var>;</div>
<div class="fieldsynopsis"><span class="type">int</span> <var class="varname"><a href="mysqli.client-version.html">$<var class="varname">client_version</var></a></var>;</div>
<div class="fieldsynopsis"><span class="type">string</span> <var class="varname"><a href="mysqli.connect-errno.html">$<var class="varname">connect_errno</var></a></var>;</div>
<div class="fieldsynopsis"><span class="type">string</span> <var class="varname"><a href="mysqli.connect-error.html">$<var class="varname">connect_error</var></a></var>;</div>
<div class="fieldsynopsis"><span class="type">int</span> <var class="varname"><a href="mysqli.errno.html">$<var class="varname">errno</var></a></var>;</div>
<div class="fieldsynopsis"><span class="type">array</span> <var class="varname"><a href="mysqli.error-list.html">$<var class="varname">error_list</var></a></var>;</div>
<div class="fieldsynopsis"><span class="type">string</span> <var class="varname"><a href="mysqli.error.html">$<var class="varname">error</var></a></var>;</div>
<div class="fieldsynopsis"><span class="type">int</span> <var class="varname"><a href="mysqli.field-count.html">$<var class="varname">field_count</var></a></var>;</div>
<div class="fieldsynopsis"><span class="type">int</span> <var class="varname"><a href="mysqli.get-client-version.html">$<var class="varname">client_version</var></a></var>;</div>
<div class="fieldsynopsis"><span class="type">string</span> <var class="varname"><a href="mysqli.get-host-info.html">$<var class="varname">host_info</var></a></var>;</div>
<div class="fieldsynopsis"><span class="type">string</span> <var class="varname"><a href="mysqli.get-proto-info.html">$<var class="varname">protocol_version</var></a></var>;</div>
<div class="fieldsynopsis"><span class="type">string</span> <var class="varname"><a href="mysqli.get-server-info.html">$<var class="varname">server_info</var></a></var>;</div>
<div class="fieldsynopsis"><span class="type">int</span> <var class="varname"><a href="mysqli.get-server-version.html">$<var class="varname">server_version</var></a></var>;</div>
<div class="fieldsynopsis"><span class="type">string</span> <var class="varname"><a href="mysqli.info.html">$<var class="varname">info</var></a></var>;</div>
<div class="fieldsynopsis"><span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <var class="varname"><a href="mysqli.insert-id.html">$<var class="varname">insert_id</var></a></var>;</div>
<div class="fieldsynopsis"><span class="type">string</span> <var class="varname"><a href="mysqli.sqlstate.html">$<var class="varname">sqlstate</var></a></var>;</div>
<div class="fieldsynopsis"><span class="type">int</span> <var class="varname"><a href="mysqli.thread-id.html">$<var class="varname">thread_id</var></a></var>;</div>
<div class="fieldsynopsis"><span class="type">int</span> <var class="varname"><a href="mysqli.warning-count.html">$<var class="varname">warning_count</var></a></var>;</div>
<div class="classsynopsisinfo classsynopsisinfo_comment">/* Methods */</div>
<div class="constructorsynopsis dc-description">
<span class="methodname"><a href="mysqli.construct.html" class="methodname">__construct</a></span>
([ <span class="methodparam"><span class="type">string</span> <code class="parameter">$host</code><span class="initializer"> = ini_get("mysqli.default_host")</span></span>
[, <span class="methodparam"><span class="type">string</span> <code class="parameter">$username</code><span class="initializer"> = ini_get("mysqli.default_user")</span></span>
[, <span class="methodparam"><span class="type">string</span> <code class="parameter">$passwd</code><span class="initializer"> = ini_get("mysqli.default_pw")</span></span>
[, <span class="methodparam"><span class="type">string</span> <code class="parameter">$dbname</code><span class="initializer"> = ""</span></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$port</code><span class="initializer"> = ini_get("mysqli.default_port")</span></span>
[, <span class="methodparam"><span class="type">string</span> <code class="parameter">$socket</code><span class="initializer"> = ini_get("mysqli.default_socket")</span></span>
]]]]]] )</div>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><a href="mysqli.autocommit.html" class="methodname">autocommit</a></span>
( <span class="methodparam"><span class="type">bool</span> <code class="parameter">$mode</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><a href="mysqli.change-user.html" class="methodname">change_user</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$user</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$password</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$database</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="type">string</span> <span class="methodname"><a href="mysqli.character-set-name.html" class="methodname">character_set_name</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><a href="mysqli.close.html" class="methodname">close</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><a href="mysqli.commit.html" class="methodname">commit</a></span>
([ <span class="methodparam"><span class="type">int</span> <code class="parameter">$flags</code></span>
[, <span class="methodparam"><span class="type">string</span> <code class="parameter">$name</code></span>
]] )</div>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><a href="mysqli.debug.html" class="methodname">debug</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$message</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><a href="mysqli.dump-debug-info.html" class="methodname">dump_debug_info</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="type">object</span> <span class="methodname"><a href="mysqli.get-charset.html" class="methodname">get_charset</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="type">string</span> <span class="methodname"><a href="mysqli.get-client-info.html" class="methodname">get_client_info</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><a href="mysqli.get-connection-stats.html" class="methodname">get_connection_stats</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="type">mysqli_warning</span> <span class="methodname"><a href="mysqli.get-warnings.html" class="methodname">get_warnings</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="type">mysqli</span> <span class="methodname"><a href="mysqli.init.html" class="methodname">init</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><a href="mysqli.kill.html" class="methodname">kill</a></span>
( <span class="methodparam"><span class="type">int</span> <code class="parameter">$processid</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><a href="mysqli.more-results.html" class="methodname">more_results</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><a href="mysqli.multi-query.html" class="methodname">multi_query</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$query</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><a href="mysqli.next-result.html" class="methodname">next_result</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><a href="mysqli.options.html" class="methodname">options</a></span>
( <span class="methodparam"><span class="type">int</span> <code class="parameter">$option</code></span>
, <span class="methodparam"><span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <code class="parameter">$value</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><a href="mysqli.ping.html" class="methodname">ping</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="modifier">static</span> <span class="type">int</span> <span class="methodname"><a href="mysqli.poll.html" class="methodname">poll</a></span>
( <span class="methodparam"><span class="type">array</span> <code class="parameter reference">&$read</code></span>
, <span class="methodparam"><span class="type">array</span> <code class="parameter reference">&$error</code></span>
, <span class="methodparam"><span class="type">array</span> <code class="parameter reference">&$reject</code></span>
, <span class="methodparam"><span class="type">int</span> <code class="parameter">$sec</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$usec</code></span>
] )</div>
<div class="methodsynopsis dc-description">
<span class="type">mysqli_stmt</span> <span class="methodname"><a href="mysqli.prepare.html" class="methodname">prepare</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$query</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="type">mixed</span> <span class="methodname"><a href="mysqli.query.html" class="methodname">query</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$query</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$resultmode</code><span class="initializer"> = MYSQLI_STORE_RESULT</span></span>
] )</div>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><a href="mysqli.real-connect.html" class="methodname">real_connect</a></span>
([ <span class="methodparam"><span class="type">string</span> <code class="parameter">$host</code></span>
[, <span class="methodparam"><span class="type">string</span> <code class="parameter">$username</code></span>
[, <span class="methodparam"><span class="type">string</span> <code class="parameter">$passwd</code></span>
[, <span class="methodparam"><span class="type">string</span> <code class="parameter">$dbname</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$port</code></span>
[, <span class="methodparam"><span class="type">string</span> <code class="parameter">$socket</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$flags</code></span>
]]]]]]] )</div>
<div class="methodsynopsis dc-description">
<span class="type">string</span> <span class="methodname"><a href="function.mysqli-escape-string.html" class="methodname">escape_string</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$escapestr</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><a href="mysqli.real-query.html" class="methodname">real_query</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$query</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">mysqli_result</span> <span class="methodname"><a href="mysqli.reap-async-query.html" class="methodname">reap_async_query</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><a href="mysqli.refresh.html" class="methodname">refresh</a></span>
( <span class="methodparam"><span class="type">int</span> <code class="parameter">$options</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><a href="mysqli.rollback.html" class="methodname">rollback</a></span>
([ <span class="methodparam"><span class="type">int</span> <code class="parameter">$flags</code></span>
[, <span class="methodparam"><span class="type">string</span> <code class="parameter">$name</code></span>
]] )</div>
<div class="methodsynopsis dc-description">
<span class="type">int</span> <span class="methodname"><a href="mysqli.rpl-query-type.html" class="methodname">rpl_query_type</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$query</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><a href="mysqli.select-db.html" class="methodname">select_db</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$dbname</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><a href="mysqli.send-query.html" class="methodname">send_query</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$query</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><a href="mysqli.set-charset.html" class="methodname">set_charset</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$charset</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><a href="mysqli.set-local-infile-handler.html" class="methodname">set_local_infile_handler</a></span>
( <span class="methodparam"><span class="type"><a href="class.mysqli.html" class="type mysqli">mysqli</a></span> <code class="parameter">$link</code></span>
, <span class="methodparam"><span class="type"><a href="language.types.callable.html" class="type callable">callable</a></span> <code class="parameter">$read_func</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><a href="mysqli.ssl-set.html" class="methodname">ssl_set</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$key</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$cert</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$ca</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$capath</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$cipher</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="type">string</span> <span class="methodname"><a href="mysqli.stat.html" class="methodname">stat</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="type">mysqli_stmt</span> <span class="methodname"><a href="mysqli.stmt-init.html" class="methodname">stmt_init</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="type">mysqli_result</span> <span class="methodname"><a href="mysqli.store-result.html" class="methodname">store_result</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="type">mysqli_result</span> <span class="methodname"><a href="mysqli.use-result.html" class="methodname">use_result</a></span>
( <span class="methodparam">void</span>
)</div>
}</div>
</div>
</div>
<h2>Table of Contents</h2><ul class="chunklist chunklist_reference"><li><a href="mysqli.affected-rows.html">mysqli::$affected_rows</a> — Gets the number of affected rows in a previous MySQL operation</li><li><a href="mysqli.autocommit.html">mysqli::autocommit</a> — Turns on or off auto-committing database modifications</li><li><a href="mysqli.begin-transaction.html">mysqli::begin_transaction</a> — Starts a transaction</li><li><a href="mysqli.change-user.html">mysqli::change_user</a> — Changes the user of the specified database connection</li><li><a href="mysqli.character-set-name.html">mysqli::character_set_name</a> — Returns the default character set for the database connection</li><li><a href="mysqli.client-info.html">mysqli::$client_info</a> — Get MySQL client info</li><li><a href="mysqli.client-version.html">mysqli::$client_version</a> — Returns the MySQL client version as a string</li><li><a href="mysqli.close.html">mysqli::close</a> — Closes a previously opened database connection</li><li><a href="mysqli.commit.html">mysqli::commit</a> — Commits the current transaction</li><li><a href="mysqli.connect-errno.html">mysqli::$connect_errno</a> — Returns the error code from last connect call</li><li><a href="mysqli.connect-error.html">mysqli::$connect_error</a> — Returns a string description of the last connect error</li><li><a href="mysqli.construct.html">mysqli::__construct</a> — Open a new connection to the MySQL server</li><li><a href="mysqli.debug.html">mysqli::debug</a> — Performs debugging operations</li><li><a href="mysqli.dump-debug-info.html">mysqli::dump_debug_info</a> — Dump debugging information into the log</li><li><a href="mysqli.errno.html">mysqli::$errno</a> — Returns the error code for the most recent function call</li><li><a href="mysqli.error-list.html">mysqli::$error_list</a> — Returns a list of errors from the last command executed</li><li><a href="mysqli.error.html">mysqli::$error</a> — Returns a string description of the last error</li><li><a href="mysqli.field-count.html">mysqli::$field_count</a> — Returns the number of columns for the most recent query</li><li><a href="mysqli.get-charset.html">mysqli::get_charset</a> — Returns a character set object</li><li><a href="mysqli.get-client-info.html">mysqli::get_client_info</a> — Get MySQL client info</li><li><a href="mysqli.get-client-stats.html">mysqli_get_client_stats</a> — Returns client per-process statistics</li><li><a href="mysqli.get-client-version.html">mysqli_get_client_version</a> — Returns the MySQL client version as an integer</li><li><a href="mysqli.get-connection-stats.html">mysqli::get_connection_stats</a> — Returns statistics about the client connection</li><li><a href="mysqli.get-host-info.html">mysqli::$host_info</a> — Returns a string representing the type of connection used</li><li><a href="mysqli.get-proto-info.html">mysqli::$protocol_version</a> — Returns the version of the MySQL protocol used</li><li><a href="mysqli.get-server-info.html">mysqli::$server_info</a> — Returns the version of the MySQL server</li><li><a href="mysqli.get-server-version.html">mysqli::$server_version</a> — Returns the version of the MySQL server as an integer</li><li><a href="mysqli.get-warnings.html">mysqli::get_warnings</a> — Get result of SHOW WARNINGS</li><li><a href="mysqli.info.html">mysqli::$info</a> — Retrieves information about the most recently executed query</li><li><a href="mysqli.init.html">mysqli::init</a> — Initializes MySQLi and returns a resource for use with mysqli_real_connect()</li><li><a href="mysqli.insert-id.html">mysqli::$insert_id</a> — Returns the auto generated id used in the last query</li><li><a href="mysqli.kill.html">mysqli::kill</a> — Asks the server to kill a MySQL thread</li><li><a href="mysqli.more-results.html">mysqli::more_results</a> — Check if there are any more query results from a multi query</li><li><a href="mysqli.multi-query.html">mysqli::multi_query</a> — Performs a query on the database</li><li><a href="mysqli.next-result.html">mysqli::next_result</a> — Prepare next result from multi_query</li><li><a href="mysqli.options.html">mysqli::options</a> — Set options</li><li><a href="mysqli.ping.html">mysqli::ping</a> — Pings a server connection, or tries to reconnect if the connection has gone down</li><li><a href="mysqli.poll.html">mysqli::poll</a> — Poll connections</li><li><a href="mysqli.prepare.html">mysqli::prepare</a> — Prepare an SQL statement for execution</li><li><a href="mysqli.query.html">mysqli::query</a> — Performs a query on the database</li><li><a href="mysqli.real-connect.html">mysqli::real_connect</a> — Opens a connection to a mysql server</li><li><a href="mysqli.real-escape-string.html">mysqli::real_escape_string</a> — Escapes special characters in a string for use in an SQL statement, taking into account the current charset of the connection</li><li><a href="mysqli.real-query.html">mysqli::real_query</a> — Execute an SQL query</li><li><a href="mysqli.reap-async-query.html">mysqli::reap_async_query</a> — Get result from async query</li><li><a href="mysqli.refresh.html">mysqli::refresh</a> — Refreshes</li><li><a href="mysqli.release-savepoint.html">mysqli::release_savepoint</a> — Rolls back a transaction to the named savepoint</li><li><a href="mysqli.rollback.html">mysqli::rollback</a> — Rolls back current transaction</li><li><a href="mysqli.rpl-query-type.html">mysqli::rpl_query_type</a> — Returns RPL query type</li><li><a href="mysqli.savepoint.html">mysqli::savepoint</a> — Set a named transaction savepoint</li><li><a href="mysqli.select-db.html">mysqli::select_db</a> — Selects the default database for database queries</li><li><a href="mysqli.send-query.html">mysqli::send_query</a> — Send the query and return</li><li><a href="mysqli.set-charset.html">mysqli::set_charset</a> — Sets the default client character set</li><li><a href="mysqli.set-local-infile-default.html">mysqli::set_local_infile_default</a> — Unsets user defined handler for load local infile command</li><li><a href="mysqli.set-local-infile-handler.html">mysqli::set_local_infile_handler</a> — Set callback function for LOAD DATA LOCAL INFILE command</li><li><a href="mysqli.sqlstate.html">mysqli::$sqlstate</a> — Returns the SQLSTATE error from previous MySQL operation</li><li><a href="mysqli.ssl-set.html">mysqli::ssl_set</a> — Used for establishing secure connections using SSL</li><li><a href="mysqli.stat.html">mysqli::stat</a> — Gets the current system status</li><li><a href="mysqli.stmt-init.html">mysqli::stmt_init</a> — Initializes a statement and returns an object for use with mysqli_stmt_prepare</li><li><a href="mysqli.store-result.html">mysqli::store_result</a> — Transfers a result set from the last query</li><li><a href="mysqli.thread-id.html">mysqli::$thread_id</a> — Returns the thread ID for the current connection</li><li><a href="mysqli.thread-safe.html">mysqli::thread_safe</a> — Returns whether thread safety is given or not</li><li><a href="mysqli.use-result.html">mysqli::use_result</a> — Initiate a result set retrieval</li><li><a href="mysqli.warning-count.html">mysqli::$warning_count</a> — Returns the number of warnings from the last query for the given link</li></ul>
</div>
<hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="mysqli.summary.html">The MySQLi Extension Function Summary</a></div>
<div class="next" style="text-align: right; float: right;"><a href="mysqli.affected-rows.html">mysqli::$affected_rows</a></div>
<div class="up"><a href="book.mysqli.html">Mysqli</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
