odbc_specialcolumns
(PHP 4, PHP 5, PHP 7, PHP 8)
odbc_specialcolumns — Retrieves special columns
Description
resource
$odbc,int
$type,?string
$catalog,string
$schema,string
$table,int
$scope,int
$nullable): resource|false
Retrieves either the optimal set of columns that uniquely identifies a row in the table, or columns that are automatically updated when any value in the row is updated by a transaction.
Parameters
-
odbc -
The ODBC connection identifier, see odbc_connect() for details.
-
type -
When the type argument is
SQL_BEST_ROWID, odbc_specialcolumns() returns the column or columns that uniquely identify each row in the table. When the type argument isSQL_ROWVER, odbc_specialcolumns() returns the column or columns in the specified table, if any, that are automatically updated by the data source when any value in the row is updated by any transaction. -
catalog -
The catalog ('qualifier' in ODBC 2 parlance).
-
schema -
The schema ('owner' in ODBC 2 parlance).
-
table -
The table.
-
scope -
The scope, which orders the result set. One of
SQL_SCOPE_CURROW,SQL_SCOPE_TRANSACTIONorSQL_SCOPE_SESSION. -
nullable -
Determines whether to return special columns that can have a NULL value. One of
SQL_NO_NULLSorSQL_NULLABLE.
Return Values
Returns an ODBC result identifier or false on
failure.
The result set has the following columns:
SCOPECOLUMN_NAMEDATA_TYPETYPE_NAMECOLUMN_SIZEBUFFER_LENGTHDECIMAL_DIGITSPSEUDO_COLUMN
The result set is ordered by SCOPE.
