RTSQLColumn


Conforms To:
NSObject
Declared In:
RTSQLColumn.h


Protocol Description

Protocol for a column in a table or result set.


Method Types

- name
- table
- dataType
- nativeDataType
- nullsAllowed
- autoIncrement
- readOnly
- unsignedValue
- size
- scale
- defaultValue
- fullTypeString
- fullTypeStringWithSize
- sqlCreationString

Instance Methods

autoIncrement

- (BOOL)autoIncrement

Returns YES if this column contains autoincrement/identity values.


dataType

- (id <RTSQLDataType>)dataType

Returns the dataType of the column. Might be unknown for columns belonging to a result set (such as calculation).


defaultValue

- (NSString*)defaultValue

Returns the default value for this column. Not available for result set columns.


fullTypeString

- (NSString*)fullTypeString

Returns the full type string for this column. Not available for result set columns.


fullTypeStringWithSize

- (NSString*)fullTypeStringWithSize

Returns the full type string for this column with size/scale parameters. Not available for result set columns.


name

- (NSString*)name

Returns the name of this column.


nativeDataType

- (UInt32)nativeDataType

Returns the native data type constant for values of this column.


nullsAllowed

- (BOOL)nullsAllowed

Returns YES if null values are allowed.


readOnly

- (BOOL)readOnly

Returns YES if this column is read-only.


scale

- (UInt32)scale

For columns with decimal values, returns the maximum number of digits to the right of the decimal.


size

- (SInt32)size

Returns the maximum length/size of values in this column. Returns zero if not-applicable to the data type (such as for fixed-width values.


sqlCreationString

- (NSString*)sqlCreationString

Returns the complete line for this column in a create table statement. Not available for result set columns.


table

- (id <RTSQLTable>)table

Returns table column belongs to. Might return nil if this column belongs to an RTResultSet and the corresponding table is unknown.


unsignedValue

- (BOOL)unsignedValue

Is this column an unsigned numeric value?


Copyright ©2006 by Runtime Labs, Inc.. All Rights Reserved.