RTSQLTable


Conforms To:
NSObject
Declared In:
RTSQLTable.h


Protocol Description

Protocol for a table. (Also represents views and synonyms).


Method Types

- name
- database
- isView
- isSynonym
- dataLoaded
- invalidateData
- columns
- indexes
- constraints
- foreignKeys
- checkConstraints
- sqlCreationString
- columnWithName:
- indexOfColumn:
- indexOfColumnNamed:

Instance Methods

checkConstraints

- (NSArray*)checkConstraints

Returns subset of constraints that are checks. If dataLoaded == NO, then will contact server for information, which could result in blocking the current thread.


columnWithName:

- (id <RTSQLColumn>)columnWithName:(NSString*)name

Returns column with the specified name, or nil if there is no such column.


columns

- (NSArray*)columns

Returns array of columns for this table. If dataLoaded == NO, then will contact server for information, which could result in blocking the current thread.


constraints

- (NSArray*)constraints

Returns array of constraints for this table. If dataLoaded == NO, then will contact server for information, which could result in blocking the current thread.


dataLoaded

- (BOOL)dataLoaded

If returns NO, documented methods could require network traffic to the remote server


database

- (id <RTSQLDatabase>)database

Returns the database this table belongs to.


foreignKeys

- (NSArray*)foreignKeys

Returns subset of constraints that are foreign keys. If dataLoaded == NO, then will contact server for information, which could result in blocking the current thread.


indexOfColumn:

- (unsigned long)indexOfColumn:(id <RTSQLColumn>)col

Returns the index of col or NSNotFound if not found.


indexOfColumnNamed:

- (unsigned long)indexOfColumnNamed:(NSString*)colName

Returns the index of the column named colName or NSNotFound if not found.


indexes

- (NSArray*)indexes

Returns array of indexes for this table. If dataLoaded == NO, then will contact server for information, which could result in blocking the current thread.


invalidateData

- (void)invalidateData

Causes the invalidation of all column, index, and constraint objects belonging to this table. The next time any of them are requested, they will be refetched from the server.


isSynonym

- (BOOL)isSynonym

Returns YES if this object represents a SQL Synonym.


isView

- (BOOL)isView

Returns YES if this object represents a SQL View.


name

- (NSString*)name

Returns the name of this table.


sqlCreationString

- (NSString*)sqlCreationString

Returns SQL creation string for the table. If dataLoaded == NO, then will contact server for information, which could result in blocking the current thread.


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