Last updated: Fri, 28 Nov 2008

mysqli_result::fetch_field_direct

mysqli_fetch_field_direct

(PHP 5)

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

Description

Object oriented style (method):

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 informations from specified resultset.

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.

**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 tabl 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 #1 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 #2 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 example will output:

Name:     SurfaceArea
Table:    Country
max. Len: 10
Flags:    32769
Type:     4


According to

http://www.redferni.uklinux.net/mysql/MySQL-Protocol.html



Data type values are:



DECIMAL           0       ENUM           247

TINY              1       SET            248

SHORT             2       TINY_BLOB      249

LONG              3       MEDIUM_BLOB    250

FLOAT             4       LONG_BLOB      251

DOUBLE            5       BLOB           252

NULL              6       VAR_STRING     253

TIMESTAMP         7       STRING         254

LONGLONG          8       GEOMETRY       255

INT24             9

DATE             10

TIME             11

DATETIME         12

YEAR             13

NEWDATE          14



Note that this is not tested and does not contain

all the values noted by deluxmozart

cjs at ashdowntech dot com
12-Sep-2008 08:00


According to

dev.mysql.com/sources/doxygen/mysql-5.1/mysql__com_8h-source.html

the flag bits are:

 

 NOT_NULL_FLAG          1         /* Field can't be NULL */

 PRI_KEY_FLAG           2         /* Field is part of a primary key */

 UNIQUE_KEY_FLAG        4         /* Field is part of a unique key */

 MULTIPLE_KEY_FLAG      8         /* Field is part of a key */

 BLOB_FLAG             16         /* Field is a blob */

 UNSIGNED_FLAG         32         /* Field is unsigned */

 ZEROFILL_FLAG         64         /* Field is zerofill */

 BINARY_FLAG          128         /* Field is binary   */

 ENUM_FLAG            256         /* field is an enum */

 AUTO_INCREMENT_FLAG  512         /* field is a autoincrement field */

 TIMESTAMP_FLAG      1024         /* Field is a timestamp */

deluxmozart at yahoo dot de
24-Jul-2008 11:05


Here are some Numbers of Datatypes. I searched for it but i didn't find a list, where the datatypes of the numbers are listed.



so first I can give this:



    3    -    Int

    10    -    Date

    246    -    Decimal

    252    -     text

    253    -    VarChar

    254    -    Boolean

add a note

mysqli_result::fetch_field

mysqli_result::fetch_assoc