cubrid_fetch_field

Description

The cubrid_fetch_field() function is used to return an object containing field information. This function can be used to obtain information about fields in the provided query result. The properties of the object are:

• name : Column name
• table : Name of the table where the column belongs
• def : Default value of the column
• max_length : Maximum length of the column
• not_null : 1 if the column cannot be NULL
• unique_key : 1 if the column is a unique key
• multiple_key : 1 if the column is a non-unique key
• numeric : 1 if the column is numeric
• type : The type of the column

Syntax

object cubrid_fetch_field ( resource $result [, int $field_offset= 0 ] )

• result : Result that comes from a call to cubrid_execute()
• field_offset : The numerical field offset. If the field offset is not specified, the next field that was not yet retrieved by this function is retrieved. The field_offset starts at 0.

Return Value

• Success: Object with certain properties of the specific column
• Failure or the end is reached : FALSE

Example

< ?php

$conn = cubrid_connect("localhost", 33000, "demodb");

$req = cubrid_execute($conn, "SELECT event_code,athlete_code,nation_code,game_date FROM game WHERE host_year=1988 and event_code=20001;");

var_dump(cubrid_fetch_row($req));

cubrid_field_seek($req, 1);

$field = cubrid_fetch_field($req);

printf("\n--- Field Properties ---\n");

printf("%-30s %s\n", "name:", $field->name);

printf("%-30s %s\n", "table:", $field->table);

printf("%-30s \"%s\"\n", "default value:", $field->def);

printf("%-30s %d\n", "max lenght:", $field->max_length);

printf("%-30s %d\n", "not null:", $field->not_null);

printf("%-30s %d\n", "unique key:", $field->unique_key);

printf("%-30s %d\n", "multiple key:", $field->multiple_key);

printf("%-30s %d\n", "numeric:", $field->numeric);

printf("%-30s %s\n", "type:", $field->type);

cubrid_close_request($req);

cubrid_disconnect($conn);

?>

The above example will output:

array(4) {

    [0]=>

    string(5) "20001"

    [1]=>

    string(5) "16681"

    [2]=>

    string(3) "KOR"

    [3]=> string(9) "1988-9-30"

}

--- Field Properties ---

name:                     athlete_code

table:                    game

default value:            ""

max lenght:               5

not null:                 1

unique key:               1

multiple key:             0

numeric:                  1

type:                     integer