-
Notifications
You must be signed in to change notification settings - Fork 5
/
PGSQLRecordset.h
135 lines (110 loc) · 4.75 KB
/
PGSQLRecordset.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
//
// PGSQLRecordset.h
// PGSQLKit
//
// Created by Andy Satori on 5/29/07.
// Copyright 2007 Druware Software Designs. All rights reserved.
//
/*!
@header PGSQLRecordset
@abstract A represention of a result from a sql command.
@discussion Where the connection is the root of all data access, the
recordset is the root of all data read operations in the
PGSQLKit. Allowing the user to navigate through the result
using a collection of PGSQLRecords, which then contain the
PGSQLFields that contain the data elements.
Of particular note is the dictionaryFromRecord method which
provides a convenient 'record to NSDictionary' translation that
often eases consumption of the data in the realm of Cocoa
Bindings.
License
Copyright (c) 2005-2010, Druware Software Designs
All rights reserved.
Redistribution and use in binary forms, with or without
modification, are permitted provided that the following
conditions are met:
1. Redistributions in binary form must reproduce the above
copyright notice, this list of conditions and the following
disclaimer in the documentation and/or other materials
provided with the distribution.
2. Neither the name of the Druware Software Designs nor the
names of its contributors may be used to endorse or promote
products derived from this software without specific prior
written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
THE POSSIBILITY OF SUCH DAMAGE.
*/
#import "PGSQLColumn.h"
#import "PGSQLRecord.h"
#import "PGSQLField.h"
/*!
@class
@abstract The PGSQLRecordset is the result of any command that returns a
result. It provides the column list, as well as methods to
read the data from the result.
@discussion Where the connection is the root of all data access, the
recordset is the root of all data read operations in the
PGSQLKit. Allowing the user to navigate through the result
using a collection of PGSQLRecords, which then contain the
PGSQLFields that contain the data elements.
Of particular note is the dictionaryFromRecord method which
provides a convenient 'record to NSDictionary' translation that
often eases consumption of the data in the realm of Cocoa
Bindings.
*/
@interface PGSQLRecordset : NSObject {
void *pgResult;
BOOL isEOF;
BOOL isOpen;
long rowCount;
NSMutableArray *columns;
PGSQLRecord *currentRecord;
NSStringEncoding defaultEncoding;
}
-(id)initWithResult:(void *)result;
-(PGSQLField *)fieldByIndex:(long)fieldIndex;
-(PGSQLField *)fieldByName:(NSString *)fieldName;
-(void)close;
-(NSArray *)columns;
- (long)recordCount;
-(PGSQLRecord *)moveFirst;
-(PGSQLRecord *)movePrevious;
-(PGSQLRecord *)moveNext;
-(PGSQLRecord *)moveLast;
-(BOOL)isEOF;
-(NSDictionary *)dictionaryFromRecord;
/*!
@function
@abstract Get the recordset's defaultEncoding for all string operations
results.
@discussion The default setting is NSMacOSRoman. While this default is
used to maintain existing functionality, this will be changed
NSUTF8StringEncoding when PostgreSQL9 is released.
@result returns the defaultEncoding as an NSSTringEncoding (
http://developer.apple.com/mac/library/documentation/Cocoa/Reference/Foundation/Classes/NSString_Class/Reference/NSString.html#//apple_ref/doc/c_ref/NSStringEncoding )
*/
-(NSStringEncoding)defaultEncoding;
/*!
@function
@abstract Set the defaultEncoding for all string operations on the current
recordset
@discussion The default setting is NSMacOSRoman. While this default is
used to maintain existing functionality, this will be changed
NSUTF8StringEncoding when PostgreSQL9 is released.
@param value the defaultEncoding as an NSSTringEncoding (
http://developer.apple.com/mac/library/documentation/Cocoa/Reference/Foundation/Classes/NSString_Class/Reference/NSString.html#//apple_ref/doc/c_ref/NSStringEncoding )
@result void
*/
-(void)setDefaultEncoding:(NSStringEncoding)value;
@end