baseten / Sources / BXPGInterface.h

// BXPGInterface.h
// BaseTen
// Copyright (C) 2006-2008 Marko Karppinen & Co. LLC.
// Before using this software, please review the available licensing options
// by visiting or by contacting
// us at Without an additional license, this software
// may be distributed only in compliance with the GNU General Public License.
// This program is free software; you can redistribute it and/or modify
// it under the terms of the GNU General Public License, version 2.0,
// as published by the Free Software Foundation.
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// GNU General Public License for more details.
// You should have received a copy of the GNU General Public License
// along with this program; if not, write to the Free Software
// Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
// $Id$

#import <Foundation/Foundation.h>
#import <BaseTen/BaseTen.h>
#import <BaseTen/BXInterface.h>
#import <BaseTen/PGTSQuery.h>

@class BXPGTransactionHandler;
@class BXPGNotificationHandler;
@class BXPGDatabaseDescription;
@class BXPGQueryBuilder;
@class PGTSConnection;
@class PGTSTableDescription;
@class PGTSFieldDescription;
@class PGTSQuery;

BX_EXPORT NSNumber* BXPGCopyCurrentCompatibilityVersionNumber ();
BX_EXPORT NSString* BXPGReturnList (NSArray* attrs, NSString* alias, BOOL prependAlias);

@interface BXPGInterface : NSObject <BXInterface> 
    BXDatabaseContext* mContext; //Weak
	NSMutableDictionary* mForeignKeys;
	BXPGTransactionHandler* mTransactionHandler;
	NSNumber* mFrameworkCompatVersion;
	BXPGQueryBuilder* mQueryBuilder;
	NSMutableSet* mLockedObjects;
	BOOL mLocking;

- (PGTSTableDescription *) tableForEntity: (BXEntityDescription *) entity error: (NSError **) error;
- (PGTSTableDescription *) tableForEntity: (BXEntityDescription *) entity 
							   inDatabase: (BXPGDatabaseDescription *) database 
									error: (NSError **) error;

- (BXDatabaseContext *) databaseContext;
- (BOOL) fetchForeignKeys: (NSError **) outError;
- (void) setTransactionHandler: (BXPGTransactionHandler *) handler;
- (NSArray *) executeFetchForEntity: (BXEntityDescription *) entity withPredicate: (NSPredicate *) predicate 
					returningFaults: (BOOL) returnFaults class: (Class) aClass forUpdate: (BOOL) forUpdate error: (NSError **) error;
- (NSArray *) observedOids;
- (NSString *) insertQuery: (BXEntityDescription *) entity fieldValues: (NSDictionary *) fieldValues error: (NSError **) error;

- (NSString *) viewDefaultValue: (BXAttributeDescription *) attr error: (NSError **) error;
- (NSString *) recursiveDefaultValue: (NSString *) name entity: (BXEntityDescription *) entity error: (NSError **) error;

- (void) prepareForConnecting;
- (BXPGTransactionHandler *) transactionHandler;

//Some of the methods needed by BaseTen Assistant.
- (BOOL) process: (BOOL) shouldAdd primaryKeyFields: (NSArray *) attributeArray error: (NSError **) outError;
- (BOOL) process: (BOOL) shouldEnable entities: (NSArray *) entityArray error: (NSError **) outError;
- (BOOL) removePrimaryKeyForEntity: (BXEntityDescription *) viewEntity error: (NSError **) outError;

- (BOOL) hasBaseTenSchema;
- (NSNumber *) schemaVersion;
- (NSNumber *) schemaCompatibilityVersion;
- (NSNumber *) frameworkCompatibilityVersion;
- (BOOL) checkSchemaCompatibility: (NSError **) error;

@interface BXPGInterface (ConnectionDelegate)
- (void) connectionSucceeded;
- (void) connectionFailed: (NSError *) error;
- (void) connectionLost: (BXPGTransactionHandler *) handler error: (NSError *) error;

- (FILE *) traceFile;
- (void) connection: (PGTSConnection *) connection sentQueryString: (const char *) queryString;
- (void) connection: (PGTSConnection *) connection sentQuery: (PGTSQuery *) query;

@interface BXPGInterface (Visitor) <PGTSQueryVisitor>
- (void) addAttributeFor: (PGTSFieldDescription *) field into: (NSMutableDictionary *) attrs 
				  entity: (BXEntityDescription *) entity primaryKeyFields: (NSSet *) pkey;
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.