nano-store 0.6.0 → 0.6.1
Sign up to get free protection for your applications and to get access to all the features.
- data/CHANGELOG.md +5 -0
- data/README.md +3 -1
- data/Rakefile +1 -1
- data/lib/nano_store.rb +1 -1
- data/lib/nano_store/model.rb +11 -7
- data/lib/nano_store/version.rb +1 -1
- data/spec/model_spec.rb +2 -5
- data/vendor/Podfile.lock +4 -4
- data/vendor/Pods/BuildHeaders/NanoStore/NSFNanoGlobals.h +3 -1
- data/vendor/Pods/BuildHeaders/NanoStore/NSFNanoPredicate.h +5 -5
- data/vendor/Pods/BuildHeaders/NanoStore/NSFNanoSearch.h +4 -2
- data/vendor/Pods/Documentation/NanoStore/docset-installed.txt +4 -0
- data/vendor/Pods/Documentation/NanoStore/docset/Contents/Info.plist +33 -0
- data/vendor/Pods/Documentation/NanoStore/docset/Contents/Resources/Documents/Classes/NSFNanoBag.html +2266 -0
- data/vendor/Pods/Documentation/NanoStore/docset/Contents/Resources/Documents/Classes/NSFNanoEngine.html +4708 -0
- data/vendor/Pods/Documentation/NanoStore/docset/Contents/Resources/Documents/Classes/NSFNanoExpression.html +818 -0
- data/vendor/Pods/Documentation/NanoStore/docset/Contents/Resources/Documents/Classes/NSFNanoObject.html +1781 -0
- data/vendor/Pods/Documentation/NanoStore/docset/Contents/Resources/Documents/Classes/NSFNanoPredicate.html +800 -0
- data/vendor/Pods/Documentation/NanoStore/docset/Contents/Resources/Documents/Classes/NSFNanoResult.html +1054 -0
- data/vendor/Pods/Documentation/NanoStore/docset/Contents/Resources/Documents/Classes/NSFNanoSearch.html +2544 -0
- data/vendor/Pods/Documentation/NanoStore/docset/Contents/Resources/Documents/Classes/NSFNanoSortDescriptor.html +713 -0
- data/vendor/Pods/Documentation/NanoStore/docset/Contents/Resources/Documents/Classes/NSFNanoStore.html +3723 -0
- data/vendor/Pods/Documentation/NanoStore/docset/Contents/Resources/Documents/Classes/NSFOrderedDictionary.html +312 -0
- data/vendor/Pods/Documentation/NanoStore/docset/Contents/Resources/Documents/Protocols/NSFNanoObjectProtocol.html +651 -0
- data/vendor/Pods/Documentation/NanoStore/docset/Contents/Resources/Documents/css/styles.css +584 -0
- data/vendor/Pods/Documentation/NanoStore/docset/Contents/Resources/Documents/css/stylesPrint.css +22 -0
- data/vendor/Pods/Documentation/NanoStore/docset/Contents/Resources/Documents/hierarchy.html +106 -0
- data/vendor/Pods/Documentation/NanoStore/docset/Contents/Resources/Documents/img/button_bar_background.png +0 -0
- data/vendor/Pods/Documentation/NanoStore/docset/Contents/Resources/Documents/img/disclosure.png +0 -0
- data/vendor/Pods/Documentation/NanoStore/docset/Contents/Resources/Documents/img/disclosure_open.png +0 -0
- data/vendor/Pods/Documentation/NanoStore/docset/Contents/Resources/Documents/img/library_background.png +0 -0
- data/vendor/Pods/Documentation/NanoStore/docset/Contents/Resources/Documents/img/title_background.png +0 -0
- data/vendor/Pods/Documentation/NanoStore/docset/Contents/Resources/Documents/index.html +654 -0
- data/vendor/Pods/Documentation/NanoStore/docset/Contents/Resources/Nodes.xml +92 -0
- data/vendor/Pods/Documentation/NanoStore/docset/Contents/Resources/Tokens1.xml +596 -0
- data/vendor/Pods/Documentation/NanoStore/docset/Contents/Resources/Tokens10.xml +48 -0
- data/vendor/Pods/Documentation/NanoStore/docset/Contents/Resources/Tokens11.xml +118 -0
- data/vendor/Pods/Documentation/NanoStore/docset/Contents/Resources/Tokens2.xml +1209 -0
- data/vendor/Pods/Documentation/NanoStore/docset/Contents/Resources/Tokens3.xml +158 -0
- data/vendor/Pods/Documentation/NanoStore/docset/Contents/Resources/Tokens4.xml +455 -0
- data/vendor/Pods/Documentation/NanoStore/docset/Contents/Resources/Tokens5.xml +166 -0
- data/vendor/Pods/Documentation/NanoStore/docset/Contents/Resources/Tokens6.xml +246 -0
- data/vendor/Pods/Documentation/NanoStore/docset/Contents/Resources/Tokens7.xml +821 -0
- data/vendor/Pods/Documentation/NanoStore/docset/Contents/Resources/Tokens8.xml +125 -0
- data/vendor/Pods/Documentation/NanoStore/docset/Contents/Resources/Tokens9.xml +1082 -0
- data/vendor/Pods/Documentation/NanoStore/docset/Contents/Resources/docSet.dsidx +0 -0
- data/vendor/Pods/Documentation/NanoStore/docset/Contents/Resources/docSet.mom +0 -0
- data/vendor/Pods/Documentation/NanoStore/docset/Contents/Resources/docSet.skidx +0 -0
- data/vendor/Pods/Documentation/NanoStore/docset/Contents/Resources/docSet.toc +0 -0
- data/vendor/Pods/Documentation/NanoStore/html/Classes/NSFNanoBag.html +2266 -0
- data/vendor/Pods/Documentation/NanoStore/html/Classes/NSFNanoEngine.html +4708 -0
- data/vendor/Pods/Documentation/NanoStore/html/Classes/NSFNanoExpression.html +818 -0
- data/vendor/Pods/Documentation/NanoStore/html/Classes/NSFNanoObject.html +1781 -0
- data/vendor/Pods/Documentation/NanoStore/html/Classes/NSFNanoPredicate.html +800 -0
- data/vendor/Pods/Documentation/NanoStore/html/Classes/NSFNanoResult.html +1054 -0
- data/vendor/Pods/Documentation/NanoStore/html/Classes/NSFNanoSearch.html +2544 -0
- data/vendor/Pods/Documentation/NanoStore/html/Classes/NSFNanoSortDescriptor.html +713 -0
- data/vendor/Pods/Documentation/NanoStore/html/Classes/NSFNanoStore.html +3723 -0
- data/vendor/Pods/Documentation/NanoStore/html/Classes/NSFOrderedDictionary.html +312 -0
- data/vendor/Pods/Documentation/NanoStore/html/Protocols/NSFNanoObjectProtocol.html +651 -0
- data/vendor/Pods/Documentation/NanoStore/html/css/styles.css +584 -0
- data/vendor/Pods/Documentation/NanoStore/html/css/stylesPrint.css +22 -0
- data/vendor/Pods/Documentation/NanoStore/html/hierarchy.html +106 -0
- data/vendor/Pods/Documentation/NanoStore/html/img/button_bar_background.png +0 -0
- data/vendor/Pods/Documentation/NanoStore/html/img/disclosure.png +0 -0
- data/vendor/Pods/Documentation/NanoStore/html/img/disclosure_open.png +0 -0
- data/vendor/Pods/Documentation/NanoStore/html/img/library_background.png +0 -0
- data/vendor/Pods/Documentation/NanoStore/html/img/title_background.png +0 -0
- data/vendor/Pods/Documentation/NanoStore/html/index.html +654 -0
- data/vendor/Pods/Headers/NanoStore/NSFNanoGlobals.h +3 -1
- data/vendor/Pods/Headers/NanoStore/NSFNanoPredicate.h +5 -5
- data/vendor/Pods/Headers/NanoStore/NSFNanoSearch.h +4 -2
- data/vendor/Pods/NanoStore/Classes/Public/NSFNanoGlobals.h +3 -1
- data/vendor/Pods/NanoStore/Classes/Public/NSFNanoGlobals.m +1 -0
- data/vendor/Pods/NanoStore/Classes/Public/NSFNanoPredicate.h +5 -5
- data/vendor/Pods/NanoStore/Classes/Public/NSFNanoPredicate.m +15 -14
- data/vendor/Pods/NanoStore/Classes/Public/NSFNanoSearch.h +4 -2
- data/vendor/Pods/NanoStore/Classes/Public/NSFNanoSearch.m +95 -20
- data/vendor/Pods/Pods.bridgesupport +708 -700
- data/vendor/Pods/Pods.xcconfig +3 -3
- metadata +62 -4
|
@@ -0,0 +1,4708 @@
|
|
|
1
|
+
<!DOCTYPE HTML>
|
|
2
|
+
<html>
|
|
3
|
+
<head>
|
|
4
|
+
<meta http-equiv="Content-Type" content="html/html; charset=utf-8" />
|
|
5
|
+
<title>NSFNanoEngine Class Reference</title>
|
|
6
|
+
<meta id="xcode-display" name="xcode-display" content="render"/>
|
|
7
|
+
<meta name="viewport" content="width=550" />
|
|
8
|
+
<link rel="stylesheet" type="text/css" href="../css/styles.css" media="all" />
|
|
9
|
+
<link rel="stylesheet" type="text/css" media="print" href="../css/stylesPrint.css" />
|
|
10
|
+
<meta name="generator" content="appledoc 2.0.5 (build 789)" />
|
|
11
|
+
</head>
|
|
12
|
+
<body>
|
|
13
|
+
<header id="top_header">
|
|
14
|
+
<div id="library" class="hideInXcode">
|
|
15
|
+
<h1><a id="libraryTitle" href="../index.html">NanoStore 2.5.7 </a></h1>
|
|
16
|
+
<a id="developerHome" href="../index.html">Tito Ciuro</a>
|
|
17
|
+
</div>
|
|
18
|
+
|
|
19
|
+
<div id="title" role="banner">
|
|
20
|
+
<h1 class="hideInXcode">NSFNanoEngine Class Reference</h1>
|
|
21
|
+
</div>
|
|
22
|
+
<ul id="headerButtons" role="toolbar">
|
|
23
|
+
<li id="toc_button">
|
|
24
|
+
<button aria-label="Show Table of Contents" role="checkbox" class="open" id="table_of_contents"><span class="disclosure"></span>Table of Contents</button>
|
|
25
|
+
</li>
|
|
26
|
+
<li id="jumpto_button" role="navigation">
|
|
27
|
+
<select id="jumpTo">
|
|
28
|
+
<option value="top">Jump To…</option>
|
|
29
|
+
|
|
30
|
+
<option value="overview">Overview</option>
|
|
31
|
+
|
|
32
|
+
|
|
33
|
+
|
|
34
|
+
|
|
35
|
+
<option value="tasks">Tasks</option>
|
|
36
|
+
|
|
37
|
+
|
|
38
|
+
|
|
39
|
+
|
|
40
|
+
|
|
41
|
+
<option value="properties">Properties</option>
|
|
42
|
+
|
|
43
|
+
<option value="//api/name/cacheMethod"> cacheMethod</option>
|
|
44
|
+
|
|
45
|
+
<option value="//api/name/path"> path</option>
|
|
46
|
+
|
|
47
|
+
<option value="//api/name/sqlite"> sqlite</option>
|
|
48
|
+
|
|
49
|
+
|
|
50
|
+
|
|
51
|
+
|
|
52
|
+
<option value="class_methods">Class Methods</option>
|
|
53
|
+
|
|
54
|
+
<option value="//api/name/NSFEncodingTypeToNSString:"> + NSFEncodingTypeToNSString:</option>
|
|
55
|
+
|
|
56
|
+
<option value="//api/name/NSFP_decodeQuantum:andSource:"> + NSFP_decodeQuantum:andSource:</option>
|
|
57
|
+
|
|
58
|
+
<option value="//api/name/NSFP_sharedROWIDKeywords"> + NSFP_sharedROWIDKeywords</option>
|
|
59
|
+
|
|
60
|
+
<option value="//api/name/NSFP_stripBitsFromExtendedResultCode:"> + NSFP_stripBitsFromExtendedResultCode:</option>
|
|
61
|
+
|
|
62
|
+
<option value="//api/name/NSStringToNSFEncodingType:"> + NSStringToNSFEncodingType:</option>
|
|
63
|
+
|
|
64
|
+
<option value="//api/name/_plistToDictionary:"> + _plistToDictionary:</option>
|
|
65
|
+
|
|
66
|
+
<option value="//api/name/databaseWithPath:"> + databaseWithPath:</option>
|
|
67
|
+
|
|
68
|
+
<option value="//api/name/decodeDataFromBase64:"> + decodeDataFromBase64:</option>
|
|
69
|
+
|
|
70
|
+
<option value="//api/name/encodeDataToBase64:"> + encodeDataToBase64:</option>
|
|
71
|
+
|
|
72
|
+
<option value="//api/name/nanoStoreEngineVersion"> + nanoStoreEngineVersion</option>
|
|
73
|
+
|
|
74
|
+
<option value="//api/name/recommendedCacheSize"> + recommendedCacheSize</option>
|
|
75
|
+
|
|
76
|
+
<option value="//api/name/sharedNanoStoreEngineDatatypes"> + sharedNanoStoreEngineDatatypes</option>
|
|
77
|
+
|
|
78
|
+
<option value="//api/name/sqliteVersion"> + sqliteVersion</option>
|
|
79
|
+
|
|
80
|
+
<option value="//api/name/stringWithUUID"> + stringWithUUID</option>
|
|
81
|
+
|
|
82
|
+
<option value="//api/name/systemPageSize"> + systemPageSize</option>
|
|
83
|
+
|
|
84
|
+
|
|
85
|
+
|
|
86
|
+
|
|
87
|
+
<option value="instance_methods">Instance Methods</option>
|
|
88
|
+
|
|
89
|
+
<option value="//api/name/JSONDescription"> - JSONDescription</option>
|
|
90
|
+
|
|
91
|
+
<option value="//api/name/NSFP_ROWIDPresenceLocation:datatypes:"> - NSFP_ROWIDPresenceLocation:datatypes:</option>
|
|
92
|
+
|
|
93
|
+
<option value="//api/name/NSFP_beginTransactionMode:"> - NSFP_beginTransactionMode:</option>
|
|
94
|
+
|
|
95
|
+
<option value="//api/name/NSFP_cacheMethodToString"> - NSFP_cacheMethodToString</option>
|
|
96
|
+
|
|
97
|
+
<option value="//api/name/NSFP_createTable:withColumns:datatypes:isTemporary:"> - NSFP_createTable:withColumns:datatypes:isTemporary:</option>
|
|
98
|
+
|
|
99
|
+
<option value="//api/name/NSFP_datatypeForColumn:"> - NSFP_datatypeForColumn:</option>
|
|
100
|
+
|
|
101
|
+
<option value="//api/name/NSFP_datatypeForTable:column:"> - NSFP_datatypeForTable:column:</option>
|
|
102
|
+
|
|
103
|
+
<option value="//api/name/NSFP_flattenAllTables"> - NSFP_flattenAllTables</option>
|
|
104
|
+
|
|
105
|
+
<option value="//api/name/NSFP_insertStringValues:forColumns:table:"> - NSFP_insertStringValues:forColumns:table:</option>
|
|
106
|
+
|
|
107
|
+
<option value="//api/name/NSFP_installCommitCallback"> - NSFP_installCommitCallback</option>
|
|
108
|
+
|
|
109
|
+
<option value="//api/name/NSFP_isColumnROWIDAlias:forTable:"> - NSFP_isColumnROWIDAlias:forTable:</option>
|
|
110
|
+
|
|
111
|
+
<option value="//api/name/NSFP_nestedDescriptionWithPrefixedSpace:"> - NSFP_nestedDescriptionWithPrefixedSpace:</option>
|
|
112
|
+
|
|
113
|
+
<option value="//api/name/NSFP_prefixWithDotDelimiter:"> - NSFP_prefixWithDotDelimiter:</option>
|
|
114
|
+
|
|
115
|
+
<option value="//api/name/NSFP_prepareSQLite3Statement:theSQLStatement:"> - NSFP_prepareSQLite3Statement:theSQLStatement:</option>
|
|
116
|
+
|
|
117
|
+
<option value="//api/name/NSFP_rebuildDatatypeCache"> - NSFP_rebuildDatatypeCache</option>
|
|
118
|
+
|
|
119
|
+
<option value="//api/name/NSFP_removeColumn:fromTable:"> - NSFP_removeColumn:fromTable:</option>
|
|
120
|
+
|
|
121
|
+
<option value="//api/name/NSFP_setFullColumnNamesEnabled"> - NSFP_setFullColumnNamesEnabled</option>
|
|
122
|
+
|
|
123
|
+
<option value="//api/name/NSFP_sqlString:appendingTags:"> - NSFP_sqlString:appendingTags:</option>
|
|
124
|
+
|
|
125
|
+
<option value="//api/name/NSFP_sqlString:appendingTags:quoteTags:"> - NSFP_sqlString:appendingTags:quoteTags:</option>
|
|
126
|
+
|
|
127
|
+
<option value="//api/name/NSFP_sqlString:forTable:withColumns:datatypes:"> - NSFP_sqlString:forTable:withColumns:datatypes:</option>
|
|
128
|
+
|
|
129
|
+
<option value="//api/name/NSFP_suffixWithDotDelimiter:"> - NSFP_suffixWithDotDelimiter:</option>
|
|
130
|
+
|
|
131
|
+
<option value="//api/name/NSFP_uninstallCommitCallback"> - NSFP_uninstallCommitCallback</option>
|
|
132
|
+
|
|
133
|
+
<option value="//api/name/allTables"> - allTables</option>
|
|
134
|
+
|
|
135
|
+
<option value="//api/name/beginDeferredTransaction"> - beginDeferredTransaction</option>
|
|
136
|
+
|
|
137
|
+
<option value="//api/name/beginTransaction"> - beginTransaction</option>
|
|
138
|
+
|
|
139
|
+
<option value="//api/name/busyTimeout"> - busyTimeout</option>
|
|
140
|
+
|
|
141
|
+
<option value="//api/name/cacheSize"> - cacheSize</option>
|
|
142
|
+
|
|
143
|
+
<option value="//api/name/close"> - close</option>
|
|
144
|
+
|
|
145
|
+
<option value="//api/name/columnsForTable:"> - columnsForTable:</option>
|
|
146
|
+
|
|
147
|
+
<option value="//api/name/commitTransaction"> - commitTransaction</option>
|
|
148
|
+
|
|
149
|
+
<option value="//api/name/compact"> - compact</option>
|
|
150
|
+
|
|
151
|
+
<option value="//api/name/createIndexForColumn:table:isUnique:"> - createIndexForColumn:table:isUnique:</option>
|
|
152
|
+
|
|
153
|
+
<option value="//api/name/createTable:withColumns:datatypes:"> - createTable:withColumns:datatypes:</option>
|
|
154
|
+
|
|
155
|
+
<option value="//api/name/datatypesForTable:"> - datatypesForTable:</option>
|
|
156
|
+
|
|
157
|
+
<option value="//api/name/description"> - description</option>
|
|
158
|
+
|
|
159
|
+
<option value="//api/name/dictionaryDescription"> - dictionaryDescription</option>
|
|
160
|
+
|
|
161
|
+
<option value="//api/name/dropIndex:"> - dropIndex:</option>
|
|
162
|
+
|
|
163
|
+
<option value="//api/name/dropTable:"> - dropTable:</option>
|
|
164
|
+
|
|
165
|
+
<option value="//api/name/encoding"> - encoding</option>
|
|
166
|
+
|
|
167
|
+
<option value="//api/name/executeSQL:"> - executeSQL:</option>
|
|
168
|
+
|
|
169
|
+
<option value="//api/name/indexedColumnsForTable:"> - indexedColumnsForTable:</option>
|
|
170
|
+
|
|
171
|
+
<option value="//api/name/indexes"> - indexes</option>
|
|
172
|
+
|
|
173
|
+
<option value="//api/name/initWithPath:"> - initWithPath:</option>
|
|
174
|
+
|
|
175
|
+
<option value="//api/name/integrityCheck"> - integrityCheck</option>
|
|
176
|
+
|
|
177
|
+
<option value="//api/name/isDatabaseOpen"> - isDatabaseOpen</option>
|
|
178
|
+
|
|
179
|
+
<option value="//api/name/isTransactionActive"> - isTransactionActive</option>
|
|
180
|
+
|
|
181
|
+
<option value="//api/name/journalModeAndReturnError:"> - journalModeAndReturnError:</option>
|
|
182
|
+
|
|
183
|
+
<option value="//api/name/maxRowUIDForTable:"> - maxRowUIDForTable:</option>
|
|
184
|
+
|
|
185
|
+
<option value="//api/name/openWithCacheMethod:useFastMode:"> - openWithCacheMethod:useFastMode:</option>
|
|
186
|
+
|
|
187
|
+
<option value="//api/name/pageSize"> - pageSize</option>
|
|
188
|
+
|
|
189
|
+
<option value="//api/name/rollbackTransaction"> - rollbackTransaction</option>
|
|
190
|
+
|
|
191
|
+
<option value="//api/name/setBusyTimeout:"> - setBusyTimeout:</option>
|
|
192
|
+
|
|
193
|
+
<option value="//api/name/setCacheSize:"> - setCacheSize:</option>
|
|
194
|
+
|
|
195
|
+
<option value="//api/name/setEncodingType:"> - setEncodingType:</option>
|
|
196
|
+
|
|
197
|
+
<option value="//api/name/setJournalMode:"> - setJournalMode:</option>
|
|
198
|
+
|
|
199
|
+
<option value="//api/name/setPageSize:"> - setPageSize:</option>
|
|
200
|
+
|
|
201
|
+
<option value="//api/name/setSynchronousMode:"> - setSynchronousMode:</option>
|
|
202
|
+
|
|
203
|
+
<option value="//api/name/setTempStoreMode:"> - setTempStoreMode:</option>
|
|
204
|
+
|
|
205
|
+
<option value="//api/name/synchronousMode"> - synchronousMode</option>
|
|
206
|
+
|
|
207
|
+
<option value="//api/name/tables"> - tables</option>
|
|
208
|
+
|
|
209
|
+
<option value="//api/name/tempStoreMode"> - tempStoreMode</option>
|
|
210
|
+
|
|
211
|
+
<option value="//api/name/temporaryTables"> - temporaryTables</option>
|
|
212
|
+
|
|
213
|
+
|
|
214
|
+
|
|
215
|
+
</select>
|
|
216
|
+
</li>
|
|
217
|
+
</ul>
|
|
218
|
+
</header>
|
|
219
|
+
<nav id="tocContainer" class="isShowingTOC">
|
|
220
|
+
<ul id="toc" role="tree">
|
|
221
|
+
|
|
222
|
+
<li role="treeitem"><span class="nodisclosure"></span><span class="sectionName"><a href="#overview">Overview</a></span></li>
|
|
223
|
+
|
|
224
|
+
|
|
225
|
+
|
|
226
|
+
|
|
227
|
+
<li role="treeitem" id="task_treeitem"><span class="nodisclosure"></span><span class="sectionName"><a href="#tasks">Tasks</a></span><ul>
|
|
228
|
+
|
|
229
|
+
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#task_Creating and Initializing NanoEngine">Creating and Initializing NanoEngine</a></span></li>
|
|
230
|
+
|
|
231
|
+
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#task_Opening and Closing">Opening and Closing</a></span></li>
|
|
232
|
+
|
|
233
|
+
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#task_Accessors">Accessors</a></span></li>
|
|
234
|
+
|
|
235
|
+
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#task_Transactions">Transactions</a></span></li>
|
|
236
|
+
|
|
237
|
+
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#task_Everything About Tables">Everything About Tables</a></span></li>
|
|
238
|
+
|
|
239
|
+
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#task_Everything about Indexes">Everything about Indexes</a></span></li>
|
|
240
|
+
|
|
241
|
+
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#task_Database Maintenance">Database Maintenance</a></span></li>
|
|
242
|
+
|
|
243
|
+
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#task_Searching and Retrieving">Searching and Retrieving</a></span></li>
|
|
244
|
+
|
|
245
|
+
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#task_Miscellaneous">Miscellaneous</a></span></li>
|
|
246
|
+
|
|
247
|
+
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#task_Private Methods">Private Methods</a></span></li>
|
|
248
|
+
|
|
249
|
+
</ul></li>
|
|
250
|
+
|
|
251
|
+
|
|
252
|
+
|
|
253
|
+
|
|
254
|
+
|
|
255
|
+
<li role="treeitem" class="children"><span class="disclosure"></span><span class="sectionName"><a href="#properties">Properties</a></span><ul>
|
|
256
|
+
|
|
257
|
+
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/cacheMethod">cacheMethod</a></span></li>
|
|
258
|
+
|
|
259
|
+
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/path">path</a></span></li>
|
|
260
|
+
|
|
261
|
+
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/sqlite">sqlite</a></span></li>
|
|
262
|
+
|
|
263
|
+
</ul></li>
|
|
264
|
+
|
|
265
|
+
|
|
266
|
+
|
|
267
|
+
<li role="treeitem" class="children"><span class="disclosure"></span><span class="sectionName"><a href="#class_methods">Class Methods</a></span><ul>
|
|
268
|
+
|
|
269
|
+
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/NSFEncodingTypeToNSString:">NSFEncodingTypeToNSString:</a></span></li>
|
|
270
|
+
|
|
271
|
+
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/NSFP_decodeQuantum:andSource:">NSFP_decodeQuantum:andSource:</a></span></li>
|
|
272
|
+
|
|
273
|
+
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/NSFP_sharedROWIDKeywords">NSFP_sharedROWIDKeywords</a></span></li>
|
|
274
|
+
|
|
275
|
+
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/NSFP_stripBitsFromExtendedResultCode:">NSFP_stripBitsFromExtendedResultCode:</a></span></li>
|
|
276
|
+
|
|
277
|
+
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/NSStringToNSFEncodingType:">NSStringToNSFEncodingType:</a></span></li>
|
|
278
|
+
|
|
279
|
+
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/_plistToDictionary:">_plistToDictionary:</a></span></li>
|
|
280
|
+
|
|
281
|
+
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/databaseWithPath:">databaseWithPath:</a></span></li>
|
|
282
|
+
|
|
283
|
+
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/decodeDataFromBase64:">decodeDataFromBase64:</a></span></li>
|
|
284
|
+
|
|
285
|
+
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/encodeDataToBase64:">encodeDataToBase64:</a></span></li>
|
|
286
|
+
|
|
287
|
+
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/nanoStoreEngineVersion">nanoStoreEngineVersion</a></span></li>
|
|
288
|
+
|
|
289
|
+
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/recommendedCacheSize">recommendedCacheSize</a></span></li>
|
|
290
|
+
|
|
291
|
+
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/sharedNanoStoreEngineDatatypes">sharedNanoStoreEngineDatatypes</a></span></li>
|
|
292
|
+
|
|
293
|
+
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/sqliteVersion">sqliteVersion</a></span></li>
|
|
294
|
+
|
|
295
|
+
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/stringWithUUID">stringWithUUID</a></span></li>
|
|
296
|
+
|
|
297
|
+
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/systemPageSize">systemPageSize</a></span></li>
|
|
298
|
+
|
|
299
|
+
</ul></li>
|
|
300
|
+
|
|
301
|
+
|
|
302
|
+
|
|
303
|
+
<li role="treeitem" class="children"><span class="disclosure"></span><span class="sectionName"><a href="#instance_methods">Instance Methods</a></span><ul>
|
|
304
|
+
|
|
305
|
+
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/JSONDescription">JSONDescription</a></span></li>
|
|
306
|
+
|
|
307
|
+
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/NSFP_ROWIDPresenceLocation:datatypes:">NSFP_ROWIDPresenceLocation:datatypes:</a></span></li>
|
|
308
|
+
|
|
309
|
+
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/NSFP_beginTransactionMode:">NSFP_beginTransactionMode:</a></span></li>
|
|
310
|
+
|
|
311
|
+
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/NSFP_cacheMethodToString">NSFP_cacheMethodToString</a></span></li>
|
|
312
|
+
|
|
313
|
+
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/NSFP_createTable:withColumns:datatypes:isTemporary:">NSFP_createTable:withColumns:datatypes:isTemporary:</a></span></li>
|
|
314
|
+
|
|
315
|
+
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/NSFP_datatypeForColumn:">NSFP_datatypeForColumn:</a></span></li>
|
|
316
|
+
|
|
317
|
+
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/NSFP_datatypeForTable:column:">NSFP_datatypeForTable:column:</a></span></li>
|
|
318
|
+
|
|
319
|
+
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/NSFP_flattenAllTables">NSFP_flattenAllTables</a></span></li>
|
|
320
|
+
|
|
321
|
+
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/NSFP_insertStringValues:forColumns:table:">NSFP_insertStringValues:forColumns:table:</a></span></li>
|
|
322
|
+
|
|
323
|
+
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/NSFP_installCommitCallback">NSFP_installCommitCallback</a></span></li>
|
|
324
|
+
|
|
325
|
+
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/NSFP_isColumnROWIDAlias:forTable:">NSFP_isColumnROWIDAlias:forTable:</a></span></li>
|
|
326
|
+
|
|
327
|
+
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/NSFP_nestedDescriptionWithPrefixedSpace:">NSFP_nestedDescriptionWithPrefixedSpace:</a></span></li>
|
|
328
|
+
|
|
329
|
+
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/NSFP_prefixWithDotDelimiter:">NSFP_prefixWithDotDelimiter:</a></span></li>
|
|
330
|
+
|
|
331
|
+
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/NSFP_prepareSQLite3Statement:theSQLStatement:">NSFP_prepareSQLite3Statement:theSQLStatement:</a></span></li>
|
|
332
|
+
|
|
333
|
+
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/NSFP_rebuildDatatypeCache">NSFP_rebuildDatatypeCache</a></span></li>
|
|
334
|
+
|
|
335
|
+
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/NSFP_removeColumn:fromTable:">NSFP_removeColumn:fromTable:</a></span></li>
|
|
336
|
+
|
|
337
|
+
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/NSFP_setFullColumnNamesEnabled">NSFP_setFullColumnNamesEnabled</a></span></li>
|
|
338
|
+
|
|
339
|
+
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/NSFP_sqlString:appendingTags:">NSFP_sqlString:appendingTags:</a></span></li>
|
|
340
|
+
|
|
341
|
+
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/NSFP_sqlString:appendingTags:quoteTags:">NSFP_sqlString:appendingTags:quoteTags:</a></span></li>
|
|
342
|
+
|
|
343
|
+
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/NSFP_sqlString:forTable:withColumns:datatypes:">NSFP_sqlString:forTable:withColumns:datatypes:</a></span></li>
|
|
344
|
+
|
|
345
|
+
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/NSFP_suffixWithDotDelimiter:">NSFP_suffixWithDotDelimiter:</a></span></li>
|
|
346
|
+
|
|
347
|
+
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/NSFP_uninstallCommitCallback">NSFP_uninstallCommitCallback</a></span></li>
|
|
348
|
+
|
|
349
|
+
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/allTables">allTables</a></span></li>
|
|
350
|
+
|
|
351
|
+
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/beginDeferredTransaction">beginDeferredTransaction</a></span></li>
|
|
352
|
+
|
|
353
|
+
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/beginTransaction">beginTransaction</a></span></li>
|
|
354
|
+
|
|
355
|
+
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/busyTimeout">busyTimeout</a></span></li>
|
|
356
|
+
|
|
357
|
+
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/cacheSize">cacheSize</a></span></li>
|
|
358
|
+
|
|
359
|
+
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/close">close</a></span></li>
|
|
360
|
+
|
|
361
|
+
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/columnsForTable:">columnsForTable:</a></span></li>
|
|
362
|
+
|
|
363
|
+
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/commitTransaction">commitTransaction</a></span></li>
|
|
364
|
+
|
|
365
|
+
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/compact">compact</a></span></li>
|
|
366
|
+
|
|
367
|
+
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/createIndexForColumn:table:isUnique:">createIndexForColumn:table:isUnique:</a></span></li>
|
|
368
|
+
|
|
369
|
+
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/createTable:withColumns:datatypes:">createTable:withColumns:datatypes:</a></span></li>
|
|
370
|
+
|
|
371
|
+
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/datatypesForTable:">datatypesForTable:</a></span></li>
|
|
372
|
+
|
|
373
|
+
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/description">description</a></span></li>
|
|
374
|
+
|
|
375
|
+
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/dictionaryDescription">dictionaryDescription</a></span></li>
|
|
376
|
+
|
|
377
|
+
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/dropIndex:">dropIndex:</a></span></li>
|
|
378
|
+
|
|
379
|
+
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/dropTable:">dropTable:</a></span></li>
|
|
380
|
+
|
|
381
|
+
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/encoding">encoding</a></span></li>
|
|
382
|
+
|
|
383
|
+
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/executeSQL:">executeSQL:</a></span></li>
|
|
384
|
+
|
|
385
|
+
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/indexedColumnsForTable:">indexedColumnsForTable:</a></span></li>
|
|
386
|
+
|
|
387
|
+
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/indexes">indexes</a></span></li>
|
|
388
|
+
|
|
389
|
+
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/initWithPath:">initWithPath:</a></span></li>
|
|
390
|
+
|
|
391
|
+
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/integrityCheck">integrityCheck</a></span></li>
|
|
392
|
+
|
|
393
|
+
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/isDatabaseOpen">isDatabaseOpen</a></span></li>
|
|
394
|
+
|
|
395
|
+
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/isTransactionActive">isTransactionActive</a></span></li>
|
|
396
|
+
|
|
397
|
+
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/journalModeAndReturnError:">journalModeAndReturnError:</a></span></li>
|
|
398
|
+
|
|
399
|
+
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/maxRowUIDForTable:">maxRowUIDForTable:</a></span></li>
|
|
400
|
+
|
|
401
|
+
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/openWithCacheMethod:useFastMode:">openWithCacheMethod:useFastMode:</a></span></li>
|
|
402
|
+
|
|
403
|
+
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/pageSize">pageSize</a></span></li>
|
|
404
|
+
|
|
405
|
+
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/rollbackTransaction">rollbackTransaction</a></span></li>
|
|
406
|
+
|
|
407
|
+
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/setBusyTimeout:">setBusyTimeout:</a></span></li>
|
|
408
|
+
|
|
409
|
+
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/setCacheSize:">setCacheSize:</a></span></li>
|
|
410
|
+
|
|
411
|
+
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/setEncodingType:">setEncodingType:</a></span></li>
|
|
412
|
+
|
|
413
|
+
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/setJournalMode:">setJournalMode:</a></span></li>
|
|
414
|
+
|
|
415
|
+
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/setPageSize:">setPageSize:</a></span></li>
|
|
416
|
+
|
|
417
|
+
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/setSynchronousMode:">setSynchronousMode:</a></span></li>
|
|
418
|
+
|
|
419
|
+
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/setTempStoreMode:">setTempStoreMode:</a></span></li>
|
|
420
|
+
|
|
421
|
+
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/synchronousMode">synchronousMode</a></span></li>
|
|
422
|
+
|
|
423
|
+
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/tables">tables</a></span></li>
|
|
424
|
+
|
|
425
|
+
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/tempStoreMode">tempStoreMode</a></span></li>
|
|
426
|
+
|
|
427
|
+
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/temporaryTables">temporaryTables</a></span></li>
|
|
428
|
+
|
|
429
|
+
</ul></li>
|
|
430
|
+
|
|
431
|
+
|
|
432
|
+
</ul>
|
|
433
|
+
</nav>
|
|
434
|
+
<article>
|
|
435
|
+
<div id="contents" class="isShowingTOC" role="main">
|
|
436
|
+
<a title="NSFNanoEngine Class Reference" name="top"></a>
|
|
437
|
+
<div class="main-navigation navigation-top">
|
|
438
|
+
<ul>
|
|
439
|
+
<li><a href="../index.html">Index</a></li>
|
|
440
|
+
<li><a href="../hierarchy.html">Hierarchy</a></li>
|
|
441
|
+
</ul>
|
|
442
|
+
</div>
|
|
443
|
+
<div id="header">
|
|
444
|
+
<div class="section-header">
|
|
445
|
+
<h1 class="title title-header">NSFNanoEngine Class Reference</h1>
|
|
446
|
+
</div>
|
|
447
|
+
</div>
|
|
448
|
+
<div id="container">
|
|
449
|
+
|
|
450
|
+
<div class="section section-specification"><table cellspacing="0"><tbody>
|
|
451
|
+
<tr>
|
|
452
|
+
<td class="specification-title">Inherits from</td>
|
|
453
|
+
<td class="specification-value">NSObject</td>
|
|
454
|
+
</tr><tr>
|
|
455
|
+
<td class="specification-title">Declared in</td>
|
|
456
|
+
<td class="specification-value">NSFNanoEngine.h</td>
|
|
457
|
+
</tr>
|
|
458
|
+
</tbody></table></div>
|
|
459
|
+
|
|
460
|
+
|
|
461
|
+
|
|
462
|
+
|
|
463
|
+
<div class="section section-overview">
|
|
464
|
+
<a title="Overview" name="overview"></a>
|
|
465
|
+
<h2 class="subtitle subtitle-overview">Overview</h2>
|
|
466
|
+
<p>@class NSFNanoEngine
|
|
467
|
+
A wrapper around SQLite, it provides convenience methods as well as “raw” access to the database.</p>
|
|
468
|
+
|
|
469
|
+
<p>\cond</p>
|
|
470
|
+
</div>
|
|
471
|
+
|
|
472
|
+
|
|
473
|
+
|
|
474
|
+
|
|
475
|
+
|
|
476
|
+
<div class="section section-tasks">
|
|
477
|
+
<a title="Tasks" name="tasks"></a>
|
|
478
|
+
<h2 class="subtitle subtitle-tasks">Tasks</h2>
|
|
479
|
+
|
|
480
|
+
|
|
481
|
+
|
|
482
|
+
<h3 class="subsubtitle task-title">Other Methods</h3>
|
|
483
|
+
|
|
484
|
+
<ul class="task-list">
|
|
485
|
+
<li>
|
|
486
|
+
<span class="tooltip">
|
|
487
|
+
<code><a href="#//api/name/sqlite"> sqlite</a></code>
|
|
488
|
+
<span class="tooltip"><ul>
|
|
489
|
+
<li>A reference to the SQLite database.</li>
|
|
490
|
+
</ul>
|
|
491
|
+
</span>
|
|
492
|
+
</span>
|
|
493
|
+
<span class="task-item-suffix">property</span>
|
|
494
|
+
|
|
495
|
+
</li><li>
|
|
496
|
+
<span class="tooltip">
|
|
497
|
+
<code><a href="#//api/name/path"> path</a></code>
|
|
498
|
+
<span class="tooltip"><ul>
|
|
499
|
+
<li>The file path where the database is located.</li>
|
|
500
|
+
</ul>
|
|
501
|
+
</span>
|
|
502
|
+
</span>
|
|
503
|
+
<span class="task-item-suffix">property</span>
|
|
504
|
+
|
|
505
|
+
</li><li>
|
|
506
|
+
<span class="tooltip">
|
|
507
|
+
<code><a href="#//api/name/cacheMethod"> cacheMethod</a></code>
|
|
508
|
+
<span class="tooltip"><ul>
|
|
509
|
+
<li>The cache mechanism being used.</li>
|
|
510
|
+
</ul>
|
|
511
|
+
</span>
|
|
512
|
+
</span>
|
|
513
|
+
<span class="task-item-suffix">property</span>
|
|
514
|
+
|
|
515
|
+
</li>
|
|
516
|
+
</ul>
|
|
517
|
+
|
|
518
|
+
|
|
519
|
+
<a title="Creating and Initializing NanoEngine" name="task_Creating and Initializing NanoEngine"></a>
|
|
520
|
+
<h3 class="subsubtitle task-title">Creating and Initializing NanoEngine</h3>
|
|
521
|
+
|
|
522
|
+
<ul class="task-list">
|
|
523
|
+
<li>
|
|
524
|
+
<span class="tooltip">
|
|
525
|
+
<code><a href="#//api/name/databaseWithPath:">+ databaseWithPath:</a></code>
|
|
526
|
+
<span class="tooltip"><p>Creates and returns an engine object at a given file <a href="#//api/name/path">path</a>.</p></span>
|
|
527
|
+
</span>
|
|
528
|
+
|
|
529
|
+
|
|
530
|
+
</li><li>
|
|
531
|
+
<span class="tooltip">
|
|
532
|
+
<code><a href="#//api/name/initWithPath:">– initWithPath:</a></code>
|
|
533
|
+
<span class="tooltip"><p>Initializes a newly allocated document store at a given file <a href="#//api/name/path">path</a>.</p></span>
|
|
534
|
+
</span>
|
|
535
|
+
|
|
536
|
+
|
|
537
|
+
</li>
|
|
538
|
+
</ul>
|
|
539
|
+
|
|
540
|
+
|
|
541
|
+
<a title="Opening and Closing" name="task_Opening and Closing"></a>
|
|
542
|
+
<h3 class="subsubtitle task-title">Opening and Closing</h3>
|
|
543
|
+
|
|
544
|
+
<ul class="task-list">
|
|
545
|
+
<li>
|
|
546
|
+
<span class="tooltip">
|
|
547
|
+
<code><a href="#//api/name/openWithCacheMethod:useFastMode:">– openWithCacheMethod:useFastMode:</a></code>
|
|
548
|
+
<span class="tooltip"><p>Opens the engine, making it ready for manipulation.</p></span>
|
|
549
|
+
</span>
|
|
550
|
+
|
|
551
|
+
|
|
552
|
+
</li><li>
|
|
553
|
+
<span class="tooltip">
|
|
554
|
+
<code><a href="#//api/name/close">– close</a></code>
|
|
555
|
+
<span class="tooltip"><p>Closes the database.</p></span>
|
|
556
|
+
</span>
|
|
557
|
+
|
|
558
|
+
|
|
559
|
+
</li>
|
|
560
|
+
</ul>
|
|
561
|
+
|
|
562
|
+
|
|
563
|
+
<a title="Accessors" name="task_Accessors"></a>
|
|
564
|
+
<h3 class="subsubtitle task-title">Accessors</h3>
|
|
565
|
+
|
|
566
|
+
<ul class="task-list">
|
|
567
|
+
<li>
|
|
568
|
+
<span class="tooltip">
|
|
569
|
+
<code><a href="#//api/name/isDatabaseOpen">– isDatabaseOpen</a></code>
|
|
570
|
+
<span class="tooltip"><p>Checks whether the document store is open or closed.</p></span>
|
|
571
|
+
</span>
|
|
572
|
+
|
|
573
|
+
|
|
574
|
+
</li><li>
|
|
575
|
+
<span class="tooltip">
|
|
576
|
+
<code><a href="#//api/name/isTransactionActive">– isTransactionActive</a></code>
|
|
577
|
+
<span class="tooltip"><p>Checks whether a transaction is currently active.</p></span>
|
|
578
|
+
</span>
|
|
579
|
+
|
|
580
|
+
|
|
581
|
+
</li><li>
|
|
582
|
+
<span class="tooltip">
|
|
583
|
+
<code><a href="#//api/name/setBusyTimeout:">– setBusyTimeout:</a></code>
|
|
584
|
+
<span class="tooltip"><p>Sets the busy timeout.</p></span>
|
|
585
|
+
</span>
|
|
586
|
+
|
|
587
|
+
|
|
588
|
+
</li><li>
|
|
589
|
+
<span class="tooltip">
|
|
590
|
+
<code><a href="#//api/name/busyTimeout">– busyTimeout</a></code>
|
|
591
|
+
<span class="tooltip"><p>Returns the current busy timeout.</p></span>
|
|
592
|
+
</span>
|
|
593
|
+
|
|
594
|
+
|
|
595
|
+
</li><li>
|
|
596
|
+
<span class="tooltip">
|
|
597
|
+
<code><a href="#//api/name/recommendedCacheSize">+ recommendedCacheSize</a></code>
|
|
598
|
+
<span class="tooltip"><p>Returns the recommended cache size based on the system resources available.</p></span>
|
|
599
|
+
</span>
|
|
600
|
+
|
|
601
|
+
|
|
602
|
+
</li><li>
|
|
603
|
+
<span class="tooltip">
|
|
604
|
+
<code><a href="#//api/name/setCacheSize:">– setCacheSize:</a></code>
|
|
605
|
+
<span class="tooltip"><p>Sets the cache size.</p></span>
|
|
606
|
+
</span>
|
|
607
|
+
|
|
608
|
+
|
|
609
|
+
</li><li>
|
|
610
|
+
<span class="tooltip">
|
|
611
|
+
<code><a href="#//api/name/cacheSize">– cacheSize</a></code>
|
|
612
|
+
<span class="tooltip"><p>Returns the cache size.</p></span>
|
|
613
|
+
</span>
|
|
614
|
+
|
|
615
|
+
|
|
616
|
+
</li><li>
|
|
617
|
+
<span class="tooltip">
|
|
618
|
+
<code><a href="#//api/name/systemPageSize">+ systemPageSize</a></code>
|
|
619
|
+
<span class="tooltip"><p>Returns the system’s page size</p></span>
|
|
620
|
+
</span>
|
|
621
|
+
|
|
622
|
+
|
|
623
|
+
</li><li>
|
|
624
|
+
<span class="tooltip">
|
|
625
|
+
<code><a href="#//api/name/setPageSize:">– setPageSize:</a></code>
|
|
626
|
+
<span class="tooltip"><p>Sets the page size.</p></span>
|
|
627
|
+
</span>
|
|
628
|
+
|
|
629
|
+
|
|
630
|
+
</li><li>
|
|
631
|
+
<span class="tooltip">
|
|
632
|
+
<code><a href="#//api/name/pageSize">– pageSize</a></code>
|
|
633
|
+
<span class="tooltip"><p>Returns the page size.</p></span>
|
|
634
|
+
</span>
|
|
635
|
+
|
|
636
|
+
|
|
637
|
+
</li><li>
|
|
638
|
+
<span class="tooltip">
|
|
639
|
+
<code><a href="#//api/name/setEncodingType:">– setEncodingType:</a></code>
|
|
640
|
+
<span class="tooltip"><p>Sets the text <a href="#//api/name/encoding">encoding</a> type.</p></span>
|
|
641
|
+
</span>
|
|
642
|
+
|
|
643
|
+
|
|
644
|
+
</li><li>
|
|
645
|
+
<span class="tooltip">
|
|
646
|
+
<code><a href="#//api/name/encoding">– encoding</a></code>
|
|
647
|
+
<span class="tooltip"><p>Returns the encoding type.</p></span>
|
|
648
|
+
</span>
|
|
649
|
+
|
|
650
|
+
|
|
651
|
+
</li><li>
|
|
652
|
+
<span class="tooltip">
|
|
653
|
+
<code><a href="#//api/name/NSStringToNSFEncodingType:">+ NSStringToNSFEncodingType:</a></code>
|
|
654
|
+
<span class="tooltip"><p>Returns the <a href="#//api/name/encoding">encoding</a> type from its string equivalent.</p></span>
|
|
655
|
+
</span>
|
|
656
|
+
|
|
657
|
+
|
|
658
|
+
</li><li>
|
|
659
|
+
<span class="tooltip">
|
|
660
|
+
<code><a href="#//api/name/NSFEncodingTypeToNSString:">+ NSFEncodingTypeToNSString:</a></code>
|
|
661
|
+
<span class="tooltip"><p>Returns the string equivalent of an <a href="#//api/name/encoding">encoding</a> type.</p></span>
|
|
662
|
+
</span>
|
|
663
|
+
|
|
664
|
+
|
|
665
|
+
</li><li>
|
|
666
|
+
<span class="tooltip">
|
|
667
|
+
<code><a href="#//api/name/setSynchronousMode:">– setSynchronousMode:</a></code>
|
|
668
|
+
<span class="tooltip"><p>Sets the synchronous mode.</p></span>
|
|
669
|
+
</span>
|
|
670
|
+
|
|
671
|
+
|
|
672
|
+
</li><li>
|
|
673
|
+
<span class="tooltip">
|
|
674
|
+
<code><a href="#//api/name/synchronousMode">– synchronousMode</a></code>
|
|
675
|
+
<span class="tooltip"><p>Returns the synchronous mode.</p></span>
|
|
676
|
+
</span>
|
|
677
|
+
|
|
678
|
+
|
|
679
|
+
</li><li>
|
|
680
|
+
<span class="tooltip">
|
|
681
|
+
<code><a href="#//api/name/setTempStoreMode:">– setTempStoreMode:</a></code>
|
|
682
|
+
<span class="tooltip"><p>Sets the temporary storage mode.</p></span>
|
|
683
|
+
</span>
|
|
684
|
+
|
|
685
|
+
|
|
686
|
+
</li><li>
|
|
687
|
+
<span class="tooltip">
|
|
688
|
+
<code><a href="#//api/name/tempStoreMode">– tempStoreMode</a></code>
|
|
689
|
+
<span class="tooltip"><p>Returns the temporary storage mode.</p></span>
|
|
690
|
+
</span>
|
|
691
|
+
|
|
692
|
+
|
|
693
|
+
</li><li>
|
|
694
|
+
<span class="tooltip">
|
|
695
|
+
<code><a href="#//api/name/journalModeAndReturnError:">– journalModeAndReturnError:</a></code>
|
|
696
|
+
<span class="tooltip"><ul>
|
|
697
|
+
<li>Journal mode.</li>
|
|
698
|
+
<li>These values represent the options used by SQLite to the the journal mode for databases associated with the current database connection.</li>
|
|
699
|
+
</ul>
|
|
700
|
+
</span>
|
|
701
|
+
</span>
|
|
702
|
+
|
|
703
|
+
|
|
704
|
+
</li><li>
|
|
705
|
+
<span class="tooltip">
|
|
706
|
+
<code><a href="#//api/name/setJournalMode:">– setJournalMode:</a></code>
|
|
707
|
+
<span class="tooltip"><p>Returns the journal mode.</p></span>
|
|
708
|
+
</span>
|
|
709
|
+
|
|
710
|
+
|
|
711
|
+
</li><li>
|
|
712
|
+
<span class="tooltip">
|
|
713
|
+
<code><a href="#//api/name/sharedNanoStoreEngineDatatypes">+ sharedNanoStoreEngineDatatypes</a></code>
|
|
714
|
+
<span class="tooltip"><p>Returns a new array containing the datatypes recognized by NanoStore.</p></span>
|
|
715
|
+
</span>
|
|
716
|
+
|
|
717
|
+
|
|
718
|
+
</li><li>
|
|
719
|
+
<span class="tooltip">
|
|
720
|
+
<code><a href="#//api/name/nanoStoreEngineVersion">+ nanoStoreEngineVersion</a></code>
|
|
721
|
+
<span class="tooltip"><p>Returns the NanoStore engine version.</p></span>
|
|
722
|
+
</span>
|
|
723
|
+
|
|
724
|
+
|
|
725
|
+
</li><li>
|
|
726
|
+
<span class="tooltip">
|
|
727
|
+
<code><a href="#//api/name/sqliteVersion">+ sqliteVersion</a></code>
|
|
728
|
+
<span class="tooltip"><p>Returns the SQLite version.</p></span>
|
|
729
|
+
</span>
|
|
730
|
+
|
|
731
|
+
|
|
732
|
+
</li>
|
|
733
|
+
</ul>
|
|
734
|
+
|
|
735
|
+
|
|
736
|
+
<a title="Transactions" name="task_Transactions"></a>
|
|
737
|
+
<h3 class="subsubtitle task-title">Transactions</h3>
|
|
738
|
+
|
|
739
|
+
<ul class="task-list">
|
|
740
|
+
<li>
|
|
741
|
+
<span class="tooltip">
|
|
742
|
+
<code><a href="#//api/name/beginTransaction">– beginTransaction</a></code>
|
|
743
|
+
<span class="tooltip"><p>Starts a transaction.</p></span>
|
|
744
|
+
</span>
|
|
745
|
+
|
|
746
|
+
|
|
747
|
+
</li><li>
|
|
748
|
+
<span class="tooltip">
|
|
749
|
+
<code><a href="#//api/name/beginDeferredTransaction">– beginDeferredTransaction</a></code>
|
|
750
|
+
<span class="tooltip"><p>Starts a deferred transaction.</p></span>
|
|
751
|
+
</span>
|
|
752
|
+
|
|
753
|
+
|
|
754
|
+
</li><li>
|
|
755
|
+
<span class="tooltip">
|
|
756
|
+
<code><a href="#//api/name/commitTransaction">– commitTransaction</a></code>
|
|
757
|
+
<span class="tooltip"><p>Commits a transaction.</p></span>
|
|
758
|
+
</span>
|
|
759
|
+
|
|
760
|
+
|
|
761
|
+
</li><li>
|
|
762
|
+
<span class="tooltip">
|
|
763
|
+
<code><a href="#//api/name/rollbackTransaction">– rollbackTransaction</a></code>
|
|
764
|
+
<span class="tooltip"><p>Rolls back a transaction.</p></span>
|
|
765
|
+
</span>
|
|
766
|
+
|
|
767
|
+
|
|
768
|
+
</li>
|
|
769
|
+
</ul>
|
|
770
|
+
|
|
771
|
+
|
|
772
|
+
<a title="Everything About Tables" name="task_Everything About Tables"></a>
|
|
773
|
+
<h3 class="subsubtitle task-title">Everything About Tables</h3>
|
|
774
|
+
|
|
775
|
+
<ul class="task-list">
|
|
776
|
+
<li>
|
|
777
|
+
<span class="tooltip">
|
|
778
|
+
<code><a href="#//api/name/createTable:withColumns:datatypes:">– createTable:withColumns:datatypes:</a></code>
|
|
779
|
+
<span class="tooltip"><p>Creates a table.</p></span>
|
|
780
|
+
</span>
|
|
781
|
+
|
|
782
|
+
|
|
783
|
+
</li><li>
|
|
784
|
+
<span class="tooltip">
|
|
785
|
+
<code><a href="#//api/name/tables">– tables</a></code>
|
|
786
|
+
<span class="tooltip"><p>Returns a new array containing the tables found in the main document store.</p></span>
|
|
787
|
+
</span>
|
|
788
|
+
|
|
789
|
+
|
|
790
|
+
</li><li>
|
|
791
|
+
<span class="tooltip">
|
|
792
|
+
<code><a href="#//api/name/allTables">– allTables</a></code>
|
|
793
|
+
<span class="tooltip"><p>Returns a new array containing the <a href="#//api/name/tables">tables</a> found in the main and attached document stores.</p></span>
|
|
794
|
+
</span>
|
|
795
|
+
|
|
796
|
+
|
|
797
|
+
</li><li>
|
|
798
|
+
<span class="tooltip">
|
|
799
|
+
<code><a href="#//api/name/columnsForTable:">– columnsForTable:</a></code>
|
|
800
|
+
<span class="tooltip"><p>Returns a new array containing the columns for a given table.</p></span>
|
|
801
|
+
</span>
|
|
802
|
+
|
|
803
|
+
|
|
804
|
+
</li><li>
|
|
805
|
+
<span class="tooltip">
|
|
806
|
+
<code><a href="#//api/name/temporaryTables">– temporaryTables</a></code>
|
|
807
|
+
<span class="tooltip"><p>Returns a new array containing the temporary <a href="#//api/name/tables">tables</a> found in the main document store.</p></span>
|
|
808
|
+
</span>
|
|
809
|
+
|
|
810
|
+
|
|
811
|
+
</li><li>
|
|
812
|
+
<span class="tooltip">
|
|
813
|
+
<code><a href="#//api/name/datatypesForTable:">– datatypesForTable:</a></code>
|
|
814
|
+
<span class="tooltip"><p>Returns a new array containing the datatypes for a given table.</p></span>
|
|
815
|
+
</span>
|
|
816
|
+
|
|
817
|
+
|
|
818
|
+
</li><li>
|
|
819
|
+
<span class="tooltip">
|
|
820
|
+
<code><a href="#//api/name/dropTable:">– dropTable:</a></code>
|
|
821
|
+
<span class="tooltip"><p>Removes the table from the document store.</p></span>
|
|
822
|
+
</span>
|
|
823
|
+
|
|
824
|
+
|
|
825
|
+
</li>
|
|
826
|
+
</ul>
|
|
827
|
+
|
|
828
|
+
|
|
829
|
+
<a title="Everything about Indexes" name="task_Everything about Indexes"></a>
|
|
830
|
+
<h3 class="subsubtitle task-title">Everything about Indexes</h3>
|
|
831
|
+
|
|
832
|
+
<ul class="task-list">
|
|
833
|
+
<li>
|
|
834
|
+
<span class="tooltip">
|
|
835
|
+
<code><a href="#//api/name/createIndexForColumn:table:isUnique:">– createIndexForColumn:table:isUnique:</a></code>
|
|
836
|
+
<span class="tooltip"><p>Creates an index.</p></span>
|
|
837
|
+
</span>
|
|
838
|
+
|
|
839
|
+
|
|
840
|
+
</li><li>
|
|
841
|
+
<span class="tooltip">
|
|
842
|
+
<code><a href="#//api/name/indexes">– indexes</a></code>
|
|
843
|
+
<span class="tooltip"><p>Returns a new array containing the indexes found in the main document store.</p></span>
|
|
844
|
+
</span>
|
|
845
|
+
|
|
846
|
+
|
|
847
|
+
</li><li>
|
|
848
|
+
<span class="tooltip">
|
|
849
|
+
<code><a href="#//api/name/indexedColumnsForTable:">– indexedColumnsForTable:</a></code>
|
|
850
|
+
<span class="tooltip"><p>Returns a new array containing the <a href="#//api/name/indexes">indexes</a> found for a given table.</p></span>
|
|
851
|
+
</span>
|
|
852
|
+
|
|
853
|
+
|
|
854
|
+
</li><li>
|
|
855
|
+
<span class="tooltip">
|
|
856
|
+
<code><a href="#//api/name/dropIndex:">– dropIndex:</a></code>
|
|
857
|
+
<span class="tooltip"><p>Removes an index.</p></span>
|
|
858
|
+
</span>
|
|
859
|
+
|
|
860
|
+
|
|
861
|
+
</li>
|
|
862
|
+
</ul>
|
|
863
|
+
|
|
864
|
+
|
|
865
|
+
<a title="Database Maintenance" name="task_Database Maintenance"></a>
|
|
866
|
+
<h3 class="subsubtitle task-title">Database Maintenance</h3>
|
|
867
|
+
|
|
868
|
+
<ul class="task-list">
|
|
869
|
+
<li>
|
|
870
|
+
<span class="tooltip">
|
|
871
|
+
<code><a href="#//api/name/compact">– compact</a></code>
|
|
872
|
+
<span class="tooltip"><p>Compacts the database, attempting to reclaim unused space.</p></span>
|
|
873
|
+
</span>
|
|
874
|
+
|
|
875
|
+
|
|
876
|
+
</li><li>
|
|
877
|
+
<span class="tooltip">
|
|
878
|
+
<code><a href="#//api/name/integrityCheck">– integrityCheck</a></code>
|
|
879
|
+
<span class="tooltip"><p>Performs an integrity check on the database.</p></span>
|
|
880
|
+
</span>
|
|
881
|
+
|
|
882
|
+
|
|
883
|
+
</li>
|
|
884
|
+
</ul>
|
|
885
|
+
|
|
886
|
+
|
|
887
|
+
<a title="Searching and Retrieving" name="task_Searching and Retrieving"></a>
|
|
888
|
+
<h3 class="subsubtitle task-title">Searching and Retrieving</h3>
|
|
889
|
+
|
|
890
|
+
<ul class="task-list">
|
|
891
|
+
<li>
|
|
892
|
+
<span class="tooltip">
|
|
893
|
+
<code><a href="#//api/name/executeSQL:">– executeSQL:</a></code>
|
|
894
|
+
<span class="tooltip"><p>Executes a SQL statement.</p></span>
|
|
895
|
+
</span>
|
|
896
|
+
|
|
897
|
+
|
|
898
|
+
</li><li>
|
|
899
|
+
<span class="tooltip">
|
|
900
|
+
<code><a href="#//api/name/maxRowUIDForTable:">– maxRowUIDForTable:</a></code>
|
|
901
|
+
<span class="tooltip"><p>Returns the largest ROWUID for a given table.</p></span>
|
|
902
|
+
</span>
|
|
903
|
+
|
|
904
|
+
|
|
905
|
+
</li>
|
|
906
|
+
</ul>
|
|
907
|
+
|
|
908
|
+
|
|
909
|
+
<a title="Miscellaneous" name="task_Miscellaneous"></a>
|
|
910
|
+
<h3 class="subsubtitle task-title">Miscellaneous</h3>
|
|
911
|
+
|
|
912
|
+
<ul class="task-list">
|
|
913
|
+
<li>
|
|
914
|
+
<span class="tooltip">
|
|
915
|
+
<code><a href="#//api/name/encodeDataToBase64:">+ encodeDataToBase64:</a></code>
|
|
916
|
+
<span class="tooltip"><p>Returns a string containing the base 64 representation of a data element.</p></span>
|
|
917
|
+
</span>
|
|
918
|
+
|
|
919
|
+
|
|
920
|
+
</li><li>
|
|
921
|
+
<span class="tooltip">
|
|
922
|
+
<code><a href="#//api/name/decodeDataFromBase64:">+ decodeDataFromBase64:</a></code>
|
|
923
|
+
<span class="tooltip"><p>Returns a data element containing from a base 64 formatted string.</p></span>
|
|
924
|
+
</span>
|
|
925
|
+
|
|
926
|
+
|
|
927
|
+
</li><li>
|
|
928
|
+
<span class="tooltip">
|
|
929
|
+
<code><a href="#//api/name/stringWithUUID">+ stringWithUUID</a></code>
|
|
930
|
+
<span class="tooltip"><p>Returns a UUID string</p></span>
|
|
931
|
+
</span>
|
|
932
|
+
|
|
933
|
+
|
|
934
|
+
</li><li>
|
|
935
|
+
<span class="tooltip">
|
|
936
|
+
<code><a href="#//api/name/description">– description</a></code>
|
|
937
|
+
<span class="tooltip"><p>Returns a string representation of the engine.</p></span>
|
|
938
|
+
</span>
|
|
939
|
+
|
|
940
|
+
|
|
941
|
+
</li><li>
|
|
942
|
+
<span class="tooltip">
|
|
943
|
+
<code><a href="#//api/name/JSONDescription">– JSONDescription</a></code>
|
|
944
|
+
<span class="tooltip"><p>Returns a JSON representation of the engine.</p></span>
|
|
945
|
+
</span>
|
|
946
|
+
|
|
947
|
+
|
|
948
|
+
</li>
|
|
949
|
+
</ul>
|
|
950
|
+
|
|
951
|
+
|
|
952
|
+
<a title="Private Methods" name="task_Private Methods"></a>
|
|
953
|
+
<h3 class="subsubtitle task-title">Private Methods</h3>
|
|
954
|
+
|
|
955
|
+
<ul class="task-list">
|
|
956
|
+
<li>
|
|
957
|
+
<span class="tooltip">
|
|
958
|
+
<code><a href="#//api/name/dictionaryDescription">– dictionaryDescription</a></code>
|
|
959
|
+
|
|
960
|
+
</span>
|
|
961
|
+
|
|
962
|
+
|
|
963
|
+
</li><li>
|
|
964
|
+
<span class="tooltip">
|
|
965
|
+
<code><a href="#//api/name/NSFP_sharedROWIDKeywords">+ NSFP_sharedROWIDKeywords</a></code>
|
|
966
|
+
|
|
967
|
+
</span>
|
|
968
|
+
|
|
969
|
+
|
|
970
|
+
</li><li>
|
|
971
|
+
<span class="tooltip">
|
|
972
|
+
<code><a href="#//api/name/NSFP_cacheMethodToString">– NSFP_cacheMethodToString</a></code>
|
|
973
|
+
|
|
974
|
+
</span>
|
|
975
|
+
|
|
976
|
+
|
|
977
|
+
</li><li>
|
|
978
|
+
<span class="tooltip">
|
|
979
|
+
<code><a href="#//api/name/NSFP_nestedDescriptionWithPrefixedSpace:">– NSFP_nestedDescriptionWithPrefixedSpace:</a></code>
|
|
980
|
+
|
|
981
|
+
</span>
|
|
982
|
+
|
|
983
|
+
|
|
984
|
+
</li><li>
|
|
985
|
+
<span class="tooltip">
|
|
986
|
+
<code><a href="#//api/name/_plistToDictionary:">+ _plistToDictionary:</a></code>
|
|
987
|
+
|
|
988
|
+
</span>
|
|
989
|
+
|
|
990
|
+
|
|
991
|
+
</li><li>
|
|
992
|
+
<span class="tooltip">
|
|
993
|
+
<code><a href="#//api/name/NSFP_datatypeForTable:column:">– NSFP_datatypeForTable:column:</a></code>
|
|
994
|
+
|
|
995
|
+
</span>
|
|
996
|
+
|
|
997
|
+
|
|
998
|
+
</li><li>
|
|
999
|
+
<span class="tooltip">
|
|
1000
|
+
<code><a href="#//api/name/NSFP_decodeQuantum:andSource:">+ NSFP_decodeQuantum:andSource:</a></code>
|
|
1001
|
+
|
|
1002
|
+
</span>
|
|
1003
|
+
|
|
1004
|
+
|
|
1005
|
+
</li><li>
|
|
1006
|
+
<span class="tooltip">
|
|
1007
|
+
<code><a href="#//api/name/NSFP_setFullColumnNamesEnabled">– NSFP_setFullColumnNamesEnabled</a></code>
|
|
1008
|
+
|
|
1009
|
+
</span>
|
|
1010
|
+
|
|
1011
|
+
|
|
1012
|
+
</li><li>
|
|
1013
|
+
<span class="tooltip">
|
|
1014
|
+
<code><a href="#//api/name/NSFP_flattenAllTables">– NSFP_flattenAllTables</a></code>
|
|
1015
|
+
|
|
1016
|
+
</span>
|
|
1017
|
+
|
|
1018
|
+
|
|
1019
|
+
</li><li>
|
|
1020
|
+
<span class="tooltip">
|
|
1021
|
+
<code><a href="#//api/name/NSFP_prepareSQLite3Statement:theSQLStatement:">– NSFP_prepareSQLite3Statement:theSQLStatement:</a></code>
|
|
1022
|
+
|
|
1023
|
+
</span>
|
|
1024
|
+
|
|
1025
|
+
|
|
1026
|
+
</li><li>
|
|
1027
|
+
<span class="tooltip">
|
|
1028
|
+
<code><a href="#//api/name/NSFP_datatypeForColumn:">– NSFP_datatypeForColumn:</a></code>
|
|
1029
|
+
|
|
1030
|
+
</span>
|
|
1031
|
+
|
|
1032
|
+
|
|
1033
|
+
</li><li>
|
|
1034
|
+
<span class="tooltip">
|
|
1035
|
+
<code><a href="#//api/name/NSFP_stripBitsFromExtendedResultCode:">+ NSFP_stripBitsFromExtendedResultCode:</a></code>
|
|
1036
|
+
|
|
1037
|
+
</span>
|
|
1038
|
+
|
|
1039
|
+
|
|
1040
|
+
</li><li>
|
|
1041
|
+
<span class="tooltip">
|
|
1042
|
+
<code><a href="#//api/name/NSFP_beginTransactionMode:">– NSFP_beginTransactionMode:</a></code>
|
|
1043
|
+
|
|
1044
|
+
</span>
|
|
1045
|
+
|
|
1046
|
+
|
|
1047
|
+
</li><li>
|
|
1048
|
+
<span class="tooltip">
|
|
1049
|
+
<code><a href="#//api/name/NSFP_createTable:withColumns:datatypes:isTemporary:">– NSFP_createTable:withColumns:datatypes:isTemporary:</a></code>
|
|
1050
|
+
|
|
1051
|
+
</span>
|
|
1052
|
+
|
|
1053
|
+
|
|
1054
|
+
</li><li>
|
|
1055
|
+
<span class="tooltip">
|
|
1056
|
+
<code><a href="#//api/name/NSFP_removeColumn:fromTable:">– NSFP_removeColumn:fromTable:</a></code>
|
|
1057
|
+
|
|
1058
|
+
</span>
|
|
1059
|
+
|
|
1060
|
+
|
|
1061
|
+
</li><li>
|
|
1062
|
+
<span class="tooltip">
|
|
1063
|
+
<code><a href="#//api/name/NSFP_rebuildDatatypeCache">– NSFP_rebuildDatatypeCache</a></code>
|
|
1064
|
+
|
|
1065
|
+
</span>
|
|
1066
|
+
|
|
1067
|
+
|
|
1068
|
+
</li><li>
|
|
1069
|
+
<span class="tooltip">
|
|
1070
|
+
<code><a href="#//api/name/NSFP_insertStringValues:forColumns:table:">– NSFP_insertStringValues:forColumns:table:</a></code>
|
|
1071
|
+
|
|
1072
|
+
</span>
|
|
1073
|
+
|
|
1074
|
+
|
|
1075
|
+
</li><li>
|
|
1076
|
+
<span class="tooltip">
|
|
1077
|
+
<code><a href="#//api/name/NSFP_sqlString:appendingTags:quoteTags:">– NSFP_sqlString:appendingTags:quoteTags:</a></code>
|
|
1078
|
+
|
|
1079
|
+
</span>
|
|
1080
|
+
|
|
1081
|
+
|
|
1082
|
+
</li><li>
|
|
1083
|
+
<span class="tooltip">
|
|
1084
|
+
<code><a href="#//api/name/NSFP_sqlString:appendingTags:">– NSFP_sqlString:appendingTags:</a></code>
|
|
1085
|
+
|
|
1086
|
+
</span>
|
|
1087
|
+
|
|
1088
|
+
|
|
1089
|
+
</li><li>
|
|
1090
|
+
<span class="tooltip">
|
|
1091
|
+
<code><a href="#//api/name/NSFP_sqlString:forTable:withColumns:datatypes:">– NSFP_sqlString:forTable:withColumns:datatypes:</a></code>
|
|
1092
|
+
|
|
1093
|
+
</span>
|
|
1094
|
+
|
|
1095
|
+
|
|
1096
|
+
</li><li>
|
|
1097
|
+
<span class="tooltip">
|
|
1098
|
+
<code><a href="#//api/name/NSFP_ROWIDPresenceLocation:datatypes:">– NSFP_ROWIDPresenceLocation:datatypes:</a></code>
|
|
1099
|
+
|
|
1100
|
+
</span>
|
|
1101
|
+
|
|
1102
|
+
|
|
1103
|
+
</li><li>
|
|
1104
|
+
<span class="tooltip">
|
|
1105
|
+
<code><a href="#//api/name/NSFP_isColumnROWIDAlias:forTable:">– NSFP_isColumnROWIDAlias:forTable:</a></code>
|
|
1106
|
+
|
|
1107
|
+
</span>
|
|
1108
|
+
|
|
1109
|
+
|
|
1110
|
+
</li><li>
|
|
1111
|
+
<span class="tooltip">
|
|
1112
|
+
<code><a href="#//api/name/NSFP_prefixWithDotDelimiter:">– NSFP_prefixWithDotDelimiter:</a></code>
|
|
1113
|
+
|
|
1114
|
+
</span>
|
|
1115
|
+
|
|
1116
|
+
|
|
1117
|
+
</li><li>
|
|
1118
|
+
<span class="tooltip">
|
|
1119
|
+
<code><a href="#//api/name/NSFP_suffixWithDotDelimiter:">– NSFP_suffixWithDotDelimiter:</a></code>
|
|
1120
|
+
|
|
1121
|
+
</span>
|
|
1122
|
+
|
|
1123
|
+
|
|
1124
|
+
</li><li>
|
|
1125
|
+
<span class="tooltip">
|
|
1126
|
+
<code><a href="#//api/name/NSFP_installCommitCallback">– NSFP_installCommitCallback</a></code>
|
|
1127
|
+
|
|
1128
|
+
</span>
|
|
1129
|
+
|
|
1130
|
+
|
|
1131
|
+
</li><li>
|
|
1132
|
+
<span class="tooltip">
|
|
1133
|
+
<code><a href="#//api/name/NSFP_uninstallCommitCallback">– NSFP_uninstallCommitCallback</a></code>
|
|
1134
|
+
|
|
1135
|
+
</span>
|
|
1136
|
+
|
|
1137
|
+
|
|
1138
|
+
</li>
|
|
1139
|
+
</ul>
|
|
1140
|
+
|
|
1141
|
+
</div>
|
|
1142
|
+
|
|
1143
|
+
|
|
1144
|
+
|
|
1145
|
+
|
|
1146
|
+
|
|
1147
|
+
<div class="section section-methods">
|
|
1148
|
+
<a title="Properties" name="properties"></a>
|
|
1149
|
+
<h2 class="subtitle subtitle-methods">Properties</h2>
|
|
1150
|
+
|
|
1151
|
+
<div class="section-method">
|
|
1152
|
+
<a name="//api/name/cacheMethod" title="cacheMethod"></a>
|
|
1153
|
+
<h3 class="subsubtitle method-title">cacheMethod</h3>
|
|
1154
|
+
|
|
1155
|
+
|
|
1156
|
+
|
|
1157
|
+
<div class="method-subsection brief-description">
|
|
1158
|
+
<ul>
|
|
1159
|
+
<li>The cache mechanism being used.</li>
|
|
1160
|
+
</ul>
|
|
1161
|
+
|
|
1162
|
+
</div>
|
|
1163
|
+
|
|
1164
|
+
|
|
1165
|
+
|
|
1166
|
+
<div class="method-subsection method-declaration"><code>@property (nonatomic, assign, readwrite) NSFCacheMethod cacheMethod</code></div>
|
|
1167
|
+
|
|
1168
|
+
|
|
1169
|
+
|
|
1170
|
+
|
|
1171
|
+
|
|
1172
|
+
|
|
1173
|
+
|
|
1174
|
+
|
|
1175
|
+
|
|
1176
|
+
<div class="method-subsection discussion-section">
|
|
1177
|
+
<h4 class="method-subtitle">Discussion</h4>
|
|
1178
|
+
<ul>
|
|
1179
|
+
<li>The cache mechanism being used.</li>
|
|
1180
|
+
</ul>
|
|
1181
|
+
|
|
1182
|
+
</div>
|
|
1183
|
+
|
|
1184
|
+
|
|
1185
|
+
|
|
1186
|
+
|
|
1187
|
+
|
|
1188
|
+
|
|
1189
|
+
|
|
1190
|
+
<div class="method-subsection declared-in-section">
|
|
1191
|
+
<h4 class="method-subtitle">Declared In</h4>
|
|
1192
|
+
<code class="declared-in-ref">NSFNanoEngine.h</code><br />
|
|
1193
|
+
</div>
|
|
1194
|
+
|
|
1195
|
+
|
|
1196
|
+
</div>
|
|
1197
|
+
|
|
1198
|
+
<div class="section-method">
|
|
1199
|
+
<a name="//api/name/path" title="path"></a>
|
|
1200
|
+
<h3 class="subsubtitle method-title">path</h3>
|
|
1201
|
+
|
|
1202
|
+
|
|
1203
|
+
|
|
1204
|
+
<div class="method-subsection brief-description">
|
|
1205
|
+
<ul>
|
|
1206
|
+
<li>The file path where the database is located.</li>
|
|
1207
|
+
</ul>
|
|
1208
|
+
|
|
1209
|
+
</div>
|
|
1210
|
+
|
|
1211
|
+
|
|
1212
|
+
|
|
1213
|
+
<div class="method-subsection method-declaration"><code>@property (nonatomic, copy, readonly) NSString *path</code></div>
|
|
1214
|
+
|
|
1215
|
+
|
|
1216
|
+
|
|
1217
|
+
|
|
1218
|
+
|
|
1219
|
+
|
|
1220
|
+
|
|
1221
|
+
|
|
1222
|
+
|
|
1223
|
+
<div class="method-subsection discussion-section">
|
|
1224
|
+
<h4 class="method-subtitle">Discussion</h4>
|
|
1225
|
+
<ul>
|
|
1226
|
+
<li>The file path where the database is located.</li>
|
|
1227
|
+
</ul>
|
|
1228
|
+
|
|
1229
|
+
</div>
|
|
1230
|
+
|
|
1231
|
+
|
|
1232
|
+
|
|
1233
|
+
|
|
1234
|
+
|
|
1235
|
+
|
|
1236
|
+
|
|
1237
|
+
<div class="method-subsection declared-in-section">
|
|
1238
|
+
<h4 class="method-subtitle">Declared In</h4>
|
|
1239
|
+
<code class="declared-in-ref">NSFNanoEngine.h</code><br />
|
|
1240
|
+
</div>
|
|
1241
|
+
|
|
1242
|
+
|
|
1243
|
+
</div>
|
|
1244
|
+
|
|
1245
|
+
<div class="section-method">
|
|
1246
|
+
<a name="//api/name/sqlite" title="sqlite"></a>
|
|
1247
|
+
<h3 class="subsubtitle method-title">sqlite</h3>
|
|
1248
|
+
|
|
1249
|
+
|
|
1250
|
+
|
|
1251
|
+
<div class="method-subsection brief-description">
|
|
1252
|
+
<ul>
|
|
1253
|
+
<li>A reference to the SQLite database.</li>
|
|
1254
|
+
</ul>
|
|
1255
|
+
|
|
1256
|
+
</div>
|
|
1257
|
+
|
|
1258
|
+
|
|
1259
|
+
|
|
1260
|
+
<div class="method-subsection method-declaration"><code>@property (nonatomic, assign, readonly) sqlite3 *sqlite</code></div>
|
|
1261
|
+
|
|
1262
|
+
|
|
1263
|
+
|
|
1264
|
+
|
|
1265
|
+
|
|
1266
|
+
|
|
1267
|
+
|
|
1268
|
+
|
|
1269
|
+
|
|
1270
|
+
<div class="method-subsection discussion-section">
|
|
1271
|
+
<h4 class="method-subtitle">Discussion</h4>
|
|
1272
|
+
<ul>
|
|
1273
|
+
<li>A reference to the SQLite database.</li>
|
|
1274
|
+
</ul>
|
|
1275
|
+
|
|
1276
|
+
</div>
|
|
1277
|
+
|
|
1278
|
+
|
|
1279
|
+
|
|
1280
|
+
|
|
1281
|
+
|
|
1282
|
+
|
|
1283
|
+
|
|
1284
|
+
<div class="method-subsection declared-in-section">
|
|
1285
|
+
<h4 class="method-subtitle">Declared In</h4>
|
|
1286
|
+
<code class="declared-in-ref">NSFNanoEngine.h</code><br />
|
|
1287
|
+
</div>
|
|
1288
|
+
|
|
1289
|
+
|
|
1290
|
+
</div>
|
|
1291
|
+
|
|
1292
|
+
</div>
|
|
1293
|
+
|
|
1294
|
+
|
|
1295
|
+
|
|
1296
|
+
<div class="section section-methods">
|
|
1297
|
+
<a title="Class Methods" name="class_methods"></a>
|
|
1298
|
+
<h2 class="subtitle subtitle-methods">Class Methods</h2>
|
|
1299
|
+
|
|
1300
|
+
<div class="section-method">
|
|
1301
|
+
<a name="//api/name/NSFEncodingTypeToNSString:" title="NSFEncodingTypeToNSString:"></a>
|
|
1302
|
+
<h3 class="subsubtitle method-title">NSFEncodingTypeToNSString:</h3>
|
|
1303
|
+
|
|
1304
|
+
|
|
1305
|
+
|
|
1306
|
+
<div class="method-subsection brief-description">
|
|
1307
|
+
<p>Returns the string equivalent of an <a href="#//api/name/encoding">encoding</a> type.</p>
|
|
1308
|
+
</div>
|
|
1309
|
+
|
|
1310
|
+
|
|
1311
|
+
|
|
1312
|
+
<div class="method-subsection method-declaration"><code>+ (NSString *)NSFEncodingTypeToNSString:(NSFEncodingType)<em>value</em></code></div>
|
|
1313
|
+
|
|
1314
|
+
|
|
1315
|
+
|
|
1316
|
+
|
|
1317
|
+
|
|
1318
|
+
<div class="method-subsection return">
|
|
1319
|
+
<h4 class="method-subtitle parameter-title">Return Value</h4>
|
|
1320
|
+
<p>The string equivalent if successful, nil otherwise.</p>
|
|
1321
|
+
</div>
|
|
1322
|
+
|
|
1323
|
+
|
|
1324
|
+
|
|
1325
|
+
|
|
1326
|
+
|
|
1327
|
+
<div class="method-subsection discussion-section">
|
|
1328
|
+
<h4 class="method-subtitle">Discussion</h4>
|
|
1329
|
+
<p>Returns the string equivalent of an <a href="#//api/name/encoding">encoding</a> type.</p>
|
|
1330
|
+
</div>
|
|
1331
|
+
|
|
1332
|
+
|
|
1333
|
+
|
|
1334
|
+
|
|
1335
|
+
|
|
1336
|
+
<div class="method-subsection see-also-section">
|
|
1337
|
+
<h4 class="method-subtitle">See Also</h4>
|
|
1338
|
+
<ul>
|
|
1339
|
+
|
|
1340
|
+
<li><code><ul>
|
|
1341
|
+
<li>(NSFEncodingType)<a href="#//api/name/NSStringToNSFEncodingType:">+ NSStringToNSFEncodingType:</a>(NSString *)value;</li>
|
|
1342
|
+
</ul>
|
|
1343
|
+
</code></li>
|
|
1344
|
+
|
|
1345
|
+
</ul>
|
|
1346
|
+
</div>
|
|
1347
|
+
|
|
1348
|
+
|
|
1349
|
+
|
|
1350
|
+
<div class="method-subsection declared-in-section">
|
|
1351
|
+
<h4 class="method-subtitle">Declared In</h4>
|
|
1352
|
+
<code class="declared-in-ref">NSFNanoEngine.h</code><br />
|
|
1353
|
+
</div>
|
|
1354
|
+
|
|
1355
|
+
|
|
1356
|
+
</div>
|
|
1357
|
+
|
|
1358
|
+
<div class="section-method">
|
|
1359
|
+
<a name="//api/name/NSFP_decodeQuantum:andSource:" title="NSFP_decodeQuantum:andSource:"></a>
|
|
1360
|
+
<h3 class="subsubtitle method-title">NSFP_decodeQuantum:andSource:</h3>
|
|
1361
|
+
|
|
1362
|
+
|
|
1363
|
+
|
|
1364
|
+
<div class="method-subsection method-declaration"><code>+ (void)NSFP_decodeQuantum:(unsigned char *)<em>dest</em> andSource:(const char *)<em>src</em></code></div>
|
|
1365
|
+
|
|
1366
|
+
|
|
1367
|
+
</div>
|
|
1368
|
+
|
|
1369
|
+
<div class="section-method">
|
|
1370
|
+
<a name="//api/name/NSFP_sharedROWIDKeywords" title="NSFP_sharedROWIDKeywords"></a>
|
|
1371
|
+
<h3 class="subsubtitle method-title">NSFP_sharedROWIDKeywords</h3>
|
|
1372
|
+
|
|
1373
|
+
|
|
1374
|
+
|
|
1375
|
+
<div class="method-subsection method-declaration"><code>+ (NSArray *)NSFP_sharedROWIDKeywords</code></div>
|
|
1376
|
+
|
|
1377
|
+
|
|
1378
|
+
</div>
|
|
1379
|
+
|
|
1380
|
+
<div class="section-method">
|
|
1381
|
+
<a name="//api/name/NSFP_stripBitsFromExtendedResultCode:" title="NSFP_stripBitsFromExtendedResultCode:"></a>
|
|
1382
|
+
<h3 class="subsubtitle method-title">NSFP_stripBitsFromExtendedResultCode:</h3>
|
|
1383
|
+
|
|
1384
|
+
|
|
1385
|
+
|
|
1386
|
+
<div class="method-subsection method-declaration"><code>+ (int)NSFP_stripBitsFromExtendedResultCode:(int)<em>extendedResult</em></code></div>
|
|
1387
|
+
|
|
1388
|
+
|
|
1389
|
+
</div>
|
|
1390
|
+
|
|
1391
|
+
<div class="section-method">
|
|
1392
|
+
<a name="//api/name/NSStringToNSFEncodingType:" title="NSStringToNSFEncodingType:"></a>
|
|
1393
|
+
<h3 class="subsubtitle method-title">NSStringToNSFEncodingType:</h3>
|
|
1394
|
+
|
|
1395
|
+
|
|
1396
|
+
|
|
1397
|
+
<div class="method-subsection brief-description">
|
|
1398
|
+
<p>Returns the <a href="#//api/name/encoding">encoding</a> type from its string equivalent.</p>
|
|
1399
|
+
</div>
|
|
1400
|
+
|
|
1401
|
+
|
|
1402
|
+
|
|
1403
|
+
<div class="method-subsection method-declaration"><code>+ (NSFEncodingType)NSStringToNSFEncodingType:(NSString *)<em>value</em></code></div>
|
|
1404
|
+
|
|
1405
|
+
|
|
1406
|
+
|
|
1407
|
+
|
|
1408
|
+
|
|
1409
|
+
<div class="method-subsection return">
|
|
1410
|
+
<h4 class="method-subtitle parameter-title">Return Value</h4>
|
|
1411
|
+
<p>The <a href="#//api/name/encoding">encoding</a> type if successful, NSFEncodingUnknown otherwise.</p>
|
|
1412
|
+
</div>
|
|
1413
|
+
|
|
1414
|
+
|
|
1415
|
+
|
|
1416
|
+
|
|
1417
|
+
|
|
1418
|
+
<div class="method-subsection discussion-section">
|
|
1419
|
+
<h4 class="method-subtitle">Discussion</h4>
|
|
1420
|
+
<p>Returns the <a href="#//api/name/encoding">encoding</a> type from its string equivalent.</p>
|
|
1421
|
+
</div>
|
|
1422
|
+
|
|
1423
|
+
|
|
1424
|
+
|
|
1425
|
+
|
|
1426
|
+
|
|
1427
|
+
<div class="method-subsection see-also-section">
|
|
1428
|
+
<h4 class="method-subtitle">See Also</h4>
|
|
1429
|
+
<ul>
|
|
1430
|
+
|
|
1431
|
+
<li><code><ul>
|
|
1432
|
+
<li>(NSString *)<a href="#//api/name/NSFEncodingTypeToNSString:">+ NSFEncodingTypeToNSString:</a>(NSFEncodingType)value;</li>
|
|
1433
|
+
</ul>
|
|
1434
|
+
</code></li>
|
|
1435
|
+
|
|
1436
|
+
</ul>
|
|
1437
|
+
</div>
|
|
1438
|
+
|
|
1439
|
+
|
|
1440
|
+
|
|
1441
|
+
<div class="method-subsection declared-in-section">
|
|
1442
|
+
<h4 class="method-subtitle">Declared In</h4>
|
|
1443
|
+
<code class="declared-in-ref">NSFNanoEngine.h</code><br />
|
|
1444
|
+
</div>
|
|
1445
|
+
|
|
1446
|
+
|
|
1447
|
+
</div>
|
|
1448
|
+
|
|
1449
|
+
<div class="section-method">
|
|
1450
|
+
<a name="//api/name/_plistToDictionary:" title="_plistToDictionary:"></a>
|
|
1451
|
+
<h3 class="subsubtitle method-title">_plistToDictionary:</h3>
|
|
1452
|
+
|
|
1453
|
+
|
|
1454
|
+
|
|
1455
|
+
<div class="method-subsection method-declaration"><code>+ (NSDictionary *)_plistToDictionary:(NSString *)<em>aPlist</em></code></div>
|
|
1456
|
+
|
|
1457
|
+
|
|
1458
|
+
</div>
|
|
1459
|
+
|
|
1460
|
+
<div class="section-method">
|
|
1461
|
+
<a name="//api/name/databaseWithPath:" title="databaseWithPath:"></a>
|
|
1462
|
+
<h3 class="subsubtitle method-title">databaseWithPath:</h3>
|
|
1463
|
+
|
|
1464
|
+
|
|
1465
|
+
|
|
1466
|
+
<div class="method-subsection brief-description">
|
|
1467
|
+
<p>Creates and returns an engine object at a given file <a href="#//api/name/path">path</a>.</p>
|
|
1468
|
+
</div>
|
|
1469
|
+
|
|
1470
|
+
|
|
1471
|
+
|
|
1472
|
+
<div class="method-subsection method-declaration"><code>+ (id)databaseWithPath:(NSString *)<em>thePath</em></code></div>
|
|
1473
|
+
|
|
1474
|
+
|
|
1475
|
+
|
|
1476
|
+
<div class="method-subsection arguments-section parameters">
|
|
1477
|
+
<h4 class="method-subtitle parameter-title">Parameters</h4>
|
|
1478
|
+
|
|
1479
|
+
<dl class="argument-def parameter-def">
|
|
1480
|
+
<dt><em>thePath</em></dt>
|
|
1481
|
+
<dd><p>the file <a href="#//api/name/path">path</a> where the document store will be created. Must not be nil.</p></dd>
|
|
1482
|
+
</dl>
|
|
1483
|
+
|
|
1484
|
+
</div>
|
|
1485
|
+
|
|
1486
|
+
|
|
1487
|
+
|
|
1488
|
+
<div class="method-subsection return">
|
|
1489
|
+
<h4 class="method-subtitle parameter-title">Return Value</h4>
|
|
1490
|
+
<p>An engine object upon success, nil otherwise.</p>
|
|
1491
|
+
</div>
|
|
1492
|
+
|
|
1493
|
+
|
|
1494
|
+
|
|
1495
|
+
|
|
1496
|
+
|
|
1497
|
+
<div class="method-subsection discussion-section">
|
|
1498
|
+
<h4 class="method-subtitle">Discussion</h4>
|
|
1499
|
+
<p>Creates and returns an engine object at a given file <a href="#//api/name/path">path</a>.</p><div class="note"><p><strong>Note:</strong> To manipulate the document store, you must first open it.</p></div>
|
|
1500
|
+
</div>
|
|
1501
|
+
|
|
1502
|
+
|
|
1503
|
+
|
|
1504
|
+
|
|
1505
|
+
|
|
1506
|
+
<div class="method-subsection see-also-section">
|
|
1507
|
+
<h4 class="method-subtitle">See Also</h4>
|
|
1508
|
+
<ul>
|
|
1509
|
+
|
|
1510
|
+
<li><code><ul>
|
|
1511
|
+
<li>(id)<a href="#//api/name/initWithPath:">– initWithPath:</a>(NSString *)thePath;</li>
|
|
1512
|
+
</ul>
|
|
1513
|
+
</code></li>
|
|
1514
|
+
|
|
1515
|
+
</ul>
|
|
1516
|
+
</div>
|
|
1517
|
+
|
|
1518
|
+
|
|
1519
|
+
|
|
1520
|
+
<div class="method-subsection declared-in-section">
|
|
1521
|
+
<h4 class="method-subtitle">Declared In</h4>
|
|
1522
|
+
<code class="declared-in-ref">NSFNanoEngine.h</code><br />
|
|
1523
|
+
</div>
|
|
1524
|
+
|
|
1525
|
+
|
|
1526
|
+
</div>
|
|
1527
|
+
|
|
1528
|
+
<div class="section-method">
|
|
1529
|
+
<a name="//api/name/decodeDataFromBase64:" title="decodeDataFromBase64:"></a>
|
|
1530
|
+
<h3 class="subsubtitle method-title">decodeDataFromBase64:</h3>
|
|
1531
|
+
|
|
1532
|
+
|
|
1533
|
+
|
|
1534
|
+
<div class="method-subsection brief-description">
|
|
1535
|
+
<p>Returns a data element containing from a base 64 formatted string.</p>
|
|
1536
|
+
</div>
|
|
1537
|
+
|
|
1538
|
+
|
|
1539
|
+
|
|
1540
|
+
<div class="method-subsection method-declaration"><code>+ (NSData *)decodeDataFromBase64:(NSString *)<em>theEncodedData</em></code></div>
|
|
1541
|
+
|
|
1542
|
+
|
|
1543
|
+
|
|
1544
|
+
|
|
1545
|
+
|
|
1546
|
+
<div class="method-subsection return">
|
|
1547
|
+
<h4 class="method-subtitle parameter-title">Return Value</h4>
|
|
1548
|
+
<p>A data element.</p>
|
|
1549
|
+
</div>
|
|
1550
|
+
|
|
1551
|
+
|
|
1552
|
+
|
|
1553
|
+
|
|
1554
|
+
|
|
1555
|
+
<div class="method-subsection discussion-section">
|
|
1556
|
+
<h4 class="method-subtitle">Discussion</h4>
|
|
1557
|
+
<p>Returns a data element containing from a base 64 formatted string.</p>
|
|
1558
|
+
</div>
|
|
1559
|
+
|
|
1560
|
+
|
|
1561
|
+
|
|
1562
|
+
|
|
1563
|
+
|
|
1564
|
+
|
|
1565
|
+
|
|
1566
|
+
<div class="method-subsection declared-in-section">
|
|
1567
|
+
<h4 class="method-subtitle">Declared In</h4>
|
|
1568
|
+
<code class="declared-in-ref">NSFNanoEngine.h</code><br />
|
|
1569
|
+
</div>
|
|
1570
|
+
|
|
1571
|
+
|
|
1572
|
+
</div>
|
|
1573
|
+
|
|
1574
|
+
<div class="section-method">
|
|
1575
|
+
<a name="//api/name/encodeDataToBase64:" title="encodeDataToBase64:"></a>
|
|
1576
|
+
<h3 class="subsubtitle method-title">encodeDataToBase64:</h3>
|
|
1577
|
+
|
|
1578
|
+
|
|
1579
|
+
|
|
1580
|
+
<div class="method-subsection brief-description">
|
|
1581
|
+
<p>Returns a string containing the base 64 representation of a data element.</p>
|
|
1582
|
+
</div>
|
|
1583
|
+
|
|
1584
|
+
|
|
1585
|
+
|
|
1586
|
+
<div class="method-subsection method-declaration"><code>+ (NSString *)encodeDataToBase64:(NSData *)<em>theData</em></code></div>
|
|
1587
|
+
|
|
1588
|
+
|
|
1589
|
+
|
|
1590
|
+
|
|
1591
|
+
|
|
1592
|
+
<div class="method-subsection return">
|
|
1593
|
+
<h4 class="method-subtitle parameter-title">Return Value</h4>
|
|
1594
|
+
<p>A string encoded in base 64 format.</p>
|
|
1595
|
+
</div>
|
|
1596
|
+
|
|
1597
|
+
|
|
1598
|
+
|
|
1599
|
+
|
|
1600
|
+
|
|
1601
|
+
<div class="method-subsection discussion-section">
|
|
1602
|
+
<h4 class="method-subtitle">Discussion</h4>
|
|
1603
|
+
<p>Returns a string containing the base 64 representation of a data element.</p>
|
|
1604
|
+
</div>
|
|
1605
|
+
|
|
1606
|
+
|
|
1607
|
+
|
|
1608
|
+
|
|
1609
|
+
|
|
1610
|
+
|
|
1611
|
+
|
|
1612
|
+
<div class="method-subsection declared-in-section">
|
|
1613
|
+
<h4 class="method-subtitle">Declared In</h4>
|
|
1614
|
+
<code class="declared-in-ref">NSFNanoEngine.h</code><br />
|
|
1615
|
+
</div>
|
|
1616
|
+
|
|
1617
|
+
|
|
1618
|
+
</div>
|
|
1619
|
+
|
|
1620
|
+
<div class="section-method">
|
|
1621
|
+
<a name="//api/name/nanoStoreEngineVersion" title="nanoStoreEngineVersion"></a>
|
|
1622
|
+
<h3 class="subsubtitle method-title">nanoStoreEngineVersion</h3>
|
|
1623
|
+
|
|
1624
|
+
|
|
1625
|
+
|
|
1626
|
+
<div class="method-subsection brief-description">
|
|
1627
|
+
<p>Returns the NanoStore engine version.</p>
|
|
1628
|
+
</div>
|
|
1629
|
+
|
|
1630
|
+
|
|
1631
|
+
|
|
1632
|
+
<div class="method-subsection method-declaration"><code>+ (NSString *)nanoStoreEngineVersion</code></div>
|
|
1633
|
+
|
|
1634
|
+
|
|
1635
|
+
|
|
1636
|
+
|
|
1637
|
+
|
|
1638
|
+
<div class="method-subsection return">
|
|
1639
|
+
<h4 class="method-subtitle parameter-title">Return Value</h4>
|
|
1640
|
+
<p>The NanoStore engine version.</p>
|
|
1641
|
+
</div>
|
|
1642
|
+
|
|
1643
|
+
|
|
1644
|
+
|
|
1645
|
+
|
|
1646
|
+
|
|
1647
|
+
<div class="method-subsection discussion-section">
|
|
1648
|
+
<h4 class="method-subtitle">Discussion</h4>
|
|
1649
|
+
<p>Returns the NanoStore engine version.</p>
|
|
1650
|
+
</div>
|
|
1651
|
+
|
|
1652
|
+
|
|
1653
|
+
|
|
1654
|
+
|
|
1655
|
+
|
|
1656
|
+
|
|
1657
|
+
|
|
1658
|
+
<div class="method-subsection declared-in-section">
|
|
1659
|
+
<h4 class="method-subtitle">Declared In</h4>
|
|
1660
|
+
<code class="declared-in-ref">NSFNanoEngine.h</code><br />
|
|
1661
|
+
</div>
|
|
1662
|
+
|
|
1663
|
+
|
|
1664
|
+
</div>
|
|
1665
|
+
|
|
1666
|
+
<div class="section-method">
|
|
1667
|
+
<a name="//api/name/recommendedCacheSize" title="recommendedCacheSize"></a>
|
|
1668
|
+
<h3 class="subsubtitle method-title">recommendedCacheSize</h3>
|
|
1669
|
+
|
|
1670
|
+
|
|
1671
|
+
|
|
1672
|
+
<div class="method-subsection brief-description">
|
|
1673
|
+
<p>Returns the recommended cache size based on the system resources available.</p>
|
|
1674
|
+
</div>
|
|
1675
|
+
|
|
1676
|
+
|
|
1677
|
+
|
|
1678
|
+
<div class="method-subsection method-declaration"><code>+ (NSUInteger)recommendedCacheSize</code></div>
|
|
1679
|
+
|
|
1680
|
+
|
|
1681
|
+
|
|
1682
|
+
|
|
1683
|
+
|
|
1684
|
+
<div class="method-subsection return">
|
|
1685
|
+
<h4 class="method-subtitle parameter-title">Return Value</h4>
|
|
1686
|
+
<p>The recommended cache size in number of pages.</p>
|
|
1687
|
+
</div>
|
|
1688
|
+
|
|
1689
|
+
|
|
1690
|
+
|
|
1691
|
+
|
|
1692
|
+
|
|
1693
|
+
<div class="method-subsection discussion-section">
|
|
1694
|
+
<h4 class="method-subtitle">Discussion</h4>
|
|
1695
|
+
<p>Returns the recommended cache size based on the system resources available.</p>
|
|
1696
|
+
</div>
|
|
1697
|
+
|
|
1698
|
+
|
|
1699
|
+
|
|
1700
|
+
|
|
1701
|
+
|
|
1702
|
+
|
|
1703
|
+
|
|
1704
|
+
<div class="method-subsection declared-in-section">
|
|
1705
|
+
<h4 class="method-subtitle">Declared In</h4>
|
|
1706
|
+
<code class="declared-in-ref">NSFNanoEngine.h</code><br />
|
|
1707
|
+
</div>
|
|
1708
|
+
|
|
1709
|
+
|
|
1710
|
+
</div>
|
|
1711
|
+
|
|
1712
|
+
<div class="section-method">
|
|
1713
|
+
<a name="//api/name/sharedNanoStoreEngineDatatypes" title="sharedNanoStoreEngineDatatypes"></a>
|
|
1714
|
+
<h3 class="subsubtitle method-title">sharedNanoStoreEngineDatatypes</h3>
|
|
1715
|
+
|
|
1716
|
+
|
|
1717
|
+
|
|
1718
|
+
<div class="method-subsection brief-description">
|
|
1719
|
+
<p>Returns a new array containing the datatypes recognized by NanoStore.</p>
|
|
1720
|
+
</div>
|
|
1721
|
+
|
|
1722
|
+
|
|
1723
|
+
|
|
1724
|
+
<div class="method-subsection method-declaration"><code>+ (NSSet *)sharedNanoStoreEngineDatatypes</code></div>
|
|
1725
|
+
|
|
1726
|
+
|
|
1727
|
+
|
|
1728
|
+
|
|
1729
|
+
|
|
1730
|
+
<div class="method-subsection return">
|
|
1731
|
+
<h4 class="method-subtitle parameter-title">Return Value</h4>
|
|
1732
|
+
<p>A new array containing the datatypes recognized by NanoStore.</p>
|
|
1733
|
+
</div>
|
|
1734
|
+
|
|
1735
|
+
|
|
1736
|
+
|
|
1737
|
+
|
|
1738
|
+
|
|
1739
|
+
<div class="method-subsection discussion-section">
|
|
1740
|
+
<h4 class="method-subtitle">Discussion</h4>
|
|
1741
|
+
<p>Returns a new array containing the datatypes recognized by NanoStore.</p>
|
|
1742
|
+
</div>
|
|
1743
|
+
|
|
1744
|
+
|
|
1745
|
+
|
|
1746
|
+
|
|
1747
|
+
|
|
1748
|
+
|
|
1749
|
+
|
|
1750
|
+
<div class="method-subsection declared-in-section">
|
|
1751
|
+
<h4 class="method-subtitle">Declared In</h4>
|
|
1752
|
+
<code class="declared-in-ref">NSFNanoEngine.h</code><br />
|
|
1753
|
+
</div>
|
|
1754
|
+
|
|
1755
|
+
|
|
1756
|
+
</div>
|
|
1757
|
+
|
|
1758
|
+
<div class="section-method">
|
|
1759
|
+
<a name="//api/name/sqliteVersion" title="sqliteVersion"></a>
|
|
1760
|
+
<h3 class="subsubtitle method-title">sqliteVersion</h3>
|
|
1761
|
+
|
|
1762
|
+
|
|
1763
|
+
|
|
1764
|
+
<div class="method-subsection brief-description">
|
|
1765
|
+
<p>Returns the SQLite version.</p>
|
|
1766
|
+
</div>
|
|
1767
|
+
|
|
1768
|
+
|
|
1769
|
+
|
|
1770
|
+
<div class="method-subsection method-declaration"><code>+ (NSString *)sqliteVersion</code></div>
|
|
1771
|
+
|
|
1772
|
+
|
|
1773
|
+
|
|
1774
|
+
|
|
1775
|
+
|
|
1776
|
+
<div class="method-subsection return">
|
|
1777
|
+
<h4 class="method-subtitle parameter-title">Return Value</h4>
|
|
1778
|
+
<p>The SQLite version.</p>
|
|
1779
|
+
</div>
|
|
1780
|
+
|
|
1781
|
+
|
|
1782
|
+
|
|
1783
|
+
|
|
1784
|
+
|
|
1785
|
+
<div class="method-subsection discussion-section">
|
|
1786
|
+
<h4 class="method-subtitle">Discussion</h4>
|
|
1787
|
+
<p>Returns the SQLite version.</p>
|
|
1788
|
+
</div>
|
|
1789
|
+
|
|
1790
|
+
|
|
1791
|
+
|
|
1792
|
+
|
|
1793
|
+
|
|
1794
|
+
|
|
1795
|
+
|
|
1796
|
+
<div class="method-subsection declared-in-section">
|
|
1797
|
+
<h4 class="method-subtitle">Declared In</h4>
|
|
1798
|
+
<code class="declared-in-ref">NSFNanoEngine.h</code><br />
|
|
1799
|
+
</div>
|
|
1800
|
+
|
|
1801
|
+
|
|
1802
|
+
</div>
|
|
1803
|
+
|
|
1804
|
+
<div class="section-method">
|
|
1805
|
+
<a name="//api/name/stringWithUUID" title="stringWithUUID"></a>
|
|
1806
|
+
<h3 class="subsubtitle method-title">stringWithUUID</h3>
|
|
1807
|
+
|
|
1808
|
+
|
|
1809
|
+
|
|
1810
|
+
<div class="method-subsection brief-description">
|
|
1811
|
+
<p>Returns a UUID string</p>
|
|
1812
|
+
</div>
|
|
1813
|
+
|
|
1814
|
+
|
|
1815
|
+
|
|
1816
|
+
<div class="method-subsection method-declaration"><code>+ (NSString *)stringWithUUID</code></div>
|
|
1817
|
+
|
|
1818
|
+
|
|
1819
|
+
|
|
1820
|
+
|
|
1821
|
+
|
|
1822
|
+
<div class="method-subsection return">
|
|
1823
|
+
<h4 class="method-subtitle parameter-title">Return Value</h4>
|
|
1824
|
+
<p>A string containing a representation of a UUID.</p>
|
|
1825
|
+
</div>
|
|
1826
|
+
|
|
1827
|
+
|
|
1828
|
+
|
|
1829
|
+
|
|
1830
|
+
|
|
1831
|
+
<div class="method-subsection discussion-section">
|
|
1832
|
+
<h4 class="method-subtitle">Discussion</h4>
|
|
1833
|
+
<p>Returns a UUID string</p>
|
|
1834
|
+
</div>
|
|
1835
|
+
|
|
1836
|
+
|
|
1837
|
+
|
|
1838
|
+
|
|
1839
|
+
|
|
1840
|
+
|
|
1841
|
+
|
|
1842
|
+
<div class="method-subsection declared-in-section">
|
|
1843
|
+
<h4 class="method-subtitle">Declared In</h4>
|
|
1844
|
+
<code class="declared-in-ref">NSFNanoEngine.h</code><br />
|
|
1845
|
+
</div>
|
|
1846
|
+
|
|
1847
|
+
|
|
1848
|
+
</div>
|
|
1849
|
+
|
|
1850
|
+
<div class="section-method">
|
|
1851
|
+
<a name="//api/name/systemPageSize" title="systemPageSize"></a>
|
|
1852
|
+
<h3 class="subsubtitle method-title">systemPageSize</h3>
|
|
1853
|
+
|
|
1854
|
+
|
|
1855
|
+
|
|
1856
|
+
<div class="method-subsection brief-description">
|
|
1857
|
+
<p>Returns the system’s page size</p>
|
|
1858
|
+
</div>
|
|
1859
|
+
|
|
1860
|
+
|
|
1861
|
+
|
|
1862
|
+
<div class="method-subsection method-declaration"><code>+ (NSInteger)systemPageSize</code></div>
|
|
1863
|
+
|
|
1864
|
+
|
|
1865
|
+
|
|
1866
|
+
|
|
1867
|
+
|
|
1868
|
+
|
|
1869
|
+
|
|
1870
|
+
|
|
1871
|
+
|
|
1872
|
+
<div class="method-subsection discussion-section">
|
|
1873
|
+
<h4 class="method-subtitle">Discussion</h4>
|
|
1874
|
+
<p>Returns the system’s page size</p>
|
|
1875
|
+
</div>
|
|
1876
|
+
|
|
1877
|
+
|
|
1878
|
+
|
|
1879
|
+
|
|
1880
|
+
|
|
1881
|
+
|
|
1882
|
+
|
|
1883
|
+
<div class="method-subsection declared-in-section">
|
|
1884
|
+
<h4 class="method-subtitle">Declared In</h4>
|
|
1885
|
+
<code class="declared-in-ref">NSFNanoEngine.h</code><br />
|
|
1886
|
+
</div>
|
|
1887
|
+
|
|
1888
|
+
|
|
1889
|
+
</div>
|
|
1890
|
+
|
|
1891
|
+
</div>
|
|
1892
|
+
|
|
1893
|
+
|
|
1894
|
+
|
|
1895
|
+
<div class="section section-methods">
|
|
1896
|
+
<a title="Instance Methods" name="instance_methods"></a>
|
|
1897
|
+
<h2 class="subtitle subtitle-methods">Instance Methods</h2>
|
|
1898
|
+
|
|
1899
|
+
<div class="section-method">
|
|
1900
|
+
<a name="//api/name/JSONDescription" title="JSONDescription"></a>
|
|
1901
|
+
<h3 class="subsubtitle method-title">JSONDescription</h3>
|
|
1902
|
+
|
|
1903
|
+
|
|
1904
|
+
|
|
1905
|
+
<div class="method-subsection brief-description">
|
|
1906
|
+
<p>Returns a JSON representation of the engine.</p>
|
|
1907
|
+
</div>
|
|
1908
|
+
|
|
1909
|
+
|
|
1910
|
+
|
|
1911
|
+
<div class="method-subsection method-declaration"><code>- (NSString *)JSONDescription</code></div>
|
|
1912
|
+
|
|
1913
|
+
|
|
1914
|
+
|
|
1915
|
+
|
|
1916
|
+
|
|
1917
|
+
|
|
1918
|
+
|
|
1919
|
+
|
|
1920
|
+
|
|
1921
|
+
<div class="method-subsection discussion-section">
|
|
1922
|
+
<h4 class="method-subtitle">Discussion</h4>
|
|
1923
|
+
<p>Returns a JSON representation of the engine.</p>
|
|
1924
|
+
</div>
|
|
1925
|
+
|
|
1926
|
+
|
|
1927
|
+
|
|
1928
|
+
|
|
1929
|
+
|
|
1930
|
+
|
|
1931
|
+
|
|
1932
|
+
<div class="method-subsection declared-in-section">
|
|
1933
|
+
<h4 class="method-subtitle">Declared In</h4>
|
|
1934
|
+
<code class="declared-in-ref">NSFNanoEngine.h</code><br />
|
|
1935
|
+
</div>
|
|
1936
|
+
|
|
1937
|
+
|
|
1938
|
+
</div>
|
|
1939
|
+
|
|
1940
|
+
<div class="section-method">
|
|
1941
|
+
<a name="//api/name/NSFP_ROWIDPresenceLocation:datatypes:" title="NSFP_ROWIDPresenceLocation:datatypes:"></a>
|
|
1942
|
+
<h3 class="subsubtitle method-title">NSFP_ROWIDPresenceLocation:datatypes:</h3>
|
|
1943
|
+
|
|
1944
|
+
|
|
1945
|
+
|
|
1946
|
+
<div class="method-subsection method-declaration"><code>- (NSInteger)NSFP_ROWIDPresenceLocation:(NSArray *)<em>tableColumns</em> datatypes:(NSArray *)<em>datatypes</em></code></div>
|
|
1947
|
+
|
|
1948
|
+
|
|
1949
|
+
</div>
|
|
1950
|
+
|
|
1951
|
+
<div class="section-method">
|
|
1952
|
+
<a name="//api/name/NSFP_beginTransactionMode:" title="NSFP_beginTransactionMode:"></a>
|
|
1953
|
+
<h3 class="subsubtitle method-title">NSFP_beginTransactionMode:</h3>
|
|
1954
|
+
|
|
1955
|
+
|
|
1956
|
+
|
|
1957
|
+
<div class="method-subsection method-declaration"><code>- (BOOL)NSFP_beginTransactionMode:(NSString *)<em>theSQLStatement</em></code></div>
|
|
1958
|
+
|
|
1959
|
+
|
|
1960
|
+
</div>
|
|
1961
|
+
|
|
1962
|
+
<div class="section-method">
|
|
1963
|
+
<a name="//api/name/NSFP_cacheMethodToString" title="NSFP_cacheMethodToString"></a>
|
|
1964
|
+
<h3 class="subsubtitle method-title">NSFP_cacheMethodToString</h3>
|
|
1965
|
+
|
|
1966
|
+
|
|
1967
|
+
|
|
1968
|
+
<div class="method-subsection method-declaration"><code>- (NSString *)NSFP_cacheMethodToString</code></div>
|
|
1969
|
+
|
|
1970
|
+
|
|
1971
|
+
</div>
|
|
1972
|
+
|
|
1973
|
+
<div class="section-method">
|
|
1974
|
+
<a name="//api/name/NSFP_createTable:withColumns:datatypes:isTemporary:" title="NSFP_createTable:withColumns:datatypes:isTemporary:"></a>
|
|
1975
|
+
<h3 class="subsubtitle method-title">NSFP_createTable:withColumns:datatypes:isTemporary:</h3>
|
|
1976
|
+
|
|
1977
|
+
|
|
1978
|
+
|
|
1979
|
+
<div class="method-subsection method-declaration"><code>- (BOOL)NSFP_createTable:(NSString *)<em>table</em> withColumns:(NSArray *)<em>tableColumns</em> datatypes:(NSArray *)<em>tableDatatypes</em> isTemporary:(BOOL)<em>isTemporaryFlag</em></code></div>
|
|
1980
|
+
|
|
1981
|
+
|
|
1982
|
+
</div>
|
|
1983
|
+
|
|
1984
|
+
<div class="section-method">
|
|
1985
|
+
<a name="//api/name/NSFP_datatypeForColumn:" title="NSFP_datatypeForColumn:"></a>
|
|
1986
|
+
<h3 class="subsubtitle method-title">NSFP_datatypeForColumn:</h3>
|
|
1987
|
+
|
|
1988
|
+
|
|
1989
|
+
|
|
1990
|
+
<div class="method-subsection method-declaration"><code>- (NSFNanoDatatype)NSFP_datatypeForColumn:(NSString *)<em>tableAndColumn</em></code></div>
|
|
1991
|
+
|
|
1992
|
+
|
|
1993
|
+
</div>
|
|
1994
|
+
|
|
1995
|
+
<div class="section-method">
|
|
1996
|
+
<a name="//api/name/NSFP_datatypeForTable:column:" title="NSFP_datatypeForTable:column:"></a>
|
|
1997
|
+
<h3 class="subsubtitle method-title">NSFP_datatypeForTable:column:</h3>
|
|
1998
|
+
|
|
1999
|
+
|
|
2000
|
+
|
|
2001
|
+
<div class="method-subsection method-declaration"><code>- (NSFNanoDatatype)NSFP_datatypeForTable:(NSString *)<em>table</em> column:(NSString *)<em>column</em></code></div>
|
|
2002
|
+
|
|
2003
|
+
|
|
2004
|
+
</div>
|
|
2005
|
+
|
|
2006
|
+
<div class="section-method">
|
|
2007
|
+
<a name="//api/name/NSFP_flattenAllTables" title="NSFP_flattenAllTables"></a>
|
|
2008
|
+
<h3 class="subsubtitle method-title">NSFP_flattenAllTables</h3>
|
|
2009
|
+
|
|
2010
|
+
|
|
2011
|
+
|
|
2012
|
+
<div class="method-subsection method-declaration"><code>- (NSArray *)NSFP_flattenAllTables</code></div>
|
|
2013
|
+
|
|
2014
|
+
|
|
2015
|
+
</div>
|
|
2016
|
+
|
|
2017
|
+
<div class="section-method">
|
|
2018
|
+
<a name="//api/name/NSFP_insertStringValues:forColumns:table:" title="NSFP_insertStringValues:forColumns:table:"></a>
|
|
2019
|
+
<h3 class="subsubtitle method-title">NSFP_insertStringValues:forColumns:table:</h3>
|
|
2020
|
+
|
|
2021
|
+
|
|
2022
|
+
|
|
2023
|
+
<div class="method-subsection method-declaration"><code>- (BOOL)NSFP_insertStringValues:(NSArray *)<em>values</em> forColumns:(NSArray *)<em>columns</em> table:(NSString *)<em>table</em></code></div>
|
|
2024
|
+
|
|
2025
|
+
|
|
2026
|
+
</div>
|
|
2027
|
+
|
|
2028
|
+
<div class="section-method">
|
|
2029
|
+
<a name="//api/name/NSFP_installCommitCallback" title="NSFP_installCommitCallback"></a>
|
|
2030
|
+
<h3 class="subsubtitle method-title">NSFP_installCommitCallback</h3>
|
|
2031
|
+
|
|
2032
|
+
|
|
2033
|
+
|
|
2034
|
+
<div class="method-subsection method-declaration"><code>- (void)NSFP_installCommitCallback</code></div>
|
|
2035
|
+
|
|
2036
|
+
|
|
2037
|
+
</div>
|
|
2038
|
+
|
|
2039
|
+
<div class="section-method">
|
|
2040
|
+
<a name="//api/name/NSFP_isColumnROWIDAlias:forTable:" title="NSFP_isColumnROWIDAlias:forTable:"></a>
|
|
2041
|
+
<h3 class="subsubtitle method-title">NSFP_isColumnROWIDAlias:forTable:</h3>
|
|
2042
|
+
|
|
2043
|
+
|
|
2044
|
+
|
|
2045
|
+
<div class="method-subsection method-declaration"><code>- (BOOL)NSFP_isColumnROWIDAlias:(NSString *)<em>column</em> forTable:(NSString *)<em>table</em></code></div>
|
|
2046
|
+
|
|
2047
|
+
|
|
2048
|
+
</div>
|
|
2049
|
+
|
|
2050
|
+
<div class="section-method">
|
|
2051
|
+
<a name="//api/name/NSFP_nestedDescriptionWithPrefixedSpace:" title="NSFP_nestedDescriptionWithPrefixedSpace:"></a>
|
|
2052
|
+
<h3 class="subsubtitle method-title">NSFP_nestedDescriptionWithPrefixedSpace:</h3>
|
|
2053
|
+
|
|
2054
|
+
|
|
2055
|
+
|
|
2056
|
+
<div class="method-subsection method-declaration"><code>- (NSString *)NSFP_nestedDescriptionWithPrefixedSpace:(NSString *)<em>prefixedSpace</em></code></div>
|
|
2057
|
+
|
|
2058
|
+
|
|
2059
|
+
</div>
|
|
2060
|
+
|
|
2061
|
+
<div class="section-method">
|
|
2062
|
+
<a name="//api/name/NSFP_prefixWithDotDelimiter:" title="NSFP_prefixWithDotDelimiter:"></a>
|
|
2063
|
+
<h3 class="subsubtitle method-title">NSFP_prefixWithDotDelimiter:</h3>
|
|
2064
|
+
|
|
2065
|
+
|
|
2066
|
+
|
|
2067
|
+
<div class="method-subsection method-declaration"><code>- (NSString *)NSFP_prefixWithDotDelimiter:(NSString *)<em>tableAndColumn</em></code></div>
|
|
2068
|
+
|
|
2069
|
+
|
|
2070
|
+
</div>
|
|
2071
|
+
|
|
2072
|
+
<div class="section-method">
|
|
2073
|
+
<a name="//api/name/NSFP_prepareSQLite3Statement:theSQLStatement:" title="NSFP_prepareSQLite3Statement:theSQLStatement:"></a>
|
|
2074
|
+
<h3 class="subsubtitle method-title">NSFP_prepareSQLite3Statement:theSQLStatement:</h3>
|
|
2075
|
+
|
|
2076
|
+
|
|
2077
|
+
|
|
2078
|
+
<div class="method-subsection method-declaration"><code>- (NSInteger)NSFP_prepareSQLite3Statement:(sqlite3_stmt **)<em>aStatement</em> theSQLStatement:(NSString *)<em>aSQLQuery</em></code></div>
|
|
2079
|
+
|
|
2080
|
+
|
|
2081
|
+
</div>
|
|
2082
|
+
|
|
2083
|
+
<div class="section-method">
|
|
2084
|
+
<a name="//api/name/NSFP_rebuildDatatypeCache" title="NSFP_rebuildDatatypeCache"></a>
|
|
2085
|
+
<h3 class="subsubtitle method-title">NSFP_rebuildDatatypeCache</h3>
|
|
2086
|
+
|
|
2087
|
+
|
|
2088
|
+
|
|
2089
|
+
<div class="method-subsection method-declaration"><code>- (void)NSFP_rebuildDatatypeCache</code></div>
|
|
2090
|
+
|
|
2091
|
+
|
|
2092
|
+
</div>
|
|
2093
|
+
|
|
2094
|
+
<div class="section-method">
|
|
2095
|
+
<a name="//api/name/NSFP_removeColumn:fromTable:" title="NSFP_removeColumn:fromTable:"></a>
|
|
2096
|
+
<h3 class="subsubtitle method-title">NSFP_removeColumn:fromTable:</h3>
|
|
2097
|
+
|
|
2098
|
+
|
|
2099
|
+
|
|
2100
|
+
<div class="method-subsection method-declaration"><code>- (BOOL)NSFP_removeColumn:(NSString *)<em>column</em> fromTable:(NSString *)<em>table</em></code></div>
|
|
2101
|
+
|
|
2102
|
+
|
|
2103
|
+
</div>
|
|
2104
|
+
|
|
2105
|
+
<div class="section-method">
|
|
2106
|
+
<a name="//api/name/NSFP_setFullColumnNamesEnabled" title="NSFP_setFullColumnNamesEnabled"></a>
|
|
2107
|
+
<h3 class="subsubtitle method-title">NSFP_setFullColumnNamesEnabled</h3>
|
|
2108
|
+
|
|
2109
|
+
|
|
2110
|
+
|
|
2111
|
+
<div class="method-subsection method-declaration"><code>- (void)NSFP_setFullColumnNamesEnabled</code></div>
|
|
2112
|
+
|
|
2113
|
+
|
|
2114
|
+
</div>
|
|
2115
|
+
|
|
2116
|
+
<div class="section-method">
|
|
2117
|
+
<a name="//api/name/NSFP_sqlString:appendingTags:" title="NSFP_sqlString:appendingTags:"></a>
|
|
2118
|
+
<h3 class="subsubtitle method-title">NSFP_sqlString:appendingTags:</h3>
|
|
2119
|
+
|
|
2120
|
+
|
|
2121
|
+
|
|
2122
|
+
<div class="method-subsection method-declaration"><code>- (void)NSFP_sqlString:(NSMutableString *)<em>theSQLStatement</em> appendingTags:(NSArray *)<em>columns</em></code></div>
|
|
2123
|
+
|
|
2124
|
+
|
|
2125
|
+
</div>
|
|
2126
|
+
|
|
2127
|
+
<div class="section-method">
|
|
2128
|
+
<a name="//api/name/NSFP_sqlString:appendingTags:quoteTags:" title="NSFP_sqlString:appendingTags:quoteTags:"></a>
|
|
2129
|
+
<h3 class="subsubtitle method-title">NSFP_sqlString:appendingTags:quoteTags:</h3>
|
|
2130
|
+
|
|
2131
|
+
|
|
2132
|
+
|
|
2133
|
+
<div class="method-subsection method-declaration"><code>- (void)NSFP_sqlString:(NSMutableString *)<em>theSQLStatement</em> appendingTags:(NSArray *)<em>tags</em> quoteTags:(BOOL)<em>flag</em></code></div>
|
|
2134
|
+
|
|
2135
|
+
|
|
2136
|
+
</div>
|
|
2137
|
+
|
|
2138
|
+
<div class="section-method">
|
|
2139
|
+
<a name="//api/name/NSFP_sqlString:forTable:withColumns:datatypes:" title="NSFP_sqlString:forTable:withColumns:datatypes:"></a>
|
|
2140
|
+
<h3 class="subsubtitle method-title">NSFP_sqlString:forTable:withColumns:datatypes:</h3>
|
|
2141
|
+
|
|
2142
|
+
|
|
2143
|
+
|
|
2144
|
+
<div class="method-subsection method-declaration"><code>- (BOOL)NSFP_sqlString:(NSMutableString *)<em>theSQLStatement</em> forTable:(NSString *)<em>table</em> withColumns:(NSArray *)<em>columns</em> datatypes:(NSArray *)<em>datatypes</em></code></div>
|
|
2145
|
+
|
|
2146
|
+
|
|
2147
|
+
</div>
|
|
2148
|
+
|
|
2149
|
+
<div class="section-method">
|
|
2150
|
+
<a name="//api/name/NSFP_suffixWithDotDelimiter:" title="NSFP_suffixWithDotDelimiter:"></a>
|
|
2151
|
+
<h3 class="subsubtitle method-title">NSFP_suffixWithDotDelimiter:</h3>
|
|
2152
|
+
|
|
2153
|
+
|
|
2154
|
+
|
|
2155
|
+
<div class="method-subsection method-declaration"><code>- (NSString *)NSFP_suffixWithDotDelimiter:(NSString *)<em>tableAndColumn</em></code></div>
|
|
2156
|
+
|
|
2157
|
+
|
|
2158
|
+
</div>
|
|
2159
|
+
|
|
2160
|
+
<div class="section-method">
|
|
2161
|
+
<a name="//api/name/NSFP_uninstallCommitCallback" title="NSFP_uninstallCommitCallback"></a>
|
|
2162
|
+
<h3 class="subsubtitle method-title">NSFP_uninstallCommitCallback</h3>
|
|
2163
|
+
|
|
2164
|
+
|
|
2165
|
+
|
|
2166
|
+
<div class="method-subsection method-declaration"><code>- (void)NSFP_uninstallCommitCallback</code></div>
|
|
2167
|
+
|
|
2168
|
+
|
|
2169
|
+
</div>
|
|
2170
|
+
|
|
2171
|
+
<div class="section-method">
|
|
2172
|
+
<a name="//api/name/allTables" title="allTables"></a>
|
|
2173
|
+
<h3 class="subsubtitle method-title">allTables</h3>
|
|
2174
|
+
|
|
2175
|
+
|
|
2176
|
+
|
|
2177
|
+
<div class="method-subsection brief-description">
|
|
2178
|
+
<p>Returns a new array containing the <a href="#//api/name/tables">tables</a> found in the main and attached document stores.</p>
|
|
2179
|
+
</div>
|
|
2180
|
+
|
|
2181
|
+
|
|
2182
|
+
|
|
2183
|
+
<div class="method-subsection method-declaration"><code>- (NSDictionary *)allTables</code></div>
|
|
2184
|
+
|
|
2185
|
+
|
|
2186
|
+
|
|
2187
|
+
|
|
2188
|
+
|
|
2189
|
+
<div class="method-subsection return">
|
|
2190
|
+
<h4 class="method-subtitle parameter-title">Return Value</h4>
|
|
2191
|
+
<p>A new array containing the <a href="#//api/name/tables">tables</a> in the main and attached document stores, or an empty array if none is found.
|
|
2192
|
+
@note
|
|
2193
|
+
The dictionary key is the document store name and its value, an array of the <a href="#//api/name/tables">tables</a> associated with that document store.</p>
|
|
2194
|
+
</div>
|
|
2195
|
+
|
|
2196
|
+
|
|
2197
|
+
|
|
2198
|
+
|
|
2199
|
+
|
|
2200
|
+
<div class="method-subsection discussion-section">
|
|
2201
|
+
<h4 class="method-subtitle">Discussion</h4>
|
|
2202
|
+
<p>Returns a new array containing the <a href="#//api/name/tables">tables</a> found in the main and attached document stores.</p>
|
|
2203
|
+
</div>
|
|
2204
|
+
|
|
2205
|
+
|
|
2206
|
+
|
|
2207
|
+
|
|
2208
|
+
|
|
2209
|
+
<div class="method-subsection see-also-section">
|
|
2210
|
+
<h4 class="method-subtitle">See Also</h4>
|
|
2211
|
+
<ul>
|
|
2212
|
+
|
|
2213
|
+
<li><code><ul>
|
|
2214
|
+
<li>(NSArray *)<a href="#//api/name/tables">– tables</a>;</li>
|
|
2215
|
+
</ul>
|
|
2216
|
+
</code></li>
|
|
2217
|
+
|
|
2218
|
+
<li><code><ul>
|
|
2219
|
+
<li>(NSArray *)<a href="#//api/name/temporaryTables">– temporaryTables</a>;</li>
|
|
2220
|
+
</ul>
|
|
2221
|
+
</code></li>
|
|
2222
|
+
|
|
2223
|
+
</ul>
|
|
2224
|
+
</div>
|
|
2225
|
+
|
|
2226
|
+
|
|
2227
|
+
|
|
2228
|
+
<div class="method-subsection declared-in-section">
|
|
2229
|
+
<h4 class="method-subtitle">Declared In</h4>
|
|
2230
|
+
<code class="declared-in-ref">NSFNanoEngine.h</code><br />
|
|
2231
|
+
</div>
|
|
2232
|
+
|
|
2233
|
+
|
|
2234
|
+
</div>
|
|
2235
|
+
|
|
2236
|
+
<div class="section-method">
|
|
2237
|
+
<a name="//api/name/beginDeferredTransaction" title="beginDeferredTransaction"></a>
|
|
2238
|
+
<h3 class="subsubtitle method-title">beginDeferredTransaction</h3>
|
|
2239
|
+
|
|
2240
|
+
|
|
2241
|
+
|
|
2242
|
+
<div class="method-subsection brief-description">
|
|
2243
|
+
<p>Starts a deferred transaction.</p>
|
|
2244
|
+
</div>
|
|
2245
|
+
|
|
2246
|
+
|
|
2247
|
+
|
|
2248
|
+
<div class="method-subsection method-declaration"><code>- (BOOL)beginDeferredTransaction</code></div>
|
|
2249
|
+
|
|
2250
|
+
|
|
2251
|
+
|
|
2252
|
+
|
|
2253
|
+
|
|
2254
|
+
<div class="method-subsection return">
|
|
2255
|
+
<h4 class="method-subtitle parameter-title">Return Value</h4>
|
|
2256
|
+
<p>YES upon success, NO otherwise.</p>
|
|
2257
|
+
</div>
|
|
2258
|
+
|
|
2259
|
+
|
|
2260
|
+
|
|
2261
|
+
|
|
2262
|
+
|
|
2263
|
+
<div class="method-subsection discussion-section">
|
|
2264
|
+
<h4 class="method-subtitle">Discussion</h4>
|
|
2265
|
+
<p>Starts a deferred transaction.</p>
|
|
2266
|
+
</div>
|
|
2267
|
+
|
|
2268
|
+
|
|
2269
|
+
|
|
2270
|
+
|
|
2271
|
+
|
|
2272
|
+
<div class="method-subsection see-also-section">
|
|
2273
|
+
<h4 class="method-subtitle">See Also</h4>
|
|
2274
|
+
<ul>
|
|
2275
|
+
|
|
2276
|
+
<li><code><ul>
|
|
2277
|
+
<li>(BOOL)<a href="#//api/name/beginTransaction">– beginTransaction</a>;</li>
|
|
2278
|
+
</ul>
|
|
2279
|
+
</code></li>
|
|
2280
|
+
|
|
2281
|
+
<li><code><ul>
|
|
2282
|
+
<li>(BOOL)<a href="#//api/name/commitTransaction">– commitTransaction</a>;</li>
|
|
2283
|
+
</ul>
|
|
2284
|
+
</code></li>
|
|
2285
|
+
|
|
2286
|
+
<li><code><ul>
|
|
2287
|
+
<li>(BOOL)<a href="#//api/name/rollbackTransaction">– rollbackTransaction</a>;</li>
|
|
2288
|
+
</ul>
|
|
2289
|
+
</code></li>
|
|
2290
|
+
|
|
2291
|
+
<li><code><ul>
|
|
2292
|
+
<li>(BOOL)<a href="#//api/name/isTransactionActive">– isTransactionActive</a>;</li>
|
|
2293
|
+
</ul>
|
|
2294
|
+
</code></li>
|
|
2295
|
+
|
|
2296
|
+
</ul>
|
|
2297
|
+
</div>
|
|
2298
|
+
|
|
2299
|
+
|
|
2300
|
+
|
|
2301
|
+
<div class="method-subsection declared-in-section">
|
|
2302
|
+
<h4 class="method-subtitle">Declared In</h4>
|
|
2303
|
+
<code class="declared-in-ref">NSFNanoEngine.h</code><br />
|
|
2304
|
+
</div>
|
|
2305
|
+
|
|
2306
|
+
|
|
2307
|
+
</div>
|
|
2308
|
+
|
|
2309
|
+
<div class="section-method">
|
|
2310
|
+
<a name="//api/name/beginTransaction" title="beginTransaction"></a>
|
|
2311
|
+
<h3 class="subsubtitle method-title">beginTransaction</h3>
|
|
2312
|
+
|
|
2313
|
+
|
|
2314
|
+
|
|
2315
|
+
<div class="method-subsection brief-description">
|
|
2316
|
+
<p>Starts a transaction.</p>
|
|
2317
|
+
</div>
|
|
2318
|
+
|
|
2319
|
+
|
|
2320
|
+
|
|
2321
|
+
<div class="method-subsection method-declaration"><code>- (BOOL)beginTransaction</code></div>
|
|
2322
|
+
|
|
2323
|
+
|
|
2324
|
+
|
|
2325
|
+
|
|
2326
|
+
|
|
2327
|
+
<div class="method-subsection return">
|
|
2328
|
+
<h4 class="method-subtitle parameter-title">Return Value</h4>
|
|
2329
|
+
<p>YES upon success, NO otherwise.</p>
|
|
2330
|
+
</div>
|
|
2331
|
+
|
|
2332
|
+
|
|
2333
|
+
|
|
2334
|
+
|
|
2335
|
+
|
|
2336
|
+
<div class="method-subsection discussion-section">
|
|
2337
|
+
<h4 class="method-subtitle">Discussion</h4>
|
|
2338
|
+
<p>Starts a transaction.</p>
|
|
2339
|
+
</div>
|
|
2340
|
+
|
|
2341
|
+
|
|
2342
|
+
|
|
2343
|
+
|
|
2344
|
+
|
|
2345
|
+
<div class="method-subsection see-also-section">
|
|
2346
|
+
<h4 class="method-subtitle">See Also</h4>
|
|
2347
|
+
<ul>
|
|
2348
|
+
|
|
2349
|
+
<li><code><ul>
|
|
2350
|
+
<li>(BOOL)<a href="#//api/name/beginTransaction">– beginTransaction</a>;</li>
|
|
2351
|
+
</ul>
|
|
2352
|
+
</code></li>
|
|
2353
|
+
|
|
2354
|
+
<li><code><ul>
|
|
2355
|
+
<li>(BOOL)<a href="#//api/name/beginDeferredTransaction">– beginDeferredTransaction</a>;</li>
|
|
2356
|
+
</ul>
|
|
2357
|
+
</code></li>
|
|
2358
|
+
|
|
2359
|
+
<li><code><ul>
|
|
2360
|
+
<li>(BOOL)<a href="#//api/name/commitTransaction">– commitTransaction</a>;</li>
|
|
2361
|
+
</ul>
|
|
2362
|
+
</code></li>
|
|
2363
|
+
|
|
2364
|
+
<li><code><ul>
|
|
2365
|
+
<li>(BOOL)<a href="#//api/name/rollbackTransaction">– rollbackTransaction</a>;</li>
|
|
2366
|
+
</ul>
|
|
2367
|
+
</code></li>
|
|
2368
|
+
|
|
2369
|
+
<li><code><ul>
|
|
2370
|
+
<li>(BOOL)<a href="#//api/name/isTransactionActive">– isTransactionActive</a>;</li>
|
|
2371
|
+
</ul>
|
|
2372
|
+
</code></li>
|
|
2373
|
+
|
|
2374
|
+
</ul>
|
|
2375
|
+
</div>
|
|
2376
|
+
|
|
2377
|
+
|
|
2378
|
+
|
|
2379
|
+
<div class="method-subsection declared-in-section">
|
|
2380
|
+
<h4 class="method-subtitle">Declared In</h4>
|
|
2381
|
+
<code class="declared-in-ref">NSFNanoEngine.h</code><br />
|
|
2382
|
+
</div>
|
|
2383
|
+
|
|
2384
|
+
|
|
2385
|
+
</div>
|
|
2386
|
+
|
|
2387
|
+
<div class="section-method">
|
|
2388
|
+
<a name="//api/name/busyTimeout" title="busyTimeout"></a>
|
|
2389
|
+
<h3 class="subsubtitle method-title">busyTimeout</h3>
|
|
2390
|
+
|
|
2391
|
+
|
|
2392
|
+
|
|
2393
|
+
<div class="method-subsection brief-description">
|
|
2394
|
+
<p>Returns the current busy timeout.</p>
|
|
2395
|
+
</div>
|
|
2396
|
+
|
|
2397
|
+
|
|
2398
|
+
|
|
2399
|
+
<div class="method-subsection method-declaration"><code>- (unsigned int)busyTimeout</code></div>
|
|
2400
|
+
|
|
2401
|
+
|
|
2402
|
+
|
|
2403
|
+
|
|
2404
|
+
|
|
2405
|
+
|
|
2406
|
+
|
|
2407
|
+
|
|
2408
|
+
|
|
2409
|
+
<div class="method-subsection discussion-section">
|
|
2410
|
+
<h4 class="method-subtitle">Discussion</h4>
|
|
2411
|
+
<p>Returns the current busy timeout.</p>
|
|
2412
|
+
</div>
|
|
2413
|
+
|
|
2414
|
+
|
|
2415
|
+
|
|
2416
|
+
|
|
2417
|
+
|
|
2418
|
+
<div class="method-subsection see-also-section">
|
|
2419
|
+
<h4 class="method-subtitle">See Also</h4>
|
|
2420
|
+
<ul>
|
|
2421
|
+
|
|
2422
|
+
<li><code><ul>
|
|
2423
|
+
<li>(void)<a href="#//api/name/setBusyTimeout:">– setBusyTimeout:</a>(unsigned int)theTimeout;</li>
|
|
2424
|
+
</ul>
|
|
2425
|
+
</code></li>
|
|
2426
|
+
|
|
2427
|
+
</ul>
|
|
2428
|
+
</div>
|
|
2429
|
+
|
|
2430
|
+
|
|
2431
|
+
|
|
2432
|
+
<div class="method-subsection declared-in-section">
|
|
2433
|
+
<h4 class="method-subtitle">Declared In</h4>
|
|
2434
|
+
<code class="declared-in-ref">NSFNanoEngine.h</code><br />
|
|
2435
|
+
</div>
|
|
2436
|
+
|
|
2437
|
+
|
|
2438
|
+
</div>
|
|
2439
|
+
|
|
2440
|
+
<div class="section-method">
|
|
2441
|
+
<a name="//api/name/cacheSize" title="cacheSize"></a>
|
|
2442
|
+
<h3 class="subsubtitle method-title">cacheSize</h3>
|
|
2443
|
+
|
|
2444
|
+
|
|
2445
|
+
|
|
2446
|
+
<div class="method-subsection brief-description">
|
|
2447
|
+
<p>Returns the cache size.</p>
|
|
2448
|
+
</div>
|
|
2449
|
+
|
|
2450
|
+
|
|
2451
|
+
|
|
2452
|
+
<div class="method-subsection method-declaration"><code>- (NSUInteger)cacheSize</code></div>
|
|
2453
|
+
|
|
2454
|
+
|
|
2455
|
+
|
|
2456
|
+
|
|
2457
|
+
|
|
2458
|
+
<div class="method-subsection return">
|
|
2459
|
+
<h4 class="method-subtitle parameter-title">Return Value</h4>
|
|
2460
|
+
<p>The current cache size.</p>
|
|
2461
|
+
</div>
|
|
2462
|
+
|
|
2463
|
+
|
|
2464
|
+
|
|
2465
|
+
|
|
2466
|
+
|
|
2467
|
+
<div class="method-subsection discussion-section">
|
|
2468
|
+
<h4 class="method-subtitle">Discussion</h4>
|
|
2469
|
+
<p>Returns the cache size.</p>
|
|
2470
|
+
</div>
|
|
2471
|
+
|
|
2472
|
+
|
|
2473
|
+
|
|
2474
|
+
|
|
2475
|
+
|
|
2476
|
+
<div class="method-subsection see-also-section">
|
|
2477
|
+
<h4 class="method-subtitle">See Also</h4>
|
|
2478
|
+
<ul>
|
|
2479
|
+
|
|
2480
|
+
<li><code><ul>
|
|
2481
|
+
<li>(NSUInteger)<a href="#//api/name/recommendedCacheSize">+ recommendedCacheSize</a>;</li>
|
|
2482
|
+
</ul>
|
|
2483
|
+
</code></li>
|
|
2484
|
+
|
|
2485
|
+
<li><code><ul>
|
|
2486
|
+
<li>(BOOL)<a href="#//api/name/setCacheSize:">– setCacheSize:</a>(NSUInteger)numberOfPages;</li>
|
|
2487
|
+
</ul>
|
|
2488
|
+
</code></li>
|
|
2489
|
+
|
|
2490
|
+
</ul>
|
|
2491
|
+
</div>
|
|
2492
|
+
|
|
2493
|
+
|
|
2494
|
+
|
|
2495
|
+
<div class="method-subsection declared-in-section">
|
|
2496
|
+
<h4 class="method-subtitle">Declared In</h4>
|
|
2497
|
+
<code class="declared-in-ref">NSFNanoEngine.h</code><br />
|
|
2498
|
+
</div>
|
|
2499
|
+
|
|
2500
|
+
|
|
2501
|
+
</div>
|
|
2502
|
+
|
|
2503
|
+
<div class="section-method">
|
|
2504
|
+
<a name="//api/name/close" title="close"></a>
|
|
2505
|
+
<h3 class="subsubtitle method-title">close</h3>
|
|
2506
|
+
|
|
2507
|
+
|
|
2508
|
+
|
|
2509
|
+
<div class="method-subsection brief-description">
|
|
2510
|
+
<p>Closes the database.</p>
|
|
2511
|
+
</div>
|
|
2512
|
+
|
|
2513
|
+
|
|
2514
|
+
|
|
2515
|
+
<div class="method-subsection method-declaration"><code>- (BOOL)close</code></div>
|
|
2516
|
+
|
|
2517
|
+
|
|
2518
|
+
|
|
2519
|
+
|
|
2520
|
+
|
|
2521
|
+
<div class="method-subsection return">
|
|
2522
|
+
<h4 class="method-subtitle parameter-title">Return Value</h4>
|
|
2523
|
+
<p>YES upon success, NO otherwise.</p>
|
|
2524
|
+
</div>
|
|
2525
|
+
|
|
2526
|
+
|
|
2527
|
+
|
|
2528
|
+
|
|
2529
|
+
|
|
2530
|
+
<div class="method-subsection discussion-section">
|
|
2531
|
+
<h4 class="method-subtitle">Discussion</h4>
|
|
2532
|
+
<p>Closes the database.</p>
|
|
2533
|
+
</div>
|
|
2534
|
+
|
|
2535
|
+
|
|
2536
|
+
|
|
2537
|
+
|
|
2538
|
+
|
|
2539
|
+
|
|
2540
|
+
|
|
2541
|
+
<div class="method-subsection declared-in-section">
|
|
2542
|
+
<h4 class="method-subtitle">Declared In</h4>
|
|
2543
|
+
<code class="declared-in-ref">NSFNanoEngine.h</code><br />
|
|
2544
|
+
</div>
|
|
2545
|
+
|
|
2546
|
+
|
|
2547
|
+
</div>
|
|
2548
|
+
|
|
2549
|
+
<div class="section-method">
|
|
2550
|
+
<a name="//api/name/columnsForTable:" title="columnsForTable:"></a>
|
|
2551
|
+
<h3 class="subsubtitle method-title">columnsForTable:</h3>
|
|
2552
|
+
|
|
2553
|
+
|
|
2554
|
+
|
|
2555
|
+
<div class="method-subsection brief-description">
|
|
2556
|
+
<p>Returns a new array containing the columns for a given table.</p>
|
|
2557
|
+
</div>
|
|
2558
|
+
|
|
2559
|
+
|
|
2560
|
+
|
|
2561
|
+
<div class="method-subsection method-declaration"><code>- (NSArray *)columnsForTable:(NSString *)<em>theTable</em></code></div>
|
|
2562
|
+
|
|
2563
|
+
|
|
2564
|
+
|
|
2565
|
+
<div class="method-subsection arguments-section parameters">
|
|
2566
|
+
<h4 class="method-subtitle parameter-title">Parameters</h4>
|
|
2567
|
+
|
|
2568
|
+
<dl class="argument-def parameter-def">
|
|
2569
|
+
<dt><em>theTable</em></dt>
|
|
2570
|
+
<dd><p>is the name of the table.</p></dd>
|
|
2571
|
+
</dl>
|
|
2572
|
+
|
|
2573
|
+
</div>
|
|
2574
|
+
|
|
2575
|
+
|
|
2576
|
+
|
|
2577
|
+
<div class="method-subsection return">
|
|
2578
|
+
<h4 class="method-subtitle parameter-title">Return Value</h4>
|
|
2579
|
+
<p>A new array containing the columns for a given table, or an empty array if none is found.</p>
|
|
2580
|
+
</div>
|
|
2581
|
+
|
|
2582
|
+
|
|
2583
|
+
|
|
2584
|
+
|
|
2585
|
+
|
|
2586
|
+
<div class="method-subsection discussion-section">
|
|
2587
|
+
<h4 class="method-subtitle">Discussion</h4>
|
|
2588
|
+
<p>Returns a new array containing the columns for a given table.</p>
|
|
2589
|
+
</div>
|
|
2590
|
+
|
|
2591
|
+
|
|
2592
|
+
|
|
2593
|
+
|
|
2594
|
+
|
|
2595
|
+
|
|
2596
|
+
|
|
2597
|
+
<div class="method-subsection declared-in-section">
|
|
2598
|
+
<h4 class="method-subtitle">Declared In</h4>
|
|
2599
|
+
<code class="declared-in-ref">NSFNanoEngine.h</code><br />
|
|
2600
|
+
</div>
|
|
2601
|
+
|
|
2602
|
+
|
|
2603
|
+
</div>
|
|
2604
|
+
|
|
2605
|
+
<div class="section-method">
|
|
2606
|
+
<a name="//api/name/commitTransaction" title="commitTransaction"></a>
|
|
2607
|
+
<h3 class="subsubtitle method-title">commitTransaction</h3>
|
|
2608
|
+
|
|
2609
|
+
|
|
2610
|
+
|
|
2611
|
+
<div class="method-subsection brief-description">
|
|
2612
|
+
<p>Commits a transaction.</p>
|
|
2613
|
+
</div>
|
|
2614
|
+
|
|
2615
|
+
|
|
2616
|
+
|
|
2617
|
+
<div class="method-subsection method-declaration"><code>- (BOOL)commitTransaction</code></div>
|
|
2618
|
+
|
|
2619
|
+
|
|
2620
|
+
|
|
2621
|
+
|
|
2622
|
+
|
|
2623
|
+
<div class="method-subsection return">
|
|
2624
|
+
<h4 class="method-subtitle parameter-title">Return Value</h4>
|
|
2625
|
+
<p>YES upon success, NO otherwise.</p>
|
|
2626
|
+
</div>
|
|
2627
|
+
|
|
2628
|
+
|
|
2629
|
+
|
|
2630
|
+
|
|
2631
|
+
|
|
2632
|
+
<div class="method-subsection discussion-section">
|
|
2633
|
+
<h4 class="method-subtitle">Discussion</h4>
|
|
2634
|
+
<p>Commits a transaction.</p>
|
|
2635
|
+
</div>
|
|
2636
|
+
|
|
2637
|
+
|
|
2638
|
+
|
|
2639
|
+
|
|
2640
|
+
|
|
2641
|
+
<div class="method-subsection see-also-section">
|
|
2642
|
+
<h4 class="method-subtitle">See Also</h4>
|
|
2643
|
+
<ul>
|
|
2644
|
+
|
|
2645
|
+
<li><code><ul>
|
|
2646
|
+
<li>(BOOL)<a href="#//api/name/beginTransaction">– beginTransaction</a>;</li>
|
|
2647
|
+
</ul>
|
|
2648
|
+
</code></li>
|
|
2649
|
+
|
|
2650
|
+
<li><code><ul>
|
|
2651
|
+
<li>(BOOL)<a href="#//api/name/beginDeferredTransaction">– beginDeferredTransaction</a>;</li>
|
|
2652
|
+
</ul>
|
|
2653
|
+
</code></li>
|
|
2654
|
+
|
|
2655
|
+
<li><code><ul>
|
|
2656
|
+
<li>(BOOL)<a href="#//api/name/rollbackTransaction">– rollbackTransaction</a>;</li>
|
|
2657
|
+
</ul>
|
|
2658
|
+
</code></li>
|
|
2659
|
+
|
|
2660
|
+
<li><code><ul>
|
|
2661
|
+
<li>(BOOL)<a href="#//api/name/isTransactionActive">– isTransactionActive</a>;</li>
|
|
2662
|
+
</ul>
|
|
2663
|
+
</code></li>
|
|
2664
|
+
|
|
2665
|
+
</ul>
|
|
2666
|
+
</div>
|
|
2667
|
+
|
|
2668
|
+
|
|
2669
|
+
|
|
2670
|
+
<div class="method-subsection declared-in-section">
|
|
2671
|
+
<h4 class="method-subtitle">Declared In</h4>
|
|
2672
|
+
<code class="declared-in-ref">NSFNanoEngine.h</code><br />
|
|
2673
|
+
</div>
|
|
2674
|
+
|
|
2675
|
+
|
|
2676
|
+
</div>
|
|
2677
|
+
|
|
2678
|
+
<div class="section-method">
|
|
2679
|
+
<a name="//api/name/compact" title="compact"></a>
|
|
2680
|
+
<h3 class="subsubtitle method-title">compact</h3>
|
|
2681
|
+
|
|
2682
|
+
|
|
2683
|
+
|
|
2684
|
+
<div class="method-subsection brief-description">
|
|
2685
|
+
<p>Compacts the database, attempting to reclaim unused space.</p>
|
|
2686
|
+
</div>
|
|
2687
|
+
|
|
2688
|
+
|
|
2689
|
+
|
|
2690
|
+
<div class="method-subsection method-declaration"><code>- (BOOL)compact</code></div>
|
|
2691
|
+
|
|
2692
|
+
|
|
2693
|
+
|
|
2694
|
+
|
|
2695
|
+
|
|
2696
|
+
<div class="method-subsection return">
|
|
2697
|
+
<h4 class="method-subtitle parameter-title">Return Value</h4>
|
|
2698
|
+
<p>YES upon success, NO otherwise.</p>
|
|
2699
|
+
</div>
|
|
2700
|
+
|
|
2701
|
+
|
|
2702
|
+
|
|
2703
|
+
|
|
2704
|
+
|
|
2705
|
+
<div class="method-subsection discussion-section">
|
|
2706
|
+
<h4 class="method-subtitle">Discussion</h4>
|
|
2707
|
+
<p>Compacts the database, attempting to reclaim unused space.</p><div class="note"><p><strong>Note:</strong> If a transaction is open, the operation will not proceed and NO will be returned instead.</p></div>
|
|
2708
|
+
</div>
|
|
2709
|
+
|
|
2710
|
+
|
|
2711
|
+
|
|
2712
|
+
|
|
2713
|
+
|
|
2714
|
+
|
|
2715
|
+
|
|
2716
|
+
<div class="method-subsection declared-in-section">
|
|
2717
|
+
<h4 class="method-subtitle">Declared In</h4>
|
|
2718
|
+
<code class="declared-in-ref">NSFNanoEngine.h</code><br />
|
|
2719
|
+
</div>
|
|
2720
|
+
|
|
2721
|
+
|
|
2722
|
+
</div>
|
|
2723
|
+
|
|
2724
|
+
<div class="section-method">
|
|
2725
|
+
<a name="//api/name/createIndexForColumn:table:isUnique:" title="createIndexForColumn:table:isUnique:"></a>
|
|
2726
|
+
<h3 class="subsubtitle method-title">createIndexForColumn:table:isUnique:</h3>
|
|
2727
|
+
|
|
2728
|
+
|
|
2729
|
+
|
|
2730
|
+
<div class="method-subsection brief-description">
|
|
2731
|
+
<p>Creates an index.</p>
|
|
2732
|
+
</div>
|
|
2733
|
+
|
|
2734
|
+
|
|
2735
|
+
|
|
2736
|
+
<div class="method-subsection method-declaration"><code>- (BOOL)createIndexForColumn:(NSString *)<em>theColumn</em> table:(NSString *)<em>theTable</em> isUnique:(BOOL)<em>isUnique</em></code></div>
|
|
2737
|
+
|
|
2738
|
+
|
|
2739
|
+
|
|
2740
|
+
<div class="method-subsection arguments-section parameters">
|
|
2741
|
+
<h4 class="method-subtitle parameter-title">Parameters</h4>
|
|
2742
|
+
|
|
2743
|
+
<dl class="argument-def parameter-def">
|
|
2744
|
+
<dt><em>theColumn</em></dt>
|
|
2745
|
+
<dd><p>is the name of the column.</p></dd>
|
|
2746
|
+
</dl>
|
|
2747
|
+
|
|
2748
|
+
<dl class="argument-def parameter-def">
|
|
2749
|
+
<dt><em>theTable</em></dt>
|
|
2750
|
+
<dd><p>is the name of the table.</p></dd>
|
|
2751
|
+
</dl>
|
|
2752
|
+
|
|
2753
|
+
<dl class="argument-def parameter-def">
|
|
2754
|
+
<dt><em>isUnique</em></dt>
|
|
2755
|
+
<dd><p>whether the index should be unique or allow duplicates.</p></dd>
|
|
2756
|
+
</dl>
|
|
2757
|
+
|
|
2758
|
+
</div>
|
|
2759
|
+
|
|
2760
|
+
|
|
2761
|
+
|
|
2762
|
+
<div class="method-subsection return">
|
|
2763
|
+
<h4 class="method-subtitle parameter-title">Return Value</h4>
|
|
2764
|
+
<p>YES upon success, NO otherwise.</p>
|
|
2765
|
+
</div>
|
|
2766
|
+
|
|
2767
|
+
|
|
2768
|
+
|
|
2769
|
+
|
|
2770
|
+
|
|
2771
|
+
<div class="method-subsection discussion-section">
|
|
2772
|
+
<h4 class="method-subtitle">Discussion</h4>
|
|
2773
|
+
<p>Creates an index.</p>
|
|
2774
|
+
</div>
|
|
2775
|
+
|
|
2776
|
+
|
|
2777
|
+
|
|
2778
|
+
|
|
2779
|
+
|
|
2780
|
+
<div class="method-subsection see-also-section">
|
|
2781
|
+
<h4 class="method-subtitle">See Also</h4>
|
|
2782
|
+
<ul>
|
|
2783
|
+
|
|
2784
|
+
<li><code><ul>
|
|
2785
|
+
<li>(void)<a href="#//api/name/dropIndex:">– dropIndex:</a>(NSString *)indexName;</li>
|
|
2786
|
+
</ul>
|
|
2787
|
+
</code></li>
|
|
2788
|
+
|
|
2789
|
+
</ul>
|
|
2790
|
+
</div>
|
|
2791
|
+
|
|
2792
|
+
|
|
2793
|
+
|
|
2794
|
+
<div class="method-subsection declared-in-section">
|
|
2795
|
+
<h4 class="method-subtitle">Declared In</h4>
|
|
2796
|
+
<code class="declared-in-ref">NSFNanoEngine.h</code><br />
|
|
2797
|
+
</div>
|
|
2798
|
+
|
|
2799
|
+
|
|
2800
|
+
</div>
|
|
2801
|
+
|
|
2802
|
+
<div class="section-method">
|
|
2803
|
+
<a name="//api/name/createTable:withColumns:datatypes:" title="createTable:withColumns:datatypes:"></a>
|
|
2804
|
+
<h3 class="subsubtitle method-title">createTable:withColumns:datatypes:</h3>
|
|
2805
|
+
|
|
2806
|
+
|
|
2807
|
+
|
|
2808
|
+
<div class="method-subsection brief-description">
|
|
2809
|
+
<p>Creates a table.</p>
|
|
2810
|
+
</div>
|
|
2811
|
+
|
|
2812
|
+
|
|
2813
|
+
|
|
2814
|
+
<div class="method-subsection method-declaration"><code>- (BOOL)createTable:(NSString *)<em>theTable</em> withColumns:(NSArray *)<em>theColumns</em> datatypes:(NSArray *)<em>theDatatypes</em></code></div>
|
|
2815
|
+
|
|
2816
|
+
|
|
2817
|
+
|
|
2818
|
+
<div class="method-subsection arguments-section parameters">
|
|
2819
|
+
<h4 class="method-subtitle parameter-title">Parameters</h4>
|
|
2820
|
+
|
|
2821
|
+
<dl class="argument-def parameter-def">
|
|
2822
|
+
<dt><em>theTable</em></dt>
|
|
2823
|
+
<dd><p>the name of the table. Must not be nil.</p></dd>
|
|
2824
|
+
</dl>
|
|
2825
|
+
|
|
2826
|
+
<dl class="argument-def parameter-def">
|
|
2827
|
+
<dt><em>theColumns</em></dt>
|
|
2828
|
+
<dd><p>the names of the columns. Must not be nil.</p></dd>
|
|
2829
|
+
</dl>
|
|
2830
|
+
|
|
2831
|
+
<dl class="argument-def parameter-def">
|
|
2832
|
+
<dt><em>theDatatypes</em></dt>
|
|
2833
|
+
<dd><p>the datatypes of the columns. Must not be nil.</p></dd>
|
|
2834
|
+
</dl>
|
|
2835
|
+
|
|
2836
|
+
</div>
|
|
2837
|
+
|
|
2838
|
+
|
|
2839
|
+
|
|
2840
|
+
<div class="method-subsection return">
|
|
2841
|
+
<h4 class="method-subtitle parameter-title">Return Value</h4>
|
|
2842
|
+
<p>YES upon success, NO otherwise.
|
|
2843
|
+
@note
|
|
2844
|
+
Allowed datatypes: NSFNanoTypeRowUID, NSFNanoTypeString, NSFNanoTypeData, NSFNanoTypeDate and NSFNanoTypeNumber.
|
|
2845
|
+
@throws NSFUnexpectedParameterException is thrown if any of the parameters are nil.
|
|
2846
|
+
@throws NSFUnexpectedParameterException is thrown if the number of columns and datatypes are not equal.</p>
|
|
2847
|
+
</div>
|
|
2848
|
+
|
|
2849
|
+
|
|
2850
|
+
|
|
2851
|
+
|
|
2852
|
+
|
|
2853
|
+
<div class="method-subsection discussion-section">
|
|
2854
|
+
<h4 class="method-subtitle">Discussion</h4>
|
|
2855
|
+
<p>Creates a table.</p>
|
|
2856
|
+
</div>
|
|
2857
|
+
|
|
2858
|
+
|
|
2859
|
+
|
|
2860
|
+
|
|
2861
|
+
|
|
2862
|
+
<div class="method-subsection see-also-section">
|
|
2863
|
+
<h4 class="method-subtitle">See Also</h4>
|
|
2864
|
+
<ul>
|
|
2865
|
+
|
|
2866
|
+
<li><code><ul>
|
|
2867
|
+
<li>(BOOL)<a href="#//api/name/dropTable:">– dropTable:</a>(NSString *)theTable;</li>
|
|
2868
|
+
</ul>
|
|
2869
|
+
</code></li>
|
|
2870
|
+
|
|
2871
|
+
</ul>
|
|
2872
|
+
</div>
|
|
2873
|
+
|
|
2874
|
+
|
|
2875
|
+
|
|
2876
|
+
<div class="method-subsection declared-in-section">
|
|
2877
|
+
<h4 class="method-subtitle">Declared In</h4>
|
|
2878
|
+
<code class="declared-in-ref">NSFNanoEngine.h</code><br />
|
|
2879
|
+
</div>
|
|
2880
|
+
|
|
2881
|
+
|
|
2882
|
+
</div>
|
|
2883
|
+
|
|
2884
|
+
<div class="section-method">
|
|
2885
|
+
<a name="//api/name/datatypesForTable:" title="datatypesForTable:"></a>
|
|
2886
|
+
<h3 class="subsubtitle method-title">datatypesForTable:</h3>
|
|
2887
|
+
|
|
2888
|
+
|
|
2889
|
+
|
|
2890
|
+
<div class="method-subsection brief-description">
|
|
2891
|
+
<p>Returns a new array containing the datatypes for a given table.</p>
|
|
2892
|
+
</div>
|
|
2893
|
+
|
|
2894
|
+
|
|
2895
|
+
|
|
2896
|
+
<div class="method-subsection method-declaration"><code>- (NSArray *)datatypesForTable:(NSString *)<em>theTable</em></code></div>
|
|
2897
|
+
|
|
2898
|
+
|
|
2899
|
+
|
|
2900
|
+
<div class="method-subsection arguments-section parameters">
|
|
2901
|
+
<h4 class="method-subtitle parameter-title">Parameters</h4>
|
|
2902
|
+
|
|
2903
|
+
<dl class="argument-def parameter-def">
|
|
2904
|
+
<dt><em>theTable</em></dt>
|
|
2905
|
+
<dd><p>is the name of the table.</p></dd>
|
|
2906
|
+
</dl>
|
|
2907
|
+
|
|
2908
|
+
</div>
|
|
2909
|
+
|
|
2910
|
+
|
|
2911
|
+
|
|
2912
|
+
<div class="method-subsection return">
|
|
2913
|
+
<h4 class="method-subtitle parameter-title">Return Value</h4>
|
|
2914
|
+
<p>A new array containing the datatypes for a given table, or an empty array if none is found.</p>
|
|
2915
|
+
</div>
|
|
2916
|
+
|
|
2917
|
+
|
|
2918
|
+
|
|
2919
|
+
|
|
2920
|
+
|
|
2921
|
+
<div class="method-subsection discussion-section">
|
|
2922
|
+
<h4 class="method-subtitle">Discussion</h4>
|
|
2923
|
+
<p>Returns a new array containing the datatypes for a given table.</p>
|
|
2924
|
+
</div>
|
|
2925
|
+
|
|
2926
|
+
|
|
2927
|
+
|
|
2928
|
+
|
|
2929
|
+
|
|
2930
|
+
|
|
2931
|
+
|
|
2932
|
+
<div class="method-subsection declared-in-section">
|
|
2933
|
+
<h4 class="method-subtitle">Declared In</h4>
|
|
2934
|
+
<code class="declared-in-ref">NSFNanoEngine.h</code><br />
|
|
2935
|
+
</div>
|
|
2936
|
+
|
|
2937
|
+
|
|
2938
|
+
</div>
|
|
2939
|
+
|
|
2940
|
+
<div class="section-method">
|
|
2941
|
+
<a name="//api/name/description" title="description"></a>
|
|
2942
|
+
<h3 class="subsubtitle method-title">description</h3>
|
|
2943
|
+
|
|
2944
|
+
|
|
2945
|
+
|
|
2946
|
+
<div class="method-subsection brief-description">
|
|
2947
|
+
<p>Returns a string representation of the engine.</p>
|
|
2948
|
+
</div>
|
|
2949
|
+
|
|
2950
|
+
|
|
2951
|
+
|
|
2952
|
+
<div class="method-subsection method-declaration"><code>- (NSString *)description</code></div>
|
|
2953
|
+
|
|
2954
|
+
|
|
2955
|
+
|
|
2956
|
+
|
|
2957
|
+
|
|
2958
|
+
|
|
2959
|
+
|
|
2960
|
+
|
|
2961
|
+
|
|
2962
|
+
<div class="method-subsection discussion-section">
|
|
2963
|
+
<h4 class="method-subtitle">Discussion</h4>
|
|
2964
|
+
<p>Returns a string representation of the engine.</p>
|
|
2965
|
+
</div>
|
|
2966
|
+
|
|
2967
|
+
|
|
2968
|
+
|
|
2969
|
+
|
|
2970
|
+
|
|
2971
|
+
|
|
2972
|
+
|
|
2973
|
+
<div class="method-subsection declared-in-section">
|
|
2974
|
+
<h4 class="method-subtitle">Declared In</h4>
|
|
2975
|
+
<code class="declared-in-ref">NSFNanoEngine.h</code><br />
|
|
2976
|
+
</div>
|
|
2977
|
+
|
|
2978
|
+
|
|
2979
|
+
</div>
|
|
2980
|
+
|
|
2981
|
+
<div class="section-method">
|
|
2982
|
+
<a name="//api/name/dictionaryDescription" title="dictionaryDescription"></a>
|
|
2983
|
+
<h3 class="subsubtitle method-title">dictionaryDescription</h3>
|
|
2984
|
+
|
|
2985
|
+
|
|
2986
|
+
|
|
2987
|
+
<div class="method-subsection method-declaration"><code>- (NSFOrderedDictionary *)dictionaryDescription</code></div>
|
|
2988
|
+
|
|
2989
|
+
|
|
2990
|
+
</div>
|
|
2991
|
+
|
|
2992
|
+
<div class="section-method">
|
|
2993
|
+
<a name="//api/name/dropIndex:" title="dropIndex:"></a>
|
|
2994
|
+
<h3 class="subsubtitle method-title">dropIndex:</h3>
|
|
2995
|
+
|
|
2996
|
+
|
|
2997
|
+
|
|
2998
|
+
<div class="method-subsection brief-description">
|
|
2999
|
+
<p>Removes an index.</p>
|
|
3000
|
+
</div>
|
|
3001
|
+
|
|
3002
|
+
|
|
3003
|
+
|
|
3004
|
+
<div class="method-subsection method-declaration"><code>- (void)dropIndex:(NSString *)<em>theIndex</em></code></div>
|
|
3005
|
+
|
|
3006
|
+
|
|
3007
|
+
|
|
3008
|
+
<div class="method-subsection arguments-section parameters">
|
|
3009
|
+
<h4 class="method-subtitle parameter-title">Parameters</h4>
|
|
3010
|
+
|
|
3011
|
+
<dl class="argument-def parameter-def">
|
|
3012
|
+
<dt><em>theIndex</em></dt>
|
|
3013
|
+
<dd><p>is the name of the index to be removed.</p></dd>
|
|
3014
|
+
</dl>
|
|
3015
|
+
|
|
3016
|
+
</div>
|
|
3017
|
+
|
|
3018
|
+
|
|
3019
|
+
|
|
3020
|
+
|
|
3021
|
+
|
|
3022
|
+
|
|
3023
|
+
|
|
3024
|
+
<div class="method-subsection discussion-section">
|
|
3025
|
+
<h4 class="method-subtitle">Discussion</h4>
|
|
3026
|
+
<p>Removes an index.</p>
|
|
3027
|
+
</div>
|
|
3028
|
+
|
|
3029
|
+
|
|
3030
|
+
|
|
3031
|
+
|
|
3032
|
+
|
|
3033
|
+
|
|
3034
|
+
|
|
3035
|
+
<div class="method-subsection declared-in-section">
|
|
3036
|
+
<h4 class="method-subtitle">Declared In</h4>
|
|
3037
|
+
<code class="declared-in-ref">NSFNanoEngine.h</code><br />
|
|
3038
|
+
</div>
|
|
3039
|
+
|
|
3040
|
+
|
|
3041
|
+
</div>
|
|
3042
|
+
|
|
3043
|
+
<div class="section-method">
|
|
3044
|
+
<a name="//api/name/dropTable:" title="dropTable:"></a>
|
|
3045
|
+
<h3 class="subsubtitle method-title">dropTable:</h3>
|
|
3046
|
+
|
|
3047
|
+
|
|
3048
|
+
|
|
3049
|
+
<div class="method-subsection brief-description">
|
|
3050
|
+
<p>Removes the table from the document store.</p>
|
|
3051
|
+
</div>
|
|
3052
|
+
|
|
3053
|
+
|
|
3054
|
+
|
|
3055
|
+
<div class="method-subsection method-declaration"><code>- (BOOL)dropTable:(NSString *)<em>theTable</em></code></div>
|
|
3056
|
+
|
|
3057
|
+
|
|
3058
|
+
|
|
3059
|
+
<div class="method-subsection arguments-section parameters">
|
|
3060
|
+
<h4 class="method-subtitle parameter-title">Parameters</h4>
|
|
3061
|
+
|
|
3062
|
+
<dl class="argument-def parameter-def">
|
|
3063
|
+
<dt><em>theTable</em></dt>
|
|
3064
|
+
<dd><p>is the name of the table.</p></dd>
|
|
3065
|
+
</dl>
|
|
3066
|
+
|
|
3067
|
+
</div>
|
|
3068
|
+
|
|
3069
|
+
|
|
3070
|
+
|
|
3071
|
+
<div class="method-subsection return">
|
|
3072
|
+
<h4 class="method-subtitle parameter-title">Return Value</h4>
|
|
3073
|
+
<p>YES upon success, NO otherwise.</p>
|
|
3074
|
+
</div>
|
|
3075
|
+
|
|
3076
|
+
|
|
3077
|
+
|
|
3078
|
+
|
|
3079
|
+
|
|
3080
|
+
<div class="method-subsection discussion-section">
|
|
3081
|
+
<h4 class="method-subtitle">Discussion</h4>
|
|
3082
|
+
<p>Removes the table from the document store.</p>
|
|
3083
|
+
</div>
|
|
3084
|
+
|
|
3085
|
+
|
|
3086
|
+
|
|
3087
|
+
|
|
3088
|
+
|
|
3089
|
+
|
|
3090
|
+
|
|
3091
|
+
<div class="method-subsection declared-in-section">
|
|
3092
|
+
<h4 class="method-subtitle">Declared In</h4>
|
|
3093
|
+
<code class="declared-in-ref">NSFNanoEngine.h</code><br />
|
|
3094
|
+
</div>
|
|
3095
|
+
|
|
3096
|
+
|
|
3097
|
+
</div>
|
|
3098
|
+
|
|
3099
|
+
<div class="section-method">
|
|
3100
|
+
<a name="//api/name/encoding" title="encoding"></a>
|
|
3101
|
+
<h3 class="subsubtitle method-title">encoding</h3>
|
|
3102
|
+
|
|
3103
|
+
|
|
3104
|
+
|
|
3105
|
+
<div class="method-subsection brief-description">
|
|
3106
|
+
<p>Returns the encoding type.</p>
|
|
3107
|
+
</div>
|
|
3108
|
+
|
|
3109
|
+
|
|
3110
|
+
|
|
3111
|
+
<div class="method-subsection method-declaration"><code>- (NSFEncodingType)encoding</code></div>
|
|
3112
|
+
|
|
3113
|
+
|
|
3114
|
+
|
|
3115
|
+
|
|
3116
|
+
|
|
3117
|
+
<div class="method-subsection return">
|
|
3118
|
+
<h4 class="method-subtitle parameter-title">Return Value</h4>
|
|
3119
|
+
<p>The current encoding type.</p>
|
|
3120
|
+
</div>
|
|
3121
|
+
|
|
3122
|
+
|
|
3123
|
+
|
|
3124
|
+
|
|
3125
|
+
|
|
3126
|
+
<div class="method-subsection discussion-section">
|
|
3127
|
+
<h4 class="method-subtitle">Discussion</h4>
|
|
3128
|
+
<p>Returns the encoding type.</p>
|
|
3129
|
+
</div>
|
|
3130
|
+
|
|
3131
|
+
|
|
3132
|
+
|
|
3133
|
+
|
|
3134
|
+
|
|
3135
|
+
<div class="method-subsection see-also-section">
|
|
3136
|
+
<h4 class="method-subtitle">See Also</h4>
|
|
3137
|
+
<ul>
|
|
3138
|
+
|
|
3139
|
+
<li><code><ul>
|
|
3140
|
+
<li>(BOOL)<a href="#//api/name/setEncodingType:">– setEncodingType:</a>(NSFEncodingType)theEncodingType;</li>
|
|
3141
|
+
</ul>
|
|
3142
|
+
</code></li>
|
|
3143
|
+
|
|
3144
|
+
</ul>
|
|
3145
|
+
</div>
|
|
3146
|
+
|
|
3147
|
+
|
|
3148
|
+
|
|
3149
|
+
<div class="method-subsection declared-in-section">
|
|
3150
|
+
<h4 class="method-subtitle">Declared In</h4>
|
|
3151
|
+
<code class="declared-in-ref">NSFNanoEngine.h</code><br />
|
|
3152
|
+
</div>
|
|
3153
|
+
|
|
3154
|
+
|
|
3155
|
+
</div>
|
|
3156
|
+
|
|
3157
|
+
<div class="section-method">
|
|
3158
|
+
<a name="//api/name/executeSQL:" title="executeSQL:"></a>
|
|
3159
|
+
<h3 class="subsubtitle method-title">executeSQL:</h3>
|
|
3160
|
+
|
|
3161
|
+
|
|
3162
|
+
|
|
3163
|
+
<div class="method-subsection brief-description">
|
|
3164
|
+
<p>Executes a SQL statement.</p>
|
|
3165
|
+
</div>
|
|
3166
|
+
|
|
3167
|
+
|
|
3168
|
+
|
|
3169
|
+
<div class="method-subsection method-declaration"><code>- (NSFNanoResult *)executeSQL:(NSString *)<em>theSQLStatement</em></code></div>
|
|
3170
|
+
|
|
3171
|
+
|
|
3172
|
+
|
|
3173
|
+
<div class="method-subsection arguments-section parameters">
|
|
3174
|
+
<h4 class="method-subtitle parameter-title">Parameters</h4>
|
|
3175
|
+
|
|
3176
|
+
<dl class="argument-def parameter-def">
|
|
3177
|
+
<dt><em>theSQLStatement</em></dt>
|
|
3178
|
+
<dd><p>is the SQL statement to be executed. Must not be nil or an empty string.</p></dd>
|
|
3179
|
+
</dl>
|
|
3180
|
+
|
|
3181
|
+
</div>
|
|
3182
|
+
|
|
3183
|
+
|
|
3184
|
+
|
|
3185
|
+
<div class="method-subsection return">
|
|
3186
|
+
<h4 class="method-subtitle parameter-title">Return Value</h4>
|
|
3187
|
+
<p>Returns a <a href="../Classes/NSFNanoResult.html">NSFNanoResult</a>.
|
|
3188
|
+
@throws NSFUnexpectedParameterException is thrown if the statement is nil or an empty string.
|
|
3189
|
+
@attention Check NSFNanoResult’s error property to find out if there was a problem executing the statement.</p>
|
|
3190
|
+
</div>
|
|
3191
|
+
|
|
3192
|
+
|
|
3193
|
+
|
|
3194
|
+
|
|
3195
|
+
|
|
3196
|
+
<div class="method-subsection discussion-section">
|
|
3197
|
+
<h4 class="method-subtitle">Discussion</h4>
|
|
3198
|
+
<p>Executes a SQL statement.</p><div class="note"><p><strong>Note:</strong> The result set will always contain string values. If you need to obtain NanoObjects instead, use the <a href="../Classes/NSFNanoSearch.html">NSFNanoSearch</a> class.</p></div>
|
|
3199
|
+
</div>
|
|
3200
|
+
|
|
3201
|
+
|
|
3202
|
+
|
|
3203
|
+
|
|
3204
|
+
|
|
3205
|
+
<div class="method-subsection see-also-section">
|
|
3206
|
+
<h4 class="method-subtitle">See Also</h4>
|
|
3207
|
+
<ul>
|
|
3208
|
+
|
|
3209
|
+
<li><code><p><a href="../Classes/NSFNanoSearch.html">NSFNanoSearch</a></p></code></li>
|
|
3210
|
+
|
|
3211
|
+
</ul>
|
|
3212
|
+
</div>
|
|
3213
|
+
|
|
3214
|
+
|
|
3215
|
+
|
|
3216
|
+
<div class="method-subsection declared-in-section">
|
|
3217
|
+
<h4 class="method-subtitle">Declared In</h4>
|
|
3218
|
+
<code class="declared-in-ref">NSFNanoEngine.h</code><br />
|
|
3219
|
+
</div>
|
|
3220
|
+
|
|
3221
|
+
|
|
3222
|
+
</div>
|
|
3223
|
+
|
|
3224
|
+
<div class="section-method">
|
|
3225
|
+
<a name="//api/name/indexedColumnsForTable:" title="indexedColumnsForTable:"></a>
|
|
3226
|
+
<h3 class="subsubtitle method-title">indexedColumnsForTable:</h3>
|
|
3227
|
+
|
|
3228
|
+
|
|
3229
|
+
|
|
3230
|
+
<div class="method-subsection brief-description">
|
|
3231
|
+
<p>Returns a new array containing the <a href="#//api/name/indexes">indexes</a> found for a given table.</p>
|
|
3232
|
+
</div>
|
|
3233
|
+
|
|
3234
|
+
|
|
3235
|
+
|
|
3236
|
+
<div class="method-subsection method-declaration"><code>- (NSArray *)indexedColumnsForTable:(NSString *)<em>theTable</em></code></div>
|
|
3237
|
+
|
|
3238
|
+
|
|
3239
|
+
|
|
3240
|
+
|
|
3241
|
+
|
|
3242
|
+
<div class="method-subsection return">
|
|
3243
|
+
<h4 class="method-subtitle parameter-title">Return Value</h4>
|
|
3244
|
+
<p>A new array containing the <a href="#//api/name/indexes">indexes</a> for a given table, or an empty array if none is found.</p>
|
|
3245
|
+
</div>
|
|
3246
|
+
|
|
3247
|
+
|
|
3248
|
+
|
|
3249
|
+
|
|
3250
|
+
|
|
3251
|
+
<div class="method-subsection discussion-section">
|
|
3252
|
+
<h4 class="method-subtitle">Discussion</h4>
|
|
3253
|
+
<p>Returns a new array containing the <a href="#//api/name/indexes">indexes</a> found for a given table.</p>
|
|
3254
|
+
</div>
|
|
3255
|
+
|
|
3256
|
+
|
|
3257
|
+
|
|
3258
|
+
|
|
3259
|
+
|
|
3260
|
+
|
|
3261
|
+
|
|
3262
|
+
<div class="method-subsection declared-in-section">
|
|
3263
|
+
<h4 class="method-subtitle">Declared In</h4>
|
|
3264
|
+
<code class="declared-in-ref">NSFNanoEngine.h</code><br />
|
|
3265
|
+
</div>
|
|
3266
|
+
|
|
3267
|
+
|
|
3268
|
+
</div>
|
|
3269
|
+
|
|
3270
|
+
<div class="section-method">
|
|
3271
|
+
<a name="//api/name/indexes" title="indexes"></a>
|
|
3272
|
+
<h3 class="subsubtitle method-title">indexes</h3>
|
|
3273
|
+
|
|
3274
|
+
|
|
3275
|
+
|
|
3276
|
+
<div class="method-subsection brief-description">
|
|
3277
|
+
<p>Returns a new array containing the indexes found in the main document store.</p>
|
|
3278
|
+
</div>
|
|
3279
|
+
|
|
3280
|
+
|
|
3281
|
+
|
|
3282
|
+
<div class="method-subsection method-declaration"><code>- (NSArray *)indexes</code></div>
|
|
3283
|
+
|
|
3284
|
+
|
|
3285
|
+
|
|
3286
|
+
|
|
3287
|
+
|
|
3288
|
+
<div class="method-subsection return">
|
|
3289
|
+
<h4 class="method-subtitle parameter-title">Return Value</h4>
|
|
3290
|
+
<p>A new array containing the indexes in the main document store, or an empty array if none is found.</p>
|
|
3291
|
+
</div>
|
|
3292
|
+
|
|
3293
|
+
|
|
3294
|
+
|
|
3295
|
+
|
|
3296
|
+
|
|
3297
|
+
<div class="method-subsection discussion-section">
|
|
3298
|
+
<h4 class="method-subtitle">Discussion</h4>
|
|
3299
|
+
<p>Returns a new array containing the indexes found in the main document store.</p>
|
|
3300
|
+
</div>
|
|
3301
|
+
|
|
3302
|
+
|
|
3303
|
+
|
|
3304
|
+
|
|
3305
|
+
|
|
3306
|
+
|
|
3307
|
+
|
|
3308
|
+
<div class="method-subsection declared-in-section">
|
|
3309
|
+
<h4 class="method-subtitle">Declared In</h4>
|
|
3310
|
+
<code class="declared-in-ref">NSFNanoEngine.h</code><br />
|
|
3311
|
+
</div>
|
|
3312
|
+
|
|
3313
|
+
|
|
3314
|
+
</div>
|
|
3315
|
+
|
|
3316
|
+
<div class="section-method">
|
|
3317
|
+
<a name="//api/name/initWithPath:" title="initWithPath:"></a>
|
|
3318
|
+
<h3 class="subsubtitle method-title">initWithPath:</h3>
|
|
3319
|
+
|
|
3320
|
+
|
|
3321
|
+
|
|
3322
|
+
<div class="method-subsection brief-description">
|
|
3323
|
+
<p>Initializes a newly allocated document store at a given file <a href="#//api/name/path">path</a>.</p>
|
|
3324
|
+
</div>
|
|
3325
|
+
|
|
3326
|
+
|
|
3327
|
+
|
|
3328
|
+
<div class="method-subsection method-declaration"><code>- (id)initWithPath:(NSString *)<em>thePath</em></code></div>
|
|
3329
|
+
|
|
3330
|
+
|
|
3331
|
+
|
|
3332
|
+
<div class="method-subsection arguments-section parameters">
|
|
3333
|
+
<h4 class="method-subtitle parameter-title">Parameters</h4>
|
|
3334
|
+
|
|
3335
|
+
<dl class="argument-def parameter-def">
|
|
3336
|
+
<dt><em>thePath</em></dt>
|
|
3337
|
+
<dd><p>the file <a href="#//api/name/path">path</a> where the document store will be created. Must not be nil.</p></dd>
|
|
3338
|
+
</dl>
|
|
3339
|
+
|
|
3340
|
+
</div>
|
|
3341
|
+
|
|
3342
|
+
|
|
3343
|
+
|
|
3344
|
+
<div class="method-subsection return">
|
|
3345
|
+
<h4 class="method-subtitle parameter-title">Return Value</h4>
|
|
3346
|
+
<p>An engine object upon success, nil otherwise.</p>
|
|
3347
|
+
</div>
|
|
3348
|
+
|
|
3349
|
+
|
|
3350
|
+
|
|
3351
|
+
|
|
3352
|
+
|
|
3353
|
+
<div class="method-subsection discussion-section">
|
|
3354
|
+
<h4 class="method-subtitle">Discussion</h4>
|
|
3355
|
+
<p>Initializes a newly allocated document store at a given file <a href="#//api/name/path">path</a>.</p><div class="note"><p><strong>Note:</strong> To manipulate the document store, you must first open it.</p></div>
|
|
3356
|
+
</div>
|
|
3357
|
+
|
|
3358
|
+
|
|
3359
|
+
|
|
3360
|
+
|
|
3361
|
+
|
|
3362
|
+
<div class="method-subsection see-also-section">
|
|
3363
|
+
<h4 class="method-subtitle">See Also</h4>
|
|
3364
|
+
<ul>
|
|
3365
|
+
|
|
3366
|
+
<li><code><ul>
|
|
3367
|
+
<li>(id)<a href="#//api/name/databaseWithPath:">+ databaseWithPath:</a>(NSString *)thePath;</li>
|
|
3368
|
+
</ul>
|
|
3369
|
+
</code></li>
|
|
3370
|
+
|
|
3371
|
+
</ul>
|
|
3372
|
+
</div>
|
|
3373
|
+
|
|
3374
|
+
|
|
3375
|
+
|
|
3376
|
+
<div class="method-subsection declared-in-section">
|
|
3377
|
+
<h4 class="method-subtitle">Declared In</h4>
|
|
3378
|
+
<code class="declared-in-ref">NSFNanoEngine.h</code><br />
|
|
3379
|
+
</div>
|
|
3380
|
+
|
|
3381
|
+
|
|
3382
|
+
</div>
|
|
3383
|
+
|
|
3384
|
+
<div class="section-method">
|
|
3385
|
+
<a name="//api/name/integrityCheck" title="integrityCheck"></a>
|
|
3386
|
+
<h3 class="subsubtitle method-title">integrityCheck</h3>
|
|
3387
|
+
|
|
3388
|
+
|
|
3389
|
+
|
|
3390
|
+
<div class="method-subsection brief-description">
|
|
3391
|
+
<p>Performs an integrity check on the database.</p>
|
|
3392
|
+
</div>
|
|
3393
|
+
|
|
3394
|
+
|
|
3395
|
+
|
|
3396
|
+
<div class="method-subsection method-declaration"><code>- (BOOL)integrityCheck</code></div>
|
|
3397
|
+
|
|
3398
|
+
|
|
3399
|
+
|
|
3400
|
+
|
|
3401
|
+
|
|
3402
|
+
<div class="method-subsection return">
|
|
3403
|
+
<h4 class="method-subtitle parameter-title">Return Value</h4>
|
|
3404
|
+
<p>YES upon success, NO otherwise.</p>
|
|
3405
|
+
</div>
|
|
3406
|
+
|
|
3407
|
+
|
|
3408
|
+
|
|
3409
|
+
|
|
3410
|
+
|
|
3411
|
+
<div class="method-subsection discussion-section">
|
|
3412
|
+
<h4 class="method-subtitle">Discussion</h4>
|
|
3413
|
+
<p>Performs an integrity check on the database.</p><div class="note"><p><strong>Note:</strong> If a transaction is open, the operation will not proceed and NO will be returned instead.</p></div>
|
|
3414
|
+
</div>
|
|
3415
|
+
|
|
3416
|
+
|
|
3417
|
+
|
|
3418
|
+
|
|
3419
|
+
|
|
3420
|
+
|
|
3421
|
+
|
|
3422
|
+
<div class="method-subsection declared-in-section">
|
|
3423
|
+
<h4 class="method-subtitle">Declared In</h4>
|
|
3424
|
+
<code class="declared-in-ref">NSFNanoEngine.h</code><br />
|
|
3425
|
+
</div>
|
|
3426
|
+
|
|
3427
|
+
|
|
3428
|
+
</div>
|
|
3429
|
+
|
|
3430
|
+
<div class="section-method">
|
|
3431
|
+
<a name="//api/name/isDatabaseOpen" title="isDatabaseOpen"></a>
|
|
3432
|
+
<h3 class="subsubtitle method-title">isDatabaseOpen</h3>
|
|
3433
|
+
|
|
3434
|
+
|
|
3435
|
+
|
|
3436
|
+
<div class="method-subsection brief-description">
|
|
3437
|
+
<p>Checks whether the document store is open or closed.</p>
|
|
3438
|
+
</div>
|
|
3439
|
+
|
|
3440
|
+
|
|
3441
|
+
|
|
3442
|
+
<div class="method-subsection method-declaration"><code>- (BOOL)isDatabaseOpen</code></div>
|
|
3443
|
+
|
|
3444
|
+
|
|
3445
|
+
|
|
3446
|
+
|
|
3447
|
+
|
|
3448
|
+
|
|
3449
|
+
|
|
3450
|
+
|
|
3451
|
+
|
|
3452
|
+
<div class="method-subsection discussion-section">
|
|
3453
|
+
<h4 class="method-subtitle">Discussion</h4>
|
|
3454
|
+
<p>Checks whether the document store is open or closed.</p>
|
|
3455
|
+
</div>
|
|
3456
|
+
|
|
3457
|
+
|
|
3458
|
+
|
|
3459
|
+
|
|
3460
|
+
|
|
3461
|
+
<div class="method-subsection see-also-section">
|
|
3462
|
+
<h4 class="method-subtitle">See Also</h4>
|
|
3463
|
+
<ul>
|
|
3464
|
+
|
|
3465
|
+
<li><code><ul>
|
|
3466
|
+
<li>(void)<a href="#//api/name/close">– close</a>;</li>
|
|
3467
|
+
</ul>
|
|
3468
|
+
</code></li>
|
|
3469
|
+
|
|
3470
|
+
</ul>
|
|
3471
|
+
</div>
|
|
3472
|
+
|
|
3473
|
+
|
|
3474
|
+
|
|
3475
|
+
<div class="method-subsection declared-in-section">
|
|
3476
|
+
<h4 class="method-subtitle">Declared In</h4>
|
|
3477
|
+
<code class="declared-in-ref">NSFNanoEngine.h</code><br />
|
|
3478
|
+
</div>
|
|
3479
|
+
|
|
3480
|
+
|
|
3481
|
+
</div>
|
|
3482
|
+
|
|
3483
|
+
<div class="section-method">
|
|
3484
|
+
<a name="//api/name/isTransactionActive" title="isTransactionActive"></a>
|
|
3485
|
+
<h3 class="subsubtitle method-title">isTransactionActive</h3>
|
|
3486
|
+
|
|
3487
|
+
|
|
3488
|
+
|
|
3489
|
+
<div class="method-subsection brief-description">
|
|
3490
|
+
<p>Checks whether a transaction is currently active.</p>
|
|
3491
|
+
</div>
|
|
3492
|
+
|
|
3493
|
+
|
|
3494
|
+
|
|
3495
|
+
<div class="method-subsection method-declaration"><code>- (BOOL)isTransactionActive</code></div>
|
|
3496
|
+
|
|
3497
|
+
|
|
3498
|
+
|
|
3499
|
+
|
|
3500
|
+
|
|
3501
|
+
<div class="method-subsection return">
|
|
3502
|
+
<h4 class="method-subtitle parameter-title">Return Value</h4>
|
|
3503
|
+
<p>YES if a transaction is currently active, NO otherwise.</p>
|
|
3504
|
+
</div>
|
|
3505
|
+
|
|
3506
|
+
|
|
3507
|
+
|
|
3508
|
+
|
|
3509
|
+
|
|
3510
|
+
<div class="method-subsection discussion-section">
|
|
3511
|
+
<h4 class="method-subtitle">Discussion</h4>
|
|
3512
|
+
<p>Checks whether a transaction is currently active.</p>
|
|
3513
|
+
</div>
|
|
3514
|
+
|
|
3515
|
+
|
|
3516
|
+
|
|
3517
|
+
|
|
3518
|
+
|
|
3519
|
+
|
|
3520
|
+
|
|
3521
|
+
<div class="method-subsection declared-in-section">
|
|
3522
|
+
<h4 class="method-subtitle">Declared In</h4>
|
|
3523
|
+
<code class="declared-in-ref">NSFNanoEngine.h</code><br />
|
|
3524
|
+
</div>
|
|
3525
|
+
|
|
3526
|
+
|
|
3527
|
+
</div>
|
|
3528
|
+
|
|
3529
|
+
<div class="section-method">
|
|
3530
|
+
<a name="//api/name/journalModeAndReturnError:" title="journalModeAndReturnError:"></a>
|
|
3531
|
+
<h3 class="subsubtitle method-title">journalModeAndReturnError:</h3>
|
|
3532
|
+
|
|
3533
|
+
|
|
3534
|
+
|
|
3535
|
+
<div class="method-subsection brief-description">
|
|
3536
|
+
<ul>
|
|
3537
|
+
<li>Journal mode.</li>
|
|
3538
|
+
<li>These values represent the options used by SQLite to the the journal mode for databases associated with the current database connection.</li>
|
|
3539
|
+
</ul>
|
|
3540
|
+
|
|
3541
|
+
</div>
|
|
3542
|
+
|
|
3543
|
+
|
|
3544
|
+
|
|
3545
|
+
<div class="method-subsection method-declaration"><code>- (NSFJournalModeMode)journalModeAndReturnError:(out NSError **)<em>outError</em></code></div>
|
|
3546
|
+
|
|
3547
|
+
|
|
3548
|
+
|
|
3549
|
+
|
|
3550
|
+
|
|
3551
|
+
|
|
3552
|
+
|
|
3553
|
+
|
|
3554
|
+
|
|
3555
|
+
<div class="method-subsection discussion-section">
|
|
3556
|
+
<h4 class="method-subtitle">Discussion</h4>
|
|
3557
|
+
<ul>
|
|
3558
|
+
<li>Journal mode.</li>
|
|
3559
|
+
<li>These values represent the options used by SQLite to the the journal mode for databases associated with the current database connection.</li>
|
|
3560
|
+
</ul>
|
|
3561
|
+
|
|
3562
|
+
|
|
3563
|
+
<p>@par
|
|
3564
|
+
The <b>DELETE</b> journaling mode is the normal behavior. In the <b>DELETE</b> mode, the rollback journal is deleted at the conclusion</p>
|
|
3565
|
+
|
|
3566
|
+
<pre><code> of each transaction. Indeed, the delete operation is the action that causes the transaction to commit. (See the document titled
|
|
3567
|
+
Atomic Commit In SQLite for additional detail.)
|
|
3568
|
+
</code></pre>
|
|
3569
|
+
|
|
3570
|
+
<p>@par
|
|
3571
|
+
The <b>TRUNCATE</b> journaling mode commits transactions by truncating the rollback journal to zero-length instead of deleting it.</p>
|
|
3572
|
+
|
|
3573
|
+
<pre><code> On many systems, truncating a file is much faster than deleting the file since the containing directory does not need to be changed.
|
|
3574
|
+
</code></pre>
|
|
3575
|
+
|
|
3576
|
+
<p>@par
|
|
3577
|
+
The <b>PERSIST</b> journaling mode prevents the rollback journal from being deleted at the end of each transaction. Instead, the header</p>
|
|
3578
|
+
|
|
3579
|
+
<pre><code> of the journal is overwritten with zeros. This will prevent other database connections from rolling the journal back. The <b>PERSIST</b>
|
|
3580
|
+
journaling mode is useful as an optimization on platforms where deleting or truncating a file is much more expensive than overwriting
|
|
3581
|
+
the first block of a file with zeros.
|
|
3582
|
+
</code></pre>
|
|
3583
|
+
|
|
3584
|
+
<p>@par</p>
|
|
3585
|
+
|
|
3586
|
+
<pre><code>The <b>MEMORY</b> journaling mode stores the rollback journal in volatile RAM. This saves disk I/O but at the expense of database safety
|
|
3587
|
+
and integrity. If the application using SQLite crashes in the middle of a transaction when the <b>MEMORY</b> journaling mode is set, then
|
|
3588
|
+
the database file will very likely go corrupt.
|
|
3589
|
+
</code></pre>
|
|
3590
|
+
|
|
3591
|
+
<p>@par</p>
|
|
3592
|
+
|
|
3593
|
+
<pre><code>The <b>WAL</b> journaling mode uses a write-ahead log instead of a rollback journal to implement transactions. The <b>WAL</b> journaling mode is
|
|
3594
|
+
persistent; after being set it stays in effect across multiple database connections and after closing and reopening the database. A database
|
|
3595
|
+
in <b>WAL</b> journaling mode can only be accessed by SQLite version 3.7.0 or later.
|
|
3596
|
+
</code></pre>
|
|
3597
|
+
|
|
3598
|
+
<p>@par</p>
|
|
3599
|
+
|
|
3600
|
+
<pre><code>The <b>OFF</b> journaling mode disables the rollback journal completely. No rollback journal is ever created and hence there is never a
|
|
3601
|
+
rollback journal to delete. The <b>OFF</b> journaling mode disables the atomic commit and rollback capabilities of SQLite. The <b>ROLLBACK</b> command
|
|
3602
|
+
no longer works; it behaves in an undefined way. Applications must avoid using the <b>ROLLBACK</b> command when the journal mode is <b>OFF</b>.
|
|
3603
|
+
If the application crashes in the middle of a transaction when the <b>OFF</b> journaling mode is set, then the database file will very likely go corrupt.
|
|
3604
|
+
</code></pre>
|
|
3605
|
+
|
|
3606
|
+
<p>@note</p>
|
|
3607
|
+
|
|
3608
|
+
<pre><code>The journal_mode for an in-memory database is either <b>MEMORY</b> or <b>OFF</b> and can not be changed to a different value. An attempt to change
|
|
3609
|
+
the journal_mode of an in-memory database to any setting other than <b>MEMORY</b> or <b>OFF</b> is ignored. Note also that the journal_mode cannot be changed
|
|
3610
|
+
while a transaction is active.
|
|
3611
|
+
</code></pre>
|
|
3612
|
+
</div>
|
|
3613
|
+
|
|
3614
|
+
|
|
3615
|
+
|
|
3616
|
+
|
|
3617
|
+
|
|
3618
|
+
|
|
3619
|
+
|
|
3620
|
+
<div class="method-subsection declared-in-section">
|
|
3621
|
+
<h4 class="method-subtitle">Declared In</h4>
|
|
3622
|
+
<code class="declared-in-ref">NSFNanoEngine.h</code><br />
|
|
3623
|
+
</div>
|
|
3624
|
+
|
|
3625
|
+
|
|
3626
|
+
</div>
|
|
3627
|
+
|
|
3628
|
+
<div class="section-method">
|
|
3629
|
+
<a name="//api/name/maxRowUIDForTable:" title="maxRowUIDForTable:"></a>
|
|
3630
|
+
<h3 class="subsubtitle method-title">maxRowUIDForTable:</h3>
|
|
3631
|
+
|
|
3632
|
+
|
|
3633
|
+
|
|
3634
|
+
<div class="method-subsection brief-description">
|
|
3635
|
+
<p>Returns the largest ROWUID for a given table.</p>
|
|
3636
|
+
</div>
|
|
3637
|
+
|
|
3638
|
+
|
|
3639
|
+
|
|
3640
|
+
<div class="method-subsection method-declaration"><code>- (long long)maxRowUIDForTable:(NSString *)<em>theTable</em></code></div>
|
|
3641
|
+
|
|
3642
|
+
|
|
3643
|
+
|
|
3644
|
+
<div class="method-subsection arguments-section parameters">
|
|
3645
|
+
<h4 class="method-subtitle parameter-title">Parameters</h4>
|
|
3646
|
+
|
|
3647
|
+
<dl class="argument-def parameter-def">
|
|
3648
|
+
<dt><em>theTable</em></dt>
|
|
3649
|
+
<dd><p>is the table from which to obtain the largest ROWUID. Must not be nil.</p></dd>
|
|
3650
|
+
</dl>
|
|
3651
|
+
|
|
3652
|
+
</div>
|
|
3653
|
+
|
|
3654
|
+
|
|
3655
|
+
|
|
3656
|
+
<div class="method-subsection return">
|
|
3657
|
+
<h4 class="method-subtitle parameter-title">Return Value</h4>
|
|
3658
|
+
<p>The largest ROWUID in use.
|
|
3659
|
+
@throws NSFUnexpectedParameterException is thrown if the table is nil.</p>
|
|
3660
|
+
</div>
|
|
3661
|
+
|
|
3662
|
+
|
|
3663
|
+
|
|
3664
|
+
|
|
3665
|
+
|
|
3666
|
+
<div class="method-subsection discussion-section">
|
|
3667
|
+
<h4 class="method-subtitle">Discussion</h4>
|
|
3668
|
+
<p>Returns the largest ROWUID for a given table.</p>
|
|
3669
|
+
</div>
|
|
3670
|
+
|
|
3671
|
+
|
|
3672
|
+
|
|
3673
|
+
|
|
3674
|
+
|
|
3675
|
+
|
|
3676
|
+
|
|
3677
|
+
<div class="method-subsection declared-in-section">
|
|
3678
|
+
<h4 class="method-subtitle">Declared In</h4>
|
|
3679
|
+
<code class="declared-in-ref">NSFNanoEngine.h</code><br />
|
|
3680
|
+
</div>
|
|
3681
|
+
|
|
3682
|
+
|
|
3683
|
+
</div>
|
|
3684
|
+
|
|
3685
|
+
<div class="section-method">
|
|
3686
|
+
<a name="//api/name/openWithCacheMethod:useFastMode:" title="openWithCacheMethod:useFastMode:"></a>
|
|
3687
|
+
<h3 class="subsubtitle method-title">openWithCacheMethod:useFastMode:</h3>
|
|
3688
|
+
|
|
3689
|
+
|
|
3690
|
+
|
|
3691
|
+
<div class="method-subsection brief-description">
|
|
3692
|
+
<p>Opens the engine, making it ready for manipulation.</p>
|
|
3693
|
+
</div>
|
|
3694
|
+
|
|
3695
|
+
|
|
3696
|
+
|
|
3697
|
+
<div class="method-subsection method-declaration"><code>- (BOOL)openWithCacheMethod:(NSFCacheMethod)<em>theCacheMethod</em> useFastMode:(BOOL)<em>useFastMode</em></code></div>
|
|
3698
|
+
|
|
3699
|
+
|
|
3700
|
+
|
|
3701
|
+
<div class="method-subsection arguments-section parameters">
|
|
3702
|
+
<h4 class="method-subtitle parameter-title">Parameters</h4>
|
|
3703
|
+
|
|
3704
|
+
<dl class="argument-def parameter-def">
|
|
3705
|
+
<dt><em>theCacheMethod</em></dt>
|
|
3706
|
+
<dd><p>allows to specify hwo the data will be read from the database:. This setting incurs a tradeoff between speed and memory usage.</p></dd>
|
|
3707
|
+
</dl>
|
|
3708
|
+
|
|
3709
|
+
<dl class="argument-def parameter-def">
|
|
3710
|
+
<dt><em>useFastMode</em></dt>
|
|
3711
|
+
<dd><p>if set to YES, the document store is opened with all performance turned on (more risky in case of failure). Setting it to NO is slower, but safer. See the note below for more information.</p></dd>
|
|
3712
|
+
</dl>
|
|
3713
|
+
|
|
3714
|
+
</div>
|
|
3715
|
+
|
|
3716
|
+
|
|
3717
|
+
|
|
3718
|
+
<div class="method-subsection return">
|
|
3719
|
+
<h4 class="method-subtitle parameter-title">Return Value</h4>
|
|
3720
|
+
<p>YES upon success, NO otherwise.
|
|
3721
|
+
@note
|
|
3722
|
+
When FastMode is activated NanoStore continues without pausing as soon as it has handed data off to the operating system.
|
|
3723
|
+
If the application running NanoStore crashes, the data will be safe, but the database might become corrupted if the operating system crashes
|
|
3724
|
+
or the computer loses power before that data has been written to the disk surface.
|
|
3725
|
+
On the other hand, some operations are as much as 50 or more times faster with FastMode activated.</p>
|
|
3726
|
+
|
|
3727
|
+
<p>@par
|
|
3728
|
+
If FastMode is deactivated, NanoStore will pause at critical moments to make sure that data has actually been written to the disk surface
|
|
3729
|
+
before continuing. This ensures that if the operating system crashes or if there is a power failure, the database will be uncorrupted after rebooting.
|
|
3730
|
+
Deactivating FastMode is very safe, but it is also slower.</p>
|
|
3731
|
+
</div>
|
|
3732
|
+
|
|
3733
|
+
|
|
3734
|
+
|
|
3735
|
+
|
|
3736
|
+
|
|
3737
|
+
<div class="method-subsection discussion-section">
|
|
3738
|
+
<h4 class="method-subtitle">Discussion</h4>
|
|
3739
|
+
<p>Opens the engine, making it ready for manipulation.</p>
|
|
3740
|
+
</div>
|
|
3741
|
+
|
|
3742
|
+
|
|
3743
|
+
|
|
3744
|
+
|
|
3745
|
+
|
|
3746
|
+
|
|
3747
|
+
|
|
3748
|
+
<div class="method-subsection declared-in-section">
|
|
3749
|
+
<h4 class="method-subtitle">Declared In</h4>
|
|
3750
|
+
<code class="declared-in-ref">NSFNanoEngine.h</code><br />
|
|
3751
|
+
</div>
|
|
3752
|
+
|
|
3753
|
+
|
|
3754
|
+
</div>
|
|
3755
|
+
|
|
3756
|
+
<div class="section-method">
|
|
3757
|
+
<a name="//api/name/pageSize" title="pageSize"></a>
|
|
3758
|
+
<h3 class="subsubtitle method-title">pageSize</h3>
|
|
3759
|
+
|
|
3760
|
+
|
|
3761
|
+
|
|
3762
|
+
<div class="method-subsection brief-description">
|
|
3763
|
+
<p>Returns the page size.</p>
|
|
3764
|
+
</div>
|
|
3765
|
+
|
|
3766
|
+
|
|
3767
|
+
|
|
3768
|
+
<div class="method-subsection method-declaration"><code>- (NSUInteger)pageSize</code></div>
|
|
3769
|
+
|
|
3770
|
+
|
|
3771
|
+
|
|
3772
|
+
|
|
3773
|
+
|
|
3774
|
+
<div class="method-subsection return">
|
|
3775
|
+
<h4 class="method-subtitle parameter-title">Return Value</h4>
|
|
3776
|
+
<p>The current page size.</p>
|
|
3777
|
+
</div>
|
|
3778
|
+
|
|
3779
|
+
|
|
3780
|
+
|
|
3781
|
+
|
|
3782
|
+
|
|
3783
|
+
<div class="method-subsection discussion-section">
|
|
3784
|
+
<h4 class="method-subtitle">Discussion</h4>
|
|
3785
|
+
<p>Returns the page size.</p>
|
|
3786
|
+
</div>
|
|
3787
|
+
|
|
3788
|
+
|
|
3789
|
+
|
|
3790
|
+
|
|
3791
|
+
|
|
3792
|
+
<div class="method-subsection see-also-section">
|
|
3793
|
+
<h4 class="method-subtitle">See Also</h4>
|
|
3794
|
+
<ul>
|
|
3795
|
+
|
|
3796
|
+
<li><code><ul>
|
|
3797
|
+
<li>(NSInteger)<a href="#//api/name/systemPageSize">+ systemPageSize</a>;</li>
|
|
3798
|
+
</ul>
|
|
3799
|
+
</code></li>
|
|
3800
|
+
|
|
3801
|
+
<li><code><ul>
|
|
3802
|
+
<li>(BOOL)<a href="#//api/name/setPageSize:">– setPageSize:</a>(NSUInteger)numberOfBytes;</li>
|
|
3803
|
+
</ul>
|
|
3804
|
+
</code></li>
|
|
3805
|
+
|
|
3806
|
+
</ul>
|
|
3807
|
+
</div>
|
|
3808
|
+
|
|
3809
|
+
|
|
3810
|
+
|
|
3811
|
+
<div class="method-subsection declared-in-section">
|
|
3812
|
+
<h4 class="method-subtitle">Declared In</h4>
|
|
3813
|
+
<code class="declared-in-ref">NSFNanoEngine.h</code><br />
|
|
3814
|
+
</div>
|
|
3815
|
+
|
|
3816
|
+
|
|
3817
|
+
</div>
|
|
3818
|
+
|
|
3819
|
+
<div class="section-method">
|
|
3820
|
+
<a name="//api/name/rollbackTransaction" title="rollbackTransaction"></a>
|
|
3821
|
+
<h3 class="subsubtitle method-title">rollbackTransaction</h3>
|
|
3822
|
+
|
|
3823
|
+
|
|
3824
|
+
|
|
3825
|
+
<div class="method-subsection brief-description">
|
|
3826
|
+
<p>Rolls back a transaction.</p>
|
|
3827
|
+
</div>
|
|
3828
|
+
|
|
3829
|
+
|
|
3830
|
+
|
|
3831
|
+
<div class="method-subsection method-declaration"><code>- (BOOL)rollbackTransaction</code></div>
|
|
3832
|
+
|
|
3833
|
+
|
|
3834
|
+
|
|
3835
|
+
|
|
3836
|
+
|
|
3837
|
+
<div class="method-subsection return">
|
|
3838
|
+
<h4 class="method-subtitle parameter-title">Return Value</h4>
|
|
3839
|
+
<p>YES upon success, NO otherwise.</p>
|
|
3840
|
+
</div>
|
|
3841
|
+
|
|
3842
|
+
|
|
3843
|
+
|
|
3844
|
+
|
|
3845
|
+
|
|
3846
|
+
<div class="method-subsection discussion-section">
|
|
3847
|
+
<h4 class="method-subtitle">Discussion</h4>
|
|
3848
|
+
<p>Rolls back a transaction.</p>
|
|
3849
|
+
</div>
|
|
3850
|
+
|
|
3851
|
+
|
|
3852
|
+
|
|
3853
|
+
|
|
3854
|
+
|
|
3855
|
+
<div class="method-subsection see-also-section">
|
|
3856
|
+
<h4 class="method-subtitle">See Also</h4>
|
|
3857
|
+
<ul>
|
|
3858
|
+
|
|
3859
|
+
<li><code><ul>
|
|
3860
|
+
<li>(BOOL)<a href="#//api/name/beginTransaction">– beginTransaction</a>;</li>
|
|
3861
|
+
</ul>
|
|
3862
|
+
</code></li>
|
|
3863
|
+
|
|
3864
|
+
<li><code><ul>
|
|
3865
|
+
<li>(BOOL)<a href="#//api/name/beginDeferredTransaction">– beginDeferredTransaction</a>;</li>
|
|
3866
|
+
</ul>
|
|
3867
|
+
</code></li>
|
|
3868
|
+
|
|
3869
|
+
<li><code><ul>
|
|
3870
|
+
<li>(BOOL)<a href="#//api/name/commitTransaction">– commitTransaction</a>;</li>
|
|
3871
|
+
</ul>
|
|
3872
|
+
</code></li>
|
|
3873
|
+
|
|
3874
|
+
<li><code><ul>
|
|
3875
|
+
<li>(BOOL)<a href="#//api/name/isTransactionActive">– isTransactionActive</a>;</li>
|
|
3876
|
+
</ul>
|
|
3877
|
+
</code></li>
|
|
3878
|
+
|
|
3879
|
+
</ul>
|
|
3880
|
+
</div>
|
|
3881
|
+
|
|
3882
|
+
|
|
3883
|
+
|
|
3884
|
+
<div class="method-subsection declared-in-section">
|
|
3885
|
+
<h4 class="method-subtitle">Declared In</h4>
|
|
3886
|
+
<code class="declared-in-ref">NSFNanoEngine.h</code><br />
|
|
3887
|
+
</div>
|
|
3888
|
+
|
|
3889
|
+
|
|
3890
|
+
</div>
|
|
3891
|
+
|
|
3892
|
+
<div class="section-method">
|
|
3893
|
+
<a name="//api/name/setBusyTimeout:" title="setBusyTimeout:"></a>
|
|
3894
|
+
<h3 class="subsubtitle method-title">setBusyTimeout:</h3>
|
|
3895
|
+
|
|
3896
|
+
|
|
3897
|
+
|
|
3898
|
+
<div class="method-subsection brief-description">
|
|
3899
|
+
<p>Sets the busy timeout.</p>
|
|
3900
|
+
</div>
|
|
3901
|
+
|
|
3902
|
+
|
|
3903
|
+
|
|
3904
|
+
<div class="method-subsection method-declaration"><code>- (void)setBusyTimeout:(unsigned int)<em>theTimeout</em></code></div>
|
|
3905
|
+
|
|
3906
|
+
|
|
3907
|
+
|
|
3908
|
+
<div class="method-subsection arguments-section parameters">
|
|
3909
|
+
<h4 class="method-subtitle parameter-title">Parameters</h4>
|
|
3910
|
+
|
|
3911
|
+
<dl class="argument-def parameter-def">
|
|
3912
|
+
<dt><em>theTimeout</em></dt>
|
|
3913
|
+
<dd><p>is number of milliseconds that SQLite will wait to retry a busy operation.</p></dd>
|
|
3914
|
+
</dl>
|
|
3915
|
+
|
|
3916
|
+
</div>
|
|
3917
|
+
|
|
3918
|
+
|
|
3919
|
+
|
|
3920
|
+
|
|
3921
|
+
|
|
3922
|
+
|
|
3923
|
+
|
|
3924
|
+
<div class="method-subsection discussion-section">
|
|
3925
|
+
<h4 class="method-subtitle">Discussion</h4>
|
|
3926
|
+
<p>Sets the busy timeout.</p><div class="note"><p><strong>Note:</strong> The acceptable range is between 100 and 5000 milliseconds. If the value is out of range, the 250 millisecond default timeout will be set instead.</p></div>
|
|
3927
|
+
</div>
|
|
3928
|
+
|
|
3929
|
+
|
|
3930
|
+
|
|
3931
|
+
|
|
3932
|
+
|
|
3933
|
+
<div class="method-subsection see-also-section">
|
|
3934
|
+
<h4 class="method-subtitle">See Also</h4>
|
|
3935
|
+
<ul>
|
|
3936
|
+
|
|
3937
|
+
<li><code><ul>
|
|
3938
|
+
<li>(unsigned int)<a href="#//api/name/busyTimeout">– busyTimeout</a>;</li>
|
|
3939
|
+
</ul>
|
|
3940
|
+
</code></li>
|
|
3941
|
+
|
|
3942
|
+
</ul>
|
|
3943
|
+
</div>
|
|
3944
|
+
|
|
3945
|
+
|
|
3946
|
+
|
|
3947
|
+
<div class="method-subsection declared-in-section">
|
|
3948
|
+
<h4 class="method-subtitle">Declared In</h4>
|
|
3949
|
+
<code class="declared-in-ref">NSFNanoEngine.h</code><br />
|
|
3950
|
+
</div>
|
|
3951
|
+
|
|
3952
|
+
|
|
3953
|
+
</div>
|
|
3954
|
+
|
|
3955
|
+
<div class="section-method">
|
|
3956
|
+
<a name="//api/name/setCacheSize:" title="setCacheSize:"></a>
|
|
3957
|
+
<h3 class="subsubtitle method-title">setCacheSize:</h3>
|
|
3958
|
+
|
|
3959
|
+
|
|
3960
|
+
|
|
3961
|
+
<div class="method-subsection brief-description">
|
|
3962
|
+
<p>Sets the cache size.</p>
|
|
3963
|
+
</div>
|
|
3964
|
+
|
|
3965
|
+
|
|
3966
|
+
|
|
3967
|
+
<div class="method-subsection method-declaration"><code>- (BOOL)setCacheSize:(NSUInteger)<em>numberOfPages</em></code></div>
|
|
3968
|
+
|
|
3969
|
+
|
|
3970
|
+
|
|
3971
|
+
<div class="method-subsection arguments-section parameters">
|
|
3972
|
+
<h4 class="method-subtitle parameter-title">Parameters</h4>
|
|
3973
|
+
|
|
3974
|
+
<dl class="argument-def parameter-def">
|
|
3975
|
+
<dt><em>numberOfPages</em></dt>
|
|
3976
|
+
<dd><p>is the number of pages.</p></dd>
|
|
3977
|
+
</dl>
|
|
3978
|
+
|
|
3979
|
+
</div>
|
|
3980
|
+
|
|
3981
|
+
|
|
3982
|
+
|
|
3983
|
+
<div class="method-subsection return">
|
|
3984
|
+
<h4 class="method-subtitle parameter-title">Return Value</h4>
|
|
3985
|
+
<p>YES upon success, NO otherwise.</p>
|
|
3986
|
+
</div>
|
|
3987
|
+
|
|
3988
|
+
|
|
3989
|
+
|
|
3990
|
+
|
|
3991
|
+
|
|
3992
|
+
<div class="method-subsection discussion-section">
|
|
3993
|
+
<h4 class="method-subtitle">Discussion</h4>
|
|
3994
|
+
<p>Sets the cache size.</p>
|
|
3995
|
+
</div>
|
|
3996
|
+
|
|
3997
|
+
|
|
3998
|
+
|
|
3999
|
+
|
|
4000
|
+
|
|
4001
|
+
<div class="method-subsection see-also-section">
|
|
4002
|
+
<h4 class="method-subtitle">See Also</h4>
|
|
4003
|
+
<ul>
|
|
4004
|
+
|
|
4005
|
+
<li><code><ul>
|
|
4006
|
+
<li>(NSUInteger)<a href="#//api/name/recommendedCacheSize">+ recommendedCacheSize</a>;</li>
|
|
4007
|
+
</ul>
|
|
4008
|
+
</code></li>
|
|
4009
|
+
|
|
4010
|
+
<li><code><ul>
|
|
4011
|
+
<li>(NSUInteger)<a href="#//api/name/cacheSize">– cacheSize</a>;</li>
|
|
4012
|
+
</ul>
|
|
4013
|
+
</code></li>
|
|
4014
|
+
|
|
4015
|
+
</ul>
|
|
4016
|
+
</div>
|
|
4017
|
+
|
|
4018
|
+
|
|
4019
|
+
|
|
4020
|
+
<div class="method-subsection declared-in-section">
|
|
4021
|
+
<h4 class="method-subtitle">Declared In</h4>
|
|
4022
|
+
<code class="declared-in-ref">NSFNanoEngine.h</code><br />
|
|
4023
|
+
</div>
|
|
4024
|
+
|
|
4025
|
+
|
|
4026
|
+
</div>
|
|
4027
|
+
|
|
4028
|
+
<div class="section-method">
|
|
4029
|
+
<a name="//api/name/setEncodingType:" title="setEncodingType:"></a>
|
|
4030
|
+
<h3 class="subsubtitle method-title">setEncodingType:</h3>
|
|
4031
|
+
|
|
4032
|
+
|
|
4033
|
+
|
|
4034
|
+
<div class="method-subsection brief-description">
|
|
4035
|
+
<p>Sets the text <a href="#//api/name/encoding">encoding</a> type.</p>
|
|
4036
|
+
</div>
|
|
4037
|
+
|
|
4038
|
+
|
|
4039
|
+
|
|
4040
|
+
<div class="method-subsection method-declaration"><code>- (BOOL)setEncodingType:(NSFEncodingType)<em>theEncodingType</em></code></div>
|
|
4041
|
+
|
|
4042
|
+
|
|
4043
|
+
|
|
4044
|
+
<div class="method-subsection arguments-section parameters">
|
|
4045
|
+
<h4 class="method-subtitle parameter-title">Parameters</h4>
|
|
4046
|
+
|
|
4047
|
+
<dl class="argument-def parameter-def">
|
|
4048
|
+
<dt><em>theEncodingType</em></dt>
|
|
4049
|
+
<dd><p>is the <a href="#//api/name/encoding">encoding</a> type. Can be NSFEncodingUTF8 or NSFEncodingUTF16.</p></dd>
|
|
4050
|
+
</dl>
|
|
4051
|
+
|
|
4052
|
+
</div>
|
|
4053
|
+
|
|
4054
|
+
|
|
4055
|
+
|
|
4056
|
+
<div class="method-subsection return">
|
|
4057
|
+
<h4 class="method-subtitle parameter-title">Return Value</h4>
|
|
4058
|
+
<p>YES upon success, NO otherwise.</p>
|
|
4059
|
+
</div>
|
|
4060
|
+
|
|
4061
|
+
|
|
4062
|
+
|
|
4063
|
+
|
|
4064
|
+
|
|
4065
|
+
<div class="method-subsection discussion-section">
|
|
4066
|
+
<h4 class="method-subtitle">Discussion</h4>
|
|
4067
|
+
<p>Sets the text <a href="#//api/name/encoding">encoding</a> type.</p>
|
|
4068
|
+
</div>
|
|
4069
|
+
|
|
4070
|
+
|
|
4071
|
+
|
|
4072
|
+
|
|
4073
|
+
|
|
4074
|
+
<div class="method-subsection see-also-section">
|
|
4075
|
+
<h4 class="method-subtitle">See Also</h4>
|
|
4076
|
+
<ul>
|
|
4077
|
+
|
|
4078
|
+
<li><code><ul>
|
|
4079
|
+
<li>(NSFEncodingType)<a href="#//api/name/encoding">– encoding</a>;</li>
|
|
4080
|
+
</ul>
|
|
4081
|
+
</code></li>
|
|
4082
|
+
|
|
4083
|
+
</ul>
|
|
4084
|
+
</div>
|
|
4085
|
+
|
|
4086
|
+
|
|
4087
|
+
|
|
4088
|
+
<div class="method-subsection declared-in-section">
|
|
4089
|
+
<h4 class="method-subtitle">Declared In</h4>
|
|
4090
|
+
<code class="declared-in-ref">NSFNanoEngine.h</code><br />
|
|
4091
|
+
</div>
|
|
4092
|
+
|
|
4093
|
+
|
|
4094
|
+
</div>
|
|
4095
|
+
|
|
4096
|
+
<div class="section-method">
|
|
4097
|
+
<a name="//api/name/setJournalMode:" title="setJournalMode:"></a>
|
|
4098
|
+
<h3 class="subsubtitle method-title">setJournalMode:</h3>
|
|
4099
|
+
|
|
4100
|
+
|
|
4101
|
+
|
|
4102
|
+
<div class="method-subsection brief-description">
|
|
4103
|
+
<p>Returns the journal mode.</p>
|
|
4104
|
+
</div>
|
|
4105
|
+
|
|
4106
|
+
|
|
4107
|
+
|
|
4108
|
+
<div class="method-subsection method-declaration"><code>- (BOOL)setJournalMode:(NSFJournalModeMode)<em>theMode</em></code></div>
|
|
4109
|
+
|
|
4110
|
+
|
|
4111
|
+
|
|
4112
|
+
|
|
4113
|
+
|
|
4114
|
+
<div class="method-subsection return">
|
|
4115
|
+
<h4 class="method-subtitle parameter-title">Return Value</h4>
|
|
4116
|
+
<p>The current journal mode.</p>
|
|
4117
|
+
</div>
|
|
4118
|
+
|
|
4119
|
+
|
|
4120
|
+
|
|
4121
|
+
|
|
4122
|
+
|
|
4123
|
+
<div class="method-subsection discussion-section">
|
|
4124
|
+
<h4 class="method-subtitle">Discussion</h4>
|
|
4125
|
+
<p>Returns the journal mode.</p>
|
|
4126
|
+
</div>
|
|
4127
|
+
|
|
4128
|
+
|
|
4129
|
+
|
|
4130
|
+
|
|
4131
|
+
|
|
4132
|
+
<div class="method-subsection see-also-section">
|
|
4133
|
+
<h4 class="method-subtitle">See Also</h4>
|
|
4134
|
+
<ul>
|
|
4135
|
+
|
|
4136
|
+
<li><code><ul>
|
|
4137
|
+
<li>(NSFJournalModeMode)<a href="#//api/name/journalModeAndReturnError:">– journalModeAndReturnError:</a>(out NSError **)outError;</li>
|
|
4138
|
+
</ul>
|
|
4139
|
+
</code></li>
|
|
4140
|
+
|
|
4141
|
+
</ul>
|
|
4142
|
+
</div>
|
|
4143
|
+
|
|
4144
|
+
|
|
4145
|
+
|
|
4146
|
+
<div class="method-subsection declared-in-section">
|
|
4147
|
+
<h4 class="method-subtitle">Declared In</h4>
|
|
4148
|
+
<code class="declared-in-ref">NSFNanoEngine.h</code><br />
|
|
4149
|
+
</div>
|
|
4150
|
+
|
|
4151
|
+
|
|
4152
|
+
</div>
|
|
4153
|
+
|
|
4154
|
+
<div class="section-method">
|
|
4155
|
+
<a name="//api/name/setPageSize:" title="setPageSize:"></a>
|
|
4156
|
+
<h3 class="subsubtitle method-title">setPageSize:</h3>
|
|
4157
|
+
|
|
4158
|
+
|
|
4159
|
+
|
|
4160
|
+
<div class="method-subsection brief-description">
|
|
4161
|
+
<p>Sets the page size.</p>
|
|
4162
|
+
</div>
|
|
4163
|
+
|
|
4164
|
+
|
|
4165
|
+
|
|
4166
|
+
<div class="method-subsection method-declaration"><code>- (BOOL)setPageSize:(NSUInteger)<em>numberOfBytes</em></code></div>
|
|
4167
|
+
|
|
4168
|
+
|
|
4169
|
+
|
|
4170
|
+
<div class="method-subsection arguments-section parameters">
|
|
4171
|
+
<h4 class="method-subtitle parameter-title">Parameters</h4>
|
|
4172
|
+
|
|
4173
|
+
<dl class="argument-def parameter-def">
|
|
4174
|
+
<dt><em>numberOfBytes</em></dt>
|
|
4175
|
+
<dd><p>is the size of the page.</p></dd>
|
|
4176
|
+
</dl>
|
|
4177
|
+
|
|
4178
|
+
</div>
|
|
4179
|
+
|
|
4180
|
+
|
|
4181
|
+
|
|
4182
|
+
<div class="method-subsection return">
|
|
4183
|
+
<h4 class="method-subtitle parameter-title">Return Value</h4>
|
|
4184
|
+
<p>YES upon success, NO otherwise.</p>
|
|
4185
|
+
</div>
|
|
4186
|
+
|
|
4187
|
+
|
|
4188
|
+
|
|
4189
|
+
|
|
4190
|
+
|
|
4191
|
+
<div class="method-subsection discussion-section">
|
|
4192
|
+
<h4 class="method-subtitle">Discussion</h4>
|
|
4193
|
+
<p>Sets the page size.</p>
|
|
4194
|
+
</div>
|
|
4195
|
+
|
|
4196
|
+
|
|
4197
|
+
|
|
4198
|
+
|
|
4199
|
+
|
|
4200
|
+
<div class="method-subsection see-also-section">
|
|
4201
|
+
<h4 class="method-subtitle">See Also</h4>
|
|
4202
|
+
<ul>
|
|
4203
|
+
|
|
4204
|
+
<li><code><ul>
|
|
4205
|
+
<li>(NSInteger)<a href="#//api/name/systemPageSize">+ systemPageSize</a>;</li>
|
|
4206
|
+
</ul>
|
|
4207
|
+
</code></li>
|
|
4208
|
+
|
|
4209
|
+
<li><code><ul>
|
|
4210
|
+
<li>(NSUInteger)<a href="#//api/name/pageSize">– pageSize</a>;</li>
|
|
4211
|
+
</ul>
|
|
4212
|
+
</code></li>
|
|
4213
|
+
|
|
4214
|
+
</ul>
|
|
4215
|
+
</div>
|
|
4216
|
+
|
|
4217
|
+
|
|
4218
|
+
|
|
4219
|
+
<div class="method-subsection declared-in-section">
|
|
4220
|
+
<h4 class="method-subtitle">Declared In</h4>
|
|
4221
|
+
<code class="declared-in-ref">NSFNanoEngine.h</code><br />
|
|
4222
|
+
</div>
|
|
4223
|
+
|
|
4224
|
+
|
|
4225
|
+
</div>
|
|
4226
|
+
|
|
4227
|
+
<div class="section-method">
|
|
4228
|
+
<a name="//api/name/setSynchronousMode:" title="setSynchronousMode:"></a>
|
|
4229
|
+
<h3 class="subsubtitle method-title">setSynchronousMode:</h3>
|
|
4230
|
+
|
|
4231
|
+
|
|
4232
|
+
|
|
4233
|
+
<div class="method-subsection brief-description">
|
|
4234
|
+
<p>Sets the synchronous mode.</p>
|
|
4235
|
+
</div>
|
|
4236
|
+
|
|
4237
|
+
|
|
4238
|
+
|
|
4239
|
+
<div class="method-subsection method-declaration"><code>- (void)setSynchronousMode:(NSFSynchronousMode)<em>theSynchronousMode</em></code></div>
|
|
4240
|
+
|
|
4241
|
+
|
|
4242
|
+
|
|
4243
|
+
<div class="method-subsection arguments-section parameters">
|
|
4244
|
+
<h4 class="method-subtitle parameter-title">Parameters</h4>
|
|
4245
|
+
|
|
4246
|
+
<dl class="argument-def parameter-def">
|
|
4247
|
+
<dt><em>theSynchronousMode</em></dt>
|
|
4248
|
+
<dd><p>is the synchronous mode. Can be SynchronousModeOff, SynchronousModeNormal or SynchronousModeFull.</p></dd>
|
|
4249
|
+
</dl>
|
|
4250
|
+
|
|
4251
|
+
</div>
|
|
4252
|
+
|
|
4253
|
+
|
|
4254
|
+
|
|
4255
|
+
|
|
4256
|
+
|
|
4257
|
+
|
|
4258
|
+
|
|
4259
|
+
<div class="method-subsection discussion-section">
|
|
4260
|
+
<h4 class="method-subtitle">Discussion</h4>
|
|
4261
|
+
<p>Sets the synchronous mode.</p>
|
|
4262
|
+
</div>
|
|
4263
|
+
|
|
4264
|
+
|
|
4265
|
+
|
|
4266
|
+
|
|
4267
|
+
|
|
4268
|
+
<div class="method-subsection see-also-section">
|
|
4269
|
+
<h4 class="method-subtitle">See Also</h4>
|
|
4270
|
+
<ul>
|
|
4271
|
+
|
|
4272
|
+
<li><code><ul>
|
|
4273
|
+
<li>(NSFSynchronousMode)<a href="#//api/name/synchronousMode">– synchronousMode</a>;</li>
|
|
4274
|
+
</ul>
|
|
4275
|
+
</code></li>
|
|
4276
|
+
|
|
4277
|
+
</ul>
|
|
4278
|
+
</div>
|
|
4279
|
+
|
|
4280
|
+
|
|
4281
|
+
|
|
4282
|
+
<div class="method-subsection declared-in-section">
|
|
4283
|
+
<h4 class="method-subtitle">Declared In</h4>
|
|
4284
|
+
<code class="declared-in-ref">NSFNanoEngine.h</code><br />
|
|
4285
|
+
</div>
|
|
4286
|
+
|
|
4287
|
+
|
|
4288
|
+
</div>
|
|
4289
|
+
|
|
4290
|
+
<div class="section-method">
|
|
4291
|
+
<a name="//api/name/setTempStoreMode:" title="setTempStoreMode:"></a>
|
|
4292
|
+
<h3 class="subsubtitle method-title">setTempStoreMode:</h3>
|
|
4293
|
+
|
|
4294
|
+
|
|
4295
|
+
|
|
4296
|
+
<div class="method-subsection brief-description">
|
|
4297
|
+
<p>Sets the temporary storage mode.</p>
|
|
4298
|
+
</div>
|
|
4299
|
+
|
|
4300
|
+
|
|
4301
|
+
|
|
4302
|
+
<div class="method-subsection method-declaration"><code>- (void)setTempStoreMode:(NSFTempStoreMode)<em>theTempStoreMode</em></code></div>
|
|
4303
|
+
|
|
4304
|
+
|
|
4305
|
+
|
|
4306
|
+
<div class="method-subsection arguments-section parameters">
|
|
4307
|
+
<h4 class="method-subtitle parameter-title">Parameters</h4>
|
|
4308
|
+
|
|
4309
|
+
<dl class="argument-def parameter-def">
|
|
4310
|
+
<dt><em>theTempStoreMode</em></dt>
|
|
4311
|
+
<dd><p>is the temporary storage mode. Can be TempStoreModeDefault, TempStoreModeFile or TempStoreModeMemory.</p></dd>
|
|
4312
|
+
</dl>
|
|
4313
|
+
|
|
4314
|
+
</div>
|
|
4315
|
+
|
|
4316
|
+
|
|
4317
|
+
|
|
4318
|
+
|
|
4319
|
+
|
|
4320
|
+
|
|
4321
|
+
|
|
4322
|
+
<div class="method-subsection discussion-section">
|
|
4323
|
+
<h4 class="method-subtitle">Discussion</h4>
|
|
4324
|
+
<p>Sets the temporary storage mode.</p>
|
|
4325
|
+
</div>
|
|
4326
|
+
|
|
4327
|
+
|
|
4328
|
+
|
|
4329
|
+
|
|
4330
|
+
|
|
4331
|
+
<div class="method-subsection see-also-section">
|
|
4332
|
+
<h4 class="method-subtitle">See Also</h4>
|
|
4333
|
+
<ul>
|
|
4334
|
+
|
|
4335
|
+
<li><code><ul>
|
|
4336
|
+
<li>(NSFTempStoreMode)<a href="#//api/name/tempStoreMode">– tempStoreMode</a>;</li>
|
|
4337
|
+
</ul>
|
|
4338
|
+
</code></li>
|
|
4339
|
+
|
|
4340
|
+
</ul>
|
|
4341
|
+
</div>
|
|
4342
|
+
|
|
4343
|
+
|
|
4344
|
+
|
|
4345
|
+
<div class="method-subsection declared-in-section">
|
|
4346
|
+
<h4 class="method-subtitle">Declared In</h4>
|
|
4347
|
+
<code class="declared-in-ref">NSFNanoEngine.h</code><br />
|
|
4348
|
+
</div>
|
|
4349
|
+
|
|
4350
|
+
|
|
4351
|
+
</div>
|
|
4352
|
+
|
|
4353
|
+
<div class="section-method">
|
|
4354
|
+
<a name="//api/name/synchronousMode" title="synchronousMode"></a>
|
|
4355
|
+
<h3 class="subsubtitle method-title">synchronousMode</h3>
|
|
4356
|
+
|
|
4357
|
+
|
|
4358
|
+
|
|
4359
|
+
<div class="method-subsection brief-description">
|
|
4360
|
+
<p>Returns the synchronous mode.</p>
|
|
4361
|
+
</div>
|
|
4362
|
+
|
|
4363
|
+
|
|
4364
|
+
|
|
4365
|
+
<div class="method-subsection method-declaration"><code>- (NSFSynchronousMode)synchronousMode</code></div>
|
|
4366
|
+
|
|
4367
|
+
|
|
4368
|
+
|
|
4369
|
+
|
|
4370
|
+
|
|
4371
|
+
<div class="method-subsection return">
|
|
4372
|
+
<h4 class="method-subtitle parameter-title">Return Value</h4>
|
|
4373
|
+
<p>The current synchronous mode.</p>
|
|
4374
|
+
</div>
|
|
4375
|
+
|
|
4376
|
+
|
|
4377
|
+
|
|
4378
|
+
|
|
4379
|
+
|
|
4380
|
+
<div class="method-subsection discussion-section">
|
|
4381
|
+
<h4 class="method-subtitle">Discussion</h4>
|
|
4382
|
+
<p>Returns the synchronous mode.</p>
|
|
4383
|
+
</div>
|
|
4384
|
+
|
|
4385
|
+
|
|
4386
|
+
|
|
4387
|
+
|
|
4388
|
+
|
|
4389
|
+
<div class="method-subsection see-also-section">
|
|
4390
|
+
<h4 class="method-subtitle">See Also</h4>
|
|
4391
|
+
<ul>
|
|
4392
|
+
|
|
4393
|
+
<li><code><ul>
|
|
4394
|
+
<li>(void)<a href="#//api/name/setSynchronousMode:">– setSynchronousMode:</a>(NSFSynchronousMode)theSynchronousMode;</li>
|
|
4395
|
+
</ul>
|
|
4396
|
+
</code></li>
|
|
4397
|
+
|
|
4398
|
+
</ul>
|
|
4399
|
+
</div>
|
|
4400
|
+
|
|
4401
|
+
|
|
4402
|
+
|
|
4403
|
+
<div class="method-subsection declared-in-section">
|
|
4404
|
+
<h4 class="method-subtitle">Declared In</h4>
|
|
4405
|
+
<code class="declared-in-ref">NSFNanoEngine.h</code><br />
|
|
4406
|
+
</div>
|
|
4407
|
+
|
|
4408
|
+
|
|
4409
|
+
</div>
|
|
4410
|
+
|
|
4411
|
+
<div class="section-method">
|
|
4412
|
+
<a name="//api/name/tables" title="tables"></a>
|
|
4413
|
+
<h3 class="subsubtitle method-title">tables</h3>
|
|
4414
|
+
|
|
4415
|
+
|
|
4416
|
+
|
|
4417
|
+
<div class="method-subsection brief-description">
|
|
4418
|
+
<p>Returns a new array containing the tables found in the main document store.</p>
|
|
4419
|
+
</div>
|
|
4420
|
+
|
|
4421
|
+
|
|
4422
|
+
|
|
4423
|
+
<div class="method-subsection method-declaration"><code>- (NSArray *)tables</code></div>
|
|
4424
|
+
|
|
4425
|
+
|
|
4426
|
+
|
|
4427
|
+
|
|
4428
|
+
|
|
4429
|
+
<div class="method-subsection return">
|
|
4430
|
+
<h4 class="method-subtitle parameter-title">Return Value</h4>
|
|
4431
|
+
<p>A new array containing the tables in the main document store, or an empty array if none is found.</p>
|
|
4432
|
+
</div>
|
|
4433
|
+
|
|
4434
|
+
|
|
4435
|
+
|
|
4436
|
+
|
|
4437
|
+
|
|
4438
|
+
<div class="method-subsection discussion-section">
|
|
4439
|
+
<h4 class="method-subtitle">Discussion</h4>
|
|
4440
|
+
<p>Returns a new array containing the tables found in the main document store.</p>
|
|
4441
|
+
</div>
|
|
4442
|
+
|
|
4443
|
+
|
|
4444
|
+
|
|
4445
|
+
|
|
4446
|
+
|
|
4447
|
+
<div class="method-subsection see-also-section">
|
|
4448
|
+
<h4 class="method-subtitle">See Also</h4>
|
|
4449
|
+
<ul>
|
|
4450
|
+
|
|
4451
|
+
<li><code><ul>
|
|
4452
|
+
<li>(NSDictionary *)<a href="#//api/name/allTables">– allTables</a>;</li>
|
|
4453
|
+
</ul>
|
|
4454
|
+
</code></li>
|
|
4455
|
+
|
|
4456
|
+
<li><code><ul>
|
|
4457
|
+
<li>(NSArray *)<a href="#//api/name/temporaryTables">– temporaryTables</a>;</li>
|
|
4458
|
+
</ul>
|
|
4459
|
+
</code></li>
|
|
4460
|
+
|
|
4461
|
+
</ul>
|
|
4462
|
+
</div>
|
|
4463
|
+
|
|
4464
|
+
|
|
4465
|
+
|
|
4466
|
+
<div class="method-subsection declared-in-section">
|
|
4467
|
+
<h4 class="method-subtitle">Declared In</h4>
|
|
4468
|
+
<code class="declared-in-ref">NSFNanoEngine.h</code><br />
|
|
4469
|
+
</div>
|
|
4470
|
+
|
|
4471
|
+
|
|
4472
|
+
</div>
|
|
4473
|
+
|
|
4474
|
+
<div class="section-method">
|
|
4475
|
+
<a name="//api/name/tempStoreMode" title="tempStoreMode"></a>
|
|
4476
|
+
<h3 class="subsubtitle method-title">tempStoreMode</h3>
|
|
4477
|
+
|
|
4478
|
+
|
|
4479
|
+
|
|
4480
|
+
<div class="method-subsection brief-description">
|
|
4481
|
+
<p>Returns the temporary storage mode.</p>
|
|
4482
|
+
</div>
|
|
4483
|
+
|
|
4484
|
+
|
|
4485
|
+
|
|
4486
|
+
<div class="method-subsection method-declaration"><code>- (NSFTempStoreMode)tempStoreMode</code></div>
|
|
4487
|
+
|
|
4488
|
+
|
|
4489
|
+
|
|
4490
|
+
|
|
4491
|
+
|
|
4492
|
+
<div class="method-subsection return">
|
|
4493
|
+
<h4 class="method-subtitle parameter-title">Return Value</h4>
|
|
4494
|
+
<p>The current temporary storage mode.</p>
|
|
4495
|
+
</div>
|
|
4496
|
+
|
|
4497
|
+
|
|
4498
|
+
|
|
4499
|
+
|
|
4500
|
+
|
|
4501
|
+
<div class="method-subsection discussion-section">
|
|
4502
|
+
<h4 class="method-subtitle">Discussion</h4>
|
|
4503
|
+
<p>Returns the temporary storage mode.</p>
|
|
4504
|
+
</div>
|
|
4505
|
+
|
|
4506
|
+
|
|
4507
|
+
|
|
4508
|
+
|
|
4509
|
+
|
|
4510
|
+
<div class="method-subsection see-also-section">
|
|
4511
|
+
<h4 class="method-subtitle">See Also</h4>
|
|
4512
|
+
<ul>
|
|
4513
|
+
|
|
4514
|
+
<li><code><ul>
|
|
4515
|
+
<li>(void)<a href="#//api/name/setTempStoreMode:">– setTempStoreMode:</a>(NSFTempStoreMode)theTempStoreMode;</li>
|
|
4516
|
+
</ul>
|
|
4517
|
+
</code></li>
|
|
4518
|
+
|
|
4519
|
+
</ul>
|
|
4520
|
+
</div>
|
|
4521
|
+
|
|
4522
|
+
|
|
4523
|
+
|
|
4524
|
+
<div class="method-subsection declared-in-section">
|
|
4525
|
+
<h4 class="method-subtitle">Declared In</h4>
|
|
4526
|
+
<code class="declared-in-ref">NSFNanoEngine.h</code><br />
|
|
4527
|
+
</div>
|
|
4528
|
+
|
|
4529
|
+
|
|
4530
|
+
</div>
|
|
4531
|
+
|
|
4532
|
+
<div class="section-method">
|
|
4533
|
+
<a name="//api/name/temporaryTables" title="temporaryTables"></a>
|
|
4534
|
+
<h3 class="subsubtitle method-title">temporaryTables</h3>
|
|
4535
|
+
|
|
4536
|
+
|
|
4537
|
+
|
|
4538
|
+
<div class="method-subsection brief-description">
|
|
4539
|
+
<p>Returns a new array containing the temporary <a href="#//api/name/tables">tables</a> found in the main document store.</p>
|
|
4540
|
+
</div>
|
|
4541
|
+
|
|
4542
|
+
|
|
4543
|
+
|
|
4544
|
+
<div class="method-subsection method-declaration"><code>- (NSArray *)temporaryTables</code></div>
|
|
4545
|
+
|
|
4546
|
+
|
|
4547
|
+
|
|
4548
|
+
|
|
4549
|
+
|
|
4550
|
+
<div class="method-subsection return">
|
|
4551
|
+
<h4 class="method-subtitle parameter-title">Return Value</h4>
|
|
4552
|
+
<p>A new array containing the temporary <a href="#//api/name/tables">tables</a> in the main document store, or an empty array if none is found.</p>
|
|
4553
|
+
</div>
|
|
4554
|
+
|
|
4555
|
+
|
|
4556
|
+
|
|
4557
|
+
|
|
4558
|
+
|
|
4559
|
+
<div class="method-subsection discussion-section">
|
|
4560
|
+
<h4 class="method-subtitle">Discussion</h4>
|
|
4561
|
+
<p>Returns a new array containing the temporary <a href="#//api/name/tables">tables</a> found in the main document store.</p>
|
|
4562
|
+
</div>
|
|
4563
|
+
|
|
4564
|
+
|
|
4565
|
+
|
|
4566
|
+
|
|
4567
|
+
|
|
4568
|
+
<div class="method-subsection see-also-section">
|
|
4569
|
+
<h4 class="method-subtitle">See Also</h4>
|
|
4570
|
+
<ul>
|
|
4571
|
+
|
|
4572
|
+
<li><code><ul>
|
|
4573
|
+
<li>(NSArray *)<a href="#//api/name/tables">– tables</a>;</li>
|
|
4574
|
+
</ul>
|
|
4575
|
+
</code></li>
|
|
4576
|
+
|
|
4577
|
+
<li><code><ul>
|
|
4578
|
+
<li>(NSDictionary *)<a href="#//api/name/allTables">– allTables</a>;</li>
|
|
4579
|
+
</ul>
|
|
4580
|
+
</code></li>
|
|
4581
|
+
|
|
4582
|
+
</ul>
|
|
4583
|
+
</div>
|
|
4584
|
+
|
|
4585
|
+
|
|
4586
|
+
|
|
4587
|
+
<div class="method-subsection declared-in-section">
|
|
4588
|
+
<h4 class="method-subtitle">Declared In</h4>
|
|
4589
|
+
<code class="declared-in-ref">NSFNanoEngine.h</code><br />
|
|
4590
|
+
</div>
|
|
4591
|
+
|
|
4592
|
+
|
|
4593
|
+
</div>
|
|
4594
|
+
|
|
4595
|
+
</div>
|
|
4596
|
+
|
|
4597
|
+
|
|
4598
|
+
</div>
|
|
4599
|
+
<div class="main-navigation navigation-bottom">
|
|
4600
|
+
<ul>
|
|
4601
|
+
<li><a href="../index.html">Index</a></li>
|
|
4602
|
+
<li><a href="../hierarchy.html">Hierarchy</a></li>
|
|
4603
|
+
</ul>
|
|
4604
|
+
</div>
|
|
4605
|
+
<div id="footer">
|
|
4606
|
+
<hr />
|
|
4607
|
+
<div class="footer-copyright">
|
|
4608
|
+
<p><span class="copyright">© 2013 Tito Ciuro. All rights reserved. (Last updated: 2013-01-22)</span><br />
|
|
4609
|
+
|
|
4610
|
+
<span class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.0.5 (build 789)</a>.</span></p>
|
|
4611
|
+
|
|
4612
|
+
</div>
|
|
4613
|
+
</div>
|
|
4614
|
+
</div>
|
|
4615
|
+
</article>
|
|
4616
|
+
<script type="text/javascript">
|
|
4617
|
+
function jumpToChange()
|
|
4618
|
+
{
|
|
4619
|
+
window.location.hash = this.options[this.selectedIndex].value;
|
|
4620
|
+
}
|
|
4621
|
+
|
|
4622
|
+
function toggleTOC()
|
|
4623
|
+
{
|
|
4624
|
+
var contents = document.getElementById('contents');
|
|
4625
|
+
var tocContainer = document.getElementById('tocContainer');
|
|
4626
|
+
|
|
4627
|
+
if (this.getAttribute('class') == 'open')
|
|
4628
|
+
{
|
|
4629
|
+
this.setAttribute('class', '');
|
|
4630
|
+
contents.setAttribute('class', '');
|
|
4631
|
+
tocContainer.setAttribute('class', '');
|
|
4632
|
+
|
|
4633
|
+
window.name = "hideTOC";
|
|
4634
|
+
}
|
|
4635
|
+
else
|
|
4636
|
+
{
|
|
4637
|
+
this.setAttribute('class', 'open');
|
|
4638
|
+
contents.setAttribute('class', 'isShowingTOC');
|
|
4639
|
+
tocContainer.setAttribute('class', 'isShowingTOC');
|
|
4640
|
+
|
|
4641
|
+
window.name = "";
|
|
4642
|
+
}
|
|
4643
|
+
return false;
|
|
4644
|
+
}
|
|
4645
|
+
|
|
4646
|
+
function toggleTOCEntryChildren(e)
|
|
4647
|
+
{
|
|
4648
|
+
e.stopPropagation();
|
|
4649
|
+
var currentClass = this.getAttribute('class');
|
|
4650
|
+
if (currentClass == 'children') {
|
|
4651
|
+
this.setAttribute('class', 'children open');
|
|
4652
|
+
}
|
|
4653
|
+
else if (currentClass == 'children open') {
|
|
4654
|
+
this.setAttribute('class', 'children');
|
|
4655
|
+
}
|
|
4656
|
+
return false;
|
|
4657
|
+
}
|
|
4658
|
+
|
|
4659
|
+
function tocEntryClick(e)
|
|
4660
|
+
{
|
|
4661
|
+
e.stopPropagation();
|
|
4662
|
+
return true;
|
|
4663
|
+
}
|
|
4664
|
+
|
|
4665
|
+
function init()
|
|
4666
|
+
{
|
|
4667
|
+
var selectElement = document.getElementById('jumpTo');
|
|
4668
|
+
selectElement.addEventListener('change', jumpToChange, false);
|
|
4669
|
+
|
|
4670
|
+
var tocButton = document.getElementById('table_of_contents');
|
|
4671
|
+
tocButton.addEventListener('click', toggleTOC, false);
|
|
4672
|
+
|
|
4673
|
+
var taskTreeItem = document.getElementById('task_treeitem');
|
|
4674
|
+
if (taskTreeItem.getElementsByTagName('li').length > 0)
|
|
4675
|
+
{
|
|
4676
|
+
taskTreeItem.setAttribute('class', 'children');
|
|
4677
|
+
taskTreeItem.firstChild.setAttribute('class', 'disclosure');
|
|
4678
|
+
}
|
|
4679
|
+
|
|
4680
|
+
var tocList = document.getElementById('toc');
|
|
4681
|
+
|
|
4682
|
+
var tocEntries = tocList.getElementsByTagName('li');
|
|
4683
|
+
for (var i = 0; i < tocEntries.length; i++) {
|
|
4684
|
+
tocEntries[i].addEventListener('click', toggleTOCEntryChildren, false);
|
|
4685
|
+
}
|
|
4686
|
+
|
|
4687
|
+
var tocLinks = tocList.getElementsByTagName('a');
|
|
4688
|
+
for (var i = 0; i < tocLinks.length; i++) {
|
|
4689
|
+
tocLinks[i].addEventListener('click', tocEntryClick, false);
|
|
4690
|
+
}
|
|
4691
|
+
|
|
4692
|
+
if (window.name == "hideTOC") {
|
|
4693
|
+
toggleTOC.call(tocButton);
|
|
4694
|
+
}
|
|
4695
|
+
}
|
|
4696
|
+
|
|
4697
|
+
window.onload = init;
|
|
4698
|
+
|
|
4699
|
+
// If showing in Xcode, hide the TOC and Header
|
|
4700
|
+
if (navigator.userAgent.match(/xcode/i)) {
|
|
4701
|
+
document.getElementById("contents").className = "hideInXcode"
|
|
4702
|
+
document.getElementById("tocContainer").className = "hideInXcode"
|
|
4703
|
+
document.getElementById("top_header").className = "hideInXcode"
|
|
4704
|
+
}
|
|
4705
|
+
|
|
4706
|
+
</script>
|
|
4707
|
+
</body>
|
|
4708
|
+
</html>
|