ADOdb

Database Abstraction Layer for PHP

User Tools

Site Tools


v5:dictionary:metacolumns

metaColumns

obj[] metaColumns(
     string $tableName,
     optional bool $normalize=false
     )

Description

The function metaColumns() returns an array of adoFieldObject objects, each representing a description of each field of the requested table or view in the passed value $tableName. Each database returns a core set of descriptions, plus additional information. See the driver documentation for more information.

The formatting of the array cannot be controlled by ADODB_ASSOC_CASE, the following casing occurs:

  • Field name (array key) - if the current value of $ADODB_FETCH_MODE is ADODB_FETCH_NUM, then the keys are returned as a numeric array, otherwise they are returned as an Upper Case key containing the name of the field.
  • Information keys - Lower Case
  • Information - Lower Case

Usage

/*
 * Assume DB2 connection
 */
$ar = $db->metaColumns('ACT');
print_r($ar);
/*
 * Returns
Array
(
    [ACTNO] => ADOFieldObject Object
        (
            [name] => ACTNO
            [max_length] => 2
            [type] => I
            [not_null] =>
            [scale] => 0
            [primary_key] => 1
        )
 
    [ACTKWD] => ADOFieldObject Object
        (
            [name] => ACTKWD
            [max_length] => 6
            [type] => C
            [not_null] =>
            [scale] =>
            [primary_key] =>
        )
 
    [ACTDESC] => ADOFieldObject Object
        (
            [name] => ACTDESC
            [max_length] => 20
            [type] => C
            [not_null] =>
            [scale] =>
            [primary_key] =>
        )
 
)
*/
v5/dictionary/metacolumns.txt · Last modified: 2018/07/01 22:18 by peterdd