db2_special_columns

(PECL ibm_db2 >= 1.0.0)

db2_special_columns — Returns a result set listing the unique row identifier columns for a table

Description

db2_special_columns(
    resource $connection,
    ?string $qualifier,
    string $schema,
    string $table_name,
    int $scope
): resource

Returns a result set listing the unique row identifier columns for a table.

Parameters

connection
A valid connection to an IBM DB2, Cloudscape, or Apache Derby database.
qualifier
A qualifier for DB2 databases running on OS/390 or z/OS servers. For other databases, pass null or an empty string.
schema
The schema which contains the tables.
table_name
The name of the table.
scope

Integer value representing the minimum duration for which the unique row identifier is valid. This can be one of the following values:

Integer valueSQL constantDescription
0SQL_SCOPE_CURROWRow identifier is valid only while the cursor is positioned on the row.
1SQL_SCOPE_TRANSACTIONRow identifier is valid for the duration of the transaction.
2SQL_SCOPE_SESSIONRow identifier is valid for the duration of the connection.

Return Values

Returns a statement resource with a result set containing rows with unique row identifier information for a table. The rows are composed of the following columns:

Column nameDescription
SCOPE
Integer valueSQL constantDescription
0SQL_SCOPE_CURROWRow identifier is valid only while the cursor is positioned on the row.
1SQL_SCOPE_TRANSACTIONRow identifier is valid for the duration of the transaction.
2SQL_SCOPE_SESSIONRow identifier is valid for the duration of the connection.
COLUMN_NAMEName of the unique column.
DATA_TYPESQL data type for the column.
TYPE_NAMECharacter string representation of the SQL data type for the column.
COLUMN_SIZEAn integer value representing the size of the column.
BUFFER_LENGTHMaximum number of bytes necessary to store data from this column.
DECIMAL_DIGITSThe scale of the column, or null where scale is not applicable.
NUM_PREC_RADIXAn integer value of either 10 (representing an exact numeric data type), 2 (representing an approximate numeric data type), or null (representing a data type for which radix is not applicable).
PSEUDO_COLUMNAlways returns 1.

See Also