View / Download this file.
---------------------------------------------
PTMDB MODULE - db_get_column_stats() FUNCTION
---------------------------------------------
------------
USAGE FORMAT
------------
Where @stats is a returned array of array references:
@stats = &db_get_column_stats($db_object, $table_name);
@stats = &db_get_column_stats($db_object, $table_name, $db_name);
-----------
DESCRIPTION
-----------
Retreives column information from a given database table. If a database
has already been selected, the only required parameters are the database
object and a table name. If a database has not been selected, or you wish
to list columns from a table in another database, a database name is
required as well. Returns an array of array references, each containing one
column's statistics.
---------
ARGUMENTS
---------
$db_object
REQUIRED
A database handler object. This object stores connection information and
is returned from a db_connect() function call. This object is of the same
type as is returned by a DBI->connect function call.
$table_name
REQUIRED
The name of the table from which you would like to pull column
information.
$db_name
OPTIONAL / REQUIRED
The name of the database from which to pull table column data. This is
only required if a database has not yet been selected using the
db_select_database() function or an SQL 'USE' statement, or alternately if
you wish to pull table column headers from a different database than the
one currently selected.
-------
RETURNS
-------
An array of array references. Each array reference contains information
about one column from the selected table. This information can vary
depending on database type. See your database documentation for the
"SHOW COLUMNS" SQL query. MySQL, for example, returns column information
in the following order:
Field Name, Type, Null, Key, Default, Extra
--------
SEE ALSO
--------
MODULES
PTMDB
FUNCTIONS
PTMDB - db_select_database()
|