View / Download this file.
----------------------------------------
PTMDB MODULE - db_get_columns() FUNCTION
----------------------------------------
------------
USAGE FORMAT
------------
Where @cols is a list of returned column/field names:
@cols = &db_get_columns($db_object, $table_name);
@cols = &db_get_columns($db_object, $table_name, $db_name);
-----------
DESCRIPTION
-----------
Retreives a list of column headers 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 containing the column header names
from the given database table.
---------
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 headers.
$db_name
OPTIONAL / REQUIRED
The name of the database from which to pull table column headers. 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
-------
A list (array) containing the column header names from the selected table
in the order in which they were returned from the database server.
--------------
USAGE EXAMPLES
--------------
------------------------------------------------------------
Example 1: Display the Column Names from the Table 'MyTable'
------------------------------------------------------------
<?= join(', ', &db_get_columns($dbobj, 'MyTable')) =?>
|