mysqli_result::fetch_field_direct
, mysqli_fetch_field_direct
mysqli_result::fetch_field_direct
mysqli_fetch_field_direct
Fetch meta-data for a single field
Description
Object oriented styleobject mysqli_result::fetch_field_direct(int fieldnr);
Procedural styleobject mysqli_fetch_field_direct(mysqli_result result,
int fieldnr);
Returns an object which contains field definition information from the specified result set.
Parameters
result
-
Procedural style only: A result set identifier returned by
mysqli_query
,mysqli_store_result
ormysqli_use_result
. fieldnr
-
The field number. This value must be in the range from
0
tonumber of fields - 1
.
Return Values
Returns an object which contains field definition information or FALSE
if no field information for specified fieldnr
is available.
Table 20.21. 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 table 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 20.184. 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 20.185. 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 examples will output:
Name: SurfaceArea Table: Country max. Len: 10 Flags: 32769 Type: 4
See Also
mysqli_num_fields
|
mysqli_fetch_field
|
mysqli_fetch_fields |