PHP mysqli_stmt_result_metadata() Function

Definition and Usage

The mysqli_stmt_result_metadata() function accepts a prepared statement object as a parameter and, if the given statement executes a SELECT query (or any other query that returns resultset), it (this function) returns a metadata object which holds information about the resultset of the given statement.

Syntax

mysqli_stmt_result_metadata($stmt);

Parameters

Return Values

The PHP mysqli_stmt_result_metadata() function returns a metadata object on success and false on failure.

PHP Version

This function was first introduced in PHP Version 5 and works works in all the later versions.

Example

Following example demonstrates the usage of the mysqli_stmt_result_metadata() function (in procedural style) −

<?php
   $con = mysqli_connect("localhost", "root", "password", "mydb");

   mysqli_query($con, "CREATE TABLE test(Name VARCHAR(255), age INT)");
   mysqli_query($con, "INSERT INTO test values('Raju', 25)");
   mysqli_query($con, "INSERT INTO test values('Jonathan', 30)");
   print("Table Created.....\n");

   //Retrieving the contents of the table
   $stmt = mysqli_prepare($con, "SELECT * FROM test");

   //Executing the statement
   mysqli_stmt_execute($stmt);

   //Retrieving the resultset metadata
   $metadata = mysqli_stmt_result_metadata($stmt);
   print_r(mysqli_fetch_fields($metadata));
 
   mysqli_free_result($metadata);

   //Closing the connection
   mysqli_close($con);
?>

This will produce following result −

Table Created.....
Array
(
    [0] => stdClass Object
        (
            [name] => Name
            [orgname] => Name
            [table] => test
            [orgtable] => test
            [def] =>
            [db] => mydb
            [catalog] => def
            [max_length] => 0
            [length] => 765
            [charsetnr] => 33
            [flags] => 0
            [type] => 253
            [decimals] => 0
        )

    [1] => stdClass Object
        (
            [name] => AGE
            [orgname] => AGE
            [table] => test
            [orgtable] => test
            [def] =>
            [db] => mydb
            [catalog] => def
            [max_length] => 0
            [length] => 11
            [charsetnr] => 63
            [flags] => 32768
            [type] => 3
            [decimals] => 0
        )

)

Example

In object oriented style the syntax of this function is $stmt->result_metadata(); Following is the example of this function in object oriented style $minus;

<?php
   //Creating a connection
   $con = new mysqli("localhost", "root", "password", "mydb");

   $con -> query("CREATE TABLE Test(Name VARCHAR(255), AGE INT)");
   $con -> query("insert into Test values('Raju', 25),('Rahman', 30),('Sarmista', 27)");
   print("Table Created.....\n");

   $stmt = $con -> prepare( "SELECT * FROM Test WHERE Name in(?, ?)");
   $stmt -> bind_param("ss", $name1, $name2);
   $name1 = 'Raju';
   $name2 = 'Rahman';
   print("Records Inserted.....\n");

   //Executing the statement
   $stmt->execute();

   //Retrieving the resultset metadata
   $metadata = $stmt->result_metadata();

   $field = $metadata->fetch_field();
   print("Field Name: ".$field->name);

   //Closing the statement
   $stmt->close();

   //Closing the connection
   $con->close();
?>

This will produce following result −

Table Created.....
Records Inserted.....
Field Name: Name