Возвращает метаданные результирующей таблицы подготавливаемого запроса

# mysqli_stmt::result_metadata

# mysqli_stmt_result_metadata

(PHP 5, PHP 7, PHP 8)

mysqli_stmt::result_metadata -- mysqli_stmt_result_metadata — Возвращает метаданные результирующей таблицы подготавливаемого запроса

### Описание

Объектно-ориентированный стиль

public function mysqli_stmt::result_metadata(): mysqli_result|false

Процедурный стиль

function mysqli_stmt_result_metadata(mysqli_stmt `$statement`): mysqli_result|false

Если запрос, переданный в mysqli_prepare(), генерирует результирующую таблицу, mysqli_stmt_result_metadata() возвращает объект, с помощью которого можно получить описание этого результирующего набора. В частности, можно получить количество полей и описание каждого отдельного поля.

Функция возвращает пустой объект mysqli_result, который можно использовать для доступа к метаданным из подготовленного запроса без необходимости извлекать фактические строки данных. Нет необходимости использовать её при использовании функции mysqli_stmt_get_result() для извлечения всего набора результатов из подготовленного запроса в виде объекта результата.

> Замечание:

> Полученный объектный указатель можно передавать в качестве аргумента в функции обработки метаданных результирующих таблиц, как например:

> - mysqli_num_fields()

> - mysqli_fetch_field()

> - mysqli_fetch_field_direct()

> - mysqli_fetch_fields()

> - mysqli_field_count()

> - mysqli_field_seek()

> - mysqli_field_tell()

> - mysqli_free_result()

> Замечание: Результирующий набор, возвращаемый из mysqli_stmt_result_metadata(), содержит только метаданные. В нем не будет строк выборки. Результаты запроса можно получить с помощью функции mysqli_stmt_fetch().

### Список параметров

`stmt`
  Только для процедурного стиля: объект mysqli_stmt, который вернула функция mysqli_stmt_init().

### Возвращаемые значения

Возвращает объект или `false` случае возникновения ошибки. Если оператор не возвращает набор результатов, также возвращается значение `false`.

### Ошибки

Если уведомления об ошибках mysqli включены (`MYSQLI_REPORT_ERROR`) и запрошенная операция не удалась, выдаётся предупреждение. Если, кроме того, установлен режим `MYSQLI_REPORT_STRICT`, вместо этого будет выброшено исключение mysqli_sql_exception.

### Примеры

Пример #1 Объектно-ориентированный стиль

    <?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();

    /* получаем результирующий набор метаданных */
    $result = $stmt->result_metadata();

    /* извлекаем информацию о столбце из метаданных */
    $field = $result->fetch_field();

    printf("Имя столбца: %s\n", $field->name);
    ?>

Пример #2 Процедурный стиль

    <?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);

    /* получаем результирующий набор метаданных */
    $result = mysqli_stmt_result_metadata($stmt);

    /* извлекаем информацию о столбце из метаданных */
    $field = mysqli_fetch_field($result);

    printf("Имя столбца: %s\n", $field->name);
    ?>

### Смотрите также

- mysqli_prepare() - Подготавливает SQL выражение к выполнению
- mysqli_free_result() - Освобождает память, занятую результатами запроса
- mysqli_stmt_get_result() - Получает результат из подготовленного запроса в виде объекта mysqli_result

`↑` and `↓` to navigate • `Enter` to select • `Esc` to close • `/` to open