Documentation Home
Connectors and APIs Manual
Download this Manual

Connectors and APIs Manual  /  ...  /  mysqli_driver::$report_mode, mysqli_report

7.3.11.3 mysqli_driver::$report_mode, mysqli_report

Copyright 1997-2021 the PHP Documentation Group.

  • mysqli_driver::$report_mode

    mysqli_report

    Sets mysqli error reporting mode

Description

Object oriented style

int mysqli_driver->report_mode ;

Procedural style

bool mysqli_report(int flags);

Depending on the flags, it sets mysqli error reporting mode to exception, warning or none. When set to MYSQLI_REPORT_ALL or MYSQLI_REPORT_INDEX it will also inform about queries that don't use an index (or use a bad index).

The default setting is MYSQLI_REPORT_OFF.

Parameters

flags

Table 7.19 Supported flags

NameDescription
MYSQLI_REPORT_OFFTurns reporting off (the default)
MYSQLI_REPORT_ERRORReport errors from mysqli function calls
MYSQLI_REPORT_STRICTThrow mysqli_sql_exception for errors instead of warnings
MYSQLI_REPORT_INDEXReport if no index or bad index was used in a query
MYSQLI_REPORT_ALLSet all options (report all)


Return Values

Returns true.

Examples

Example 7.132 Object oriented style

<?php
/* activate reporting */
$driver = new mysqli_driver();
$driver->report_mode = MYSQLI_REPORT_ALL;
try {
    /* if the connection fails, a mysqli_sql_exception will be thrown */
    $mysqli = new mysqli("localhost", "my_user", "my_password", "my_db");
    /* this query should report an error */
    $result = $mysqli->query("SELECT Name FROM Nonexistingtable WHERE population > 50000");
    /* this query should report a bad index if the column population doesn't have an index */
    $result = $mysqli->query("SELECT Name FROM City WHERE population > 50000");
} catch (mysqli_sql_exception $e) {
    error_log($e->__toString());
}

Example 7.133 Procedural style

<?php
/* activate reporting */
mysqli_report(MYSQLI_REPORT_ALL);
try {
    $link = mysqli_connect("localhost", "my_user", "my_password", "my_db");
    /* this query should report an error */
    $result = mysqli_query($link, "SELECT Name FROM Nonexistingtable WHERE population > 50000");
    /* this query should report a bad index if the column population doesn't have an index */
    $result = mysqli_query($link, "SELECT Name FROM City WHERE population > 50000");
} catch (mysqli_sql_exception $e) {
    error_log($e->__toString());
}

Example 7.134 Error reporting except bad index errors

<?php
/* activate reporting */
mysqli_report(MYSQLI_REPORT_ERROR | MYSQLI_REPORT_STRICT);
try {
    /* if the connection fails, a mysqli_sql_exception will be thrown */
    $mysqli = new mysqli("localhost", "my_user", "my_password", "my_db");
    /* this query should report an error */
    $result = $mysqli->query("SELECT Name FROM Nonexistingtable WHERE population > 50000");
    /* this WILL NOT report any errors even if index is not available */
    $result = $mysqli->query("SELECT Name FROM City WHERE population > 50000");
} catch (mysqli_sql_exception $e) {
    error_log($e->__toString());
}

See Also

mysqli_sql_exception
set_exception_handler
error_reporting