MySQL Improved Extension (Mysqli) - MySQL Manual

mysqli_result::fetch_assoc

$mysqli::connect_errno

$mysqli::connect_error

$mysqli::errno

$mysqli::error

The MySQLi Extension Function Summary

22.9.3.3.2. Connections

The MySQL server supports the use of different transport layers for connections. Connections use TCP/IP, Unix domain sockets or Windows named pipes.

The hostname localhost has a special meaning. It is bound to the use of Unix domain sockets. It is not possible to open a TCP/IP connection using the hostname localhost you must use 127.0.0.1 instead.

Example 22.80. Special meaning of localhost

<?php$mysqli = new mysqli("localhost", "user", "password", "database");if ($mysqli->connect_errno) { echo "Failed to connect to MySQL: (" . $mysqli->connect_errno . ") " . $mysqli->connect_error;}echo $mysqli->host_info . "\n";$mysqli = new mysqli("127.0.0.1", "user", "password", "database", 3306);if ($mysqli->connect_errno) { echo "Failed to connect to MySQL: (" . $mysqli->connect_errno . ") " . $mysqli->connect_error;}echo $mysqli->host_info . "\n";?>

The above example will output:

Localhost via UNIX socket127.0.0.1 via TCP/IP

Connection parameter defaults

Depending on the connection function used, assorted parameters can be omitted. If a parameter is not provided, then the extension attempts to use the default values that are set in the PHP configuration file.

Example 22.81. Setting defaults

mysqli.default_host=192.168.2.27mysqli.default_user=rootmysqli.default_pw=""mysqli.default_port=3306mysqli.default_socket=/tmp/mysql.sock

The resulting parameter values are then passed to the client library that is used by the extension. If the client library detects empty or unset parameters, then it may default to the library built-in values.

Built-in connection library defaults

If the host value is unset or empty, then the client library will default to a Unix socket connection on localhost. If socket is unset or empty, and a Unix socket connection is requested, then a connection to the default socket on /tmp/mysql.sock is attempted.

On Windows systems, the host name . is interpreted by the client library as an attempt to open a Windows named pipe based connection. In this case the socket parameter is interpreted as the pipe name. If not given or empty, then the socket (pipe name) defaults to \\.\pipe\MySQL.

If neither a Unix domain socket based not a Windows named pipe based connection is to be be established and the port parameter value is unset, the library will default to port 3306.

The mysqlnd library and the MySQL Client Library (libmysql) implement the same logic for determining defaults.

Connection options

Connection options are available to, for example, set init commands which are executed upon connect, or for requesting use of a certain charset. Connection options must be set before a network connection is established.

For setting a connection option, the connect operation has to be performed in three steps: creating a connection handle with mysqli_init, setting the requested options using mysqli_options, and establishing the network connection with mysqli_real_connect.

Connection pooling

The mysqli extension supports persistent database connections, which are a special kind of pooled connections. By default, every database connection opened by a script is either explicitly closed by the user during runtime or released automatically at the end of the script. A persistent connection is not. Instead it is put into a pool for later reuse, if a connection to the same server using the same username, password, socket, port and default database is opened. Reuse saves connection overhead.

Every PHP process is using its own mysqli connection pool. Depending on the web server deployment model, a PHP process may serve one or multiple requests. Therefore, a pooled connection may be used by one or more scripts subsequently.

Persistent connection

If a unused persistent connection for a given combination of host, username, password, socket, port and default database can not be found in the connection pool, then mysqli opens a new connection. The use of persistent connections can be enabled and disabled using the PHP directive mysqli.allow_persistent. The total number of connections opened by a script can be limited with mysqli.max_links. The maximum number of persistent connections per PHP process can be restricted with mysqli.max_persistent. Please note, that the web server may spawn many PHP processes.

A common complain about persistent connections is that their state is not reset before reuse. For example, open and unfinished transactions are not automatically rolled back. But also, authorization changes which happened in the time between putting the connection into the pool and reusing it are not reflected. This may be seen as an unwanted side-effect. On the contrary, the name persistent may be understood as a promise that the state is persisted.

The mysqli extension supports both interpretations of a persistent connection: state persisted, and state reset before reuse. The default is reset. Before a persistent connection is reused, the mysqli extension implicitly calls mysqli_change_user to reset the state. The persistent connection appears to the user as if it was just opened. No artifacts from previous usages are visible.

The mysqli_change_user function is an expensive operation. For best performance, users may want to recompile the extension with the compile flag MYSQLI_NO_CHANGE_USER_ON_PCONNECT being set.

It is left to the user to choose between safe behavior and best performance. Both are valid optimization goals. For ease of use, the safe behavior has been made the default at the expense of maximum performance.

See also

MySQLi Configuration Options

Persistent Database Connections

22.9.3.3.3. Executing statements

Statements can be executed with the mysqli_query, mysqli_real_query and mysqli_multi_query functions. The mysqli_query function is the most common, and combines the executing statement with a buffered fetch of its result set, if any, in one call. Calling mysqli_query is identical to calling mysqli_real_query followed by mysqli_store_result.

Example 22.82. Connecting to MySQL

<?php$mysqli = new mysqli("example.com", "user", "password", "database");if ($mysqli->connect_errno) { echo "Failed to connect to MySQL: (" . $mysqli->connect_errno . ") " . $mysqli->connect_error;}if (!$mysqli->query("DROP TABLE IF EXISTS test") || !$mysqli->query("CREATE TABLE test(id INT)") || !$mysqli->query("INSERT INTO test(id) VALUES (1)")) { echo "Table creation failed: (" . $mysqli->errno . ") " . $mysqli->error;}?>

Buffered result sets

After statement execution results can be retrieved at once to be buffered by the client or by read row by row. Client-side result set buffering allows the server to free resources associated with the statement results as early as possible. Generally speaking, clients are slow consuming result sets. Therefore, it is recommended to use buffered result sets. mysqli_query combines statement execution and result set buffering.

PHP applications can navigate freely through buffered results. Navigation is fast because the result sets are held in client memory. Please, keep in mind that it is often easier to scale by client than it is to scale the server.

Example 22.83. Navigation through buffered results

<?php$mysqli = new mysqli("example.com", "user", "password", "database");if ($mysqli->connect_errno) { echo "Failed to connect to MySQL: (" . $mysqli->connect_errno . ") " . $mysqli->connect_error;}if (!$mysqli->query("DROP TABLE IF EXISTS test") || !$mysqli->query("CREATE TABLE test(id INT)") || !$mysqli->query("INSERT INTO test(id) VALUES (1), (2), (3)")) { echo "Table creation failed: (" . $mysqli->errno . ") " . $mysqli->error;}$res = $mysqli->query("SELECT id FROM test ORDER BY id ASC");echo "Reverse order...\n";for ($row_no = $res->num_rows - 1; $row_no >= 0; $row_no--) { $res->data_seek($row_no); $row = $res->fetch_assoc(); echo " id = " . $row['id'] . "\n";}echo "Result set order...\n";$res->data_seek(0);while ($row = $res->fetch_assoc()) { echo " id = " . $row['id'] . "\n";}?>

The above example will output:

Reverse order... id = 3 id = 2 id = 1Result set order... id = 1 id = 2 id = 3

Unbuffered result sets

If client memory is a short resource and freeing server resources as early as possible to keep server load low is not needed, unbuffered results can be used. Scrolling through unbuffered results is not possible before all rows have been read.

Example 22.84. Navigation through unbuffered results

<?php$mysqli->real_query("SELECT id FROM test ORDER BY id ASC");$res = $mysqli->use_result();echo "Result set order...\n";while ($row = $res->fetch_assoc()) { echo " id = " . $row['id'] . "\n";}?>

Result set values data types

The mysqli_query, mysqli_real_query and mysqli_multi_query functions are used to execute non-prepared statements. At the level of the MySQL Client Server Protocol, the command COM_QUERY and the text protocol are used for statement execution. With the text protocol, the MySQL server converts all data of a result sets into strings before sending. This conversion is done regardless of the SQL result set column data type. The mysql client libraries receive all column values as strings. No further client-side casting is done to convert columns back to their native types. Instead, all values are provided as PHP strings.

Example 22.85. Text protocol returns strings by default

<?php$mysqli = new mysqli("example.com", "user", "password", "database");if ($mysqli->connect_errno) { echo "Failed to connect to MySQL: (" . $mysqli->connect_errno . ") " . $mysqli->connect_error;}if (!$mysqli->query("DROP TABLE IF EXISTS test") || !$mysqli->query("CREATE TABLE test(id INT, label CHAR(1))") || !$mysqli->query("INSERT INTO test(id, label) VALUES (1, 'a')")) { echo "Table creation failed: (" . $mysqli->errno . ") " . $mysqli->error;}$res = $mysqli->query("SELECT id, label FROM test WHERE id = 1");$row = $res->fetch_assoc();printf("id = %s (%s)\n", $row['id'], gettype($row['id']));printf("label = %s (%s)\n", $row['label'], gettype($row['label']));?>

The above example will output:

id = 1 (string)label = a (string)

It is possible to convert integer and float columns back to PHP numbers by setting the MYSQLI_OPT_INT_AND_FLOAT_NATIVE connection option, if using the mysqlnd library. If set, the mysqlnd library will check the result set meta data column types and convert numeric SQL columns to PHP numbers, if the PHP data type value range allows for it. This way, for example, SQL INT columns are returned as integers.

Example 22.86. Native data types with mysqlnd and connection option

<?php$mysqli = mysqli_init();$mysqli->options(MYSQLI_OPT_INT_AND_FLOAT_NATIVE, 1);$mysqli->real_connect("example.com", "user", "password", "database");if ($mysqli->connect_errno) { echo "Failed to connect to MySQL: (" . $mysqli->connect_errno . ") " . $mysqli->connect_error;}if (!$mysqli->query("DROP TABLE IF EXISTS test") || !$mysqli->query("CREATE TABLE test(id INT, label CHAR(1))") || !$mysqli->query("INSERT INTO test(id, label) VALUES (1, 'a')")) { echo "Table creation failed: (" . $mysqli->errno . ") " . $mysqli->error;}$res = $mysqli->query("SELECT id, label FROM test WHERE id = 1");$row = $res->fetch_assoc();printf("id = %s (%s)\n", $row['id'], gettype($row['id']));printf("label = %s (%s)\n", $row['label'], gettype($row['label']));?>

The above example will output:

id = 1 (integer)label = a (string)

See also

22.9.3.3.4. Prepared Statements

The MySQL database supports prepared statements. A prepared statement or a parameterized statement is used to execute the same statement repeatedly with high efficiency.

Basic workflow

The prepared statement execution consists of two stages: prepare and execute. At the prepare stage a statement template is send to the database server. The server performs a syntax check and initializes server internal resources for later use.

The MySQL server supports using anonymous, positional placeholder with ?.

Example 22.87. First stage: prepare

<?php$mysqli = new mysqli("example.com", "user", "password", "database");if ($mysqli->connect_errno) { echo "Failed to connect to MySQL: (" . $mysqli->connect_errno . ") " . $mysqli->connect_error;}/* Non-prepared statement */if (!$mysqli->query("DROP TABLE IF EXISTS test") || !$mysqli->query("CREATE TABLE test(id INT)")) { echo "Table creation failed: (" . $mysqli->errno . ") " . $mysqli->error;}/* Prepared statement, stage 1: prepare */if (!($stmt = $mysqli->prepare("INSERT INTO test(id) VALUES (?)"))) { echo "Prepare failed: (" . $mysqli->errno . ") " . $mysqli->error;}?>

Prepare is followed by execute. During execute the client binds parameter values and sends them to the server. The server creates a statement from the statement template and the bound values to execute it using the previously created internal resources.

Example 22.88. Second stage: bind and execute

<?php/* Prepared statement, stage 2: bind and execute */$id = 1;if (!$stmt->bind_param("i", $id)) { echo "Binding parameters failed: (" . $stmt->errno . ") " . $stmt->error;}if (!$stmt->execute()) { echo "Execute failed: (" . $stmt->errno . ") " . $stmt->error;}?>

Repeated execution

A prepared statement can be executed repeatedly. Upon every execution the current value of the bound variable is evaluated and send to the server. The statement is not parsed again. The statement template is not transferred to the server again.

Example 22.89. INSERT prepared once, executed multiple times

<?php$mysqli = new mysqli("example.com", "user", "password", "database");if ($mysqli->connect_errno) { echo "Failed to connect to MySQL: (" . $mysqli->connect_errno . ") " . $mysqli->connect_error;}/* Non-prepared statement */if (!$mysqli->query("DROP TABLE IF EXISTS test") || !$mysqli->query("CREATE TABLE test(id INT)")) { echo "Table creation failed: (" . $mysqli->errno . ") " . $mysqli->error;}/* Prepared statement, stage 1: prepare */if (!($stmt = $mysqli->prepare("INSERT INTO test(id) VALUES (?)"))) { echo "Prepare failed: (" . $mysqli->errno . ") " . $mysqli->error;}/* Prepared statement, stage 2: bind and execute */$id = 1;if (!$stmt->bind_param("i", $id)) { echo "Binding parameters failed: (" . $stmt->errno . ") " . $stmt->error;}if (!$stmt->execute()) { echo "Execute failed: (" . $stmt->errno . ") " . $stmt->error;}/* Prepared statement: repeated execution, only data transferred from client to server */for ($id = 2; $id < 5; $id++) { if (!$stmt->execute()) { echo "Execute failed: (" . $stmt->errno . ") " . $stmt->error; }}/* explicit close recommended */$stmt->close();/* Non-prepared statement */$res = $mysqli->query("SELECT id FROM test");var_dump($res->fetch_all());?>

The above example will output:

array(4) {  [0]=>  array(1) { [0]=> string(1) "1"  }  [1]=>  array(1) { [0]=> string(1) "2"  }  [2]=>  array(1) { [0]=> string(1) "3"  }  [3]=>  array(1) { [0]=> string(1) "4"  }}

Every prepared statement occupies server resources. Statements should be closed explicitly immediately after use. If not done explicitly, the statement will be closed when the statement handle is freed by PHP.

Using a prepared statement is not always the most efficient way of executing a statement. A prepared statement executed only once causes more client-server round-trips than a non-prepared statement. This is why the SELECT is not run as a prepared statement above.

Also, consider the use of the MySQL multi-INSERT SQL syntax for INSERTs. For the example, multi-INSERT requires less round-trips between the server and client than the prepared statement shown above.

Example 22.90. Less round trips using multi-INSERT SQL

<?phpif (!$mysqli->query("INSERT INTO test(id) VALUES (1), (2), (3), (4)")) { echo "Multi-INSERT failed: (" . $mysqli->errno . ") " . $mysqli->error;}?>

Result set values data types

The MySQL Client Server Protocol defines a different data transfer protocol for prepared statements and non-prepared statements. Prepared statements are using the so called binary protocol. The MySQL server sends result set data "as is" in binary format. Results are not serialized into strings before sending. The client libraries do not receive strings only. Instead, they will receive binary data and try to convert the values into appropriate PHP data types. For example, results from an SQL INT column will be provided as PHP integer variables.

Example 22.91. Native datatypes

<?php$mysqli = new mysqli("example.com", "user", "password", "database");if ($mysqli->connect_errno) { echo "Failed to connect to MySQL: (" . $mysqli->connect_errno . ") " . $mysqli->connect_error;}if (!$mysqli->query("DROP TABLE IF EXISTS test") || !$mysqli->query("CREATE TABLE test(id INT, label CHAR(1))") || !$mysqli->query("INSERT INTO test(id, label) VALUES (1, 'a')")) { echo "Table creation failed: (" . $mysqli->errno . ") " . $mysqli->error;}$stmt = $mysqli->prepare("SELECT id, label FROM test WHERE id = 1");$stmt->execute();$res = $stmt->get_result();$row = $res->fetch_assoc();printf("id = %s (%s)\n", $row['id'], gettype($row['id']));printf("label = %s (%s)\n", $row['label'], gettype($row['label']));?>

The above example will output:

id = 1 (integer)label = a (string)

This behavior differs from non-prepared statements. By default, non-prepared statements return all results as strings. This default can be changed using a connection option. If the connection option is used, there are no differences.

Fetching results using bound variables

Results from prepared statements can either be retrieved by binding output variables, or by requesting a mysqli_result object.

Output variables must be bound after statement execution. One variable must be bound for every column of the statements result set.

Example 22.92. Output variable binding

<?php$mysqli = new mysqli("example.com", "user", "password", "database");if ($mysqli->connect_errno) { echo "Failed to connect to MySQL: (" . $mysqli->connect_errno . ") " . $mysqli->connect_error;}if (!$mysqli->query("DROP TABLE IF EXISTS test") || !$mysqli->query("CREATE TABLE test(id INT, label CHAR(1))") || !$mysqli->query("INSERT INTO test(id, label) VALUES (1, 'a')")) { echo "Table creation failed: (" . $mysqli->errno . ") " . $mysqli->error;}if (!($stmt = $mysqli->prepare("SELECT id, label FROM test"))) { echo "Prepare failed: (" . $mysqli->errno . ") " . $mysqli->error;}if (!$stmt->execute()) { echo "Execute failed: (" . $mysqli->errno . ") " . $mysqli->error;}$out_id = NULL;$out_label = NULL;if (!$stmt->bind_result($out_id, $out_label)) { echo "Binding output parameters failed: (" . $stmt->errno . ") " . $stmt->error;}while ($stmt->fetch()) { printf("id = %s (%s), label = %s (%s)\n", $out_id, gettype($out_id), $out_label, gettype($out_label));}?>

The above example will output:

id = 1 (integer), label = a (string)

Prepared statements return unbuffered result sets by default. The results of the statement are not implicitly fetched and transferred from the server to the client for client-side buffering. The result set takes server resources until all results have been fetched by the client. Thus it is recommended to consume results timely. If a client fails to fetch all results or the client closes the statement before having fetched all data, the data has to be fetched implicitly by mysqli.

It is also possible to buffer the results of a prepared statement using mysqli_stmt_store_result.

Fetching results using mysqli_result interface

Instead of using bound results, results can also be retrieved through the mysqli_result interface. mysqli_stmt_get_result returns a buffered result set.

Example 22.93. Using mysqli_result to fetch results

<?php$mysqli = new mysqli("example.com", "user", "password", "database");if ($mysqli->connect_errno) { echo "Failed to connect to MySQL: (" . $mysqli->connect_errno . ") " . $mysqli->connect_error;}if (!$mysqli->query("DROP TABLE IF EXISTS test") || !$mysqli->query("CREATE TABLE test(id INT, label CHAR(1))") || !$mysqli->query("INSERT INTO test(id, label) VALUES (1, 'a')")) { echo "Table creation failed: (" . $mysqli->errno . ") " . $mysqli->error;}if (!($stmt = $mysqli->prepare("SELECT id, label FROM test ORDER BY id ASC"))) { echo "Prepare failed: (" . $mysqli->errno . ") " . $mysqli->error;}if (!$stmt->execute()) { echo "Execute failed: (" . $stmt->errno . ") " . $stmt->error;}if (!($res = $stmt->get_result())) { echo "Getting result set failed: (" . $stmt->errno . ") " . $stmt->error;}var_dump($res->fetch_all());?>

The above example will output:

array(1) {  [0]=>  array(2) { [0]=> int(1) [1]=> string(1) "a"  }}

Using the mysqli_result interface offers the additional benefit of flexible client-side result set navigation.

Example 22.94. Buffered result set for flexible read out

<?php$mysqli = new mysqli("example.com", "user", "password", "database");if ($mysqli->connect_errno) { echo "Failed to connect to MySQL: (" . $mysqli->connect_errno . ") " . $mysqli->connect_error;}if (!$mysqli->query("DROP TABLE IF EXISTS test") || !$mysqli->query("CREATE TABLE test(id INT, label CHAR(1))") || !$mysqli->query("INSERT INTO test(id, label) VALUES (1, 'a'), (2, 'b'), (3, 'c')")) { echo "Table creation failed: (" . $mysqli->errno . ") " . $mysqli->error;}if (!($stmt = $mysqli->prepare("SELECT id, label FROM test"))) { echo "Prepare failed: (" . $mysqli->errno . ") " . $mysqli->error;}if (!$stmt->execute()) { echo "Execute failed: (" . $stmt->errno . ") " . $stmt->error;}if (!($res = $stmt->get_result())) { echo "Getting result set failed: (" . $stmt->errno . ") " . $stmt->error;}for ($row_no = ($res->num_rows - 1); $row_no >= 0; $row_no--) { $res->data_seek($row_no); var_dump($res->fetch_assoc());}$res->close();?>

The above example will output:

array(2) {  ["id"]=>  int(3)  ["label"]=>  string(1) "c"}array(2) {  ["id"]=>  int(2)  ["label"]=>  string(1) "b"}array(2) {  ["id"]=>  int(1)  ["label"]=>  string(1) "a"}

Escaping and SQL injection

Bound variables will be escaped automatically by the server. The server inserts their escaped values at the appropriate places into the statement template before execution. A hint must be provided to the server for the type of bound variable, to create an appropriate conversion. See the mysqli_stmt_bind_param function for more information.

The automatic escaping of values within the server is sometimes considered a security feature to prevent SQL injection. The same degree of security can be achieved with non-prepared statements, if input values are escaped correctly.

Client-side prepared statement emulation

The API does not include emulation for client-side prepared statement emulation.

Quick prepared - non-prepared statement comparison

The table below compares server-side prepared and non-prepared statements.

Table 22.37. Comparison of prepared and non-prepared statements

	Prepared Statement	Non-prepared statement
Client-server round trips, SELECT, single execution	2	1
Statement string transferred from client to server	1	1
Client-server round trips, SELECT, repeated (n) execution	1 + n	n
Statement string transferred from client to server	1 template, n times bound parameter, if any	n times together with parameter, if any
Input parameter binding API	Yes, automatic input escaping	No, manual input escaping
Output variable binding API	Yes	No
Supports use of mysqli_result API	Yes, use mysqli_stmt_get_result	Yes
Buffered result sets	Yes, use mysqli_stmt_get_result or binding with mysqli_stmt_store_result	Yes, default of mysqli_query
Unbuffered result sets	Yes, use output binding API	Yes, use mysqli_real_query withmysqli_use_result
MySQL Client Server protocol data transfer flavor	Binary protocol	Text protocol
Result set values SQL data types	Preserved when fetching	Converted to string or preserved when fetching
Supports all SQL statements	Recent MySQL versions support most but not all	Yes

See also

mysqli_stmt::bind_param

mysqli_stmt::bind_result

22.9.3.3.5. Stored Procedures

The MySQL database supports stored procedures. A stored procedure is a subroutine stored in the database catalog. Applications can call and execute the stored procedure. The CALL SQL statement is used to execute a stored procedure.

Parameter

Stored procedures can have IN, INOUT and OUT parameters, depending on the MySQL version. The mysqli interface has no special notion for the different kinds of parameters.

IN parameter

Input parameters are provided with the CALL statement. Please, make sure values are escaped correctly.

Example 22.95. Calling a stored procedure

<?php$mysqli = new mysqli("example.com", "user", "password", "database");if ($mysqli->connect_errno) { echo "Failed to connect to MySQL: (" . $mysqli->connect_errno . ") " . $mysqli->connect_error;}if (!$mysqli->query("DROP TABLE IF EXISTS test") || !$mysqli->query("CREATE TABLE test(id INT)")) { echo "Table creation failed: (" . $mysqli->errno . ") " . $mysqli->error;}if (!$mysqli->query("DROP PROCEDURE IF EXISTS p") || !$mysqli->query("CREATE PROCEDURE p(IN id_val INT) BEGIN INSERT INTO test(id) VALUES(id_val); END;")) { echo "Stored procedure creation failed: (" . $mysqli->errno . ") " . $mysqli->error;}if (!$mysqli->query("CALL p(1)")) { echo "CALL failed: (" . $mysqli->errno . ") " . $mysqli->error;}if (!($res = $mysqli->query("SELECT id FROM test"))) { echo "SELECT failed: (" . $mysqli->errno . ") " . $mysqli->error;}var_dump($res->fetch_assoc());?>

The above example will output:

array(1) {  ["id"]=>  string(1) "1"}

INOUT/OUT parameter

The values of INOUT/OUT parameters are accessed using session variables.

Example 22.96. Using session variables

<?php$mysqli = new mysqli("example.com", "user", "password", "database");if ($mysqli->connect_errno) { echo "Failed to connect to MySQL: (" . $mysqli->connect_errno . ") " . $mysqli->connect_error;}if (!$mysqli->query("DROP PROCEDURE IF EXISTS p") || !$mysqli->query('CREATE PROCEDURE p(OUT msg VARCHAR(50)) BEGIN SELECT "Hi!" INTO msg; END;')) { echo "Stored procedure creation failed: (" . $mysqli->errno . ") " . $mysqli->error;}if (!$mysqli->query("SET @msg = ''") || !$mysqli->query("CALL p(@msg)")) { echo "CALL failed: (" . $mysqli->errno . ") " . $mysqli->error;}if (!($res = $mysqli->query("SELECT @msg as _p_out"))) { echo "Fetch failed: (" . $mysqli->errno . ") " . $mysqli->error;}$row = $res->fetch_assoc();echo $row['_p_out'];?>

The above example will output:

Hi!

Application and framework developers may be able to provide a more convenient API using a mix of session variables and databased catalog inspection. However, please note the possible performance impact of a custom solution based on catalog inspection.

Handling result sets

Stored procedures can return result sets. Result sets returned from a stored procedure cannot be fetched correctly using mysqli_query. The mysqli_query function combines statement execution and fetching the first result set into a buffered result set, if any. However, there are additional stored procedure result sets hidden from the user which cause mysqli_query to fail returning the user expected result sets.

Result sets returned from a stored procedure are fetched using mysqli_real_query or mysqli_multi_query. Both functions allow fetching any number of result sets returned by a statement, such as CALL. Failing to fetch all result sets returned by a stored procedure causes an error.

Example 22.97. Fetching results from stored procedures

<?php$mysqli = new mysqli("example.com", "user", "password", "database");if ($mysqli->connect_errno) { echo "Failed to connect to MySQL: (" . $mysqli->connect_errno . ") " . $mysqli->connect_error;}if (!$mysqli->query("DROP TABLE IF EXISTS test") || !$mysqli->query("CREATE TABLE test(id INT)") || !$mysqli->query("INSERT INTO test(id) VALUES (1), (2), (3)")) { echo "Table creation failed: (" . $mysqli->errno . ") " . $mysqli->error;}if (!$mysqli->query("DROP PROCEDURE IF EXISTS p") || !$mysqli->query('CREATE PROCEDURE p() READS SQL DATA BEGIN SELECT id FROM test; SELECT id + 1 FROM test; END;')) { echo "Stored procedure creation failed: (" . $mysqli->errno . ") " . $mysqli->error;}if (!$mysqli->multi_query("CALL p()")) { echo "CALL failed: (" . $mysqli->errno . ") " . $mysqli->error;}do { if ($res = $mysqli->store_result()) { printf("---\n"); var_dump($res->fetch_all()); $res->free(); } else { if ($mysqli->errno) { echo "Store failed: (" . $mysqli->errno . ") " . $mysqli->error; } }} while ($mysqli->more_results() && $mysqli->next_result());?>

The above example will output:

---array(3) {  [0]=>  array(1) { [0]=> string(1) "1"  }  [1]=>  array(1) { [0]=> string(1) "2"  }  [2]=>  array(1) { [0]=> string(1) "3"  }}---array(3) {  [0]=>  array(1) { [0]=> string(1) "2"  }  [1]=>  array(1) { [0]=> string(1) "3"  }  [2]=>  array(1) { [0]=> string(1) "4"  }}

Use of prepared statements

No special handling is required when using the prepared statement interface for fetching results from the same stored procedure as above. The prepared statement and non-prepared statement interfaces are similar. Please note, that not every MYSQL server version may support preparing the CALL SQL statement.

Example 22.98. Stored Procedures and Prepared Statements

<?php$mysqli = new mysqli("example.com", "user", "password", "database");if ($mysqli->connect_errno) { echo "Failed to connect to MySQL: (" . $mysqli->connect_errno . ") " . $mysqli->connect_error;}if (!$mysqli->query("DROP TABLE IF EXISTS test") || !$mysqli->query("CREATE TABLE test(id INT)") || !$mysqli->query("INSERT INTO test(id) VALUES (1), (2), (3)")) { echo "Table creation failed: (" . $mysqli->errno . ") " . $mysqli->error;}if (!$mysqli->query("DROP PROCEDURE IF EXISTS p") || !$mysqli->query('CREATE PROCEDURE p() READS SQL DATA BEGIN SELECT id FROM test; SELECT id + 1 FROM test; END;')) { echo "Stored procedure creation failed: (" . $mysqli->errno . ") " . $mysqli->error;}if (!($stmt = $mysqli->prepare("CALL p()"))) { echo "Prepare failed: (" . $mysqli->errno . ") " . $mysqli->error;}if (!$stmt->execute()) { echo "Execute failed: (" . $stmt->errno . ") " . $stmt->error;}do { if ($res = $stmt->get_result()) { printf("---\n"); var_dump(mysqli_fetch_all($res)); mysqli_free_result($res); } else { if ($stmt->errno) { echo "Store failed: (" . $stmt->errno . ") " . $stmt->error; } }} while ($stmt->more_results() && $stmt->next_result());?>

Of course, use of the bind API for fetching is supported as well.

Example 22.99. Stored Procedures and Prepared Statements using bind API

<?phpif (!($stmt = $mysqli->prepare("CALL p()"))) { echo "Prepare failed: (" . $mysqli->errno . ") " . $mysqli->error;}if (!$stmt->execute()) { echo "Execute failed: (" . $stmt->errno . ") " . $stmt->error;}do { $id_out = NULL; if (!$stmt->bind_result($id_out)) { echo "Bind failed: (" . $stmt->errno . ") " . $stmt->error; } while ($stmt->fetch()) { echo "id = $id_out\n"; }} while ($stmt->more_results() && $stmt->next_result());?>

See also

mysqli_result::next-result

mysqli_result::more-results

22.9.3.3.6. Multiple Statements

MySQL optionally allows having multiple statements in one statement string. Sending multiple statements at once reduces client-server round trips but requires special handling.

Multiple statements or multi queries must be executed with mysqli_multi_query. The individual statements of the statement string are separated by semicolon. Then, all result sets returned by the executed statements must be fetched.

The MySQL server allows having statements that do return result sets and statements that do not return result sets in one multiple statement.

Example 22.100. Multiple Statements

<?php$mysqli = new mysqli("example.com", "user", "password", "database");if ($mysqli->connect_errno) { echo "Failed to connect to MySQL: (" . $mysqli->connect_errno . ") " . $mysqli->connect_error;}if (!$mysqli->query("DROP TABLE IF EXISTS test") || !$mysqli->query("CREATE TABLE test(id INT)")) { echo "Table creation failed: (" . $mysqli->errno . ") " . $mysqli->error;}$sql = "SELECT COUNT(*) AS _num FROM test; ";$sql.= "INSERT INTO test(id) VALUES (1); ";$sql.= "SELECT COUNT(*) AS _num FROM test; ";if (!$mysqli->multi_query($sql)) { echo "Multi query failed: (" . $mysqli->errno . ") " . $mysqli->error;}do { if ($res = $mysqli->store_result()) { var_dump($res->fetch_all(MYSQLI_ASSOC)); $res->free(); }} while ($mysqli->more_results() && $mysqli->next_result());?>

The above example will output:

array(1) {  [0]=>  array(1) { ["_num"]=> string(1) "0"  }}array(1) {  [0]=>  array(1) { ["_num"]=> string(1) "1"  }}

Security considerations

The API functions mysqli_query and mysqli_real_query do not set a connection flag necessary for activating multi queries in the server. An extra API call is used for multiple statements to reduce the likeliness of accidental SQL injection attacks. An attacker may try to add statements such as ; DROP DATABASE mysql or ; SELECT SLEEP(999). If the attacker succeeds in adding SQL to the statement string but mysqli_multi_query is not used, the server will not execute the second, injected and malicious SQL statement.

Example 22.101. SQL Injection

<?php$mysqli = new mysqli("example.com", "user", "password", "database");$res = $mysqli->query("SELECT 1; DROP TABLE mysql.user");if (!$res) { echo "Error executing query: (" . $mysqli->errno . ") " . $mysqli->error;}?>

The above example will output:

Error executing query: (1064) You have an error in your SQL syntax;check the manual that corresponds to your MySQL server version for the right syntax to use near 'DROP TABLE mysql.user' at line 1

Prepared statements

Use of the multiple statement with prepared statements is not supported.

See also

mysqli_result::next-result

mysqli_result::more-results

22.9.3.3.7. API support for transactions

The MySQL server supports transactions depending on the storage engine used. Since MySQL 5.5, the default storage engine is InnoDB. InnoDB has full ACID transaction support.

Transactions can either be controlled using SQL or API calls. It is recommended to use API calls for enabling and disabling the auto commit mode and for committing and rolling back transactions.

Example 22.102. Setting auto commit mode with SQL and through the API

<?php$mysqli = new mysqli("example.com", "user", "password", "database");if ($mysqli->connect_errno) { echo "Failed to connect to MySQL: (" . $mysqli->connect_errno . ") " . $mysqli->connect_error;}/* Recommended: using API to control transactional settings */$mysqli->autocommit(false);/* Won't be monitored and recognized by the replication and the load balancing plugin */if (!$mysqli->query('SET AUTOCOMMIT = 0')) { echo "Query failed: (" . $mysqli->errno . ") " . $mysqli->error;}?>

Optional feature packages, such as the replication and load balancing plugin, can easily monitor API calls. The replication plugin offers transaction aware load balancing, if transactions are controlled with API calls. Transaction aware load balancing is not available if SQL statements are used for setting auto commit mode, committing or rolling back a transaction.

Example 22.103. Commit and rollback

<?php$mysqli = new mysqli("example.com", "user", "password", "database");$mysqli->autocommit(false);$mysqli->query("INSERT INTO test(id) VALUES (1)");$mysqli->rollback();$mysqli->query("INSERT INTO test(id) VALUES (2)");$mysqli->commit();?>

Please note, that the MySQL server cannot roll back all statements. Some statements cause am implicit commit.

See also

mysqli::autocommit

mysqli_result::commit

mysqli_result::rollback

22.9.3.3.8. Metadata

A MySQL result set contains metadata. The metadata describes the columns found in the result set. All metadata send by MySQL is accessible through the mysqli interface. The extension performs no or negligible changes to the information it receives. Differences between MySQL server versions are not aligned.

Meta data is access through the mysqli_result interface.

Example 22.104. Accessing result set meta data

<?php$mysqli = new mysqli("example.com", "user", "password", "database");if ($mysqli->connect_errno) { echo "Failed to connect to MySQL: (" . $mysqli->connect_errno . ") ". $mysqli->connect_error;}$res = $mysqli->query("SELECT 1 AS _one, 'Hello' AS _two FROM DUAL");var_dump($res->fetch_fields());?>

The above example will output:

array(2) {  [0]=>  object(stdClass)#3 (13) { ["name"]=> string(4) "_one" ["orgname"]=> string(0) "" ["table"]=> string(0) "" ["orgtable"]=> string(0) "" ["def"]=> string(0) "" ["db"]=> string(0) "" ["catalog"]=> string(3) "def" ["max_length"]=> int(1) ["length"]=> int(1) ["charsetnr"]=> int(63) ["flags"]=> int(32897) ["type"]=> int(8) ["decimals"]=> int(0)  }  [1]=>  object(stdClass)#4 (13) { ["name"]=> string(4) "_two" ["orgname"]=> string(0) "" ["table"]=> string(0) "" ["orgtable"]=> string(0) "" ["def"]=> string(0) "" ["db"]=> string(0) "" ["catalog"]=> string(3) "def" ["max_length"]=> int(5) ["length"]=> int(5) ["charsetnr"]=> int(8) ["flags"]=> int(1) ["type"]=> int(253) ["decimals"]=> int(31)  }}

Prepared statements

Meta data of result sets created using prepared statements are accessed the same way. A suitable mysqli_result handle is returned by mysqli_stmt_result_metadata.

Example 22.105. Prepared statements metadata

<?php$stmt = $mysqli->prepare("SELECT 1 AS _one, 'Hello' AS _two FROM DUAL");$stmt->execute();$res = $stmt->result_metadata();var_dump($res->fetch_fields());?>

See also

mysqli_result::fetch_fields

22.9.3.4. Installing/Configuring

22.9.3.4.1. Requirements

In order to have these functions available, you must compile PHP with support for the mysqli extension.

Note

The mysqli extension is designed to work with MySQL version 4.1.13 or newer, or 5.0.7 or newer. For previous versions, please see the MySQL extension documentation.

22.9.3.4.2. Installation

The mysqli extension was introduced with PHP version 5.0.0. The MySQL Native Driver was included in PHP version 5.3.0.

22.9.3.4.2.1. Installation on Linux

The common Unix distributions include binary versions of PHP that can be installed. Although these binary versions are typically built with support for MySQL extensions enabled, the extension libraries themselves may need to be installed using an additional package. Check the package manager than comes with your chosen distribution for availability.

Unless your Unix distribution comes with a binary package of PHP with the mysqli extension available, you will need to build PHP from source code. Building PHP from source allows you to specify the MySQL extensions you want to use, as well as your choice of client library for each extension.

The MySQL Native Driver is the recommended option, as it results in improved performance and gives access to features not available when using the MySQL Client Library. Refer to What is PHP's MySQL Native Driver? for a brief overview of the advantages of MySQL Native Driver.

The /path/to/mysql_config represents the location of the mysql_config program that comes with MySQL Server.

Table 22.38. mysqli compile time support matrix

PHP Version	Default	Configure Options:mysqlnd	Configure Options: libmysql	Changelog
5.0.x, 5.1.x, 5.2.x	libmysql	Not Available	--with-mysqli=/path/to/mysql_config
5.3.x	libmysql	--with-mysqli=mysqlnd	--with-mysqli=/path/to/mysql_config	mysqlnd is now supported
5.4.x	mysqlnd	--with-mysqli	--with-mysqli=/path/to/mysql_config	mysqlnd is now the default

Note that it is possible to freely mix MySQL extensions and client libraries. For example, it is possible to enable the MySQL extension to use the MySQL Client Library (libmysql), while configuring the mysqli extension to use the MySQL Native Driver. However, all permutations of extension and client library are possible.

The following example builds the MySQL extension to use the MySQL Client Library, and the mysqli and PDO MYSQL extensions to use the MySQL Native Driver:

./configure --with-mysql=/usr/bin/mysql_config  \--with-mysqli=mysqlnd \--with-pdo-mysql=mysqlnd[other options]

22.9.3.4.2.2. Installation on Windows Systems

On Windows, PHP is most commonly installed using the binary installer.

22.9.3.4.2.2.1. PHP 5.0, 5.1, 5.2

Once PHP has been installed, some configuration is required to enable mysqli and specify the client library you want it to use.

The mysqli extension is not enabled by default, so the php_mysqli.dll DLL must be enabled inside of php.ini. In order to do this you need to find the php.ini file (typically located in c:\php), and make sure you remove the comment (semi-colon) from the start of the line extension=php_mysqli.dll, in the section marked [PHP_MYSQLI].

Also, if you want to use the MySQL Client Library with mysqli, you need to make sure PHP can access the client library file. The MySQL Client Library is included as a file named libmysql.dll in the Windows PHP distribution. This file needs to be available in the Windows system's PATH environment variable, so that it can be successfully loaded. See the FAQ titled "How do I add my PHP directory to the PATH on Windows" for information on how to do this. Copying libmysql.dll to the Windows system directory (typically c:\Windows\system) also works, as the system directory is by default in the system's PATH. However, this practice is strongly discouraged.

As with enabling any PHP extension (such as php_mysqli.dll), the PHP directive extension_dir should be set to the directory where the PHP extensions are located. See also the Manual Windows Installation Instructions. An example extension_dir value for PHP 5 is c:\php\ext.

Note

If when starting the web server an error similar to the following occurs: "Unable to load dynamic library './php_mysqli.dll'", this is because php_mysqli.dll and/or libmysql.dll cannot be found by the system.

22.9.3.4.2.2.2. PHP 5.3.0+

On Windows, for PHP versions 5.3 and newer, the mysqli extension is enabled and uses the MySQL Native Driver by default. This means you don't need to worry about configuring access to libmysql.dll.

22.9.3.4.3. Runtime Configuration

The behaviour of these functions is affected by settings in php.ini.

Table 22.39. MySQLi Configuration Options

Name	Default	Changeable	Changelog
mysqli.allow_local_infile	"1"	PHP_INI_SYSTEM	Available since PHP 5.2.4.
mysqli.allow_persistent	"1"	PHP_INI_SYSTEM	Available since PHP 5.3.0.
mysqli.max_persistent	"-1"	PHP_INI_SYSTEM	Available since PHP 5.3.0.
mysqli.max_links	"-1"	PHP_INI_SYSTEM	Available since PHP 5.0.0.
mysqli.default_port	"3306"	PHP_INI_ALL	Available since PHP 5.0.0.
mysqli.default_socket	NULL	PHP_INI_ALL	Available since PHP 5.0.0.
mysqli.default_host	NULL	PHP_INI_ALL	Available since PHP 5.0.0.
mysqli.default_user	NULL	PHP_INI_ALL	Available since PHP 5.0.0.
mysqli.default_pw	NULL	PHP_INI_ALL	Available since PHP 5.0.0.
mysqli.reconnect	"0"	PHP_INI_SYSTEM	Available since PHP 4.3.5.
mysqli.cache_size	"2000"	PHP_INI_SYSTEM	Available since PHP 5.3.0.

For further details and definitions of the preceding PHP_INI_* constants, see the chapter on configuration changes.

Here's a short explanation of the configuration directives.

mysqli.allow_local_infile integer: Allow accessing, from PHP's perspective, local files with LOAD DATA statements
mysqli.allow_persistent integer: Enable the ability to create persistent connections using mysqli_connect.
mysqli.max_persistent integer: Maximum of persistent connections that can be made. Set to 0 for unlimited.
mysqli.max_links integer: The maximum number of MySQL connections per process.
mysqli.default_port integer: The default TCP port number to use when connecting to the database server if no other port is specified. If no default is specified, the port will be obtained from the MYSQL_TCP_PORT environment variable, the mysql-tcp entry in /etc/services or the compile-time MYSQL_PORT constant, in that order. Win32 will only use the MYSQL_PORT constant.
mysqli.default_socket string: The default socket name to use when connecting to a local database server if no other socket name is specified.
mysqli.default_host string: The default server host to use when connecting to the database server if no other host is specified. Doesn't apply in safe mode.
mysqli.default_user string: The default user name to use when connecting to the database server if no other name is specified. Doesn't apply in safe mode.
mysqli.default_pw string: The default password to use when connecting to the database server if no other password is specified. Doesn't apply in safe mode.
mysqli.reconnect integer: Automatically reconnect if the connection was lost.
mysqli.cache_size integer: Available only with mysqlnd.

Users cannot set MYSQL_OPT_READ_TIMEOUT through an API call or runtime configuration setting. Note that if it were possible there would be differences between how libmysql and streams would interpret the value of MYSQL_OPT_READ_TIMEOUT.

22.9.3.4.4. Resource Types

This extension has no resource types defined.

22.9.3.5. The mysqli Extension and Persistent Connections

Persistent connection support was introduced in PHP 5.3 for the mysqli extension. Support was already present in PDO MYSQL and ext/mysql. The idea behind persistent connections is that a connection between a client process and a database can be reused by a client process, rather than being created and destroyed multiple times. This reduces the overhead of creating fresh connections every time one is required, as unused connections are cached and ready to be reused.

Unlike the mysql extension, mysqli does not provide a separate function for opening persistent connections. To open a persistent connection you must prepend p: to the hostname when connecting.

The problem with persistent connections is that they can be left in unpredictable states by clients. For example, a table lock might be activated before a client terminates unexpectedly. A new client process reusing this persistent connection will get the connection "as is". Any cleanup would need to be done by the new client process before it could make good use of the persistent connection, increasing the burden on the programmer.

The persistent connection of the mysqli extension however provides built-in cleanup handling code. The cleanup carried out by mysqli includes:

Rollback active transactions
Close and drop temporary tables
Unlock tables
Reset session variables
Close prepared statements (always happens with PHP)
Close handler
Release locks acquired with GET_LOCK

This ensures that persistent connections are in a clean state on return from the connection pool, before the client process uses them.

The mysqli extension does this cleanup by automatically calling the C-API function mysql_change_user().

The automatic cleanup feature has advantages and disadvantages though. The advantage is that the programmer no longer needs to worry about adding cleanup code, as it is called automatically. However, the disadvantage is that the code could potentially be a little slower, as the code to perform the cleanup needs to run each time a connection is returned from the connection pool.

It is possible to switch off the automatic cleanup code, by compiling PHP with MYSQLI_NO_CHANGE_USER_ON_PCONNECT defined.

Note

The mysqli extension supports persistent connections when using either MySQL Native Driver or MySQL Client Library.

22.9.3.6. Predefined Constants

The constants below are defined by this extension, andwill only be available when the extension has eitherbeen compiled into PHP or dynamically loaded at runtime.

MYSQLI_READ_DEFAULT_GROUP: Read options from the named group from my.cnf or the file specified with MYSQLI_READ_DEFAULT_FILE
MYSQLI_READ_DEFAULT_FILE: Read options from the named option file instead of from my.cnf
MYSQLI_OPT_CONNECT_TIMEOUT: Connect timeout in seconds
MYSQLI_OPT_LOCAL_INFILE: Enables command LOAD LOCAL INFILE
MYSQLI_INIT_COMMAND: Command to execute when connecting to MySQL server. Will automatically be re-executed when reconnecting.
MYSQLI_CLIENT_SSL: Use SSL (encrypted protocol). This option should not be set by application programs; it is set internally in the MySQL client library
MYSQLI_CLIENT_COMPRESS: Use compression protocol
MYSQLI_CLIENT_INTERACTIVE: Allow interactive_timeout seconds (instead of wait_timeout seconds) of inactivity before closing the connection. The client's session wait_timeout variable will be set to the value of the session interactive_timeout variable.
MYSQLI_CLIENT_IGNORE_SPACE: Allow spaces after function names. Makes all functions names reserved words.
MYSQLI_CLIENT_NO_SCHEMA: Don't allow the db_name.tbl_name.col_name syntax.
MYSQLI_CLIENT_MULTI_QUERIES: Allows multiple semicolon-delimited queries in a single mysqli_query call.
MYSQLI_STORE_RESULT: For using buffered resultsets
MYSQLI_USE_RESULT: For using unbuffered resultsets
MYSQLI_ASSOC: Columns are returned into the array having the fieldname as the array index.
MYSQLI_NUM: Columns are returned into the array having an enumerated index.
MYSQLI_BOTH: Columns are returned into the array having both a numerical index and the fieldname as the associative index.
MYSQLI_NOT_NULL_FLAG: Indicates that a field is defined as NOT NULL
MYSQLI_PRI_KEY_FLAG: Field is part of a primary index
MYSQLI_UNIQUE_KEY_FLAG: Field is part of a unique index.
MYSQLI_MULTIPLE_KEY_FLAG: Field is part of an index.
MYSQLI_BLOB_FLAG: Field is defined as BLOB
MYSQLI_UNSIGNED_FLAG: Field is defined as UNSIGNED
MYSQLI_ZEROFILL_FLAG: Field is defined as ZEROFILL
MYSQLI_AUTO_INCREMENT_FLAG: Field is defined as AUTO_INCREMENT
MYSQLI_TIMESTAMP_FLAG: Field is defined as TIMESTAMP
MYSQLI_SET_FLAG: Field is defined as SET
MYSQLI_NUM_FLAG: Field is defined as NUMERIC
MYSQLI_PART_KEY_FLAG: Field is part of an multi-index
MYSQLI_GROUP_FLAG: Field is part of GROUP BY
MYSQLI_TYPE_DECIMAL: Field is defined as DECIMAL
MYSQLI_TYPE_NEWDECIMAL: Precision math DECIMAL or NUMERIC field (MySQL 5.0.3 and up)
MYSQLI_TYPE_BIT: Field is defined as BIT (MySQL 5.0.3 and up)
MYSQLI_TYPE_TINY: Field is defined as TINYINT
MYSQLI_TYPE_SHORT: Field is defined as SMALLINT
MYSQLI_TYPE_LONG: Field is defined as INT
MYSQLI_TYPE_FLOAT: Field is defined as FLOAT
MYSQLI_TYPE_DOUBLE: Field is defined as DOUBLE
MYSQLI_TYPE_NULL: Field is defined as DEFAULT NULL
MYSQLI_TYPE_TIMESTAMP: Field is defined as TIMESTAMP
MYSQLI_TYPE_LONGLONG: Field is defined as BIGINT
MYSQLI_TYPE_INT24: Field is defined as MEDIUMINT
MYSQLI_TYPE_DATE: Field is defined as DATE
MYSQLI_TYPE_TIME: Field is defined as TIME
MYSQLI_TYPE_DATETIME: Field is defined as DATETIME
MYSQLI_TYPE_YEAR: Field is defined as YEAR
MYSQLI_TYPE_NEWDATE: Field is defined as DATE
MYSQLI_TYPE_INTERVAL: Field is defined as INTERVAL
MYSQLI_TYPE_ENUM: Field is defined as ENUM
MYSQLI_TYPE_SET: Field is defined as SET
MYSQLI_TYPE_TINY_BLOB: Field is defined as TINYBLOB
MYSQLI_TYPE_MEDIUM_BLOB: Field is defined as MEDIUMBLOB
MYSQLI_TYPE_LONG_BLOB: Field is defined as LONGBLOB
MYSQLI_TYPE_BLOB: Field is defined as BLOB
MYSQLI_TYPE_VAR_STRING: Field is defined as VARCHAR
MYSQLI_TYPE_STRING: Field is defined as CHAR or BINARY
MYSQLI_TYPE_CHAR: Field is defined as TINYINT. For CHAR, see MYSQLI_TYPE_STRING
MYSQLI_TYPE_GEOMETRY: Field is defined as GEOMETRY
MYSQLI_NEED_DATA: More data available for bind variable
MYSQLI_NO_DATA: No more data available for bind variable
MYSQLI_DATA_TRUNCATED: Data truncation occurred. Available since PHP 5.1.0 and MySQL 5.0.5.
MYSQLI_ENUM_FLAG: Field is defined as ENUM. Available since PHP 5.3.0.
MYSQLI_CURSOR_TYPE_FOR_UPDATE
MYSQLI_CURSOR_TYPE_NO_CURSOR
MYSQLI_CURSOR_TYPE_READ_ONLY
MYSQLI_CURSOR_TYPE_SCROLLABLE
MYSQLI_STMT_ATTR_CURSOR_TYPE
MYSQLI_STMT_ATTR_PREFETCH_ROWS
MYSQLI_STMT_ATTR_UPDATE_MAX_LENGTH
MYSQLI_SET_CHARSET_NAME
MYSQLI_REPORT_INDEX: Report if no index or bad index was used in a query.
MYSQLI_REPORT_ERROR: Report errors from mysqli function calls.
MYSQLI_REPORT_STRICT: Throw a mysqli_sql_exception for errors instead of warnings.
MYSQLI_REPORT_ALL: Set all options on (report all).
MYSQLI_REPORT_OFF: Turns reporting off.
MYSQLI_DEBUG_TRACE_ENABLED: Is set to 1 if mysqli_debug functionality is enabled.
MYSQLI_SERVER_QUERY_NO_GOOD_INDEX_USED
MYSQLI_SERVER_QUERY_NO_INDEX_USED
MYSQLI_REFRESH_GRANT: Refreshes the grant tables.
MYSQLI_REFRESH_LOG: Flushes the logs, like executing the FLUSH LOGS SQL statement.
MYSQLI_REFRESH_TABLES: Flushes the table cache, like executing the FLUSH TABLES SQL statement.
MYSQLI_REFRESH_HOSTS: Flushes the host cache, like executing the FLUSH HOSTS SQL statement.
MYSQLI_REFRESH_STATUS: Reset the status variables, like executing the FLUSH STATUS SQL statement.
MYSQLI_REFRESH_THREADS: Flushes the thread cache.
MYSQLI_REFRESH_SLAVE: On a slave replication server: resets the master server information, and restarts the slave. Like executing the RESET SLAVE SQL statement.
MYSQLI_REFRESH_MASTER: On a master replication server: removes the binary log files listed in the binary log index, and truncates the index file. Like executing the RESET MASTER SQL statement.

22.9.3.7. Notes

Some implementation notes:

Support was added for MYSQL_TYPE_GEOMETRY to the MySQLi extension in PHP 5.3.
Note there are different internal implementations within libmysql and mysqlnd for handling columns of type MYSQL_TYPE_GEOMETRY. Generally speaking, mysqlnd will allocate significantly less memory. For example, if there is a POINT column in a result set, libmysql may pre-allocate up to 4GB of RAM although less than 50 bytes are needed for holding a POINT column in memory. Memory allocation is much lower, less than 50 bytes, if using mysqlnd.

22.9.3.8. The MySQLi Extension Function Summary

Table 22.40. Summary of mysqli methods

OOP Interface	Procedural Interface	Alias (Do not use)	Description
mysqli Class
Properties
$mysqli::affected_rows	mysqli_affected_rows	N/A	Gets the number of affected rows in a previous MySQL operation
$mysqli::client_info	mysqli_get_client_info	N/A	Returns the MySQL client version as a string
$mysqli::client_version	mysqli_get_client_version	N/A	Returns MySQL client version info as an integer
$mysqli::connect_errno	mysqli_connect_errno	N/A	Returns the error code from last connect call
$mysqli::connect_error	mysqli_connect_error	N/A	Returns a string description of the last connect error
$mysqli::errno	mysqli_errno	N/A	Returns the error code for the most recent function call
$mysqli::error	mysqli_error	N/A	Returns a string description of the last error
$mysqli::field_count	mysqli_field_count	N/A	Returns the number of columns for the most recent query
$mysqli::host_info	mysqli_get_host_info	N/A	Returns a string representing the type of connection used
$mysqli::protocol_version	mysqli_get_proto_info	N/A	Returns the version of the MySQL protocol used
$mysqli::server_info	mysqli_get_server_info	N/A	Returns the version of the MySQL server
$mysqli::server_version	mysqli_get_server_version	N/A	Returns the version of the MySQL server as an integer
$mysqli::info	mysqli_info	N/A	Retrieves information about the most recently executed query
$mysqli::insert_id	mysqli_insert_id	N/A	Returns the auto generated id used in the last query
$mysqli::sqlstate	mysqli_sqlstate	N/A	Returns the SQLSTATE error from previous MySQL operation
$mysqli::warning_count	mysqli_warning_count	N/A	Returns the number of warnings from the last query for the given link
Methods
mysqli::autocommit	mysqli_autocommit	N/A	Turns on or off auto-committing database modifications
mysqli::change_user	mysqli_change_user	N/A	Changes the user of the specified database connection
mysqli::character_set_name, mysqli::client_encoding	mysqli_character_set_name	mysqli_ client_ encoding	Returns the default character set for the database connection
mysqli::close	mysqli_close	N/A	Closes a previously opened database connection
mysqli::commit	mysqli_commit	N/A	Commits the current transaction
mysqli::__construct	mysqli_connect	N/A	Open a new connection to the MySQL server [Note: static (i.e. class) method]
mysqli::debug	mysqli_debug	N/A	Performs debugging operations
mysqli::dump_debug_info	mysqli_dump_debug_info	N/A	Dump debugging information into the log
mysqli::get_charset	mysqli_get_charset	N/A	Returns a character set object
mysqli::get_connection_stats	mysqli_get_connection_stats	N/A	Returns client connection statistics. Available only with mysqlnd.
mysqli::get_client_info	mysqli_get_client_info	N/A	Returns the MySQL client version as a string
mysqli::get_client_stats	mysqli_get_client_stats	N/A	Returns client per-process statistics. Available only with mysqlnd.
mysqli::get_cache_stats	mysqli_get_cache_stats	N/A	Returns client Zval cache statistics. Available only with mysqlnd.
mysqli::get_server_info	mysqli_get_server_info	N/A	NOT DOCUMENTED
mysqli::get_warnings	mysqli_get_warnings	N/A	NOT DOCUMENTED
mysqli::init	mysqli_init	N/A	Initializes MySQLi and returns a resource for use with mysqli_real_connect. [Not called on an object, as it returns a $mysqli object.]
mysqli::kill	mysqli_kill	N/A	Asks the server to kill a MySQL thread
mysqli::more_results	mysqli_more_results	N/A	Check if there are any more query results from a multi query
mysqli::multi_query	mysqli_multi_query	N/A	Performs a query on the database
mysqli::next_result	mysqli_next_result	N/A	Prepare next result from multi_query
mysqli::options	mysqli_options	mysqli_ set_ opt	Set options
mysqli::ping	mysqli_ping	N/A	Pings a server connection, or tries to reconnect if the connection has gone down
mysqli::prepare	mysqli_prepare	N/A	Prepare an SQL statement for execution
mysqli::query	mysqli_query	N/A	Performs a query on the database
mysqli::real_connect	mysqli_real_connect	N/A	Opens a connection to a mysql server
mysqli::real_escape_string, mysqli::escape_string	mysqli_real_escape_string	mysqli_ escape_ string	Escapes special characters in a string for use in an SQL statement, taking into account the current charset of the connection
mysqli::real_query	mysqli_real_query	N/A	Execute an SQL query
mysqli::refresh	mysqli_refresh	N/A	Flushes tables or caches, or resets the replication server information
mysqli::rollback	mysqli_rollback	N/A	Rolls back current transaction
mysqli::select_db	mysqli_select_db	N/A	Selects the default database for database queries
mysqli::set_charset	mysqli_set_charset	N/A	Sets the default client character set
mysqli::set_local_infile_ default	mysqli_set_local_infile_ default	N/A	Unsets user defined handler for load local infile command
mysqli::set_local_infile_ handler	mysqli_set_local_infile_ handler	N/A	Set callback function for LOAD DATA LOCAL INFILE command
mysqli::ssl_set	mysqli_ssl_set	N/A	Used for establishing secure connections using SSL
mysqli::stat	mysqli_stat	N/A	Gets the current system status
mysqli::stmt_init	mysqli_stmt_init	N/A	Initializes a statement and returns an object for use withmysqli_stmt_prepare
mysqli::store_result	mysqli_store_result	N/A	Transfers a result set from the last query
mysqli::thread_id	mysqli_thread_id	N/A	Returns the thread ID for the current connection
mysqli::thread_safe	mysqli_thread_safe	N/A	Returns whether thread safety is given or not
mysqli::use_result	mysqli_use_result	N/A	Initiate a result set retrieval

Table 22.41. Summary of mysqli_stmt methods

OOP Interface	Procedural Interface	Alias (Do not use)	Description
MySQL_STMT
Properties
$mysqli_stmt::affected_rows	mysqli_stmt_affected_rows	N/A	Returns the total number of rows changed, deleted, or inserted by the last executed statement
$mysqli_stmt::errno	mysqli_stmt_errno	N/A	Returns the error code for the most recent statement call
$mysqli_stmt::error	mysqli_stmt_error	N/A	Returns a string description for last statement error
$mysqli_stmt::field_count	mysqli_stmt_field_count	N/A	Returns the number of field in the given statement - not documented
$mysqli_stmt::insert_id	mysqli_stmt_insert_id	N/A	Get the ID generated from the previous INSERT operation
$mysqli_stmt::num_rows	mysqli_stmt_num_rows	N/A	Return the number of rows in statements result set
$mysqli_stmt::param_count	mysqli_stmt_param_count	mysqli_param_count	Returns the number of parameter for the given statement
$mysqli_stmt::sqlstate	mysqli_stmt_sqlstate	N/A	Returns SQLSTATE error from previous statement operation
Methods
mysqli_stmt::attr_get	mysqli_stmt_attr_get	N/A	Used to get the current value of a statement attribute
mysqli_stmt::attr_set	mysqli_stmt_attr_set	N/A	Used to modify the behavior of a prepared statement
mysqli_stmt::bind_param	mysqli_stmt_bind_param	mysqli_bind_param	Binds variables to a prepared statement as parameters
mysqli_stmt::bind_result	mysqli_stmt_bind_result	mysqli_bind_result	Binds variables to a prepared statement for result storage
mysqli_stmt::close	mysqli_stmt_close	N/A	Closes a prepared statement
mysqli_stmt::data_seek	mysqli_stmt_data_seek	N/A	Seeks to an arbitrary row in statement result set
mysqli_stmt::execute	mysqli_stmt_execute	mysqli_execute	Executes a prepared Query
mysqli_stmt::fetch	mysqli_stmt_fetch	mysqli_fetch	Fetch results from a prepared statement into the bound variables
mysqli_stmt::free_result	mysqli_stmt_free_result	N/A	Frees stored result memory for the given statement handle
mysqli_stmt::get_result	mysqli_stmt_get_result	N/A	Gets a result set from a prepared statement. Available only with mysqlnd.
mysqli_stmt::get_warnings	mysqli_stmt_get_warnings	N/A	NOT DOCUMENTED
$mysqli_stmt::more_results()	mysqli_stmt_more_results()	N/A	NOT DOCUMENTED Available only with mysqlnd.
$mysqli_stmt::next_result()	mysqli_stmt_next_result()	N/A	NOT DOCUMENTED Available only with mysqlnd.
mysqli_stmt::num_rows	mysqli_stmt_num_rows	N/A	See also property$mysqli_stmt::num_rows
mysqli_stmt::prepare	mysqli_stmt_prepare	N/A	Prepare an SQL statement for execution
mysqli_stmt::reset	mysqli_stmt_reset	N/A	Resets a prepared statement
mysqli_stmt::result_ metadata	mysqli_stmt_result_ metadata	mysqli_get_ metadata	Returns result set metadata from a prepared statement
mysqli_stmt::send_long_ data	mysqli_stmt_send_long_ data	mysqli_send_long_ data	Send data in blocks
mysqli_stmt::store_result	mysqli_stmt_store_result	N/A	Transfers a result set from a prepared statement

Table 22.42. Summary of mysqli_result methods

OOP Interface	Procedural Interface	Alias (Do not use)	Description
mysqli_result
Properties
$mysqli_result::current_field	mysqli_field_tell	N/A	Get current field offset of a result pointer
$mysqli_result::field_count	mysqli_num_fields	N/A	Get the number of fields in a result
$mysqli_result::lengths	mysqli_fetch_lengths	N/A	Returns the lengths of the columns of the current row in the result set
$mysqli_result::num_rows	mysqli_num_rows	N/A	Gets the number of rows in a result
Methods
mysqli_result::data_seek	mysqli_data_seek	N/A	Adjusts the result pointer to an arbitrary row in the result
mysqli_result::fetch_all	mysqli_fetch_all	N/A	Fetches all result rows and returns the result set as an associative array, a numeric array, or both. Available only with mysqlnd.
mysqli_result::fetch_array	mysqli_fetch_array	N/A	Fetch a result row as an associative, a numeric array, or both
mysqli_result::fetch_assoc	mysqli_fetch_assoc	N/A	Fetch a result row as an associative array
mysqli_result::fetch_field_direct	mysqli_fetch_field_direct	N/A	Fetch meta-data for a single field
mysqli_result::fetch_field	mysqli_fetch_field	N/A	Returns the next field in the result set
mysqli_result::fetch_fields	mysqli_fetch_fields	N/A	Returns an array of objects representing the fields in a result set
mysqli_result::fetch_object	mysqli_fetch_object	N/A	Returns the current row of a result set as an object
mysqli_result::fetch_row	mysqli_fetch_row	N/A	Get a result row as an enumerated array
mysqli_result::field_seek	mysqli_field_seek	N/A	Set result pointer to a specified field offset
mysqli_result::free, mysqli_result::close,mysqli_result::free_result	mysqli_free_result	N/A	Frees the memory associated with a result

Table 22.43. Summary of mysqli_driver methods

OOP Interface	Procedural Interface	Alias (Do not use)	Description
MySQL_Driver
Properties
N/A
Methods
mysqli_driver::embedded_server_end	mysqli_embedded_server_end	N/A	NOT DOCUMENTED
mysqli_driver::embedded_server_start	mysqli_embedded_server_start	N/A	NOT DOCUMENTED

Note

Alias functions are provided for backward compatibility purposes only. Do not use them in new projects.

22.9.3.9. The mysqli class (mysqli)

Represents a connection between PHP and a MySQL database.

 mysqli {
 mysqliProperties  int mysqli->affected_rows ;
  string mysqli->client_info ;
  int mysqli->client_version ;
  string mysqli->connect_errno ;
  string mysqli->connect_error ;
  int mysqli->errno ;
  array mysqli->error_list ;
  string mysqli->error ;
  int mysqli->field_count ;
  int mysqli->client_version ;
  string mysqli->host_info ;
  string mysqli->protocol_version ;
  string mysqli->server_info ;
  int mysqli->server_version ;
  string mysqli->info ;
  mixed mysqli->insert_id ;
  string mysqli->sqlstate ;
  int mysqli->thread_id ;
  int mysqli->warning_count ;
Methods  mysqli::__construct(string host= =ini_get("mysqli.default_host"),
  string username= =ini_get("mysqli.default_user"),
  string passwd= =ini_get("mysqli.default_pw"),
  string dbname= ="",
  int port= =ini_get("mysqli.default_port"),
  string socket= =ini_get("mysqli.default_socket"));
  bool mysqli::autocommit(bool mode);
  bool mysqli::change_user(string user,
   string password,
   string database);
  string mysqli::character_set_name();
  bool mysqli::close();
  bool mysqli::commit();
  bool mysqli::debug(string message);
  bool mysqli::dump_debug_info();
  object mysqli::get_charset();
  string mysqli::get_client_info();
  bool mysqli::get_connection_stats();
  mysqli_warning mysqli::get_warnings();
  mysqli mysqli::init();
  bool mysqli::kill(int processid);
  bool mysqli::more_results();
  bool mysqli::multi_query(string query);
  bool mysqli::next_result();
  bool mysqli::options(int option,
   mixed value);
  bool mysqli::ping();
  public int mysqli::poll(array read,
  array error,
  array reject,
  int sec,
  int usec);
  mysqli_stmt mysqli::prepare(string query);
  mixed mysqli::query(string query,
  int resultmode= =MYSQLI_STORE_RESULT);
  bool mysqli::real_connect(string host,
 string username,
 string passwd,
 string dbname,
 int port,
 string socket,
 int flags);
  string mysqli::escape_string(string escapestr);
  bool mysqli::real_query(string query);
  public mysqli_result mysqli::reap_async_query();
  public bool mysqli::refresh(int options);
  bool mysqli::rollback();
  int mysqli::rpl_query_type(string query);
  bool mysqli::select_db(string dbname);
  bool mysqli::send_query(string query);
  bool mysqli::set_charset(string charset);
  bool mysqli::set_local_infile_handler(mysqli link,
 callable read_func);
  bool mysqli::ssl_set(string key,
   string cert,
   string ca,
   string capath,
   string cipher);
  string mysqli::stat();
  mysqli_stmt mysqli::stmt_init();
  mysqli_result mysqli::store_result();
  mysqli_result mysqli::use_result();
}

22.9.3.9.1. mysqli::$affected_rows,mysqli_affected_rows

mysqli::$affected_rows
mysqli_affected_rows
Gets the number of affected rows in a previous MySQL operation

Description

Object oriented style

int mysqli->affected_rows ;

Procedural style

int mysqli_affected_rows(mysqli link);

Returns the number of rows affected by the last INSERT, UPDATE, REPLACE or DELETE query.

For SELECT statements mysqli_affected_rows works like mysqli_num_rows.

Parameters

link: Procedural style only: A link identifier returned by mysqli_connect or mysqli_init

Return Values

An integer greater than zero indicates the number of rows affected or retrieved. Zero indicates that no records where updated for an UPDATE statement, no rows matched the WHERE clause in the query or that no query has yet been executed. -1 indicates that the query returned an error.

Note

If the number of affected rows is greater than maximal int value, the number of affected rows will be returned as a string.

Examples

Example 22.106. $mysqli->affected_rows example

Object oriented style

<?php$mysqli = new mysqli("localhost", "my_user", "my_password", "world");/* check connection */if (mysqli_connect_errno()) { printf("Connect failed: %s\n", mysqli_connect_error()); exit();}/* Insert rows */$mysqli->query("CREATE TABLE Language SELECT * from CountryLanguage");printf("Affected rows (INSERT): %d\n", $mysqli->affected_rows);$mysqli->query("ALTER TABLE Language ADD Status int default 0");/* update rows */$mysqli->query("UPDATE Language SET Status=1 WHERE Percentage > 50");printf("Affected rows (UPDATE): %d\n", $mysqli->affected_rows);/* delete rows */$mysqli->query("DELETE FROM Language WHERE Percentage < 50");printf("Affected rows (DELETE): %d\n", $mysqli->affected_rows);/* select all rows */$result = $mysqli->query("SELECT CountryCode FROM Language");printf("Affected rows (SELECT): %d\n", $mysqli->affected_rows);$result->close();/* Delete table Language */$mysqli->query("DROP TABLE Language");/* close connection */$mysqli->close();?>

Procedural style

<?php$link = mysqli_connect("localhost", "my_user", "my_password", "world");if (!$link) { printf("Can't connect to localhost. Error: %s\n", mysqli_connect_error()); exit();}/* Insert rows */mysqli_query($link, "CREATE TABLE Language SELECT * from CountryLanguage");printf("Affected rows (INSERT): %d\n", mysqli_affected_rows($link));mysqli_query($link, "ALTER TABLE Language ADD Status int default 0");/* update rows */mysqli_query($link, "UPDATE Language SET Status=1 WHERE Percentage > 50");printf("Affected rows (UPDATE): %d\n", mysqli_affected_rows($link));/* delete rows */mysqli_query($link, "DELETE FROM Language WHERE Percentage < 50");printf("Affected rows (DELETE): %d\n", mysqli_affected_rows($link));/* select all rows */$result = mysqli_query($link, "SELECT CountryCode FROM Language");printf("Affected rows (SELECT): %d\n", mysqli_affected_rows($link));mysqli_free_result($result);/* Delete table Language */mysqli_query($link, "DROP TABLE Language");/* close connection */mysqli_close($link);?>

The above examples will output:

Affected rows (INSERT): 984Affected rows (UPDATE): 168Affected rows (DELETE): 815Affected rows (SELECT): 169

See Also

mysqli_num_rows

mysqli_info

22.9.3.9.2. mysqli::autocommit,mysqli_autocommit

mysqli::autocommit
mysqli_autocommit
Turns on or off auto-committing database modifications

Description

Object oriented style

bool mysqli::autocommit(bool mode);

Procedural style

bool mysqli_autocommit(mysqli link,
bool mode);

Turns on or off auto-commit mode on queries for the database connection.

To determine the current state of autocommit use the SQL command SELECT @@autocommit.

Parameters

link: Procedural style only: A link identifier returned by mysqli_connect or mysqli_init
mode: Whether to turn on auto-commit or not.

Return Values

Returns TRUE on success or FALSE on failure.

Notes

Note

This function doesn't work with non transactional table types (like MyISAM or ISAM).

Examples

Example 22.107. mysqli::autocommitexample

Object oriented style

<?php$mysqli = new mysqli("localhost", "my_user", "my_password", "world");if (mysqli_connect_errno()) { printf("Connect failed: %s\n", mysqli_connect_error()); exit();}/* turn autocommit on */$mysqli->autocommit(TRUE);if ($result = $mysqli->query("SELECT @@autocommit")) { $row = $result->fetch_row(); printf("Autocommit is %s\n", $row[0]); $result->free();}/* close connection */$mysqli->close();?>

Procedural style

<?php$link = mysqli_connect("localhost", "my_user", "my_password", "world");if (!$link) { printf("Can't connect to localhost. Error: %s\n", mysqli_connect_error()); exit();}/* turn autocommit on */mysqli_autocommit($link, TRUE);if ($result = mysqli_query($link, "SELECT @@autocommit")) { $row = mysqli_fetch_row($result); printf("Autocommit is %s\n", $row[0]); mysqli_free_result($result);}/* close connection */mysqli_close($link);?>

The above examples will output:

Autocommit is 1

See Also

mysqli_commit

mysqli_rollback

22.9.3.9.3. mysqli::change_user,mysqli_change_user

mysqli::change_user
mysqli_change_user
Changes the user of the specified database connection

Description

Object oriented style

bool mysqli::change_user(string user,
string password,
string database);

Procedural style

bool mysqli_change_user(mysqli link,
string user,
string password,
string database);

Changes the user of the specified database connection and sets the current database.

In order to successfully change users a valid username and password parameters must be provided and that user must have sufficient permissions to access the desired database. If for any reason authorization fails, the current user authentication will remain.

Parameters

link

Procedural style only: A link identifier returned by mysqli_connect or mysqli_init

user

The MySQL user name.

password

The MySQL password.

database

The database to change to.

If desired, the NULL value may be passed resulting in only changing the user and not selecting a database. To select a database in this case use the mysqli_select_db function.

Return Values

Returns TRUE on success or FALSE on failure.

Notes

Note

Using this command will always cause the current database connection to behave as if was a completely new database connection, regardless of if the operation was completed successfully. This reset includes performing a rollback on any active transactions, closing all temporary tables, and unlocking all locked tables.

Examples

Example 22.108. mysqli::change_userexample

Object oriented style

<?php/* connect database test */$mysqli = new mysqli("localhost", "my_user", "my_password", "test");/* check connection */if (mysqli_connect_errno()) { printf("Connect failed: %s\n", mysqli_connect_error()); exit();}/* Set Variable a */$mysqli->query("SET @a:=1");/* reset all and select a new database */$mysqli->change_user("my_user", "my_password", "world");if ($result = $mysqli->query("SELECT DATABASE()")) { $row = $result->fetch_row(); printf("Default database: %s\n", $row[0]); $result->close();}if ($result = $mysqli->query("SELECT @a")) { $row = $result->fetch_row(); if ($row[0] === NULL) { printf("Value of variable a is NULL\n"); } $result->close();}/* close connection */$mysqli->close();?>

Procedural style

<?php/* connect database test */$link = mysqli_connect("localhost", "my_user", "my_password", "test");/* check connection */if (!$link) { printf("Connect failed: %s\n", mysqli_connect_error()); exit();}/* Set Variable a */mysqli_query($link, "SET @a:=1");/* reset all and select a new database */mysqli_change_user($link, "my_user", "my_password", "world");if ($result = mysqli_query($link, "SELECT DATABASE()")) { $row = mysqli_fetch_row($result); printf("Default database: %s\n", $row[0]); mysqli_free_result($result);}if ($result = mysqli_query($link, "SELECT @a")) { $row = mysqli_fetch_row($result); if ($row[0] === NULL) { printf("Value of variable a is NULL\n"); } mysqli_free_result($result);}/* close connection */mysqli_close($link);?>

The above examples will output:

Default database: worldValue of variable a is NULL

See Also

mysqli_connect

mysqli_select_db

22.9.3.9.4. mysqli::character_set_name,mysqli_character_set_name

mysqli::character_set_name
mysqli_character_set_name
Returns the default character set for the database connection

Description

Object oriented style

string mysqli::character_set_name();

Procedural style

string mysqli_character_set_name(mysqli link);

Returns the current character set for the database connection.

Parameters

link: Procedural style only: A link identifier returned by mysqli_connect or mysqli_init

Return Values

The default character set for the current connection

Examples

Example 22.109. mysqli::character_set_nameexample

Object oriented style

<?php/* Open a connection */$mysqli = new mysqli("localhost", "my_user", "my_password", "world");/* check connection */if (mysqli_connect_errno()) { printf("Connect failed: %s\n", mysqli_connect_error()); exit();}/* Print current character set */$charset = $mysqli->character_set_name();printf ("Current character set is %s\n", $charset);$mysqli->close();?>

Procedural style

<?php/* Open a connection */$link = mysqli_connect("localhost", "my_user", "my_password", "world");/* check connection */if (!$link) { printf("Connect failed: %s\n", mysqli_connect_error()); exit();}/* Print current character set */$charset = mysqli_character_set_name($link);printf ("Current character set is %s\n",$charset);/* close connection */mysqli_close($link);?>

The above examples will output:

Current character set is latin1_swedish_ci

See Also

mysqli_set_charset

mysqli_client_encoding

mysqli_real_escape_string

22.9.3.9.5. mysqli::$client_info,mysqli_get_client_info

mysqli::$client_info
mysqli_get_client_info
Get MySQL client info

Description

Object oriented style

string mysqli->client_info ;

Procedural style

string mysqli_get_client_info(mysqli link);

Returns a string that represents the MySQL client library version.

Return Values

A string that represents the MySQL client library version

Examples

Example 22.110. mysqli_get_client_info

<?php/* We don't need a connection to determine   the version of mysql client library */printf("Client library version: %s\n", mysqli_get_client_info());?>

See Also

22.9.3.9.6. mysqli::$client_version,mysqli_get_client_version

mysqli::$client_version
mysqli_get_client_version
Returns the MySQL client version as a string

Description

Object oriented style

int mysqli->client_version ;

Procedural style

int mysqli_get_client_version(mysqli link);

Returns client version number as an integer.

Return Values

A number that represents the MySQL client library version in format: main_version*10000 + minor_version *100 + sub_version. For example, 4.1.0 is returned as 40100.

This is useful to quickly determine the version of the client library to know if some capability exists.

Examples

Example 22.111. mysqli_get_client_version

<?php/* We don't need a connection to determine   the version of mysql client library */printf("Client library version: %d\n", mysqli_get_client_version());?>

See Also

22.9.3.9.7. mysqli::close, mysqli_close

mysqli::close
mysqli_close
Closes a previously opened database connection

Description

Object oriented style

bool mysqli::close();

Procedural style

bool mysqli_close(mysqli link);

Closes a previously opened database connection.

Parameters

link: Procedural style only: A link identifier returned by mysqli_connect or mysqli_init

Return Values

Returns TRUE on success or FALSE on failure.

Examples

See mysqli_connect.

See Also

mysqli::__construct

mysqli_init

mysqli_character_set_name

22.9.3.9.8. mysqli::commit, mysqli_commit

mysqli::commit
mysqli_commit
Commits the current transaction

Description

Object oriented style

bool mysqli::commit();

Procedural style

bool mysqli_commit(mysqli link);

Commits the current transaction for the database connection.

Parameters

link: Procedural style only: A link identifier returned by mysqli_connect or mysqli_init

Return Values

Returns TRUE on success or FALSE on failure.

Examples

Example 22.112. mysqli::commitexample

Object oriented style

<?php$mysqli = new mysqli("localhost", "my_user", "my_password", "world");/* check connection */if (mysqli_connect_errno()) { printf("Connect failed: %s\n", mysqli_connect_error()); exit();}$mysqli->query("CREATE TABLE Language LIKE CountryLanguage");/* set autocommit to off */$mysqli->autocommit(FALSE);/* Insert some values */$mysqli->query("INSERT INTO Language VALUES ('DEU', 'Bavarian', 'F', 11.2)");$mysqli->query("INSERT INTO Language VALUES ('DEU', 'Swabian', 'F', 9.4)");/* commit transaction */$mysqli->commit();/* drop table */$mysqli->query("DROP TABLE Language");/* close connection */$mysqli->close();?>

Procedural style

<?php$link = mysqli_connect("localhost", "my_user", "my_password", "test");/* check connection */if (!$link) { printf("Connect failed: %s\n", mysqli_connect_error()); exit();}/* set autocommit to off */mysqli_autocommit($link, FALSE);mysqli_query($link, "CREATE TABLE Language LIKE CountryLanguage");/* Insert some values */mysqli_query($link, "INSERT INTO Language VALUES ('DEU', 'Bavarian', 'F', 11.2)");mysqli_query($link, "INSERT INTO Language VALUES ('DEU', 'Swabian', 'F', 9.4)");/* commit transaction */mysqli_commit($link);/* close connection */mysqli_close($link);?>

See Also

mysqli_autocommit

mysqli_rollback

22.9.3.9.9. mysqli::$connect_errno,mysqli_connect_errno

mysqli::$connect_errno
mysqli_connect_errno
Returns the error code from last connect call

Description

Object oriented style

string mysqli->connect_errno ;

Procedural style

int mysqli_connect_errno();

Returns the last error code number from the last call to mysqli_connect.

Note

Client error message numbers are listed in the MySQL errmsg.h header file, server error message numbers are listed in mysqld_error.h. In the MySQL source distribution you can find a complete list of error messages and error numbers in the file Docs/mysqld_error.txt.

Return Values

An error code value for the last call to mysqli_connect, if it failed. zero means no error occurred.

Examples

Example 22.113. $mysqli->connect_errno example

Object oriented style

<?php$mysqli = @new mysqli('localhost', 'fake_user', 'my_password', 'my_db');if ($mysqli->connect_errno) { die('Connect Error: ' . $mysqli->connect_errno);}?>

Procedural style

<?php$link = @mysqli_connect('localhost', 'fake_user', 'my_password', 'my_db');if (!$link) { die('Connect Error: ' . mysqli_connect_errno());}?>

The above examples will output:

Connect Error: 1045

See Also

22.9.3.9.10. mysqli::$connect_error,mysqli_connect_error

mysqli::$connect_error
mysqli_connect_error
Returns a string description of the last connect error

Description

Object oriented style

string mysqli->connect_error ;

Procedural style

string mysqli_connect_error();

Returns the last error message string from the last call to mysqli_connect.

Return Values

A string that describes the error. NULL is returned if no error occurred.

Examples

Example 22.114. $mysqli->connect_error example

Object oriented style

<?php$mysqli = @new mysqli('localhost', 'fake_user', 'my_password', 'my_db');// Works as of PHP 5.2.9 and 5.3.0.if ($mysqli->connect_error) { die('Connect Error: ' . $mysqli->connect_error);}?>

Procedural style

<?php$link = @mysqli_connect('localhost', 'fake_user', 'my_password', 'my_db');if (!$link) { die('Connect Error: ' . mysqli_connect_error());}?>

The above examples will output:

Connect Error: Access denied for user 'fake_user'@'localhost' (using password: YES)

Notes

Warning

The mysqli->connect_error property only works properly as of PHP versions 5.2.9 and 5.3.0. Use the mysqli_connect_error function if compatibility with earlier PHP versions is required.

See Also

22.9.3.9.11. mysqli::__construct,mysqli_connect

mysqli::__construct
mysqli_connect
Open a new connection to the MySQL server

Description

Object oriented style

mysqli::__construct(string host= =ini_get("mysqli.default_host"),
string username= =ini_get("mysqli.default_user"),
string passwd= =ini_get("mysqli.default_pw"),
string dbname= ="",
int port= =ini_get("mysqli.default_port"),
string socket= =ini_get("mysqli.default_socket"));

Procedural style

mysqli mysqli_connect(string host= =ini_get("mysqli.default_host"),
string username= =ini_get("mysqli.default_user"),
string passwd= =ini_get("mysqli.default_pw"),
string dbname= ="",
int port= =ini_get("mysqli.default_port"),
string socket= =ini_get("mysqli.default_socket"));

Opens a connection to the MySQL Server running on.

Parameters

host

Can be either a host name or an IP address. Passing the NULL value or the string "localhost" to this parameter, the local host is assumed. When possible, pipes will be used instead of the TCP/IP protocol.

Prepending host by p: opens a persistent connection. mysqli_change_user is automatically called on connections opened from the connection pool.

username

The MySQL user name.

passwd

If not provided or NULL , the MySQL server will attempt to authenticate the user against those user records which have no password only. This allows one username to be used with different permissions (depending on if a password as provided or not).

dbname

If provided will specify the default database to be used when performing queries.

port

Specifies the port number to attempt to connect to the MySQL server.

socket

Specifies the socket or named pipe that should be used.

Note

Specifying the socket parameter will not explicitly determine the type of connection to be used when connecting to the MySQL server. How the connection is made to the MySQL database is determined by the host parameter.

Return Values

Returns an object which represents the connection to a MySQL Server.

Changelog

Version	Description
5.3.0	Added the ability of persistent connections.

Examples

Example 22.115. mysqli::__constructexample

Object oriented style

<?php$mysqli = new mysqli('localhost', 'my_user', 'my_password', 'my_db');/* * This is the "official" OO way to do it, * BUT $connect_error was broken until PHP 5.2.9 and 5.3.0. */if ($mysqli->connect_error) { die('Connect Error (' . $mysqli->connect_errno . ') ' . $mysqli->connect_error);}/* * Use this instead of $connect_error if you need to ensure * compatibility with PHP versions prior to 5.2.9 and 5.3.0. */if (mysqli_connect_error()) { die('Connect Error (' . mysqli_connect_errno() . ') ' . mysqli_connect_error());}echo 'Success... ' . $mysqli->host_info . "\n";$mysqli->close();?>

Object oriented style when extending mysqli class

<?phpclass foo_mysqli extends mysqli { public function __construct($host, $user, $pass, $db) { parent::__construct($host, $user, $pass, $db); if (mysqli_connect_error()) { die('Connect Error (' . mysqli_connect_errno() . ') ' . mysqli_connect_error()); } }}$db = new foo_mysqli('localhost', 'my_user', 'my_password', 'my_db');echo 'Success... ' . $db->host_info . "\n";$db->close();?>

Procedural style

<?php$link = mysqli_connect('localhost', 'my_user', 'my_password', 'my_db');if (!$link) { die('Connect Error (' . mysqli_connect_errno() . ') ' . mysqli_connect_error());}echo 'Success... ' . mysqli_get_host_info($link) . "\n";mysqli_close($link);?>

The above examples will output:

Success... MySQL host info: localhost via TCP/IP

Notes

Note

MySQLnd always assumes the server default charset. This charset is sent during connection hand-shake/authentication, which mysqlnd will use.

Libmysql uses the default charset set in the my.cnf or by an explicit call to mysqli_options prior to calling mysqli_real_connect, but after mysqli_init.

Note

OO syntax only: If a connection fails an object is still returned. To check if the connection failed then use either the mysqli_connect_error function or the mysqli->connect_error property as in the preceding examples.

Note

If it is necessary to set options, such as the connection timeout, mysqli_real_connect must be used instead.

Note

Calling the constructor with no parameters is the same as calling mysqli_init.

Note

Error "Can't create TCP/IP socket (10106)" usually means that the variables_order configure directive doesn't contain character E. On Windows, if the environment is not copied the SYSTEMROOT environment variable won't be available and PHP will have problems loading Winsock.

See Also

22.9.3.9.12. mysqli::debug, mysqli_debug

mysqli::debug
mysqli_debug
Performs debugging operations

Description

Object oriented style

bool mysqli::debug(string message);

Procedural style

bool mysqli_debug(string message);

Performs debugging operations using the Fred Fish debugging library.

Parameters

message: A string representing the debugging operation to perform

Return Values

Returns TRUE .

Notes

Note

To use the mysqli_debug function you must compile the MySQL client library to support debugging.

Examples

Example 22.116. Generating a Trace File

<?php/* Create a trace file in '/tmp/client.trace' on the local (client) machine: */mysqli_debug("d:t:o,/tmp/client.trace");?>

See Also

mysqli_dump_debug_info

mysqli_report

22.9.3.9.13. mysqli::dump_debug_info,mysqli_dump_debug_info

mysqli::dump_debug_info
mysqli_dump_debug_info
Dump debugging information into the log

Description

Object oriented style

bool mysqli::dump_debug_info();

Procedural style

bool mysqli_dump_debug_info(mysqli link);

This function is designed to be executed by an user with the SUPER privilege and is used to dump debugging information into the log for the MySQL Server relating to the connection.

Parameters

link: Procedural style only: A link identifier returned by mysqli_connect or mysqli_init

Return Values

Returns TRUE on success or FALSE on failure.

See Also

mysqli_debug

22.9.3.9.14. mysqli::$errno, mysqli_errno

mysqli::$errno
mysqli_errno
Returns the error code for the most recent function call

Description

Object oriented style

int mysqli->errno ;

Procedural style

int mysqli_errno(mysqli link);

Returns the last error code for the most recent MySQLi function call that can succeed or fail.

Parameters

link: Procedural style only: A link identifier returned by mysqli_connect or mysqli_init

Return Values

An error code value for the last call, if it failed. zero means no error occurred.

Examples

Example 22.117. $mysqli->errno example

Object oriented style

<?php$mysqli = new mysqli("localhost", "my_user", "my_password", "world");/* check connection */if ($mysqli->connect_errno) { printf("Connect failed: %s\n", $mysqli->connect_error); exit();}if (!$mysqli->query("SET a=1")) { printf("Errorcode: %d\n", $mysqli->errno);}/* close connection */$mysqli->close();?>

Procedural style

<?php$link = mysqli_connect("localhost", "my_user", "my_password", "world");/* check connection */if (mysqli_connect_errno()) { printf("Connect failed: %s\n", mysqli_connect_error()); exit();}if (!mysqli_query($link, "SET a=1")) { printf("Errorcode: %d\n", mysqli_errno($link));}/* close connection */mysqli_close($link);?>

The above examples will output:

Errorcode: 1193

See Also

22.9.3.9.15. mysqli::$error_list,mysqli_error_list

mysqli::$error_list
mysqli_error_list
Returns a list of errors from the last command executed

Description

Object oriented style

array mysqli->error_list ;

Procedural style

array mysqli_error_list(mysqli link);

Returns a array of errors for the most recent MySQLi function call that can succeed or fail.

Parameters

link: Procedural style only: A link identifier returned by mysqli_connect or mysqli_init

Return Values

A list of errors, each as an associative array containing the errno, error, and sqlstate.

Examples

Example 22.118. $mysqli->error_list example

Object oriented style

<?php$mysqli = new mysqli("localhost", "nobody", "");/* check connection */if (mysqli_connect_errno()) { printf("Connect failed: %s\n", mysqli_connect_error()); exit();}if (!$mysqli->query("SET a=1")) { print_r($mysqli->error_list);}/* close connection */$mysqli->close();?>

Procedural style

<?php$link = mysqli_connect("localhost", "my_user", "my_password", "world");/* check connection */if (mysqli_connect_errno()) { printf("Connect failed: %s\n", mysqli_connect_error()); exit();}if (!mysqli_query($link, "SET a=1")) { print_r(mysqli_error_list($link));}/* close connection */mysqli_close($link);?>

The above examples will output:

Array( [0] => Array ( [errno] => 1193 [sqlstate] => HY000 [error] => Unknown system variable 'a' ))

See Also

22.9.3.9.16. mysqli::$error, mysqli_error

mysqli::$error
mysqli_error
Returns a string description of the last error

Description

Object oriented style

string mysqli->error ;

Procedural style

string mysqli_error(mysqli link);

Returns the last error message for the most recent MySQLi function call that can succeed or fail.

Parameters

link: Procedural style only: A link identifier returned by mysqli_connect or mysqli_init

Return Values

A string that describes the error. An empty string if no error occurred.

Examples

Example 22.119. $mysqli->error example

Object oriented style

<?php$mysqli = new mysqli("localhost", "my_user", "my_password", "world");/* check connection */if ($mysqli->connect_errno) { printf("Connect failed: %s\n", $mysqli->connect_error); exit();}if (!$mysqli->query("SET a=1")) { printf("Errormessage: %s\n", $mysqli->error);}/* close connection */$mysqli->close();?>

Procedural style

<?php$link = mysqli_connect("localhost", "my_user", "my_password", "world");/* check connection */if (mysqli_connect_errno()) { printf("Connect failed: %s\n", mysqli_connect_error()); exit();}if (!mysqli_query($link, "SET a=1")) { printf("Errormessage: %s\n", mysqli_error($link));}/* close connection */mysqli_close($link);?>

The above examples will output:

Errormessage: Unknown system variable 'a'

See Also

22.9.3.9.17. mysqli::$field_count,mysqli_field_count

mysqli::$field_count
mysqli_field_count
Returns the number of columns for the most recent query

Description

Object oriented style

int mysqli->field_count ;

Procedural style

int mysqli_field_count(mysqli link);

Returns the number of columns for the most recent query on the connection represented by the link parameter. This function can be useful when using the mysqli_store_result function to determine if the query should have produced a non-empty result set or not without knowing the nature of the query.

Parameters

link: Procedural style only: A link identifier returned by mysqli_connect or mysqli_init

Return Values

An integer representing the number of fields in a result set.

Examples

Example 22.120. $mysqli->field_count example

Object oriented style

<?php$mysqli = new mysqli("localhost", "my_user", "my_password", "test");$mysqli->query( "DROP TABLE IF EXISTS friends");$mysqli->query( "CREATE TABLE friends (id int, name varchar(20))");$mysqli->query( "INSERT INTO friends VALUES (1,'Hartmut'), (2, 'Ulf')");$mysqli->real_query("SELECT * FROM friends");if ($mysqli->field_count) { /* this was a select/show or describe query */ $result = $mysqli->store_result(); /* process resultset */ $row = $result->fetch_row(); /* free resultset */ $result->close();}/* close connection */$mysqli->close();?>

Procedural style

<?php$link = mysqli_connect("localhost", "my_user", "my_password", "test");mysqli_query($link, "DROP TABLE IF EXISTS friends");mysqli_query($link, "CREATE TABLE friends (id int, name varchar(20))");mysqli_query($link, "INSERT INTO friends VALUES (1,'Hartmut'), (2, 'Ulf')");mysqli_real_query($link, "SELECT * FROM friends");if (mysqli_field_count($link)) { /* this was a select/show or describe query */ $result = mysqli_store_result($link); /* process resultset */ $row = mysqli_fetch_row($result); /* free resultset */ mysqli_free_result($result);}/* close connection */mysqli_close($link);?>

22.9.3.9.18. mysqli::get_charset,mysqli_get_charset

mysqli::get_charset
mysqli_get_charset
Returns a character set object

Description

Object oriented style

object mysqli::get_charset();

Procedural style

object mysqli_get_charset(mysqli link);

Returns a character set object providing several properties of the current active character set.

Parameters

link: Procedural style only: A link identifier returned by mysqli_connect or mysqli_init

Return Values

The function returns a character set object with the following properties:

charset: Character set name
collation: Collation name
dir: Directory the charset description was fetched from (?) or "" for built-in character sets
min_length: Minimum character length in bytes
max_length: Maximum character length in bytes
number: Internal character set number
state: Character set status (?)

Examples

Example 22.121. mysqli::get_charsetexample

Object oriented style

<?php  $db = mysqli_init();  $db->real_connect("localhost","root","","test");  var_dump($db->get_charset());?>

Procedural style

<?php  $db = mysqli_init();  mysqli_real_connect($db, "localhost","root","","test");  var_dump($db->get_charset());?>

The above examples will output:

object(stdClass)#2 (7) {  ["charset"]=>  string(6) "latin1"  ["collation"]=>  string(17) "latin1_swedish_ci"  ["dir"]=>  string(0) ""  ["min_length"]=>  int(1)  ["max_length"]=>  int(1)  ["number"]=>  int(8)  ["state"]=>  int(801)}

See Also

mysqli_set_charset

22.9.3.9.19. mysqli::get_client_info,mysqli_get_client_info

mysqli::get_client_info
mysqli_get_client_info
Get MySQL client info

Description

Object oriented style

string mysqli::get_client_info();

Procedural style

string mysqli_get_client_info(mysqli link);

Returns a string that represents the MySQL client library version.

Return Values

A string that represents the MySQL client library version

Examples

Example 22.122. mysqli_get_client_info

<?php/* We don't need a connection to determine   the version of mysql client library */printf("Client library version: %s\n", mysqli_get_client_info());?>

See Also

22.9.3.9.20. mysqli_get_client_stats

mysqli_get_client_stats
Returns client per-process statistics

Description

array mysqli_get_client_stats();

Returns client per-process statistics. Available only with mysqlnd.

Parameters

Return Values

Returns an array with client stats if success, FALSE otherwise.

Examples

Example 22.123. A mysqli_get_client_statsexample

<?php$link = mysqli_connect();print_r(mysqli_get_client_stats());?>

The above example will output something similar to:

Array( [bytes_sent] => 43 [bytes_received] => 80 [packets_sent] => 1 [packets_received] => 2 [protocol_overhead_in] => 8 [protocol_overhead_out] => 4 [bytes_received_ok_packet] => 11 [bytes_received_eof_packet] => 0 [bytes_received_rset_header_packet] => 0 [bytes_received_rset_field_meta_packet] => 0 [bytes_received_rset_row_packet] => 0 [bytes_received_prepare_response_packet] => 0 [bytes_received_change_user_packet] => 0 [packets_sent_command] => 0 [packets_received_ok] => 1 [packets_received_eof] => 0 [packets_received_rset_header] => 0 [packets_received_rset_field_meta] => 0 [packets_received_rset_row] => 0 [packets_received_prepare_response] => 0 [packets_received_change_user] => 0 [result_set_queries] => 0 [non_result_set_queries] => 0 [no_index_used] => 0 [bad_index_used] => 0 [slow_queries] => 0 [buffered_sets] => 0 [unbuffered_sets] => 0 [ps_buffered_sets] => 0 [ps_unbuffered_sets] => 0 [flushed_normal_sets] => 0 [flushed_ps_sets] => 0 [ps_prepared_never_executed] => 0 [ps_prepared_once_executed] => 0 [rows_fetched_from_server_normal] => 0 [rows_fetched_from_server_ps] => 0 [rows_buffered_from_client_normal] => 0 [rows_buffered_from_client_ps] => 0 [rows_fetched_from_client_normal_buffered] => 0 [rows_fetched_from_client_normal_unbuffered] => 0 [rows_fetched_from_client_ps_buffered] => 0 [rows_fetched_from_client_ps_unbuffered] => 0 [rows_fetched_from_client_ps_cursor] => 0 [rows_skipped_normal] => 0 [rows_skipped_ps] => 0 [copy_on_write_saved] => 0 [copy_on_write_performed] => 0 [command_buffer_too_small] => 0 [connect_success] => 1 [connect_failure] => 0 [connection_reused] => 0 [reconnect] => 0 [pconnect_success] => 0 [active_connections] => 1 [active_persistent_connections] => 0 [explicit_close] => 0 [implicit_close] => 0 [disconnect_close] => 0 [in_middle_of_command_close] => 0 [explicit_free_result] => 0 [implicit_free_result] => 0 [explicit_stmt_close] => 0 [implicit_stmt_close] => 0 [mem_emalloc_count] => 0 [mem_emalloc_ammount] => 0 [mem_ecalloc_count] => 0 [mem_ecalloc_ammount] => 0 [mem_erealloc_count] => 0 [mem_erealloc_ammount] => 0 [mem_efree_count] => 0 [mem_malloc_count] => 0 [mem_malloc_ammount] => 0 [mem_calloc_count] => 0 [mem_calloc_ammount] => 0 [mem_realloc_count] => 0 [mem_realloc_ammount] => 0 [mem_free_count] => 0 [proto_text_fetched_null] => 0 [proto_text_fetched_bit] => 0 [proto_text_fetched_tinyint] => 0 [proto_text_fetched_short] => 0 [proto_text_fetched_int24] => 0 [proto_text_fetched_int] => 0 [proto_text_fetched_bigint] => 0 [proto_text_fetched_decimal] => 0 [proto_text_fetched_float] => 0 [proto_text_fetched_double] => 0 [proto_text_fetched_date] => 0 [proto_text_fetched_year] => 0 [proto_text_fetched_time] => 0 [proto_text_fetched_datetime] => 0 [proto_text_fetched_timestamp] => 0 [proto_text_fetched_string] => 0 [proto_text_fetched_blob] => 0 [proto_text_fetched_enum] => 0 [proto_text_fetched_set] => 0 [proto_text_fetched_geometry] => 0 [proto_text_fetched_other] => 0 [proto_binary_fetched_null] => 0 [proto_binary_fetched_bit] => 0 [proto_binary_fetched_tinyint] => 0 [proto_binary_fetched_short] => 0 [proto_binary_fetched_int24] => 0 [proto_binary_fetched_int] => 0 [proto_binary_fetched_bigint] => 0 [proto_binary_fetched_decimal] => 0 [proto_binary_fetched_float] => 0 [proto_binary_fetched_double] => 0 [proto_binary_fetched_date] => 0 [proto_binary_fetched_year] => 0 [proto_binary_fetched_time] => 0 [proto_binary_fetched_datetime] => 0 [proto_binary_fetched_timestamp] => 0 [proto_binary_fetched_string] => 0 [proto_binary_fetched_blob] => 0 [proto_binary_fetched_enum] => 0 [proto_binary_fetched_set] => 0 [proto_binary_fetched_geometry] => 0 [proto_binary_fetched_other] => 0)

See Also

Stats description

22.9.3.9.21. mysqli_get_client_version,mysqli::$client_version

mysqli_get_client_version
mysqli::$client_version
Returns the MySQL client version as a string

Description

Object oriented style

int mysqli->client_version ;

Procedural style

int mysqli_get_client_version(mysqli link);

Returns client version number as an integer.

Return Values

A number that represents the MySQL client library version in format: main_version*10000 + minor_version *100 + sub_version. For example, 4.1.0 is returned as 40100.

This is useful to quickly determine the version of the client library to know if some capability exits.

Examples

Example 22.124. mysqli_get_client_version

<?php/* We don't need a connection to determine   the version of mysql client library */printf("Client library version: %d\n", mysqli_get_client_version());?>

See Also

22.9.3.9.22. mysqli::get_connection_stats,mysqli_get_connection_stats

mysqli::get_connection_stats
mysqli_get_connection_stats
Returns statistics about the client connection

Description

Object oriented style

bool mysqli::get_connection_stats();

Procedural style

array mysqli_get_connection_stats(mysqli link);

Returns statistics about the client connection. Available only with mysqlnd.

Parameters

link: Procedural style only: A link identifier returned by mysqli_connect or mysqli_init

Return Values

Returns an array with connection stats if success, FALSE otherwise.

Examples

Example 22.125. A mysqli_get_connection_statsexample

<?php$link = mysqli_connect();print_r(mysqli_get_connection_stats($link));?>

The above example will output something similar to:

Array( [bytes_sent] => 43 [bytes_received] => 80 [packets_sent] => 1 [packets_received] => 2 [protocol_overhead_in] => 8 [protocol_overhead_out] => 4 [bytes_received_ok_packet] => 11 [bytes_received_eof_packet] => 0 [bytes_received_rset_header_packet] => 0 [bytes_received_rset_field_meta_packet] => 0 [bytes_received_rset_row_packet] => 0 [bytes_received_prepare_response_packet] => 0 [bytes_received_change_user_packet] => 0 [packets_sent_command] => 0 [packets_received_ok] => 1 [packets_received_eof] => 0 [packets_received_rset_header] => 0 [packets_received_rset_field_meta] => 0 [packets_received_rset_row] => 0 [packets_received_prepare_response] => 0 [packets_received_change_user] => 0 [result_set_queries] => 0 [non_result_set_queries] => 0 [no_index_used] => 0 [bad_index_used] => 0 [slow_queries] => 0 [buffered_sets] => 0 [unbuffered_sets] => 0 [ps_buffered_sets] => 0 [ps_unbuffered_sets] => 0 [flushed_normal_sets] => 0 [flushed_ps_sets] => 0 [ps_prepared_never_executed] => 0 [ps_prepared_once_executed] => 0 [rows_fetched_from_server_normal] => 0 [rows_fetched_from_server_ps] => 0 [rows_buffered_from_client_normal] => 0 [rows_buffered_from_client_ps] => 0 [rows_fetched_from_client_normal_buffered] => 0 [rows_fetched_from_client_normal_unbuffered] => 0 [rows_fetched_from_client_ps_buffered] => 0 [rows_fetched_from_client_ps_unbuffered] => 0 [rows_fetched_from_client_ps_cursor] => 0 [rows_skipped_normal] => 0 [rows_skipped_ps] => 0 [copy_on_write_saved] => 0 [copy_on_write_performed] => 0 [command_buffer_too_small] => 0 [connect_success] => 1 [connect_failure] => 0 [connection_reused] => 0 [reconnect] => 0 [pconnect_success] => 0 [active_connections] => 1 [active_persistent_connections] => 0 [explicit_close] => 0 [implicit_close] => 0 [disconnect_close] => 0 [in_middle_of_command_close] => 0 [explicit_free_result] => 0 [implicit_free_result] => 0 [explicit_stmt_close] => 0 [implicit_stmt_close] => 0 [mem_emalloc_count] => 0 [mem_emalloc_ammount] => 0 [mem_ecalloc_count] => 0 [mem_ecalloc_ammount] => 0 [mem_erealloc_count] => 0 [mem_erealloc_ammount] => 0 [mem_efree_count] => 0 [mem_malloc_count] => 0 [mem_malloc_ammount] => 0 [mem_calloc_count] => 0 [mem_calloc_ammount] => 0 [mem_realloc_count] => 0 [mem_realloc_ammount] => 0 [mem_free_count] => 0 [proto_text_fetched_null] => 0 [proto_text_fetched_bit] => 0 [proto_text_fetched_tinyint] => 0 [proto_text_fetched_short] => 0 [proto_text_fetched_int24] => 0 [proto_text_fetched_int] => 0 [proto_text_fetched_bigint] => 0 [proto_text_fetched_decimal] => 0 [proto_text_fetched_float] => 0 [proto_text_fetched_double] => 0 [proto_text_fetched_date] => 0 [proto_text_fetched_year] => 0 [proto_text_fetched_time] => 0 [proto_text_fetched_datetime] => 0 [proto_text_fetched_timestamp] => 0 [proto_text_fetched_string] => 0 [proto_text_fetched_blob] => 0 [proto_text_fetched_enum] => 0 [proto_text_fetched_set] => 0 [proto_text_fetched_geometry] => 0 [proto_text_fetched_other] => 0 [proto_binary_fetched_null] => 0 [proto_binary_fetched_bit] => 0 [proto_binary_fetched_tinyint] => 0 [proto_binary_fetched_short] => 0 [proto_binary_fetched_int24] => 0 [proto_binary_fetched_int] => 0 [proto_binary_fetched_bigint] => 0 [proto_binary_fetched_decimal] => 0 [proto_binary_fetched_float] => 0 [proto_binary_fetched_double] => 0 [proto_binary_fetched_date] => 0 [proto_binary_fetched_year] => 0 [proto_binary_fetched_time] => 0 [proto_binary_fetched_datetime] => 0 [proto_binary_fetched_timestamp] => 0 [proto_binary_fetched_string] => 0 [proto_binary_fetched_blob] => 0 [proto_binary_fetched_enum] => 0 [proto_binary_fetched_set] => 0 [proto_binary_fetched_geometry] => 0 [proto_binary_fetched_other] => 0)

See Also

Stats description

22.9.3.9.23. mysqli::$host_info,mysqli_get_host_info

mysqli::$host_info
mysqli_get_host_info
Returns a string representing the type of connection used

Description

Object oriented style

string mysqli->host_info ;

Procedural style

string mysqli_get_host_info(mysqli link);

Returns a string describing the connection represented by the link parameter (including the server host name).

Parameters

link: Procedural style only: A link identifier returned by mysqli_connect or mysqli_init

Return Values

A character string representing the server hostname and the connection type.

Examples

Example 22.126. $mysqli->host_info example

Object oriented style

<?php$mysqli = new mysqli("localhost", "my_user", "my_password", "world");/* check connection */if (mysqli_connect_errno()) { printf("Connect failed: %s\n", mysqli_connect_error()); exit();}/* print host information */printf("Host info: %s\n", $mysqli->host_info);/* close connection */$mysqli->close();?>

Procedural style

<?php$link = mysqli_connect("localhost", "my_user", "my_password", "world");/* check connection */if (mysqli_connect_errno()) { printf("Connect failed: %s\n", mysqli_connect_error()); exit();}/* print host information */printf("Host info: %s\n", mysqli_get_host_info($link));/* close connection */mysqli_close($link);?>

The above examples will output:

Host info: Localhost via UNIX socket

See Also

mysqli_get_proto_info

22.9.3.9.24. mysqli::$protocol_version,mysqli_get_proto_info

mysqli::$protocol_version
mysqli_get_proto_info
Returns the version of the MySQL protocol used

Description

Object oriented style

string mysqli->protocol_version ;

Procedural style

int mysqli_get_proto_info(mysqli link);

Returns an integer representing the MySQL protocol version used by the connection represented by the link parameter.

Parameters

link: Procedural style only: A link identifier returned by mysqli_connect or mysqli_init

Return Values

Returns an integer representing the protocol version.

Examples

Example 22.127. $mysqli->protocol_version example

Object oriented style

<?php$mysqli = new mysqli("localhost", "my_user", "my_password");/* check connection */if (mysqli_connect_errno()) { printf("Connect failed: %s\n", mysqli_connect_error()); exit();}/* print protocol version */printf("Protocol version: %d\n", $mysqli->protocol_version);/* close connection */$mysqli->close();?>

Procedural style

<?php$link = mysqli_connect("localhost", "my_user", "my_password");/* check connection */if (mysqli_connect_errno()) { printf("Connect failed: %s\n", mysqli_connect_error()); exit();}/* print protocol version */printf("Protocol version: %d\n", mysqli_get_proto_info($link));/* close connection */mysqli_close($link);?>

The above examples will output:

Protocol version: 10

See Also

mysqli_get_host_info

22.9.3.9.25. mysqli::$server_info,mysqli_get_server_info

mysqli::$server_info
mysqli_get_server_info
Returns the version of the MySQL server

Description

Object oriented style

string mysqli->server_info ;

Procedural style

string mysqli_get_server_info(mysqli link);

Returns a string representing the version of the MySQL server that the MySQLi extension is connected to.

Parameters

link: Procedural style only: A link identifier returned by mysqli_connect or mysqli_init

Return Values

A character string representing the server version.

Examples

Example 22.128. $mysqli->server_info example

Object oriented style

<?php$mysqli = new mysqli("localhost", "my_user", "my_password");/* check connection */if (mysqli_connect_errno()) { printf("Connect failed: %s\n", mysqli_connect_error()); exit();}/* print server version */printf("Server version: %s\n", $mysqli->server_info);/* close connection */$mysqli->close();?>

Procedural style

<?php$link = mysqli_connect("localhost", "my_user", "my_password");/* check connection */if (mysqli_connect_errno()) { printf("Connect failed: %s\n", mysqli_connect_error()); exit();}/* print server version */printf("Server version: %s\n", mysqli_get_server_info($link));/* close connection */mysqli_close($link);?>

The above examples will output:

Server version: 4.1.2-alpha-debug

See Also

22.9.3.9.26. mysqli::$server_version,mysqli_get_server_version

mysqli::$server_version
mysqli_get_server_version
Returns the version of the MySQL server as an integer

Description

Object oriented style

int mysqli->server_version ;

Procedural style

int mysqli_get_server_version(mysqli link);

The mysqli_get_server_version function returns the version of the server connected to (represented by the link parameter) as an integer.

Parameters

link: Procedural style only: A link identifier returned by mysqli_connect or mysqli_init

Return Values

An integer representing the server version.

The form of this version number is main_version * 10000 + minor_version * 100 + sub_version (i.e. version 4.1.0 is 40100).

Examples

Example 22.129. $mysqli->server_version example

Object oriented style

<?php$mysqli = new mysqli("localhost", "my_user", "my_password");/* check connection */if (mysqli_connect_errno()) { printf("Connect failed: %s\n", mysqli_connect_error()); exit();}/* print server version */printf("Server version: %d\n", $mysqli->server_version);/* close connection */$mysqli->close();?>

Procedural style

<?php$link = mysqli_connect("localhost", "my_user", "my_password");/* check connection */if (mysqli_connect_errno()) { printf("Connect failed: %s\n", mysqli_connect_error()); exit();}/* print server version */printf("Server version: %d\n", mysqli_get_server_version($link));/* close connection */mysqli_close($link);?>

The above examples will output:

Server version: 40102

See Also

22.9.3.9.27. mysqli::get_warnings,mysqli_get_warnings

mysqli::get_warnings
mysqli_get_warnings
Get result of SHOW WARNINGS

Description

Object oriented style

mysqli_warning mysqli::get_warnings();

Procedural style

mysqli_warning mysqli_get_warnings(mysqli link);

Warning

This function iscurrently not documented; only its argument list is available.

22.9.3.9.28. mysqli::$info, mysqli_info

mysqli::$info
mysqli_info
Retrieves information about the most recently executed query

Description

Object oriented style

string mysqli->info ;

Procedural style

string mysqli_info(mysqli link);

The mysqli_info function returns a string providing information about the last query executed. The nature of this string is provided below:

Table 22.44. Possible mysqli_info return values

Query type	Example result string
INSERT INTO...SELECT...	Records: 100 Duplicates: 0 Warnings: 0
INSERT INTO...VALUES (...),(...),(...)	Records: 3 Duplicates: 0 Warnings: 0
LOAD DATA INFILE ...	Records: 1 Deleted: 0 Skipped: 0 Warnings: 0
ALTER TABLE ...	Records: 3 Duplicates: 0 Warnings: 0
UPDATE ...	Rows matched: 40 Changed: 40 Warnings: 0

Note

Queries which do not fall into one of the preceding formats are not supported. In these situations, mysqli_info will return an empty string.

Parameters

link: Procedural style only: A link identifier returned by mysqli_connect or mysqli_init

Return Values

A character string representing additional information about the most recently executed query.

Examples

Example 22.130. $mysqli->info example

Object oriented style

<?php$mysqli = new mysqli("localhost", "my_user", "my_password", "world");/* check connection */if (mysqli_connect_errno()) { printf("Connect failed: %s\n", mysqli_connect_error()); exit();}$mysqli->query("CREATE TEMPORARY TABLE t1 LIKE City");/* INSERT INTO .. SELECT */$mysqli->query("INSERT INTO t1 SELECT * FROM City ORDER BY ID LIMIT 150");printf("%s\n", $mysqli->info);/* close connection */$mysqli->close();?>

Procedural style

<?php$link = mysqli_connect("localhost", "my_user", "my_password", "world");/* check connection */if (mysqli_connect_errno()) { printf("Connect failed: %s\n", mysqli_connect_error()); exit();}mysqli_query($link, "CREATE TEMPORARY TABLE t1 LIKE City");/* INSERT INTO .. SELECT */mysqli_query($link, "INSERT INTO t1 SELECT * FROM City ORDER BY ID LIMIT 150");printf("%s\n", mysqli_info($link));/* close connection */mysqli_close($link);?>

The above examples will output:

Records: 150  Duplicates: 0  Warnings: 0

See Also

mysqli_affected_rows

mysqli_warning_count

mysqli_num_rows

22.9.3.9.29. mysqli::init, mysqli_init

mysqli::init
mysqli_init
Initializes MySQLi and returns a resource for use with mysqli_real_connect()

Description

Object oriented style

mysqli mysqli::init();

Procedural style

mysqli mysqli_init();

Allocates or initializes a MYSQL object suitable for mysqli_options and mysqli_real_connect.

Note

Any subsequent calls to any mysqli function (except mysqli_options) will fail until mysqli_real_connect was called.

Return Values

Returns an object.

Examples

See mysqli_real_connect.

See Also

22.9.3.9.30. mysqli::$insert_id,mysqli_insert_id

mysqli::$insert_id
mysqli_insert_id
Returns the auto generated id used in the last query

Description

Object oriented style

mixed mysqli->insert_id ;

Procedural style

mixed mysqli_insert_id(mysqli link);

The mysqli_insert_id function returns the ID generated by a query on a table with a column having the AUTO_INCREMENT attribute. If the last query wasn't an INSERT or UPDATE statement or if the modified table does not have a column with the AUTO_INCREMENT attribute, this function will return zero.

Note

Performing an INSERT or UPDATE statement using the LAST_INSERT_ID() function will also modify the value returned by the mysqli_insert_id function.

Parameters

link: Procedural style only: A link identifier returned by mysqli_connect or mysqli_init

Return Values

The value of the AUTO_INCREMENT field that was updated by the previous query. Returns zero if there was no previous query on the connection or if the query did not update an AUTO_INCREMENT value.

Note

If the number is greater than maximal int value, mysqli_insert_id will return a string.

Examples

Example 22.131. $mysqli->insert_id example

Object oriented style

<?php$mysqli = new mysqli("localhost", "my_user", "my_password", "world");/* check connection */if (mysqli_connect_errno()) { printf("Connect failed: %s\n", mysqli_connect_error()); exit();}$mysqli->query("CREATE TABLE myCity LIKE City");$query = "INSERT INTO myCity VALUES (NULL, 'Stuttgart', 'DEU', 'Stuttgart', 617000)";$mysqli->query($query);printf ("New Record has id %d.\n", $mysqli->insert_id);/* drop table */$mysqli->query("DROP TABLE myCity");/* close connection */$mysqli->close();?>

Procedural style

<?php$link = mysqli_connect("localhost", "my_user", "my_password", "world");/* check connection */if (mysqli_connect_errno()) { printf("Connect failed: %s\n", mysqli_connect_error()); exit();}mysqli_query($link, "CREATE TABLE myCity LIKE City");$query = "INSERT INTO myCity VALUES (NULL, 'Stuttgart', 'DEU', 'Stuttgart', 617000)";mysqli_query($link, $query);printf ("New Record has id %d.\n", mysqli_insert_id($link));/* drop table */mysqli_query($link, "DROP TABLE myCity");/* close connection */mysqli_close($link);?>

The above examples will output:

New Record has id 1.

22.9.3.9.31. mysqli::kill, mysqli_kill

mysqli::kill
mysqli_kill
Asks the server to kill a MySQL thread

Description

Object oriented style

bool mysqli::kill(int processid);

Procedural style

bool mysqli_kill(mysqli link,
int processid);

This function is used to ask the server to kill a MySQL thread specified by the processid parameter. This value must be retrieved by calling the mysqli_thread_id function.

To stop a running query you should use the SQL command KILL QUERY processid.

Parameters

link: Procedural style only: A link identifier returned by mysqli_connect or mysqli_init

Return Values

Returns TRUE on success or FALSE on failure.

Examples

Example 22.132. mysqli::killexample

Object oriented style

<?php$mysqli = new mysqli("localhost", "my_user", "my_password", "world");/* check connection */if (mysqli_connect_errno()) { printf("Connect failed: %s\n", mysqli_connect_error()); exit();}/* determine our thread id */$thread_id = $mysqli->thread_id;/* Kill connection */$mysqli->kill($thread_id);/* This should produce an error */if (!$mysqli->query("CREATE TABLE myCity LIKE City")) { printf("Error: %s\n", $mysqli->error); exit;}/* close connection */$mysqli->close();?>

Procedural style

<?php$link = mysqli_connect("localhost", "my_user", "my_password", "world");/* check connection */if (mysqli_connect_errno()) { printf("Connect failed: %s\n", mysqli_connect_error()); exit();}/* determine our thread id */$thread_id = mysqli_thread_id($link);/* Kill connection */mysqli_kill($link, $thread_id);/* This should produce an error */if (!mysqli_query($link, "CREATE TABLE myCity LIKE City")) { printf("Error: %s\n", mysqli_error($link)); exit;}/* close connection */mysqli_close($link);?>

The above examples will output:

Error: MySQL server has gone away

See Also

mysqli_thread_id

22.9.3.9.32. mysqli::more_results,mysqli_more_results

mysqli::more_results
mysqli_more_results
Check if there are any more query results from a multi query

Description

Object oriented style

bool mysqli::more_results();

Procedural style

bool mysqli_more_results(mysqli link);

Indicates if one or more result sets are available from a previous call to mysqli_multi_query.

Parameters

link: Procedural style only: A link identifier returned by mysqli_connect or mysqli_init

Return Values

Returns TRUE on success or FALSE on failure.

Examples

See mysqli_multi_query.

See Also

22.9.3.9.33. mysqli::multi_query,mysqli_multi_query

mysqli::multi_query
mysqli_multi_query
Performs a query on the database

Description

Object oriented style

bool mysqli::multi_query(string query);

Procedural style

bool mysqli_multi_query(mysqli link,
string query);

Executes one or multiple queries which are concatenated by a semicolon.

To retrieve the resultset from the first query you can use mysqli_use_result or mysqli_store_result. All subsequent query results can be processed using mysqli_more_results and mysqli_next_result.

Parameters

link

Procedural style only: A link identifier returned by mysqli_connect or mysqli_init

query

The query, as a string.

Data inside the query should be properly escaped.

Return Values

Returns FALSE if the first statement failed. To retrieve subsequent errors from other statements you have to call mysqli_next_result first.

Examples

Example 22.133. mysqli::multi_queryexample

Object oriented style

<?php$mysqli = new mysqli("localhost", "my_user", "my_password", "world");/* check connection */if (mysqli_connect_errno()) { printf("Connect failed: %s\n", mysqli_connect_error()); exit();}$query  = "SELECT CURRENT_USER();";$query .= "SELECT Name FROM City ORDER BY ID LIMIT 20, 5";/* execute multi query */if ($mysqli->multi_query($query)) { do { /* store first result set */ if ($result = $mysqli->store_result()) { while ($row = $result->fetch_row()) { printf("%s\n", $row[0]); } $result->free(); } /* print divider */ if ($mysqli->more_results()) { printf("-----------------\n"); } } while ($mysqli->next_result());}/* close connection */$mysqli->close();?>

Procedural style

<?php$link = mysqli_connect("localhost", "my_user", "my_password", "world");/* check connection */if (mysqli_connect_errno()) { printf("Connect failed: %s\n", mysqli_connect_error()); exit();}$query  = "SELECT CURRENT_USER();";$query .= "SELECT Name FROM City ORDER BY ID LIMIT 20, 5";/* execute multi query */if (mysqli_multi_query($link, $query)) { do { /* store first result set */ if ($result = mysqli_store_result($link)) { while ($row = mysqli_fetch_row($result)) { printf("%s\n", $row[0]); } mysqli_free_result($result); } /* print divider */ if (mysqli_more_results($link)) { printf("-----------------\n"); } } while (mysqli_next_result($link));}/* close connection */mysqli_close($link);?>

The above examples will output something similar to:

my_user@localhost-----------------AmersfoortMaastrichtDordrechtLeidenHaarlemmermeer

See Also

22.9.3.9.34. mysqli::next_result,mysqli_next_result

mysqli::next_result
mysqli_next_result
Prepare next result from multi_query

Description

Object oriented style

bool mysqli::next_result();

Procedural style

bool mysqli_next_result(mysqli link);

Prepares next result set from a previous call to mysqli_multi_query which can be retrieved by mysqli_store_result or mysqli_use_result.

Parameters

link: Procedural style only: A link identifier returned by mysqli_connect or mysqli_init

Return Values

Returns TRUE on success or FALSE on failure.

Examples

See mysqli_multi_query.

See Also

22.9.3.9.35. mysqli::options, mysqli_options

mysqli::options
mysqli_options
Set options

Description

Object oriented style

bool mysqli::options(int option,
mixed value);

Procedural style

bool mysqli_options(mysqli link,
int option,
mixed value);

Used to set extra connect options and affect behavior for a connection.

This function may be called multiple times to set several options.

mysqli_options should be called after mysqli_init and before mysqli_real_connect.

Parameters

link

Procedural style only: A link identifier returned by mysqli_connect or mysqli_init

option

The option that you want to set. It can be one of the following values:

Table 22.45. Valid options

Name	Description
MYSQLI_OPT_CONNECT_TIMEOUT	connection timeout in seconds (supported on Windows with TCP/IP since PHP 5.3.1)
MYSQLI_OPT_LOCAL_INFILE	enable/disable use of LOAD LOCAL INFILE
MYSQLI_INIT_COMMAND	command to execute after when connecting to MySQL server
MYSQLI_READ_DEFAULT_FILE	Read options from named option file instead of my.cnf
MYSQLI_READ_DEFAULT_GROUP	Read options from the named group from my.cnf or the file specified with MYSQL_READ_DEFAULT_FILE.
MYSQLI_SERVER_PUBLIC_KEY	RSA public key file used with the SHA-256 based authentication.

value

The value for the option.

Return Values

Returns TRUE on success or FALSE on failure.

Changelog

Version	Description
5.5.0	The MYSQLI_SERVER_PUBLIC_KEYoption was added.

Examples

See mysqli_real_connect.

Notes

Note

MySQLnd always assumes the server default charset. This charset is sent during connection hand-shake/authentication, which mysqlnd will use.

Libmysql uses the default charset set in the my.cnf or by an explicit call to mysqli_options prior to calling mysqli_real_connect, but after mysqli_init.

See Also

mysqli_init

22.9.3.9.36. mysqli::ping, mysqli_ping

mysqli::ping
mysqli_ping
Pings a server connection, or tries to reconnect if the connection has gone down

Description

Object oriented style

bool mysqli::ping();

Procedural style

bool mysqli_ping(mysqli link);

Checks whether the connection to the server is working. If it has gone down, and global option mysqli.reconnect is enabled an automatic reconnection is attempted.

This function 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.

Parameters

link: Procedural style only: A link identifier returned by mysqli_connect or mysqli_init

Return Values

Returns TRUE on success or FALSE on failure.

Examples

Example 22.134. mysqli::pingexample

Object oriented style

<?php$mysqli = new mysqli("localhost", "my_user", "my_password", "world");/* check connection */if (mysqli_connect_errno()) { printf("Connect failed: %s\n", mysqli_connect_error()); exit();}/* check if server is alive */if ($mysqli->ping()) { printf ("Our connection is ok!\n");} else { printf ("Error: %s\n", $mysqli->error);}/* close connection */$mysqli->close();?>

Procedural style

<?php$link = mysqli_connect("localhost", "my_user", "my_password", "world");/* check connection */if (mysqli_connect_errno()) { printf("Connect failed: %s\n", mysqli_connect_error()); exit();}/* check if server is alive */if (mysqli_ping($link)) { printf ("Our connection is ok!\n");} else { printf ("Error: %s\n", mysqli_error($link));}/* close connection */mysqli_close($link);?>

The above examples will output:

Our connection is ok!

22.9.3.9.37. mysqli::poll, mysqli_poll

mysqli::poll
mysqli_poll
Poll connections

Description

Object oriented style

public int mysqli::poll(array read,
array error,
array reject,
int sec,
int usec);

Procedural style

int mysqli_poll(array read,
array error,
array reject,
int sec,
int usec);

Warning

This function iscurrently not documented; only its argument list is available.

Poll connections. Available only with mysqlnd. The method can be used as static.

Parameters

read
error
reject
sec: Number of seconds to wait, must be non-negative.
usec: Number of microseconds to wait, must be non-negative.

Return Values

Returns number of ready connections upon success, FALSE otherwise.

Examples

Example 22.135. A mysqli_pollexample

<?php$link1 = mysqli_connect();$link1->query("SELECT 'test'", MYSQLI_ASYNC);$all_links = array($link1);$processed = 0;do { $links = $errors = $reject = array(); foreach ($all_links as $link) { $links[] = $errors[] = $reject[] = $link; } if (!mysqli_poll($links, $errors, $reject, 1)) { continue; } foreach ($links as $link) { if ($result = $link->reap_async_query()) { print_r($result->fetch_row()); if (is_object($result)) mysqli_free_result($result);   } else die(sprintf("MySQLi Error: %s", mysqli_error($link))); $processed++; }} while ($processed < count($all_links));?>

The above example will output:

Array( [0] => test)

See Also

mysqli_reap_async_query

22.9.3.9.38. mysqli::prepare, mysqli_prepare

mysqli::prepare
mysqli_prepare
Prepare an SQL statement for execution

Description

Object oriented style

mysqli_stmt mysqli::prepare(string query);

Procedural style

mysqli_stmt mysqli_prepare(mysqli link,
string query);

Prepares the SQL query, and returns a statement handle to be used for further operations on the statement. The query must consist of a single SQL statement.

The parameter markers must be bound to application variables using mysqli_stmt_bind_param and/or mysqli_stmt_bind_result before executing the statement or fetching rows.

Parameters

link

Procedural style only: A link identifier returned by mysqli_connect or mysqli_init

query

The query, as a string.

Note

You should not add a terminating semicolon or \g to the statement.

This parameter can include one or more parameter markers in the SQL statement by embedding question mark (?) characters at the appropriate positions.

Note

The markers are legal only in certain places in SQL statements. For example, they are allowed in the VALUES() list of an INSERT statement (to specify column values for a row), or in a comparison with a column in a WHERE clause to specify a comparison value.

However, they are not allowed for identifiers (such as table or column names), in the select list that names the columns to be returned by a SELECT statement, or to specify both operands of a binary operator such as the = equal sign. The latter restriction is necessary because it would be impossible to determine the parameter type. It's not allowed to compare marker with NULL by ? IS NULL too. In general, parameters are legal only in Data Manipulation Language (DML) statements, and not in Data Definition Language (DDL) statements.

Return Values

mysqli_prepare returns a statement object or FALSE if an error occurred.

Examples

Example 22.136. mysqli::prepareexample

Object oriented style

<?php$mysqli = new mysqli("localhost", "my_user", "my_password", "world");/* check connection */if (mysqli_connect_errno()) { printf("Connect failed: %s\n", mysqli_connect_error()); exit();}$city = "Amersfoort";/* create a prepared statement */if ($stmt = $mysqli->prepare("SELECT District FROM City WHERE Name=?")) { /* bind parameters for markers */ $stmt->bind_param("s", $city); /* execute query */ $stmt->execute(); /* bind result variables */ $stmt->bind_result($district); /* fetch value */ $stmt->fetch(); printf("%s is in district %s\n", $city, $district); /* close statement */ $stmt->close();}/* close connection */$mysqli->close();?>

Procedural style

<?php$link = mysqli_connect("localhost", "my_user", "my_password", "world");/* check connection */if (mysqli_connect_errno()) { printf("Connect failed: %s\n", mysqli_connect_error()); exit();}$city = "Amersfoort";/* create a prepared statement */if ($stmt = mysqli_prepare($link, "SELECT District FROM City WHERE Name=?")) { /* bind parameters for markers */ mysqli_stmt_bind_param($stmt, "s", $city); /* execute query */ mysqli_stmt_execute($stmt); /* bind result variables */ mysqli_stmt_bind_result($stmt, $district); /* fetch value */ mysqli_stmt_fetch($stmt); printf("%s is in district %s\n", $city, $district); /* close statement */ mysqli_stmt_close($stmt);}/* close connection */mysqli_close($link);?>

The above examples will output:

Amersfoort is in district Utrecht

See Also

mysqli_character_set_name

mysqli_stmt_close

22.9.3.9.39. mysqli::query, mysqli_query

mysqli::query
mysqli_query
Performs a query on the database

Description

Object oriented style

mixed mysqli::query(string query,
int resultmode= =MYSQLI_STORE_RESULT);

Procedural style

mixed mysqli_query(mysqli link,
string query,
int resultmode= =MYSQLI_STORE_RESULT);

Performs a query against the database.

Functionally, using this function is identical to calling mysqli_real_query followed either by mysqli_use_result or mysqli_store_result.

Note

In the case where you pass a statement to mysqli_query that is longer than max_allowed_packet of the server, the returned error codes are different depending on whether you are using MySQL Native Driver (mysqlnd) or MySQL Client Library (libmysql). The behavior is as follows:

mysqlnd on Linux returns an error code of 1153. The error message means "got a packet bigger than max_allowed_packet bytes".
mysqlnd on Windows returns an error code 2006. This error message means "server has gone away".
libmysql on all platforms returns an error code 2006. This error message means "server has gone away".

Parameters

link

Procedural style only: A link identifier returned by mysqli_connect or mysqli_init

query

The query string.

Data inside the query should be properly escaped.

resultmode

Either the constant MYSQLI_USE_RESULT or MYSQLI_STORE_RESULT depending on the desired behavior. By default, MYSQLI_STORE_RESULT is used.

If you use MYSQLI_USE_RESULT all subsequent calls will return error Commands out of sync unless you call mysqli_free_result

With MYSQLI_ASYNC (available with mysqlnd), it is possible to perform query asynchronously. mysqli_poll is then used to get results from such queries.

Return Values

Returns FALSE on failure. For successful SELECT, SHOW, DESCRIBE or EXPLAIN queries mysqli_query will return a mysqli_result object. For other successful queries mysqli_query will return TRUE .

Changelog

Version	Description
5.3.0	Added the ability of async queries.

Examples

Example 22.137. mysqli::queryexample

Object oriented style

<?php$mysqli = new mysqli("localhost", "my_user", "my_password", "world");/* check connection */if ($mysqli->connect_errno) { printf("Connect failed: %s\n", $mysqli->connect_error); exit();}/* Create table doesn't return a resultset */if ($mysqli->query("CREATE TEMPORARY TABLE myCity LIKE City") === TRUE) { printf("Table myCity successfully created.\n");}/* Select queries return a resultset */if ($result = $mysqli->query("SELECT Name FROM City LIMIT 10")) { printf("Select returned %d rows.\n", $result->num_rows); /* free result set */ $result->close();}/* If we have to retrieve large amount of data we use MYSQLI_USE_RESULT */if ($result = $mysqli->query("SELECT * FROM City", MYSQLI_USE_RESULT)) { /* Note, that we can't execute any functions which interact with the   server until result set was closed. All calls will return an   'out of sync' error */ if (!$mysqli->query("SET @a:='this will not work'")) { printf("Error: %s\n", $mysqli->error); } $result->close();}$mysqli->close();?>

Procedural style

<?php$link = mysqli_connect("localhost", "my_user", "my_password", "world");/* check connection */if (mysqli_connect_errno()) { printf("Connect failed: %s\n", mysqli_connect_error()); exit();}/* Create table doesn't return a resultset */if (mysqli_query($link, "CREATE TEMPORARY TABLE myCity LIKE City") === TRUE) { printf("Table myCity successfully created.\n");}/* Select queries return a resultset */if ($result = mysqli_query($link, "SELECT Name FROM City LIMIT 10")) { printf("Select returned %d rows.\n", mysqli_num_rows($result)); /* free result set */ mysqli_free_result($result);}/* If we have to retrieve large amount of data we use MYSQLI_USE_RESULT */if ($result = mysqli_query($link, "SELECT * FROM City", MYSQLI_USE_RESULT)) { /* Note, that we can't execute any functions which interact with the   server until result set was closed. All calls will return an   'out of sync' error */ if (!mysqli_query($link, "SET @a:='this will not work'")) { printf("Error: %s\n", mysqli_error($link)); } mysqli_free_result($result);}mysqli_close($link);?>

The above examples will output:

Table myCity successfully created.Select returned 10 rows.Error: Commands out of sync;  You can't run this command now

See Also

mysqli_real_query

mysqli_multi_query

mysqli_free_result

22.9.3.9.40. mysqli::real_connect,mysqli_real_connect

mysqli::real_connect
mysqli_real_connect
Opens a connection to a mysql server

Description

Object oriented style

bool mysqli::real_connect(string host,
string username,
string passwd,
string dbname,
int port,
string socket,
int flags);

Procedural style

bool mysqli_real_connect(mysqli link,
string host,
string username,
string passwd,
string dbname,
int port,
string socket,
int flags);

Establish a connection to a MySQL database engine.

This function differs from mysqli_connect:

mysqli_real_connect needs a valid object which has to be created by function mysqli_init.
With the mysqli_options function you can set various options for connection.
There is a flags parameter.

Parameters

link

Procedural style only: A link identifier returned by mysqli_connect or mysqli_init

host

username

The MySQL user name.

passwd

If provided or NULL , the MySQL server will attempt to authenticate the user against those user records which have no password only. This allows one username to be used with different permissions (depending on if a password as provided or not).

dbname

If provided will specify the default database to be used when performing queries.

port

Specifies the port number to attempt to connect to the MySQL server.

socket

Specifies the socket or named pipe that should be used.

Note

flags

With the parameter flags you can set different connection options:

Table 22.46. Supported flags

Name	Description
MYSQLI_CLIENT_COMPRESS	Use compression protocol
MYSQLI_CLIENT_FOUND_ROWS	return number of matched rows, not the number of affected rows
MYSQLI_CLIENT_IGNORE_SPACE	Allow spaces after function names. Makes all function names reserved words.
MYSQLI_CLIENT_INTERACTIVE	Allow interactive_timeout seconds (instead of wait_timeout seconds) ofinactivity before closing the connection
MYSQLI_CLIENT_SSL	Use SSL (encryption)

Note

For security reasons the MULTI_STATEMENT flag is not supported in PHP. If you want to execute multiple queries use the mysqli_multi_query function.

Return Values

Returns TRUE on success or FALSE on failure.

Examples

Example 22.138. mysqli::real_connectexample

Object oriented style

<?php$mysqli = mysqli_init();if (!$mysqli) { die('mysqli_init failed');}if (!$mysqli->options(MYSQLI_INIT_COMMAND, 'SET AUTOCOMMIT = 0')) { die('Setting MYSQLI_INIT_COMMAND failed');}if (!$mysqli->options(MYSQLI_OPT_CONNECT_TIMEOUT, 5)) { die('Setting MYSQLI_OPT_CONNECT_TIMEOUT failed');}if (!$mysqli->real_connect('localhost', 'my_user', 'my_password', 'my_db')) { die('Connect Error (' . mysqli_connect_errno() . ') ' . mysqli_connect_error());}echo 'Success... ' . $mysqli->host_info . "\n";$mysqli->close();?>

Object oriented style when extending mysqli class

<?phpclass foo_mysqli extends mysqli { public function __construct($host, $user, $pass, $db) { parent::init(); if (!parent::options(MYSQLI_INIT_COMMAND, 'SET AUTOCOMMIT = 0')) { die('Setting MYSQLI_INIT_COMMAND failed'); } if (!parent::options(MYSQLI_OPT_CONNECT_TIMEOUT, 5)) { die('Setting MYSQLI_OPT_CONNECT_TIMEOUT failed'); } if (!parent::real_connect($host, $user, $pass, $db)) { die('Connect Error (' . mysqli_connect_errno() . ') ' . mysqli_connect_error()); } }}$db = new foo_mysqli('localhost', 'my_user', 'my_password', 'my_db');echo 'Success... ' . $db->host_info . "\n";$db->close();?>

Procedural style

<?php$link = mysqli_init();if (!$link) { die('mysqli_init failed');}if (!mysqli_options($link, MYSQLI_INIT_COMMAND, 'SET AUTOCOMMIT = 0')) { die('Setting MYSQLI_INIT_COMMAND failed');}if (!mysqli_options($link, MYSQLI_OPT_CONNECT_TIMEOUT, 5)) { die('Setting MYSQLI_OPT_CONNECT_TIMEOUT failed');}if (!mysqli_real_connect($link, 'localhost', 'my_user', 'my_password', 'my_db')) { die('Connect Error (' . mysqli_connect_errno() . ') ' . mysqli_connect_error());}echo 'Success... ' . mysqli_get_host_info($link) . "\n";mysqli_close($link);?>

The above examples will output:

Success... MySQL host info: localhost via TCP/IP

Notes

Note

MySQLnd always assumes the server default charset. This charset is sent during connection hand-shake/authentication, which mysqlnd will use.

Libmysql uses the default charset set in the my.cnf or by an explicit call to mysqli_options prior to calling mysqli_real_connect, but after mysqli_init.

See Also

22.9.3.9.41. mysqli::real_escape_string,mysqli_real_escape_string

mysqli::real_escape_string
mysqli_real_escape_string
Escapes special characters in a string for use in an SQL statement, taking into account the current charset of the connection

Description

Object oriented style

string mysqli::escape_string(string escapestr);
string mysqli::real_escape_string(string escapestr);

Procedural style

string mysqli_real_escape_string(mysqli link,
string escapestr);

This function is used to create a legal SQL string that you can use in an SQL statement. The given string is encoded to an escaped SQL string, taking into account the current character set of the connection.

Security: the default character set

The character set must be set either at the server level, or with the API function mysqli_set_charset for it to affect mysqli_real_escape_string. See the concepts section on character sets for more information.

Parameters

link

Procedural style only: A link identifier returned by mysqli_connect or mysqli_init

escapestr

The string to be escaped.

Characters encoded are NUL (ASCII 0), \n, \r, \, ', ", and Control-Z.

Return Values

Returns an escaped string.

Examples

Example 22.139. mysqli::real_escape_stringexample

Object oriented style

<?php$mysqli = new mysqli("localhost", "my_user", "my_password", "world");/* check connection */if (mysqli_connect_errno()) { printf("Connect failed: %s\n", mysqli_connect_error()); exit();}$mysqli->query("CREATE TEMPORARY TABLE myCity LIKE City");$city = "'s Hertogenbosch";/* this query will fail, cause we didn't escape $city */if (!$mysqli->query("INSERT into myCity (Name) VALUES ('$city')")) { printf("Error: %s\n", $mysqli->sqlstate);}$city = $mysqli->real_escape_string($city);/* this query with escaped $city will work */if ($mysqli->query("INSERT into myCity (Name) VALUES ('$city')")) { printf("%d Row inserted.\n", $mysqli->affected_rows);}$mysqli->close();?>

Procedural style

<?php$link = mysqli_connect("localhost", "my_user", "my_password", "world");/* check connection */if (mysqli_connect_errno()) { printf("Connect failed: %s\n", mysqli_connect_error()); exit();}mysqli_query($link, "CREATE TEMPORARY TABLE myCity LIKE City");$city = "'s Hertogenbosch";/* this query will fail, cause we didn't escape $city */if (!mysqli_query($link, "INSERT into myCity (Name) VALUES ('$city')")) { printf("Error: %s\n", mysqli_sqlstate($link));}$city = mysqli_real_escape_string($link, $city);/* this query with escaped $city will work */if (mysqli_query($link, "INSERT into myCity (Name) VALUES ('$city')")) { printf("%d Row inserted.\n", mysqli_affected_rows($link));}mysqli_close($link);?>

The above examples will output:

Error: 420001 Row inserted.

Notes

Note

For those accustomed to using mysql_real_escape_string, note that the arguments of mysqli_real_escape_string differ from what mysql_real_escape_string expects. The link identifier comes first in mysqli_real_escape_string, whereas the string to be escaped comes first in mysql_real_escape_string.

See Also

mysqli_set_charset

22.9.3.9.42. mysqli::real_query,mysqli_real_query

mysqli::real_query
mysqli_real_query
Execute an SQL query

Description

Object oriented style

bool mysqli::real_query(string query);

Procedural style

bool mysqli_real_query(mysqli link,
string query);

Executes a single query against the database whose result can then be retrieved or stored using the mysqli_store_result or mysqli_use_result functions.

In order to determine if a given query should return a result set or not, see mysqli_field_count.

Parameters

link

Procedural style only: A link identifier returned by mysqli_connect or mysqli_init

query

The query, as a string.

Data inside the query should be properly escaped.

Return Values

Returns TRUE on success or FALSE on failure.

See Also

mysqli_store_result

mysqli_use_result

22.9.3.9.43. mysqli::reap_async_query,mysqli_reap_async_query

mysqli::reap_async_query
mysqli_reap_async_query
Get result from async query

Description

Object oriented style

public mysqli_result mysqli::reap_async_query();

Procedural style

mysqli_result mysqli_reap_async_query(mysql link);

Warning

This function iscurrently not documented; only its argument list is available.

Get result from async query. Available only with mysqlnd.

Parameters

link: Procedural style only: A link identifier returned by mysqli_connect or mysqli_init

Return Values

Returns mysqli_result in success, FALSE otherwise.

See Also

mysqli_poll

22.9.3.9.44. mysqli::refresh, mysqli_refresh

mysqli::refresh
mysqli_refresh
Refreshes

Description

Object oriented style

public bool mysqli::refresh(int options);

Procedural style

int mysqli_refresh(resource link,
int options);

Flushes tables or caches, or resets the replication server information.

Parameters

link

Procedural style only: A link identifier returned by mysqli_connect or mysqli_init

options

The options to refresh, using the MYSQLI_REFRESH_* constants as documented within the MySQLi constants documentation.

See also the official MySQL Refresh documentation.

Return Values

TRUE if the refresh was a success, otherwise FALSE

See Also

mysqli_poll

22.9.3.9.45. mysqli::rollback, mysqli_rollback

mysqli::rollback
mysqli_rollback
Rolls back current transaction

Description

Object oriented style

bool mysqli::rollback();

Procedural style

bool mysqli_rollback(mysqli link);

Rollbacks the current transaction for the database.

Parameters

link: Procedural style only: A link identifier returned by mysqli_connect or mysqli_init

Return Values

Returns TRUE on success or FALSE on failure.

Examples

Example 22.140. mysqli::rollbackexample

Object oriented style

<?php$mysqli = new mysqli("localhost", "my_user", "my_password", "world");/* check connection */if (mysqli_connect_errno()) { printf("Connect failed: %s\n", mysqli_connect_error()); exit();}/* disable autocommit */$mysqli->autocommit(FALSE);$mysqli->query("CREATE TABLE myCity LIKE City");$mysqli->query("ALTER TABLE myCity Type=InnoDB");$mysqli->query("INSERT INTO myCity SELECT * FROM City LIMIT 50");/* commit insert */$mysqli->commit();/* delete all rows */$mysqli->query("DELETE FROM myCity");if ($result = $mysqli->query("SELECT COUNT(*) FROM myCity")) { $row = $result->fetch_row(); printf("%d rows in table myCity.\n", $row[0]); /* Free result */ $result->close();}/* Rollback */$mysqli->rollback();if ($result = $mysqli->query("SELECT COUNT(*) FROM myCity")) { $row = $result->fetch_row(); printf("%d rows in table myCity (after rollback).\n", $row[0]); /* Free result */ $result->close();}/* Drop table myCity */$mysqli->query("DROP TABLE myCity");$mysqli->close();?>

Procedural style

<?php$link = mysqli_connect("localhost", "my_user", "my_password", "world");/* check connection */if (mysqli_connect_errno()) { printf("Connect failed: %s\n", mysqli_connect_error()); exit();}/* disable autocommit */mysqli_autocommit($link, FALSE);mysqli_query($link, "CREATE TABLE myCity LIKE City");mysqli_query($link, "ALTER TABLE myCity Type=InnoDB");mysqli_query($link, "INSERT INTO myCity SELECT * FROM City LIMIT 50");/* commit insert */mysqli_commit($link);/* delete all rows */mysqli_query($link, "DELETE FROM myCity");if ($result = mysqli_query($link, "SELECT COUNT(*) FROM myCity")) { $row = mysqli_fetch_row($result); printf("%d rows in table myCity.\n", $row[0]); /* Free result */ mysqli_free_result($result);}/* Rollback */mysqli_rollback($link);if ($result = mysqli_query($link, "SELECT COUNT(*) FROM myCity")) { $row = mysqli_fetch_row($result); printf("%d rows in table myCity (after rollback).\n", $row[0]); /* Free result */ mysqli_free_result($result);}/* Drop table myCity */mysqli_query($link, "DROP TABLE myCity");mysqli_close($link);?>

The above examples will output:

0 rows in table myCity.50 rows in table myCity (after rollback).

See Also

mysqli_commit

mysqli_autocommit

22.9.3.9.46. mysqli::rpl_query_type,mysqli_rpl_query_type

mysqli::rpl_query_type
mysqli_rpl_query_type
Returns RPL query type

Description

Object oriented style

int mysqli::rpl_query_type(string query);

Procedural style

int mysqli_rpl_query_type(mysqli link,
string query);

Returns MYSQLI_RPL_MASTER , MYSQLI_RPL_SLAVE or MYSQLI_RPL_ADMIN depending on a query type. INSERT, UPDATE and similar are master queries, SELECT is slave, and FLUSH, REPAIR and similar are admin.

Warning

This function iscurrently not documented; only its argument list is available.

Warning

This function has beenDEPRECATED and REMOVED as of PHP 5.3.0.

22.9.3.9.47. mysqli::select_db,mysqli_select_db

mysqli::select_db
mysqli_select_db
Selects the default database for database queries

Description

Object oriented style

bool mysqli::select_db(string dbname);

Procedural style

bool mysqli_select_db(mysqli link,
string dbname);

Selects the default database to be used when performing queries against the database connection.

Note

This function should only be used to change the default database for the connection. You can select the default database with 4th parameter in mysqli_connect.

Parameters

link: Procedural style only: A link identifier returned by mysqli_connect or mysqli_init
dbname: The database name.

Return Values

Returns TRUE on success or FALSE on failure.

Examples

Example 22.141. mysqli::select_dbexample

Object oriented style

<?php$mysqli = new mysqli("localhost", "my_user", "my_password", "test");/* check connection */if (mysqli_connect_errno()) { printf("Connect failed: %s\n", mysqli_connect_error()); exit();}/* return name of current default database */if ($result = $mysqli->query("SELECT DATABASE()")) { $row = $result->fetch_row(); printf("Default database is %s.\n", $row[0]); $result->close();}/* change db to world db */$mysqli->select_db("world");/* return name of current default database */if ($result = $mysqli->query("SELECT DATABASE()")) { $row = $result->fetch_row(); printf("Default database is %s.\n", $row[0]); $result->close();}$mysqli->close();?>

Procedural style

<?php$link = mysqli_connect("localhost", "my_user", "my_password", "test");/* check connection */if (mysqli_connect_errno()) { printf("Connect failed: %s\n", mysqli_connect_error()); exit();}/* return name of current default database */if ($result = mysqli_query($link, "SELECT DATABASE()")) { $row = mysqli_fetch_row($result); printf("Default database is %s.\n", $row[0]); mysqli_free_result($result);}/* change db to world db */mysqli_select_db($link, "world");/* return name of current default database */if ($result = mysqli_query($link, "SELECT DATABASE()")) { $row = mysqli_fetch_row($result); printf("Default database is %s.\n", $row[0]); mysqli_free_result($result);}mysqli_close($link);?>

The above examples will output:

Default database is test.Default database is world.

See Also

mysqli_connect

mysqli_character_set_name

22.9.3.9.48. mysqli::send_query,mysqli_send_query

mysqli::send_query
mysqli_send_query
Send the query and return

Description

Object oriented style

bool mysqli::send_query(string query);

Procedural style

bool mysqli_send_query(mysqli link,
string query);

Warning

This function iscurrently not documented; only its argument list is available.

Warning

This function has beenDEPRECATED and REMOVED as of PHP 5.3.0.

22.9.3.9.49. mysqli::set_charset,mysqli_set_charset

mysqli::set_charset
mysqli_set_charset
Sets the default client character set

Description

Object oriented style

bool mysqli::set_charset(string charset);

Procedural style

bool mysqli_set_charset(mysqli link,
string charset);

Sets the default character set to be used when sending data from and to the database server.

Parameters

link: Procedural style only: A link identifier returned by mysqli_connect or mysqli_init
charset: The charset to be set as default.

Return Values

Returns TRUE on success or FALSE on failure.

Notes

Note

To use this function on a Windows platform you need MySQL client library version 4.1.11 or above (for MySQL 5.0 you need 5.0.6 or above).

Note

This is the preferred way to change the charset. Using mysqli_query to set it (such as SET NAMES utf8) is not recommended. See the MySQL character set concepts section for more information.

Examples

Example 22.142. mysqli::set_charsetexample

Object oriented style

<?php$mysqli = new mysqli("localhost", "my_user", "my_password", "test");/* check connection */if (mysqli_connect_errno()) { printf("Connect failed: %s\n", mysqli_connect_error()); exit();}/* change character set to utf8 */if (!$mysqli->set_charset("utf8")) { printf("Error loading character set utf8: %s\n", $mysqli->error);} else { printf("Current character set: %s\n", $mysqli->character_set_name());}$mysqli->close();?>

Procedural style

<?php$link = mysqli_connect('localhost', 'my_user', 'my_password', 'test');/* check connection */if (mysqli_connect_errno()) { printf("Connect failed: %s\n", mysqli_connect_error()); exit();}/* change character set to utf8 */if (!mysqli_set_charset($link, "utf8")) { printf("Error loading character set utf8: %s\n", mysqli_error($link));} else { printf("Current character set: %s\n", mysqli_character_set_name($link));}mysqli_close($link);?>

The above examples will output:

Current character set: utf8

See Also

mysqli_real_escape_string

List of character sets that MySQL supports

22.9.3.9.50. mysqli::set_local_infile_default,mysqli_set_local_infile_default

mysqli::set_local_infile_default
mysqli_set_local_infile_default
Unsets user defined handler for load local infile command

Description

void mysqli_set_local_infile_default(mysqli link);

Deactivates a LOAD DATA INFILE LOCAL handler previously set with mysqli_set_local_infile_handler.

Parameters

link: Procedural style only: A link identifier returned by mysqli_connect or mysqli_init

Return Values

No value is returned.

Examples

See mysqli_set_local_infile_handler examples

See Also

mysqli_set_local_infile_handler

22.9.3.9.51. mysqli::set_local_infile_handler,mysqli_set_local_infile_handler

mysqli::set_local_infile_handler
mysqli_set_local_infile_handler
Set callback function for LOAD DATA LOCAL INFILE command

Description

Object oriented style

bool mysqli::set_local_infile_handler(mysqli link,
callable read_func);

Procedural style

bool mysqli_set_local_infile_handler(mysqli link,
callable read_func);

Set callback function for LOAD DATA LOCAL INFILE command

The callbacks task is to read input from the file specified in the LOAD DATA LOCAL INFILE and to reformat it into the format understood by LOAD DATA INFILE.

The returned data needs to match the format specified in the LOAD DATA

Parameters

link

Procedural style only: A link identifier returned by mysqli_connect or mysqli_init

read_func

A callback function or object method taking the following parameters:

stream: A PHP stream associated with the SQL commands INFILE
&buffer: A string buffer to store the rewritten input into
buflen: The maximum number of characters to be stored in the buffer
&errormsg: If an error occurs you can store an error message in here

The callback function should return the number of characters stored in the buffer or a negative value if an error occurred.

Return Values

Returns TRUE on success or FALSE on failure.

Examples

Example 22.143. mysqli::set_local_infile_handlerexample

Object oriented style

<?php  $db = mysqli_init();  $db->real_connect("localhost","root","","test");  function callme($stream, &$buffer, $buflen, &$errmsg)  { $buffer = fgets($stream); echo $buffer; // convert to upper case and replace "," delimiter with [TAB] $buffer = strtoupper(str_replace(",", "\t", $buffer)); return strlen($buffer);  }  echo "Input:\n";  $db->set_local_infile_handler("callme");  $db->query("LOAD DATA LOCAL INFILE 'input.txt' INTO TABLE t1");  $db->set_local_infile_default();  $res = $db->query("SELECT * FROM t1");  echo "\nResult:\n";  while ($row = $res->fetch_assoc()) { echo join(",", $row)."\n";  }?>

Procedural style

<?php  $db = mysqli_init();  mysqli_real_connect($db, "localhost","root","","test");  function callme($stream, &$buffer, $buflen, &$errmsg)  { $buffer = fgets($stream); echo $buffer; // convert to upper case and replace "," delimiter with [TAB] $buffer = strtoupper(str_replace(",", "\t", $buffer)); return strlen($buffer);  }  echo "Input:\n";  mysqli_set_local_infile_handler($db, "callme");  mysqli_query($db, "LOAD DATA LOCAL INFILE 'input.txt' INTO TABLE t1");  mysqli_set_local_infile_default($db);  $res = mysqli_query($db, "SELECT * FROM t1");  echo "\nResult:\n";  while ($row = mysqli_fetch_assoc($res)) { echo join(",", $row)."\n";  }?>

The above examples will output:

Input:23,foo42,barOutput:23,FOO42,BAR

See Also

mysqli_set_local_infile_default

22.9.3.9.52. mysqli::$sqlstate, mysqli_sqlstate

mysqli::$sqlstate
mysqli_sqlstate
Returns the SQLSTATE error from previous MySQL operation

Description

Object oriented style

string mysqli->sqlstate ;

Procedural style

string mysqli_sqlstate(mysqli link);

Returns a string containing the SQLSTATE error code for the last error. The error code consists of five characters. '00000' means no error. The values are specified by ANSI SQL and ODBC. For a list of possible values, see http://dev.mysql.com/doc/mysql/en/error-handling.html.

Note

Note that not all MySQL errors are yet mapped to SQLSTATE's. The value HY000 (general error) is used for unmapped errors.

Parameters

link: Procedural style only: A link identifier returned by mysqli_connect or mysqli_init

Return Values

Returns a string containing the SQLSTATE error code for the last error. The error code consists of five characters. '00000' means no error.

Examples

Example 22.144. $mysqli->sqlstate example

Object oriented style

<?php$mysqli = new mysqli("localhost", "my_user", "my_password", "world");/* check connection */if (mysqli_connect_errno()) { printf("Connect failed: %s\n", mysqli_connect_error()); exit();}/* Table City already exists, so we should get an error */if (!$mysqli->query("CREATE TABLE City (ID INT, Name VARCHAR(30))")) { printf("Error - SQLSTATE %s.\n", $mysqli->sqlstate);}$mysqli->close();?>

Procedural style

<?php$link = mysqli_connect("localhost", "my_user", "my_password", "world");/* check connection */if (mysqli_connect_errno()) { printf("Connect failed: %s\n", mysqli_connect_error()); exit();}/* Table City already exists, so we should get an error */if (!mysqli_query($link, "CREATE TABLE City (ID INT, Name VARCHAR(30))")) { printf("Error - SQLSTATE %s.\n", mysqli_sqlstate($link));}mysqli_close($link);?>

The above examples will output:

Error - SQLSTATE 42S01.

See Also

mysqli_errno

mysqli_error

22.9.3.9.53. mysqli::ssl_set, mysqli_ssl_set

mysqli::ssl_set
mysqli_ssl_set
Used for establishing secure connections using SSL

Description

Object oriented style

bool mysqli::ssl_set(string key,
string cert,
string ca,
string capath,
string cipher);

Procedural style

bool mysqli_ssl_set(mysqli link,
string key,
string cert,
string ca,
string capath,
string cipher);

Used for establishing secure connections using SSL. It must be called before mysqli_real_connect. This function does nothing unless OpenSSL support is enabled.

Note that MySQL Native Driver does not support SSL before PHP 5.3.3, so calling this function when using MySQL Native Driver will result in an error. MySQL Native Driver is enabled by default on Microsoft Windows from PHP version 5.3 onwards.

Parameters

link: Procedural style only: A link identifier returned by mysqli_connect or mysqli_init
key: The path name to the key file.
cert: The path name to the certificate file.
ca: The path name to the certificate authority file.
capath: The pathname to a directory that contains trusted SSL CA certificates in PEM format.
cipher: A list of allowable ciphers to use for SSL encryption.

Any unused SSL parameters may be given as NULL

Return Values

This function always returns TRUE value. If SSL setup is incorrect mysqli_real_connect will return an error when you attempt to connect.

See Also

mysqli_options

22.9.3.9.54. mysqli::stat, mysqli_stat

mysqli::stat
mysqli_stat
Gets the current system status

Description

Object oriented style

string mysqli::stat();

Procedural style

string mysqli_stat(mysqli link);

mysqli_stat returns a string containing information similar to that provided by the 'mysqladmin status' command. This includes uptime in seconds and the number of running threads, questions, reloads, and open tables.

Parameters

link: Procedural style only: A link identifier returned by mysqli_connect or mysqli_init

Return Values

A string describing the server status. FALSE if an error occurred.

Examples

Example 22.145. mysqli::statexample

Object oriented style

<?php$mysqli = new mysqli("localhost", "my_user", "my_password", "world");/* check connection */if (mysqli_connect_errno()) { printf("Connect failed: %s\n", mysqli_connect_error()); exit();}printf ("System status: %s\n", $mysqli->stat());$mysqli->close();?>

Procedural style

<?php$link = mysqli_connect("localhost", "my_user", "my_password", "world");/* check connection */if (mysqli_connect_errno()) { printf("Connect failed: %s\n", mysqli_connect_error()); exit();}printf("System status: %s\n", mysqli_stat($link));mysqli_close($link);?>

The above examples will output:

System status: Uptime: 272  Threads: 1  Questions: 5340  Slow queries: 0Opens: 13  Flush tables: 1  Open tables: 0  Queries per second avg: 19.632Memory in use: 8496K  Max memory used: 8560K

See Also

22.9.3.9.55. mysqli::stmt_init,mysqli_stmt_init

mysqli::stmt_init
mysqli_stmt_init
Initializes a statement and returns an object for use with mysqli_stmt_prepare

Description

Object oriented style

mysqli_stmt mysqli::stmt_init();

Procedural style

mysqli_stmt mysqli_stmt_init(mysqli link);

Allocates and initializes a statement object suitable for mysqli_stmt_prepare.

Note

Any subsequent calls to any mysqli_stmt function will fail until mysqli_stmt_prepare was called.

Parameters

link: Procedural style only: A link identifier returned by mysqli_connect or mysqli_init

Return Values

Returns an object.

See Also

mysqli_stmt_prepare

22.9.3.9.56. mysqli::store_result,mysqli_store_result

mysqli::store_result
mysqli_store_result
Transfers a result set from the last query

Description

Object oriented style

mysqli_result mysqli::store_result();

Procedural style

mysqli_result mysqli_store_result(mysqli link);

Transfers the result set from the last query on the database connection represented by the link parameter to be used with the mysqli_data_seek function.

Parameters

link: Procedural style only: A link identifier returned by mysqli_connect or mysqli_init

Return Values

Returns a buffered result object or FALSE if an error occurred.

Note

mysqli_store_result returns FALSE in case the query didn't return a result set (if the query was, for example an INSERT statement). This function also returns FALSE if the reading of the result set failed. You can check if you have got an error by checking if mysqli_error doesn't return an empty string, if mysqli_errno returns a non zero value, or if mysqli_field_count returns a non zero value. Also possible reason for this function returning FALSE after successful call to mysqli_query can be too large result set (memory for it cannot be allocated). If mysqli_field_count returns a non-zero value, the statement should have produced a non-empty result set.

Notes

Note

Although it is always good practice to free the memory used by the result of a query using the mysqli_free_result function, when transferring large result sets using the mysqli_store_result this becomes particularly important.

Examples

See mysqli_multi_query.

See Also

mysqli_real_query

mysqli_use_result

22.9.3.9.57. mysqli::$thread_id,mysqli_thread_id

mysqli::$thread_id
mysqli_thread_id
Returns the thread ID for the current connection

Description

Object oriented style

int mysqli->thread_id ;

Procedural style

int mysqli_thread_id(mysqli link);

The mysqli_thread_id function returns the thread ID for the current connection which can then be killed using the mysqli_kill function. If the connection is lost and you reconnect with mysqli_ping, the thread ID will be other. Therefore you should get the thread ID only when you need it.

Note

The thread ID is assigned on a connection-by-connection basis. Hence, if the connection is broken and then re-established a new thread ID will be assigned.

To kill a running query you can use the SQL command KILL QUERY processid.

Parameters

link: Procedural style only: A link identifier returned by mysqli_connect or mysqli_init

Return Values

Returns the Thread ID for the current connection.

Examples

Example 22.146. $mysqli->thread_id example

Object oriented style

<?php$mysqli = new mysqli("localhost", "my_user", "my_password", "world");/* check connection */if (mysqli_connect_errno()) { printf("Connect failed: %s\n", mysqli_connect_error()); exit();}/* determine our thread id */$thread_id = $mysqli->thread_id;/* Kill connection */$mysqli->kill($thread_id);/* This should produce an error */if (!$mysqli->query("CREATE TABLE myCity LIKE City")) { printf("Error: %s\n", $mysqli->error); exit;}/* close connection */$mysqli->close();?>

Procedural style

<?php$link = mysqli_connect("localhost", "my_user", "my_password", "world");/* check connection */if (mysqli_connect_errno()) { printf("Connect failed: %s\n", mysqli_connect_error()); exit();}/* determine our thread id */$thread_id = mysqli_thread_id($link);/* Kill connection */mysqli_kill($link, $thread_id);/* This should produce an error */if (!mysqli_query($link, "CREATE TABLE myCity LIKE City")) { printf("Error: %s\n", mysqli_error($link)); exit;}/* close connection */mysqli_close($link);?>

The above examples will output:

Error: MySQL server has gone away

See Also

mysqli_kill

22.9.3.9.58. mysqli::thread_safe,mysqli_thread_safe

mysqli::thread_safe
mysqli_thread_safe
Returns whether thread safety is given or not

Description

Procedural style

bool mysqli_thread_safe();

Tells whether the client library is compiled as thread-safe.

Return Values

TRUE if the client library is thread-safe, otherwise FALSE .

22.9.3.9.59. mysqli::use_result,mysqli_use_result

mysqli::use_result
mysqli_use_result
Initiate a result set retrieval

Description

Object oriented style

mysqli_result mysqli::use_result();

Procedural style

mysqli_result mysqli_use_result(mysqli link);

Used to initiate the retrieval of a result set from the last query executed using the mysqli_real_query function on the database connection.

Either this or the mysqli_store_result function must be called before the results of a query can be retrieved, and one or the other must be called to prevent the next query on that database connection from failing.

Note

The mysqli_use_result function does not transfer the entire result set from the database and hence cannot be used functions such as mysqli_data_seek to move to a particular row within the set. To use this functionality, the result set must be stored using mysqli_store_result. One should not use mysqli_use_result if a lot of processing on the client side is performed, since this will tie up the server and prevent other threads from updating any tables from which the data is being fetched.

Return Values

Returns an unbuffered result object or FALSE if an error occurred.

Examples

Example 22.147. mysqli::use_resultexample

Object oriented style

<?php$mysqli = new mysqli("localhost", "my_user", "my_password", "world");/* check connection */if (mysqli_connect_errno()) { printf("Connect failed: %s\n", mysqli_connect_error()); exit();}$query  = "SELECT CURRENT_USER();";$query .= "SELECT Name FROM City ORDER BY ID LIMIT 20, 5";/* execute multi query */if ($mysqli->multi_query($query)) { do { /* store first result set */ if ($result = $mysqli->use_result()) { while ($row = $result->fetch_row()) { printf("%s\n", $row[0]); } $result->close(); } /* print divider */ if ($mysqli->more_results()) { printf("-----------------\n"); } } while ($mysqli->next_result());}/* close connection */$mysqli->close();?>

Procedural style

<?php$link = mysqli_connect("localhost", "my_user", "my_password", "world");/* check connection */if (mysqli_connect_errno()) { printf("Connect failed: %s\n", mysqli_connect_error()); exit();}$query  = "SELECT CURRENT_USER();";$query .= "SELECT Name FROM City ORDER BY ID LIMIT 20, 5";/* execute multi query */if (mysqli_multi_query($link, $query)) { do { /* store first result set */ if ($result = mysqli_use_result($link)) { while ($row = mysqli_fetch_row($result)) { printf("%s\n", $row[0]); } mysqli_free_result($result); } /* print divider */ if (mysqli_more_results($link)) { printf("-----------------\n"); } } while (mysqli_next_result($link));}/* close connection */mysqli_close($link);?>

The above examples will output:

my_user@localhost-----------------AmersfoortMaastrichtDordrechtLeidenHaarlemmermeer

See Also

mysqli_real_query

mysqli_store_result

22.9.3.9.60. mysqli::$warning_count,mysqli_warning_count

mysqli::$warning_count
mysqli_warning_count
Returns the number of warnings from the last query for the given link

Description

Object oriented style

int mysqli->warning_count ;

Procedural style

int mysqli_warning_count(mysqli link);

Returns the number of warnings from the last query in the connection.

Note

For retrieving warning messages you can use the SQL command SHOW WARNINGS [limit row_count].

Parameters

link: Procedural style only: A link identifier returned by mysqli_connect or mysqli_init

Return Values

Number of warnings or zero if there are no warnings.

Examples

Example 22.148. $mysqli->warning_count example

Object oriented style

<?php$mysqli = new mysqli("localhost", "my_user", "my_password", "world");/* check connection */if (mysqli_connect_errno()) { printf("Connect failed: %s\n", mysqli_connect_error()); exit();}$mysqli->query("CREATE TABLE myCity LIKE City");/* a remarkable city in Wales */$query = "INSERT INTO myCity (CountryCode, Name) VALUES('GBR', 'Llanfairpwllgwyngyllgogerychwyrndrobwllllantysiliogogogoch')";$mysqli->query($query);if ($mysqli->warning_count) { if ($result = $mysqli->query("SHOW WARNINGS")) { $row = $result->fetch_row(); printf("%s (%d): %s\n", $row[0], $row[1], $row[2]); $result->close(); }}/* close connection */$mysqli->close();?>

Procedural style

<?php$link = mysqli_connect("localhost", "my_user", "my_password", "world");/* check connection */if (mysqli_connect_errno()) { printf("Connect failed: %s\n", mysqli_connect_error()); exit();}mysqli_query($link, "CREATE TABLE myCity LIKE City");/* a remarkable long city name in Wales */$query = "INSERT INTO myCity (CountryCode, Name) VALUES('GBR', 'Llanfairpwllgwyngyllgogerychwyrndrobwllllantysiliogogogoch')";mysqli_query($link, $query);if (mysqli_warning_count($link)) { if ($result = mysqli_query($link, "SHOW WARNINGS")) { $row = mysqli_fetch_row($result); printf("%s (%d): %s\n", $row[0], $row[1], $row[2]); mysqli_free_result($result); }}/* close connection */mysqli_close($link);?>

The above examples will output:

Warning (1264): Data truncated for column 'Name' at row 1

See Also

mysqli_errno

mysqli_error

mysqli_sqlstate

22.9.3.10. The mysqli_stmt class (mysqli_stmt)

Represents a prepared statement.

 mysqli_stmt {
 mysqli_stmtProperties  int mysqli_stmt->affected_rows ;
  int mysqli_stmt->errno ;
  array mysqli_stmt->error_list ;
  string mysqli_stmt->error ;
  int mysqli_stmt->field_count ;
  int mysqli_stmt->insert_id ;
  int mysqli_stmt->num_rows ;
  int mysqli_stmt->param_count ;
  string mysqli_stmt->sqlstate ;
Methods  int mysqli_stmt::attr_get(int attr);
  bool mysqli_stmt::attr_set(int attr,
 int mode);
  bool mysqli_stmt::bind_param(string types,
   mixed var1,
   mixed ...);
  bool mysqli_stmt::bind_result(mixed var1,
 mixed ...);
  bool mysqli_stmt::close();
  void mysqli_stmt::data_seek(int offset);
  bool mysqli_stmt::execute();
  bool mysqli_stmt::fetch();
  void mysqli_stmt::free_result();
  mysqli_result mysqli_stmt::get_result();
  object mysqli_stmt::get_warnings(mysqli_stmt stmt);
  mixed mysqli_stmt::prepare(string query);
  bool mysqli_stmt::reset();
  mysqli_result mysqli_stmt::result_metadata();
  bool mysqli_stmt::send_long_data(int param_nr,
   string data);
  bool mysqli_stmt::store_result();
}

22.9.3.10.1. mysqli_stmt::$affected_rows,mysqli_stmt_affected_rows

mysqli_stmt::$affected_rows
mysqli_stmt_affected_rows
Returns the total number of rows changed, deleted, or inserted by the last executed statement

Description

Object oriented style

int mysqli_stmt->affected_rows ;

Procedural style

int mysqli_stmt_affected_rows(mysqli_stmt stmt);

Returns the number of rows affected by INSERT, UPDATE, or DELETE query.

This function only works with queries which update a table. In order to get the number of rows from a SELECT query, use mysqli_stmt_num_rows instead.

Parameters

stmt: Procedural style only: A statement identifier returned by mysqli_stmt_init.

Return Values

An integer greater than zero indicates the number of rows affected or retrieved. Zero indicates that no records where updated for an UPDATE/DELETE statement, no rows matched the WHERE clause in the query or that no query has yet been executed. -1 indicates that the query has returned an error. NULL indicates an invalid argument was supplied to the function.

Note

If the number of affected rows is greater than maximal PHP int value, the number of affected rows will be returned as a string value.

Examples

Example 22.149. Object oriented style

<?php$mysqli = new mysqli("localhost", "my_user", "my_password", "world");/* check connection */if (mysqli_connect_errno()) { printf("Connect failed: %s\n", mysqli_connect_error()); exit();}/* create temp table */$mysqli->query("CREATE TEMPORARY TABLE myCountry LIKE Country");$query = "INSERT INTO myCountry SELECT * FROM Country WHERE Code LIKE ?";/* prepare statement */if ($stmt = $mysqli->prepare($query)) { /* Bind variable for placeholder */ $code = 'A%'; $stmt->bind_param("s", $code); /* execute statement */ $stmt->execute(); printf("rows inserted: %d\n", $stmt->affected_rows); /* close statement */ $stmt->close();}/* close connection */$mysqli->close();?>

Example 22.150. Procedural style

<?php$link = mysqli_connect("localhost", "my_user", "my_password", "world");/* check connection */if (mysqli_connect_errno()) { printf("Connect failed: %s\n", mysqli_connect_error()); exit();}/* create temp table */mysqli_query($link, "CREATE TEMPORARY TABLE myCountry LIKE Country");$query = "INSERT INTO myCountry SELECT * FROM Country WHERE Code LIKE ?";/* prepare statement */if ($stmt = mysqli_prepare($link, $query)) { /* Bind variable for placeholder */ $code = 'A%'; mysqli_stmt_bind_param($stmt, "s", $code); /* execute statement */ mysqli_stmt_execute($stmt); printf("rows inserted: %d\n", mysqli_stmt_affected_rows($stmt)); /* close statement */ mysqli_stmt_close($stmt);}/* close connection */mysqli_close($link);?>

The above examples will output:

rows inserted: 17

See Also

mysqli_stmt_num_rows

22.9.3.10.2. mysqli_stmt::attr_get,mysqli_stmt_attr_get

mysqli_stmt::attr_get
mysqli_stmt_attr_get
Used to get the current value of a statement attribute

Description

Object oriented style

int mysqli_stmt::attr_get(int attr);

Procedural style

int mysqli_stmt_attr_get(mysqli_stmt stmt,
int attr);

Gets the current value of a statement attribute.

Parameters

stmt: Procedural style only: A statement identifier returned by mysqli_stmt_init.
attr: The attribute that you want to get.

Return Values

Returns FALSE if the attribute is not found, otherwise returns the value of the attribute.

22.9.3.10.3. mysqli_stmt::attr_set,mysqli_stmt_attr_set

mysqli_stmt::attr_set
mysqli_stmt_attr_set
Used to modify the behavior of a prepared statement

Description

Object oriented style

bool mysqli_stmt::attr_set(int attr,
int mode);

Procedural style

bool mysqli_stmt_attr_set(mysqli_stmt stmt,
int attr,
int mode);

Used to modify the behavior of a prepared statement. This function may be called multiple times to set several attributes.

Parameters

stmt

Procedural style only: A statement identifier returned by mysqli_stmt_init.

attr

The attribute that you want to set. It can have one of the following values:

Table 22.47. Attribute values

Character	Description
MYSQLI_STMT_ATTR_UPDATE_MAX_LENGTH	If set to 1, causes mysqli_stmt_store_result to update the metadata MYSQL_FIELD->max_length value.
MYSQLI_STMT_ATTR_CURSOR_TYPE	Type of cursor to open for statement when mysqli_stmt_execute is invoked. mode can be MYSQLI_CURSOR_TYPE_NO_CURSOR (the default) or MYSQLI_CURSOR_TYPE_READ_ONLY.
MYSQLI_STMT_ATTR_PREFETCH_ROWS	Number of rows to fetch from server at a time when using a cursor. mode can be in the range from 1 to the maximum value of unsignedlong. The default is 1.

If you use the MYSQLI_STMT_ATTR_CURSOR_TYPE option with MYSQLI_CURSOR_TYPE_READ_ONLY, a cursor is opened for the statement when you invoke mysqli_stmt_execute. If there is already an open cursor from a previous mysqli_stmt_execute call, it closes the cursor before opening a new one. mysqli_stmt_reset also closes any open cursor before preparing the statement for re-execution. mysqli_stmt_free_result closes any open cursor.

If you open a cursor for a prepared statement, mysqli_stmt_store_result is unnecessary.

mode

The value to assign to the attribute.

22.9.3.10.4. mysqli_stmt::bind_param,mysqli_stmt_bind_param

mysqli_stmt::bind_param
mysqli_stmt_bind_param
Binds variables to a prepared statement as parameters

Description

Object oriented style

bool mysqli_stmt::bind_param(string types,
mixed var1,
mixed ...);

Procedural style

bool mysqli_stmt_bind_param(mysqli_stmt stmt,
string types,
mixed var1,
mixed ...);

Bind variables for the parameter markers in the SQL statement that was passed to mysqli_prepare.

Note

If data size of a variable exceeds max. allowed packet size (max_allowed_packet), you have to specify b in types and use mysqli_stmt_send_long_data to send the data in packets.

Note

Care must be taken when using mysqli_stmt_bind_param in conjunction with call_user_func_array. Note that mysqli_stmt_bind_param requires parameters to be passed by reference, whereas call_user_func_array can accept as a parameter a list of variables that can represent references or values.

Parameters

stmt

Procedural style only: A statement identifier returned by mysqli_stmt_init.

types

A string that contains one or more characters which specify the types for the corresponding bind variables:

Table 22.48. Type specification chars

Character	Description
i	corresponding variable has type integer
d	corresponding variable has type double
s	corresponding variable has type string
b	corresponding variable is a blob and will be sent in packets

var1

The number of variables and length of string types must match the parameters in the statement.

Return Values

Returns TRUE on success or FALSE on failure.

Examples

Example 22.151. Object oriented style

<?php$mysqli = new mysqli('localhost', 'my_user', 'my_password', 'world');/* check connection */if (mysqli_connect_errno()) { printf("Connect failed: %s\n", mysqli_connect_error()); exit();}$stmt = $mysqli->prepare("INSERT INTO CountryLanguage VALUES (?, ?, ?, ?)");$stmt->bind_param('sssd', $code, $language, $official, $percent);$code = 'DEU';$language = 'Bavarian';$official = "F";$percent = 11.2;/* execute prepared statement */$stmt->execute();printf("%d Row inserted.\n", $stmt->affected_rows);/* close statement and connection */$stmt->close();/* Clean up table CountryLanguage */$mysqli->query("DELETE FROM CountryLanguage WHERE Language='Bavarian'");printf("%d Row deleted.\n", $mysqli->affected_rows);/* close connection */$mysqli->close();?>

Example 22.152. Procedural style

<?php$link = mysqli_connect('localhost', 'my_user', 'my_password', 'world');/* check connection */if (!$link) { printf("Connect failed: %s\n", mysqli_connect_error()); exit();}$stmt = mysqli_prepare($link, "INSERT INTO CountryLanguage VALUES (?, ?, ?, ?)");mysqli_stmt_bind_param($stmt, 'sssd', $code, $language, $official, $percent);$code = 'DEU';$language = 'Bavarian';$official = "F";$percent = 11.2;/* execute prepared statement */mysqli_stmt_execute($stmt);printf("%d Row inserted.\n", mysqli_stmt_affected_rows($stmt));/* close statement and connection */mysqli_stmt_close($stmt);/* Clean up table CountryLanguage */mysqli_query($link, "DELETE FROM CountryLanguage WHERE Language='Bavarian'");printf("%d Row deleted.\n", mysqli_affected_rows($link));/* close connection */mysqli_close($link);?>

The above examples will output:

1 Row inserted.1 Row deleted.

See Also

mysqli_stmt_send_long_data

22.9.3.10.5. mysqli_stmt::bind_result,mysqli_stmt_bind_result

mysqli_stmt::bind_result
mysqli_stmt_bind_result
Binds variables to a prepared statement for result storage

Description

Object oriented style

bool mysqli_stmt::bind_result(mixed var1,
mixed ...);

Procedural style

bool mysqli_stmt_bind_result(mysqli_stmt stmt,
mixed var1,
mixed ...);

Binds columns in the result set to variables.

When mysqli_stmt_fetch is called to fetch data, the MySQL client/server protocol places the data for the bound columns into the specified variables var1, ....

Note

Note that all columns must be bound after mysqli_stmt_execute and prior to calling mysqli_stmt_fetch. Depending on column types bound variables can silently change to the corresponding PHP type.

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 mysqli_stmt_fetch is called.

Parameters

stmt: Procedural style only: A statement identifier returned by mysqli_stmt_init.
var1: The variable to be bound.

Return Values

Returns TRUE on success or FALSE on failure.

Examples

Example 22.153. Object oriented style

<?php$mysqli = new mysqli("localhost", "my_user", "my_password", "world");if (mysqli_connect_errno()) { printf("Connect failed: %s\n", mysqli_connect_error()); exit();}/* prepare statement */if ($stmt = $mysqli->prepare("SELECT Code, Name FROM Country ORDER BY Name LIMIT 5")) { $stmt->execute(); /* bind variables to prepared statement */ $stmt->bind_result($col1, $col2); /* fetch values */ while ($stmt->fetch()) { printf("%s %s\n", $col1, $col2); } /* close statement */ $stmt->close();}/* close connection */$mysqli->close();?>

Example 22.154. Procedural style

<?php$link = mysqli_connect("localhost", "my_user", "my_password", "world");/* check connection */if (!$link) { printf("Connect failed: %s\n", mysqli_connect_error()); exit();}/* prepare statement */if ($stmt = mysqli_prepare($link, "SELECT Code, Name FROM Country ORDER BY Name LIMIT 5")) { mysqli_stmt_execute($stmt); /* bind variables to prepared statement */ mysqli_stmt_bind_result($stmt, $col1, $col2); /* fetch values */ while (mysqli_stmt_fetch($stmt)) { printf("%s %s\n", $col1, $col2); } /* close statement */ mysqli_stmt_close($stmt);}/* close connection */mysqli_close($link);?>

The above examples will output:

AFG AfghanistanALB AlbaniaDZA AlgeriaASM American SamoaAND Andorra

See Also

22.9.3.10.6. mysqli_stmt::close,mysqli_stmt_close

mysqli_stmt::close
mysqli_stmt_close
Closes a prepared statement

Description

Object oriented style

bool mysqli_stmt::close();

Procedural style

bool mysqli_stmt_close(mysqli_stmt stmt);

Closes a prepared statement. mysqli_stmt_close also deallocates the statement handle. If the current statement has pending or unread results, this function cancels them so that the next query can be executed.

Parameters

stmt: Procedural style only: A statement identifier returned by mysqli_stmt_init.

Return Values

Returns TRUE on success or FALSE on failure.

See Also

22.9.3.10.7. mysqli_stmt::data_seek,mysqli_stmt_data_seek

mysqli_stmt::data_seek
mysqli_stmt_data_seek
Seeks to an arbitrary row in statement result set

Description

Object oriented style

void mysqli_stmt::data_seek(int offset);

Procedural style

void mysqli_stmt_data_seek(mysqli_stmt stmt,
int offset);

Seeks to an arbitrary result pointer in the statement result set.

mysqli_stmt_store_result must be called prior to mysqli_stmt_data_seek.

Parameters

stmt: Procedural style only: A statement identifier returned by mysqli_stmt_init.
offset: Must be between zero and the total number of rows minus one (0.. mysqli_stmt_num_rows - 1).

Return Values

No value is returned.

Examples

Example 22.155. Object oriented style

<?php/* Open a connection */$mysqli = new mysqli("localhost", "my_user", "my_password", "world");/* check connection */if (mysqli_connect_errno()) { printf("Connect failed: %s\n", mysqli_connect_error()); exit();}$query = "SELECT Name, CountryCode FROM City ORDER BY Name";if ($stmt = $mysqli->prepare($query)) { /* execute query */ $stmt->execute(); /* bind result variables */ $stmt->bind_result($name, $code); /* store result */ $stmt->store_result(); /* seek to row no. 400 */ $stmt->data_seek(399); /* fetch values */ $stmt->fetch(); printf ("City: %s  Countrycode: %s\n", $name, $code); /* close statement */ $stmt->close();}/* close connection */$mysqli->close();?>

Example 22.156. Procedural style

<?php/* Open a connection */$link = mysqli_connect("localhost", "my_user", "my_password", "world");/* check connection */if (mysqli_connect_errno()) { printf("Connect failed: %s\n", mysqli_connect_error()); exit();}$query = "SELECT Name, CountryCode FROM City ORDER BY Name";if ($stmt = mysqli_prepare($link, $query)) { /* execute query */ mysqli_stmt_execute($stmt); /* bind result variables */ mysqli_stmt_bind_result($stmt, $name, $code); /* store result */ mysqli_stmt_store_result($stmt); /* seek to row no. 400 */ mysqli_stmt_data_seek($stmt, 399); /* fetch values */ mysqli_stmt_fetch($stmt); printf ("City: %s  Countrycode: %s\n", $name, $code); /* close statement */ mysqli_stmt_close($stmt);}/* close connection */mysqli_close($link);?>

The above examples will output:

City: Benin City  Countrycode: NGA

See Also

22.9.3.10.8. mysqli_stmt::$errno,mysqli_stmt_errno

mysqli_stmt::$errno
mysqli_stmt_errno
Returns the error code for the most recent statement call

Description

Object oriented style

int mysqli_stmt->errno ;

Procedural style

int mysqli_stmt_errno(mysqli_stmt stmt);

Returns the error code for the most recently invoked statement function that can succeed or fail.

Parameters

stmt: Procedural style only: A statement identifier returned by mysqli_stmt_init.

Return Values

An error code value. Zero means no error occurred.

Examples

Example 22.157. Object oriented style

<?php/* Open a connection */$mysqli = new mysqli("localhost", "my_user", "my_password", "world");/* check connection */if (mysqli_connect_errno()) { printf("Connect failed: %s\n", mysqli_connect_error()); exit();}$mysqli->query("CREATE TABLE myCountry LIKE Country");$mysqli->query("INSERT INTO myCountry SELECT * FROM Country");$query = "SELECT Name, Code FROM myCountry ORDER BY Name";if ($stmt = $mysqli->prepare($query)) { /* drop table */ $mysqli->query("DROP TABLE myCountry"); /* execute query */ $stmt->execute(); printf("Error: %d.\n", $stmt->errno); /* close statement */ $stmt->close();}/* close connection */$mysqli->close();?>

Example 22.158. Procedural style

<?php/* Open a connection */$link = mysqli_connect("localhost", "my_user", "my_password", "world");/* check connection */if (mysqli_connect_errno()) { printf("Connect failed: %s\n", mysqli_connect_error()); exit();}mysqli_query($link, "CREATE TABLE myCountry LIKE Country");mysqli_query($link, "INSERT INTO myCountry SELECT * FROM Country");$query = "SELECT Name, Code FROM myCountry ORDER BY Name";if ($stmt = mysqli_prepare($link, $query)) { /* drop table */ mysqli_query($link, "DROP TABLE myCountry"); /* execute query */ mysqli_stmt_execute($stmt); printf("Error: %d.\n", mysqli_stmt_errno($stmt)); /* close statement */ mysqli_stmt_close($stmt);}/* close connection */mysqli_close($link);?>

The above examples will output:

Error: 1146.

See Also

mysqli_stmt_sqlstate

22.9.3.10.9. mysqli_stmt::$error_list,mysqli_stmt_error_list

mysqli_stmt::$error_list
mysqli_stmt_error_list
Returns a list of errors from the last statement executed

Description

Object oriented style

array mysqli_stmt->error_list ;

Procedural style

array mysqli_stmt_error_list(mysqli_stmt stmt);

Returns an array of errors for the most recently invoked statement function that can succeed or fail.

Parameters

stmt: Procedural style only: A statement identifier returned by mysqli_stmt_init.

Return Values

A list of errors, each as an associative array containing the errno, error, and sqlstate.

Examples

Example 22.159. Object oriented style

<?php/* Open a connection */$mysqli = new mysqli("localhost", "my_user", "my_password", "world");/* check connection */if (mysqli_connect_errno()) { printf("Connect failed: %s\n", mysqli_connect_error()); exit();}$mysqli->query("CREATE TABLE myCountry LIKE Country");$mysqli->query("INSERT INTO myCountry SELECT * FROM Country");$query = "SELECT Name, Code FROM myCountry ORDER BY Name";if ($stmt = $mysqli->prepare($query)) { /* drop table */ $mysqli->query("DROP TABLE myCountry"); /* execute query */ $stmt->execute(); echo "Error:\n"; print_r($stmt->error_list); /* close statement */ $stmt->close();}/* close connection */$mysqli->close();?>

Example 22.160. Procedural style

<?php/* Open a connection */$link = mysqli_connect("localhost", "my_user", "my_password", "world");/* check connection */if (mysqli_connect_errno()) { printf("Connect failed: %s\n", mysqli_connect_error()); exit();}mysqli_query($link, "CREATE TABLE myCountry LIKE Country");mysqli_query($link, "INSERT INTO myCountry SELECT * FROM Country");$query = "SELECT Name, Code FROM myCountry ORDER BY Name";if ($stmt = mysqli_prepare($link, $query)) { /* drop table */ mysqli_query($link, "DROP TABLE myCountry"); /* execute query */ mysqli_stmt_execute($stmt); echo "Error:\n"; print_r(mysql_stmt_error_list($stmt)); /* close statement */ mysqli_stmt_close($stmt);}/* close connection */mysqli_close($link);?>

The above examples will output:

Array( [0] => Array ( [errno] => 1146 [sqlstate] => 42S02 [error] => Table 'world.myCountry' doesn't exist ))

See Also

mysqli_stmt_sqlstate

22.9.3.10.10. mysqli_stmt::$error,mysqli_stmt_error

mysqli_stmt::$error
mysqli_stmt_error
Returns a string description for last statement error

Description

Object oriented style

string mysqli_stmt->error ;

Procedural style

string mysqli_stmt_error(mysqli_stmt stmt);

Returns a containing the error message for the most recently invoked statement function that can succeed or fail.

Parameters

stmt: Procedural style only: A statement identifier returned by mysqli_stmt_init.

Return Values

A string that describes the error. An empty string if no error occurred.

Examples

Example 22.161. Object oriented style

<?php/* Open a connection */$mysqli = new mysqli("localhost", "my_user", "my_password", "world");/* check connection */if (mysqli_connect_errno()) { printf("Connect failed: %s\n", mysqli_connect_error()); exit();}$mysqli->query("CREATE TABLE myCountry LIKE Country");$mysqli->query("INSERT INTO myCountry SELECT * FROM Country");$query = "SELECT Name, Code FROM myCountry ORDER BY Name";if ($stmt = $mysqli->prepare($query)) { /* drop table */ $mysqli->query("DROP TABLE myCountry"); /* execute query */ $stmt->execute(); printf("Error: %s.\n", $stmt->error); /* close statement */ $stmt->close();}/* close connection */$mysqli->close();?>

Example 22.162. Procedural style

<?php/* Open a connection */$link = mysqli_connect("localhost", "my_user", "my_password", "world");/* check connection */if (mysqli_connect_errno()) { printf("Connect failed: %s\n", mysqli_connect_error()); exit();}mysqli_query($link, "CREATE TABLE myCountry LIKE Country");mysqli_query($link, "INSERT INTO myCountry SELECT * FROM Country");$query = "SELECT Name, Code FROM myCountry ORDER BY Name";if ($stmt = mysqli_prepare($link, $query)) { /* drop table */ mysqli_query($link, "DROP TABLE myCountry"); /* execute query */ mysqli_stmt_execute($stmt); printf("Error: %s.\n", mysqli_stmt_error($stmt)); /* close statement */ mysqli_stmt_close($stmt);}/* close connection */mysqli_close($link);?>

The above examples will output:

Error: Table 'world.myCountry' doesn't exist.

See Also

mysqli_stmt_sqlstate

22.9.3.10.11. mysqli_stmt::execute,mysqli_stmt_execute

mysqli_stmt::execute
mysqli_stmt_execute
Executes a prepared Query

Description

Object oriented style

bool mysqli_stmt::execute();

Procedural style

bool mysqli_stmt_execute(mysqli_stmt stmt);

Executes a query that has been previously prepared using the mysqli_prepare function. When executed any parameter markers which exist will automatically be replaced with the appropriate data.

If the statement is UPDATE, DELETE, or INSERT, the total number of affected rows can be determined by using the mysqli_stmt_affected_rows function. Likewise, if the query yields a result set the mysqli_stmt_fetch function is used.

Note

When using mysqli_stmt_execute, the mysqli_stmt_fetch function must be used to fetch the data prior to performing any additional queries.

Parameters

stmt: Procedural style only: A statement identifier returned by mysqli_stmt_init.

Return Values

Returns TRUE on success or FALSE on failure.

Examples

Example 22.163. Object oriented style

<?php$mysqli = new mysqli("localhost", "my_user", "my_password", "world");/* check connection */if (mysqli_connect_errno()) { printf("Connect failed: %s\n", mysqli_connect_error()); exit();}$mysqli->query("CREATE TABLE myCity LIKE City");/* Prepare an insert statement */$query = "INSERT INTO myCity (Name, CountryCode, District) VALUES (?,?,?)";$stmt = $mysqli->prepare($query);$stmt->bind_param("sss", $val1, $val2, $val3);$val1 = 'Stuttgart';$val2 = 'DEU';$val3 = 'Baden-Wuerttemberg';/* Execute the statement */$stmt->execute();$val1 = 'Bordeaux';$val2 = 'FRA';$val3 = 'Aquitaine';/* Execute the statement */$stmt->execute();/* close statement */$stmt->close();/* retrieve all rows from myCity */$query = "SELECT Name, CountryCode, District FROM myCity";if ($result = $mysqli->query($query)) { while ($row = $result->fetch_row()) { printf("%s (%s,%s)\n", $row[0], $row[1], $row[2]); } /* free result set */ $result->close();}/* remove table */$mysqli->query("DROP TABLE myCity");/* close connection */$mysqli->close();?>

Example 22.164. Procedural style

<?php$link = mysqli_connect("localhost", "my_user", "my_password", "world");/* check connection */if (mysqli_connect_errno()) { printf("Connect failed: %s\n", mysqli_connect_error()); exit();}mysqli_query($link, "CREATE TABLE myCity LIKE City");/* Prepare an insert statement */$query = "INSERT INTO myCity (Name, CountryCode, District) VALUES (?,?,?)";$stmt = mysqli_prepare($link, $query);mysqli_stmt_bind_param($stmt, "sss", $val1, $val2, $val3);$val1 = 'Stuttgart';$val2 = 'DEU';$val3 = 'Baden-Wuerttemberg';/* Execute the statement */mysqli_stmt_execute($stmt);$val1 = 'Bordeaux';$val2 = 'FRA';$val3 = 'Aquitaine';/* Execute the statement */mysqli_stmt_execute($stmt);/* close statement */mysqli_stmt_close($stmt);/* retrieve all rows from myCity */$query = "SELECT Name, CountryCode, District FROM myCity";if ($result = mysqli_query($link, $query)) { while ($row = mysqli_fetch_row($result)) { printf("%s (%s,%s)\n", $row[0], $row[1], $row[2]); } /* free result set */ mysqli_free_result($result);}/* remove table */mysqli_query($link, "DROP TABLE myCity");/* close connection */mysqli_close($link);?>

The above examples will output:

Stuttgart (DEU,Baden-Wuerttemberg)Bordeaux (FRA,Aquitaine)

See Also

22.9.3.10.12. mysqli_stmt::fetch,mysqli_stmt_fetch

mysqli_stmt::fetch
mysqli_stmt_fetch
Fetch results from a prepared statement into the bound variables

Description

Object oriented style

bool mysqli_stmt::fetch();

Procedural style

bool mysqli_stmt_fetch(mysqli_stmt stmt);

Fetch the result from a prepared statement into the variables bound by mysqli_stmt_bind_result.

Note

Note that all columns must be bound by the application before calling mysqli_stmt_fetch.

Note

Data are transferred unbuffered without calling mysqli_stmt_store_result which can decrease performance (but reduces memory cost).

Parameters

stmt: Procedural style only: A statement identifier returned by mysqli_stmt_init.

Return Values

Table 22.49. Return Values

Value	Description
TRUE	Success. Data has been fetched
FALSE	Error occurred
NULL	No more rows/data exists or data truncation occurred

Examples

Example 22.165. Object oriented style

<?php$mysqli = new mysqli("localhost", "my_user", "my_password", "world");/* check connection */if (mysqli_connect_errno()) { printf("Connect failed: %s\n", mysqli_connect_error()); exit();}$query = "SELECT Name, CountryCode FROM City ORDER by ID DESC LIMIT 150,5";if ($stmt = $mysqli->prepare($query)) { /* execute statement */ $stmt->execute(); /* bind result variables */ $stmt->bind_result($name, $code); /* fetch values */ while ($stmt->fetch()) { printf ("%s (%s)\n", $name, $code); } /* close statement */ $stmt->close();}/* close connection */$mysqli->close();?>

Example 22.166. Procedural style

<?php$link = mysqli_connect("localhost", "my_user", "my_password", "world");/* check connection */if (mysqli_connect_errno()) { printf("Connect failed: %s\n", mysqli_connect_error()); exit();}$query = "SELECT Name, CountryCode FROM City ORDER by ID DESC LIMIT 150,5";if ($stmt = mysqli_prepare($link, $query)) { /* execute statement */ mysqli_stmt_execute($stmt); /* bind result variables */ mysqli_stmt_bind_result($stmt, $name, $code); /* fetch values */ while (mysqli_stmt_fetch($stmt)) { printf ("%s (%s)\n", $name, $code); } /* close statement */ mysqli_stmt_close($stmt);}/* close connection */mysqli_close($link);?>

The above examples will output:

Rockford (USA)Tallahassee (USA)Salinas (USA)Santa Clarita (USA)Springfield (USA)

See Also

22.9.3.10.13. mysqli_stmt::$field_count,mysqli_stmt_field_count

mysqli_stmt::$field_count
mysqli_stmt_field_count
Returns the number of field in the given statement

Description

Object oriented style

int mysqli_stmt->field_count ;

Procedural style

int mysqli_stmt_field_count(mysqli_stmt stmt);

Warning

This function iscurrently not documented; only its argument list is available.

22.9.3.10.14. mysqli_stmt::free_result,mysqli_stmt_free_result

mysqli_stmt::free_result
mysqli_stmt_free_result
Frees stored result memory for the given statement handle

Description

Object oriented style

void mysqli_stmt::free_result();

Procedural style

void mysqli_stmt_free_result(mysqli_stmt stmt);

Frees the result memory associated with the statement, which was allocated by mysqli_stmt_store_result.

Parameters

stmt: Procedural style only: A statement identifier returned by mysqli_stmt_init.

Return Values

No value is returned.

See Also

22.9.3.10.15. mysqli_stmt::get_result,mysqli_stmt_get_result

mysqli_stmt::get_result
mysqli_stmt_get_result
Gets a result set from a prepared statement

Description

Object oriented style

mysqli_result mysqli_stmt::get_result();

Procedural style

mysqli_result mysqli_stmt_get_result(mysqli_stmt stmt);

Call to return a result set from a prepared statement query.

Parameters

stmt: Procedural style only: A statement identifier returned by mysqli_stmt_init.

Return Values

Returns a resultset or FALSE on failure.

MySQL Native Driver Only

Available only with mysqlnd.

Examples

Example 22.167. Object oriented style

<?php $mysqli = new mysqli("127.0.0.1", "user", "password", "world"); if($mysqli->connect_error){ die("$mysqli->connect_errno: $mysqli->connect_error");}$query = "SELECT Name, Population, Continent FROM Country WHERE Continent=? ORDER BY Name LIMIT 1";$stmt = $mysqli->stmt_init();if(!$stmt->prepare($query)){ print "Failed to prepare statement\n";}else{ $stmt->bind_param("s", $continent); $continent_array = array('Europe','Africa','Asia','North America'); foreach($continent_array as $continent) { $stmt->execute(); $result = $stmt->get_result(); while ($row = $result->fetch_array(MYSQLI_NUM)) { foreach ($row as $r) { print "$r "; } print "\n"; } }}$stmt->close();$mysqli->close();?>

Example 22.168. Procedural style

<?php $link = mysqli_connect("127.0.0.1", "user", "password", "world"); if (!$link){ $error = mysqli_connect_error(); $errno = mysqli_connect_errno(); print "$errno: $error\n"; exit();}$query = "SELECT Name, Population, Continent FROM Country WHERE Continent=? ORDER BY Name LIMIT 1";$stmt = mysqli_stmt_init($link);if(!mysqli_stmt_prepare($stmt, $query)){ print "Failed to prepare statement\n";}else{ mysqli_stmt_bind_param($stmt, "s", $continent); $continent_array = array('Europe','Africa','Asia','North America'); foreach($continent_array as $continent) { mysqli_stmt_execute($stmt); $result = mysqli_stmt_get_result($stmt); while ($row = mysqli_fetch_array($result, MYSQLI_NUM)) { foreach ($row as $r) { print "$r "; } print "\n"; } }}mysqli_stmt_close($stmt);mysqli_close($link);?>

The above examples will output:

Albania 3401200 Europe Algeria 31471000 Africa Afghanistan 22720000 Asia Anguilla 8000 North America

See Also

mysqli_stmt_result_metadata

mysqli_fetch_array

22.9.3.10.16. mysqli_stmt::get_warnings,mysqli_stmt_get_warnings

mysqli_stmt::get_warnings
mysqli_stmt_get_warnings
Get result of SHOW WARNINGS

Description

Object oriented style

object mysqli_stmt::get_warnings(mysqli_stmt stmt);

Procedural style

object mysqli_stmt_get_warnings(mysqli_stmt stmt);

Warning

This function iscurrently not documented; only its argument list is available.

22.9.3.10.17. mysqli_stmt::$insert_id,mysqli_stmt_insert_id

mysqli_stmt::$insert_id
mysqli_stmt_insert_id
Get the ID generated from the previous INSERT operation

Description

Object oriented style

int mysqli_stmt->insert_id ;

Procedural style

mixed mysqli_stmt_insert_id(mysqli_stmt stmt);

Warning

This function iscurrently not documented; only its argument list is available.

22.9.3.10.18. mysqli_stmt::more_results,mysqli_stmt_more_results

mysqli_stmt::more_results
mysqli_stmt_more_results
Check if there are more query results from a multiple query

Description

Object oriented style (method):

public bool mysqli_stmt::more_results();

Procedural style:

bool mysqli_stmt_more_results(mysql_stmt stmt);

Checks if there are more query results from a multiple query.

Parameters

stmt: Procedural style only: A statement identifier returned by mysqli_stmt_init.

Return Values

Returns TRUE if more results exist, otherwise FALSE .

See Also

mysqli_stmt::next_result

mysqli_stmt::more_results

22.9.3.10.19. mysqli_stmt::next_result,mysqli_stmt_next_result

mysqli_stmt::next_result
mysqli_stmt_next_result
Reads the next result from a multiple query

Description

Object oriented style (method):

public bool mysqli_stmt::next_result();

Procedural style:

bool mysqli_stmt_next_result(mysql_stmt stmt);

Reads the next result from a multiple query.

Parameters

stmt: Procedural style only: A statement identifier returned by mysqli_stmt_init.

Return Values

Returns TRUE on success or FALSE on failure.

Errors/Exceptions

Emits an E_STRICT level error if a result set does not exist, and suggests using mysqli_stmt::more_results in these cases, before calling mysqli_stmt::next_result.

See Also

mysqli_stmt_affected_rows

22.9.3.10.20. mysqli_stmt::$num_rows,mysqli_stmt_num_rows

mysqli_stmt::$num_rows
mysqli_stmt_num_rows
Return the number of rows in statements result set

Description

Object oriented style

int mysqli_stmt->num_rows ;

Procedural style

int mysqli_stmt_num_rows(mysqli_stmt stmt);

Returns the number of rows in the result set. The use of mysqli_stmt_num_rows depends on whether or not you used mysqli_stmt_store_result to buffer the entire result set in the statement handle.

If you use mysqli_stmt_store_result, mysqli_stmt_num_rows may be called immediately.

Parameters

stmt: Procedural style only: A statement identifier returned by mysqli_stmt_init.

Return Values

An integer representing the number of rows in result set.

Examples

Example 22.169. Object oriented style

<?php/* Open a connection */$mysqli = new mysqli("localhost", "my_user", "my_password", "world");/* check connection */if (mysqli_connect_errno()) { printf("Connect failed: %s\n", mysqli_connect_error()); exit();}$query = "SELECT Name, CountryCode FROM City ORDER BY Name LIMIT 20";if ($stmt = $mysqli->prepare($query)) { /* execute query */ $stmt->execute(); /* store result */ $stmt->store_result(); printf("Number of rows: %d.\n", $stmt->num_rows); /* close statement */ $stmt->close();}/* close connection */$mysqli->close();?>

Example 22.170. Procedural style

<?php/* Open a connection */$link = mysqli_connect("localhost", "my_user", "my_password", "world");/* check connection */if (mysqli_connect_errno()) { printf("Connect failed: %s\n", mysqli_connect_error()); exit();}$query = "SELECT Name, CountryCode FROM City ORDER BY Name LIMIT 20";if ($stmt = mysqli_prepare($link, $query)) { /* execute query */ mysqli_stmt_execute($stmt); /* store result */ mysqli_stmt_store_result($stmt); printf("Number of rows: %d.\n", mysqli_stmt_num_rows($stmt)); /* close statement */ mysqli_stmt_close($stmt);}/* close connection */mysqli_close($link);?>

The above examples will output:

Number of rows: 20.

See Also

22.9.3.10.21. mysqli_stmt::$param_count,mysqli_stmt_param_count

mysqli_stmt::$param_count
mysqli_stmt_param_count
Returns the number of parameter for the given statement

Description

Object oriented style

int mysqli_stmt->param_count ;

Procedural style

int mysqli_stmt_param_count(mysqli_stmt stmt);

Returns the number of parameter markers present in the prepared statement.

Parameters

stmt: Procedural style only: A statement identifier returned by mysqli_stmt_init.

Return Values

Returns an integer representing the number of parameters.

Examples

Example 22.171. Object oriented style

<?php$mysqli = new mysqli("localhost", "my_user", "my_password", "world");/* check connection */if (mysqli_connect_errno()) { printf("Connect failed: %s\n", mysqli_connect_error()); exit();}if ($stmt = $mysqli->prepare("SELECT Name FROM Country WHERE Name=? OR Code=?")) { $marker = $stmt->param_count; printf("Statement has %d markers.\n", $marker); /* close statement */ $stmt->close();}/* close connection */$mysqli->close();?>

Example 22.172. Procedural style

<?php$link = mysqli_connect("localhost", "my_user", "my_password", "world");/* check connection */if (mysqli_connect_errno()) { printf("Connect failed: %s\n", mysqli_connect_error()); exit();}if ($stmt = mysqli_prepare($link, "SELECT Name FROM Country WHERE Name=? OR Code=?")) { $marker = mysqli_stmt_param_count($stmt); printf("Statement has %d markers.\n", $marker); /* close statement */ mysqli_stmt_close($stmt);}/* close connection */mysqli_close($link);?>

The above examples will output:

Statement has 2 markers.

See Also

22.9.3.10.22. mysqli_stmt::prepare,mysqli_stmt_prepare

mysqli_stmt::prepare
mysqli_stmt_prepare
Prepare an SQL statement for execution

Description

Object oriented style

mixed mysqli_stmt::prepare(string query);

Procedural style

bool mysqli_stmt_prepare(mysqli_stmt stmt,
string query);

Prepares the SQL query pointed to by the null-terminated string query.

The parameter markers must be bound to application variables using mysqli_stmt_bind_param and/or mysqli_stmt_bind_result before executing the statement or fetching rows.

Note

In the case where you pass a statement to mysqli_stmt_prepare that is longer than max_allowed_packet of the server, the returned error codes are different depending on whether you are using MySQL Native Driver (mysqlnd) or MySQL Client Library (libmysql). The behavior is as follows:

mysqlnd on Linux returns an error code of 1153. The error message means "got a packet bigger than max_allowed_packet bytes".
mysqlnd on Windows returns an error code 2006. This error message means "server has gone away".
libmysql on all platforms returns an error code 2006. This error message means "server has gone away".

Parameters

stmt

Procedural style only: A statement identifier returned by mysqli_stmt_init.

query

The query, as a string. It must consist of a single SQL statement.

You can include one or more parameter markers in the SQL statement by embedding question mark (?) characters at the appropriate positions.

Note

You should not add a terminating semicolon or \g to the statement.

Note

However, they are not allowed for identifiers (such as table or column names), in the select list that names the columns to be returned by a SELECT statement), or to specify both operands of a binary operator such as the = equal sign. The latter restriction is necessary because it would be impossible to determine the parameter type. In general, parameters are legal only in Data Manipulation Language (DML) statements, and not in Data Definition Language (DDL) statements.

Return Values

Returns TRUE on success or FALSE on failure.

Examples

Example 22.173. Object oriented style

<?php$mysqli = new mysqli("localhost", "my_user", "my_password", "world");/* check connection */if (mysqli_connect_errno()) { printf("Connect failed: %s\n", mysqli_connect_error()); exit();}$city = "Amersfoort";/* create a prepared statement */$stmt =  $mysqli->stmt_init();if ($stmt->prepare("SELECT District FROM City WHERE Name=?")) { /* bind parameters for markers */ $stmt->bind_param("s", $city); /* execute query */ $stmt->execute(); /* bind result variables */ $stmt->bind_result($district); /* fetch value */ $stmt->fetch(); printf("%s is in district %s\n", $city, $district); /* close statement */ $stmt->close();}/* close connection */$mysqli->close();?>

Example 22.174. Procedural style

<?php$link = mysqli_connect("localhost", "my_user", "my_password", "world");/* check connection */if (mysqli_connect_errno()) { printf("Connect failed: %s\n", mysqli_connect_error()); exit();}$city = "Amersfoort";/* create a prepared statement */$stmt = mysqli_stmt_init($link);if (mysqli_stmt_prepare($stmt, 'SELECT District FROM City WHERE Name=?')) { /* bind parameters for markers */ mysqli_stmt_bind_param($stmt, "s", $city); /* execute query */ mysqli_stmt_execute($stmt); /* bind result variables */ mysqli_stmt_bind_result($stmt, $district); /* fetch value */ mysqli_stmt_fetch($stmt); printf("%s is in district %s\n", $city, $district); /* close statement */ mysqli_stmt_close($stmt);}/* close connection */mysqli_close($link);?>

The above examples will output:

Amersfoort is in district Utrecht

See Also

mysqli_stmt_init

mysqli_stmt_close

22.9.3.10.23. mysqli_stmt::reset,mysqli_stmt_reset

mysqli_stmt::reset
mysqli_stmt_reset
Resets a prepared statement

Description

Object oriented style

bool mysqli_stmt::reset();

Procedural style

bool mysqli_stmt_reset(mysqli_stmt stmt);

Resets a prepared statement on client and server to state after prepare.

It resets the statement on the server, data sent using mysqli_stmt_send_long_data, unbuffered result sets and current errors. It does not clear bindings or stored result sets. Stored result sets will be cleared when executing the prepared statement (or closing it).

To prepare a statement with another query use function mysqli_stmt_prepare.

Parameters

stmt: Procedural style only: A statement identifier returned by mysqli_stmt_init.

Return Values

Returns TRUE on success or FALSE on failure.

See Also

22.9.3.10.24. mysqli_stmt::result_metadata,mysqli_stmt_result_metadata

mysqli_stmt::result_metadata
mysqli_stmt_result_metadata
Returns result set metadata from a prepared statement

Description

Object oriented style

mysqli_result mysqli_stmt::result_metadata();

Procedural style

mysqli_result mysqli_stmt_result_metadata(mysqli_stmt stmt);

If a statement passed to mysqli_prepare is one that produces a result set, mysqli_stmt_result_metadata returns the result object that can be used to process the meta information such as total number of fields and individual field information.

Note

This result set pointer can be passed as an argument to any of the field-based functions that process result set metadata, such as:

The result set structure should be freed when you are done with it, which you can do by passing it to mysqli_free_result

Note

The result set returned by mysqli_stmt_result_metadata contains only metadata. It does not contain any row results. The rows are obtained by using the statement handle with mysqli_stmt_fetch.

Parameters

stmt: Procedural style only: A statement identifier returned by mysqli_stmt_init.

Return Values

Returns a result object or FALSE if an error occurred.

Examples

Example 22.175. Object oriented style

<?php$mysqli = new mysqli("localhost", "my_user", "my_password", "test");$mysqli->query("DROP TABLE IF EXISTS friends");$mysqli->query("CREATE TABLE friends (id int, name varchar(20))");$mysqli->query("INSERT INTO friends VALUES (1,'Hartmut'), (2, 'Ulf')");$stmt = $mysqli->prepare("SELECT id, name FROM friends");$stmt->execute();/* get resultset for metadata */$result = $stmt->result_metadata();/* retrieve field information from metadata result set */$field = $result->fetch_field();printf("Fieldname: %s\n", $field->name);/* close resultset */$result->close();/* close connection */$mysqli->close();?>

Example 22.176. Procedural style

<?php$link = mysqli_connect("localhost", "my_user", "my_password", "test");mysqli_query($link, "DROP TABLE IF EXISTS friends");mysqli_query($link, "CREATE TABLE friends (id int, name varchar(20))");mysqli_query($link, "INSERT INTO friends VALUES (1,'Hartmut'), (2, 'Ulf')");$stmt = mysqli_prepare($link, "SELECT id, name FROM friends");mysqli_stmt_execute($stmt);/* get resultset for metadata */$result = mysqli_stmt_result_metadata($stmt);/* retrieve field information from metadata result set */$field = mysqli_fetch_field($result);printf("Fieldname: %s\n", $field->name);/* close resultset */mysqli_free_result($result);/* close connection */mysqli_close($link);?>

See Also

mysqli_free_result

22.9.3.10.25. mysqli_stmt::send_long_data,mysqli_stmt_send_long_data

mysqli_stmt::send_long_data
mysqli_stmt_send_long_data
Send data in blocks

Description

Object oriented style

bool mysqli_stmt::send_long_data(int param_nr,
string data);

Procedural style

bool mysqli_stmt_send_long_data(mysqli_stmt stmt,
int param_nr,
string data);

Allows to send parameter data to the server in pieces (or chunks), e.g. if the size of a blob exceeds the size of max_allowed_packet. This function 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 TEXT or BLOB datatypes.

Parameters

stmt: Procedural style only: A statement identifier returned by mysqli_stmt_init.
param_nr: Indicates which parameter to associate the data with. Parameters are numbered beginning with 0.
data: A string containing data to be sent.

Return Values

Returns TRUE on success or FALSE on failure.

Examples

Example 22.177. Object oriented style

<?php$stmt = $mysqli->prepare("INSERT INTO messages (message) VALUES (?)");$null = NULL;$stmt->bind_param("b", $null);$fp = fopen("messages.txt", "r");while (!feof($fp)) { $stmt->send_long_data(0, fread($fp, 8192));}fclose($fp);$stmt->execute();?>

See Also

22.9.3.10.26. mysqli_stmt::$sqlstate,mysqli_stmt_sqlstate

mysqli_stmt::$sqlstate
mysqli_stmt_sqlstate
Returns SQLSTATE error from previous statement operation

Description

Object oriented style

string mysqli_stmt->sqlstate ;

Procedural style

string mysqli_stmt_sqlstate(mysqli_stmt stmt);

Returns a string containing the SQLSTATE error code for the most recently invoked prepared statement function that can succeed or fail. The error code consists of five characters. '00000' means no error. The values are specified by ANSI SQL and ODBC. For a list of possible values, see http://dev.mysql.com/doc/mysql/en/error-handling.html.

Parameters

stmt: Procedural style only: A statement identifier returned by mysqli_stmt_init.

Return Values

Returns a string containing the SQLSTATE error code for the last error. The error code consists of five characters. '00000' means no error.

Notes

Note

Note that not all MySQL errors are yet mapped to SQLSTATE's. The value HY000 (general error) is used for unmapped errors.

Examples

Example 22.178. Object oriented style

<?php/* Open a connection */$mysqli = new mysqli("localhost", "my_user", "my_password", "world");/* check connection */if (mysqli_connect_errno()) { printf("Connect failed: %s\n", mysqli_connect_error()); exit();}$mysqli->query("CREATE TABLE myCountry LIKE Country");$mysqli->query("INSERT INTO myCountry SELECT * FROM Country");$query = "SELECT Name, Code FROM myCountry ORDER BY Name";if ($stmt = $mysqli->prepare($query)) { /* drop table */ $mysqli->query("DROP TABLE myCountry"); /* execute query */ $stmt->execute(); printf("Error: %s.\n", $stmt->sqlstate); /* close statement */ $stmt->close();}/* close connection */$mysqli->close();?>

Example 22.179. Procedural style

<?php/* Open a connection */$link = mysqli_connect("localhost", "my_user", "my_password", "world");/* check connection */if (mysqli_connect_errno()) { printf("Connect failed: %s\n", mysqli_connect_error()); exit();}mysqli_query($link, "CREATE TABLE myCountry LIKE Country");mysqli_query($link, "INSERT INTO myCountry SELECT * FROM Country");$query = "SELECT Name, Code FROM myCountry ORDER BY Name";if ($stmt = mysqli_prepare($link, $query)) { /* drop table */ mysqli_query($link, "DROP TABLE myCountry"); /* execute query */ mysqli_stmt_execute($stmt); printf("Error: %s.\n", mysqli_stmt_sqlstate($stmt)); /* close statement */ mysqli_stmt_close($stmt);}/* close connection */mysqli_close($link);?>

The above examples will output:

Error: 42S02.

See Also

22.9.3.10.27. mysqli_stmt::store_result,mysqli_stmt_store_result

mysqli_stmt::store_result
mysqli_stmt_store_result
Transfers a result set from a prepared statement

Description

Object oriented style

bool mysqli_stmt::store_result();

Procedural style

bool mysqli_stmt_store_result(mysqli_stmt stmt);

You must call mysqli_stmt_store_result for every query that successfully produces a result set (SELECT, SHOW, DESCRIBE, EXPLAIN), and only if you want to buffer the complete result set by the client, so that the subsequent mysqli_stmt_fetch call returns buffered data.

Note

It is unnecessary to call mysqli_stmt_store_result for other queries, but if you do, it will not harm or cause any notable performance in all cases. You can detect whether the query produced a result set by checking if mysqli_stmt_result_metadata returns NULL.

Parameters

stmt: Procedural style only: A statement identifier returned by mysqli_stmt_init.

Return Values

Returns TRUE on success or FALSE on failure.

Examples

Example 22.180. Object oriented style

<?php/* Open a connection */$mysqli = new mysqli("localhost", "my_user", "my_password", "world");/* check connection */if (mysqli_connect_errno()) { printf("Connect failed: %s\n", mysqli_connect_error()); exit();}$query = "SELECT Name, CountryCode FROM City ORDER BY Name LIMIT 20";if ($stmt = $mysqli->prepare($query)) { /* execute query */ $stmt->execute(); /* store result */ $stmt->store_result(); printf("Number of rows: %d.\n", $stmt->num_rows); /* free result */ $stmt->free_result(); /* close statement */ $stmt->close();}/* close connection */$mysqli->close();?>

Example 22.181. Procedural style

<?php/* Open a connection */$link = mysqli_connect("localhost", "my_user", "my_password", "world");/* check connection */if (mysqli_connect_errno()) { printf("Connect failed: %s\n", mysqli_connect_error()); exit();}$query = "SELECT Name, CountryCode FROM City ORDER BY Name LIMIT 20";if ($stmt = mysqli_prepare($link, $query)) { /* execute query */ mysqli_stmt_execute($stmt); /* store result */ mysqli_stmt_store_result($stmt); printf("Number of rows: %d.\n", mysqli_stmt_num_rows($stmt)); /* free result */ mysqli_stmt_free_result($stmt); /* close statement */ mysqli_stmt_close($stmt);}/* close connection */mysqli_close($link);?>

The above examples will output:

Number of rows: 20.

See Also

mysqli_stmt_result_metadata

22.9.3.11. The mysqli_result class (mysqli_result)

Represents the result set obtained from a query against the database.

Changelog

Table 22.50. Changelog

Version	Description
5.4.0	Iterator support was added, as mysqli_result now implementsTraversable.

 mysqli_result {
 mysqli_result , TraversableProperties  int mysqli_result->current_field ;
  int mysqli_result->field_count ;
  array mysqli_result->lengths ;
  int mysqli_result->num_rows ;
Methods  bool mysqli_result::data_seek(int offset);
  mixed mysqli_result::fetch_all(int resulttype= =MYSQLI_NUM);
  mixed mysqli_result::fetch_array(int resulttype= =MYSQLI_BOTH);
  array mysqli_result::fetch_assoc();
  object mysqli_result::fetch_field_direct(int fieldnr);
  object mysqli_result::fetch_field();
  array mysqli_result::fetch_fields();
  object mysqli_result::fetch_object(string class_name,
 array params);
  mixed mysqli_result::fetch_row();
  bool mysqli_result::field_seek(int fieldnr);
  void mysqli_result::free();
}

22.9.3.11.1. mysqli_result::$current_field,mysqli_field_tell

mysqli_result::$current_field
mysqli_field_tell
Get current field offset of a result pointer

Description

Object oriented style

int mysqli_result->current_field ;

Procedural style

int mysqli_field_tell(mysqli_result result);

Returns the position of the field cursor used for the last mysqli_fetch_field call. This value can be used as an argument to mysqli_field_seek.

Parameters

result: Procedural style only: A result set identifier returned by mysqli_query, mysqli_store_result or mysqli_use_result.

Return Values

Returns current offset of field cursor.

Examples

Example 22.182. Object oriented style

<?php$mysqli = new mysqli("localhost", "my_user", "my_password", "world");/* check connection */if (mysqli_connect_errno()) { printf("Connect failed: %s\n", mysqli_connect_error()); exit();}$query = "SELECT Name, SurfaceArea from Country ORDER BY Code LIMIT 5";if ($result = $mysqli->query($query)) { /* Get field information for all columns */ while ($finfo = $result->fetch_field()) { /* get fieldpointer offset */ $currentfield = $result->current_field; printf("Column %d:\n", $currentfield); printf("Name: %s\n", $finfo->name); printf("Table: %s\n", $finfo->table); printf("max. Len: %d\n", $finfo->max_length); printf("Flags: %d\n", $finfo->flags); printf("Type: %d\n\n", $finfo->type); } $result->close();}/* close connection */$mysqli->close();?>

Example 22.183. Procedural style

<?php$link = mysqli_connect("localhost", "my_user", "my_password", "world");/* check connection */if (mysqli_connect_errno()) { printf("Connect failed: %s\n", mysqli_connect_error()); exit();}$query = "SELECT Name, SurfaceArea from Country ORDER BY Code LIMIT 5";if ($result = mysqli_query($link, $query)) { /* Get field information for all fields */ while ($finfo = mysqli_fetch_field($result)) { /* get fieldpointer offset */ $currentfield = mysqli_field_tell($result); printf("Column %d:\n", $currentfield); printf("Name: %s\n", $finfo->name); printf("Table: %s\n", $finfo->table); printf("max. Len: %d\n", $finfo->max_length); printf("Flags: %d\n", $finfo->flags); printf("Type: %d\n\n", $finfo->type); } mysqli_free_result($result);}/* close connection */mysqli_close($link);?>

The above examples will output:

Column 1:Name: NameTable: Countrymax. Len: 11Flags: 1Type: 254Column 2:Name: SurfaceAreaTable: Countrymax. Len: 10Flags: 32769Type: 4

See Also

mysqli_field_seek

22.9.3.11.2. mysqli_result::data_seek,mysqli_data_seek

mysqli_result::data_seek
mysqli_data_seek
Adjusts the result pointer to an arbitrary row in the result

Description

Object oriented style

bool mysqli_result::data_seek(int offset);

Procedural style

bool mysqli_data_seek(mysqli_result result,
int offset);

The mysqli_data_seek function seeks to an arbitrary result pointer specified by the offset in the result set.

Parameters

result: Procedural style only: A result set identifier returned by mysqli_query, mysqli_store_result or mysqli_use_result.
offset: The field offset. Must be between zero and the total number of rows minus one (0..mysqli_num_rows - 1).

Return Values

Returns TRUE on success or FALSE on failure.

Notes

Note

This function can only be used with buffered results attained from the use of the mysqli_store_result or mysqli_query functions.

Examples

Example 22.184. Object oriented style

<?php/* Open a connection */$mysqli = new mysqli("localhost", "my_user", "my_password", "world");/* check connection */if (mysqli_connect_errno()) { printf("Connect failed: %s\n", mysqli_connect_error()); exit();}$query = "SELECT Name, CountryCode FROM City ORDER BY Name";if ($result = $mysqli->query( $query)) { /* seek to row no. 400 */ $result->data_seek(399); /* fetch row */ $row = $result->fetch_row(); printf ("City: %s  Countrycode: %s\n", $row[0], $row[1]); /* free result set*/ $result->close();}/* close connection */$mysqli->close();?>

Example 22.185. Procedural style

<?php/* Open a connection */$link = mysqli_connect("localhost", "my_user", "my_password", "world");/* check connection */if (!$link) { printf("Connect failed: %s\n", mysqli_connect_error()); exit();}$query = "SELECT Name, CountryCode FROM City ORDER BY Name";if ($result = mysqli_query($link, $query)) { /* seek to row no. 400 */ mysqli_data_seek($result, 399); /* fetch row */ $row = mysqli_fetch_row($result); printf ("City: %s  Countrycode: %s\n", $row[0], $row[1]); /* free result set*/ mysqli_free_result($result);}/* close connection */mysqli_close($link);?>

The above examples will output:

City: Benin City  Countrycode: NGA

See Also

22.9.3.11.3. mysqli_result::fetch_all,mysqli_fetch_all

mysqli_result::fetch_all
mysqli_fetch_all
Fetches all result rows as an associative array, a numeric array, or both

Description

Object oriented style

mixed mysqli_result::fetch_all(int resulttype= =MYSQLI_NUM);

Procedural style

mixed mysqli_fetch_all(mysqli_result result,
int resulttype= =MYSQLI_NUM);

mysqli_fetch_all fetches all result rows and returns the result set as an associative array, a numeric array, or both.

Parameters

result: Procedural style only: A result set identifier returned by mysqli_query, mysqli_store_result or mysqli_use_result.
resulttype: This optional parameter is a constant indicating what type of array should be produced from the current row data. The possible values for this parameter are the constants MYSQLI_ASSOC , MYSQLI_NUM , or MYSQLI_BOTH .

Return Values

Returns an array of associative or numeric arrays holding result rows.

MySQL Native Driver Only

Available only with mysqlnd.

As mysqli_fetch_all returns all the rows as an array in a single step, it may consume more memory than some similar functions such as mysqli_fetch_array, which only returns one row at a time from the result set. Further, if you need to iterate over the result set, you will need a looping construct that will further impact performance. For these reasons mysqli_fetch_all should only be used in those situations where the fetched result set will be sent to another layer for processing.

See Also

mysqli_fetch_array

22.9.3.11.4. mysqli_result::fetch_array,mysqli_fetch_array

mysqli_result::fetch_array
mysqli_fetch_array
Fetch a result row as an associative, a numeric array, or both

Description

Object oriented style

mixed mysqli_result::fetch_array(int resulttype= =MYSQLI_BOTH);

Procedural style

mixed mysqli_fetch_array(mysqli_result result,
int resulttype= =MYSQLI_BOTH);

Returns an array that corresponds to the fetched row or NULL if there are no more rows for the resultset represented by the result parameter.

mysqli_fetch_array is an extended version of the mysqli_fetch_row function. In addition to storing the data in the numeric indices of the result array, the mysqli_fetch_array function can also store the data in associative indices, using the field names of the result set as keys.

Note

Field names returned by this functionare case-sensitive.

Note

This function sets NULL fields tothe PHP NULL value.

If two or more columns of the result have the same field names, the last column will take precedence and overwrite the earlier data. In order to access multiple columns with the same name, the numerically indexed version of the row must be used.

Parameters

result

Procedural style only: A result set identifier returned by mysqli_query, mysqli_store_result or mysqli_use_result.

resulttype

This optional parameter is a constant indicating what type of array should be produced from the current row data. The possible values for this parameter are the constants MYSQLI_ASSOC , MYSQLI_NUM , or MYSQLI_BOTH .

By using the MYSQLI_ASSOC constant this function will behave identically to the mysqli_fetch_assoc, while MYSQLI_NUM will behave identically to the mysqli_fetch_row function. The final option MYSQLI_BOTH will create a single array with the attributes of both.

Return Values

Returns an array of strings that corresponds to the fetched row or NULL if there are no more rows in resultset.

Examples

Example 22.186. Object oriented style

<?php$mysqli = new mysqli("localhost", "my_user", "my_password", "world");/* check connection */if (mysqli_connect_errno()) { printf("Connect failed: %s\n", mysqli_connect_error()); exit();}$query = "SELECT Name, CountryCode FROM City ORDER by ID LIMIT 3";$result = $mysqli->query($query);/* numeric array */$row = $result->fetch_array(MYSQLI_NUM);printf ("%s (%s)\n", $row[0], $row[1]);/* associative array */$row = $result->fetch_array(MYSQLI_ASSOC);printf ("%s (%s)\n", $row["Name"], $row["CountryCode"]);/* associative and numeric array */$row = $result->fetch_array(MYSQLI_BOTH);printf ("%s (%s)\n", $row[0], $row["CountryCode"]);/* free result set */$result->free();/* close connection */$mysqli->close();?>

Example 22.187. Procedural style

<?php$link = mysqli_connect("localhost", "my_user", "my_password", "world");/* check connection */if (mysqli_connect_errno()) { printf("Connect failed: %s\n", mysqli_connect_error()); exit();}$query = "SELECT Name, CountryCode FROM City ORDER by ID LIMIT 3";$result = mysqli_query($link, $query);/* numeric array */$row = mysqli_fetch_array($result, MYSQLI_NUM);printf ("%s (%s)\n", $row[0], $row[1]);/* associative array */$row = mysqli_fetch_array($result, MYSQLI_ASSOC);printf ("%s (%s)\n", $row["Name"], $row["CountryCode"]);/* associative and numeric array */$row = mysqli_fetch_array($result, MYSQLI_BOTH);printf ("%s (%s)\n", $row[0], $row["CountryCode"]);/* free result set */mysqli_free_result($result);/* close connection */mysqli_close($link);?>

The above examples will output:

Kabul (AFG)Qandahar (AFG)Herat (AFG)

See Also

22.9.3.11.5. mysqli_result::fetch_assoc,mysqli_fetch_assoc

mysqli_result::fetch_assoc
mysqli_fetch_assoc
Fetch a result row as an associative array

Description

Object oriented style

array mysqli_result::fetch_assoc();

Procedural style

array mysqli_fetch_assoc(mysqli_result result);

Returns an associative array that corresponds to the fetched row or NULL if there are no more rows.

Note

Field names returned by this functionare case-sensitive.

Note

This function sets NULL fields tothe PHP NULL value.

Parameters

result: Procedural style only: A result set identifier returned by mysqli_query, mysqli_store_result or mysqli_use_result.

Return Values

Returns an associative array of strings representing the fetched row in the result set, where each key in the array represents the name of one of the result set's columns or NULL if there are no more rows in resultset.

If two or more columns of the result have the same field names, the last column will take precedence. To access the other column(s) of the same name, you either need to access the result with numeric indices by using mysqli_fetch_row or add alias names.

Examples

Example 22.188. Object oriented style

<?php$mysqli = new mysqli("localhost", "my_user", "my_password", "world");/* check connection */if (mysqli_connect_errno()) { printf("Connect failed: %s\n", mysqli_connect_error()); exit();}$query = "SELECT Name, CountryCode FROM City ORDER by ID DESC LIMIT 50,5";if ($result = $mysqli->query($query)) { /* fetch associative array */ while ($row = $result->fetch_assoc()) { printf ("%s (%s)\n", $row["Name"], $row["CountryCode"]); } /* free result set */ $result->free();}/* close connection */$mysqli->close();?>

Example 22.189. Procedural style

<?php$link = mysqli_connect("localhost", "my_user", "my_password", "world");/* check connection */if (mysqli_connect_errno()) { printf("Connect failed: %s\n", mysqli_connect_error()); exit();}$query = "SELECT Name, CountryCode FROM City ORDER by ID DESC LIMIT 50,5";if ($result = mysqli_query($link, $query)) { /* fetch associative array */ while ($row = mysqli_fetch_assoc($result)) { printf ("%s (%s)\n", $row["Name"], $row["CountryCode"]); } /* free result set */ mysqli_free_result($result);}/* close connection */mysqli_close($link);?>

The above examples will output:

Pueblo (USA)Arvada (USA)Cape Coral (USA)Green Bay (USA)Santa Clara (USA)

Example 22.190. A mysqli_result example comparingiterator usage

<?php$c = mysqli_connect('127.0.0.1','user', 'pass');// Using iterators (support was added with PHP 5.4)foreach ( $c->query('SELECT user,host FROM mysql.user') as $row ) { printf("'%s'@'%s'\n", $row['user'], $row['host']);}echo "\n==================\n";// Not using iterators$result = $c->query('SELECT user,host FROM mysql.user');while ($row = $result->fetch_assoc()) { printf("'%s'@'%s'\n", $row['user'], $row['host']);}?>

The above example will output something similar to:

'root'@'192.168.1.1''root'@'127.0.0.1''dude'@'localhost''lebowski'@'localhost'=================='root'@'192.168.1.1''root'@'127.0.0.1''dude'@'localhost''lebowski'@'localhost'

See Also

22.9.3.11.6. mysqli_result::fetch_field_direct,mysqli_fetch_field_direct

mysqli_result::fetch_field_direct
mysqli_fetch_field_direct
Fetch meta-data for a single field

Description

Object oriented style

object mysqli_result::fetch_field_direct(int fieldnr);

Procedural style

object mysqli_fetch_field_direct(mysqli_result result,
int fieldnr);

Returns an object which contains field definition information from the specified result set.

Parameters

result: Procedural style only: A result set identifier returned by mysqli_query, mysqli_store_result or mysqli_use_result.
fieldnr: The field number. This value must be in the range from 0 to number of fields - 1.

Return Values

Returns an object which contains field definition information or FALSE if no field information for specified fieldnr is available.

Table 22.51. Object attributes

Attribute	Description
name	The name of the column
orgname	Original column name if an alias was specified
table	The name of the table this field belongs to (if not calculated)
orgtable	Original table name if an alias was specified
def	The default value for this field, represented as a string
max_length	The maximum width of the field for the result set.
length	The width of the field, as specified in the table definition.
charsetnr	The character set number for the field.
flags	An integer representing the bit-flags for the field.
type	The data type used for this field
decimals	The number of decimals used (for integer fields)

Examples

Example 22.191. Object oriented style

<?php$mysqli = new mysqli("localhost", "my_user", "my_password", "world");/* check connection */if (mysqli_connect_errno()) { printf("Connect failed: %s\n", mysqli_connect_error()); exit();}$query = "SELECT Name, SurfaceArea from Country ORDER BY Name LIMIT 5";if ($result = $mysqli->query($query)) { /* Get field information for column 'SurfaceArea' */ $finfo = $result->fetch_field_direct(1); printf("Name: %s\n", $finfo->name); printf("Table: %s\n", $finfo->table); printf("max. Len: %d\n", $finfo->max_length); printf("Flags: %d\n", $finfo->flags); printf("Type: %d\n", $finfo->type); $result->close();}/* close connection */$mysqli->close();?>

Example 22.192. Procedural style

<?php$link = mysqli_connect("localhost", "my_user", "my_password", "world");/* check connection */if (mysqli_connect_errno()) { printf("Connect failed: %s\n", mysqli_connect_error()); exit();}$query = "SELECT Name, SurfaceArea from Country ORDER BY Name LIMIT 5";if ($result = mysqli_query($link, $query)) { /* Get field information for column 'SurfaceArea' */ $finfo = mysqli_fetch_field_direct($result, 1); printf("Name: %s\n", $finfo->name); printf("Table: %s\n", $finfo->table); printf("max. Len: %d\n", $finfo->max_length); printf("Flags: %d\n", $finfo->flags); printf("Type: %d\n", $finfo->type); mysqli_free_result($result);}/* close connection */mysqli_close($link);?>

The above examples will output:

Name: SurfaceAreaTable: Countrymax. Len: 10Flags: 32769Type: 4

See Also

mysqli_num_fields

mysqli_fetch_field_direct

mysqli_fetch_fields

22.9.3.11.7. mysqli_result::fetch_field,mysqli_fetch_field

mysqli_result::fetch_field
mysqli_fetch_field
Returns the next field in the result set

Description

Object oriented style

object mysqli_result::fetch_field();

Procedural style

object mysqli_fetch_field(mysqli_result result);

Returns the definition of one column of a result set as an object. Call this function repeatedly to retrieve information about all columns in the result set.

Parameters

result: Procedural style only: A result set identifier returned by mysqli_query, mysqli_store_result or mysqli_use_result.

Return Values

Returns an object which contains field definition information or FALSE if no field information is available.

Table 22.52. Object properties

Property	Description
name	The name of the column
orgname	Original column name if an alias was specified
table	The name of the table this field belongs to (if not calculated)
orgtable	Original table name if an alias was specified
def	Reserved for default value, currently always ""
db	Database (since PHP 5.3.6)
catalog	The catalog name, always "def" (since PHP 5.3.6)
max_length	The maximum width of the field for the result set.
length	The width of the field, as specified in the table definition.
charsetnr	The character set number for the field.
flags	An integer representing the bit-flags for the field.
type	The data type used for this field
decimals	The number of decimals used (for integer fields)

Examples

Example 22.193. Object oriented style

<?php$mysqli = new mysqli("localhost", "my_user", "my_password", "world");/* check connection */if (mysqli_connect_errno()) { printf("Connect failed: %s\n", mysqli_connect_error()); exit();}$query = "SELECT Name, SurfaceArea from Country ORDER BY Code LIMIT 5";if ($result = $mysqli->query($query)) { /* Get field information for all columns */ while ($finfo = $result->fetch_field()) { printf("Name: %s\n", $finfo->name); printf("Table: %s\n", $finfo->table); printf("max. Len: %d\n", $finfo->max_length); printf("Flags: %d\n", $finfo->flags); printf("Type: %d\n\n", $finfo->type); } $result->close();}/* close connection */$mysqli->close();?>

Example 22.194. Procedural style

<?php$link = mysqli_connect("localhost", "my_user", "my_password", "world");/* check connection */if (mysqli_connect_errno()) { printf("Connect failed: %s\n", mysqli_connect_error()); exit();}$query = "SELECT Name, SurfaceArea from Country ORDER BY Code LIMIT 5";if ($result = mysqli_query($link, $query)) { /* Get field information for all fields */ while ($finfo = mysqli_fetch_field($result)) { printf("Name: %s\n", $finfo->name); printf("Table: %s\n", $finfo->table); printf("max. Len: %d\n", $finfo->max_length); printf("Flags: %d\n", $finfo->flags); printf("Type: %d\n\n", $finfo->type); } mysqli_free_result($result);}/* close connection */mysqli_close($link);?>

The above examples will output:

Name: NameTable: Countrymax. Len: 11Flags: 1Type: 254Name: SurfaceAreaTable: Countrymax. Len: 10Flags: 32769Type: 4

See Also

mysqli_num_fields

mysqli_fetch_fields

mysqli_field_seek

22.9.3.11.8. mysqli_result::fetch_fields,mysqli_fetch_fields

mysqli_result::fetch_fields
mysqli_fetch_fields
Returns an array of objects representing the fields in a result set

Description

Object oriented style

array mysqli_result::fetch_fields();

Procedural style

array mysqli_fetch_fields(mysqli_result result);

This function serves an identical purpose to the mysqli_fetch_field function with the single difference that, instead of returning one object at a time for each field, the columns are returned as an array of objects.

Parameters

result: Procedural style only: A result set identifier returned by mysqli_query, mysqli_store_result or mysqli_use_result.

Return Values

Returns an array of objects which contains field definition information or FALSE if no field information is available.

Table 22.53. Object properties

Property	Description
name	The name of the column
orgname	Original column name if an alias was specified
table	The name of the table this field belongs to (if not calculated)
orgtable	Original table name if an alias was specified
max_length	The maximum width of the field for the result set.
length	The width of the field, as specified in the table definition.
charsetnr	The character set number for the field.
flags	An integer representing the bit-flags for the field.
type	The data type used for this field
decimals	The number of decimals used (for integer fields)

Examples

Example 22.195. Object oriented style

<?php$mysqli = new mysqli("localhost", "my_user", "my_password", "world");/* check connection */if (mysqli_connect_errno()) { printf("Connect failed: %s\n", mysqli_connect_error()); exit();}$query = "SELECT Name, SurfaceArea from Country ORDER BY Code LIMIT 5";if ($result = $mysqli->query($query)) { /* Get field information for all columns */ $finfo = $result->fetch_fields(); foreach ($finfo as $val) { printf("Name: %s\n", $val->name); printf("Table: %s\n", $val->table); printf("max. Len: %d\n", $val->max_length); printf("Flags: %d\n", $val->flags); printf("Type: %d\n\n", $val->type); } $result->close();}/* close connection */$mysqli->close();?>

Example 22.196. Procedural style

<?php$link = mysqli_connect("localhost", "my_user", "my_password", "world");/* check connection */if (mysqli_connect_errno()) { printf("Connect failed: %s\n", mysqli_connect_error()); exit();}$query = "SELECT Name, SurfaceArea from Country ORDER BY Code LIMIT 5";if ($result = mysqli_query($link, $query)) { /* Get field information for all columns */ $finfo = mysqli_fetch_fields($result); foreach ($finfo as $val) { printf("Name: %s\n", $val->name); printf("Table: %s\n", $val->table); printf("max. Len: %d\n", $val->max_length); printf("Flags: %d\n", $val->flags); printf("Type: %d\n\n", $val->type); } mysqli_free_result($result);}/* close connection */mysqli_close($link);?>

The above examples will output:

Name: NameTable: Countrymax. Len: 11Flags: 1Type: 254Name: SurfaceAreaTable: Countrymax. Len: 10Flags: 32769Type: 4

See Also

mysqli_num_fields

mysqli_fetch_field_direct

22.9.3.11.9. mysqli_result::fetch_object,mysqli_fetch_object

mysqli_result::fetch_object
mysqli_fetch_object
Returns the current row of a result set as an object

Description

Object oriented style

object mysqli_result::fetch_object(string class_name,
array params);

Procedural style

object mysqli_fetch_object(mysqli_result result,
string class_name,
array params);

The mysqli_fetch_object will return the current row result set as an object where the attributes of the object represent the names of the fields found within the result set.

Note that mysqli_fetch_object sets the properties of the object before calling the object constructor.

Parameters

result: Procedural style only: A result set identifier returned by mysqli_query, mysqli_store_result or mysqli_use_result.
class_name: The name of the class to instantiate, set the properties of and return. If not specified, a stdClass object is returned.
params: An optional array of parameters to pass to the constructor for class_name objects.

Return Values

Returns an object with string properties that corresponds to the fetched row or NULL if there are no more rows in resultset.

Note

Field names returned by this functionare case-sensitive.

Note

This function sets NULL fields tothe PHP NULL value.

Changelog

Version	Description
5.0.0	Added the ability to return as a different object.

Examples

Example 22.197. Object oriented style

<?php$mysqli = new mysqli("localhost", "my_user", "my_password", "world");/* check connection */if (mysqli_connect_errno()) { printf("Connect failed: %s\n", mysqli_connect_error()); exit();} $query = "SELECT Name, CountryCode FROM City ORDER by ID DESC LIMIT 50,5";if ($result = $mysqli->query($query)) { /* fetch object array */ while ($obj = $result->fetch_object()) { printf ("%s (%s)\n", $obj->Name, $obj->CountryCode); } /* free result set */ $result->close();}/* close connection */$mysqli->close();?>

Example 22.198. Procedural style

<?php$link = mysqli_connect("localhost", "my_user", "my_password", "world");/* check connection */if (mysqli_connect_errno()) { printf("Connect failed: %s\n", mysqli_connect_error()); exit();}$query = "SELECT Name, CountryCode FROM City ORDER by ID DESC LIMIT 50,5";if ($result = mysqli_query($link, $query)) { /* fetch associative array */ while ($obj = mysqli_fetch_object($result)) { printf ("%s (%s)\n", $obj->Name, $obj->CountryCode); } /* free result set */ mysqli_free_result($result);}/* close connection */mysqli_close($link);?>

The above examples will output:

Pueblo (USA)Arvada (USA)Cape Coral (USA)Green Bay (USA)Santa Clara (USA)

See Also

22.9.3.11.10. mysqli_result::fetch_row,mysqli_fetch_row

mysqli_result::fetch_row
mysqli_fetch_row
Get a result row as an enumerated array

Description

Object oriented style

mixed mysqli_result::fetch_row();

Procedural style

mixed mysqli_fetch_row(mysqli_result result);

Fetches one row of data from the result set and returns it as an enumerated array, where each column is stored in an array offset starting from 0 (zero). Each subsequent call to this function will return the next row within the result set, or NULL if there are no more rows.

Parameters

result: Procedural style only: A result set identifier returned by mysqli_query, mysqli_store_result or mysqli_use_result.

Return Values

mysqli_fetch_row returns an array of strings that corresponds to the fetched row or NULL if there are no more rows in result set.

Note

This function sets NULL fields tothe PHP NULL value.

Examples

Example 22.199. Object oriented style

<?php$mysqli = new mysqli("localhost", "my_user", "my_password", "world");/* check connection */if (mysqli_connect_errno()) { printf("Connect failed: %s\n", mysqli_connect_error()); exit();}$query = "SELECT Name, CountryCode FROM City ORDER by ID DESC LIMIT 50,5";if ($result = $mysqli->query($query)) { /* fetch object array */ while ($row = $result->fetch_row()) { printf ("%s (%s)\n", $row[0], $row[1]); } /* free result set */ $result->close();}/* close connection */$mysqli->close();?>

Example 22.200. Procedural style

<?php$link = mysqli_connect("localhost", "my_user", "my_password", "world");/* check connection */if (mysqli_connect_errno()) { printf("Connect failed: %s\n", mysqli_connect_error()); exit();}$query = "SELECT Name, CountryCode FROM City ORDER by ID DESC LIMIT 50,5";if ($result = mysqli_query($link, $query)) { /* fetch associative array */ while ($row = mysqli_fetch_row($result)) { printf ("%s (%s)\n", $row[0], $row[1]); } /* free result set */ mysqli_free_result($result);}/* close connection */mysqli_close($link);?>

The above examples will output:

Pueblo (USA)Arvada (USA)Cape Coral (USA)Green Bay (USA)Santa Clara (USA)

See Also

22.9.3.11.11. mysqli_result::$field_count,mysqli_num_fields

mysqli_result::$field_count
mysqli_num_fields
Get the number of fields in a result

Description

Object oriented style

int mysqli_result->field_count ;

Procedural style

int mysqli_num_fields(mysqli_result result);

Returns the number of fields from specified result set.

Parameters

result: Procedural style only: A result set identifier returned by mysqli_query, mysqli_store_result or mysqli_use_result.

Return Values

The number of fields from a result set.

Examples

Example 22.201. Object oriented style

<?php$mysqli = new mysqli("localhost", "my_user", "my_password", "world");/* check connection */if (mysqli_connect_errno()) { printf("Connect failed: %s\n", mysqli_connect_error()); exit();}if ($result = $mysqli->query("SELECT * FROM City ORDER BY ID LIMIT 1")) { /* determine number of fields in result set */ $field_cnt = $result->field_count; printf("Result set has %d fields.\n", $field_cnt); /* close result set */ $result->close();}/* close connection */$mysqli->close();?>

Example 22.202. Procedural style

<?php$link = mysqli_connect("localhost", "my_user", "my_password", "world");/* check connection */if (mysqli_connect_errno()) { printf("Connect failed: %s\n", mysqli_connect_error()); exit();}if ($result = mysqli_query($link, "SELECT * FROM City ORDER BY ID LIMIT 1")) { /* determine number of fields in result set */ $field_cnt = mysqli_num_fields($result); printf("Result set has %d fields.\n", $field_cnt); /* close result set */ mysqli_free_result($result);}/* close connection */mysqli_close($link);?>

The above examples will output:

Result set has 5 fields.

See Also

22.9.3.11.12. mysqli_result::field_seek,mysqli_field_seek

mysqli_result::field_seek
mysqli_field_seek
Set result pointer to a specified field offset

Description

Object oriented style

bool mysqli_result::field_seek(int fieldnr);

Procedural style

bool mysqli_field_seek(mysqli_result result,
int fieldnr);

Sets the field cursor to the given offset. The next call to mysqli_fetch_field will retrieve the field definition of the column associated with that offset.

Note

To seek to the beginning of a row, pass an offset value of zero.

Parameters

result: Procedural style only: A result set identifier returned by mysqli_query, mysqli_store_result or mysqli_use_result.
fieldnr: The field number. This value must be in the range from 0 to number of fields - 1.

Return Values

Returns TRUE on success or FALSE on failure.

Examples

Example 22.203. Object oriented style

<?php$mysqli = new mysqli("localhost", "my_user", "my_password", "world");/* check connection */if (mysqli_connect_errno()) { printf("Connect failed: %s\n", mysqli_connect_error()); exit();}$query = "SELECT Name, SurfaceArea from Country ORDER BY Code LIMIT 5";if ($result = $mysqli->query($query)) { /* Get field information for 2nd column */ $result->field_seek(1); $finfo = $result->fetch_field(); printf("Name: %s\n", $finfo->name); printf("Table: %s\n", $finfo->table); printf("max. Len: %d\n", $finfo->max_length); printf("Flags: %d\n", $finfo->flags); printf("Type: %d\n\n", $finfo->type); $result->close();}/* close connection */$mysqli->close();?>

Example 22.204. Procedural style

<?php$link = mysqli_connect("localhost", "my_user", "my_password", "world");/* check connection */if (mysqli_connect_errno()) { printf("Connect failed: %s\n", mysqli_connect_error()); exit();}$query = "SELECT Name, SurfaceArea from Country ORDER BY Code LIMIT 5";if ($result = mysqli_query($link, $query)) { /* Get field information for 2nd column */ mysqli_field_seek($result, 1); $finfo = mysqli_fetch_field($result); printf("Name: %s\n", $finfo->name); printf("Table: %s\n", $finfo->table); printf("max. Len: %d\n", $finfo->max_length); printf("Flags: %d\n", $finfo->flags); printf("Type: %d\n\n", $finfo->type); mysqli_free_result($result);}/* close connection */mysqli_close($link);?>

The above examples will output:

Name: SurfaceAreaTable: Countrymax. Len: 10Flags: 32769Type: 4

See Also

22.9.3.11.13. mysqli_result::free,mysqli_free_result

mysqli_result::free
mysqli_free_result
Frees the memory associated with a result

Description

Object oriented style

void mysqli_result::free();
void mysqli_result::close();
void mysqli_result::free_result();

Procedural style

void mysqli_free_result(mysqli_result result);

Frees the memory associated with the result.

Note

You should always free your result with mysqli_free_result, when your result object is not needed anymore.

Parameters

result: Procedural style only: A result set identifier returned by mysqli_query, mysqli_store_result or mysqli_use_result.

Return Values

No value is returned.

See Also

mysqli_store_result

mysqli_use_result

22.9.3.11.14. mysqli_result::$lengths,mysqli_fetch_lengths

mysqli_result::$lengths
mysqli_fetch_lengths
Returns the lengths of the columns of the current row in the result set

Description

Object oriented style

array mysqli_result->lengths ;

Procedural style

array mysqli_fetch_lengths(mysqli_result result);

The mysqli_fetch_lengths function returns an array containing the lengths of every column of the current row within the result set.

Parameters

result: Procedural style only: A result set identifier returned by mysqli_query, mysqli_store_result or mysqli_use_result.

Return Values

An array of integers representing the size of each column (not including any terminating null characters). FALSE if an error occurred.

mysqli_fetch_lengths is valid only for the current row of the result set. It returns FALSE if you call it before calling mysqli_fetch_row/array/object or after retrieving all rows in the result.

Examples

Example 22.205. Object oriented style

<?php$mysqli = new mysqli("localhost", "my_user", "my_password", "world");/* check connection */if (mysqli_connect_errno()) { printf("Connect failed: %s\n", mysqli_connect_error()); exit();}$query = "SELECT * from Country ORDER BY Code LIMIT 1";if ($result = $mysqli->query($query)) { $row = $result->fetch_row(); /* display column lengths */ foreach ($result->lengths as $i => $val) { printf("Field %2d has Length %2d\n", $i+1, $val); } $result->close();}/* close connection */$mysqli->close();?>

Example 22.206. Procedural style

<?php$link = mysqli_connect("localhost", "my_user", "my_password", "world");/* check connection */if (mysqli_connect_errno()) { printf("Connect failed: %s\n", mysqli_connect_error()); exit();}$query = "SELECT * from Country ORDER BY Code LIMIT 1";if ($result = mysqli_query($link, $query)) { $row = mysqli_fetch_row($result); /* display column lengths */ foreach (mysqli_fetch_lengths($result) as $i => $val) { printf("Field %2d has Length %2d\n", $i+1, $val); } mysqli_free_result($result);}/* close connection */mysqli_close($link);?>

The above examples will output:

Field  1 has Length  3Field  2 has Length  5Field  3 has Length 13Field  4 has Length  9Field  5 has Length  6Field  6 has Length  1Field  7 has Length  6Field  8 has Length  4Field  9 has Length  6Field 10 has Length  6Field 11 has Length  5Field 12 has Length 44Field 13 has Length  7Field 14 has Length  3Field 15 has Length  2

22.9.3.11.15. mysqli_result::$num_rows,mysqli_num_rows

mysqli_result::$num_rows
mysqli_num_rows
Gets the number of rows in a result

Description

Object oriented style

int mysqli_result->num_rows ;

Procedural style

int mysqli_num_rows(mysqli_result result);

Returns the number of rows in the result set.

The behaviour of mysqli_num_rows depends on whether buffered or unbuffered result sets are being used. For unbuffered result sets, mysqli_num_rows will not return the correct number of rows until all the rows in the result have been retrieved.

Parameters

result: Procedural style only: A result set identifier returned by mysqli_query, mysqli_store_result or mysqli_use_result.

Return Values

Returns number of rows in the result set.

Note

If the number of rows is greater than MAXINT , the number will be returned as a string.

Examples

Example 22.207. Object oriented style

<?php$mysqli = new mysqli("localhost", "my_user", "my_password", "world");/* check connection */if (mysqli_connect_errno()) { printf("Connect failed: %s\n", mysqli_connect_error()); exit();}if ($result = $mysqli->query("SELECT Code, Name FROM Country ORDER BY Name")) { /* determine number of rows result set */ $row_cnt = $result->num_rows; printf("Result set has %d rows.\n", $row_cnt); /* close result set */ $result->close();}/* close connection */$mysqli->close();?>

Example 22.208. Procedural style

<?php$link = mysqli_connect("localhost", "my_user", "my_password", "world");/* check connection */if (mysqli_connect_errno()) { printf("Connect failed: %s\n", mysqli_connect_error()); exit();}if ($result = mysqli_query($link, "SELECT Code, Name FROM Country ORDER BY Name")) { /* determine number of rows result set */ $row_cnt = mysqli_num_rows($result); printf("Result set has %d rows.\n", $row_cnt); /* close result set */ mysqli_free_result($result);}/* close connection */mysqli_close($link);?>

The above examples will output:

Result set has 239 rows.

See Also

22.9.3.12. The mysqli_driver class (mysqli_driver)

MySQLi Driver.

 mysqli_driver {
 mysqli_driverProperties  public readonly string client_info ;
  public readonly string client_version ;
  public readonly string driver_version ;
  public readonly string embedded ;
  public bool reconnect ;
  public int report_mode ;
Methods  void mysqli_driver::embedded_server_end();
  bool mysqli_driver::embedded_server_start(bool start,
 array arguments,
 array groups);
}

client_info: The Client API header version
client_version: The Client version
driver_version: The MySQLi Driver version
embedded: Whether MySQLi Embedded support is enabled
reconnect: Allow or prevent reconnect (see the mysqli.reconnect INI directive)
report_mode: Set to MYSQLI_REPORT_OFF , MYSQLI_REPORT_ALL or any combination of MYSQLI_REPORT_STRICT (throw Exceptions for errors), MYSQLI_REPORT_ERROR (report errors) and MYSQLI_REPORT_INDEX (errors regarding indexes). See also mysqli_report.

22.9.3.12.1. mysqli_driver::embedded_server_end,mysqli_embedded_server_end

mysqli_driver::embedded_server_end
mysqli_embedded_server_end
Stop embedded server

Description

Object oriented style

void mysqli_driver::embedded_server_end();

Procedural style

void mysqli_embedded_server_end();

Warning

This function iscurrently not documented; only its argument list is available.

22.9.3.12.2. mysqli_driver::embedded_server_start,mysqli_embedded_server_start

mysqli_driver::embedded_server_start
mysqli_embedded_server_start
Initialize and start embedded server

Description

Object oriented style

bool mysqli_driver::embedded_server_start(bool start,
array arguments,
array groups);

Procedural style

bool mysqli_embedded_server_start(bool start,
array arguments,
array groups);

Warning

This function iscurrently not documented; only its argument list is available.

22.9.3.12.3. mysqli_driver::$report_mode,mysqli_report

mysqli_driver::$report_mode
mysqli_report
Enables or disables internal report functions

Description

Object oriented style

int mysqli_driver->report_mode ;

Procedural style

bool mysqli_report(int flags);

A function helpful in improving queries during code development and testing. Depending on the flags, it reports errors from mysqli function calls or queries that don't use an index (or use a bad index).

Parameters

flags

Table 22.54. Supported flags

Name	Description
MYSQLI_REPORT_OFF	Turns reporting off
MYSQLI_REPORT_ERROR	Report errors from mysqli function calls
MYSQLI_REPORT_STRICT	Throw mysqli_sql_exception for errors instead ofwarnings
MYSQLI_REPORT_INDEX	Report if no index or bad index was used in a query
MYSQLI_REPORT_ALL	Set all options (report all)

Return Values

Returns TRUE on success or FALSE on failure.

Changelog

Version	Description
5.3.4	Changing the reporting mode is now be per-request, rather than per-process.
5.2.15	Changing the reporting mode is now be per-request, rather thanper-process.

Examples

Example 22.209. Object oriented style

<?php$mysqli = new mysqli("localhost", "my_user", "my_password", "world");/* check connection */if (mysqli_connect_errno()) { printf("Connect failed: %s\n", mysqli_connect_error()); exit();}/* activate reporting */$driver = new mysqli_driver();$driver->report_mode = MYSQLI_REPORT_ALL;try { /* this query should report an error */ $result = $mysqli->query("SELECT Name FROM Nonexistingtable WHERE population > 50000"); /* this query should report a bad index */ $result = $mysqli->query("SELECT Name FROM City WHERE population > 50000"); $result->close(); $mysqli->close();} catch (mysqli_sql_exception $e) { echo $e->__toString();}?>

Example 22.210. Procedural style

<?php/* activate reporting */mysqli_report(MYSQLI_REPORT_ALL);$link = mysqli_connect("localhost", "my_user", "my_password", "world");/* check connection */if (mysqli_connect_errno()) { printf("Connect failed: %s\n", mysqli_connect_error()); exit();}/* this query should report an error */$result = mysqli_query("SELECT Name FROM Nonexistingtable WHERE population > 50000");/* this query should report a bad index */$result = mysqli_query("SELECT Name FROM City WHERE population > 50000");mysqli_free_result($result);mysqli_close($link);?>

See Also

mysqli_debug

mysqli_dump_debug_info

mysqli_sql_exception

set_exception_handler

error_reporting

22.9.3.13. The mysqli_warning class (mysqli_warning)

Represents a MySQL warning.

 mysqli_warning {
 mysqli_warningProperties  public message ;
  public sqlstate ;
  public errno ;
Methods  public mysqli_warning::__construct();
  public void mysqli_warning::next();
}

message: Message string
sqlstate: SQL state
errno: Error number

22.9.3.13.1. mysqli_warning::__construct

mysqli_warning::__construct
The __construct purpose

Description

public mysqli_warning::__construct();

Warning

This function iscurrently not documented; only its argument list is available.

Parameters

This function has no parameters.

Return Values

22.9.3.13.2. mysqli_warning::next

mysqli_warning::next
The next purpose

Description

public void mysqli_warning::next();

Warning

This function iscurrently not documented; only its argument list is available.

Parameters

This function has no parameters.

Return Values

22.9.3.14. The mysqli_sql_exception class (mysqli_sql_exception)

The mysqli exception handling class.

 mysqli_sql_exception {
 mysqli_sql_exception, extends RuntimeExceptionProperties  protected code ;
  protected sqlstate ;
}

message: The error message.
file: The file with the error.
line: The line with the error.
code: The code causing the error.
sqlstate: The sql state with the error.

22.9.3.15. Aliases and deprecated Mysqli Functions

22.9.3.15.1. mysqli_bind_param

mysqli_bind_param
Alias for mysqli_stmt_bind_param

Description

This function is an alias of mysqli_stmt_bind_param.

Warning

This function has beenDEPRECATED as of PHP 5.3.0 and REMOVED as of PHP 5.4.0.

See Also

22.9.3.15.2. mysqli_bind_result

mysqli_bind_result
Alias for mysqli_stmt_bind_result

Description

This function is an alias of mysqli_stmt_bind_result.

Warning

This function has beenDEPRECATED as of PHP 5.3.0 and REMOVED as of PHP 5.4.0.

See Also

mysqli_real_escape_string

22.9.3.15.3. mysqli_client_encoding

mysqli_client_encoding
Alias of mysqli_character_set_name

Description

This function is an alias of mysqli_character_set_name.

Warning

This function has beenDEPRECATED as of PHP 5.3.0 and REMOVED as of PHP 5.4.0.

See Also

22.9.3.15.4. mysqli_connect

mysqli_connect
Alias of mysqli::__construct

Description

This function is an alias of: mysqli::__construct

22.9.3.15.5. mysqli::disable_reads_from_master,mysqli_disable_reads_from_master

mysqli::disable_reads_from_master
mysqli_disable_reads_from_master
Disable reads from master

Description

Object oriented style

void mysqli::disable_reads_from_master();

Procedural style

bool mysqli_disable_reads_from_master(mysqli link);

Warning

This function iscurrently not documented; only its argument list is available.

Warning

This function has beenDEPRECATED and REMOVED as of PHP 5.3.0.

22.9.3.15.6. mysqli_disable_rpl_parse

mysqli_disable_rpl_parse
Disable RPL parse

Description

bool mysqli_disable_rpl_parse(mysqli link);

Warning

This function iscurrently not documented; only its argument list is available.

Warning

This function has beenDEPRECATED and REMOVED as of PHP 5.3.0.

22.9.3.15.7. mysqli_enable_reads_from_master

mysqli_enable_reads_from_master
Enable reads from master

Description

bool mysqli_enable_reads_from_master(mysqli link);

Warning

This function iscurrently not documented; only its argument list is available.

Warning

This function has beenDEPRECATED and REMOVED as of PHP 5.3.0.

22.9.3.15.8. mysqli_enable_rpl_parse

mysqli_enable_rpl_parse
Enable RPL parse

Description

bool mysqli_enable_rpl_parse(mysqli link);

Warning

This function iscurrently not documented; only its argument list is available.

Warning

This function has beenDEPRECATED and REMOVED as of PHP 5.3.0.

22.9.3.15.9. mysqli_escape_string

mysqli_escape_string
Alias of mysqli_real_escape_string

Description

This function is an alias of: mysqli_real_escape_string.

22.9.3.15.10. mysqli_execute

mysqli_execute
Alias for mysqli_stmt_execute

Description

This function is an alias of mysqli_stmt_execute.

Notes

Note

mysqli_execute is deprecated and will be removed.

See Also

22.9.3.15.11. mysqli_fetch

mysqli_fetch
Alias for mysqli_stmt_fetch

Description

This function is an alias of mysqli_stmt_fetch.

Warning

This function has beenDEPRECATED as of PHP 5.3.0 and REMOVED as of PHP 5.4.0.

See Also