com.aspc.commander.sql

Class VersionColumnsCommand

java.lang.Object

com.aspc.commander.Command

com.aspc.commander.sql.SQLCommand

com.aspc.commander.sql.VersionColumnsCommand

All Implemented Interfaces:

CommandBuildResultsPlugin

public class VersionColumnsCommand
extends SQLCommand

Retrieves a description of a table's columns that are automatically updated when any value in a row is updated. They are unordered.

Each column description has the following columns:

SCOPE short => is not used
COLUMN_NAME String => column name
DATA_TYPE int => SQL data type from "java.sql.Types"
TYPE_NAME String => Data source-dependent type name
COLUMN_SIZE int => precision
BUFFER_LENGTH int => length of column value in bytes
DECIMAL_DIGITS short => scale
PSEUDO_COLUMN short => whether this is pseudo column like an Oracle ROWID
* versionColumnUnknown - may or may not be pseudo column
* versionColumnNotPseudo - is NOT a pseudo column
* versionColumnPseudo - is a pseudo column

catalog_name a catalog name; must match the catalog name as it is stored in the database; "" retrieves those without a catalog; NULL means that the catalog name should not be used to narrow the search

schema_name a schema name; must match the schema name as it is stored in the database; "" retrieves those without a schema; NULL means that the schema name should not be used to narrow the search

table_name a table name; must match the table name as it is stored in the database
Syntax

  VERSION_COLUMNS CATALOG catalog_name SCHEMA schema_name TABLE table_name
  

THREAD MODE: SINGLE THREADED command

Since:

3 December 2003

Author:

Nigel Leck

Field Summary

Fields inherited from class com.aspc.commander.sql.SQLCommand

CURSOR_SIZE

Constructor Summary

Constructors

Constructor and Description
VersionColumnsCommand(Connection connection, Pattern pattern) std.

Method Summary

Modifier and Type	Method and Description
protected void	execute(Parser p) execute the command.
java.lang.String	getColumnName(int col) the column name
java.lang.String	getColumnType(int col) Gets the column type for the given column index, starting at one
java.lang.String	getRecordID(int row) the record ID
java.lang.Object	getValue(int row, int col) the value for this row, column

Methods inherited from class com.aspc.commander.sql.SQLCommand

appendResult, appendResult, getCursorName, getRecordKey, isExecuteOnly

Methods inherited from class com.aspc.commander.Command

execute, extMakeThreadName, getConnection, getPattern, getRawTitle, getTitle, makeThreadName, recordCall, setTitle

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.aspc.commander.sql.results.CommandBuildResultsPlugin

getRawTitle

Constructor Detail

VersionColumnsCommand

public VersionColumnsCommand(Connection connection,
                             Pattern pattern)

std. Command.

Parameters:

connection - the connection

pattern - the pattern

Method Detail

execute

protected void execute(Parser p)
                throws java.lang.Exception

execute the command.

Specified by:

execute in class Command

Parameters:

p - The parser

Throws:

java.lang.Exception - A serious problem

getColumnName

public java.lang.String getColumnName(int col)

the column name

Parameters:

col - the column

Returns:

the name

getColumnType

public java.lang.String getColumnType(int col)

Gets the column type for the given column index, starting at one

Parameters:

col - the column index

Returns:

String the column type

getRecordID

public java.lang.String getRecordID(int row)

the record ID

Parameters:

row - the row index

Returns:

the record ID

getValue

public java.lang.Object getValue(int row,
                                 int col)

the value for this row, column

Parameters:

row - the row index

col - the column

Returns:

Object the value for the given row and column