PHP Manual
Prev |  | Next

# fbsql_fetch_field

(PHP 4 >= 4.0.6)

fbsql_fetch_field -- Get column information from a result and return as an object

## Description

``object fbsql_fetch_field` (resource result, int [field_offset])`

Returns an object containing field information.

fbsql_fetch_field() can be used in order to obtain information about fields in a certain query result. If the field offset isn't specified, the next field that wasn't yet retrieved by fbsql_fetch_field() is retrieved.

The properties of the object are:

- name - column name

- table - name of the table the column belongs to

- max_length - maximum length of the column

- not_null - 1 if the column cannot be `NULL`

- type - the type of the column

Example 1. fbsql_fetch_field() example
    <?php
    fbsql_connect ($host, $user, $password)
        or die ("Could not connect");
    $result = fbsql_db_query ("database", "select * from table")
        or die ("Query failed");
    # get column metadata
    $i = 0;
    while ($i < fbsql_num_fields ($result)) {
        echo "Information for column $i:<BR>\n";
        $meta = fbsql_fetch_field ($result);
        if (!$meta) {
            echo "No information available<BR>\n";
        }
        echo "<PRE>
    max_length:   $meta->max_length
    name:         $meta->name
    not_null:     $meta->not_null
    table:        $meta->table
    type:         $meta->type
    </PRE>";
        $i++;
    }
    fbsql_free_result ($result);
    ?>

See also fbsql_field_seek().

Prev | Home | Next
fbsql_fetch_assoc | Up | fbsql_fetch_lengths