RTSQLDatabase


Conforms To:
NSObject
Declared In:
RTSQLDatabase.h


Protocol Description

Protocol for a "database". Each RTSQLSession has a list of RTSQLDatabases, which represent a collection of tables and views on the remote server. In terms of the SQL standard, this is a Schema, but it is called a database for legacy reasons. The following table lists the terminology used for this object in each database implementation.

FrontBaseSchema
MicrosoftSQL Server Owner
MySQLDatabase
OpenBaseSchema
OracleUser
PostgreSQLFor versions prior to 7.3, none. MacSQL creates fakes schemas named "USER" and "SYSTEM"
PostgreSQLFor version 7.3 and above, Schema
SybaseOwner


Method Types

- name
- dataLoaded
- invalidateData
- tables
- tableNames
- tableWithName:
- session

Instance Methods

dataLoaded

- (BOOL)dataLoaded

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


invalidateData

- (void)invalidateData

Causes object to invalidate list of tables from server, unloading data.


name

- (NSString*)name

Returns the name of this RTSQLDatabase.


session

- (id <RTSQLSession>)session

returns parent session


tableNames

- (NSArray*)tableNames

Returns array of table names for this database. If dataLoaded == NO, then will contact server form information, could block. Useful for displaying list of table names since key-value coding for tables.name can cause problems if a table has a column named "name".


tableWithName:

- (id <RTSQLTable>)tableWithName:(NSString*)name

Returns the table with the specified name, or nil if no such table exists.


tables

- (NSArray*)tables

Returns array of tables for this database. 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.