PHP MySQLi 函数

PHP mysqli_stmt::result_metadata() / mysqli_stmt_result_metadata() 函数从准备好的语句返回结果集元数据，如果准备好的语句产生一个结果集。返回的结果对象可用于处理字段总数、单个字段信息等元信息。

说明:此返回的结果集函数仅包含元数据。它不包含任何行结果。这些行是通过使用 mysqli_stmt_fetch() 的语句句柄来获取的。

注意:此结果集指针可以作为参数传递给任何处理结果集元数据的基于字段的函数，例如如:
  • 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()

语法

//面向对象风格
public mysqli_stmt::result_metadata()

//面向过程风格
mysqli_stmt_result_metadata(statement)

参数

statement 必需。 仅适用于面向过程风格:指定 mysqli_stmt_init() 返回的 mysqli_stmt 对象。

返回值

返回 true成功并且数据已获取。如果发生错误则返回 false。如果不再存在行/数据或发生数据截断，则返回 null。

示例:面向对象风格

下面的示例显示mysqli_stmt::result_metadata() 的用法 方法。

<?php
//建立与数据库的连接
$mysqli = new mysqli("localhost", "user", "password", "database");
if ($mysqli->connect_errno) {
  echo "Failed to connect to MySQL: ". $mysqli->connect_error;
  exit();
}

$stmt = $mysqli>prepare("SELECT Name, Age FROM Employee ORDER BY Age");

//执行SQL语句
$stmt->execute();

//获取元数据结果集
$result = $stmt->result_metadata();

//获取所有字段信息
//元数据结果集中的列
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();

//关闭连接
$mysqli->close();
?>

上述代码的输出将类似于:

Name:     Name
Table:    Employee
max. Len: 50
Flags:    1
Type:     254

Name:     Age
Table:    Employee
max. Len: 10
Flags:    32769
Type:     4

示例:面向过程风格

示例下面显示了 mysqli_stmt_result_metadata() 函数的用法。

<?php
//建立与数据库的连接
$mysqli = mysqli_connect("localhost", "user", "password", "database");
if (mysqli_connect_errno()) {
  echo "Failed to connect to MySQL: ". mysqli_connect_error();
  exit();
}

$stmt = mysqli_prepare($mysqli, "SELECT Name, Age FROM Employee ORDER BY Age");

//执行SQL语句
mysqli_stmt_execute($stmt);

//获取元数据结果集
$result = mysqli_stmt_result_metadata($stmt);

//获取所有字段信息
//元数据结果集中的列
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);

//关闭连接
mysqli_close($mysqli);
?>

上述代码的输出将类似于:

Name:     Name
Table:    Employee
max. Len: 50
Flags:    1
Type:     254

Name:     Age
Table:    Employee
max. Len: 10
Flags:    32769
Type:     4