php man page for db2_special_columns

DB2_SPECIAL_COLUMNS(3)							 1						    DB2_SPECIAL_COLUMNS(3)

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

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

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

PARAMETERS
	      o $connection
		- A valid connection to an IBM DB2, Cloudscape, or Apache Derby database.

	      o $qualifier
		- A qualifier for DB2 databases running on OS/390 or z/OS servers. For other databases, pass NULL or an empty string.

	      o $schema
		- The schema which contains the tables.

	      o $table_name
		- The name of the table.

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

	      +--------------+--------------------------------------+---+
	      |Integer value |					    |	|
	      | 	     |					    |	|
	      | 	     |		   SQL constant 	    |	|
	      | 	     |					    |	|
	      | 	     |		   Description		    |	|
	      | 	     |					    |	|
	      +--------------+--------------------------------------+---+
	      |      0	     |					    |	|
	      | 	     |					    |	|
	      | 	     |		 SQL_SCOPE_CURROW	    |	|
	      | 	     |					    |	|
	      | 	     | Row identifier is valid	only  while |	|
	      | 	     | the cursor is positioned on the row. |	|
	      | 	     |					    |	|
	      |      1	     |					    |	|
	      | 	     |					    |	|
	      | 	     |	      SQL_SCOPE_TRANSACTION	    |	|
	      | 	     |					    |	|
	      | 	     | Row  identifier	is  valid  for	the |	|
	      | 	     | duration of the transaction.	    |	|
	      | 	     |					    |	|
	      |      2	     |					    |	|
	      | 	     |					    |	|
	      | 	     |		SQL_SCOPE_SESSION	    |	|
	      | 	     |					    |	|
	      | 	     | Row  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 name |							|
       |	    |							|
       |	    |			 Description			|
       |	    |							|
       +------------+---------------------------------------------------+
       |   SCOPE    |							|
       |	    |							|
       |	    |							|
       |	    |							|
       |	    |	     box, tab (|); c | c | c |	.   T{	Integer |
       |	    |	     value					|
       |	    |							|
       |	    |			SQL constant			|
       |	    |							|
       |	    |			 Description			|
       |	    |							|
       +------------+---------------------------------------------------+
       |     0	    |							|
       |	    |							|
       |	    |		      SQL_SCOPE_CURROW			|
       |	    |							|
       |	    | Row  identifier is valid only while the cursor is |
       |	    | positioned on the row.				|
       |	    |							|
       |     1	    |							|
       |	    |							|
       |	    |		    SQL_SCOPE_TRANSACTION		|
       |	    |							|
       |	    | Row identifier is valid for the duration	of  the |
       |	    | transaction.					|
       |	    |							|
       |     2	    |							|
       |	    |							|
       |	    |		      SQL_SCOPE_SESSION 		|
       |	    |							|
       |	    | Row  identifier  is valid for the duration of the |
       |	    | connection.					|
       |	    |							|
       +------------+---------------------------------------------------+
       T} T{ COLUMN_NAME

       T} |T{ Name of the unique column.

       T} T{ DATA_TYPE

       T} |T{ SQL data type for the column.

       T} T{ TYPE_NAME

       T} |T{ Character string representation of the SQL data type for the column.

       T} T{ COLUMN_SIZE

       T} |T{ An integer value representing the size of the column.

       T} T{ BUFFER_LENGTH

       T} |T{
	Maximum number of bytes necessary to store data from this column.

       T} T{ DECIMAL_DIGITS

       T} |T{
	The scale of the column, or NULL where scale is not applicable.

       T} T{ NUM_PREC_RADIX

       T} |T{
	An integer value of either 10 (representing an exact numeric data type), 2 (representing an approximate numeric data type), or NULL  (rep-
       resenting a data type for which radix is not applicable).

       T} T{ PSEUDO_COLUMN

       T} |T{ Always returns 1.

       T}

SEE ALSO
       db2_column_privileges(3),  db2_columns(3),  db2_foreign_keys(3), db2_primary_keys(3), db2_procedure_columns(3), db2_procedures(3), db2_sta-
       tistics(3), db2_table_privileges(3), db2_tables(3).

PHP Documentation Group 												    DB2_SPECIAL_COLUMNS(3)