diff options
| author | August "Gus" Mueller <gus@flyingmeat.com> | 2015-11-02 21:31:31 +0300 |
|---|---|---|
| committer | August "Gus" Mueller <gus@flyingmeat.com> | 2015-11-02 21:31:31 +0300 |
| commit | 6147a03f1f336eb1aeaff38d0ccdc792caa70bab (patch) | |
| tree | c188724657ab5334c103edaee209e8b12160ac7a | |
| parent | fd875dcca5d7302853cbe6b47f0dfaf68a4f69b2 (diff) | |
| parent | aafbe9de4bfbd3c370f6a7c961a41dae259b69eb (diff) | |
Merge pull request #425 from robertmryan/gh-pages
Update documentation and class hierarchy
| -rw-r--r-- | html/Blocks/FMDBExecuteStatementsCallbackBlock.html | 6 | ||||
| -rw-r--r-- | html/Categories/FMDatabase+FMDatabaseAdditions.html | 294 | ||||
| -rw-r--r-- | html/Categories/NSObject+FMDatabasePoolDelegate.html | 6 | ||||
| -rw-r--r-- | html/Classes/FMDatabase.html | 212 | ||||
| -rw-r--r-- | html/Classes/FMDatabasePool.html | 460 | ||||
| -rw-r--r-- | html/Classes/FMDatabaseQueue.html | 299 | ||||
| -rw-r--r-- | html/Classes/FMResultSet.html | 668 | ||||
| -rw-r--r-- | html/Classes/FMStatement.html | 6 | ||||
| -rw-r--r-- | html/hierarchy.html | 16 | ||||
| -rw-r--r-- | html/index.html | 16 | ||||
| -rw-r--r-- | index.html | 46 |
11 files changed, 1217 insertions, 812 deletions
diff --git a/html/Blocks/FMDBExecuteStatementsCallbackBlock.html b/html/Blocks/FMDBExecuteStatementsCallbackBlock.html index c07248c..8d7ac42 100644 --- a/html/Blocks/FMDBExecuteStatementsCallbackBlock.html +++ b/html/Blocks/FMDBExecuteStatementsCallbackBlock.html @@ -7,7 +7,7 @@ <link rel="stylesheet" href="../css/style.css"> <meta name="viewport" content="initial-scale=1, maximum-scale=1.4"> - <meta name="generator" content="appledoc 2.2.1 (build 1333)"> + <meta name="generator" content="appledoc 2.2.1 (build 1334)"> </head> <body class="appledoc"> <header> @@ -80,10 +80,10 @@ <footer> <div class="footer-copyright"> - <p class="copyright">Copyright © 2015 ccgus. All rights reserved. Updated: 2015-01-25</p> + <p class="copyright">Copyright © 2015 ccgus. All rights reserved. Updated: 2015-10-29</p> - <p class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.2.1 (build 1333)</a>.</p> + <p class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.2.1 (build 1334)</a>.</p> </div> </footer> diff --git a/html/Categories/FMDatabase+FMDatabaseAdditions.html b/html/Categories/FMDatabase+FMDatabaseAdditions.html index 45965ce..c65d5b0 100644 --- a/html/Categories/FMDatabase+FMDatabaseAdditions.html +++ b/html/Categories/FMDatabase+FMDatabaseAdditions.html @@ -7,7 +7,7 @@ <link rel="stylesheet" href="../css/style.css"> <meta name="viewport" content="initial-scale=1, maximum-scale=1.4"> - <meta name="generator" content="appledoc 2.2.1 (build 1333)"> + <meta name="generator" content="appledoc 2.2.1 (build 1334)"> </head> <body class="appledoc"> <header> @@ -119,7 +119,7 @@ <div class="section section-specification"><table cellspacing="0"><tbody> <tr> <th>Declared in</th> - <td>FMDatabaseAdditions.h<br />FMDatabaseAdditions.m</td> + <td>FMDatabaseAdditions.h</td> </tr> </tbody></table></div> @@ -147,13 +147,13 @@ <a title="Tasks" name="tasks"></a> - - + <a title="Return results of SQL to variable" name="task_Return results of SQL to variable"></a> + <h2 class="task-title">Return results of SQL to variable</h2> <div class="task-list"> <div class="section-method"> - <a name="//api/name/stringForQuery:" title="stringForQuery:"></a> - <h3 class="method-title"><code><a href="#//api/name/stringForQuery:">– stringForQuery:</a></code> + <a name="//api/name/intForQuery:" title="intForQuery:"></a> + <h3 class="method-title"><code><a href="#//api/name/intForQuery:">– intForQuery:</a></code> </h3> <div class="method-info"> @@ -163,12 +163,12 @@ <div class="method-subsection brief-description"> - <p>Return <code>NSString</code> value for query</p> + <p>Return <code>int</code> value for query</p> </div> - <div class="method-subsection method-declaration"><code>- (NSString *)stringForQuery:(NSString *)<em>query</em>, <em>...</em></code></div> + <div class="method-subsection method-declaration"><code>- (int)intForQuery:(NSString *)<em>query</em>, <em>...</em></code></div> @@ -193,7 +193,7 @@ <div class="method-subsection return"> <h4 class="method-subtitle parameter-title">Return Value</h4> - <p><code>NSString</code> value.</p> + <p><code>int</code> value.</p> </div> @@ -202,7 +202,7 @@ <div class="method-subsection discussion-section"> <h4 class="method-subtitle">Discussion</h4> - <p>Return <code>NSString</code> value for query</p><div class="note"><p><strong>Note:</strong> To use this method from Swift, you must include <code>FMDatabaseAdditionsVariadic.swift</code> in your project.</p></div> + <p>Return <code>int</code> value for query</p><div class="note"><p><strong>Note:</strong> To use this method from Swift, you must include <code>FMDatabaseAdditionsVariadic.swift</code> in your project.</p></div> </div> @@ -220,8 +220,8 @@ </div> </div> </div><div class="section-method"> - <a name="//api/name/intForQuery:" title="intForQuery:"></a> - <h3 class="method-title"><code><a href="#//api/name/intForQuery:">– intForQuery:</a></code> + <a name="//api/name/longForQuery:" title="longForQuery:"></a> + <h3 class="method-title"><code><a href="#//api/name/longForQuery:">– longForQuery:</a></code> </h3> <div class="method-info"> @@ -231,12 +231,12 @@ <div class="method-subsection brief-description"> - <p>Return <code>int</code> value for query</p> + <p>Return <code>long</code> value for query</p> </div> - <div class="method-subsection method-declaration"><code>- (int)intForQuery:(NSString *)<em>query</em>, <em>...</em></code></div> + <div class="method-subsection method-declaration"><code>- (long)longForQuery:(NSString *)<em>query</em>, <em>...</em></code></div> @@ -261,7 +261,7 @@ <div class="method-subsection return"> <h4 class="method-subtitle parameter-title">Return Value</h4> - <p><code>int</code> value.</p> + <p><code>long</code> value.</p> </div> @@ -270,7 +270,7 @@ <div class="method-subsection discussion-section"> <h4 class="method-subtitle">Discussion</h4> - <p>Return <code>int</code> value for query</p><div class="note"><p><strong>Note:</strong> To use this method from Swift, you must include <code>FMDatabaseAdditionsVariadic.swift</code> in your project.</p></div> + <p>Return <code>long</code> value for query</p><div class="note"><p><strong>Note:</strong> To use this method from Swift, you must include <code>FMDatabaseAdditionsVariadic.swift</code> in your project.</p></div> </div> @@ -288,8 +288,8 @@ </div> </div> </div><div class="section-method"> - <a name="//api/name/longForQuery:" title="longForQuery:"></a> - <h3 class="method-title"><code><a href="#//api/name/longForQuery:">– longForQuery:</a></code> + <a name="//api/name/boolForQuery:" title="boolForQuery:"></a> + <h3 class="method-title"><code><a href="#//api/name/boolForQuery:">– boolForQuery:</a></code> </h3> <div class="method-info"> @@ -299,12 +299,12 @@ <div class="method-subsection brief-description"> - <p>Return <code>long</code> value for query</p> + <p>Return <code>BOOL</code> value for query</p> </div> - <div class="method-subsection method-declaration"><code>- (long)longForQuery:(NSString *)<em>query</em>, <em>...</em></code></div> + <div class="method-subsection method-declaration"><code>- (BOOL)boolForQuery:(NSString *)<em>query</em>, <em>...</em></code></div> @@ -329,7 +329,7 @@ <div class="method-subsection return"> <h4 class="method-subtitle parameter-title">Return Value</h4> - <p><code>long</code> value.</p> + <p><code>BOOL</code> value.</p> </div> @@ -338,7 +338,7 @@ <div class="method-subsection discussion-section"> <h4 class="method-subtitle">Discussion</h4> - <p>Return <code>long</code> value for query</p><div class="note"><p><strong>Note:</strong> To use this method from Swift, you must include <code>FMDatabaseAdditionsVariadic.swift</code> in your project.</p></div> + <p>Return <code>BOOL</code> value for query</p><div class="note"><p><strong>Note:</strong> To use this method from Swift, you must include <code>FMDatabaseAdditionsVariadic.swift</code> in your project.</p></div> </div> @@ -356,8 +356,8 @@ </div> </div> </div><div class="section-method"> - <a name="//api/name/boolForQuery:" title="boolForQuery:"></a> - <h3 class="method-title"><code><a href="#//api/name/boolForQuery:">– boolForQuery:</a></code> + <a name="//api/name/doubleForQuery:" title="doubleForQuery:"></a> + <h3 class="method-title"><code><a href="#//api/name/doubleForQuery:">– doubleForQuery:</a></code> </h3> <div class="method-info"> @@ -367,12 +367,12 @@ <div class="method-subsection brief-description"> - <p>Return <code>BOOL</code> value for query</p> + <p>Return <code>double</code> value for query</p> </div> - <div class="method-subsection method-declaration"><code>- (BOOL)boolForQuery:(NSString *)<em>query</em>, <em>...</em></code></div> + <div class="method-subsection method-declaration"><code>- (double)doubleForQuery:(NSString *)<em>query</em>, <em>...</em></code></div> @@ -397,7 +397,7 @@ <div class="method-subsection return"> <h4 class="method-subtitle parameter-title">Return Value</h4> - <p><code>BOOL</code> value.</p> + <p><code>double</code> value.</p> </div> @@ -406,7 +406,7 @@ <div class="method-subsection discussion-section"> <h4 class="method-subtitle">Discussion</h4> - <p>Return <code>BOOL</code> value for query</p><div class="note"><p><strong>Note:</strong> To use this method from Swift, you must include <code>FMDatabaseAdditionsVariadic.swift</code> in your project.</p></div> + <p>Return <code>double</code> value for query</p><div class="note"><p><strong>Note:</strong> To use this method from Swift, you must include <code>FMDatabaseAdditionsVariadic.swift</code> in your project.</p></div> </div> @@ -424,8 +424,8 @@ </div> </div> </div><div class="section-method"> - <a name="//api/name/doubleForQuery:" title="doubleForQuery:"></a> - <h3 class="method-title"><code><a href="#//api/name/doubleForQuery:">– doubleForQuery:</a></code> + <a name="//api/name/stringForQuery:" title="stringForQuery:"></a> + <h3 class="method-title"><code><a href="#//api/name/stringForQuery:">– stringForQuery:</a></code> </h3> <div class="method-info"> @@ -435,12 +435,12 @@ <div class="method-subsection brief-description"> - <p>Return <code>double</code> value for query</p> + <p>Return <code>NSString</code> value for query</p> </div> - <div class="method-subsection method-declaration"><code>- (double)doubleForQuery:(NSString *)<em>query</em>, <em>...</em></code></div> + <div class="method-subsection method-declaration"><code>- (NSString *)stringForQuery:(NSString *)<em>query</em>, <em>...</em></code></div> @@ -465,7 +465,7 @@ <div class="method-subsection return"> <h4 class="method-subtitle parameter-title">Return Value</h4> - <p><code>double</code> value.</p> + <p><code>NSString</code> value.</p> </div> @@ -474,7 +474,7 @@ <div class="method-subsection discussion-section"> <h4 class="method-subtitle">Discussion</h4> - <p>Return <code>double</code> value for query</p><div class="note"><p><strong>Note:</strong> To use this method from Swift, you must include <code>FMDatabaseAdditionsVariadic.swift</code> in your project.</p></div> + <p>Return <code>NSString</code> value for query</p><div class="note"><p><strong>Note:</strong> To use this method from Swift, you must include <code>FMDatabaseAdditionsVariadic.swift</code> in your project.</p></div> </div> @@ -627,7 +627,15 @@ </div> </div> -</div><div class="section-method"> +</div> + </div> + + + <a title="Schema related operations" name="task_Schema related operations"></a> + <h2 class="task-title">Schema related operations</h2> + + <div class="task-list"> + <div class="section-method"> <a name="//api/name/tableExists:" title="tableExists:"></a> <h3 class="method-title"><code><a href="#//api/name/tableExists:">– tableExists:</a></code> </h3> @@ -919,8 +927,8 @@ </div> </div> </div><div class="section-method"> - <a name="//api/name/applicationID" title="applicationID"></a> - <h3 class="method-title"><code><a href="#//api/name/applicationID">– applicationID</a></code> + <a name="//api/name/columnExists:columnName:" title="columnExists:columnName:"></a> + <h3 class="method-title"><code><a href="#//api/name/columnExists:columnName:">– columnExists:columnName:</a></code> </h3> <div class="method-info"> @@ -930,20 +938,37 @@ <div class="method-subsection brief-description"> - <p>Retrieve application ID</p> + <p>Test to see if particular column exists for particular table in database</p> </div> - <div class="method-subsection method-declaration"><code>- (uint32_t)applicationID</code></div> + <div class="method-subsection method-declaration"><code>- (BOOL)columnExists:(NSString *)<em>tableName</em> columnName:(NSString *)<em>columnName</em></code></div> + <div class="method-subsection arguments-section parameters"> + <h4 class="method-subtitle parameter-title">Parameters</h4> + <table class="argument-def parameter-def"> + + <tr> + <th scope="row" class="argument-name"><code>tableName</code></th> + <td><p>The name of the table.</p></td> + </tr> + + <tr> + <th scope="row" class="argument-name"><code>columnName</code></th> + <td><p>The name of the column.</p></td> + </tr> + + </table> + </div> + <div class="method-subsection return"> <h4 class="method-subtitle parameter-title">Return Value</h4> - <p>The <code>uint32_t</code> numeric value of the application ID.</p> + <p><code>YES</code> if column exists in table in question; <code>NO</code> otherwise.</p> </div> @@ -952,7 +977,7 @@ <div class="method-subsection discussion-section"> <h4 class="method-subtitle">Discussion</h4> - <p>Retrieve application ID</p> + <p>Test to see if particular column exists for particular table in database</p><div class="warning"><p><strong>Warning:</strong> Deprecated - use <a href="#//api/name/columnExists:inTableWithName:"><code>columnExists:inTableWithName:</code></a> instead.</p></div> </div> @@ -963,7 +988,7 @@ <h4 class="method-subtitle">See Also</h4> <ul> - <li><code><p><a href="#//api/name/setApplicationID:">- setApplicationID:</a></p></code></li> + <li><code><p><a href="#//api/name/columnExists:inTableWithName:">- columnExists:inTableWithName:</a></p></code></li> </ul> </div> @@ -979,8 +1004,8 @@ </div> </div> </div><div class="section-method"> - <a name="//api/name/setApplicationID:" title="setApplicationID:"></a> - <h3 class="method-title"><code><a href="#//api/name/setApplicationID:">– setApplicationID:</a></code> + <a name="//api/name/validateSQL:error:" title="validateSQL:error:"></a> + <h3 class="method-title"><code><a href="#//api/name/validateSQL:error:">– validateSQL:error:</a></code> </h3> <div class="method-info"> @@ -990,12 +1015,12 @@ <div class="method-subsection brief-description"> - <p>Set the application ID</p> + <p>Validate SQL statement</p> </div> - <div class="method-subsection method-declaration"><code>- (void)setApplicationID:(uint32_t)<em>appID</em></code></div> + <div class="method-subsection method-declaration"><code>- (BOOL)validateSQL:(NSString *)<em>sql</em> error:(NSError **)<em>error</em></code></div> @@ -1004,8 +1029,13 @@ <table class="argument-def parameter-def"> <tr> - <th scope="row" class="argument-name"><code>appID</code></th> - <td><p>The <code>uint32_t</code> numeric value of the application ID.</p></td> + <th scope="row" class="argument-name"><code>sql</code></th> + <td><p>The SQL statement being validated.</p></td> + </tr> + + <tr> + <th scope="row" class="argument-name"><code>error</code></th> + <td><p>This is a pointer to a <code>NSError</code> object that will receive the autoreleased <code>NSError</code> object if there was any error. If this is <code>nil</code>, no <code>NSError</code> result will be returned.</p></td> </tr> </table> @@ -1013,28 +1043,26 @@ + <div class="method-subsection return"> + <h4 class="method-subtitle parameter-title">Return Value</h4> + <p><code>YES</code> if validation succeeded without incident; <code>NO</code> otherwise.</p> + </div> + <div class="method-subsection discussion-section"> <h4 class="method-subtitle">Discussion</h4> - <p>Set the application ID</p> + <p>Validate SQL statement</p> + +<p>This validates SQL statement by performing <code>sqlite3_prepare_v2</code>, but not returning the results, but instead immediately calling <code>sqlite3_finalize</code>.</p> </div> - <div class="method-subsection see-also-section"> - <h4 class="method-subtitle">See Also</h4> - <ul> - - <li><code><p><a href="#//api/name/applicationID">- applicationID</a></p></code></li> - - </ul> - </div> - <div class="method-subsection declared-in-section"> @@ -1045,9 +1073,17 @@ </div> </div> -</div><div class="section-method"> - <a name="//api/name/applicationIDString" title="applicationIDString"></a> - <h3 class="method-title"><code><a href="#//api/name/applicationIDString">– applicationIDString</a></code> +</div> + </div> + + + <a title="Application identifier tasks" name="task_Application identifier tasks"></a> + <h2 class="task-title">Application identifier tasks</h2> + + <div class="task-list"> + <div class="section-method"> + <a name="//api/name/applicationID" title="applicationID"></a> + <h3 class="method-title"><code><a href="#//api/name/applicationID">– applicationID</a></code> </h3> <div class="method-info"> @@ -1057,12 +1093,12 @@ <div class="method-subsection brief-description"> - <p>Retrieve application ID string</p> + <p>Retrieve application ID</p> </div> - <div class="method-subsection method-declaration"><code>- (NSString *)applicationIDString</code></div> + <div class="method-subsection method-declaration"><code>- (uint32_t)applicationID</code></div> @@ -1070,7 +1106,7 @@ <div class="method-subsection return"> <h4 class="method-subtitle parameter-title">Return Value</h4> - <p>The <code>NSString</code> value of the application ID.</p> + <p>The <code>uint32_t</code> numeric value of the application ID.</p> </div> @@ -1079,7 +1115,7 @@ <div class="method-subsection discussion-section"> <h4 class="method-subtitle">Discussion</h4> - <p>Retrieve application ID string</p> + <p>Retrieve application ID</p> </div> @@ -1090,7 +1126,7 @@ <h4 class="method-subtitle">See Also</h4> <ul> - <li><code><p><a href="#//api/name/setApplicationIDString:">- setApplicationIDString:</a></p></code></li> + <li><code><p><a href="#//api/name/setApplicationID:">- setApplicationID:</a></p></code></li> </ul> </div> @@ -1106,8 +1142,8 @@ </div> </div> </div><div class="section-method"> - <a name="//api/name/setApplicationIDString:" title="setApplicationIDString:"></a> - <h3 class="method-title"><code><a href="#//api/name/setApplicationIDString:">– setApplicationIDString:</a></code> + <a name="//api/name/setApplicationID:" title="setApplicationID:"></a> + <h3 class="method-title"><code><a href="#//api/name/setApplicationID:">– setApplicationID:</a></code> </h3> <div class="method-info"> @@ -1117,12 +1153,12 @@ <div class="method-subsection brief-description"> - <p>Set the application ID string</p> + <p>Set the application ID</p> </div> - <div class="method-subsection method-declaration"><code>- (void)setApplicationIDString:(NSString *)<em>string</em></code></div> + <div class="method-subsection method-declaration"><code>- (void)setApplicationID:(uint32_t)<em>appID</em></code></div> @@ -1131,8 +1167,8 @@ <table class="argument-def parameter-def"> <tr> - <th scope="row" class="argument-name"><code>string</code></th> - <td><p>The <code>NSString</code> value of the application ID.</p></td> + <th scope="row" class="argument-name"><code>appID</code></th> + <td><p>The <code>uint32_t</code> numeric value of the application ID.</p></td> </tr> </table> @@ -1146,7 +1182,7 @@ <div class="method-subsection discussion-section"> <h4 class="method-subtitle">Discussion</h4> - <p>Set the application ID string</p> + <p>Set the application ID</p> </div> @@ -1157,7 +1193,7 @@ <h4 class="method-subtitle">See Also</h4> <ul> - <li><code><p><a href="#//api/name/applicationIDString">- applicationIDString</a></p></code></li> + <li><code><p><a href="#//api/name/applicationID">- applicationID</a></p></code></li> </ul> </div> @@ -1173,8 +1209,8 @@ </div> </div> </div><div class="section-method"> - <a name="//api/name/userVersion" title="userVersion"></a> - <h3 class="method-title"><code><a href="#//api/name/userVersion">– userVersion</a></code> + <a name="//api/name/applicationIDString" title="applicationIDString"></a> + <h3 class="method-title"><code><a href="#//api/name/applicationIDString">– applicationIDString</a></code> </h3> <div class="method-info"> @@ -1184,12 +1220,12 @@ <div class="method-subsection brief-description"> - <p>Retrieve user version</p> + <p>Retrieve application ID string</p> </div> - <div class="method-subsection method-declaration"><code>- (uint32_t)userVersion</code></div> + <div class="method-subsection method-declaration"><code>- (NSString *)applicationIDString</code></div> @@ -1197,7 +1233,7 @@ <div class="method-subsection return"> <h4 class="method-subtitle parameter-title">Return Value</h4> - <p>The <code>uint32_t</code> numeric value of the user version.</p> + <p>The <code>NSString</code> value of the application ID.</p> </div> @@ -1206,7 +1242,7 @@ <div class="method-subsection discussion-section"> <h4 class="method-subtitle">Discussion</h4> - <p>Retrieve user version</p> + <p>Retrieve application ID string</p> </div> @@ -1217,7 +1253,7 @@ <h4 class="method-subtitle">See Also</h4> <ul> - <li><code><p><a href="#//api/name/setUserVersion:">- setUserVersion:</a></p></code></li> + <li><code><p><a href="#//api/name/setApplicationIDString:">- setApplicationIDString:</a></p></code></li> </ul> </div> @@ -1233,8 +1269,8 @@ </div> </div> </div><div class="section-method"> - <a name="//api/name/setUserVersion:" title="setUserVersion:"></a> - <h3 class="method-title"><code><a href="#//api/name/setUserVersion:">– setUserVersion:</a></code> + <a name="//api/name/setApplicationIDString:" title="setApplicationIDString:"></a> + <h3 class="method-title"><code><a href="#//api/name/setApplicationIDString:">– setApplicationIDString:</a></code> </h3> <div class="method-info"> @@ -1244,12 +1280,12 @@ <div class="method-subsection brief-description"> - <p>Set the user-version</p> + <p>Set the application ID string</p> </div> - <div class="method-subsection method-declaration"><code>- (void)setUserVersion:(uint32_t)<em>version</em></code></div> + <div class="method-subsection method-declaration"><code>- (void)setApplicationIDString:(NSString *)<em>string</em></code></div> @@ -1258,8 +1294,8 @@ <table class="argument-def parameter-def"> <tr> - <th scope="row" class="argument-name"><code>version</code></th> - <td><p>The <code>uint32_t</code> numeric value of the user version.</p></td> + <th scope="row" class="argument-name"><code>string</code></th> + <td><p>The <code>NSString</code> value of the application ID.</p></td> </tr> </table> @@ -1273,7 +1309,7 @@ <div class="method-subsection discussion-section"> <h4 class="method-subtitle">Discussion</h4> - <p>Set the user-version</p> + <p>Set the application ID string</p> </div> @@ -1284,7 +1320,7 @@ <h4 class="method-subtitle">See Also</h4> <ul> - <li><code><p><a href="#//api/name/userVersion">- userVersion</a></p></code></li> + <li><code><p><a href="#//api/name/applicationIDString">- applicationIDString</a></p></code></li> </ul> </div> @@ -1299,9 +1335,17 @@ </div> </div> -</div><div class="section-method"> - <a name="//api/name/columnExists:columnName:" title="columnExists:columnName:"></a> - <h3 class="method-title"><code><a href="#//api/name/columnExists:columnName:">– columnExists:columnName:</a></code> +</div> + </div> + + + <a title="user version identifier tasks" name="task_user version identifier tasks"></a> + <h2 class="task-title">user version identifier tasks</h2> + + <div class="task-list"> + <div class="section-method"> + <a name="//api/name/userVersion" title="userVersion"></a> + <h3 class="method-title"><code><a href="#//api/name/userVersion">– userVersion</a></code> </h3> <div class="method-info"> @@ -1311,37 +1355,20 @@ <div class="method-subsection brief-description"> - <p>Test to see if particular column exists for particular table in database</p> + <p>Retrieve user version</p> </div> - <div class="method-subsection method-declaration"><code>- (BOOL)columnExists:(NSString *)<em>tableName</em> columnName:(NSString *)<em>columnName</em></code></div> + <div class="method-subsection method-declaration"><code>- (uint32_t)userVersion</code></div> - <div class="method-subsection arguments-section parameters"> - <h4 class="method-subtitle parameter-title">Parameters</h4> - <table class="argument-def parameter-def"> - - <tr> - <th scope="row" class="argument-name"><code>tableName</code></th> - <td><p>The name of the table.</p></td> - </tr> - - <tr> - <th scope="row" class="argument-name"><code>columnName</code></th> - <td><p>The name of the column.</p></td> - </tr> - - </table> - </div> - <div class="method-subsection return"> <h4 class="method-subtitle parameter-title">Return Value</h4> - <p><code>YES</code> if column exists in table in question; <code>NO</code> otherwise.</p> + <p>The <code>uint32_t</code> numeric value of the user version.</p> </div> @@ -1350,7 +1377,7 @@ <div class="method-subsection discussion-section"> <h4 class="method-subtitle">Discussion</h4> - <p>Test to see if particular column exists for particular table in database</p><div class="warning"><p><strong>Warning:</strong> Deprecated - use <a href="#//api/name/columnExists:inTableWithName:"><code>columnExists:inTableWithName:</code></a> instead.</p></div> + <p>Retrieve user version</p> </div> @@ -1361,7 +1388,7 @@ <h4 class="method-subtitle">See Also</h4> <ul> - <li><code><p><a href="#//api/name/columnExists:inTableWithName:">- columnExists:inTableWithName:</a></p></code></li> + <li><code><p><a href="#//api/name/setUserVersion:">- setUserVersion:</a></p></code></li> </ul> </div> @@ -1377,8 +1404,8 @@ </div> </div> </div><div class="section-method"> - <a name="//api/name/validateSQL:error:" title="validateSQL:error:"></a> - <h3 class="method-title"><code><a href="#//api/name/validateSQL:error:">– validateSQL:error:</a></code> + <a name="//api/name/setUserVersion:" title="setUserVersion:"></a> + <h3 class="method-title"><code><a href="#//api/name/setUserVersion:">– setUserVersion:</a></code> </h3> <div class="method-info"> @@ -1388,12 +1415,12 @@ <div class="method-subsection brief-description"> - <p>Validate SQL statement</p> + <p>Set the user-version</p> </div> - <div class="method-subsection method-declaration"><code>- (BOOL)validateSQL:(NSString *)<em>sql</em> error:(NSError **)<em>error</em></code></div> + <div class="method-subsection method-declaration"><code>- (void)setUserVersion:(uint32_t)<em>version</em></code></div> @@ -1402,13 +1429,8 @@ <table class="argument-def parameter-def"> <tr> - <th scope="row" class="argument-name"><code>sql</code></th> - <td><p>The SQL statement being validated.</p></td> - </tr> - - <tr> - <th scope="row" class="argument-name"><code>error</code></th> - <td><p>This is a pointer to a <code>NSError</code> object that will receive the autoreleased <code>NSError</code> object if there was any error. If this is <code>nil</code>, no <code>NSError</code> result will be returned.</p></td> + <th scope="row" class="argument-name"><code>version</code></th> + <td><p>The <code>uint32_t</code> numeric value of the user version.</p></td> </tr> </table> @@ -1416,26 +1438,28 @@ - <div class="method-subsection return"> - <h4 class="method-subtitle parameter-title">Return Value</h4> - <p><code>YES</code> if validation succeeded without incident; <code>NO</code> otherwise.</p> - </div> - <div class="method-subsection discussion-section"> <h4 class="method-subtitle">Discussion</h4> - <p>Validate SQL statement</p> - -<p>This validates SQL statement by performing <code>sqlite3_prepare_v2</code>, but not returning the results, but instead immediately calling <code>sqlite3_finalize</code>.</p> + <p>Set the user-version</p> </div> + <div class="method-subsection see-also-section"> + <h4 class="method-subtitle">See Also</h4> + <ul> + + <li><code><p><a href="#//api/name/userVersion">- userVersion</a></p></code></li> + + </ul> + </div> + <div class="method-subsection declared-in-section"> @@ -1459,10 +1483,10 @@ <footer> <div class="footer-copyright"> - <p class="copyright">Copyright © 2015 ccgus. All rights reserved. Updated: 2015-01-25</p> + <p class="copyright">Copyright © 2015 ccgus. All rights reserved. Updated: 2015-10-29</p> - <p class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.2.1 (build 1333)</a>.</p> + <p class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.2.1 (build 1334)</a>.</p> </div> </footer> diff --git a/html/Categories/NSObject+FMDatabasePoolDelegate.html b/html/Categories/NSObject+FMDatabasePoolDelegate.html index 9d6ff13..5e6327d 100644 --- a/html/Categories/NSObject+FMDatabasePoolDelegate.html +++ b/html/Categories/NSObject+FMDatabasePoolDelegate.html @@ -7,7 +7,7 @@ <link rel="stylesheet" href="../css/style.css"> <meta name="viewport" content="initial-scale=1, maximum-scale=1.4"> - <meta name="generator" content="appledoc 2.2.1 (build 1333)"> + <meta name="generator" content="appledoc 2.2.1 (build 1334)"> </head> <body class="appledoc"> <header> @@ -256,10 +256,10 @@ <footer> <div class="footer-copyright"> - <p class="copyright">Copyright © 2015 ccgus. All rights reserved. Updated: 2015-01-25</p> + <p class="copyright">Copyright © 2015 ccgus. All rights reserved. Updated: 2015-10-29</p> - <p class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.2.1 (build 1333)</a>.</p> + <p class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.2.1 (build 1334)</a>.</p> </div> </footer> diff --git a/html/Classes/FMDatabase.html b/html/Classes/FMDatabase.html index ece6ffe..14737f1 100644 --- a/html/Classes/FMDatabase.html +++ b/html/Classes/FMDatabase.html @@ -7,7 +7,7 @@ <link rel="stylesheet" href="../css/style.css"> <meta name="viewport" content="initial-scale=1, maximum-scale=1.4"> - <meta name="generator" content="appledoc 2.2.1 (build 1333)"> + <meta name="generator" content="appledoc 2.2.1 (build 1334)"> </head> <body class="appledoc"> <header> @@ -106,6 +106,8 @@ <option value="//api/name/executeQuery:">- executeQuery:</option> + <option value="//api/name/executeQuery:values:error:">- executeQuery:values:error:</option> + <option value="//api/name/executeQuery:withArgumentsInArray:">- executeQuery:withArgumentsInArray:</option> <option value="//api/name/executeQuery:withParameterDictionary:">- executeQuery:withParameterDictionary:</option> @@ -118,6 +120,8 @@ <option value="//api/name/executeUpdate:">- executeUpdate:</option> + <option value="//api/name/executeUpdate:values:error:">- executeUpdate:values:error:</option> + <option value="//api/name/executeUpdate:withArgumentsInArray:">- executeUpdate:withArgumentsInArray:</option> <option value="//api/name/executeUpdate:withErrorAndBindings:">- executeUpdate:withErrorAndBindings:</option> @@ -758,7 +762,7 @@ FMDatabase *db = [FMDatabase databaseWithPath:dbPath]; <div class="method-subsection brief-description"> - <p>Opening a new database connection with flags</p> + <p>Opening a new database connection with flags and an optional virtual file system (VFS)</p> </div> @@ -785,7 +789,9 @@ FMDatabase *db = [FMDatabase databaseWithPath:dbPath]; <p><code>SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE</code></p> -<p>The database is opened for reading and writing, and is created if it does not already exist. This is the behavior that is always used for <code>open</code> method.</p></td> +<p>The database is opened for reading and writing, and is created if it does not already exist. This is the behavior that is always used for <code>open</code> method.</p> + +<p>If vfs is given the value is passed to the vfs parameter of sqlite3_open_v2.</p></td> </tr> </table> @@ -804,7 +810,7 @@ FMDatabase *db = [FMDatabase databaseWithPath:dbPath]; <div class="method-subsection discussion-section"> <h4 class="method-subtitle">Discussion</h4> - <p>Opening a new database connection with flags</p> + <p>Opening a new database connection with flags and an optional virtual file system (VFS)</p> </div> @@ -1360,6 +1366,104 @@ FMDatabase *db = [FMDatabase databaseWithPath:dbPath]; <h4 class="method-subtitle">See Also</h4> <ul> + <li><code><p><a href="#//api/name/executeUpdate:values:error:">- executeUpdate:values:error:</a></p></code></li> + + <li><code><p><a href="#//api/name/lastError">- lastError</a></p></code></li> + + <li><code><p><a href="#//api/name/lastErrorCode">- lastErrorCode</a></p></code></li> + + <li><code><p><a href="#//api/name/lastErrorMessage">- lastErrorMessage</a></p></code></li> + + </ul> + </div> + + + + <div class="method-subsection declared-in-section"> + <h4 class="method-subtitle">Declared In</h4> + <p><code class="declared-in-ref">FMDatabase.h</code></p> + </div> + + + </div> + </div> +</div><div class="section-method"> + <a name="//api/name/executeUpdate:values:error:" title="executeUpdate:values:error:"></a> + <h3 class="method-title"><code><a href="#//api/name/executeUpdate:values:error:">– executeUpdate:values:error:</a></code> +</h3> + + <div class="method-info"> + <div class="pointy-thing"></div> + + <div class="method-info-container"> + + + <div class="method-subsection brief-description"> + <p>Execute single update statement</p> + </div> + + + + <div class="method-subsection method-declaration"><code>- (BOOL)executeUpdate:(NSString *)<em>sql</em> values:(NSArray *)<em>values</em> error:(NSError *__autoreleasing *)<em>error</em></code></div> + + + + <div class="method-subsection arguments-section parameters"> + <h4 class="method-subtitle parameter-title">Parameters</h4> + <table class="argument-def parameter-def"> + + <tr> + <th scope="row" class="argument-name"><code>sql</code></th> + <td><p>The SQL to be performed, with optional <code>?</code> placeholders.</p></td> + </tr> + + <tr> + <th scope="row" class="argument-name"><code>values</code></th> + <td><p>A <code>NSArray</code> of objects to be used when binding values to the <code>?</code> placeholders in the SQL statement.</p></td> + </tr> + + <tr> + <th scope="row" class="argument-name"><code>error</code></th> + <td><p>A <code>NSError</code> object to receive any error object (if any).</p></td> + </tr> + + </table> + </div> + + + + <div class="method-subsection return"> + <h4 class="method-subtitle parameter-title">Return Value</h4> + <p><code>YES</code> upon success; <code>NO</code> upon failure. If failed, you can call <a href="#//api/name/lastError"><code>lastError</code></a>, <a href="#//api/name/lastErrorCode"><code>lastErrorCode</code></a>, or <a href="#//api/name/lastErrorMessage"><code>lastErrorMessage</code></a> for diagnostic information regarding the failure.</p> + </div> + + + + + + <div class="method-subsection discussion-section"> + <h4 class="method-subtitle">Discussion</h4> + <p>Execute single update statement</p> + +<p>This method executes a single SQL update statement (i.e. any SQL that does not return results, such as <code>UPDATE</code>, <code>INSERT</code>, or <code>DELETE</code>. This method employs <a href="http://sqlite.org/c3ref/prepare.html"><code>sqlite3_prepare_v2</code></a> and <a href="http://sqlite.org/c3ref/bind_blob.html"><code>sqlite3_bind</code></a> binding any <code>?</code> placeholders in the SQL with the optional list of parameters.</p> + +<p>The optional values provided to this method should be objects (e.g. <code>NSString</code>, <code>NSNumber</code>, <code>NSNull</code>, <code>NSDate</code>, and <code>NSData</code> objects), not fundamental data types (e.g. <code>int</code>, <code>long</code>, <code>NSInteger</code>, etc.). This method automatically handles the aforementioned object types, and all other object types will be interpreted as text values using the object’s <code>description</code> method.</p> + +<p>This is similar to <a href="#//api/name/executeUpdate:withArgumentsInArray:"><code>executeUpdate:withArgumentsInArray:</code></a>, except that this also accepts a pointer to a <code>NSError</code> pointer, so that errors can be returned.</p> + +<p>In Swift 2, this throws errors, as if it were defined as follows:</p> + +<p><code>func executeUpdate(sql: String!, values: [AnyObject]!) throws -> Bool</code></p> + </div> + + + + + + <div class="method-subsection see-also-section"> + <h4 class="method-subtitle">See Also</h4> + <ul> + <li><code><p><a href="#//api/name/lastError">- lastError</a></p></code></li> <li><code><p><a href="#//api/name/lastErrorCode">- lastErrorCode</a></p></code></li> @@ -2092,6 +2196,102 @@ FMDatabase *db = [FMDatabase databaseWithPath:dbPath]; <h4 class="method-subtitle">See Also</h4> <ul> + <li><code><p><a href="#//api/name/executeQuery:values:error:">- executeQuery:values:error:</a></p></code></li> + + <li><code><p><a href="../Classes/FMResultSet.html">FMResultSet</a></p></code></li> + + <li><code><p><a href="../Classes/FMResultSet.html#//api/name/next"><code>FMResultSet next</code></a></p></code></li> + + </ul> + </div> + + + + <div class="method-subsection declared-in-section"> + <h4 class="method-subtitle">Declared In</h4> + <p><code class="declared-in-ref">FMDatabase.h</code></p> + </div> + + + </div> + </div> +</div><div class="section-method"> + <a name="//api/name/executeQuery:values:error:" title="executeQuery:values:error:"></a> + <h3 class="method-title"><code><a href="#//api/name/executeQuery:values:error:">– executeQuery:values:error:</a></code> +</h3> + + <div class="method-info"> + <div class="pointy-thing"></div> + + <div class="method-info-container"> + + + <div class="method-subsection brief-description"> + <p>Execute select statement</p> + </div> + + + + <div class="method-subsection method-declaration"><code>- (FMResultSet *)executeQuery:(NSString *)<em>sql</em> values:(NSArray *)<em>values</em> error:(NSError *__autoreleasing *)<em>error</em></code></div> + + + + <div class="method-subsection arguments-section parameters"> + <h4 class="method-subtitle parameter-title">Parameters</h4> + <table class="argument-def parameter-def"> + + <tr> + <th scope="row" class="argument-name"><code>sql</code></th> + <td><p>The SELECT statement to be performed, with optional <code>?</code> placeholders.</p></td> + </tr> + + <tr> + <th scope="row" class="argument-name"><code>values</code></th> + <td><p>A <code>NSArray</code> of objects to be used when binding values to the <code>?</code> placeholders in the SQL statement.</p></td> + </tr> + + <tr> + <th scope="row" class="argument-name"><code>error</code></th> + <td><p>A <code>NSError</code> object to receive any error object (if any).</p></td> + </tr> + + </table> + </div> + + + + <div class="method-subsection return"> + <h4 class="method-subtitle parameter-title">Return Value</h4> + <p>A <a href="../Classes/FMResultSet.html"><code>FMResultSet</code></a> for the result set upon success; <code>nil</code> upon failure. If failed, you can call <a href="#//api/name/lastError"><code>lastError</code></a>, <a href="#//api/name/lastErrorCode"><code>lastErrorCode</code></a>, or <a href="#//api/name/lastErrorMessage"><code>lastErrorMessage</code></a> for diagnostic information regarding the failure.</p> + </div> + + + + + + <div class="method-subsection discussion-section"> + <h4 class="method-subtitle">Discussion</h4> + <p>Execute select statement</p> + +<p>Executing queries returns an <a href="../Classes/FMResultSet.html"><code>FMResultSet</code></a> object if successful, and <code>nil</code> upon failure. Like executing updates, there is a variant that accepts an <code>NSError **</code> parameter. Otherwise you should use the <a href="#//api/name/lastErrorMessage"><code>lastErrorMessage</code></a> and <a href="#//api/name/lastErrorMessage"><code>lastErrorMessage</code></a> methods to determine why a query failed.</p> + +<p>In order to iterate through the results of your query, you use a <code>while()</code> loop. You also need to “step” (via <a href="../Classes/FMResultSet.html#//api/name/next"><code>[FMResultSet next]</code></a>) from one record to the other.</p> + +<p>This is similar to <a href="#//api/name/executeQuery:withArgumentsInArray:"><code>executeQuery:withArgumentsInArray:</code></a>, except that this also accepts a pointer to a <code>NSError</code> pointer, so that errors can be returned.</p> + +<p>In Swift 2, this throws errors, as if it were defined as follows:</p> + +<p><code>func executeQuery(sql: String!, values: [AnyObject]!) throws -> FMResultSet!</code></p><div class="note"><p><strong>Note:</strong> When called from Swift, only use the first two parameters, <code>sql</code> and <code>values</code>. This but throws the error.</p></div> + </div> + + + + + + <div class="method-subsection see-also-section"> + <h4 class="method-subtitle">See Also</h4> + <ul> + <li><code><p><a href="../Classes/FMResultSet.html">FMResultSet</a></p></code></li> <li><code><p><a href="../Classes/FMResultSet.html#//api/name/next"><code>FMResultSet next</code></a></p></code></li> @@ -4445,10 +4645,10 @@ FMDatabase *db = [FMDatabase databaseWithPath:dbPath]; <footer> <div class="footer-copyright"> - <p class="copyright">Copyright © 2015 ccgus. All rights reserved. Updated: 2015-01-25</p> + <p class="copyright">Copyright © 2015 ccgus. All rights reserved. Updated: 2015-10-29</p> - <p class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.2.1 (build 1333)</a>.</p> + <p class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.2.1 (build 1334)</a>.</p> </div> </footer> diff --git a/html/Classes/FMDatabasePool.html b/html/Classes/FMDatabasePool.html index 524cc1b..12b9cec 100644 --- a/html/Classes/FMDatabasePool.html +++ b/html/Classes/FMDatabasePool.html @@ -7,7 +7,7 @@ <link rel="stylesheet" href="../css/style.css"> <meta name="viewport" content="initial-scale=1, maximum-scale=1.4"> - <meta name="generator" content="appledoc 2.2.1 (build 1333)"> + <meta name="generator" content="appledoc 2.2.1 (build 1334)"> </head> <body class="appledoc"> <header> @@ -124,7 +124,7 @@ <td>NSObject</td> </tr><tr> <th>Declared in</th> - <td>FMDatabasePool.h<br />FMDatabasePool.m</td> + <td>FMDatabasePool.h</td> </tr> </tbody></table></div> @@ -166,8 +166,8 @@ in the main.m file.</p></div> <div class="task-list"> <div class="section-method"> - <a name="//api/name/databasePoolWithPath:" title="databasePoolWithPath:"></a> - <h3 class="method-title"><code><a href="#//api/name/databasePoolWithPath:">+ databasePoolWithPath:</a></code> + <a name="//api/name/path" title="path"></a> + <h3 class="method-title"><code><a href="#//api/name/path"> path</a></code> </h3> <div class="method-info"> @@ -177,41 +177,24 @@ in the main.m file.</p></div> <div class="method-subsection brief-description"> - <p>Create pool using path.</p> + <p>Database path</p> </div> - <div class="method-subsection method-declaration"><code>+ (instancetype)databasePoolWithPath:(NSString *)<em>aPath</em></code></div> + <div class="method-subsection method-declaration"><code>@property (atomic, retain) NSString *path</code></div> - <div class="method-subsection arguments-section parameters"> - <h4 class="method-subtitle parameter-title">Parameters</h4> - <table class="argument-def parameter-def"> - - <tr> - <th scope="row" class="argument-name"><code>aPath</code></th> - <td><p>The file path of the database.</p></td> - </tr> - - </table> - </div> - - <div class="method-subsection return"> - <h4 class="method-subtitle parameter-title">Return Value</h4> - <p>The <code>FMDatabasePool</code> object. <code>nil</code> on error.</p> - </div> - <div class="method-subsection discussion-section"> <h4 class="method-subtitle">Discussion</h4> - <p>Create pool using path.</p> + <p>Database path</p> </div> @@ -229,8 +212,8 @@ in the main.m file.</p></div> </div> </div> </div><div class="section-method"> - <a name="//api/name/databasePoolWithPath:flags:" title="databasePoolWithPath:flags:"></a> - <h3 class="method-title"><code><a href="#//api/name/databasePoolWithPath:flags:">+ databasePoolWithPath:flags:</a></code> + <a name="//api/name/delegate" title="delegate"></a> + <h3 class="method-title"><code><a href="#//api/name/delegate"> delegate</a></code> </h3> <div class="method-info"> @@ -240,46 +223,24 @@ in the main.m file.</p></div> <div class="method-subsection brief-description"> - <p>Create pool using path and specified flags</p> + <p>Delegate object</p> </div> - <div class="method-subsection method-declaration"><code>+ (instancetype)databasePoolWithPath:(NSString *)<em>aPath</em> flags:(int)<em>openFlags</em></code></div> + <div class="method-subsection method-declaration"><code>@property (atomic, assign) id delegate</code></div> - <div class="method-subsection arguments-section parameters"> - <h4 class="method-subtitle parameter-title">Parameters</h4> - <table class="argument-def parameter-def"> - - <tr> - <th scope="row" class="argument-name"><code>aPath</code></th> - <td><p>The file path of the database.</p></td> - </tr> - - <tr> - <th scope="row" class="argument-name"><code>openFlags</code></th> - <td><p>Flags passed to the openWithFlags method of the database</p></td> - </tr> - - </table> - </div> - - <div class="method-subsection return"> - <h4 class="method-subtitle parameter-title">Return Value</h4> - <p>The <code>FMDatabasePool</code> object. <code>nil</code> on error.</p> - </div> - <div class="method-subsection discussion-section"> <h4 class="method-subtitle">Discussion</h4> - <p>Create pool using path and specified flags</p> + <p>Delegate object</p> </div> @@ -297,8 +258,8 @@ in the main.m file.</p></div> </div> </div> </div><div class="section-method"> - <a name="//api/name/initWithPath:flags:" title="initWithPath:flags:"></a> - <h3 class="method-title"><code><a href="#//api/name/initWithPath:flags:">– initWithPath:flags:</a></code> + <a name="//api/name/maximumNumberOfDatabasesToCreate" title="maximumNumberOfDatabasesToCreate"></a> + <h3 class="method-title"><code><a href="#//api/name/maximumNumberOfDatabasesToCreate"> maximumNumberOfDatabasesToCreate</a></code> </h3> <div class="method-info"> @@ -308,46 +269,24 @@ in the main.m file.</p></div> <div class="method-subsection brief-description"> - <p>Create pool using path and specified flags.</p> + <p>Maximum number of databases to create</p> </div> - <div class="method-subsection method-declaration"><code>- (instancetype)initWithPath:(NSString *)<em>aPath</em> flags:(int)<em>openFlags</em></code></div> + <div class="method-subsection method-declaration"><code>@property (atomic, assign) NSUInteger maximumNumberOfDatabasesToCreate</code></div> - <div class="method-subsection arguments-section parameters"> - <h4 class="method-subtitle parameter-title">Parameters</h4> - <table class="argument-def parameter-def"> - - <tr> - <th scope="row" class="argument-name"><code>aPath</code></th> - <td><p>The file path of the database.</p></td> - </tr> - - <tr> - <th scope="row" class="argument-name"><code>openFlags</code></th> - <td><p>Flags passed to the openWithFlags method of the database</p></td> - </tr> - - </table> - </div> - - <div class="method-subsection return"> - <h4 class="method-subtitle parameter-title">Return Value</h4> - <p>The <code>FMDatabasePool</code> object. <code>nil</code> on error.</p> - </div> - <div class="method-subsection discussion-section"> <h4 class="method-subtitle">Discussion</h4> - <p>Create pool using path and specified flags.</p> + <p>Maximum number of databases to create</p> </div> @@ -365,8 +304,8 @@ in the main.m file.</p></div> </div> </div> </div><div class="section-method"> - <a name="//api/name/initWithPath:" title="initWithPath:"></a> - <h3 class="method-title"><code><a href="#//api/name/initWithPath:">– initWithPath:</a></code> + <a name="//api/name/openFlags" title="openFlags"></a> + <h3 class="method-title"><code><a href="#//api/name/openFlags"> openFlags</a></code> </h3> <div class="method-info"> @@ -376,41 +315,24 @@ in the main.m file.</p></div> <div class="method-subsection brief-description"> - <p>Create pool using path.</p> + <p>Open flags</p> </div> - <div class="method-subsection method-declaration"><code>- (instancetype)initWithPath:(NSString *)<em>aPath</em></code></div> + <div class="method-subsection method-declaration"><code>@property (atomic, readonly) int openFlags</code></div> - <div class="method-subsection arguments-section parameters"> - <h4 class="method-subtitle parameter-title">Parameters</h4> - <table class="argument-def parameter-def"> - - <tr> - <th scope="row" class="argument-name"><code>aPath</code></th> - <td><p>The file path of the database.</p></td> - </tr> - - </table> - </div> - - <div class="method-subsection return"> - <h4 class="method-subtitle parameter-title">Return Value</h4> - <p>The <code>FMDatabasePool</code> object. <code>nil</code> on error.</p> - </div> - <div class="method-subsection discussion-section"> <h4 class="method-subtitle">Discussion</h4> - <p>Create pool using path.</p> + <p>Open flags</p> </div> @@ -427,9 +349,17 @@ in the main.m file.</p></div> </div> </div> -</div><div class="section-method"> - <a name="//api/name/countOfCheckedInDatabases" title="countOfCheckedInDatabases"></a> - <h3 class="method-title"><code><a href="#//api/name/countOfCheckedInDatabases">– countOfCheckedInDatabases</a></code> +</div> + </div> + + + <a title="Initialization" name="task_Initialization"></a> + <h2 class="task-title">Initialization</h2> + + <div class="task-list"> + <div class="section-method"> + <a name="//api/name/databasePoolWithPath:" title="databasePoolWithPath:"></a> + <h3 class="method-title"><code><a href="#//api/name/databasePoolWithPath:">+ databasePoolWithPath:</a></code> </h3> <div class="method-info"> @@ -439,20 +369,32 @@ in the main.m file.</p></div> <div class="method-subsection brief-description"> - <p>Number of checked-in databases in pool</p> + <p>Create pool using path.</p> </div> - <div class="method-subsection method-declaration"><code>- (NSUInteger)countOfCheckedInDatabases</code></div> + <div class="method-subsection method-declaration"><code>+ (instancetype)databasePoolWithPath:(NSString *)<em>aPath</em></code></div> + <div class="method-subsection arguments-section parameters"> + <h4 class="method-subtitle parameter-title">Parameters</h4> + <table class="argument-def parameter-def"> + + <tr> + <th scope="row" class="argument-name"><code>aPath</code></th> + <td><p>The file path of the database.</p></td> + </tr> + + </table> + </div> + <div class="method-subsection return"> <h4 class="method-subtitle parameter-title">Return Value</h4> - <p>Number of databases</p> + <p>The <code>FMDatabasePool</code> object. <code>nil</code> on error.</p> </div> @@ -461,7 +403,7 @@ in the main.m file.</p></div> <div class="method-subsection discussion-section"> <h4 class="method-subtitle">Discussion</h4> - <p>Number of checked-in databases in pool</p> + <p>Create pool using path.</p> </div> @@ -479,8 +421,8 @@ in the main.m file.</p></div> </div> </div> </div><div class="section-method"> - <a name="//api/name/countOfCheckedOutDatabases" title="countOfCheckedOutDatabases"></a> - <h3 class="method-title"><code><a href="#//api/name/countOfCheckedOutDatabases">– countOfCheckedOutDatabases</a></code> + <a name="//api/name/databasePoolWithPath:flags:" title="databasePoolWithPath:flags:"></a> + <h3 class="method-title"><code><a href="#//api/name/databasePoolWithPath:flags:">+ databasePoolWithPath:flags:</a></code> </h3> <div class="method-info"> @@ -490,20 +432,37 @@ in the main.m file.</p></div> <div class="method-subsection brief-description"> - <p>Number of checked-out databases in pool</p> + <p>Create pool using path and specified flags</p> </div> - <div class="method-subsection method-declaration"><code>- (NSUInteger)countOfCheckedOutDatabases</code></div> + <div class="method-subsection method-declaration"><code>+ (instancetype)databasePoolWithPath:(NSString *)<em>aPath</em> flags:(int)<em>openFlags</em></code></div> + <div class="method-subsection arguments-section parameters"> + <h4 class="method-subtitle parameter-title">Parameters</h4> + <table class="argument-def parameter-def"> + + <tr> + <th scope="row" class="argument-name"><code>aPath</code></th> + <td><p>The file path of the database.</p></td> + </tr> + + <tr> + <th scope="row" class="argument-name"><code>openFlags</code></th> + <td><p>Flags passed to the openWithFlags method of the database</p></td> + </tr> + + </table> + </div> + <div class="method-subsection return"> <h4 class="method-subtitle parameter-title">Return Value</h4> - <p>Number of databases</p> + <p>The <code>FMDatabasePool</code> object. <code>nil</code> on error.</p> </div> @@ -512,7 +471,7 @@ in the main.m file.</p></div> <div class="method-subsection discussion-section"> <h4 class="method-subtitle">Discussion</h4> - <p>Number of checked-out databases in pool</p> + <p>Create pool using path and specified flags</p> </div> @@ -530,8 +489,8 @@ in the main.m file.</p></div> </div> </div> </div><div class="section-method"> - <a name="//api/name/countOfOpenDatabases" title="countOfOpenDatabases"></a> - <h3 class="method-title"><code><a href="#//api/name/countOfOpenDatabases">– countOfOpenDatabases</a></code> + <a name="//api/name/initWithPath:" title="initWithPath:"></a> + <h3 class="method-title"><code><a href="#//api/name/initWithPath:">– initWithPath:</a></code> </h3> <div class="method-info"> @@ -541,20 +500,32 @@ in the main.m file.</p></div> <div class="method-subsection brief-description"> - <p>Total number of databases in pool</p> + <p>Create pool using path.</p> </div> - <div class="method-subsection method-declaration"><code>- (NSUInteger)countOfOpenDatabases</code></div> + <div class="method-subsection method-declaration"><code>- (instancetype)initWithPath:(NSString *)<em>aPath</em></code></div> + <div class="method-subsection arguments-section parameters"> + <h4 class="method-subtitle parameter-title">Parameters</h4> + <table class="argument-def parameter-def"> + + <tr> + <th scope="row" class="argument-name"><code>aPath</code></th> + <td><p>The file path of the database.</p></td> + </tr> + + </table> + </div> + <div class="method-subsection return"> <h4 class="method-subtitle parameter-title">Return Value</h4> - <p>Number of databases</p> + <p>The <code>FMDatabasePool</code> object. <code>nil</code> on error.</p> </div> @@ -563,7 +534,7 @@ in the main.m file.</p></div> <div class="method-subsection discussion-section"> <h4 class="method-subtitle">Discussion</h4> - <p>Total number of databases in pool</p> + <p>Create pool using path.</p> </div> @@ -581,8 +552,8 @@ in the main.m file.</p></div> </div> </div> </div><div class="section-method"> - <a name="//api/name/releaseAllDatabases" title="releaseAllDatabases"></a> - <h3 class="method-title"><code><a href="#//api/name/releaseAllDatabases">– releaseAllDatabases</a></code> + <a name="//api/name/initWithPath:flags:" title="initWithPath:flags:"></a> + <h3 class="method-title"><code><a href="#//api/name/initWithPath:flags:">– initWithPath:flags:</a></code> </h3> <div class="method-info"> @@ -592,24 +563,46 @@ in the main.m file.</p></div> <div class="method-subsection brief-description"> - <p>Release all databases in pool</p> + <p>Create pool using path and specified flags.</p> </div> - <div class="method-subsection method-declaration"><code>- (void)releaseAllDatabases</code></div> + <div class="method-subsection method-declaration"><code>- (instancetype)initWithPath:(NSString *)<em>aPath</em> flags:(int)<em>openFlags</em></code></div> + <div class="method-subsection arguments-section parameters"> + <h4 class="method-subtitle parameter-title">Parameters</h4> + <table class="argument-def parameter-def"> + + <tr> + <th scope="row" class="argument-name"><code>aPath</code></th> + <td><p>The file path of the database.</p></td> + </tr> + + <tr> + <th scope="row" class="argument-name"><code>openFlags</code></th> + <td><p>Flags passed to the openWithFlags method of the database</p></td> + </tr> + + </table> + </div> + + <div class="method-subsection return"> + <h4 class="method-subtitle parameter-title">Return Value</h4> + <p>The <code>FMDatabasePool</code> object. <code>nil</code> on error.</p> + </div> + <div class="method-subsection discussion-section"> <h4 class="method-subtitle">Discussion</h4> - <p>Release all databases in pool</p> + <p>Create pool using path and specified flags.</p> </div> @@ -626,9 +619,17 @@ in the main.m file.</p></div> </div> </div> -</div><div class="section-method"> - <a name="//api/name/inDatabase:" title="inDatabase:"></a> - <h3 class="method-title"><code><a href="#//api/name/inDatabase:">– inDatabase:</a></code> +</div> + </div> + + + <a title="Keeping track of checked in/out databases" name="task_Keeping track of checked in/out databases"></a> + <h2 class="task-title">Keeping track of checked in/out databases</h2> + + <div class="task-list"> + <div class="section-method"> + <a name="//api/name/countOfCheckedInDatabases" title="countOfCheckedInDatabases"></a> + <h3 class="method-title"><code><a href="#//api/name/countOfCheckedInDatabases">– countOfCheckedInDatabases</a></code> </h3> <div class="method-info"> @@ -638,36 +639,29 @@ in the main.m file.</p></div> <div class="method-subsection brief-description"> - <p>Synchronously perform database operations in pool.</p> + <p>Number of checked-in databases in pool</p> </div> - <div class="method-subsection method-declaration"><code>- (void)inDatabase:(void ( ^ ) ( FMDatabase *db ))<em>block</em></code></div> + <div class="method-subsection method-declaration"><code>- (NSUInteger)countOfCheckedInDatabases</code></div> - <div class="method-subsection arguments-section parameters"> - <h4 class="method-subtitle parameter-title">Parameters</h4> - <table class="argument-def parameter-def"> - - <tr> - <th scope="row" class="argument-name"><code>block</code></th> - <td><p>The code to be run on the <code>FMDatabasePool</code> pool.</p></td> - </tr> - - </table> - </div> - + <div class="method-subsection return"> + <h4 class="method-subtitle parameter-title">Return Value</h4> + <p>Number of databases</p> + </div> + <div class="method-subsection discussion-section"> <h4 class="method-subtitle">Discussion</h4> - <p>Synchronously perform database operations in pool.</p> + <p>Number of checked-in databases in pool</p> </div> @@ -685,8 +679,8 @@ in the main.m file.</p></div> </div> </div> </div><div class="section-method"> - <a name="//api/name/inDeferredTransaction:" title="inDeferredTransaction:"></a> - <h3 class="method-title"><code><a href="#//api/name/inDeferredTransaction:">– inDeferredTransaction:</a></code> + <a name="//api/name/countOfCheckedOutDatabases" title="countOfCheckedOutDatabases"></a> + <h3 class="method-title"><code><a href="#//api/name/countOfCheckedOutDatabases">– countOfCheckedOutDatabases</a></code> </h3> <div class="method-info"> @@ -696,36 +690,29 @@ in the main.m file.</p></div> <div class="method-subsection brief-description"> - <p>Synchronously perform database operations in pool using deferred transaction.</p> + <p>Number of checked-out databases in pool</p> </div> - <div class="method-subsection method-declaration"><code>- (void)inDeferredTransaction:(void ( ^ ) ( FMDatabase *db , BOOL *rollback ))<em>block</em></code></div> + <div class="method-subsection method-declaration"><code>- (NSUInteger)countOfCheckedOutDatabases</code></div> - <div class="method-subsection arguments-section parameters"> - <h4 class="method-subtitle parameter-title">Parameters</h4> - <table class="argument-def parameter-def"> - - <tr> - <th scope="row" class="argument-name"><code>block</code></th> - <td><p>The code to be run on the <code>FMDatabasePool</code> pool.</p></td> - </tr> - - </table> - </div> - + <div class="method-subsection return"> + <h4 class="method-subtitle parameter-title">Return Value</h4> + <p>Number of databases</p> + </div> + <div class="method-subsection discussion-section"> <h4 class="method-subtitle">Discussion</h4> - <p>Synchronously perform database operations in pool using deferred transaction.</p> + <p>Number of checked-out databases in pool</p> </div> @@ -743,8 +730,8 @@ in the main.m file.</p></div> </div> </div> </div><div class="section-method"> - <a name="//api/name/inTransaction:" title="inTransaction:"></a> - <h3 class="method-title"><code><a href="#//api/name/inTransaction:">– inTransaction:</a></code> + <a name="//api/name/countOfOpenDatabases" title="countOfOpenDatabases"></a> + <h3 class="method-title"><code><a href="#//api/name/countOfOpenDatabases">– countOfOpenDatabases</a></code> </h3> <div class="method-info"> @@ -754,36 +741,29 @@ in the main.m file.</p></div> <div class="method-subsection brief-description"> - <p>Synchronously perform database operations in pool using transaction.</p> + <p>Total number of databases in pool</p> </div> - <div class="method-subsection method-declaration"><code>- (void)inTransaction:(void ( ^ ) ( FMDatabase *db , BOOL *rollback ))<em>block</em></code></div> + <div class="method-subsection method-declaration"><code>- (NSUInteger)countOfOpenDatabases</code></div> - <div class="method-subsection arguments-section parameters"> - <h4 class="method-subtitle parameter-title">Parameters</h4> - <table class="argument-def parameter-def"> - - <tr> - <th scope="row" class="argument-name"><code>block</code></th> - <td><p>The code to be run on the <code>FMDatabasePool</code> pool.</p></td> - </tr> - - </table> - </div> - + <div class="method-subsection return"> + <h4 class="method-subtitle parameter-title">Return Value</h4> + <p>Number of databases</p> + </div> + <div class="method-subsection discussion-section"> <h4 class="method-subtitle">Discussion</h4> - <p>Synchronously perform database operations in pool using transaction.</p> + <p>Total number of databases in pool</p> </div> @@ -801,8 +781,8 @@ in the main.m file.</p></div> </div> </div> </div><div class="section-method"> - <a name="//api/name/inSavePoint:" title="inSavePoint:"></a> - <h3 class="method-title"><code><a href="#//api/name/inSavePoint:">– inSavePoint:</a></code> + <a name="//api/name/releaseAllDatabases" title="releaseAllDatabases"></a> + <h3 class="method-title"><code><a href="#//api/name/releaseAllDatabases">– releaseAllDatabases</a></code> </h3> <div class="method-info"> @@ -812,41 +792,24 @@ in the main.m file.</p></div> <div class="method-subsection brief-description"> - <p>Synchronously perform database operations in pool using save point.</p> + <p>Release all databases in pool</p> </div> - <div class="method-subsection method-declaration"><code>- (NSError *)inSavePoint:(void ( ^ ) ( FMDatabase *db , BOOL *rollback ))<em>block</em></code></div> + <div class="method-subsection method-declaration"><code>- (void)releaseAllDatabases</code></div> - <div class="method-subsection arguments-section parameters"> - <h4 class="method-subtitle parameter-title">Parameters</h4> - <table class="argument-def parameter-def"> - - <tr> - <th scope="row" class="argument-name"><code>block</code></th> - <td><p>The code to be run on the <code>FMDatabasePool</code> pool.</p></td> - </tr> - - </table> - </div> - - <div class="method-subsection return"> - <h4 class="method-subtitle parameter-title">Return Value</h4> - <p><code>NSError</code> object if error; <code>nil</code> if successful.</p> - </div> - <div class="method-subsection discussion-section"> <h4 class="method-subtitle">Discussion</h4> - <p>Synchronously perform database operations in pool using save point.</p><div class="warning"><p><strong>Warning:</strong> You can not nest these, since calling it will pull another database out of the pool and you’ll get a deadlock. If you need to nest, use <a href="../Classes/FMDatabase.html#//api/name/startSavePointWithName:error:"><code>[FMDatabase startSavePointWithName:error:]</code></a> instead.</p></div> + <p>Release all databases in pool</p> </div> @@ -867,13 +830,13 @@ in the main.m file.</p></div> </div> - - <h2 class="task-title">Other Methods</h2> + <a title="Perform database operations in pool" name="task_Perform database operations in pool"></a> + <h2 class="task-title">Perform database operations in pool</h2> <div class="task-list"> <div class="section-method"> - <a name="//api/name/path" title="path"></a> - <h3 class="method-title"><code><a href="#//api/name/path"> path</a></code> + <a name="//api/name/inDatabase:" title="inDatabase:"></a> + <h3 class="method-title"><code><a href="#//api/name/inDatabase:">– inDatabase:</a></code> </h3> <div class="method-info"> @@ -883,15 +846,27 @@ in the main.m file.</p></div> <div class="method-subsection brief-description"> - <p>Database path</p> + <p>Synchronously perform database operations in pool.</p> </div> - <div class="method-subsection method-declaration"><code>@property (atomic, retain) NSString *path</code></div> + <div class="method-subsection method-declaration"><code>- (void)inDatabase:(void ( ^ ) ( FMDatabase *db ))<em>block</em></code></div> + <div class="method-subsection arguments-section parameters"> + <h4 class="method-subtitle parameter-title">Parameters</h4> + <table class="argument-def parameter-def"> + + <tr> + <th scope="row" class="argument-name"><code>block</code></th> + <td><p>The code to be run on the <code>FMDatabasePool</code> pool.</p></td> + </tr> + + </table> + </div> + @@ -900,7 +875,7 @@ in the main.m file.</p></div> <div class="method-subsection discussion-section"> <h4 class="method-subtitle">Discussion</h4> - <p>Database path</p> + <p>Synchronously perform database operations in pool.</p> </div> @@ -918,8 +893,8 @@ in the main.m file.</p></div> </div> </div> </div><div class="section-method"> - <a name="//api/name/delegate" title="delegate"></a> - <h3 class="method-title"><code><a href="#//api/name/delegate"> delegate</a></code> + <a name="//api/name/inTransaction:" title="inTransaction:"></a> + <h3 class="method-title"><code><a href="#//api/name/inTransaction:">– inTransaction:</a></code> </h3> <div class="method-info"> @@ -929,15 +904,27 @@ in the main.m file.</p></div> <div class="method-subsection brief-description"> - <p>Delegate object</p> + <p>Synchronously perform database operations in pool using transaction.</p> </div> - <div class="method-subsection method-declaration"><code>@property (atomic, assign) id delegate</code></div> + <div class="method-subsection method-declaration"><code>- (void)inTransaction:(void ( ^ ) ( FMDatabase *db , BOOL *rollback ))<em>block</em></code></div> + <div class="method-subsection arguments-section parameters"> + <h4 class="method-subtitle parameter-title">Parameters</h4> + <table class="argument-def parameter-def"> + + <tr> + <th scope="row" class="argument-name"><code>block</code></th> + <td><p>The code to be run on the <code>FMDatabasePool</code> pool.</p></td> + </tr> + + </table> + </div> + @@ -946,7 +933,7 @@ in the main.m file.</p></div> <div class="method-subsection discussion-section"> <h4 class="method-subtitle">Discussion</h4> - <p>Delegate object</p> + <p>Synchronously perform database operations in pool using transaction.</p> </div> @@ -964,8 +951,8 @@ in the main.m file.</p></div> </div> </div> </div><div class="section-method"> - <a name="//api/name/maximumNumberOfDatabasesToCreate" title="maximumNumberOfDatabasesToCreate"></a> - <h3 class="method-title"><code><a href="#//api/name/maximumNumberOfDatabasesToCreate"> maximumNumberOfDatabasesToCreate</a></code> + <a name="//api/name/inDeferredTransaction:" title="inDeferredTransaction:"></a> + <h3 class="method-title"><code><a href="#//api/name/inDeferredTransaction:">– inDeferredTransaction:</a></code> </h3> <div class="method-info"> @@ -975,15 +962,27 @@ in the main.m file.</p></div> <div class="method-subsection brief-description"> - <p>Maximum number of databases to create</p> + <p>Synchronously perform database operations in pool using deferred transaction.</p> </div> - <div class="method-subsection method-declaration"><code>@property (atomic, assign) NSUInteger maximumNumberOfDatabasesToCreate</code></div> + <div class="method-subsection method-declaration"><code>- (void)inDeferredTransaction:(void ( ^ ) ( FMDatabase *db , BOOL *rollback ))<em>block</em></code></div> + <div class="method-subsection arguments-section parameters"> + <h4 class="method-subtitle parameter-title">Parameters</h4> + <table class="argument-def parameter-def"> + + <tr> + <th scope="row" class="argument-name"><code>block</code></th> + <td><p>The code to be run on the <code>FMDatabasePool</code> pool.</p></td> + </tr> + + </table> + </div> + @@ -992,7 +991,7 @@ in the main.m file.</p></div> <div class="method-subsection discussion-section"> <h4 class="method-subtitle">Discussion</h4> - <p>Maximum number of databases to create</p> + <p>Synchronously perform database operations in pool using deferred transaction.</p> </div> @@ -1010,8 +1009,8 @@ in the main.m file.</p></div> </div> </div> </div><div class="section-method"> - <a name="//api/name/openFlags" title="openFlags"></a> - <h3 class="method-title"><code><a href="#//api/name/openFlags"> openFlags</a></code> + <a name="//api/name/inSavePoint:" title="inSavePoint:"></a> + <h3 class="method-title"><code><a href="#//api/name/inSavePoint:">– inSavePoint:</a></code> </h3> <div class="method-info"> @@ -1021,24 +1020,41 @@ in the main.m file.</p></div> <div class="method-subsection brief-description"> - <p>Open flags</p> + <p>Synchronously perform database operations in pool using save point.</p> </div> - <div class="method-subsection method-declaration"><code>@property (atomic, readonly) int openFlags</code></div> + <div class="method-subsection method-declaration"><code>- (NSError *)inSavePoint:(void ( ^ ) ( FMDatabase *db , BOOL *rollback ))<em>block</em></code></div> + <div class="method-subsection arguments-section parameters"> + <h4 class="method-subtitle parameter-title">Parameters</h4> + <table class="argument-def parameter-def"> + + <tr> + <th scope="row" class="argument-name"><code>block</code></th> + <td><p>The code to be run on the <code>FMDatabasePool</code> pool.</p></td> + </tr> + + </table> + </div> + + <div class="method-subsection return"> + <h4 class="method-subtitle parameter-title">Return Value</h4> + <p><code>NSError</code> object if error; <code>nil</code> if successful.</p> + </div> + <div class="method-subsection discussion-section"> <h4 class="method-subtitle">Discussion</h4> - <p>Open flags</p> + <p>Synchronously perform database operations in pool using save point.</p><div class="warning"><p><strong>Warning:</strong> You can not nest these, since calling it will pull another database out of the pool and you’ll get a deadlock. If you need to nest, use <a href="../Classes/FMDatabase.html#//api/name/startSavePointWithName:error:"><code>[FMDatabase startSavePointWithName:error:]</code></a> instead.</p></div> </div> @@ -1068,10 +1084,10 @@ in the main.m file.</p></div> <footer> <div class="footer-copyright"> - <p class="copyright">Copyright © 2015 ccgus. All rights reserved. Updated: 2015-01-25</p> + <p class="copyright">Copyright © 2015 ccgus. All rights reserved. Updated: 2015-10-29</p> - <p class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.2.1 (build 1333)</a>.</p> + <p class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.2.1 (build 1334)</a>.</p> </div> </footer> diff --git a/html/Classes/FMDatabaseQueue.html b/html/Classes/FMDatabaseQueue.html index f6953c7..bd6af43 100644 --- a/html/Classes/FMDatabaseQueue.html +++ b/html/Classes/FMDatabaseQueue.html @@ -7,7 +7,7 @@ <link rel="stylesheet" href="../css/style.css"> <meta name="viewport" content="initial-scale=1, maximum-scale=1.4"> - <meta name="generator" content="appledoc 2.2.1 (build 1333)"> + <meta name="generator" content="appledoc 2.2.1 (build 1334)"> </head> <body class="appledoc"> <header> @@ -92,6 +92,8 @@ <option value="//api/name/initWithPath:flags:">- initWithPath:flags:</option> + <option value="//api/name/initWithPath:flags:vfs:">- initWithPath:flags:vfs:</option> + </optgroup> @@ -116,7 +118,7 @@ <td>NSObject</td> </tr><tr> <th>Declared in</th> - <td>FMDatabaseQueue.h<br />FMDatabaseQueue.m</td> + <td>FMDatabaseQueue.h</td> </tr> </tbody></table></div> @@ -190,6 +192,106 @@ <div class="task-list"> <div class="section-method"> + <a name="//api/name/path" title="path"></a> + <h3 class="method-title"><code><a href="#//api/name/path"> path</a></code> +</h3> + + <div class="method-info"> + <div class="pointy-thing"></div> + + <div class="method-info-container"> + + + <div class="method-subsection brief-description"> + <p>Path of database</p> + </div> + + + + <div class="method-subsection method-declaration"><code>@property (atomic, retain) NSString *path</code></div> + + + + + + + + + + <div class="method-subsection discussion-section"> + <h4 class="method-subtitle">Discussion</h4> + <p>Path of database</p> + </div> + + + + + + + + <div class="method-subsection declared-in-section"> + <h4 class="method-subtitle">Declared In</h4> + <p><code class="declared-in-ref">FMDatabaseQueue.h</code></p> + </div> + + + </div> + </div> +</div><div class="section-method"> + <a name="//api/name/openFlags" title="openFlags"></a> + <h3 class="method-title"><code><a href="#//api/name/openFlags"> openFlags</a></code> +</h3> + + <div class="method-info"> + <div class="pointy-thing"></div> + + <div class="method-info-container"> + + + <div class="method-subsection brief-description"> + <p>Open flags</p> + </div> + + + + <div class="method-subsection method-declaration"><code>@property (atomic, readonly) int openFlags</code></div> + + + + + + + + + + <div class="method-subsection discussion-section"> + <h4 class="method-subtitle">Discussion</h4> + <p>Open flags</p> + </div> + + + + + + + + <div class="method-subsection declared-in-section"> + <h4 class="method-subtitle">Declared In</h4> + <p><code class="declared-in-ref">FMDatabaseQueue.h</code></p> + </div> + + + </div> + </div> +</div> + </div> + + + <a title="Initialization, opening, and closing of queue" name="task_Initialization, opening, and closing of queue"></a> + <h2 class="task-title">Initialization, opening, and closing of queue</h2> + + <div class="task-list"> + <div class="section-method"> <a name="//api/name/databaseQueueWithPath:" title="databaseQueueWithPath:"></a> <h3 class="method-title"><code><a href="#//api/name/databaseQueueWithPath:">+ databaseQueueWithPath:</a></code> </h3> @@ -321,8 +423,8 @@ </div> </div> </div><div class="section-method"> - <a name="//api/name/databaseClass" title="databaseClass"></a> - <h3 class="method-title"><code><a href="#//api/name/databaseClass">+ databaseClass</a></code> + <a name="//api/name/initWithPath:" title="initWithPath:"></a> + <h3 class="method-title"><code><a href="#//api/name/initWithPath:">– initWithPath:</a></code> </h3> <div class="method-info"> @@ -332,20 +434,32 @@ <div class="method-subsection brief-description"> - <p>Returns the Class of ‘FMDatabase’ subclass, that will be used to instantiate database object.</p> + <p>Create queue using path.</p> </div> - <div class="method-subsection method-declaration"><code>+ (Class)databaseClass</code></div> + <div class="method-subsection method-declaration"><code>- (instancetype)initWithPath:(NSString *)<em>aPath</em></code></div> + <div class="method-subsection arguments-section parameters"> + <h4 class="method-subtitle parameter-title">Parameters</h4> + <table class="argument-def parameter-def"> + + <tr> + <th scope="row" class="argument-name"><code>aPath</code></th> + <td><p>The file path of the database.</p></td> + </tr> + + </table> + </div> + <div class="method-subsection return"> <h4 class="method-subtitle parameter-title">Return Value</h4> - <p>The Class of ‘FMDatabase’ subclass, that will be used to instantiate database object.</p> + <p>The <code>FMDatabaseQueue</code> object. <code>nil</code> on error.</p> </div> @@ -354,9 +468,7 @@ <div class="method-subsection discussion-section"> <h4 class="method-subtitle">Discussion</h4> - <p>Returns the Class of ‘FMDatabase’ subclass, that will be used to instantiate database object.</p> - -<p>Subclasses can override this method to return specified Class of ‘FMDatabase’ subclass.</p> + <p>Create queue using path.</p> </div> @@ -442,8 +554,8 @@ </div> </div> </div><div class="section-method"> - <a name="//api/name/initWithPath:" title="initWithPath:"></a> - <h3 class="method-title"><code><a href="#//api/name/initWithPath:">– initWithPath:</a></code> + <a name="//api/name/initWithPath:flags:vfs:" title="initWithPath:flags:vfs:"></a> + <h3 class="method-title"><code><a href="#//api/name/initWithPath:flags:vfs:">– initWithPath:flags:vfs:</a></code> </h3> <div class="method-info"> @@ -453,12 +565,12 @@ <div class="method-subsection brief-description"> - <p>Create queue using path.</p> + <p>Create queue using path and specified flags.</p> </div> - <div class="method-subsection method-declaration"><code>- (instancetype)initWithPath:(NSString *)<em>aPath</em></code></div> + <div class="method-subsection method-declaration"><code>- (instancetype)initWithPath:(NSString *)<em>aPath</em> flags:(int)<em>openFlags</em> vfs:(NSString *)<em>vfsName</em></code></div> @@ -471,6 +583,16 @@ <td><p>The file path of the database.</p></td> </tr> + <tr> + <th scope="row" class="argument-name"><code>openFlags</code></th> + <td><p>Flags passed to the openWithFlags method of the database</p></td> + </tr> + + <tr> + <th scope="row" class="argument-name"><code>vfsName</code></th> + <td><p>The name of a custom virtual file system</p></td> + </tr> + </table> </div> @@ -487,7 +609,7 @@ <div class="method-subsection discussion-section"> <h4 class="method-subtitle">Discussion</h4> - <p>Create queue using path.</p> + <p>Create queue using path and specified flags.</p> </div> @@ -505,8 +627,8 @@ </div> </div> </div><div class="section-method"> - <a name="//api/name/close" title="close"></a> - <h3 class="method-title"><code><a href="#//api/name/close">– close</a></code> + <a name="//api/name/databaseClass" title="databaseClass"></a> + <h3 class="method-title"><code><a href="#//api/name/databaseClass">+ databaseClass</a></code> </h3> <div class="method-info"> @@ -516,24 +638,31 @@ <div class="method-subsection brief-description"> - <p>Close database used by queue.</p> + <p>Returns the Class of ‘FMDatabase’ subclass, that will be used to instantiate database object.</p> </div> - <div class="method-subsection method-declaration"><code>- (void)close</code></div> + <div class="method-subsection method-declaration"><code>+ (Class)databaseClass</code></div> + <div class="method-subsection return"> + <h4 class="method-subtitle parameter-title">Return Value</h4> + <p>The Class of ‘FMDatabase’ subclass, that will be used to instantiate database object.</p> + </div> + <div class="method-subsection discussion-section"> <h4 class="method-subtitle">Discussion</h4> - <p>Close database used by queue.</p> + <p>Returns the Class of ‘FMDatabase’ subclass, that will be used to instantiate database object.</p> + +<p>Subclasses can override this method to return specified Class of ‘FMDatabase’ subclass.</p> </div> @@ -551,8 +680,8 @@ </div> </div> </div><div class="section-method"> - <a name="//api/name/inDatabase:" title="inDatabase:"></a> - <h3 class="method-title"><code><a href="#//api/name/inDatabase:">– inDatabase:</a></code> + <a name="//api/name/close" title="close"></a> + <h3 class="method-title"><code><a href="#//api/name/close">– close</a></code> </h3> <div class="method-info"> @@ -562,27 +691,15 @@ <div class="method-subsection brief-description"> - <p>Synchronously perform database operations on queue.</p> + <p>Close database used by queue.</p> </div> - <div class="method-subsection method-declaration"><code>- (void)inDatabase:(void ( ^ ) ( FMDatabase *db ))<em>block</em></code></div> + <div class="method-subsection method-declaration"><code>- (void)close</code></div> - <div class="method-subsection arguments-section parameters"> - <h4 class="method-subtitle parameter-title">Parameters</h4> - <table class="argument-def parameter-def"> - - <tr> - <th scope="row" class="argument-name"><code>block</code></th> - <td><p>The code to be run on the queue of <code>FMDatabaseQueue</code></p></td> - </tr> - - </table> - </div> - @@ -591,7 +708,7 @@ <div class="method-subsection discussion-section"> <h4 class="method-subtitle">Discussion</h4> - <p>Synchronously perform database operations on queue.</p> + <p>Close database used by queue.</p> </div> @@ -608,9 +725,17 @@ </div> </div> -</div><div class="section-method"> - <a name="//api/name/inDeferredTransaction:" title="inDeferredTransaction:"></a> - <h3 class="method-title"><code><a href="#//api/name/inDeferredTransaction:">– inDeferredTransaction:</a></code> +</div> + </div> + + + <a title="Dispatching database operations to queue" name="task_Dispatching database operations to queue"></a> + <h2 class="task-title">Dispatching database operations to queue</h2> + + <div class="task-list"> + <div class="section-method"> + <a name="//api/name/inDatabase:" title="inDatabase:"></a> + <h3 class="method-title"><code><a href="#//api/name/inDatabase:">– inDatabase:</a></code> </h3> <div class="method-info"> @@ -620,12 +745,12 @@ <div class="method-subsection brief-description"> - <p>Synchronously perform database operations on queue, using deferred transactions.</p> + <p>Synchronously perform database operations on queue.</p> </div> - <div class="method-subsection method-declaration"><code>- (void)inDeferredTransaction:(void ( ^ ) ( FMDatabase *db , BOOL *rollback ))<em>block</em></code></div> + <div class="method-subsection method-declaration"><code>- (void)inDatabase:(void ( ^ ) ( FMDatabase *db ))<em>block</em></code></div> @@ -649,7 +774,7 @@ <div class="method-subsection discussion-section"> <h4 class="method-subtitle">Discussion</h4> - <p>Synchronously perform database operations on queue, using deferred transactions.</p> + <p>Synchronously perform database operations on queue.</p> </div> @@ -725,8 +850,8 @@ </div> </div> </div><div class="section-method"> - <a name="//api/name/inSavePoint:" title="inSavePoint:"></a> - <h3 class="method-title"><code><a href="#//api/name/inSavePoint:">– inSavePoint:</a></code> + <a name="//api/name/inDeferredTransaction:" title="inDeferredTransaction:"></a> + <h3 class="method-title"><code><a href="#//api/name/inDeferredTransaction:">– inDeferredTransaction:</a></code> </h3> <div class="method-info"> @@ -736,12 +861,12 @@ <div class="method-subsection brief-description"> - <p>Synchronously perform database operations using save point.</p> + <p>Synchronously perform database operations on queue, using deferred transactions.</p> </div> - <div class="method-subsection method-declaration"><code>- (NSError *)inSavePoint:(void ( ^ ) ( FMDatabase *db , BOOL *rollback ))<em>block</em></code></div> + <div class="method-subsection method-declaration"><code>- (void)inDeferredTransaction:(void ( ^ ) ( FMDatabase *db , BOOL *rollback ))<em>block</em></code></div> @@ -765,7 +890,7 @@ <div class="method-subsection discussion-section"> <h4 class="method-subtitle">Discussion</h4> - <p>Synchronously perform database operations using save point.</p> + <p>Synchronously perform database operations on queue, using deferred transactions.</p> </div> @@ -782,17 +907,9 @@ </div> </div> -</div> - </div> - - - - <h2 class="task-title">Other Methods</h2> - - <div class="task-list"> - <div class="section-method"> - <a name="//api/name/path" title="path"></a> - <h3 class="method-title"><code><a href="#//api/name/path"> path</a></code> +</div><div class="section-method"> + <a name="//api/name/inSavePoint:" title="inSavePoint:"></a> + <h3 class="method-title"><code><a href="#//api/name/inSavePoint:">– inSavePoint:</a></code> </h3> <div class="method-info"> @@ -802,61 +919,27 @@ <div class="method-subsection brief-description"> - <p>Path of database</p> + <p>Synchronously perform database operations using save point.</p> </div> - <div class="method-subsection method-declaration"><code>@property (atomic, retain) NSString *path</code></div> + <div class="method-subsection method-declaration"><code>- (NSError *)inSavePoint:(void ( ^ ) ( FMDatabase *db , BOOL *rollback ))<em>block</em></code></div> - - - - - - - <div class="method-subsection discussion-section"> - <h4 class="method-subtitle">Discussion</h4> - <p>Path of database</p> - </div> - - - - - - - - <div class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <p><code class="declared-in-ref">FMDatabaseQueue.h</code></p> - </div> - - - </div> - </div> -</div><div class="section-method"> - <a name="//api/name/openFlags" title="openFlags"></a> - <h3 class="method-title"><code><a href="#//api/name/openFlags"> openFlags</a></code> -</h3> - - <div class="method-info"> - <div class="pointy-thing"></div> - - <div class="method-info-container"> - - - <div class="method-subsection brief-description"> - <p>Open flags</p> + <div class="method-subsection arguments-section parameters"> + <h4 class="method-subtitle parameter-title">Parameters</h4> + <table class="argument-def parameter-def"> + + <tr> + <th scope="row" class="argument-name"><code>block</code></th> + <td><p>The code to be run on the queue of <code>FMDatabaseQueue</code></p></td> + </tr> + + </table> </div> - - - <div class="method-subsection method-declaration"><code>@property (atomic, readonly) int openFlags</code></div> - - - @@ -865,7 +948,7 @@ <div class="method-subsection discussion-section"> <h4 class="method-subtitle">Discussion</h4> - <p>Open flags</p> + <p>Synchronously perform database operations using save point.</p> </div> @@ -895,10 +978,10 @@ <footer> <div class="footer-copyright"> - <p class="copyright">Copyright © 2015 ccgus. All rights reserved. Updated: 2015-01-25</p> + <p class="copyright">Copyright © 2015 ccgus. All rights reserved. Updated: 2015-10-29</p> - <p class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.2.1 (build 1333)</a>.</p> + <p class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.2.1 (build 1334)</a>.</p> </div> </footer> diff --git a/html/Classes/FMResultSet.html b/html/Classes/FMResultSet.html index ebdfd2a..db51df8 100644 --- a/html/Classes/FMResultSet.html +++ b/html/Classes/FMResultSet.html @@ -7,7 +7,7 @@ <link rel="stylesheet" href="../css/style.css"> <meta name="viewport" content="initial-scale=1, maximum-scale=1.4"> - <meta name="generator" content="appledoc 2.2.1 (build 1333)"> + <meta name="generator" content="appledoc 2.2.1 (build 1334)"> </head> <body class="appledoc"> <header> @@ -56,6 +56,8 @@ <optgroup label="Properties"> + <option value="//api/name/columnNameToIndexMap">columnNameToIndexMap</option> + <option value="//api/name/query">query</option> <option value="//api/name/statement">statement</option> @@ -94,8 +96,6 @@ <option value="//api/name/columnNameForIndex:">- columnNameForIndex:</option> - <option value="//api/name/columnNameToIndexMap">- columnNameToIndexMap</option> - <option value="//api/name/dataForColumn:">- dataForColumn:</option> <option value="//api/name/dataForColumnIndex:">- dataForColumnIndex:</option> @@ -176,7 +176,7 @@ <td>NSObject</td> </tr><tr> <th>Declared in</th> - <td>FMResultSet.h<br />FMResultSet.m</td> + <td>FMResultSet.h</td> </tr> </tbody></table></div> @@ -204,13 +204,13 @@ <a title="Tasks" name="tasks"></a> - - <h2 class="task-title">Other Methods</h2> + <a title="Properties" name="task_Properties"></a> + <h2 class="task-title">Properties</h2> <div class="task-list"> <div class="section-method"> - <a name="//api/name/resultSetWithStatement:usingParentDatabase:" title="resultSetWithStatement:usingParentDatabase:"></a> - <h3 class="method-title"><code><a href="#//api/name/resultSetWithStatement:usingParentDatabase:">+ resultSetWithStatement:usingParentDatabase:</a></code> + <a name="//api/name/query" title="query"></a> + <h3 class="method-title"><code><a href="#//api/name/query"> query</a></code> </h3> <div class="method-info"> @@ -220,46 +220,24 @@ <div class="method-subsection brief-description"> - <p>Create result set from <a href="../Classes/FMStatement.html"><code>FMStatement</code></a></p> + <p>Executed query</p> </div> - <div class="method-subsection method-declaration"><code>+ (instancetype)resultSetWithStatement:(FMStatement *)<em>statement</em> usingParentDatabase:(FMDatabase *)<em>aDB</em></code></div> + <div class="method-subsection method-declaration"><code>@property (atomic, retain) NSString *query</code></div> - <div class="method-subsection arguments-section parameters"> - <h4 class="method-subtitle parameter-title">Parameters</h4> - <table class="argument-def parameter-def"> - - <tr> - <th scope="row" class="argument-name"><code>statement</code></th> - <td><p>A <a href="../Classes/FMStatement.html"><code>FMStatement</code></a> to be performed</p></td> - </tr> - - <tr> - <th scope="row" class="argument-name"><code>aDB</code></th> - <td><p>A <a href="../Classes/FMDatabase.html"><code>FMDatabase</code></a> to be used</p></td> - </tr> - - </table> - </div> - - <div class="method-subsection return"> - <h4 class="method-subtitle parameter-title">Return Value</h4> - <p>A <code>FMResultSet</code> on success; <code>nil</code> on failure</p> - </div> - <div class="method-subsection discussion-section"> <h4 class="method-subtitle">Discussion</h4> - <p>Create result set from <a href="../Classes/FMStatement.html"><code>FMStatement</code></a></p> + <p>Executed query</p> </div> @@ -277,8 +255,8 @@ </div> </div> </div><div class="section-method"> - <a name="//api/name/close" title="close"></a> - <h3 class="method-title"><code><a href="#//api/name/close">– close</a></code> + <a name="//api/name/columnNameToIndexMap" title="columnNameToIndexMap"></a> + <h3 class="method-title"><code><a href="#//api/name/columnNameToIndexMap"> columnNameToIndexMap</a></code> </h3> <div class="method-info"> @@ -288,12 +266,12 @@ <div class="method-subsection brief-description"> - <p>Close result set</p> + <p><code>NSMutableDictionary</code> mapping column names to numeric index</p> </div> - <div class="method-subsection method-declaration"><code>- (void)close</code></div> + <div class="method-subsection method-declaration"><code>@property (readonly) NSMutableDictionary *columnNameToIndexMap</code></div> @@ -305,7 +283,7 @@ <div class="method-subsection discussion-section"> <h4 class="method-subtitle">Discussion</h4> - <p>Close result set</p> + <p><code>NSMutableDictionary</code> mapping column names to numeric index</p> </div> @@ -323,8 +301,8 @@ </div> </div> </div><div class="section-method"> - <a name="//api/name/columnCount" title="columnCount"></a> - <h3 class="method-title"><code><a href="#//api/name/columnCount">– columnCount</a></code> + <a name="//api/name/statement" title="statement"></a> + <h3 class="method-title"><code><a href="#//api/name/statement"> statement</a></code> </h3> <div class="method-info"> @@ -334,29 +312,24 @@ <div class="method-subsection brief-description"> - <p>How many columns in result set</p> + <p><code>FMStatement</code> used by result set.</p> </div> - <div class="method-subsection method-declaration"><code>- (int)columnCount</code></div> + <div class="method-subsection method-declaration"><code>@property (atomic, retain) FMStatement *statement</code></div> - <div class="method-subsection return"> - <h4 class="method-subtitle parameter-title">Return Value</h4> - <p>Integer value of the number of columns.</p> - </div> - <div class="method-subsection discussion-section"> <h4 class="method-subtitle">Discussion</h4> - <p>How many columns in result set</p> + <p><code>FMStatement</code> used by result set.</p> </div> @@ -373,9 +346,17 @@ </div> </div> -</div><div class="section-method"> - <a name="//api/name/columnNameToIndexMap" title="columnNameToIndexMap"></a> - <h3 class="method-title"><code><a href="#//api/name/columnNameToIndexMap">– columnNameToIndexMap</a></code> +</div> + </div> + + + <a title="Creating and closing database" name="task_Creating and closing database"></a> + <h2 class="task-title">Creating and closing database</h2> + + <div class="task-list"> + <div class="section-method"> + <a name="//api/name/resultSetWithStatement:usingParentDatabase:" title="resultSetWithStatement:usingParentDatabase:"></a> + <h3 class="method-title"><code><a href="#//api/name/resultSetWithStatement:usingParentDatabase:">+ resultSetWithStatement:usingParentDatabase:</a></code> </h3> <div class="method-info"> @@ -385,24 +366,46 @@ <div class="method-subsection brief-description"> - <p><code>NSMutableDictionary</code> mapping column names to numeric index</p> + <p>Create result set from <a href="../Classes/FMStatement.html"><code>FMStatement</code></a></p> </div> - <div class="method-subsection method-declaration"><code>- (NSMutableDictionary *)columnNameToIndexMap</code></div> + <div class="method-subsection method-declaration"><code>+ (instancetype)resultSetWithStatement:(FMStatement *)<em>statement</em> usingParentDatabase:(FMDatabase *)<em>aDB</em></code></div> + <div class="method-subsection arguments-section parameters"> + <h4 class="method-subtitle parameter-title">Parameters</h4> + <table class="argument-def parameter-def"> + + <tr> + <th scope="row" class="argument-name"><code>statement</code></th> + <td><p>A <a href="../Classes/FMStatement.html"><code>FMStatement</code></a> to be performed</p></td> + </tr> + + <tr> + <th scope="row" class="argument-name"><code>aDB</code></th> + <td><p>A <a href="../Classes/FMDatabase.html"><code>FMDatabase</code></a> to be used</p></td> + </tr> + + </table> + </div> + + <div class="method-subsection return"> + <h4 class="method-subtitle parameter-title">Return Value</h4> + <p>A <code>FMResultSet</code> on success; <code>nil</code> on failure</p> + </div> + <div class="method-subsection discussion-section"> <h4 class="method-subtitle">Discussion</h4> - <p><code>NSMutableDictionary</code> mapping column names to numeric index</p> + <p>Create result set from <a href="../Classes/FMStatement.html"><code>FMStatement</code></a></p> </div> @@ -420,8 +423,8 @@ </div> </div> </div><div class="section-method"> - <a name="//api/name/kvcMagic:" title="kvcMagic:"></a> - <h3 class="method-title"><code><a href="#//api/name/kvcMagic:">– kvcMagic:</a></code> + <a name="//api/name/close" title="close"></a> + <h3 class="method-title"><code><a href="#//api/name/close">– close</a></code> </h3> <div class="method-info"> @@ -431,27 +434,15 @@ <div class="method-subsection brief-description"> - <p>Performs <code>setValue</code> to yield support for key value observing.</p> + <p>Close result set</p> </div> - <div class="method-subsection method-declaration"><code>- (void)kvcMagic:(id)<em>object</em></code></div> + <div class="method-subsection method-declaration"><code>- (void)close</code></div> - <div class="method-subsection arguments-section parameters"> - <h4 class="method-subtitle parameter-title">Parameters</h4> - <table class="argument-def parameter-def"> - - <tr> - <th scope="row" class="argument-name"><code>object</code></th> - <td><p>The object for which the values will be set. This is the key-value-coding compliant object that you might, for example, observe.</p></td> - </tr> - - </table> - </div> - @@ -460,7 +451,7 @@ <div class="method-subsection discussion-section"> <h4 class="method-subtitle">Discussion</h4> - <p>Performs <code>setValue</code> to yield support for key value observing.</p> + <p>Close result set</p> </div> @@ -477,9 +468,17 @@ </div> </div> -</div><div class="section-method"> - <a name="//api/name/resultDict" title="resultDict"></a> - <h3 class="method-title"><code><a href="#//api/name/resultDict">– resultDict</a></code> +</div> + </div> + + + <a title="Iterating through the result set" name="task_Iterating through the result set"></a> + <h2 class="task-title">Iterating through the result set</h2> + + <div class="task-list"> + <div class="section-method"> + <a name="//api/name/next" title="next"></a> + <h3 class="method-title"><code><a href="#//api/name/next">– next</a></code> </h3> <div class="method-info"> @@ -489,24 +488,31 @@ <div class="method-subsection brief-description"> - <p>Returns a dictionary of the row results</p> + <p>Retrieve next row for result set.</p> </div> - <div class="method-subsection method-declaration"><code>- (NSDictionary *)resultDict</code></div> + <div class="method-subsection method-declaration"><code>- (BOOL)next</code></div> + <div class="method-subsection return"> + <h4 class="method-subtitle parameter-title">Return Value</h4> + <p><code>YES</code> if row successfully retrieved; <code>NO</code> if end of result set reached</p> + </div> + <div class="method-subsection discussion-section"> <h4 class="method-subtitle">Discussion</h4> - <p>Returns a dictionary of the row results</p><div class="warning"><p><strong>Warning:</strong> <strong>Deprecated</strong>: Please use <a href="#//api/name/resultDictionary"><code>resultDictionary</code></a> instead. Also, beware that <a href="#//api/name/resultDictionary"><code>resultDictionary</code></a> is case sensitive!</p></div> + <p>Retrieve next row for result set.</p> + +<p>You must always invoke <code>next</code> or <code>nextWithError</code> before attempting to access the values returned in a query, even if you’re only expecting one.</p> </div> @@ -517,7 +523,7 @@ <h4 class="method-subtitle">See Also</h4> <ul> - <li><code><p><a href="#//api/name/resultDictionary">- resultDictionary</a></p></code></li> + <li><code><p><a href="#//api/name/hasAnotherRow">- hasAnotherRow</a></p></code></li> </ul> </div> @@ -533,8 +539,8 @@ </div> </div> </div><div class="section-method"> - <a name="//api/name/resultDictionary" title="resultDictionary"></a> - <h3 class="method-title"><code><a href="#//api/name/resultDictionary">– resultDictionary</a></code> + <a name="//api/name/nextWithError:" title="nextWithError:"></a> + <h3 class="method-title"><code><a href="#//api/name/nextWithError:">– nextWithError:</a></code> </h3> <div class="method-info"> @@ -544,20 +550,32 @@ <div class="method-subsection brief-description"> - <p>Returns a dictionary of the row results mapped to case sensitive keys of the column names.</p> + <p>Retrieve next row for result set.</p> </div> - <div class="method-subsection method-declaration"><code>- (NSDictionary *)resultDictionary</code></div> + <div class="method-subsection method-declaration"><code>- (BOOL)nextWithError:(NSError **)<em>outErr</em></code></div> + <div class="method-subsection arguments-section parameters"> + <h4 class="method-subtitle parameter-title">Parameters</h4> + <table class="argument-def parameter-def"> + + <tr> + <th scope="row" class="argument-name"><code>outErr</code></th> + <td><p>A ‘NSError’ object to receive any error object (if any).</p></td> + </tr> + + </table> + </div> + <div class="method-subsection return"> <h4 class="method-subtitle parameter-title">Return Value</h4> - <p><code>NSDictionary</code> of the row results.</p> + <p>‘YES’ if row successfully retrieved; ‘NO’ if end of result set reached</p> </div> @@ -566,13 +584,24 @@ <div class="method-subsection discussion-section"> <h4 class="method-subtitle">Discussion</h4> - <p>Returns a dictionary of the row results mapped to case sensitive keys of the column names.</p><div class="warning"><p><strong>Warning:</strong> The keys to the dictionary are case sensitive of the column names.</p></div> + <p>Retrieve next row for result set.</p> + +<p> You must always invoke <code>next</code> or <code>nextWithError</code> before attempting to access the values returned in a query, even if you’re only expecting one.</p> </div> + <div class="method-subsection see-also-section"> + <h4 class="method-subtitle">See Also</h4> + <ul> + + <li><code><p><a href="#//api/name/hasAnotherRow">- hasAnotherRow</a></p></code></li> + + </ul> + </div> + <div class="method-subsection declared-in-section"> @@ -584,8 +613,8 @@ </div> </div> </div><div class="section-method"> - <a name="//api/name/next" title="next"></a> - <h3 class="method-title"><code><a href="#//api/name/next">– next</a></code> + <a name="//api/name/hasAnotherRow" title="hasAnotherRow"></a> + <h3 class="method-title"><code><a href="#//api/name/hasAnotherRow">– hasAnotherRow</a></code> </h3> <div class="method-info"> @@ -595,12 +624,12 @@ <div class="method-subsection brief-description"> - <p>Retrieve next row for result set.</p> + <p>Did the last call to <a href="#//api/name/next"><code>next</code></a> succeed in retrieving another row?</p> </div> - <div class="method-subsection method-declaration"><code>- (BOOL)next</code></div> + <div class="method-subsection method-declaration"><code>- (BOOL)hasAnotherRow</code></div> @@ -608,7 +637,7 @@ <div class="method-subsection return"> <h4 class="method-subtitle parameter-title">Return Value</h4> - <p><code>YES</code> if row successfully retrieved; <code>NO</code> if end of result set reached</p> + <p><code>YES</code> if the last call to <a href="#//api/name/next"><code>next</code></a> succeeded in retrieving another record; <code>NO</code> if not.</p> </div> @@ -617,9 +646,7 @@ <div class="method-subsection discussion-section"> <h4 class="method-subtitle">Discussion</h4> - <p>Retrieve next row for result set.</p> - -<p>You must always invoke <code>next</code> or <code>nextWithError</code> before attempting to access the values returned in a query, even if you’re only expecting one.</p> + <p>Did the last call to <a href="#//api/name/next"><code>next</code></a> succeed in retrieving another row?</p><div class="warning"><p><strong>Warning:</strong> The <code>hasAnotherRow</code> method must follow a call to <a href="#//api/name/next"><code>next</code></a>. If the previous database interaction was something other than a call to <code>next</code>, then this method may return <code>NO</code>, whether there is another row of data or not.</p></div> </div> @@ -630,7 +657,7 @@ <h4 class="method-subtitle">See Also</h4> <ul> - <li><code><p><a href="#//api/name/hasAnotherRow">- hasAnotherRow</a></p></code></li> + <li><code><p><a href="#//api/name/next">- next</a></p></code></li> </ul> </div> @@ -645,9 +672,17 @@ </div> </div> -</div><div class="section-method"> - <a name="//api/name/nextWithError:" title="nextWithError:"></a> - <h3 class="method-title"><code><a href="#//api/name/nextWithError:">– nextWithError:</a></code> +</div> + </div> + + + <a title="Retrieving information from result set" name="task_Retrieving information from result set"></a> + <h2 class="task-title">Retrieving information from result set</h2> + + <div class="task-list"> + <div class="section-method"> + <a name="//api/name/columnCount" title="columnCount"></a> + <h3 class="method-title"><code><a href="#//api/name/columnCount">– columnCount</a></code> </h3> <div class="method-info"> @@ -657,32 +692,20 @@ <div class="method-subsection brief-description"> - <p>Retrieve next row for result set.</p> + <p>How many columns in result set</p> </div> - <div class="method-subsection method-declaration"><code>- (BOOL)nextWithError:(NSError **)<em>outErr</em></code></div> + <div class="method-subsection method-declaration"><code>- (int)columnCount</code></div> - <div class="method-subsection arguments-section parameters"> - <h4 class="method-subtitle parameter-title">Parameters</h4> - <table class="argument-def parameter-def"> - - <tr> - <th scope="row" class="argument-name"><code>outErr</code></th> - <td><p>A ‘NSError’ object to receive any error object (if any).</p></td> - </tr> - - </table> - </div> - <div class="method-subsection return"> <h4 class="method-subtitle parameter-title">Return Value</h4> - <p>‘YES’ if row successfully retrieved; ‘NO’ if end of result set reached</p> + <p>Integer value of the number of columns.</p> </div> @@ -691,24 +714,13 @@ <div class="method-subsection discussion-section"> <h4 class="method-subtitle">Discussion</h4> - <p>Retrieve next row for result set.</p> - -<p> You must always invoke <code>next</code> or <code>nextWithError</code> before attempting to access the values returned in a query, even if you’re only expecting one.</p> + <p>How many columns in result set</p> </div> - <div class="method-subsection see-also-section"> - <h4 class="method-subtitle">See Also</h4> - <ul> - - <li><code><p><a href="#//api/name/hasAnotherRow">- hasAnotherRow</a></p></code></li> - - </ul> - </div> - <div class="method-subsection declared-in-section"> @@ -720,8 +732,8 @@ </div> </div> </div><div class="section-method"> - <a name="//api/name/hasAnotherRow" title="hasAnotherRow"></a> - <h3 class="method-title"><code><a href="#//api/name/hasAnotherRow">– hasAnotherRow</a></code> + <a name="//api/name/columnIndexForName:" title="columnIndexForName:"></a> + <h3 class="method-title"><code><a href="#//api/name/columnIndexForName:">– columnIndexForName:</a></code> </h3> <div class="method-info"> @@ -731,20 +743,32 @@ <div class="method-subsection brief-description"> - <p>Did the last call to <a href="#//api/name/next"><code>next</code></a> succeed in retrieving another row?</p> + <p>Column index for column name</p> </div> - <div class="method-subsection method-declaration"><code>- (BOOL)hasAnotherRow</code></div> + <div class="method-subsection method-declaration"><code>- (int)columnIndexForName:(NSString *)<em>columnName</em></code></div> + <div class="method-subsection arguments-section parameters"> + <h4 class="method-subtitle parameter-title">Parameters</h4> + <table class="argument-def parameter-def"> + + <tr> + <th scope="row" class="argument-name"><code>columnName</code></th> + <td><p><code>NSString</code> value of the name of the column.</p></td> + </tr> + + </table> + </div> + <div class="method-subsection return"> <h4 class="method-subtitle parameter-title">Return Value</h4> - <p><code>YES</code> if the last call to <a href="#//api/name/next"><code>next</code></a> succeeded in retrieving another record; <code>NO</code> if not.</p> + <p>Zero-based index for column.</p> </div> @@ -753,22 +777,13 @@ <div class="method-subsection discussion-section"> <h4 class="method-subtitle">Discussion</h4> - <p>Did the last call to <a href="#//api/name/next"><code>next</code></a> succeed in retrieving another row?</p><div class="warning"><p><strong>Warning:</strong> The <code>hasAnotherRow</code> method must follow a call to <a href="#//api/name/next"><code>next</code></a>. If the previous database interaction was something other than a call to <code>next</code>, then this method may return <code>NO</code>, whether there is another row of data or not.</p></div> + <p>Column index for column name</p> </div> - <div class="method-subsection see-also-section"> - <h4 class="method-subtitle">See Also</h4> - <ul> - - <li><code><p><a href="#//api/name/next">- next</a></p></code></li> - - </ul> - </div> - <div class="method-subsection declared-in-section"> @@ -780,8 +795,8 @@ </div> </div> </div><div class="section-method"> - <a name="//api/name/columnIndexForName:" title="columnIndexForName:"></a> - <h3 class="method-title"><code><a href="#//api/name/columnIndexForName:">– columnIndexForName:</a></code> + <a name="//api/name/columnNameForIndex:" title="columnNameForIndex:"></a> + <h3 class="method-title"><code><a href="#//api/name/columnNameForIndex:">– columnNameForIndex:</a></code> </h3> <div class="method-info"> @@ -791,12 +806,12 @@ <div class="method-subsection brief-description"> - <p>Column index for column name</p> + <p>Column name for column index</p> </div> - <div class="method-subsection method-declaration"><code>- (int)columnIndexForName:(NSString *)<em>columnName</em></code></div> + <div class="method-subsection method-declaration"><code>- (NSString *)columnNameForIndex:(int)<em>columnIdx</em></code></div> @@ -805,8 +820,8 @@ <table class="argument-def parameter-def"> <tr> - <th scope="row" class="argument-name"><code>columnName</code></th> - <td><p><code>NSString</code> value of the name of the column.</p></td> + <th scope="row" class="argument-name"><code>columnIdx</code></th> + <td><p>Zero-based index for column.</p></td> </tr> </table> @@ -816,7 +831,7 @@ <div class="method-subsection return"> <h4 class="method-subtitle parameter-title">Return Value</h4> - <p>Zero-based index for column.</p> + <p>columnName <code>NSString</code> value of the name of the column.</p> </div> @@ -825,7 +840,7 @@ <div class="method-subsection discussion-section"> <h4 class="method-subtitle">Discussion</h4> - <p>Column index for column name</p> + <p>Column name for column index</p> </div> @@ -1599,8 +1614,8 @@ </div> </div> </div><div class="section-method"> - <a name="//api/name/stringForColumnIndex:" title="stringForColumnIndex:"></a> - <h3 class="method-title"><code><a href="#//api/name/stringForColumnIndex:">– stringForColumnIndex:</a></code> + <a name="//api/name/stringForColumn:" title="stringForColumn:"></a> + <h3 class="method-title"><code><a href="#//api/name/stringForColumn:">– stringForColumn:</a></code> </h3> <div class="method-info"> @@ -1615,7 +1630,7 @@ - <div class="method-subsection method-declaration"><code>- (NSString *)stringForColumnIndex:(int)<em>columnIdx</em></code></div> + <div class="method-subsection method-declaration"><code>- (NSString *)stringForColumn:(NSString *)<em>columnName</em></code></div> @@ -1624,8 +1639,8 @@ <table class="argument-def parameter-def"> <tr> - <th scope="row" class="argument-name"><code>columnIdx</code></th> - <td><p>Zero-based index for column.</p></td> + <th scope="row" class="argument-name"><code>columnName</code></th> + <td><p><code>NSString</code> value of the name of the column.</p></td> </tr> </table> @@ -1662,8 +1677,8 @@ </div> </div> </div><div class="section-method"> - <a name="//api/name/stringForColumn:" title="stringForColumn:"></a> - <h3 class="method-title"><code><a href="#//api/name/stringForColumn:">– stringForColumn:</a></code> + <a name="//api/name/stringForColumnIndex:" title="stringForColumnIndex:"></a> + <h3 class="method-title"><code><a href="#//api/name/stringForColumnIndex:">– stringForColumnIndex:</a></code> </h3> <div class="method-info"> @@ -1678,7 +1693,7 @@ - <div class="method-subsection method-declaration"><code>- (NSString *)stringForColumn:(NSString *)<em>columnName</em></code></div> + <div class="method-subsection method-declaration"><code>- (NSString *)stringForColumnIndex:(int)<em>columnIdx</em></code></div> @@ -1687,8 +1702,8 @@ <table class="argument-def parameter-def"> <tr> - <th scope="row" class="argument-name"><code>columnName</code></th> - <td><p><code>NSString</code> value of the name of the column.</p></td> + <th scope="row" class="argument-name"><code>columnIdx</code></th> + <td><p>Zero-based index for column.</p></td> </tr> </table> @@ -1979,8 +1994,8 @@ </div> </div> </div><div class="section-method"> - <a name="//api/name/dataNoCopyForColumn:" title="dataNoCopyForColumn:"></a> - <h3 class="method-title"><code><a href="#//api/name/dataNoCopyForColumn:">– dataNoCopyForColumn:</a></code> + <a name="//api/name/UTF8StringForColumnName:" title="UTF8StringForColumnName:"></a> + <h3 class="method-title"><code><a href="#//api/name/UTF8StringForColumnName:">– UTF8StringForColumnName:</a></code> </h3> <div class="method-info"> @@ -1990,12 +2005,12 @@ <div class="method-subsection brief-description"> - <p>Result set <code>NSData</code> value for column.</p> + <p>Result set <code>(const unsigned char *)</code> value for column.</p> </div> - <div class="method-subsection method-declaration"><code>- (NSData *)dataNoCopyForColumn:(NSString *)<em>columnName</em></code></div> + <div class="method-subsection method-declaration"><code>- (const unsigned char *)UTF8StringForColumnName:(NSString *)<em>columnName</em></code></div> @@ -2015,7 +2030,7 @@ <div class="method-subsection return"> <h4 class="method-subtitle parameter-title">Return Value</h4> - <p><code>NSData</code> value of the result set’s column.</p> + <p><code>(const unsigned char *)</code> value of the result set’s column.</p> </div> @@ -2024,9 +2039,7 @@ <div class="method-subsection discussion-section"> <h4 class="method-subtitle">Discussion</h4> - <p>Result set <code>NSData</code> value for column.</p><div class="warning"><p><strong>Warning:</strong> If you are going to use this data after you iterate over the next row, or after you close the -result set, make sure to make a copy of the data first (or just use <a href="#//api/name/dataForColumn:"><code>dataForColumn:</code></a>/<a href="#//api/name/dataForColumnIndex:"><code>dataForColumnIndex:</code></a>) -If you don’t, you’re going to be in a world of hurt when you try and use the data.</p></div> + <p>Result set <code>(const unsigned char *)</code> value for column.</p> </div> @@ -2044,8 +2057,8 @@ If you don’t, you’re going to be in a world of hurt when you try and </div> </div> </div><div class="section-method"> - <a name="//api/name/dataNoCopyForColumnIndex:" title="dataNoCopyForColumnIndex:"></a> - <h3 class="method-title"><code><a href="#//api/name/dataNoCopyForColumnIndex:">– dataNoCopyForColumnIndex:</a></code> + <a name="//api/name/UTF8StringForColumnIndex:" title="UTF8StringForColumnIndex:"></a> + <h3 class="method-title"><code><a href="#//api/name/UTF8StringForColumnIndex:">– UTF8StringForColumnIndex:</a></code> </h3> <div class="method-info"> @@ -2055,12 +2068,12 @@ If you don’t, you’re going to be in a world of hurt when you try and <div class="method-subsection brief-description"> - <p>Result set <code>NSData</code> value for column.</p> + <p>Result set <code>(const unsigned char *)</code> value for column.</p> </div> - <div class="method-subsection method-declaration"><code>- (NSData *)dataNoCopyForColumnIndex:(int)<em>columnIdx</em></code></div> + <div class="method-subsection method-declaration"><code>- (const unsigned char *)UTF8StringForColumnIndex:(int)<em>columnIdx</em></code></div> @@ -2080,7 +2093,7 @@ If you don’t, you’re going to be in a world of hurt when you try and <div class="method-subsection return"> <h4 class="method-subtitle parameter-title">Return Value</h4> - <p><code>NSData</code> value of the result set’s column.</p> + <p><code>(const unsigned char *)</code> value of the result set’s column.</p> </div> @@ -2089,9 +2102,7 @@ If you don’t, you’re going to be in a world of hurt when you try and <div class="method-subsection discussion-section"> <h4 class="method-subtitle">Discussion</h4> - <p>Result set <code>NSData</code> value for column.</p><div class="warning"><p><strong>Warning:</strong> If you are going to use this data after you iterate over the next row, or after you close the -result set, make sure to make a copy of the data first (or just use <a href="#//api/name/dataForColumn:"><code>dataForColumn:</code></a>/<a href="#//api/name/dataForColumnIndex:"><code>dataForColumnIndex:</code></a>) -If you don’t, you’re going to be in a world of hurt when you try and use the data.</p></div> + <p>Result set <code>(const unsigned char *)</code> value for column.</p> </div> @@ -2109,8 +2120,8 @@ If you don’t, you’re going to be in a world of hurt when you try and </div> </div> </div><div class="section-method"> - <a name="//api/name/columnIndexIsNull:" title="columnIndexIsNull:"></a> - <h3 class="method-title"><code><a href="#//api/name/columnIndexIsNull:">– columnIndexIsNull:</a></code> + <a name="//api/name/objectForColumnName:" title="objectForColumnName:"></a> + <h3 class="method-title"><code><a href="#//api/name/objectForColumnName:">– objectForColumnName:</a></code> </h3> <div class="method-info"> @@ -2120,12 +2131,12 @@ If you don’t, you’re going to be in a world of hurt when you try and <div class="method-subsection brief-description"> - <p>Is the column <code>NULL</code>?</p> + <p>Result set object for column.</p> </div> - <div class="method-subsection method-declaration"><code>- (BOOL)columnIndexIsNull:(int)<em>columnIdx</em></code></div> + <div class="method-subsection method-declaration"><code>- (id)objectForColumnName:(NSString *)<em>columnName</em></code></div> @@ -2134,8 +2145,8 @@ If you don’t, you’re going to be in a world of hurt when you try and <table class="argument-def parameter-def"> <tr> - <th scope="row" class="argument-name"><code>columnIdx</code></th> - <td><p>Zero-based index for column.</p></td> + <th scope="row" class="argument-name"><code>columnName</code></th> + <td><p><code>NSString</code> value of the name of the column.</p></td> </tr> </table> @@ -2145,7 +2156,7 @@ If you don’t, you’re going to be in a world of hurt when you try and <div class="method-subsection return"> <h4 class="method-subtitle parameter-title">Return Value</h4> - <p><code>YES</code> if column is <code>NULL</code>; <code>NO</code> if not <code>NULL</code>.</p> + <p>Either <code>NSNumber</code>, <code>NSString</code>, <code>NSData</code>, or <code>NSNull</code>. If the column was <code>NULL</code>, this returns <code>[NSNull null]</code> object.</p> </div> @@ -2154,13 +2165,22 @@ If you don’t, you’re going to be in a world of hurt when you try and <div class="method-subsection discussion-section"> <h4 class="method-subtitle">Discussion</h4> - <p>Is the column <code>NULL</code>?</p> + <p>Result set object for column.</p> </div> + <div class="method-subsection see-also-section"> + <h4 class="method-subtitle">See Also</h4> + <ul> + + <li><code><p><a href="#//api/name/objectForKeyedSubscript:">- objectForKeyedSubscript:</a></p></code></li> + + </ul> + </div> + <div class="method-subsection declared-in-section"> @@ -2172,8 +2192,8 @@ If you don’t, you’re going to be in a world of hurt when you try and </div> </div> </div><div class="section-method"> - <a name="//api/name/columnIsNull:" title="columnIsNull:"></a> - <h3 class="method-title"><code><a href="#//api/name/columnIsNull:">– columnIsNull:</a></code> + <a name="//api/name/objectForColumnIndex:" title="objectForColumnIndex:"></a> + <h3 class="method-title"><code><a href="#//api/name/objectForColumnIndex:">– objectForColumnIndex:</a></code> </h3> <div class="method-info"> @@ -2183,12 +2203,12 @@ If you don’t, you’re going to be in a world of hurt when you try and <div class="method-subsection brief-description"> - <p>Is the column <code>NULL</code>?</p> + <p>Result set object for column.</p> </div> - <div class="method-subsection method-declaration"><code>- (BOOL)columnIsNull:(NSString *)<em>columnName</em></code></div> + <div class="method-subsection method-declaration"><code>- (id)objectForColumnIndex:(int)<em>columnIdx</em></code></div> @@ -2197,8 +2217,8 @@ If you don’t, you’re going to be in a world of hurt when you try and <table class="argument-def parameter-def"> <tr> - <th scope="row" class="argument-name"><code>columnName</code></th> - <td><p><code>NSString</code> value of the name of the column.</p></td> + <th scope="row" class="argument-name"><code>columnIdx</code></th> + <td><p>Zero-based index for column.</p></td> </tr> </table> @@ -2208,7 +2228,7 @@ If you don’t, you’re going to be in a world of hurt when you try and <div class="method-subsection return"> <h4 class="method-subtitle parameter-title">Return Value</h4> - <p><code>YES</code> if column is <code>NULL</code>; <code>NO</code> if not <code>NULL</code>.</p> + <p>Either <code>NSNumber</code>, <code>NSString</code>, <code>NSData</code>, or <code>NSNull</code>. If the column was <code>NULL</code>, this returns <code>[NSNull null]</code> object.</p> </div> @@ -2217,13 +2237,22 @@ If you don’t, you’re going to be in a world of hurt when you try and <div class="method-subsection discussion-section"> <h4 class="method-subtitle">Discussion</h4> - <p>Is the column <code>NULL</code>?</p> + <p>Result set object for column.</p> </div> + <div class="method-subsection see-also-section"> + <h4 class="method-subtitle">See Also</h4> + <ul> + + <li><code><p><a href="#//api/name/objectAtIndexedSubscript:">- objectAtIndexedSubscript:</a></p></code></li> + + </ul> + </div> + <div class="method-subsection declared-in-section"> @@ -2235,8 +2264,8 @@ If you don’t, you’re going to be in a world of hurt when you try and </div> </div> </div><div class="section-method"> - <a name="//api/name/UTF8StringForColumnIndex:" title="UTF8StringForColumnIndex:"></a> - <h3 class="method-title"><code><a href="#//api/name/UTF8StringForColumnIndex:">– UTF8StringForColumnIndex:</a></code> + <a name="//api/name/objectForKeyedSubscript:" title="objectForKeyedSubscript:"></a> + <h3 class="method-title"><code><a href="#//api/name/objectForKeyedSubscript:">– objectForKeyedSubscript:</a></code> </h3> <div class="method-info"> @@ -2246,12 +2275,12 @@ If you don’t, you’re going to be in a world of hurt when you try and <div class="method-subsection brief-description"> - <p>Result set <code>(const unsigned char *)</code> value for column.</p> + <p>Result set object for column.</p> </div> - <div class="method-subsection method-declaration"><code>- (const unsigned char *)UTF8StringForColumnIndex:(int)<em>columnIdx</em></code></div> + <div class="method-subsection method-declaration"><code>- (id)objectForKeyedSubscript:(NSString *)<em>columnName</em></code></div> @@ -2260,8 +2289,8 @@ If you don’t, you’re going to be in a world of hurt when you try and <table class="argument-def parameter-def"> <tr> - <th scope="row" class="argument-name"><code>columnIdx</code></th> - <td><p>Zero-based index for column.</p></td> + <th scope="row" class="argument-name"><code>columnName</code></th> + <td><p><code>NSString</code> value of the name of the column.</p></td> </tr> </table> @@ -2271,7 +2300,7 @@ If you don’t, you’re going to be in a world of hurt when you try and <div class="method-subsection return"> <h4 class="method-subtitle parameter-title">Return Value</h4> - <p><code>(const unsigned char *)</code> value of the result set’s column.</p> + <p>Either <code>NSNumber</code>, <code>NSString</code>, <code>NSData</code>, or <code>NSNull</code>. If the column was <code>NULL</code>, this returns <code>[NSNull null]</code> object.</p> </div> @@ -2280,7 +2309,22 @@ If you don’t, you’re going to be in a world of hurt when you try and <div class="method-subsection discussion-section"> <h4 class="method-subtitle">Discussion</h4> - <p>Result set <code>(const unsigned char *)</code> value for column.</p> + <p>Result set object for column.</p> + +<p>This method allows the use of the “boxed” syntax supported in Modern Objective-C. For example, by defining this method, the following syntax is now supported:</p> + +<pre><code>id result = rs[@"employee_name"]; +</code></pre> + +<p>This simplified syntax is equivalent to calling:</p> + +<pre><code>id result = [rs objectForKeyedSubscript:@"employee_name"]; +</code></pre> + +<p>which is, it turns out, equivalent to calling:</p> + +<pre><code>id result = [rs objectForColumnName:@"employee_name"]; +</code></pre> </div> @@ -2298,8 +2342,8 @@ If you don’t, you’re going to be in a world of hurt when you try and </div> </div> </div><div class="section-method"> - <a name="//api/name/UTF8StringForColumnName:" title="UTF8StringForColumnName:"></a> - <h3 class="method-title"><code><a href="#//api/name/UTF8StringForColumnName:">– UTF8StringForColumnName:</a></code> + <a name="//api/name/objectAtIndexedSubscript:" title="objectAtIndexedSubscript:"></a> + <h3 class="method-title"><code><a href="#//api/name/objectAtIndexedSubscript:">– objectAtIndexedSubscript:</a></code> </h3> <div class="method-info"> @@ -2309,12 +2353,12 @@ If you don’t, you’re going to be in a world of hurt when you try and <div class="method-subsection brief-description"> - <p>Result set <code>(const unsigned char *)</code> value for column.</p> + <p>Result set object for column.</p> </div> - <div class="method-subsection method-declaration"><code>- (const unsigned char *)UTF8StringForColumnName:(NSString *)<em>columnName</em></code></div> + <div class="method-subsection method-declaration"><code>- (id)objectAtIndexedSubscript:(int)<em>columnIdx</em></code></div> @@ -2323,8 +2367,8 @@ If you don’t, you’re going to be in a world of hurt when you try and <table class="argument-def parameter-def"> <tr> - <th scope="row" class="argument-name"><code>columnName</code></th> - <td><p><code>NSString</code> value of the name of the column.</p></td> + <th scope="row" class="argument-name"><code>columnIdx</code></th> + <td><p>Zero-based index for column.</p></td> </tr> </table> @@ -2334,7 +2378,7 @@ If you don’t, you’re going to be in a world of hurt when you try and <div class="method-subsection return"> <h4 class="method-subtitle parameter-title">Return Value</h4> - <p><code>(const unsigned char *)</code> value of the result set’s column.</p> + <p>Either <code>NSNumber</code>, <code>NSString</code>, <code>NSData</code>, or <code>NSNull</code>. If the column was <code>NULL</code>, this returns <code>[NSNull null]</code> object.</p> </div> @@ -2343,7 +2387,22 @@ If you don’t, you’re going to be in a world of hurt when you try and <div class="method-subsection discussion-section"> <h4 class="method-subtitle">Discussion</h4> - <p>Result set <code>(const unsigned char *)</code> value for column.</p> + <p>Result set object for column.</p> + +<p>This method allows the use of the “boxed” syntax supported in Modern Objective-C. For example, by defining this method, the following syntax is now supported:</p> + +<pre><code>id result = rs[0]; +</code></pre> + +<p>This simplified syntax is equivalent to calling:</p> + +<pre><code>id result = [rs objectForKeyedSubscript:0]; +</code></pre> + +<p>which is, it turns out, equivalent to calling:</p> + +<pre><code>id result = [rs objectForColumnName:0]; +</code></pre> </div> @@ -2361,8 +2420,8 @@ If you don’t, you’re going to be in a world of hurt when you try and </div> </div> </div><div class="section-method"> - <a name="//api/name/objectForColumnIndex:" title="objectForColumnIndex:"></a> - <h3 class="method-title"><code><a href="#//api/name/objectForColumnIndex:">– objectForColumnIndex:</a></code> + <a name="//api/name/dataNoCopyForColumn:" title="dataNoCopyForColumn:"></a> + <h3 class="method-title"><code><a href="#//api/name/dataNoCopyForColumn:">– dataNoCopyForColumn:</a></code> </h3> <div class="method-info"> @@ -2372,12 +2431,12 @@ If you don’t, you’re going to be in a world of hurt when you try and <div class="method-subsection brief-description"> - <p>Result set object for column.</p> + <p>Result set <code>NSData</code> value for column.</p> </div> - <div class="method-subsection method-declaration"><code>- (id)objectForColumnIndex:(int)<em>columnIdx</em></code></div> + <div class="method-subsection method-declaration"><code>- (NSData *)dataNoCopyForColumn:(NSString *)<em>columnName</em></code></div> @@ -2386,8 +2445,8 @@ If you don’t, you’re going to be in a world of hurt when you try and <table class="argument-def parameter-def"> <tr> - <th scope="row" class="argument-name"><code>columnIdx</code></th> - <td><p>Zero-based index for column.</p></td> + <th scope="row" class="argument-name"><code>columnName</code></th> + <td><p><code>NSString</code> value of the name of the column.</p></td> </tr> </table> @@ -2397,7 +2456,7 @@ If you don’t, you’re going to be in a world of hurt when you try and <div class="method-subsection return"> <h4 class="method-subtitle parameter-title">Return Value</h4> - <p>Either <code>NSNumber</code>, <code>NSString</code>, <code>NSData</code>, or <code>NSNull</code>. If the column was <code>NULL</code>, this returns <code>[NSNull null]</code> object.</p> + <p><code>NSData</code> value of the result set’s column.</p> </div> @@ -2406,22 +2465,15 @@ If you don’t, you’re going to be in a world of hurt when you try and <div class="method-subsection discussion-section"> <h4 class="method-subtitle">Discussion</h4> - <p>Result set object for column.</p> + <p>Result set <code>NSData</code> value for column.</p><div class="warning"><p><strong>Warning:</strong> If you are going to use this data after you iterate over the next row, or after you close the +result set, make sure to make a copy of the data first (or just use <a href="#//api/name/dataForColumn:"><code>dataForColumn:</code></a>/<a href="#//api/name/dataForColumnIndex:"><code>dataForColumnIndex:</code></a>) +If you don’t, you’re going to be in a world of hurt when you try and use the data.</p></div> </div> - <div class="method-subsection see-also-section"> - <h4 class="method-subtitle">See Also</h4> - <ul> - - <li><code><p><a href="#//api/name/objectAtIndexedSubscript:">- objectAtIndexedSubscript:</a></p></code></li> - - </ul> - </div> - <div class="method-subsection declared-in-section"> @@ -2433,8 +2485,8 @@ If you don’t, you’re going to be in a world of hurt when you try and </div> </div> </div><div class="section-method"> - <a name="//api/name/objectForColumnName:" title="objectForColumnName:"></a> - <h3 class="method-title"><code><a href="#//api/name/objectForColumnName:">– objectForColumnName:</a></code> + <a name="//api/name/dataNoCopyForColumnIndex:" title="dataNoCopyForColumnIndex:"></a> + <h3 class="method-title"><code><a href="#//api/name/dataNoCopyForColumnIndex:">– dataNoCopyForColumnIndex:</a></code> </h3> <div class="method-info"> @@ -2444,12 +2496,12 @@ If you don’t, you’re going to be in a world of hurt when you try and <div class="method-subsection brief-description"> - <p>Result set object for column.</p> + <p>Result set <code>NSData</code> value for column.</p> </div> - <div class="method-subsection method-declaration"><code>- (id)objectForColumnName:(NSString *)<em>columnName</em></code></div> + <div class="method-subsection method-declaration"><code>- (NSData *)dataNoCopyForColumnIndex:(int)<em>columnIdx</em></code></div> @@ -2458,8 +2510,8 @@ If you don’t, you’re going to be in a world of hurt when you try and <table class="argument-def parameter-def"> <tr> - <th scope="row" class="argument-name"><code>columnName</code></th> - <td><p><code>NSString</code> value of the name of the column.</p></td> + <th scope="row" class="argument-name"><code>columnIdx</code></th> + <td><p>Zero-based index for column.</p></td> </tr> </table> @@ -2469,7 +2521,7 @@ If you don’t, you’re going to be in a world of hurt when you try and <div class="method-subsection return"> <h4 class="method-subtitle parameter-title">Return Value</h4> - <p>Either <code>NSNumber</code>, <code>NSString</code>, <code>NSData</code>, or <code>NSNull</code>. If the column was <code>NULL</code>, this returns <code>[NSNull null]</code> object.</p> + <p><code>NSData</code> value of the result set’s column.</p> </div> @@ -2478,22 +2530,15 @@ If you don’t, you’re going to be in a world of hurt when you try and <div class="method-subsection discussion-section"> <h4 class="method-subtitle">Discussion</h4> - <p>Result set object for column.</p> + <p>Result set <code>NSData</code> value for column.</p><div class="warning"><p><strong>Warning:</strong> If you are going to use this data after you iterate over the next row, or after you close the +result set, make sure to make a copy of the data first (or just use <a href="#//api/name/dataForColumn:"><code>dataForColumn:</code></a>/<a href="#//api/name/dataForColumnIndex:"><code>dataForColumnIndex:</code></a>) +If you don’t, you’re going to be in a world of hurt when you try and use the data.</p></div> </div> - <div class="method-subsection see-also-section"> - <h4 class="method-subtitle">See Also</h4> - <ul> - - <li><code><p><a href="#//api/name/objectForKeyedSubscript:">- objectForKeyedSubscript:</a></p></code></li> - - </ul> - </div> - <div class="method-subsection declared-in-section"> @@ -2505,8 +2550,8 @@ If you don’t, you’re going to be in a world of hurt when you try and </div> </div> </div><div class="section-method"> - <a name="//api/name/columnNameForIndex:" title="columnNameForIndex:"></a> - <h3 class="method-title"><code><a href="#//api/name/columnNameForIndex:">– columnNameForIndex:</a></code> + <a name="//api/name/columnIndexIsNull:" title="columnIndexIsNull:"></a> + <h3 class="method-title"><code><a href="#//api/name/columnIndexIsNull:">– columnIndexIsNull:</a></code> </h3> <div class="method-info"> @@ -2516,12 +2561,12 @@ If you don’t, you’re going to be in a world of hurt when you try and <div class="method-subsection brief-description"> - <p>Column name for column index</p> + <p>Is the column <code>NULL</code>?</p> </div> - <div class="method-subsection method-declaration"><code>- (NSString *)columnNameForIndex:(int)<em>columnIdx</em></code></div> + <div class="method-subsection method-declaration"><code>- (BOOL)columnIndexIsNull:(int)<em>columnIdx</em></code></div> @@ -2541,7 +2586,7 @@ If you don’t, you’re going to be in a world of hurt when you try and <div class="method-subsection return"> <h4 class="method-subtitle parameter-title">Return Value</h4> - <p>columnName <code>NSString</code> value of the name of the column.</p> + <p><code>YES</code> if column is <code>NULL</code>; <code>NO</code> if not <code>NULL</code>.</p> </div> @@ -2550,7 +2595,7 @@ If you don’t, you’re going to be in a world of hurt when you try and <div class="method-subsection discussion-section"> <h4 class="method-subtitle">Discussion</h4> - <p>Column name for column index</p> + <p>Is the column <code>NULL</code>?</p> </div> @@ -2568,8 +2613,8 @@ If you don’t, you’re going to be in a world of hurt when you try and </div> </div> </div><div class="section-method"> - <a name="//api/name/objectAtIndexedSubscript:" title="objectAtIndexedSubscript:"></a> - <h3 class="method-title"><code><a href="#//api/name/objectAtIndexedSubscript:">– objectAtIndexedSubscript:</a></code> + <a name="//api/name/columnIsNull:" title="columnIsNull:"></a> + <h3 class="method-title"><code><a href="#//api/name/columnIsNull:">– columnIsNull:</a></code> </h3> <div class="method-info"> @@ -2579,12 +2624,12 @@ If you don’t, you’re going to be in a world of hurt when you try and <div class="method-subsection brief-description"> - <p>Result set object for column.</p> + <p>Is the column <code>NULL</code>?</p> </div> - <div class="method-subsection method-declaration"><code>- (id)objectAtIndexedSubscript:(int)<em>columnIdx</em></code></div> + <div class="method-subsection method-declaration"><code>- (BOOL)columnIsNull:(NSString *)<em>columnName</em></code></div> @@ -2593,8 +2638,8 @@ If you don’t, you’re going to be in a world of hurt when you try and <table class="argument-def parameter-def"> <tr> - <th scope="row" class="argument-name"><code>columnIdx</code></th> - <td><p>Zero-based index for column.</p></td> + <th scope="row" class="argument-name"><code>columnName</code></th> + <td><p><code>NSString</code> value of the name of the column.</p></td> </tr> </table> @@ -2604,7 +2649,7 @@ If you don’t, you’re going to be in a world of hurt when you try and <div class="method-subsection return"> <h4 class="method-subtitle parameter-title">Return Value</h4> - <p>Either <code>NSNumber</code>, <code>NSString</code>, <code>NSData</code>, or <code>NSNull</code>. If the column was <code>NULL</code>, this returns <code>[NSNull null]</code> object.</p> + <p><code>YES</code> if column is <code>NULL</code>; <code>NO</code> if not <code>NULL</code>.</p> </div> @@ -2613,22 +2658,7 @@ If you don’t, you’re going to be in a world of hurt when you try and <div class="method-subsection discussion-section"> <h4 class="method-subtitle">Discussion</h4> - <p>Result set object for column.</p> - -<p>This method allows the use of the “boxed” syntax supported in Modern Objective-C. For example, by defining this method, the following syntax is now supported:</p> - -<pre><code>id result = rs[0]; -</code></pre> - -<p>This simplified syntax is equivalent to calling:</p> - -<pre><code>id result = [rs objectForKeyedSubscript:0]; -</code></pre> - -<p>which is, it turns out, equivalent to calling:</p> - -<pre><code>id result = [rs objectForColumnName:0]; -</code></pre> + <p>Is the column <code>NULL</code>?</p> </div> @@ -2646,8 +2676,8 @@ If you don’t, you’re going to be in a world of hurt when you try and </div> </div> </div><div class="section-method"> - <a name="//api/name/objectForKeyedSubscript:" title="objectForKeyedSubscript:"></a> - <h3 class="method-title"><code><a href="#//api/name/objectForKeyedSubscript:">– objectForKeyedSubscript:</a></code> + <a name="//api/name/resultDictionary" title="resultDictionary"></a> + <h3 class="method-title"><code><a href="#//api/name/resultDictionary">– resultDictionary</a></code> </h3> <div class="method-info"> @@ -2657,32 +2687,20 @@ If you don’t, you’re going to be in a world of hurt when you try and <div class="method-subsection brief-description"> - <p>Result set object for column.</p> + <p>Returns a dictionary of the row results mapped to case sensitive keys of the column names.</p> </div> - <div class="method-subsection method-declaration"><code>- (id)objectForKeyedSubscript:(NSString *)<em>columnName</em></code></div> + <div class="method-subsection method-declaration"><code>- (NSDictionary *)resultDictionary</code></div> - <div class="method-subsection arguments-section parameters"> - <h4 class="method-subtitle parameter-title">Parameters</h4> - <table class="argument-def parameter-def"> - - <tr> - <th scope="row" class="argument-name"><code>columnName</code></th> - <td><p><code>NSString</code> value of the name of the column.</p></td> - </tr> - - </table> - </div> - <div class="method-subsection return"> <h4 class="method-subtitle parameter-title">Return Value</h4> - <p>Either <code>NSNumber</code>, <code>NSString</code>, <code>NSData</code>, or <code>NSNull</code>. If the column was <code>NULL</code>, this returns <code>[NSNull null]</code> object.</p> + <p><code>NSDictionary</code> of the row results.</p> </div> @@ -2691,22 +2709,7 @@ If you don’t, you’re going to be in a world of hurt when you try and <div class="method-subsection discussion-section"> <h4 class="method-subtitle">Discussion</h4> - <p>Result set object for column.</p> - -<p>This method allows the use of the “boxed” syntax supported in Modern Objective-C. For example, by defining this method, the following syntax is now supported:</p> - -<pre><code>id result = rs[@"employee_name"]; -</code></pre> - -<p>This simplified syntax is equivalent to calling:</p> - -<pre><code>id result = [rs objectForKeyedSubscript:@"employee_name"]; -</code></pre> - -<p>which is, it turns out, equivalent to calling:</p> - -<pre><code>id result = [rs objectForColumnName:@"employee_name"]; -</code></pre> + <p>Returns a dictionary of the row results mapped to case sensitive keys of the column names.</p><div class="warning"><p><strong>Warning:</strong> The keys to the dictionary are case sensitive of the column names.</p></div> </div> @@ -2723,17 +2726,9 @@ If you don’t, you’re going to be in a world of hurt when you try and </div> </div> -</div> - </div> - - - <a title="Properties" name="task_Properties"></a> - <h2 class="task-title">Properties</h2> - - <div class="task-list"> - <div class="section-method"> - <a name="//api/name/query" title="query"></a> - <h3 class="method-title"><code><a href="#//api/name/query"> query</a></code> +</div><div class="section-method"> + <a name="//api/name/resultDict" title="resultDict"></a> + <h3 class="method-title"><code><a href="#//api/name/resultDict">– resultDict</a></code> </h3> <div class="method-info"> @@ -2743,12 +2738,12 @@ If you don’t, you’re going to be in a world of hurt when you try and <div class="method-subsection brief-description"> - <p>Executed query</p> + <p>Returns a dictionary of the row results</p> </div> - <div class="method-subsection method-declaration"><code>@property (atomic, retain) NSString *query</code></div> + <div class="method-subsection method-declaration"><code>- (NSDictionary *)resultDict</code></div> @@ -2760,13 +2755,22 @@ If you don’t, you’re going to be in a world of hurt when you try and <div class="method-subsection discussion-section"> <h4 class="method-subtitle">Discussion</h4> - <p>Executed query</p> + <p>Returns a dictionary of the row results</p><div class="warning"><p><strong>Warning:</strong> <strong>Deprecated</strong>: Please use <a href="#//api/name/resultDictionary"><code>resultDictionary</code></a> instead. Also, beware that <a href="#//api/name/resultDictionary"><code>resultDictionary</code></a> is case sensitive!</p></div> </div> + <div class="method-subsection see-also-section"> + <h4 class="method-subtitle">See Also</h4> + <ul> + + <li><code><p><a href="#//api/name/resultDictionary">- resultDictionary</a></p></code></li> + + </ul> + </div> + <div class="method-subsection declared-in-section"> @@ -2777,9 +2781,17 @@ If you don’t, you’re going to be in a world of hurt when you try and </div> </div> -</div><div class="section-method"> - <a name="//api/name/statement" title="statement"></a> - <h3 class="method-title"><code><a href="#//api/name/statement"> statement</a></code> +</div> + </div> + + + <a title="Key value coding magic" name="task_Key value coding magic"></a> + <h2 class="task-title">Key value coding magic</h2> + + <div class="task-list"> + <div class="section-method"> + <a name="//api/name/kvcMagic:" title="kvcMagic:"></a> + <h3 class="method-title"><code><a href="#//api/name/kvcMagic:">– kvcMagic:</a></code> </h3> <div class="method-info"> @@ -2789,15 +2801,27 @@ If you don’t, you’re going to be in a world of hurt when you try and <div class="method-subsection brief-description"> - <p><code>FMStatement</code> used by result set.</p> + <p>Performs <code>setValue</code> to yield support for key value observing.</p> </div> - <div class="method-subsection method-declaration"><code>@property (atomic, retain) FMStatement *statement</code></div> + <div class="method-subsection method-declaration"><code>- (void)kvcMagic:(id)<em>object</em></code></div> + <div class="method-subsection arguments-section parameters"> + <h4 class="method-subtitle parameter-title">Parameters</h4> + <table class="argument-def parameter-def"> + + <tr> + <th scope="row" class="argument-name"><code>object</code></th> + <td><p>The object for which the values will be set. This is the key-value-coding compliant object that you might, for example, observe.</p></td> + </tr> + + </table> + </div> + @@ -2806,7 +2830,7 @@ If you don’t, you’re going to be in a world of hurt when you try and <div class="method-subsection discussion-section"> <h4 class="method-subtitle">Discussion</h4> - <p><code>FMStatement</code> used by result set.</p> + <p>Performs <code>setValue</code> to yield support for key value observing.</p> </div> @@ -2836,10 +2860,10 @@ If you don’t, you’re going to be in a world of hurt when you try and <footer> <div class="footer-copyright"> - <p class="copyright">Copyright © 2015 ccgus. All rights reserved. Updated: 2015-01-25</p> + <p class="copyright">Copyright © 2015 ccgus. All rights reserved. Updated: 2015-10-29</p> - <p class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.2.1 (build 1333)</a>.</p> + <p class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.2.1 (build 1334)</a>.</p> </div> </footer> diff --git a/html/Classes/FMStatement.html b/html/Classes/FMStatement.html index e5852f6..3931db4 100644 --- a/html/Classes/FMStatement.html +++ b/html/Classes/FMStatement.html @@ -7,7 +7,7 @@ <link rel="stylesheet" href="../css/style.css"> <meta name="viewport" content="initial-scale=1, maximum-scale=1.4"> - <meta name="generator" content="appledoc 2.2.1 (build 1333)"> + <meta name="generator" content="appledoc 2.2.1 (build 1334)"> </head> <body class="appledoc"> <header> @@ -442,10 +442,10 @@ <footer> <div class="footer-copyright"> - <p class="copyright">Copyright © 2015 ccgus. All rights reserved. Updated: 2015-01-25</p> + <p class="copyright">Copyright © 2015 ccgus. All rights reserved. Updated: 2015-10-29</p> - <p class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.2.1 (build 1333)</a>.</p> + <p class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.2.1 (build 1334)</a>.</p> </div> </footer> diff --git a/html/hierarchy.html b/html/hierarchy.html index a1fd22c..8a67ec0 100644 --- a/html/hierarchy.html +++ b/html/hierarchy.html @@ -7,7 +7,7 @@ <link rel="stylesheet" href="css/style.css"> <meta name="viewport" content="initial-scale=1, maximum-scale=1.4"> - <meta name="generator" content="appledoc 2.2.1 (build 1333)"> + <meta name="generator" content="appledoc 2.2.1 (build 1334)"> </head> <body class="appledoc"> <header> @@ -57,8 +57,14 @@ <li><a href="Classes/FMResultSet.html">FMResultSet</a></li> + <li><a href="Classes/FMSimpleTokenizer.html">FMSimpleTokenizer</a></li> + <li><a href="Classes/FMStatement.html">FMStatement</a></li> + <li><a href="Classes/FMStopWordTokenizer.html">FMStopWordTokenizer</a></li> + + <li><a href="Classes/FMTextOffsets.html">FMTextOffsets</a></li> + </ul> </li> @@ -77,6 +83,10 @@ <li><a href="Categories/FMDatabase+FMDatabaseAdditions.html">FMDatabase(FMDatabaseAdditions)</a></li> + <li><a href="Categories/FMDatabase+FTS3.html">FMDatabase(FTS3)</a></li> + + <li><a href="Categories/FMResultSet+FTS3.html">FMResultSet(FTS3)</a></li> + <li><a href="Categories/NSObject+FMDatabasePoolDelegate.html">NSObject(FMDatabasePoolDelegate)</a></li> </ul> @@ -87,10 +97,10 @@ <footer> <div class="footer-copyright"> - <p class="copyright">Copyright © 2015 ccgus. All rights reserved. Updated: 2015-01-25</p> + <p class="copyright">Copyright © 2015 ccgus. All rights reserved. Updated: 2015-10-29</p> - <p class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.2.1 (build 1333)</a>.</p> + <p class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.2.1 (build 1334)</a>.</p> </div> </footer> diff --git a/html/index.html b/html/index.html index fb5a6ce..ce1edd9 100644 --- a/html/index.html +++ b/html/index.html @@ -7,7 +7,7 @@ <link rel="stylesheet" href="css/style.css"> <meta name="viewport" content="initial-scale=1, maximum-scale=1.4"> - <meta name="generator" content="appledoc 2.2.1 (build 1333)"> + <meta name="generator" content="appledoc 2.2.1 (build 1334)"> </head> <body class="appledoc"> <header> @@ -58,8 +58,14 @@ <li><a href="Classes/FMResultSet.html">FMResultSet</a></li> + <li><a href="Classes/FMSimpleTokenizer.html">FMSimpleTokenizer</a></li> + <li><a href="Classes/FMStatement.html">FMStatement</a></li> + <li><a href="Classes/FMStopWordTokenizer.html">FMStopWordTokenizer</a></li> + + <li><a href="Classes/FMTextOffsets.html">FMTextOffsets</a></li> + </ul> </div> @@ -76,6 +82,10 @@ <li><a href="Categories/FMDatabase+FMDatabaseAdditions.html">FMDatabase(FMDatabaseAdditions)</a></li> + <li><a href="Categories/FMDatabase+FTS3.html">FMDatabase(FTS3)</a></li> + + <li><a href="Categories/FMResultSet+FTS3.html">FMResultSet(FTS3)</a></li> + <li><a href="Categories/NSObject+FMDatabasePoolDelegate.html">NSObject(FMDatabasePoolDelegate)</a></li> </ul> @@ -87,10 +97,10 @@ <footer> <div class="footer-copyright"> - <p class="copyright">Copyright © 2015 ccgus. All rights reserved. Updated: 2015-01-25</p> + <p class="copyright">Copyright © 2015 ccgus. All rights reserved. Updated: 2015-10-29</p> - <p class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.2.1 (build 1333)</a>.</p> + <p class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.2.1 (build 1334)</a>.</p> </div> </footer> @@ -192,11 +192,11 @@ if ([s next]) { <h2>Using FMDatabaseQueue and Thread Safety.</h2> -<p>Using a single instance of FMDatabase from multiple threads at once is a bad idea. It has always been OK to make a FMDatabase object <em>per thread</em>. Just don't share a single instance across threads, and definitely not across multiple threads at the same time. Bad things will eventually happen and you'll eventually get something to crash, or maybe get an exception, or maybe meteorites will fall out of the sky and hit your Mac Pro. <em>This would suck</em>.</p> +<p>Using a single instance of <code>FMDatabase</code> from multiple threads at once is a bad idea. It has always been OK to make a <code>FMDatabase</code> object <em>per thread</em>. Just don't share a single instance across threads, and definitely not across multiple threads at the same time. Bad things will eventually happen and you'll eventually get something to crash, or maybe get an exception, or maybe meteorites will fall out of the sky and hit your Mac Pro. <em>This would suck</em>.</p> <p><strong>So don't instantiate a single FMDatabase object and use it across multiple threads.</strong></p> -<p>Instead, use FMDatabaseQueue. It's your friend and it's here to help. Here's how to use it:</p> +<p>Instead, use <code>FMDatabaseQueue</code>. It's your friend and it's here to help. Here's how to use it:</p> <p>First, make your queue.</p> @@ -233,12 +233,50 @@ if ([s next]) { }]; </code></pre> -<p>FMDatabaseQueue will make a serialized GCD queue in the background and execute the blocks you pass to the GCD queue. This means if you call your FMDatabaseQueue's methods from multiple threads at the same time GDC will execute them in the order they are received. This means queries and updates won't step on each other's toes, and every one is happy.</p> +<p><code>FMDatabaseQueue</code> will make a serialized GCD queue in the background and execute the blocks you pass to the GCD queue. This means if you call your <code>FMDatabaseQueue</code>'s methods from multiple threads at the same time GDC will execute them in the order they are received. This means queries and updates won't step on each other's toes, and every one is happy.</p> <h2>Making custom sqlite functions, based on blocks.</h2> +<p>You can do this! For an example, look for <code>makeFunctionNamed:</code> in main.m</p> -<p>You can do this! For an example, look for "makeFunctionNamed:" in main.m</p> +<h2>Swift</h2> +<p> You can use FMDB in Swift projects, too. To do this, you should: </p> +<ol> +<li>Copy the FMDB .m and .h files into your project. </li> +<li>If prompted to create a "bridging header", you should do so. If not prompted and if you don't already have a bridging header, add one. For more information on bridging headers, see <a href="https://developer.apple.com/library/ios/documentation/Swift/Conceptual/BuildingCocoaApps/MixandMatch.html#//apple_ref/doc/uid/TP40014216-CH10-XID_76">Swift and Objective-C in the Same Project</a>. </li> +<li>In your bridging header, add a line that says: <br /> +<pre><code>#import "FMDB.h" </code></pre></li> +<li>Use the variations of <code>executeQuery</code> and <code>executeUpdate</code> with the sql and values parameters with try pattern, as shown below. +</p></ol> + +<p>These renditions of <code>executeQuery</code> and <code>executeUpdate</code> both throw errors in true Swift 2 fashion. If you do the above, you can then write Swift code that uses <code>FMDatabase</code>. For example: </p> + +<pre><code>let documents = try! NSFileManager.defaultManager().URLForDirectory(.DocumentDirectory, inDomain: .UserDomainMask, appropriateForURL: nil, create: false) +let fileURL = documents.URLByAppendingPathComponent("test.sqlite") +let database = FMDatabase(path: fileURL.path) + +if !database.open() { + print("Unable to open database") + return +} + +do { + try database.executeUpdate("create table test(x text, y text, z text)", values: nil) + try database.executeUpdate("insert into test (x, y, z) values (?, ?, ?)", values: ["a", "b", "c"]) + try database.executeUpdate("insert into test (x, y, z) values (?, ?, ?)", values: ["e", "f", "g"]) + + let rs = try database.executeQuery("select x, y, z from test", values: nil) + while rs.next() { + let x = rs.stringForColumn("x") + let y = rs.stringForColumn("y") + let z = rs.stringForColumn("z") + print("x = \(x); y = \(y); z = \(z)") + } +} catch let error as NSError { + print("failed: \(error.localizedDescription)") +} + +database.close()</code></pre> <h2>History</h2> <p>The history and changes are availbe on its <a href="https://github.com/ccgus/fmdb">GitHub page</a> and are summarized in the "CHANGES_AND_TODO_LIST.txt" file.</p> |