diff options
| author | August "Gus" Mueller <gus@flyingmeat.com> | 2015-01-26 00:49:52 +0300 |
|---|---|---|
| committer | August "Gus" Mueller <gus@flyingmeat.com> | 2015-01-26 00:49:52 +0300 |
| commit | fd875dcca5d7302853cbe6b47f0dfaf68a4f69b2 (patch) | |
| tree | 12e327e682a5990b04aac1a51ced3bae082bc94f | |
| parent | 60f043679cbcffddab688ef67bbe85d73696e264 (diff) | |
| parent | f954bad94331d1a1befbaf507f7af9671b6bdb3d (diff) | |
Merge pull request #338 from robertmryan/gh-pages
Updated documentation
25 files changed, 11615 insertions, 11284 deletions
diff --git a/html/Blocks/FMDBExecuteStatementsCallbackBlock.html b/html/Blocks/FMDBExecuteStatementsCallbackBlock.html new file mode 100644 index 0000000..c07248c --- /dev/null +++ b/html/Blocks/FMDBExecuteStatementsCallbackBlock.html @@ -0,0 +1,96 @@ +<!DOCTYPE html> +<html> +<head> + <meta charset="utf-8"> + + <title>FMDBExecuteStatementsCallbackBlock Block Reference</title> + + <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)"> +</head> +<body class="appledoc"> + <header> + <div class="container" class="hide-in-xcode"> + + <h1 id="library-title"> + <a href="../index.html">FMDB </a> + </h1> + + <p id="developer-home"> + <a href="../index.html">ccgus</a> + </p> + + </div> + </header> + + <aside> + <div class="container"> + <nav> + <ul id="header-buttons" role="toolbar"> + <li><a href="../index.html">Index</a></li> +<li><a href="../hierarchy.html">Hierarchy</a></li> + + <li id="on-this-page" role="navigation"> + <label> + On This Page + + <div class="chevron"> + <div class="chevy chevron-left"></div> + <div class="chevy chevron-right"></div> + </div> + + <select id="jump-to"> + <option value="top">Jump To…</option> + + + + + +</select> + </label> + </li> + </ul> + </nav> + </div> + </aside> + + <article> + <div id="overview_contents" class="container"> + <div id="content"> + <main role="main"> + <h1 class="title">FMDBExecuteStatementsCallbackBlock Block Reference</h1> + + + <div class="section section-specification"><table cellspacing="0"><tbody> + <tr> + <th>Declared in</th> + <td>FMDatabase.h</td> +</tr> + </tbody></table></div> + + + + + + + + </main> + + <footer> + <div class="footer-copyright"> + + <p class="copyright">Copyright © 2015 ccgus. All rights reserved. Updated: 2015-01-25</p> + + + <p class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.2.1 (build 1333)</a>.</p> + + </div> + </footer> + </div> + </div> + </article> + + <script src="../js/script.js"></script> +</body> +</html>
\ No newline at end of file diff --git a/html/Categories/FMDatabase+FMDatabaseAdditions.html b/html/Categories/FMDatabase+FMDatabaseAdditions.html index 700a9eb..45965ce 100644 --- a/html/Categories/FMDatabase+FMDatabaseAdditions.html +++ b/html/Categories/FMDatabase+FMDatabaseAdditions.html @@ -1,183 +1,130 @@ -<!DOCTYPE HTML> +<!DOCTYPE html> <html> - <head> - <meta http-equiv="Content-Type" content="html/html; charset=utf-8" /> - <title>FMDatabase(FMDatabaseAdditions) Category Reference</title> - <meta id="xcode-display" name="xcode-display" content="render"/> - <meta name="viewport" content="width=550" /> - <link rel="stylesheet" type="text/css" href="../css/styles.css" media="all" /> - <link rel="stylesheet" type="text/css" media="print" href="../css/stylesPrint.css" /> - <meta name="generator" content="appledoc 2.1 (build 858)" /> - </head> - <body> - <header id="top_header"> - <div id="library" class="hideInXcode"> - <h1><a id="libraryTitle" href="../index.html">FMDB </a></h1> - <a id="developerHome" href="../index.html">ccgus</a> - </div> - - <div id="title" role="banner"> - <h1 class="hideInXcode">FMDatabase(FMDatabaseAdditions) Category Reference</h1> - </div> - <ul id="headerButtons" role="toolbar"> - <li id="toc_button"> - <button aria-label="Show Table of Contents" role="checkbox" class="open" id="table_of_contents"><span class="disclosure"></span>Table of Contents</button> - </li> - <li id="jumpto_button" role="navigation"> - <select id="jumpTo"> - <option value="top">Jump To…</option> - - <option value="overview">Overview</option> - - - - - <option value="tasks">Tasks</option> - - - - - - - - - - <option value="instance_methods">Instance Methods</option> - - <option value="//api/name/applicationID"> - applicationID</option> - - <option value="//api/name/applicationIDString"> - applicationIDString</option> - - <option value="//api/name/boolForQuery:"> - boolForQuery:</option> - - <option value="//api/name/columnExists:columnName:"> - columnExists:columnName:</option> - - <option value="//api/name/columnExists:inTableWithName:"> - columnExists:inTableWithName:</option> - - <option value="//api/name/dataForQuery:"> - dataForQuery:</option> - - <option value="//api/name/dateForQuery:"> - dateForQuery:</option> - - <option value="//api/name/doubleForQuery:"> - doubleForQuery:</option> - - <option value="//api/name/getSchema"> - getSchema</option> - - <option value="//api/name/getTableSchema:"> - getTableSchema:</option> - - <option value="//api/name/intForQuery:"> - intForQuery:</option> - - <option value="//api/name/longForQuery:"> - longForQuery:</option> - - <option value="//api/name/setApplicationID:"> - setApplicationID:</option> - - <option value="//api/name/setApplicationIDString:"> - setApplicationIDString:</option> - - <option value="//api/name/setUserVersion:"> - setUserVersion:</option> - - <option value="//api/name/stringForQuery:"> - stringForQuery:</option> - - <option value="//api/name/tableExists:"> - tableExists:</option> - - <option value="//api/name/userVersion"> - userVersion</option> - - <option value="//api/name/validateSQL:error:"> - validateSQL:error:</option> - - - -</select> - </li> - </ul> - </header> - <nav id="tocContainer" class="isShowingTOC"> - <ul id="toc" role="tree"> - -<li role="treeitem"><span class="nodisclosure"></span><span class="sectionName"><a href="#overview">Overview</a></span></li> - - - - -<li role="treeitem" id="task_treeitem"><span class="nodisclosure"></span><span class="sectionName"><a href="#tasks">Tasks</a></span><ul> - -</ul></li> - - +<head> + <meta charset="utf-8"> + <title>FMDatabase(FMDatabaseAdditions) Category Reference</title> + <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)"> +</head> +<body class="appledoc"> + <header> + <div class="container" class="hide-in-xcode"> + + <h1 id="library-title"> + <a href="../index.html">FMDB </a> + </h1> + <p id="developer-home"> + <a href="../index.html">ccgus</a> + </p> + + </div> + </header> + <aside> + <div class="container"> + <nav> + <ul id="header-buttons" role="toolbar"> + <li><a href="../index.html">Index</a></li> +<li><a href="../hierarchy.html">Hierarchy</a></li> + <li id="on-this-page" role="navigation"> + <label> + On This Page + <div class="chevron"> + <div class="chevy chevron-left"></div> + <div class="chevy chevron-right"></div> + </div> -<li role="treeitem" class="children"><span class="disclosure"></span><span class="sectionName"><a href="#instance_methods">Instance Methods</a></span><ul> - - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/applicationID">applicationID</a></span></li> - - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/applicationIDString">applicationIDString</a></span></li> - - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/boolForQuery:">boolForQuery:</a></span></li> - - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/columnExists:columnName:">columnExists:columnName:</a></span></li> - - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/columnExists:inTableWithName:">columnExists:inTableWithName:</a></span></li> - - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/dataForQuery:">dataForQuery:</a></span></li> - - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/dateForQuery:">dateForQuery:</a></span></li> - - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/doubleForQuery:">doubleForQuery:</a></span></li> + <select id="jump-to"> + <option value="top">Jump To…</option> - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/getSchema">getSchema</a></span></li> + <option value="overview">Overview</option> - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/getTableSchema:">getTableSchema:</a></span></li> + - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/intForQuery:">intForQuery:</a></span></li> - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/longForQuery:">longForQuery:</a></span></li> + <option value="tasks">Tasks</option> - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/setApplicationID:">setApplicationID:</a></span></li> - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/setApplicationIDString:">setApplicationIDString:</a></span></li> + - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/setUserVersion:">setUserVersion:</a></span></li> - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/stringForQuery:">stringForQuery:</a></span></li> + - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/tableExists:">tableExists:</a></span></li> + - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/userVersion">userVersion</a></span></li> + <optgroup label="Instance Methods"> + + <option value="//api/name/applicationID">- applicationID</option> + + <option value="//api/name/applicationIDString">- applicationIDString</option> + + <option value="//api/name/boolForQuery:">- boolForQuery:</option> + + <option value="//api/name/columnExists:columnName:">- columnExists:columnName:</option> + + <option value="//api/name/columnExists:inTableWithName:">- columnExists:inTableWithName:</option> + + <option value="//api/name/dataForQuery:">- dataForQuery:</option> + + <option value="//api/name/dateForQuery:">- dateForQuery:</option> + + <option value="//api/name/doubleForQuery:">- doubleForQuery:</option> + + <option value="//api/name/getSchema">- getSchema</option> + + <option value="//api/name/getTableSchema:">- getTableSchema:</option> + + <option value="//api/name/intForQuery:">- intForQuery:</option> + + <option value="//api/name/longForQuery:">- longForQuery:</option> + + <option value="//api/name/setApplicationID:">- setApplicationID:</option> + + <option value="//api/name/setApplicationIDString:">- setApplicationIDString:</option> + + <option value="//api/name/setUserVersion:">- setUserVersion:</option> + + <option value="//api/name/stringForQuery:">- stringForQuery:</option> + + <option value="//api/name/tableExists:">- tableExists:</option> + + <option value="//api/name/userVersion">- userVersion</option> + + <option value="//api/name/validateSQL:error:">- validateSQL:error:</option> + + </optgroup> - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/validateSQL:error:">validateSQL:error:</a></span></li> -</ul></li> - - - </ul> - </nav> - <article> - <div id="contents" class="isShowingTOC" role="main"> - <a title="FMDatabase(FMDatabaseAdditions) Category Reference" name="top"></a> - <div class="main-navigation navigation-top"> - <ul> - <li><a href="../index.html">Index</a></li> - <li><a href="../hierarchy.html">Hierarchy</a></li> -</ul> - </div> - <div id="header"> - <div class="section-header"> - <h1 class="title title-header">FMDatabase(FMDatabaseAdditions) Category Reference</h1> - </div> - </div> - <div id="container"> +</select> + </label> + </li> + </ul> + </nav> + </div> + </aside> + + <article> + <div id="overview_contents" class="container"> + <div id="content"> + <main role="main"> + <h1 class="title">FMDatabase(FMDatabaseAdditions) Category Reference</h1> + <div class="section section-specification"><table cellspacing="0"><tbody> <tr> - <td class="specification-title">Declared in</td> - <td class="specification-value">FMDatabaseAdditions.h<br />FMDatabaseAdditions.m</td> + <th>Declared in</th> + <td>FMDatabaseAdditions.h<br />FMDatabaseAdditions.m</td> </tr> </tbody></table></div> - - + + <div class="section section-overview"> <a title="Overview" name="overview"></a> @@ -193,648 +140,593 @@ </div> - + <div class="section section-tasks"> <a title="Tasks" name="tasks"></a> - <h2 class="subtitle subtitle-tasks">Tasks</h2> - - - - <ul class="task-list"> - <li> - <span class="tooltip"> - <code><a href="#//api/name/stringForQuery:">– stringForQuery:</a></code> - <span class="tooltip"><p>Return <code>NSString</code> value for query</p></span> - </span> - - -</li><li> - <span class="tooltip"> - <code><a href="#//api/name/intForQuery:">– intForQuery:</a></code> - <span class="tooltip"><p>Return <code>int</code> value for query</p></span> - </span> - - -</li><li> - <span class="tooltip"> - <code><a href="#//api/name/longForQuery:">– longForQuery:</a></code> - <span class="tooltip"><p>Return <code>long</code> value for query</p></span> - </span> - - -</li><li> - <span class="tooltip"> - <code><a href="#//api/name/boolForQuery:">– boolForQuery:</a></code> - <span class="tooltip"><p>Return <code>BOOL</code> value for query</p></span> - </span> - - -</li><li> - <span class="tooltip"> - <code><a href="#//api/name/doubleForQuery:">– doubleForQuery:</a></code> - <span class="tooltip"><p>Return <code>double</code> value for query</p></span> - </span> - - -</li><li> - <span class="tooltip"> - <code><a href="#//api/name/dataForQuery:">– dataForQuery:</a></code> - <span class="tooltip"><p>Return <code>NSData</code> value for query</p></span> - </span> - - -</li><li> - <span class="tooltip"> - <code><a href="#//api/name/dateForQuery:">– dateForQuery:</a></code> - <span class="tooltip"><p>Return <code>NSDate</code> value for query</p></span> - </span> - - -</li><li> - <span class="tooltip"> - <code><a href="#//api/name/tableExists:">– tableExists:</a></code> - <span class="tooltip"><p>Does table exist in database?</p></span> - </span> - - -</li><li> - <span class="tooltip"> - <code><a href="#//api/name/getSchema">– getSchema</a></code> - <span class="tooltip"><p>The schema of the database.</p></span> - </span> - - -</li><li> - <span class="tooltip"> - <code><a href="#//api/name/getTableSchema:">– getTableSchema:</a></code> - <span class="tooltip"><p>The schema of the database.</p></span> - </span> - - -</li><li> - <span class="tooltip"> - <code><a href="#//api/name/columnExists:inTableWithName:">– columnExists:inTableWithName:</a></code> - <span class="tooltip"><p>Test to see if particular column exists for particular table in database</p></span> - </span> - - -</li><li> - <span class="tooltip"> - <code><a href="#//api/name/applicationID">– applicationID</a></code> - <span class="tooltip"><p>Retrieve application ID</p></span> - </span> - - -</li><li> - <span class="tooltip"> - <code><a href="#//api/name/setApplicationID:">– setApplicationID:</a></code> - <span class="tooltip"><p>Set the application ID</p></span> - </span> - - -</li><li> - <span class="tooltip"> - <code><a href="#//api/name/applicationIDString">– applicationIDString</a></code> - <span class="tooltip"><p>Retrieve application ID string</p></span> - </span> - - -</li><li> - <span class="tooltip"> - <code><a href="#//api/name/setApplicationIDString:">– setApplicationIDString:</a></code> - <span class="tooltip"><p>Set the application ID string</p></span> - </span> - - -</li><li> - <span class="tooltip"> - <code><a href="#//api/name/userVersion">– userVersion</a></code> - <span class="tooltip"><p>Retrieve user version</p></span> - </span> - - -</li><li> - <span class="tooltip"> - <code><a href="#//api/name/setUserVersion:">– setUserVersion:</a></code> - <span class="tooltip"><p>Set the user-version</p></span> - </span> - - -</li><li> - <span class="tooltip"> - <code><a href="#//api/name/columnExists:columnName:">– columnExists:columnName:</a></code> - <span class="tooltip"><p>Test to see if particular column exists for particular table in database</p></span> - </span> - - -</li><li> - <span class="tooltip"> - <code><a href="#//api/name/validateSQL:error:">– validateSQL:error:</a></code> - <span class="tooltip"><p>Validate SQL statement</p></span> - </span> - - -</li> - </ul> - </div> - - - - - - - - - - <div class="section section-methods"> - <a title="Instance Methods" name="instance_methods"></a> - <h2 class="subtitle subtitle-methods">Instance Methods</h2> - <div class="section-method"> - <a name="//api/name/applicationID" title="applicationID"></a> - <h3 class="subsubtitle method-title">applicationID</h3> - - - - <div class="method-subsection brief-description"> - <p>Retrieve application ID</p> - </div> - - - <div class="method-subsection method-declaration"><code>- (uint32_t)applicationID</code></div> + <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> +</h3> - - - - - <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> - </div> - - - - - - - - - - <div class="method-subsection see-also-section"> - <h4 class="method-subtitle">See Also</h4> - <ul> + <div class="method-info"> + <div class="pointy-thing"></div> + + <div class="method-info-container"> + + + <div class="method-subsection brief-description"> + <p>Return <code>NSString</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 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>query</code></th> + <td><p>The SQL query to be performed.</p></td> + </tr> + + <tr> + <th scope="row" class="argument-name"><code>...</code></th> + <td><p>A list of parameters that will be bound to the <code>?</code> placeholders in the SQL query.</p></td> + </tr> + + </table> + </div> + + + + <div class="method-subsection return"> + <h4 class="method-subtitle parameter-title">Return Value</h4> + <p><code>NSString</code> value.</p> + </div> + + + + + + <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> + </div> + + + + + + + + <div class="method-subsection declared-in-section"> + <h4 class="method-subtitle">Declared In</h4> + <p><code class="declared-in-ref">FMDatabaseAdditions.h</code></p> + </div> - <li><code><p><a href="#//api/name/setApplicationID:">- setApplicationID:</a></p></code></li> - </ul> + </div> </div> - - - - <div class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMDatabaseAdditions.h</code><br /> - </div> - - -</div> - - <div class="section-method"> - <a name="//api/name/applicationIDString" title="applicationIDString"></a> - <h3 class="subsubtitle method-title">applicationIDString</h3> - - - - <div class="method-subsection brief-description"> - <p>Retrieve application ID string</p> - </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> +</h3> - <div class="method-subsection method-declaration"><code>- (NSString *)applicationIDString</code></div> + <div class="method-info"> + <div class="pointy-thing"></div> - - - - - <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> + <div class="method-info-container"> + + + <div class="method-subsection brief-description"> + <p>Return <code>int</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 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>query</code></th> + <td><p>The SQL query to be performed.</p></td> + </tr> + + <tr> + <th scope="row" class="argument-name"><code>...</code></th> + <td><p>A list of parameters that will be bound to the <code>?</code> placeholders in the SQL query.</p></td> + </tr> + + </table> + </div> + + + + <div class="method-subsection return"> + <h4 class="method-subtitle parameter-title">Return Value</h4> + <p><code>int</code> value.</p> + </div> + + + + + + <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> + </div> + + + + + + + + <div class="method-subsection declared-in-section"> + <h4 class="method-subtitle">Declared In</h4> + <p><code class="declared-in-ref">FMDatabaseAdditions.h</code></p> + </div> + + + </div> </div> - - - - - - - - - - <div class="method-subsection see-also-section"> - <h4 class="method-subtitle">See Also</h4> - <ul> +</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> +</h3> + + <div class="method-info"> + <div class="pointy-thing"></div> + + <div class="method-info-container"> + + + <div class="method-subsection brief-description"> + <p>Return <code>long</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 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>query</code></th> + <td><p>The SQL query to be performed.</p></td> + </tr> + + <tr> + <th scope="row" class="argument-name"><code>...</code></th> + <td><p>A list of parameters that will be bound to the <code>?</code> placeholders in the SQL query.</p></td> + </tr> + + </table> + </div> + + + + <div class="method-subsection return"> + <h4 class="method-subtitle parameter-title">Return Value</h4> + <p><code>long</code> value.</p> + </div> - <li><code><p><a href="#//api/name/setApplicationIDString:">- setApplicationIDString:</a></p></code></li> + + + + + <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> + </div> - </ul> + + + + + + + <div class="method-subsection declared-in-section"> + <h4 class="method-subtitle">Declared In</h4> + <p><code class="declared-in-ref">FMDatabaseAdditions.h</code></p> + </div> + + + </div> </div> - - - - <div class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMDatabaseAdditions.h</code><br /> - </div> - - -</div> - - <div class="section-method"> +</div><div class="section-method"> <a name="//api/name/boolForQuery:" title="boolForQuery:"></a> - <h3 class="subsubtitle method-title">boolForQuery:</h3> - - - - <div class="method-subsection brief-description"> - <p>Return <code>BOOL</code> value for query</p> - </div> - - + <h3 class="method-title"><code><a href="#//api/name/boolForQuery:">– boolForQuery:</a></code> +</h3> - <div class="method-subsection method-declaration"><code>- (BOOL)boolForQuery:(NSString *)<em>query</em>, <em>...</em></code></div> + <div class="method-info"> + <div class="pointy-thing"></div> - - - <div class="method-subsection arguments-section parameters"> - <h4 class="method-subtitle parameter-title">Parameters</h4> - - <dl class="argument-def parameter-def"> - <dt><em>query</em></dt> - <dd><p>The SQL query to be performed.</p></dd> - </dl> - - <dl class="argument-def parameter-def"> - <dt><em>...</em></dt> - <dd><p>A list of parameters that will be bound to the <code>?</code> placeholders in the SQL query.</p></dd> - </dl> - - </div> - - - - <div class="method-subsection return"> - <h4 class="method-subtitle parameter-title">Return Value</h4> - <p><code>BOOL</code> value.</p> - </div> - - - - - - - - - - - - <div class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMDatabaseAdditions.h</code><br /> - </div> - - -</div> - - <div class="section-method"> - <a name="//api/name/columnExists:columnName:" title="columnExists:columnName:"></a> - <h3 class="subsubtitle method-title">columnExists:columnName:</h3> - - - - <div class="method-subsection brief-description"> - <p>Test to see if particular column exists for particular table in database</p> - </div> - - + <div class="method-info-container"> + + + <div class="method-subsection brief-description"> + <p>Return <code>BOOL</code> value for query</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>- (BOOL)boolForQuery:(NSString *)<em>query</em>, <em>...</em></code></div> - - - <div class="method-subsection arguments-section parameters"> - <h4 class="method-subtitle parameter-title">Parameters</h4> - - <dl class="argument-def parameter-def"> - <dt><em>tableName</em></dt> - <dd><p>The name of the table.</p></dd> - </dl> - - <dl class="argument-def parameter-def"> - <dt><em>columnName</em></dt> - <dd><p>The name of the column.</p></dd> - </dl> - - </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> - </div> - - - - - - <div class="method-subsection discussion-section"> - <h4 class="method-subtitle">Discussion</h4> - <div class="warning"><p><strong>Warning:</strong> Deprecated - use <a href="#//api/name/columnExists:inTableWithName:"><code>columnExists:inTableWithName:</code></a> instead.</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/columnExists:inTableWithName:">- columnExists:inTableWithName:</a></p></code></li> + <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>query</code></th> + <td><p>The SQL query to be performed.</p></td> + </tr> + + <tr> + <th scope="row" class="argument-name"><code>...</code></th> + <td><p>A list of parameters that will be bound to the <code>?</code> placeholders in the SQL query.</p></td> + </tr> + + </table> + </div> - </ul> - </div> - - - - <div class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMDatabaseAdditions.h</code><br /> - </div> - - -</div> - - <div class="section-method"> - <a name="//api/name/columnExists:inTableWithName:" title="columnExists:inTableWithName:"></a> - <h3 class="subsubtitle method-title">columnExists:inTableWithName:</h3> - - - - <div class="method-subsection brief-description"> - <p>Test to see if particular column exists for particular table in database</p> - </div> - - - <div class="method-subsection method-declaration"><code>- (BOOL)columnExists:(NSString *)<em>columnName</em> inTableWithName:(NSString *)<em>tableName</em></code></div> + + <div class="method-subsection return"> + <h4 class="method-subtitle parameter-title">Return Value</h4> + <p><code>BOOL</code> value.</p> + </div> + - - - <div class="method-subsection arguments-section parameters"> - <h4 class="method-subtitle parameter-title">Parameters</h4> - - <dl class="argument-def parameter-def"> - <dt><em>columnName</em></dt> - <dd><p>The name of the column.</p></dd> - </dl> - - <dl class="argument-def parameter-def"> - <dt><em>tableName</em></dt> - <dd><p>The name of the table.</p></dd> - </dl> - + + + + <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> + </div> + + + + + + + + <div class="method-subsection declared-in-section"> + <h4 class="method-subtitle">Declared In</h4> + <p><code class="declared-in-ref">FMDatabaseAdditions.h</code></p> + </div> + + + </div> </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> +</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> +</h3> + + <div class="method-info"> + <div class="pointy-thing"></div> + + <div class="method-info-container"> + + + <div class="method-subsection brief-description"> + <p>Return <code>double</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 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>query</code></th> + <td><p>The SQL query to be performed.</p></td> + </tr> + + <tr> + <th scope="row" class="argument-name"><code>...</code></th> + <td><p>A list of parameters that will be bound to the <code>?</code> placeholders in the SQL query.</p></td> + </tr> + + </table> + </div> + + + + <div class="method-subsection return"> + <h4 class="method-subtitle parameter-title">Return Value</h4> + <p><code>double</code> value.</p> + </div> + + + + + + <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> + </div> + + + + + + + + <div class="method-subsection declared-in-section"> + <h4 class="method-subtitle">Declared In</h4> + <p><code class="declared-in-ref">FMDatabaseAdditions.h</code></p> + </div> + + + </div> </div> - - - - - - - - - - - - <div class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMDatabaseAdditions.h</code><br /> - </div> - - -</div> - - <div class="section-method"> +</div><div class="section-method"> <a name="//api/name/dataForQuery:" title="dataForQuery:"></a> - <h3 class="subsubtitle method-title">dataForQuery:</h3> - - - - <div class="method-subsection brief-description"> - <p>Return <code>NSData</code> value for query</p> - </div> - - + <h3 class="method-title"><code><a href="#//api/name/dataForQuery:">– dataForQuery:</a></code> +</h3> - <div class="method-subsection method-declaration"><code>- (NSData *)dataForQuery:(NSString *)<em>query</em>, <em>...</em></code></div> + <div class="method-info"> + <div class="pointy-thing"></div> - - - <div class="method-subsection arguments-section parameters"> - <h4 class="method-subtitle parameter-title">Parameters</h4> - - <dl class="argument-def parameter-def"> - <dt><em>query</em></dt> - <dd><p>The SQL query to be performed.</p></dd> - </dl> - - <dl class="argument-def parameter-def"> - <dt><em>...</em></dt> - <dd><p>A list of parameters that will be bound to the <code>?</code> placeholders in the SQL query.</p></dd> - </dl> - - </div> - - - - <div class="method-subsection return"> - <h4 class="method-subtitle parameter-title">Return Value</h4> - <p><code>NSData</code> value.</p> + <div class="method-info-container"> + + + <div class="method-subsection brief-description"> + <p>Return <code>NSData</code> value for query</p> + </div> + + + + <div class="method-subsection method-declaration"><code>- (NSData *)dataForQuery:(NSString *)<em>query</em>, <em>...</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>query</code></th> + <td><p>The SQL query to be performed.</p></td> + </tr> + + <tr> + <th scope="row" class="argument-name"><code>...</code></th> + <td><p>A list of parameters that will be bound to the <code>?</code> placeholders in the SQL query.</p></td> + </tr> + + </table> + </div> + + + + <div class="method-subsection return"> + <h4 class="method-subtitle parameter-title">Return Value</h4> + <p><code>NSData</code> value.</p> + </div> + + + + + + <div class="method-subsection discussion-section"> + <h4 class="method-subtitle">Discussion</h4> + <p>Return <code>NSData</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> + + + + + + + + <div class="method-subsection declared-in-section"> + <h4 class="method-subtitle">Declared In</h4> + <p><code class="declared-in-ref">FMDatabaseAdditions.h</code></p> + </div> + + + </div> </div> - - - - - - - - - - - - <div class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMDatabaseAdditions.h</code><br /> - </div> - - -</div> - - <div class="section-method"> +</div><div class="section-method"> <a name="//api/name/dateForQuery:" title="dateForQuery:"></a> - <h3 class="subsubtitle method-title">dateForQuery:</h3> - - - - <div class="method-subsection brief-description"> - <p>Return <code>NSDate</code> value for query</p> - </div> - - + <h3 class="method-title"><code><a href="#//api/name/dateForQuery:">– dateForQuery:</a></code> +</h3> - <div class="method-subsection method-declaration"><code>- (NSDate *)dateForQuery:(NSString *)<em>query</em>, <em>...</em></code></div> + <div class="method-info"> + <div class="pointy-thing"></div> - - - <div class="method-subsection arguments-section parameters"> - <h4 class="method-subtitle parameter-title">Parameters</h4> - - <dl class="argument-def parameter-def"> - <dt><em>query</em></dt> - <dd><p>The SQL query to be performed.</p></dd> - </dl> - - <dl class="argument-def parameter-def"> - <dt><em>...</em></dt> - <dd><p>A list of parameters that will be bound to the <code>?</code> placeholders in the SQL query.</p></dd> - </dl> - - </div> - - - - <div class="method-subsection return"> - <h4 class="method-subtitle parameter-title">Return Value</h4> - <p><code>NSDate</code> value.</p> - </div> - - - - - - - - - - - - <div class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMDatabaseAdditions.h</code><br /> - </div> - - -</div> - - <div class="section-method"> - <a name="//api/name/doubleForQuery:" title="doubleForQuery:"></a> - <h3 class="subsubtitle method-title">doubleForQuery:</h3> - - - - <div class="method-subsection brief-description"> - <p>Return <code>double</code> value for query</p> - </div> - - + <div class="method-info-container"> + + + <div class="method-subsection brief-description"> + <p>Return <code>NSDate</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>- (NSDate *)dateForQuery:(NSString *)<em>query</em>, <em>...</em></code></div> - - - <div class="method-subsection arguments-section parameters"> - <h4 class="method-subtitle parameter-title">Parameters</h4> - - <dl class="argument-def parameter-def"> - <dt><em>query</em></dt> - <dd><p>The SQL query to be performed.</p></dd> - </dl> - - <dl class="argument-def parameter-def"> - <dt><em>...</em></dt> - <dd><p>A list of parameters that will be bound to the <code>?</code> placeholders in the SQL query.</p></dd> - </dl> - + + + <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>query</code></th> + <td><p>The SQL query to be performed.</p></td> + </tr> + + <tr> + <th scope="row" class="argument-name"><code>...</code></th> + <td><p>A list of parameters that will be bound to the <code>?</code> placeholders in the SQL query.</p></td> + </tr> + + </table> + </div> + + + + <div class="method-subsection return"> + <h4 class="method-subtitle parameter-title">Return Value</h4> + <p><code>NSDate</code> value.</p> + </div> + + + + + + <div class="method-subsection discussion-section"> + <h4 class="method-subtitle">Discussion</h4> + <p>Return <code>NSDate</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> + + + + + + + + <div class="method-subsection declared-in-section"> + <h4 class="method-subtitle">Declared In</h4> + <p><code class="declared-in-ref">FMDatabaseAdditions.h</code></p> + </div> + + + </div> </div> - - - - <div class="method-subsection return"> - <h4 class="method-subtitle parameter-title">Return Value</h4> - <p><code>double</code> value.</p> +</div><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> + + <div class="method-info"> + <div class="pointy-thing"></div> + + <div class="method-info-container"> + + + <div class="method-subsection brief-description"> + <p>Does table exist in database?</p> + </div> + + + + <div class="method-subsection method-declaration"><code>- (BOOL)tableExists:(NSString *)<em>tableName</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 being looked for.</p></td> + </tr> + + </table> + </div> + + + + <div class="method-subsection return"> + <h4 class="method-subtitle parameter-title">Return Value</h4> + <p><code>YES</code> if table found; <code>NO</code> if not found.</p> + </div> + + + + + + <div class="method-subsection discussion-section"> + <h4 class="method-subtitle">Discussion</h4> + <p>Does table exist in database?</p> + </div> + + + + + + + + <div class="method-subsection declared-in-section"> + <h4 class="method-subtitle">Declared In</h4> + <p><code class="declared-in-ref">FMDatabaseAdditions.h</code></p> + </div> + + + </div> </div> - - - - - - - - - - - - <div class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMDatabaseAdditions.h</code><br /> - </div> - - -</div> - - <div class="section-method"> +</div><div class="section-method"> <a name="//api/name/getSchema" title="getSchema"></a> - <h3 class="subsubtitle method-title">getSchema</h3> - - - - <div class="method-subsection brief-description"> - <p>The schema of the database.</p> - </div> - - + <h3 class="method-title"><code><a href="#//api/name/getSchema">– getSchema</a></code> +</h3> - <div class="method-subsection method-declaration"><code>- (FMResultSet *)getSchema</code></div> + <div class="method-info"> + <div class="pointy-thing"></div> - - - - - <div class="method-subsection return"> - <h4 class="method-subtitle parameter-title">Return Value</h4> - <p><code>FMResultSet</code> of schema; <code>nil</code> on error.</p> - </div> - - - - - - <div class="method-subsection discussion-section"> - <h4 class="method-subtitle">Discussion</h4> - <p>This will be the schema for the entire database. For each entity, each row of the result set will include the following fields:</p> + <div class="method-info-container"> + + + <div class="method-subsection brief-description"> + <p>The schema of the database.</p> + </div> + + + + <div class="method-subsection method-declaration"><code>- (FMResultSet *)getSchema</code></div> + + + + + + <div class="method-subsection return"> + <h4 class="method-subtitle parameter-title">Return Value</h4> + <p><code>FMResultSet</code> of schema; <code>nil</code> on error.</p> + </div> + + + + + + <div class="method-subsection discussion-section"> + <h4 class="method-subtitle">Discussion</h4> + <p>The schema of the database.</p> + +<p>This will be the schema for the entire database. For each entity, each row of the result set will include the following fields:</p> <ul> <li><code>type</code> - The type of entity (e.g. table, index, view, or trigger)</li> @@ -844,71 +736,80 @@ <li><code>sql</code> - The SQL that created the entity</li> </ul> - </div> - - - - - - <div class="method-subsection see-also-section"> - <h4 class="method-subtitle">See Also</h4> - <ul> + </div> + + + + + + <div class="method-subsection see-also-section"> + <h4 class="method-subtitle">See Also</h4> + <ul> + + <li><code><p><a href="http://www.sqlite.org/fileformat.html">SQLite File Format</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">FMDatabaseAdditions.h</code></p> + </div> - <li><code><p><a href="http://www.sqlite.org/fileformat.html">SQLite File Format</a></p></code></li> - </ul> + </div> </div> - - - - <div class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMDatabaseAdditions.h</code><br /> - </div> - - -</div> - - <div class="section-method"> +</div><div class="section-method"> <a name="//api/name/getTableSchema:" title="getTableSchema:"></a> - <h3 class="subsubtitle method-title">getTableSchema:</h3> - - - - <div class="method-subsection brief-description"> - <p>The schema of the database.</p> - </div> - - + <h3 class="method-title"><code><a href="#//api/name/getTableSchema:">– getTableSchema:</a></code> +</h3> - <div class="method-subsection method-declaration"><code>- (FMResultSet *)getTableSchema:(NSString *)<em>tableName</em></code></div> + <div class="method-info"> + <div class="pointy-thing"></div> - - - <div class="method-subsection arguments-section parameters"> - <h4 class="method-subtitle parameter-title">Parameters</h4> - - <dl class="argument-def parameter-def"> - <dt><em>tableName</em></dt> - <dd><p>The name of the table for whom the schema will be returned.</p></dd> - </dl> - - </div> - - - - <div class="method-subsection return"> - <h4 class="method-subtitle parameter-title">Return Value</h4> - <p><code>FMResultSet</code> of schema; <code>nil</code> on error.</p> - </div> - - - - - - <div class="method-subsection discussion-section"> - <h4 class="method-subtitle">Discussion</h4> - <p>This will be the schema for a particular table as report by SQLite <code>PRAGMA</code>, for example:</p> + <div class="method-info-container"> + + + <div class="method-subsection brief-description"> + <p>The schema of the database.</p> + </div> + + + + <div class="method-subsection method-declaration"><code>- (FMResultSet *)getTableSchema:(NSString *)<em>tableName</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 for whom the schema will be returned.</p></td> + </tr> + + </table> + </div> + + + + <div class="method-subsection return"> + <h4 class="method-subtitle parameter-title">Return Value</h4> + <p><code>FMResultSet</code> of schema; <code>nil</code> on error.</p> + </div> + + + + + + <div class="method-subsection discussion-section"> + <h4 class="method-subtitle">Discussion</h4> + <p>The schema of the database.</p> + +<p>This will be the schema for a particular table as report by SQLite <code>PRAGMA</code>, for example:</p> <pre><code>PRAGMA table_info('employees') </code></pre> @@ -924,637 +825,651 @@ <li><code>pk</code> - Whether the field is part of the primary key of the table</li> </ul> - </div> - - - - - - <div class="method-subsection see-also-section"> - <h4 class="method-subtitle">See Also</h4> - <ul> + </div> - <li><code><p><a href="http://www.sqlite.org/pragma.html#pragma_table_info">table_info</a></p></code></li> + - </ul> - </div> - - - - <div class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMDatabaseAdditions.h</code><br /> - </div> - - -</div> - - <div class="section-method"> - <a name="//api/name/intForQuery:" title="intForQuery:"></a> - <h3 class="subsubtitle method-title">intForQuery:</h3> - - - - <div class="method-subsection brief-description"> - <p>Return <code>int</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 see-also-section"> + <h4 class="method-subtitle">See Also</h4> + <ul> + + <li><code><p><a href="http://www.sqlite.org/pragma.html#pragma_table_info">table_info</a></p></code></li> + + </ul> + </div> + - - - <div class="method-subsection arguments-section parameters"> - <h4 class="method-subtitle parameter-title">Parameters</h4> - - <dl class="argument-def parameter-def"> - <dt><em>query</em></dt> - <dd><p>The SQL query to be performed.</p></dd> - </dl> - - <dl class="argument-def parameter-def"> - <dt><em>...</em></dt> - <dd><p>A list of parameters that will be bound to the <code>?</code> placeholders in the SQL query.</p></dd> - </dl> - - </div> - - - - <div class="method-subsection return"> - <h4 class="method-subtitle parameter-title">Return Value</h4> - <p><code>int</code> value.</p> + + <div class="method-subsection declared-in-section"> + <h4 class="method-subtitle">Declared In</h4> + <p><code class="declared-in-ref">FMDatabaseAdditions.h</code></p> + </div> + + + </div> </div> - - - - - - - - - - - - <div class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMDatabaseAdditions.h</code><br /> - </div> - - -</div> - - <div class="section-method"> - <a name="//api/name/longForQuery:" title="longForQuery:"></a> - <h3 class="subsubtitle method-title">longForQuery:</h3> - - - - <div class="method-subsection brief-description"> - <p>Return <code>long</code> value for query</p> - </div> - - +</div><div class="section-method"> + <a name="//api/name/columnExists:inTableWithName:" title="columnExists:inTableWithName:"></a> + <h3 class="method-title"><code><a href="#//api/name/columnExists:inTableWithName:">– columnExists:inTableWithName:</a></code> +</h3> - <div class="method-subsection method-declaration"><code>- (long)longForQuery:(NSString *)<em>query</em>, <em>...</em></code></div> + <div class="method-info"> + <div class="pointy-thing"></div> - - - <div class="method-subsection arguments-section parameters"> - <h4 class="method-subtitle parameter-title">Parameters</h4> - - <dl class="argument-def parameter-def"> - <dt><em>query</em></dt> - <dd><p>The SQL query to be performed.</p></dd> - </dl> - - <dl class="argument-def parameter-def"> - <dt><em>...</em></dt> - <dd><p>A list of parameters that will be bound to the <code>?</code> placeholders in the SQL query.</p></dd> - </dl> - + <div class="method-info-container"> + + + <div class="method-subsection brief-description"> + <p>Test to see if particular column exists for particular table in database</p> + </div> + + + + <div class="method-subsection method-declaration"><code>- (BOOL)columnExists:(NSString *)<em>columnName</em> inTableWithName:(NSString *)<em>tableName</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>The name of the column.</p></td> + </tr> + + <tr> + <th scope="row" class="argument-name"><code>tableName</code></th> + <td><p>The name of the table.</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> + </div> + + + + + + <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> + + + + + + + + <div class="method-subsection declared-in-section"> + <h4 class="method-subtitle">Declared In</h4> + <p><code class="declared-in-ref">FMDatabaseAdditions.h</code></p> + </div> + + + </div> </div> - - - - <div class="method-subsection return"> - <h4 class="method-subtitle parameter-title">Return Value</h4> - <p><code>long</code> value.</p> +</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> +</h3> + + <div class="method-info"> + <div class="pointy-thing"></div> + + <div class="method-info-container"> + + + <div class="method-subsection brief-description"> + <p>Retrieve application ID</p> + </div> + + + + <div class="method-subsection method-declaration"><code>- (uint32_t)applicationID</code></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> + </div> + + + + + + <div class="method-subsection discussion-section"> + <h4 class="method-subtitle">Discussion</h4> + <p>Retrieve application ID</p> + </div> + + + + + + <div class="method-subsection see-also-section"> + <h4 class="method-subtitle">See Also</h4> + <ul> + + <li><code><p><a href="#//api/name/setApplicationID:">- setApplicationID:</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">FMDatabaseAdditions.h</code></p> + </div> + + + </div> </div> - - - - - - - - - - - - <div class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMDatabaseAdditions.h</code><br /> - </div> - - -</div> - - <div class="section-method"> +</div><div class="section-method"> <a name="//api/name/setApplicationID:" title="setApplicationID:"></a> - <h3 class="subsubtitle method-title">setApplicationID:</h3> - - - - <div class="method-subsection brief-description"> - <p>Set the application ID</p> - </div> - - + <h3 class="method-title"><code><a href="#//api/name/setApplicationID:">– setApplicationID:</a></code> +</h3> - <div class="method-subsection method-declaration"><code>- (void)setApplicationID:(uint32_t)<em>appID</em></code></div> + <div class="method-info"> + <div class="pointy-thing"></div> - - - <div class="method-subsection arguments-section parameters"> - <h4 class="method-subtitle parameter-title">Parameters</h4> - - <dl class="argument-def parameter-def"> - <dt><em>appID</em></dt> - <dd><p>The <code>uint32_t</code> numeric value of the application ID.</p></dd> - </dl> - + <div class="method-info-container"> + + + <div class="method-subsection brief-description"> + <p>Set the application ID</p> + </div> + + + + <div class="method-subsection method-declaration"><code>- (void)setApplicationID:(uint32_t)<em>appID</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>appID</code></th> + <td><p>The <code>uint32_t</code> numeric value of the application ID.</p></td> + </tr> + + </table> + </div> + + + + + + + + <div class="method-subsection discussion-section"> + <h4 class="method-subtitle">Discussion</h4> + <p>Set the application ID</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"> + <h4 class="method-subtitle">Declared In</h4> + <p><code class="declared-in-ref">FMDatabaseAdditions.h</code></p> + </div> + + + </div> </div> - - - - - - - - - - - - <div class="method-subsection see-also-section"> - <h4 class="method-subtitle">See Also</h4> - <ul> +</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> +</h3> + + <div class="method-info"> + <div class="pointy-thing"></div> + + <div class="method-info-container"> + - <li><code><p><a href="#//api/name/applicationID">- applicationID</a></p></code></li> + <div class="method-subsection brief-description"> + <p>Retrieve application ID string</p> + </div> + + + + <div class="method-subsection method-declaration"><code>- (NSString *)applicationIDString</code></div> + + + + + + <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> + </div> + + - </ul> + + + <div class="method-subsection discussion-section"> + <h4 class="method-subtitle">Discussion</h4> + <p>Retrieve application ID string</p> + </div> + + + + + + <div class="method-subsection see-also-section"> + <h4 class="method-subtitle">See Also</h4> + <ul> + + <li><code><p><a href="#//api/name/setApplicationIDString:">- setApplicationIDString:</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">FMDatabaseAdditions.h</code></p> + </div> + + + </div> </div> - - - - <div class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMDatabaseAdditions.h</code><br /> - </div> - - -</div> - - <div class="section-method"> +</div><div class="section-method"> <a name="//api/name/setApplicationIDString:" title="setApplicationIDString:"></a> - <h3 class="subsubtitle method-title">setApplicationIDString:</h3> - - - - <div class="method-subsection brief-description"> - <p>Set the application ID string</p> - </div> - - + <h3 class="method-title"><code><a href="#//api/name/setApplicationIDString:">– setApplicationIDString:</a></code> +</h3> - <div class="method-subsection method-declaration"><code>- (void)setApplicationIDString:(NSString *)<em>string</em></code></div> + <div class="method-info"> + <div class="pointy-thing"></div> - - - <div class="method-subsection arguments-section parameters"> - <h4 class="method-subtitle parameter-title">Parameters</h4> - - <dl class="argument-def parameter-def"> - <dt><em>string</em></dt> - <dd><p>The <code>NSString</code> value of the application ID.</p></dd> - </dl> - + <div class="method-info-container"> + + + <div class="method-subsection brief-description"> + <p>Set the application ID string</p> + </div> + + + + <div class="method-subsection method-declaration"><code>- (void)setApplicationIDString:(NSString *)<em>string</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>string</code></th> + <td><p>The <code>NSString</code> value of the application ID.</p></td> + </tr> + + </table> + </div> + + + + + + + + <div class="method-subsection discussion-section"> + <h4 class="method-subtitle">Discussion</h4> + <p>Set the application ID string</p> + </div> + + + + + + <div class="method-subsection see-also-section"> + <h4 class="method-subtitle">See Also</h4> + <ul> + + <li><code><p><a href="#//api/name/applicationIDString">- applicationIDString</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">FMDatabaseAdditions.h</code></p> + </div> + + + </div> </div> - - - - - - - - - - - - <div class="method-subsection see-also-section"> - <h4 class="method-subtitle">See Also</h4> - <ul> +</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> +</h3> + + <div class="method-info"> + <div class="pointy-thing"></div> + + <div class="method-info-container"> - <li><code><p><a href="#//api/name/applicationIDString">- applicationIDString</a></p></code></li> - </ul> + <div class="method-subsection brief-description"> + <p>Retrieve user version</p> + </div> + + + + <div class="method-subsection method-declaration"><code>- (uint32_t)userVersion</code></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 user version.</p> + </div> + + + + + + <div class="method-subsection discussion-section"> + <h4 class="method-subtitle">Discussion</h4> + <p>Retrieve 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/setUserVersion:">- setUserVersion:</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">FMDatabaseAdditions.h</code></p> + </div> + + + </div> </div> - - - - <div class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMDatabaseAdditions.h</code><br /> - </div> - - -</div> - - <div class="section-method"> +</div><div class="section-method"> <a name="//api/name/setUserVersion:" title="setUserVersion:"></a> - <h3 class="subsubtitle method-title">setUserVersion:</h3> - - - - <div class="method-subsection brief-description"> - <p>Set the user-version</p> - </div> - - + <h3 class="method-title"><code><a href="#//api/name/setUserVersion:">– setUserVersion:</a></code> +</h3> - <div class="method-subsection method-declaration"><code>- (void)setUserVersion:(uint32_t)<em>version</em></code></div> + <div class="method-info"> + <div class="pointy-thing"></div> - - - <div class="method-subsection arguments-section parameters"> - <h4 class="method-subtitle parameter-title">Parameters</h4> - - <dl class="argument-def parameter-def"> - <dt><em>version</em></dt> - <dd><p>The <code>uint32_t</code> numeric value of the user version.</p></dd> - </dl> - - </div> - - - - - - - - - - - - <div class="method-subsection see-also-section"> - <h4 class="method-subtitle">See Also</h4> - <ul> + <div class="method-info-container"> - <li><code><p><a href="#//api/name/userVersion">- userVersion</a></p></code></li> - </ul> - </div> - - - - <div class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMDatabaseAdditions.h</code><br /> - </div> - - -</div> - - <div class="section-method"> - <a name="//api/name/stringForQuery:" title="stringForQuery:"></a> - <h3 class="subsubtitle method-title">stringForQuery:</h3> - - - - <div class="method-subsection brief-description"> - <p>Return <code>NSString</code> value for query</p> - </div> - - + <div class="method-subsection brief-description"> + <p>Set the user-version</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>- (void)setUserVersion:(uint32_t)<em>version</em></code></div> - - - <div class="method-subsection arguments-section parameters"> - <h4 class="method-subtitle parameter-title">Parameters</h4> - - <dl class="argument-def parameter-def"> - <dt><em>query</em></dt> - <dd><p>The SQL query to be performed.</p></dd> - </dl> - - <dl class="argument-def parameter-def"> - <dt><em>...</em></dt> - <dd><p>A list of parameters that will be bound to the <code>?</code> placeholders in the SQL query.</p></dd> - </dl> - - </div> - - - - <div class="method-subsection return"> - <h4 class="method-subtitle parameter-title">Return Value</h4> - <p><code>NSString</code> value.</p> - </div> - - - - - - - - - - - - <div class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMDatabaseAdditions.h</code><br /> - </div> - - -</div> - - <div class="section-method"> - <a name="//api/name/tableExists:" title="tableExists:"></a> - <h3 class="subsubtitle method-title">tableExists:</h3> - - - - <div class="method-subsection brief-description"> - <p>Does table exist in database?</p> - </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>version</code></th> + <td><p>The <code>uint32_t</code> numeric value of the user version.</p></td> + </tr> + + </table> + </div> + - <div class="method-subsection method-declaration"><code>- (BOOL)tableExists:(NSString *)<em>tableName</em></code></div> + - - - <div class="method-subsection arguments-section parameters"> - <h4 class="method-subtitle parameter-title">Parameters</h4> - - <dl class="argument-def parameter-def"> - <dt><em>tableName</em></dt> - <dd><p>The name of the table being looked for.</p></dd> - </dl> - - </div> - - - - <div class="method-subsection return"> - <h4 class="method-subtitle parameter-title">Return Value</h4> - <p><code>YES</code> if table found; <code>NO</code> if not found.</p> - </div> - - - - - - - - - - - - <div class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMDatabaseAdditions.h</code><br /> - </div> - - -</div> - - <div class="section-method"> - <a name="//api/name/userVersion" title="userVersion"></a> - <h3 class="subsubtitle method-title">userVersion</h3> - - - - <div class="method-subsection brief-description"> - <p>Retrieve user version</p> - </div> - - + - <div class="method-subsection method-declaration"><code>- (uint32_t)userVersion</code></div> + + <div class="method-subsection discussion-section"> + <h4 class="method-subtitle">Discussion</h4> + <p>Set the user-version</p> + </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 user version.</p> + + + + <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"> + <h4 class="method-subtitle">Declared In</h4> + <p><code class="declared-in-ref">FMDatabaseAdditions.h</code></p> + </div> + + + </div> </div> - - - - - - - - - - <div class="method-subsection see-also-section"> - <h4 class="method-subtitle">See Also</h4> - <ul> +</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> +</h3> + + <div class="method-info"> + <div class="pointy-thing"></div> + + <div class="method-info-container"> + + + <div class="method-subsection brief-description"> + <p>Test to see if particular column exists for particular table in database</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 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> + + - <li><code><p><a href="#//api/name/setUserVersion:">- setUserVersion:</a></p></code></li> + <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> + </div> - </ul> + + + + + <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> + </div> + + + + + + <div class="method-subsection see-also-section"> + <h4 class="method-subtitle">See Also</h4> + <ul> + + <li><code><p><a href="#//api/name/columnExists:inTableWithName:">- columnExists:inTableWithName:</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">FMDatabaseAdditions.h</code></p> + </div> + + + </div> </div> - - - - <div class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMDatabaseAdditions.h</code><br /> - </div> - - -</div> - - <div class="section-method"> +</div><div class="section-method"> <a name="//api/name/validateSQL:error:" title="validateSQL:error:"></a> - <h3 class="subsubtitle method-title">validateSQL:error:</h3> - - - - <div class="method-subsection brief-description"> - <p>Validate SQL statement</p> - </div> - - + <h3 class="method-title"><code><a href="#//api/name/validateSQL:error:">– validateSQL:error:</a></code> +</h3> - <div class="method-subsection method-declaration"><code>- (BOOL)validateSQL:(NSString *)<em>sql</em> error:(NSError **)<em>error</em></code></div> + <div class="method-info"> + <div class="pointy-thing"></div> - - - <div class="method-subsection arguments-section parameters"> - <h4 class="method-subtitle parameter-title">Parameters</h4> - - <dl class="argument-def parameter-def"> - <dt><em>sql</em></dt> - <dd><p>The SQL statement being validated.</p></dd> - </dl> - - <dl class="argument-def parameter-def"> - <dt><em>error</em></dt> - <dd><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></dd> - </dl> - - </div> - - - - <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>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 class="method-info-container"> + + + <div class="method-subsection brief-description"> + <p>Validate SQL statement</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 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 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> + </div> + + + + <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> + </div> + + + + + + + + <div class="method-subsection declared-in-section"> + <h4 class="method-subtitle">Declared In</h4> + <p><code class="declared-in-ref">FMDatabaseAdditions.h</code></p> + </div> + + + </div> </div> - - - - - - - - <div class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMDatabaseAdditions.h</code><br /> - </div> - - </div> + </div> </div> - </div> - <div class="main-navigation navigation-bottom"> - <ul> - <li><a href="../index.html">Index</a></li> - <li><a href="../hierarchy.html">Hierarchy</a></li> -</ul> - </div> - <div id="footer"> - <hr /> + + + </main> + + <footer> <div class="footer-copyright"> - <p><span class="copyright">© 2014 ccgus. All rights reserved. (Last updated: 2014-05-25)</span><br /> - <span class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.1 (build 858)</a>.</span></p> + <p class="copyright">Copyright © 2015 ccgus. All rights reserved. Updated: 2015-01-25</p> + + + <p class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.2.1 (build 1333)</a>.</p> </div> - </div> - </div> - </article> - <script type="text/javascript"> - function jumpToChange() - { - window.location.hash = this.options[this.selectedIndex].value; - } - - function toggleTOC() - { - var contents = document.getElementById('contents'); - var tocContainer = document.getElementById('tocContainer'); - - if (this.getAttribute('class') == 'open') - { - this.setAttribute('class', ''); - contents.setAttribute('class', ''); - tocContainer.setAttribute('class', ''); - - window.name = "hideTOC"; - } - else - { - this.setAttribute('class', 'open'); - contents.setAttribute('class', 'isShowingTOC'); - tocContainer.setAttribute('class', 'isShowingTOC'); - - window.name = ""; - } - return false; - } - - function toggleTOCEntryChildren(e) - { - e.stopPropagation(); - var currentClass = this.getAttribute('class'); - if (currentClass == 'children') { - this.setAttribute('class', 'children open'); - } - else if (currentClass == 'children open') { - this.setAttribute('class', 'children'); - } - return false; - } - - function tocEntryClick(e) - { - e.stopPropagation(); - return true; - } - - function init() - { - var selectElement = document.getElementById('jumpTo'); - selectElement.addEventListener('change', jumpToChange, false); - - var tocButton = document.getElementById('table_of_contents'); - tocButton.addEventListener('click', toggleTOC, false); - - var taskTreeItem = document.getElementById('task_treeitem'); - if (taskTreeItem.getElementsByTagName('li').length > 0) - { - taskTreeItem.setAttribute('class', 'children'); - taskTreeItem.firstChild.setAttribute('class', 'disclosure'); - } - - var tocList = document.getElementById('toc'); - - var tocEntries = tocList.getElementsByTagName('li'); - for (var i = 0; i < tocEntries.length; i++) { - tocEntries[i].addEventListener('click', toggleTOCEntryChildren, false); - } - - var tocLinks = tocList.getElementsByTagName('a'); - for (var i = 0; i < tocLinks.length; i++) { - tocLinks[i].addEventListener('click', tocEntryClick, false); - } - - if (window.name == "hideTOC") { - toggleTOC.call(tocButton); - } - } - - window.onload = init; - - // If showing in Xcode, hide the TOC and Header - if (navigator.userAgent.match(/xcode/i)) { - document.getElementById("contents").className = "hideInXcode" - document.getElementById("tocContainer").className = "hideInXcode" - document.getElementById("top_header").className = "hideInXcode" - } - - </script> - </body> + </footer> + </div> + </div> + </article> + + <script src="../js/script.js"></script> +</body> </html>
\ No newline at end of file diff --git a/html/Categories/NSObject+FMDatabasePoolDelegate.html b/html/Categories/NSObject+FMDatabasePoolDelegate.html new file mode 100644 index 0000000..9d6ff13 --- /dev/null +++ b/html/Categories/NSObject+FMDatabasePoolDelegate.html @@ -0,0 +1,272 @@ +<!DOCTYPE html> +<html> +<head> + <meta charset="utf-8"> + + <title>NSObject(FMDatabasePoolDelegate) Category Reference</title> + + <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)"> +</head> +<body class="appledoc"> + <header> + <div class="container" class="hide-in-xcode"> + + <h1 id="library-title"> + <a href="../index.html">FMDB </a> + </h1> + + <p id="developer-home"> + <a href="../index.html">ccgus</a> + </p> + + </div> + </header> + + <aside> + <div class="container"> + <nav> + <ul id="header-buttons" role="toolbar"> + <li><a href="../index.html">Index</a></li> +<li><a href="../hierarchy.html">Hierarchy</a></li> + + <li id="on-this-page" role="navigation"> + <label> + On This Page + + <div class="chevron"> + <div class="chevy chevron-left"></div> + <div class="chevy chevron-right"></div> + </div> + + <select id="jump-to"> + <option value="top">Jump To…</option> + + <option value="overview">Overview</option> + + + + + <option value="tasks">Tasks</option> + + + + + + + + + + <optgroup label="Instance Methods"> + + <option value="//api/name/databasePool:didAddDatabase:">- databasePool:didAddDatabase:</option> + + <option value="//api/name/databasePool:shouldAddDatabaseToPool:">- databasePool:shouldAddDatabaseToPool:</option> + + </optgroup> + + +</select> + </label> + </li> + </ul> + </nav> + </div> + </aside> + + <article> + <div id="overview_contents" class="container"> + <div id="content"> + <main role="main"> + <h1 class="title">NSObject(FMDatabasePoolDelegate) Category Reference</h1> + + + <div class="section section-specification"><table cellspacing="0"><tbody> + <tr> + <th>Declared in</th> + <td>FMDatabasePool.h</td> +</tr> + </tbody></table></div> + + + + + <div class="section section-overview"> + <a title="Overview" name="overview"></a> + <h2 class="subtitle subtitle-overview">Overview</h2> + <p>FMDatabasePool delegate category</p> + +<p>This is a category that defines the protocol for the FMDatabasePool delegate</p> + </div> + + + + + + <div class="section section-tasks"> + <a title="Tasks" name="tasks"></a> + + + + + + <div class="task-list"> + <div class="section-method"> + <a name="//api/name/databasePool:shouldAddDatabaseToPool:" title="databasePool:shouldAddDatabaseToPool:"></a> + <h3 class="method-title"><code><a href="#//api/name/databasePool:shouldAddDatabaseToPool:">– databasePool:shouldAddDatabaseToPool:</a></code> +</h3> + + <div class="method-info"> + <div class="pointy-thing"></div> + + <div class="method-info-container"> + + + <div class="method-subsection brief-description"> + <p>Asks the delegate whether database should be added to the pool.</p> + </div> + + + + <div class="method-subsection method-declaration"><code>- (BOOL)databasePool:(FMDatabasePool *)<em>pool</em> shouldAddDatabaseToPool:(FMDatabase *)<em>database</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>pool</code></th> + <td><p>The <code>FMDatabasePool</code> object.</p></td> + </tr> + + <tr> + <th scope="row" class="argument-name"><code>database</code></th> + <td><p>The <code>FMDatabase</code> object.</p></td> + </tr> + + </table> + </div> + + + + <div class="method-subsection return"> + <h4 class="method-subtitle parameter-title">Return Value</h4> + <p><code>YES</code> if it should add database to pool; <code>NO</code> if not.</p> + </div> + + + + + + <div class="method-subsection discussion-section"> + <h4 class="method-subtitle">Discussion</h4> + <p>Asks the delegate whether database should be added to the pool.</p> + </div> + + + + + + + + <div class="method-subsection declared-in-section"> + <h4 class="method-subtitle">Declared In</h4> + <p><code class="declared-in-ref">FMDatabasePool.h</code></p> + </div> + + + </div> + </div> +</div><div class="section-method"> + <a name="//api/name/databasePool:didAddDatabase:" title="databasePool:didAddDatabase:"></a> + <h3 class="method-title"><code><a href="#//api/name/databasePool:didAddDatabase:">– databasePool:didAddDatabase:</a></code> +</h3> + + <div class="method-info"> + <div class="pointy-thing"></div> + + <div class="method-info-container"> + + + <div class="method-subsection brief-description"> + <p>Tells the delegate that database was added to the pool.</p> + </div> + + + + <div class="method-subsection method-declaration"><code>- (void)databasePool:(FMDatabasePool *)<em>pool</em> didAddDatabase:(FMDatabase *)<em>database</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>pool</code></th> + <td><p>The <code>FMDatabasePool</code> object.</p></td> + </tr> + + <tr> + <th scope="row" class="argument-name"><code>database</code></th> + <td><p>The <code>FMDatabase</code> object.</p></td> + </tr> + + </table> + </div> + + + + + + + + <div class="method-subsection discussion-section"> + <h4 class="method-subtitle">Discussion</h4> + <p>Tells the delegate that database was added to the pool.</p> + </div> + + + + + + + + <div class="method-subsection declared-in-section"> + <h4 class="method-subtitle">Declared In</h4> + <p><code class="declared-in-ref">FMDatabasePool.h</code></p> + </div> + + + </div> + </div> +</div> + </div> + + </div> + + + + + </main> + + <footer> + <div class="footer-copyright"> + + <p class="copyright">Copyright © 2015 ccgus. All rights reserved. Updated: 2015-01-25</p> + + + <p class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.2.1 (build 1333)</a>.</p> + + </div> + </footer> + </div> + </div> + </article> + + <script src="../js/script.js"></script> +</body> +</html>
\ No newline at end of file diff --git a/html/Classes/FMDatabase.html b/html/Classes/FMDatabase.html index ee2f7db..ece6ffe 100644 --- a/html/Classes/FMDatabase.html +++ b/html/Classes/FMDatabase.html @@ -1,384 +1,219 @@ -<!DOCTYPE HTML> +<!DOCTYPE html> <html> - <head> - <meta http-equiv="Content-Type" content="html/html; charset=utf-8" /> - <title>FMDatabase Class Reference</title> - <meta id="xcode-display" name="xcode-display" content="render"/> - <meta name="viewport" content="width=550" /> - <link rel="stylesheet" type="text/css" href="../css/styles.css" media="all" /> - <link rel="stylesheet" type="text/css" media="print" href="../css/stylesPrint.css" /> - <meta name="generator" content="appledoc 2.1 (build 858)" /> - </head> - <body> - <header id="top_header"> - <div id="library" class="hideInXcode"> - <h1><a id="libraryTitle" href="../index.html">FMDB </a></h1> - <a id="developerHome" href="../index.html">ccgus</a> - </div> - - <div id="title" role="banner"> - <h1 class="hideInXcode">FMDatabase Class Reference</h1> - </div> - <ul id="headerButtons" role="toolbar"> - <li id="toc_button"> - <button aria-label="Show Table of Contents" role="checkbox" class="open" id="table_of_contents"><span class="disclosure"></span>Table of Contents</button> - </li> - <li id="jumpto_button" role="navigation"> - <select id="jumpTo"> +<head> + <meta charset="utf-8"> + + <title>FMDatabase Class Reference</title> + + <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)"> +</head> +<body class="appledoc"> + <header> + <div class="container" class="hide-in-xcode"> + + <h1 id="library-title"> + <a href="../index.html">FMDB </a> + </h1> + + <p id="developer-home"> + <a href="../index.html">ccgus</a> + </p> + + </div> + </header> + + <aside> + <div class="container"> + <nav> + <ul id="header-buttons" role="toolbar"> + <li><a href="../index.html">Index</a></li> +<li><a href="../hierarchy.html">Hierarchy</a></li> + + <li id="on-this-page" role="navigation"> + <label> + On This Page + + <div class="chevron"> + <div class="chevy chevron-left"></div> + <div class="chevy chevron-right"></div> + </div> + + <select id="jump-to"> <option value="top">Jump To…</option> <option value="overview">Overview</option> - + <option value="tasks">Tasks</option> - - - - <option value="properties">Properties</option> - - <option value="//api/name/cachedStatements"> cachedStatements</option> - - <option value="//api/name/checkedOut"> checkedOut</option> - - <option value="//api/name/crashOnErrors"> crashOnErrors</option> - - <option value="//api/name/logsErrors"> logsErrors</option> - - <option value="//api/name/traceExecution"> traceExecution</option> - - - - - <option value="class_methods">Class Methods</option> - - <option value="//api/name/databaseWithPath:"> + databaseWithPath:</option> - - <option value="//api/name/isSQLiteThreadSafe"> + isSQLiteThreadSafe</option> - - <option value="//api/name/sqliteLibVersion"> + sqliteLibVersion</option> - - <option value="//api/name/storeableDateFormat:"> + storeableDateFormat:</option> - - - - - <option value="instance_methods">Instance Methods</option> - - <option value="//api/name/beginDeferredTransaction"> - beginDeferredTransaction</option> - - <option value="//api/name/beginTransaction"> - beginTransaction</option> - - <option value="//api/name/changes"> - changes</option> - - <option value="//api/name/clearCachedStatements"> - clearCachedStatements</option> - - <option value="//api/name/close"> - close</option> - - <option value="//api/name/closeOpenResultSets"> - closeOpenResultSets</option> - - <option value="//api/name/commit"> - commit</option> - - <option value="//api/name/databasePath"> - databasePath</option> - - <option value="//api/name/dateFromString:"> - dateFromString:</option> - - <option value="//api/name/executeQuery:"> - executeQuery:</option> - - <option value="//api/name/executeQuery:withArgumentsInArray:"> - executeQuery:withArgumentsInArray:</option> - - <option value="//api/name/executeQuery:withParameterDictionary:"> - executeQuery:withParameterDictionary:</option> - - <option value="//api/name/executeQueryWithFormat:"> - executeQueryWithFormat:</option> - - <option value="//api/name/executeStatements:"> - executeStatements:</option> - - <option value="//api/name/executeStatements:withResultBlock:"> - executeStatements:withResultBlock:</option> - - <option value="//api/name/executeUpdate:"> - executeUpdate:</option> - - <option value="//api/name/executeUpdate:withArgumentsInArray:"> - executeUpdate:withArgumentsInArray:</option> - - <option value="//api/name/executeUpdate:withErrorAndBindings:"> - executeUpdate:withErrorAndBindings:</option> - - <option value="//api/name/executeUpdate:withParameterDictionary:"> - executeUpdate:withParameterDictionary:</option> - - <option value="//api/name/executeUpdate:withVAList:"> - executeUpdate:withVAList:</option> - - <option value="//api/name/executeUpdateWithFormat:"> - executeUpdateWithFormat:</option> - - <option value="//api/name/goodConnection"> - goodConnection</option> - - <option value="//api/name/hadError"> - hadError</option> - - <option value="//api/name/hasDateFormatter"> - hasDateFormatter</option> - - <option value="//api/name/hasOpenResultSets"> - hasOpenResultSets</option> - - <option value="//api/name/inSavePoint:"> - inSavePoint:</option> - - <option value="//api/name/inTransaction"> - inTransaction</option> - - <option value="//api/name/initWithPath:"> - initWithPath:</option> - - <option value="//api/name/lastError"> - lastError</option> - - <option value="//api/name/lastErrorCode"> - lastErrorCode</option> - - <option value="//api/name/lastErrorMessage"> - lastErrorMessage</option> - - <option value="//api/name/lastInsertRowId"> - lastInsertRowId</option> - - <option value="//api/name/makeFunctionNamed:maximumArguments:withBlock:"> - makeFunctionNamed:maximumArguments:withBlock:</option> - - <option value="//api/name/open"> - open</option> - - <option value="//api/name/openWithFlags:"> - openWithFlags:</option> - - <option value="//api/name/rekey:"> - rekey:</option> - - <option value="//api/name/rekeyWithData:"> - rekeyWithData:</option> - - <option value="//api/name/releaseSavePointWithName:error:"> - releaseSavePointWithName:error:</option> - - <option value="//api/name/rollback"> - rollback</option> - - <option value="//api/name/rollbackToSavePointWithName:error:"> - rollbackToSavePointWithName:error:</option> - - <option value="//api/name/setDateFormat:"> - setDateFormat:</option> - - <option value="//api/name/setKey:"> - setKey:</option> - - <option value="//api/name/setKeyWithData:"> - setKeyWithData:</option> - - <option value="//api/name/setShouldCacheStatements:"> - setShouldCacheStatements:</option> - - <option value="//api/name/shouldCacheStatements"> - shouldCacheStatements</option> - - <option value="//api/name/sqliteHandle"> - sqliteHandle</option> - - <option value="//api/name/startSavePointWithName:error:"> - startSavePointWithName:error:</option> - - <option value="//api/name/stringFromDate:"> - stringFromDate:</option> - - <option value="//api/name/update:withErrorAndBindings:"> - update:withErrorAndBindings:</option> - - - -</select> - </li> - </ul> - </header> - <nav id="tocContainer" class="isShowingTOC"> - <ul id="toc" role="tree"> - -<li role="treeitem"><span class="nodisclosure"></span><span class="sectionName"><a href="#overview">Overview</a></span></li> - - - -<li role="treeitem" id="task_treeitem"><span class="nodisclosure"></span><span class="sectionName"><a href="#tasks">Tasks</a></span><ul> - - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#task_Properties">Properties</a></span></li> - - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#task_Initialization">Initialization</a></span></li> - - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#task_Opening and closing database">Opening and closing database</a></span></li> - - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#task_Perform updates">Perform updates</a></span></li> - - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#task_Retrieving results">Retrieving results</a></span></li> - - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#task_Transactions">Transactions</a></span></li> - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#task_Cached statements and result sets">Cached statements and result sets</a></span></li> - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#task_Encryption methods">Encryption methods</a></span></li> - - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#task_General inquiry methods">General inquiry methods</a></span></li> - - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#task_Retrieving error codes">Retrieving error codes</a></span></li> - - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#task_Save points">Save points</a></span></li> - - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#task_SQLite library status">SQLite library status</a></span></li> - - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#task_Make SQL function">Make SQL function</a></span></li> - - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#task_Date formatter">Date formatter</a></span></li> + <optgroup label="Properties"> + + <option value="//api/name/cachedStatements">cachedStatements</option> + + <option value="//api/name/checkedOut">checkedOut</option> + + <option value="//api/name/crashOnErrors">crashOnErrors</option> + + <option value="//api/name/logsErrors">logsErrors</option> + + <option value="//api/name/traceExecution">traceExecution</option> + + </optgroup> -</ul></li> - - - - -<li role="treeitem" class="children"><span class="disclosure"></span><span class="sectionName"><a href="#properties">Properties</a></span><ul> - - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/cachedStatements">cachedStatements</a></span></li> - - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/checkedOut">checkedOut</a></span></li> - - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/crashOnErrors">crashOnErrors</a></span></li> - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/logsErrors">logsErrors</a></span></li> - - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/traceExecution">traceExecution</a></span></li> + <optgroup label="Class Methods"> + + <option value="//api/name/databaseWithPath:">+ databaseWithPath:</option> + + <option value="//api/name/isSQLiteThreadSafe">+ isSQLiteThreadSafe</option> + + <option value="//api/name/sqliteLibVersion">+ sqliteLibVersion</option> + + <option value="//api/name/storeableDateFormat:">+ storeableDateFormat:</option> + + </optgroup> -</ul></li> - - -<li role="treeitem" class="children"><span class="disclosure"></span><span class="sectionName"><a href="#class_methods">Class Methods</a></span><ul> - - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/databaseWithPath:">databaseWithPath:</a></span></li> - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/isSQLiteThreadSafe">isSQLiteThreadSafe</a></span></li> - - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/sqliteLibVersion">sqliteLibVersion</a></span></li> + <optgroup label="Instance Methods"> + + <option value="//api/name/beginDeferredTransaction">- beginDeferredTransaction</option> + + <option value="//api/name/beginTransaction">- beginTransaction</option> + + <option value="//api/name/changes">- changes</option> + + <option value="//api/name/clearCachedStatements">- clearCachedStatements</option> + + <option value="//api/name/close">- close</option> + + <option value="//api/name/closeOpenResultSets">- closeOpenResultSets</option> + + <option value="//api/name/commit">- commit</option> + + <option value="//api/name/databasePath">- databasePath</option> + + <option value="//api/name/dateFromString:">- dateFromString:</option> + + <option value="//api/name/executeQuery:">- executeQuery:</option> + + <option value="//api/name/executeQuery:withArgumentsInArray:">- executeQuery:withArgumentsInArray:</option> + + <option value="//api/name/executeQuery:withParameterDictionary:">- executeQuery:withParameterDictionary:</option> + + <option value="//api/name/executeQueryWithFormat:">- executeQueryWithFormat:</option> + + <option value="//api/name/executeStatements:">- executeStatements:</option> + + <option value="//api/name/executeStatements:withResultBlock:">- executeStatements:withResultBlock:</option> + + <option value="//api/name/executeUpdate:">- executeUpdate:</option> + + <option value="//api/name/executeUpdate:withArgumentsInArray:">- executeUpdate:withArgumentsInArray:</option> + + <option value="//api/name/executeUpdate:withErrorAndBindings:">- executeUpdate:withErrorAndBindings:</option> + + <option value="//api/name/executeUpdate:withParameterDictionary:">- executeUpdate:withParameterDictionary:</option> + + <option value="//api/name/executeUpdate:withVAList:">- executeUpdate:withVAList:</option> + + <option value="//api/name/executeUpdateWithFormat:">- executeUpdateWithFormat:</option> + + <option value="//api/name/goodConnection">- goodConnection</option> + + <option value="//api/name/hadError">- hadError</option> + + <option value="//api/name/hasDateFormatter">- hasDateFormatter</option> + + <option value="//api/name/hasOpenResultSets">- hasOpenResultSets</option> + + <option value="//api/name/inSavePoint:">- inSavePoint:</option> + + <option value="//api/name/inTransaction">- inTransaction</option> + + <option value="//api/name/initWithPath:">- initWithPath:</option> + + <option value="//api/name/lastError">- lastError</option> + + <option value="//api/name/lastErrorCode">- lastErrorCode</option> + + <option value="//api/name/lastErrorMessage">- lastErrorMessage</option> + + <option value="//api/name/lastInsertRowId">- lastInsertRowId</option> + + <option value="//api/name/makeFunctionNamed:maximumArguments:withBlock:">- makeFunctionNamed:maximumArguments:withBlock:</option> + + <option value="//api/name/open">- open</option> + + <option value="//api/name/openWithFlags:">- openWithFlags:</option> + + <option value="//api/name/rekey:">- rekey:</option> + + <option value="//api/name/rekeyWithData:">- rekeyWithData:</option> + + <option value="//api/name/releaseSavePointWithName:error:">- releaseSavePointWithName:error:</option> + + <option value="//api/name/rollback">- rollback</option> + + <option value="//api/name/rollbackToSavePointWithName:error:">- rollbackToSavePointWithName:error:</option> + + <option value="//api/name/setDateFormat:">- setDateFormat:</option> + + <option value="//api/name/setKey:">- setKey:</option> + + <option value="//api/name/setKeyWithData:">- setKeyWithData:</option> + + <option value="//api/name/setShouldCacheStatements:">- setShouldCacheStatements:</option> + + <option value="//api/name/shouldCacheStatements">- shouldCacheStatements</option> + + <option value="//api/name/sqliteHandle">- sqliteHandle</option> + + <option value="//api/name/startSavePointWithName:error:">- startSavePointWithName:error:</option> + + <option value="//api/name/stringFromDate:">- stringFromDate:</option> + + <option value="//api/name/update:withErrorAndBindings:">- update:withErrorAndBindings:</option> + + </optgroup> - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/storeableDateFormat:">storeableDateFormat:</a></span></li> -</ul></li> - - +</select> + </label> + </li> + </ul> + </nav> + </div> + </aside> + + <article> + <div id="overview_contents" class="container"> + <div id="content"> + <main role="main"> + <h1 class="title">FMDatabase Class Reference</h1> -<li role="treeitem" class="children"><span class="disclosure"></span><span class="sectionName"><a href="#instance_methods">Instance Methods</a></span><ul> - - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/beginDeferredTransaction">beginDeferredTransaction</a></span></li> - - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/beginTransaction">beginTransaction</a></span></li> - - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/changes">changes</a></span></li> - - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/clearCachedStatements">clearCachedStatements</a></span></li> - - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/close">close</a></span></li> - - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/closeOpenResultSets">closeOpenResultSets</a></span></li> - - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/commit">commit</a></span></li> - - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/databasePath">databasePath</a></span></li> - - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/dateFromString:">dateFromString:</a></span></li> - - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/executeQuery:">executeQuery:</a></span></li> - - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/executeQuery:withArgumentsInArray:">executeQuery:withArgumentsInArray:</a></span></li> - - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/executeQuery:withParameterDictionary:">executeQuery:withParameterDictionary:</a></span></li> - - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/executeQueryWithFormat:">executeQueryWithFormat:</a></span></li> - - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/executeStatements:">executeStatements:</a></span></li> - - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/executeStatements:withResultBlock:">executeStatements:withResultBlock:</a></span></li> - - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/executeUpdate:">executeUpdate:</a></span></li> - - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/executeUpdate:withArgumentsInArray:">executeUpdate:withArgumentsInArray:</a></span></li> - - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/executeUpdate:withErrorAndBindings:">executeUpdate:withErrorAndBindings:</a></span></li> - - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/executeUpdate:withParameterDictionary:">executeUpdate:withParameterDictionary:</a></span></li> - - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/executeUpdate:withVAList:">executeUpdate:withVAList:</a></span></li> - - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/executeUpdateWithFormat:">executeUpdateWithFormat:</a></span></li> - - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/goodConnection">goodConnection</a></span></li> - - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/hadError">hadError</a></span></li> - - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/hasDateFormatter">hasDateFormatter</a></span></li> - - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/hasOpenResultSets">hasOpenResultSets</a></span></li> - - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/inSavePoint:">inSavePoint:</a></span></li> - - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/inTransaction">inTransaction</a></span></li> - - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/initWithPath:">initWithPath:</a></span></li> - - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/lastError">lastError</a></span></li> - - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/lastErrorCode">lastErrorCode</a></span></li> - - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/lastErrorMessage">lastErrorMessage</a></span></li> - - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/lastInsertRowId">lastInsertRowId</a></span></li> - - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/makeFunctionNamed:maximumArguments:withBlock:">makeFunctionNamed:maximumArguments:withBlock:</a></span></li> - - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/open">open</a></span></li> - - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/openWithFlags:">openWithFlags:</a></span></li> - - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/rekey:">rekey:</a></span></li> - - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/rekeyWithData:">rekeyWithData:</a></span></li> - - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/releaseSavePointWithName:error:">releaseSavePointWithName:error:</a></span></li> - - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/rollback">rollback</a></span></li> - - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/rollbackToSavePointWithName:error:">rollbackToSavePointWithName:error:</a></span></li> - - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/setDateFormat:">setDateFormat:</a></span></li> - - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/setKey:">setKey:</a></span></li> - - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/setKeyWithData:">setKeyWithData:</a></span></li> - - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/setShouldCacheStatements:">setShouldCacheStatements:</a></span></li> - - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/shouldCacheStatements">shouldCacheStatements</a></span></li> - - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/sqliteHandle">sqliteHandle</a></span></li> - - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/startSavePointWithName:error:">startSavePointWithName:error:</a></span></li> - - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/stringFromDate:">stringFromDate:</a></span></li> - - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/update:withErrorAndBindings:">update:withErrorAndBindings:</a></span></li> - -</ul></li> - - - </ul> - </nav> - <article> - <div id="contents" class="isShowingTOC" role="main"> - <a title="FMDatabase Class Reference" name="top"></a> - <div class="main-navigation navigation-top"> - <ul> - <li><a href="../index.html">Index</a></li> - <li><a href="../hierarchy.html">Hierarchy</a></li> -</ul> - </div> - <div id="header"> - <div class="section-header"> - <h1 class="title title-header">FMDatabase Class Reference</h1> - </div> - </div> - <div id="container"> <div class="section section-specification"><table cellspacing="0"><tbody> <tr> - <td class="specification-title">Inherits from</td> - <td class="specification-value">NSObject</td> + <th>Inherits from</th> + <td>NSObject</td> </tr><tr> - <td class="specification-title">Declared in</td> - <td class="specification-value">FMDatabase.h</td> + <th>Declared in</th> + <td>FMDatabase.h</td> </tr> </tbody></table></div> - - + + <div class="section section-overview"> <a title="Overview" name="overview"></a> @@ -416,769 +251,304 @@ </div> - + <div class="section section-tasks"> <a title="Tasks" name="tasks"></a> - <h2 class="subtitle subtitle-tasks">Tasks</h2> - + <a title="Properties" name="task_Properties"></a> - <h3 class="subsubtitle task-title">Properties</h3> - - <ul class="task-list"> - <li> - <span class="tooltip"> - <code><a href="#//api/name/traceExecution"> traceExecution</a></code> - <span class="tooltip"><p>Whether should trace execution</p></span> - </span> - <span class="task-item-suffix">property</span> - -</li><li> - <span class="tooltip"> - <code><a href="#//api/name/checkedOut"> checkedOut</a></code> - <span class="tooltip"><p>Whether checked out or not</p></span> - </span> - <span class="task-item-suffix">property</span> - -</li><li> - <span class="tooltip"> - <code><a href="#//api/name/crashOnErrors"> crashOnErrors</a></code> - <span class="tooltip"><p>Crash on errors</p></span> - </span> - <span class="task-item-suffix">property</span> - -</li><li> - <span class="tooltip"> - <code><a href="#//api/name/logsErrors"> logsErrors</a></code> - <span class="tooltip"><p>Logs errors</p></span> - </span> - <span class="task-item-suffix">property</span> - -</li><li> - <span class="tooltip"> - <code><a href="#//api/name/cachedStatements"> cachedStatements</a></code> - <span class="tooltip"><p>Dictionary of cached statements</p></span> - </span> - <span class="task-item-suffix">property</span> - -</li> - </ul> - - - <a title="Initialization" name="task_Initialization"></a> - <h3 class="subsubtitle task-title">Initialization</h3> - - <ul class="task-list"> - <li> - <span class="tooltip"> - <code><a href="#//api/name/databaseWithPath:">+ databaseWithPath:</a></code> - <span class="tooltip"><p>Create a <code>FMDatabase</code> object.</p></span> - </span> - - -</li><li> - <span class="tooltip"> - <code><a href="#//api/name/initWithPath:">– initWithPath:</a></code> - <span class="tooltip"><p>Initialize a <code>FMDatabase</code> object.</p></span> - </span> - - -</li> - </ul> - - - <a title="Opening and closing database" name="task_Opening and closing database"></a> - <h3 class="subsubtitle task-title">Opening and closing database</h3> - - <ul class="task-list"> - <li> - <span class="tooltip"> - <code><a href="#//api/name/open">– open</a></code> - <span class="tooltip"><p>Opening a new database connection</p></span> - </span> - - -</li><li> - <span class="tooltip"> - <code><a href="#//api/name/openWithFlags:">– openWithFlags:</a></code> - <span class="tooltip"><p>Opening a new database connection with flags</p></span> - </span> - - -</li><li> - <span class="tooltip"> - <code><a href="#//api/name/close">– close</a></code> - <span class="tooltip"><p>Closing a database connection</p></span> - </span> - - -</li><li> - <span class="tooltip"> - <code><a href="#//api/name/goodConnection">– goodConnection</a></code> - <span class="tooltip"><p>Test to see if we have a good connection to the database.</p></span> - </span> - - -</li> - </ul> - - - <a title="Perform updates" name="task_Perform updates"></a> - <h3 class="subsubtitle task-title">Perform updates</h3> - - <ul class="task-list"> - <li> - <span class="tooltip"> - <code><a href="#//api/name/executeUpdate:withErrorAndBindings:">– executeUpdate:withErrorAndBindings:</a></code> - <span class="tooltip"><p>Execute single update statement</p></span> - </span> - - -</li><li> - <span class="tooltip"> - <code><a href="#//api/name/update:withErrorAndBindings:">– update:withErrorAndBindings:</a></code> - <span class="tooltip"><p>Execute single update statement</p></span> - </span> - - -</li><li> - <span class="tooltip"> - <code><a href="#//api/name/executeUpdate:">– executeUpdate:</a></code> - <span class="tooltip"><p>Execute single update statement</p></span> - </span> - - -</li><li> - <span class="tooltip"> - <code><a href="#//api/name/executeUpdateWithFormat:">– executeUpdateWithFormat:</a></code> - <span class="tooltip"><p>Execute single update statement</p></span> - </span> - - -</li><li> - <span class="tooltip"> - <code><a href="#//api/name/executeUpdate:withArgumentsInArray:">– executeUpdate:withArgumentsInArray:</a></code> - <span class="tooltip"><p>Execute single update statement</p></span> - </span> - - -</li><li> - <span class="tooltip"> - <code><a href="#//api/name/executeUpdate:withParameterDictionary:">– executeUpdate:withParameterDictionary:</a></code> - <span class="tooltip"><p>Execute single update statement</p></span> - </span> - - -</li><li> - <span class="tooltip"> - <code><a href="#//api/name/executeUpdate:withVAList:">– executeUpdate:withVAList:</a></code> - <span class="tooltip"><p>Execute single update statement</p></span> - </span> - - -</li><li> - <span class="tooltip"> - <code><a href="#//api/name/executeStatements:">– executeStatements:</a></code> - <span class="tooltip"><p>Execute multiple SQL statements</p></span> - </span> - - -</li><li> - <span class="tooltip"> - <code><a href="#//api/name/executeStatements:withResultBlock:">– executeStatements:withResultBlock:</a></code> - <span class="tooltip"><p>Execute multiple SQL statements with callback handler</p></span> - </span> - - -</li><li> - <span class="tooltip"> - <code><a href="#//api/name/lastInsertRowId">– lastInsertRowId</a></code> - <span class="tooltip"><p>Last insert rowid</p></span> - </span> - - -</li><li> - <span class="tooltip"> - <code><a href="#//api/name/changes">– changes</a></code> - <span class="tooltip"><p>The number of rows changed by prior SQL statement.</p></span> - </span> - - -</li> - </ul> - - - <a title="Retrieving results" name="task_Retrieving results"></a> - <h3 class="subsubtitle task-title">Retrieving results</h3> - - <ul class="task-list"> - <li> - <span class="tooltip"> - <code><a href="#//api/name/executeQuery:">– executeQuery:</a></code> - <span class="tooltip"><p>Execute select statement</p></span> - </span> - - -</li><li> - <span class="tooltip"> - <code><a href="#//api/name/executeQueryWithFormat:">– executeQueryWithFormat:</a></code> - <span class="tooltip"><p>Execute select statement</p></span> - </span> - - -</li><li> - <span class="tooltip"> - <code><a href="#//api/name/executeQuery:withArgumentsInArray:">– executeQuery:withArgumentsInArray:</a></code> - <span class="tooltip"><p>Execute select statement</p></span> - </span> - - -</li><li> - <span class="tooltip"> - <code><a href="#//api/name/executeQuery:withParameterDictionary:">– executeQuery:withParameterDictionary:</a></code> - <span class="tooltip"><p>Execute select statement</p></span> - </span> - - -</li> - </ul> - - - <a title="Transactions" name="task_Transactions"></a> - <h3 class="subsubtitle task-title">Transactions</h3> - - <ul class="task-list"> - <li> - <span class="tooltip"> - <code><a href="#//api/name/beginTransaction">– beginTransaction</a></code> - <span class="tooltip"><p>Begin a transaction</p></span> - </span> - - -</li><li> - <span class="tooltip"> - <code><a href="#//api/name/beginDeferredTransaction">– beginDeferredTransaction</a></code> - <span class="tooltip"><p>Begin a deferred transaction</p></span> - </span> - - -</li><li> - <span class="tooltip"> - <code><a href="#//api/name/commit">– commit</a></code> - <span class="tooltip"><p>Commit a transaction</p></span> - </span> - - -</li><li> - <span class="tooltip"> - <code><a href="#//api/name/rollback">– rollback</a></code> - <span class="tooltip"><p>Rollback a transaction</p></span> - </span> - - -</li><li> - <span class="tooltip"> - <code><a href="#//api/name/inTransaction">– inTransaction</a></code> - <span class="tooltip"><p>Identify whether currently in a transaction or not</p></span> - </span> - - -</li> - </ul> - - - <a title="Cached statements and result sets" name="task_Cached statements and result sets"></a> - <h3 class="subsubtitle task-title">Cached statements and result sets</h3> - - <ul class="task-list"> - <li> - <span class="tooltip"> - <code><a href="#//api/name/clearCachedStatements">– clearCachedStatements</a></code> - <span class="tooltip"><p>Clear cached statements</p></span> - </span> - - -</li><li> - <span class="tooltip"> - <code><a href="#//api/name/closeOpenResultSets">– closeOpenResultSets</a></code> - <span class="tooltip"><p>Close all open result sets</p></span> - </span> - - -</li><li> - <span class="tooltip"> - <code><a href="#//api/name/hasOpenResultSets">– hasOpenResultSets</a></code> - <span class="tooltip"><p>Whether database has any open result sets</p></span> - </span> - - -</li><li> - <span class="tooltip"> - <code><a href="#//api/name/shouldCacheStatements">– shouldCacheStatements</a></code> - <span class="tooltip"><p>Return whether should cache statements or not</p></span> - </span> - - -</li><li> - <span class="tooltip"> - <code><a href="#//api/name/setShouldCacheStatements:">– setShouldCacheStatements:</a></code> - <span class="tooltip"><p>Set whether should cache statements or not</p></span> - </span> - - -</li> - </ul> - - - <a title="Encryption methods" name="task_Encryption methods"></a> - <h3 class="subsubtitle task-title">Encryption methods</h3> - - <ul class="task-list"> - <li> - <span class="tooltip"> - <code><a href="#//api/name/setKey:">– setKey:</a></code> - <span class="tooltip"><p>Set encryption key.</p></span> - </span> - - -</li><li> - <span class="tooltip"> - <code><a href="#//api/name/rekey:">– rekey:</a></code> - <span class="tooltip"><p>Reset encryption key</p></span> - </span> - - -</li><li> - <span class="tooltip"> - <code><a href="#//api/name/setKeyWithData:">– setKeyWithData:</a></code> - <span class="tooltip"><p>Set encryption key using <code>keyData</code>.</p></span> - </span> - - -</li><li> - <span class="tooltip"> - <code><a href="#//api/name/rekeyWithData:">– rekeyWithData:</a></code> - <span class="tooltip"><p>Reset encryption key using <code>keyData</code>.</p></span> - </span> - - -</li> - </ul> - - - <a title="General inquiry methods" name="task_General inquiry methods"></a> - <h3 class="subsubtitle task-title">General inquiry methods</h3> - - <ul class="task-list"> - <li> - <span class="tooltip"> - <code><a href="#//api/name/databasePath">– databasePath</a></code> - <span class="tooltip"><p>The path of the database file</p></span> - </span> - - -</li><li> - <span class="tooltip"> - <code><a href="#//api/name/sqliteHandle">– sqliteHandle</a></code> - <span class="tooltip"><p>The underlying SQLite handle</p></span> - </span> - - -</li> - </ul> - - - <a title="Retrieving error codes" name="task_Retrieving error codes"></a> - <h3 class="subsubtitle task-title">Retrieving error codes</h3> - - <ul class="task-list"> - <li> - <span class="tooltip"> - <code><a href="#//api/name/lastErrorMessage">– lastErrorMessage</a></code> - <span class="tooltip"><p>Last error message</p></span> - </span> - - -</li><li> - <span class="tooltip"> - <code><a href="#//api/name/lastErrorCode">– lastErrorCode</a></code> - <span class="tooltip"><p>Last error code</p></span> - </span> - - -</li><li> - <span class="tooltip"> - <code><a href="#//api/name/hadError">– hadError</a></code> - <span class="tooltip"><p>Had error</p></span> - </span> - - -</li><li> - <span class="tooltip"> - <code><a href="#//api/name/lastError">– lastError</a></code> - <span class="tooltip"><p>Last error</p></span> - </span> - - -</li> - </ul> - - - <a title="Save points" name="task_Save points"></a> - <h3 class="subsubtitle task-title">Save points</h3> - - <ul class="task-list"> - <li> - <span class="tooltip"> - <code><a href="#//api/name/startSavePointWithName:error:">– startSavePointWithName:error:</a></code> - <span class="tooltip"><p>Start save point</p></span> - </span> - - -</li><li> - <span class="tooltip"> - <code><a href="#//api/name/releaseSavePointWithName:error:">– releaseSavePointWithName:error:</a></code> - <span class="tooltip"><p>Release save point</p></span> - </span> - - -</li><li> - <span class="tooltip"> - <code><a href="#//api/name/rollbackToSavePointWithName:error:">– rollbackToSavePointWithName:error:</a></code> - <span class="tooltip"><p>Roll back to save point</p></span> - </span> - - -</li><li> - <span class="tooltip"> - <code><a href="#//api/name/inSavePoint:">– inSavePoint:</a></code> - <span class="tooltip"><p>Start save point</p></span> - </span> - - -</li> - </ul> - - - <a title="SQLite library status" name="task_SQLite library status"></a> - <h3 class="subsubtitle task-title">SQLite library status</h3> - - <ul class="task-list"> - <li> - <span class="tooltip"> - <code><a href="#//api/name/isSQLiteThreadSafe">+ isSQLiteThreadSafe</a></code> - <span class="tooltip"><p>Test to see if the library is threadsafe</p></span> - </span> - - -</li><li> - <span class="tooltip"> - <code><a href="#//api/name/sqliteLibVersion">+ sqliteLibVersion</a></code> - <span class="tooltip"><p>Run-time library version numbers</p></span> - </span> - - -</li> - </ul> - - - <a title="Make SQL function" name="task_Make SQL function"></a> - <h3 class="subsubtitle task-title">Make SQL function</h3> - - <ul class="task-list"> - <li> - <span class="tooltip"> - <code><a href="#//api/name/makeFunctionNamed:maximumArguments:withBlock:">– makeFunctionNamed:maximumArguments:withBlock:</a></code> - <span class="tooltip"><p>Adds SQL functions or aggregates or to redefine the behavior of existing SQL functions or aggregates.</p></span> - </span> - - -</li> - </ul> - - - <a title="Date formatter" name="task_Date formatter"></a> - <h3 class="subsubtitle task-title">Date formatter</h3> - - <ul class="task-list"> - <li> - <span class="tooltip"> - <code><a href="#//api/name/storeableDateFormat:">+ storeableDateFormat:</a></code> - <span class="tooltip"><p>Generate an <code>NSDateFormatter</code> that won’t be broken by permutations of timezones or locales.</p></span> - </span> - - -</li><li> - <span class="tooltip"> - <code><a href="#//api/name/hasDateFormatter">– hasDateFormatter</a></code> - <span class="tooltip"><p>Test whether the database has a date formatter assigned.</p></span> - </span> - - -</li><li> - <span class="tooltip"> - <code><a href="#//api/name/setDateFormat:">– setDateFormat:</a></code> - <span class="tooltip"><p>Set to a date formatter to use string dates with sqlite instead of the default UNIX timestamps.</p></span> - </span> - - -</li><li> - <span class="tooltip"> - <code><a href="#//api/name/dateFromString:">– dateFromString:</a></code> - <span class="tooltip"><p>Convert the supplied NSString to NSDate, using the current database formatter.</p></span> - </span> - - -</li><li> - <span class="tooltip"> - <code><a href="#//api/name/stringFromDate:">– stringFromDate:</a></code> - <span class="tooltip"><p>Convert the supplied NSDate to NSString, using the current database formatter.</p></span> - </span> - - -</li> - </ul> - - </div> - - - - - - <div class="section section-methods"> - <a title="Properties" name="properties"></a> - <h2 class="subtitle subtitle-methods">Properties</h2> - - <div class="section-method"> - <a name="//api/name/cachedStatements" title="cachedStatements"></a> - <h3 class="subsubtitle method-title">cachedStatements</h3> - - - - <div class="method-subsection brief-description"> - <p>Dictionary of cached statements</p> - </div> - - + <h2 class="task-title">Properties</h2> - <div class="method-subsection method-declaration"><code>@property (atomic, retain) NSMutableDictionary *cachedStatements</code></div> + <div class="task-list"> + <div class="section-method"> + <a name="//api/name/traceExecution" title="traceExecution"></a> + <h3 class="method-title"><code><a href="#//api/name/traceExecution"> traceExecution</a></code> +</h3> - - - - - - - - - - - - - - - <div class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMDatabase.h</code><br /> - </div> - - -</div> - - <div class="section-method"> + <div class="method-info"> + <div class="pointy-thing"></div> + + <div class="method-info-container"> + + + <div class="method-subsection brief-description"> + <p>Whether should trace execution</p> + </div> + + + + <div class="method-subsection method-declaration"><code>@property (atomic, assign) BOOL traceExecution</code></div> + + + + + + + + + + <div class="method-subsection discussion-section"> + <h4 class="method-subtitle">Discussion</h4> + <p>Whether should trace execution</p> + </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/checkedOut" title="checkedOut"></a> - <h3 class="subsubtitle method-title">checkedOut</h3> - - - - <div class="method-subsection brief-description"> - <p>Whether checked out or not</p> - </div> - - + <h3 class="method-title"><code><a href="#//api/name/checkedOut"> checkedOut</a></code> +</h3> - <div class="method-subsection method-declaration"><code>@property (atomic, assign) BOOL checkedOut</code></div> + <div class="method-info"> + <div class="pointy-thing"></div> - - - - - - - - - - - - - - - <div class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMDatabase.h</code><br /> - </div> - - -</div> - - <div class="section-method"> + <div class="method-info-container"> + + + <div class="method-subsection brief-description"> + <p>Whether checked out or not</p> + </div> + + + + <div class="method-subsection method-declaration"><code>@property (atomic, assign) BOOL checkedOut</code></div> + + + + + + + + + + <div class="method-subsection discussion-section"> + <h4 class="method-subtitle">Discussion</h4> + <p>Whether checked out or not</p> + </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/crashOnErrors" title="crashOnErrors"></a> - <h3 class="subsubtitle method-title">crashOnErrors</h3> - - - - <div class="method-subsection brief-description"> - <p>Crash on errors</p> - </div> - - + <h3 class="method-title"><code><a href="#//api/name/crashOnErrors"> crashOnErrors</a></code> +</h3> - <div class="method-subsection method-declaration"><code>@property (atomic, assign) BOOL crashOnErrors</code></div> + <div class="method-info"> + <div class="pointy-thing"></div> - - - - - - - - - - - - - - - <div class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMDatabase.h</code><br /> - </div> - - -</div> - - <div class="section-method"> + <div class="method-info-container"> + + + <div class="method-subsection brief-description"> + <p>Crash on errors</p> + </div> + + + + <div class="method-subsection method-declaration"><code>@property (atomic, assign) BOOL crashOnErrors</code></div> + + + + + + + + + + <div class="method-subsection discussion-section"> + <h4 class="method-subtitle">Discussion</h4> + <p>Crash on errors</p> + </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/logsErrors" title="logsErrors"></a> - <h3 class="subsubtitle method-title">logsErrors</h3> - - - - <div class="method-subsection brief-description"> - <p>Logs errors</p> - </div> - - + <h3 class="method-title"><code><a href="#//api/name/logsErrors"> logsErrors</a></code> +</h3> - <div class="method-subsection method-declaration"><code>@property (atomic, assign) BOOL logsErrors</code></div> + <div class="method-info"> + <div class="pointy-thing"></div> - - - - - - - - - - - - - - - <div class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMDatabase.h</code><br /> - </div> - - -</div> - - <div class="section-method"> - <a name="//api/name/traceExecution" title="traceExecution"></a> - <h3 class="subsubtitle method-title">traceExecution</h3> - - - - <div class="method-subsection brief-description"> - <p>Whether should trace execution</p> - </div> - - + <div class="method-info-container"> + + + <div class="method-subsection brief-description"> + <p>Logs errors</p> + </div> + + - <div class="method-subsection method-declaration"><code>@property (atomic, assign) BOOL traceExecution</code></div> + <div class="method-subsection method-declaration"><code>@property (atomic, assign) BOOL logsErrors</code></div> - - - - - - - - - - - - - - - <div class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMDatabase.h</code><br /> - </div> - - + + + + + + + + + <div class="method-subsection discussion-section"> + <h4 class="method-subtitle">Discussion</h4> + <p>Logs errors</p> + </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/cachedStatements" title="cachedStatements"></a> + <h3 class="method-title"><code><a href="#//api/name/cachedStatements"> cachedStatements</a></code> +</h3> + + <div class="method-info"> + <div class="pointy-thing"></div> + + <div class="method-info-container"> + + + <div class="method-subsection brief-description"> + <p>Dictionary of cached statements</p> + </div> + + + + <div class="method-subsection method-declaration"><code>@property (atomic, retain) NSMutableDictionary *cachedStatements</code></div> + + + + + + + + + + <div class="method-subsection discussion-section"> + <h4 class="method-subtitle">Discussion</h4> + <p>Dictionary of cached statements</p> + </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> - </div> - - - - <div class="section section-methods"> - <a title="Class Methods" name="class_methods"></a> - <h2 class="subtitle subtitle-methods">Class Methods</h2> - - <div class="section-method"> + + <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/databaseWithPath:" title="databaseWithPath:"></a> - <h3 class="subsubtitle method-title">databaseWithPath:</h3> - - - - <div class="method-subsection brief-description"> - <p>Create a <code>FMDatabase</code> object.</p> - </div> - - + <h3 class="method-title"><code><a href="#//api/name/databaseWithPath:">+ databaseWithPath:</a></code> +</h3> - <div class="method-subsection method-declaration"><code>+ (instancetype)databaseWithPath:(NSString *)<em>inPath</em></code></div> + <div class="method-info"> + <div class="pointy-thing"></div> - - - <div class="method-subsection arguments-section parameters"> - <h4 class="method-subtitle parameter-title">Parameters</h4> - - <dl class="argument-def parameter-def"> - <dt><em>inPath</em></dt> - <dd><p>Path of database file</p></dd> - </dl> - - </div> - - - - <div class="method-subsection return"> - <h4 class="method-subtitle parameter-title">Return Value</h4> - <p><code>FMDatabase</code> object if successful; <code>nil</code> if failure.</p> - </div> - - - - - - <div class="method-subsection discussion-section"> - <h4 class="method-subtitle">Discussion</h4> - <p>An <code>FMDatabase</code> is created with a path to a SQLite database file. This path can be one of these three:</p> + <div class="method-info-container"> + + + <div class="method-subsection brief-description"> + <p>Create a <code>FMDatabase</code> object.</p> + </div> + + + + <div class="method-subsection method-declaration"><code>+ (instancetype)databaseWithPath:(NSString *)<em>inPath</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>inPath</code></th> + <td><p>Path of database file</p></td> + </tr> + + </table> + </div> + + + + <div class="method-subsection return"> + <h4 class="method-subtitle parameter-title">Return Value</h4> + <p><code>FMDatabase</code> object if successful; <code>nil</code> if failure.</p> + </div> + + + + + + <div class="method-subsection discussion-section"> + <h4 class="method-subtitle">Discussion</h4> + <p>Create a <code>FMDatabase</code> object.</p> + +<p>An <code>FMDatabase</code> is created with a path to a SQLite database file. This path can be one of these three:</p> <ol> <li>A file system path. The file does not have to exist on disk. If it does not exist, it is created for you.</li> @@ -1200,942 +570,1421 @@ FMDatabase *db = [FMDatabase databaseWithPath:dbPath]; </code></pre> <p>(For more information on temporary and in-memory databases, read the sqlite documentation on the subject: <a href="http://www.sqlite.org/inmemorydb.html">http://www.sqlite.org/inmemorydb.html</a>)</p> - </div> - - - - - - - - <div class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMDatabase.h</code><br /> - </div> - - -</div> - - <div class="section-method"> - <a name="//api/name/isSQLiteThreadSafe" title="isSQLiteThreadSafe"></a> - <h3 class="subsubtitle method-title">isSQLiteThreadSafe</h3> - - - - <div class="method-subsection brief-description"> - <p>Test to see if the library is threadsafe</p> - </div> - - + </div> + - <div class="method-subsection method-declaration"><code>+ (BOOL)isSQLiteThreadSafe</code></div> + - - - - - <div class="method-subsection return"> - <h4 class="method-subtitle parameter-title">Return Value</h4> - <p><code>NO</code> if and only if SQLite was compiled with mutexing code omitted due to the SQLITE_THREADSAFE compile-time option being set to 0.</p> - </div> - - - - - - - - - - <div class="method-subsection see-also-section"> - <h4 class="method-subtitle">See Also</h4> - <ul> - <li><code><p><a href="http://sqlite.org/c3ref/threadsafe.html">sqlite3_threadsafe()</a></p></code></li> + + + <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> + - </ul> + </div> </div> - - - - <div class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMDatabase.h</code><br /> - </div> - - -</div> - - <div class="section-method"> - <a name="//api/name/sqliteLibVersion" title="sqliteLibVersion"></a> - <h3 class="subsubtitle method-title">sqliteLibVersion</h3> - - - - <div class="method-subsection brief-description"> - <p>Run-time library version numbers</p> - </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> +</h3> - <div class="method-subsection method-declaration"><code>+ (NSString *)sqliteLibVersion</code></div> + <div class="method-info"> + <div class="pointy-thing"></div> - - - - - <div class="method-subsection return"> - <h4 class="method-subtitle parameter-title">Return Value</h4> - <p>The sqlite library version string.</p> - </div> - - - - - - - - - - <div class="method-subsection see-also-section"> - <h4 class="method-subtitle">See Also</h4> - <ul> + <div class="method-info-container"> - <li><code><p><a href="http://sqlite.org/c3ref/libversion.html">sqlite3_libversion()</a></p></code></li> - </ul> - </div> - - - - <div class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMDatabase.h</code><br /> - </div> - - -</div> - - <div class="section-method"> - <a name="//api/name/storeableDateFormat:" title="storeableDateFormat:"></a> - <h3 class="subsubtitle method-title">storeableDateFormat:</h3> - - - - <div class="method-subsection brief-description"> - <p>Generate an <code>NSDateFormatter</code> that won’t be broken by permutations of timezones or locales.</p> - </div> - - + <div class="method-subsection brief-description"> + <p>Initialize a <code>FMDatabase</code> object.</p> + </div> + + - <div class="method-subsection method-declaration"><code>+ (NSDateFormatter *)storeableDateFormat:(NSString *)<em>format</em></code></div> + <div class="method-subsection method-declaration"><code>- (instancetype)initWithPath:(NSString *)<em>inPath</em></code></div> - - - <div class="method-subsection arguments-section parameters"> - <h4 class="method-subtitle parameter-title">Parameters</h4> - - <dl class="argument-def parameter-def"> - <dt><em>format</em></dt> - <dd><p>A valid NSDateFormatter format string.</p></dd> - </dl> - - </div> - - - - <div class="method-subsection return"> - <h4 class="method-subtitle parameter-title">Return Value</h4> - <p>A <code>NSDateFormatter</code> that can be used for converting dates to strings and vice versa.</p> - </div> - - - - - - <div class="method-subsection discussion-section"> - <h4 class="method-subtitle">Discussion</h4> - <p>Use this method to generate values to set the dateFormat property.</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>inPath</code></th> + <td><p>Path of database file</p></td> + </tr> + + </table> + </div> + -<p>Example:</p> + + <div class="method-subsection return"> + <h4 class="method-subtitle parameter-title">Return Value</h4> + <p><code>FMDatabase</code> object if successful; <code>nil</code> if failure.</p> + </div> + -<pre><code>myDB.dateFormat = [FMDatabase storeableDateFormat:@"yyyy-MM-dd HH:mm:ss"]; -</code></pre><div class="warning"><p><strong>Warning:</strong> Note that <code>NSDateFormatter</code> is not thread-safe, so the formatter generated by this method should be assigned to only one FMDB instance and should not be used for other purposes.</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/hasDateFormatter">- hasDateFormatter</a></p></code></li> + - <li><code><p><a href="#//api/name/setDateFormat:">- setDateFormat:</a></p></code></li> + <div class="method-subsection discussion-section"> + <h4 class="method-subtitle">Discussion</h4> + <p>Initialize a <code>FMDatabase</code> object.</p> + +<p>An <code>FMDatabase</code> is created with a path to a SQLite database file. This path can be one of these three:</p> + +<ol> +<li>A file system path. The file does not have to exist on disk. If it does not exist, it is created for you.</li> +<li>An empty string (<code>@""</code>). An empty database is created at a temporary location. This database is deleted with the <code>FMDatabase</code> connection is closed.</li> +<li><code>nil</code>. An in-memory database is created. This database will be destroyed with the <code>FMDatabase</code> connection is closed.</li> +</ol> + + +<p>For example, to create/open a database in your Mac OS X <code>tmp</code> folder:</p> + +<pre><code>FMDatabase *db = [FMDatabase databaseWithPath:@"/tmp/tmp.db"]; +</code></pre> + +<p>Or, in iOS, you might open a database in the app’s <code>Documents</code> directory:</p> + +<pre><code>NSString *docsPath = NSSearchPathForDirectoriesInDomains(NSDocumentDirectory, NSUserDomainMask, YES)[0]; +NSString *dbPath = [docsPath stringByAppendingPathComponent:@"test.db"]; +FMDatabase *db = [FMDatabase databaseWithPath:dbPath]; +</code></pre> + +<p>(For more information on temporary and in-memory databases, read the sqlite documentation on the subject: <a href="http://www.sqlite.org/inmemorydb.html">http://www.sqlite.org/inmemorydb.html</a>)</p> + </div> - <li><code><p><a href="#//api/name/dateFromString:">- dateFromString:</a></p></code></li> + - <li><code><p><a href="#//api/name/stringFromDate:">- stringFromDate:</a></p></code></li> + - <li><code><p><a href="#//api/name/storeableDateFormat:">+ storeableDateFormat:</a></p></code></li> + - </ul> + <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 class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMDatabase.h</code><br /> - </div> - - </div> + </div> - </div> + + <a title="Opening and closing database" name="task_Opening and closing database"></a> + <h2 class="task-title">Opening and closing database</h2> + + <div class="task-list"> + <div class="section-method"> + <a name="//api/name/open" title="open"></a> + <h3 class="method-title"><code><a href="#//api/name/open">– open</a></code> +</h3> + + <div class="method-info"> + <div class="pointy-thing"></div> + + <div class="method-info-container"> + + + <div class="method-subsection brief-description"> + <p>Opening a new database connection</p> + </div> + + + + <div class="method-subsection method-declaration"><code>- (BOOL)open</code></div> + + + + + + <div class="method-subsection return"> + <h4 class="method-subtitle parameter-title">Return Value</h4> + <p><code>YES</code> if successful, <code>NO</code> on error.</p> + </div> + + + + + + <div class="method-subsection discussion-section"> + <h4 class="method-subtitle">Discussion</h4> + <p>Opening a new database connection</p> + +<p>The database is opened for reading and writing, and is created if it does not already exist.</p> + </div> + + + + + + <div class="method-subsection see-also-section"> + <h4 class="method-subtitle">See Also</h4> + <ul> + <li><code><p><a href="http://sqlite.org/c3ref/open.html">sqlite3_open()</a></p></code></li> + <li><code><p><a href="#//api/name/openWithFlags:">- openWithFlags:</a></p></code></li> - <div class="section section-methods"> - <a title="Instance Methods" name="instance_methods"></a> - <h2 class="subtitle subtitle-methods">Instance Methods</h2> - - <div class="section-method"> - <a name="//api/name/beginDeferredTransaction" title="beginDeferredTransaction"></a> - <h3 class="subsubtitle method-title">beginDeferredTransaction</h3> - - - - <div class="method-subsection brief-description"> - <p>Begin a deferred transaction</p> - </div> - - - - <div class="method-subsection method-declaration"><code>- (BOOL)beginDeferredTransaction</code></div> + <li><code><p><a href="#//api/name/close">- close</a></p></code></li> + + </ul> + </div> + - - - - - <div class="method-subsection return"> - <h4 class="method-subtitle parameter-title">Return Value</h4> - <p><code>YES</code> on success; <code>NO</code> on 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 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 class="method-subsection see-also-section"> - <h4 class="method-subtitle">See Also</h4> - <ul> +</div><div class="section-method"> + <a name="//api/name/openWithFlags:" title="openWithFlags:"></a> + <h3 class="method-title"><code><a href="#//api/name/openWithFlags:">– openWithFlags:</a></code> +</h3> + + <div class="method-info"> + <div class="pointy-thing"></div> + + <div class="method-info-container"> - <li><code><p><a href="#//api/name/commit">- commit</a></p></code></li> - <li><code><p><a href="#//api/name/rollback">- rollback</a></p></code></li> + <div class="method-subsection brief-description"> + <p>Opening a new database connection with flags</p> + </div> - <li><code><p><a href="#//api/name/beginTransaction">- beginTransaction</a></p></code></li> + + + <div class="method-subsection method-declaration"><code>- (BOOL)openWithFlags:(int)<em>flags</em></code></div> + + - <li><code><p><a href="#//api/name/inTransaction">- inTransaction</a></p></code></li> + <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>flags</code></th> + <td><p>one of the following three values, optionally combined with the <code>SQLITE_OPEN_NOMUTEX</code>, <code>SQLITE_OPEN_FULLMUTEX</code>, <code>SQLITE_OPEN_SHAREDCACHE</code>, <code>SQLITE_OPEN_PRIVATECACHE</code>, and/or <code>SQLITE_OPEN_URI</code> flags:</p> + +<p><code>SQLITE_OPEN_READONLY</code></p> + +<p>The database is opened in read-only mode. If the database does not already exist, an error is returned.</p> + +<p><code>SQLITE_OPEN_READWRITE</code></p> + +<p>The database is opened for reading and writing if possible, or reading only if the file is write protected by the operating system. In either case the database must already exist, otherwise an error is returned.</p> + +<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> + </tr> + + </table> + </div> - </ul> - </div> - - - - <div class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMDatabase.h</code><br /> - </div> - - -</div> - - <div class="section-method"> - <a name="//api/name/beginTransaction" title="beginTransaction"></a> - <h3 class="subsubtitle method-title">beginTransaction</h3> - - - - <div class="method-subsection brief-description"> - <p>Begin a transaction</p> - </div> - - - <div class="method-subsection method-declaration"><code>- (BOOL)beginTransaction</code></div> + + <div class="method-subsection return"> + <h4 class="method-subtitle parameter-title">Return Value</h4> + <p><code>YES</code> if successful, <code>NO</code> on error.</p> + </div> + - - - - - <div class="method-subsection return"> - <h4 class="method-subtitle parameter-title">Return Value</h4> - <p><code>YES</code> on success; <code>NO</code> on 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 see-also-section"> - <h4 class="method-subtitle">See Also</h4> - <ul> - <li><code><p><a href="#//api/name/commit">- commit</a></p></code></li> + - <li><code><p><a href="#//api/name/rollback">- rollback</a></p></code></li> + <div class="method-subsection discussion-section"> + <h4 class="method-subtitle">Discussion</h4> + <p>Opening a new database connection with flags</p> + </div> - <li><code><p><a href="#//api/name/beginDeferredTransaction">- beginDeferredTransaction</a></p></code></li> + - <li><code><p><a href="#//api/name/inTransaction">- inTransaction</a></p></code></li> + - </ul> + <div class="method-subsection see-also-section"> + <h4 class="method-subtitle">See Also</h4> + <ul> + + <li><code><p><a href="http://sqlite.org/c3ref/open.html">sqlite3_open_v2()</a></p></code></li> + + <li><code><p><a href="#//api/name/open">- open</a></p></code></li> + + <li><code><p><a href="#//api/name/close">- close</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 class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMDatabase.h</code><br /> - </div> - - -</div> - - <div class="section-method"> - <a name="//api/name/changes" title="changes"></a> - <h3 class="subsubtitle method-title">changes</h3> - - - - <div class="method-subsection brief-description"> - <p>The number of rows changed by prior SQL statement.</p> - </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> +</h3> - <div class="method-subsection method-declaration"><code>- (int)changes</code></div> + <div class="method-info"> + <div class="pointy-thing"></div> - - - - - <div class="method-subsection return"> - <h4 class="method-subtitle parameter-title">Return Value</h4> - <p>The number of rows changed by prior SQL statement.</p> - </div> - - - - - - <div class="method-subsection discussion-section"> - <h4 class="method-subtitle">Discussion</h4> - <p>This function returns the number of database rows that were changed or inserted or deleted by the most recently completed SQL statement on the database connection specified by the first parameter. Only changes that are directly specified by the INSERT, UPDATE, or DELETE statement are counted.</p> - </div> - - - - - - <div class="method-subsection see-also-section"> - <h4 class="method-subtitle">See Also</h4> - <ul> + <div class="method-info-container"> - <li><code><p><a href="http://sqlite.org/c3ref/changes.html">sqlite3_changes()</a></p></code></li> - </ul> - </div> - - - - <div class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMDatabase.h</code><br /> - </div> - - -</div> - - <div class="section-method"> - <a name="//api/name/clearCachedStatements" title="clearCachedStatements"></a> - <h3 class="subsubtitle method-title">clearCachedStatements</h3> - - - - <div class="method-subsection brief-description"> - <p>Clear cached statements</p> - </div> - - + <div class="method-subsection brief-description"> + <p>Closing a database connection</p> + </div> + + - <div class="method-subsection method-declaration"><code>- (void)clearCachedStatements</code></div> + <div class="method-subsection method-declaration"><code>- (BOOL)close</code></div> - - - - - - - - - - - - - - - <div class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMDatabase.h</code><br /> - </div> - - -</div> - - <div class="section-method"> - <a name="//api/name/close" title="close"></a> - <h3 class="subsubtitle method-title">close</h3> - - - - <div class="method-subsection brief-description"> - <p>Closing a database connection</p> - </div> - - + + - <div class="method-subsection method-declaration"><code>- (BOOL)close</code></div> + + <div class="method-subsection return"> + <h4 class="method-subtitle parameter-title">Return Value</h4> + <p><code>YES</code> if success, <code>NO</code> on error.</p> + </div> + - - - - - <div class="method-subsection return"> - <h4 class="method-subtitle parameter-title">Return Value</h4> - <p><code>YES</code> if success, <code>NO</code> on error.</p> - </div> - - - - - - - - - - <div class="method-subsection see-also-section"> - <h4 class="method-subtitle">See Also</h4> - <ul> - <li><code><p><a href="http://sqlite.org/c3ref/close.html">sqlite3_close()</a></p></code></li> + + + <div class="method-subsection discussion-section"> + <h4 class="method-subtitle">Discussion</h4> + <p>Closing a database connection</p> + </div> + + + + + + <div class="method-subsection see-also-section"> + <h4 class="method-subtitle">See Also</h4> + <ul> + + <li><code><p><a href="http://sqlite.org/c3ref/close.html">sqlite3_close()</a></p></code></li> + + <li><code><p><a href="#//api/name/open">- open</a></p></code></li> + + <li><code><p><a href="#//api/name/openWithFlags:">- openWithFlags:</a></p></code></li> + + </ul> + </div> + + - <li><code><p><a href="#//api/name/open">- open</a></p></code></li> + <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> - <li><code><p><a href="#//api/name/openWithFlags:">- openWithFlags:</a></p></code></li> - </ul> + </div> </div> - - - - <div class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMDatabase.h</code><br /> - </div> - - -</div> - - <div class="section-method"> - <a name="//api/name/closeOpenResultSets" title="closeOpenResultSets"></a> - <h3 class="subsubtitle method-title">closeOpenResultSets</h3> - - - - <div class="method-subsection brief-description"> - <p>Close all open result sets</p> - </div> - - +</div><div class="section-method"> + <a name="//api/name/goodConnection" title="goodConnection"></a> + <h3 class="method-title"><code><a href="#//api/name/goodConnection">– goodConnection</a></code> +</h3> - <div class="method-subsection method-declaration"><code>- (void)closeOpenResultSets</code></div> + <div class="method-info"> + <div class="pointy-thing"></div> - - - - - - - - - - - - - - - <div class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMDatabase.h</code><br /> - </div> - - -</div> - - <div class="section-method"> - <a name="//api/name/commit" title="commit"></a> - <h3 class="subsubtitle method-title">commit</h3> - - - - <div class="method-subsection brief-description"> - <p>Commit a transaction</p> - </div> - - + <div class="method-info-container"> + + + <div class="method-subsection brief-description"> + <p>Test to see if we have a good connection to the database.</p> + </div> + + - <div class="method-subsection method-declaration"><code>- (BOOL)commit</code></div> + <div class="method-subsection method-declaration"><code>- (BOOL)goodConnection</code></div> - - - - - <div class="method-subsection return"> - <h4 class="method-subtitle parameter-title">Return Value</h4> - <p><code>YES</code> on success; <code>NO</code> on 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>Commit a transaction that was initiated with either <a href="#//api/name/beginTransaction"><code>beginTransaction</code></a> or with <a href="#//api/name/beginDeferredTransaction"><code>beginDeferredTransaction</code></a>.</p> - </div> - - - - - - <div class="method-subsection see-also-section"> - <h4 class="method-subtitle">See Also</h4> - <ul> + - <li><code><p><a href="#//api/name/beginTransaction">- beginTransaction</a></p></code></li> + - <li><code><p><a href="#//api/name/beginDeferredTransaction">- beginDeferredTransaction</a></p></code></li> + <div class="method-subsection return"> + <h4 class="method-subtitle parameter-title">Return Value</h4> + <p><code>YES</code> if everything succeeds, <code>NO</code> on failure.</p> + </div> - <li><code><p><a href="#//api/name/rollback">- rollback</a></p></code></li> + - <li><code><p><a href="#//api/name/inTransaction">- inTransaction</a></p></code></li> + - </ul> - </div> - - - - <div class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMDatabase.h</code><br /> - </div> - - -</div> - - <div class="section-method"> - <a name="//api/name/databasePath" title="databasePath"></a> - <h3 class="subsubtitle method-title">databasePath</h3> - - - - <div class="method-subsection brief-description"> - <p>The path of the database file</p> - </div> - - + <div class="method-subsection discussion-section"> + <h4 class="method-subtitle">Discussion</h4> + <p>Test to see if we have a good connection to the database.</p> - <div class="method-subsection method-declaration"><code>- (NSString *)databasePath</code></div> +<p>This will confirm whether:</p> - - - - - <div class="method-subsection return"> - <h4 class="method-subtitle parameter-title">Return Value</h4> - <p>path of database.</p> +<ul> +<li>is database open</li> +<li>if open, it will try a simple SELECT statement and confirm that it succeeds.</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 class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMDatabase.h</code><br /> - </div> - - </div> + </div> - <div class="section-method"> - <a name="//api/name/dateFromString:" title="dateFromString:"></a> - <h3 class="subsubtitle method-title">dateFromString:</h3> - - - - <div class="method-subsection brief-description"> - <p>Convert the supplied NSString to NSDate, using the current database formatter.</p> - </div> - - - <div class="method-subsection method-declaration"><code>- (NSDate *)dateFromString:(NSString *)<em>s</em></code></div> + <a title="Perform updates" name="task_Perform updates"></a> + <h2 class="task-title">Perform updates</h2> - - - <div class="method-subsection arguments-section parameters"> - <h4 class="method-subtitle parameter-title">Parameters</h4> - - <dl class="argument-def parameter-def"> - <dt><em>s</em></dt> - <dd><p><code>NSString</code> to convert to <code>NSDate</code>.</p></dd> - </dl> - + <div class="task-list"> + <div class="section-method"> + <a name="//api/name/executeUpdate:withErrorAndBindings:" title="executeUpdate:withErrorAndBindings:"></a> + <h3 class="method-title"><code><a href="#//api/name/executeUpdate:withErrorAndBindings:">– executeUpdate:withErrorAndBindings:</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> withErrorAndBindings:(NSError **)<em>outErr</em>, <em>...</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>outErr</code></th> + <td><p>A reference to the <code>NSError</code> pointer to be updated with an auto released <code>NSError</code> object if an error if an error occurs. If <code>nil</code>, no <code>NSError</code> object will be returned.</p></td> + </tr> + + <tr> + <th scope="row" class="argument-name"><code>...</code></th> + <td><p>Optional parameters to bind to <code>?</code> placeholders in the SQL statement. These should be Objective-C objects (e.g. <code>NSString</code>, <code>NSNumber</code>, etc.), not fundamental C data types (e.g. <code>int</code>, <code>char *</code>, etc.).</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>, <a href="http://sqlite.org/c3ref/bind_blob.html"><code>sqlite3_bind</code></a> to bind values to <code>?</code> placeholders in the SQL with the optional list of parameters, and <a href="http://sqlite.org/c3ref/step.html"><code>sqlite_step</code></a> to perform the update.</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> + </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> + + <li><code><p><a href="#//api/name/lastErrorMessage">- lastErrorMessage</a></p></code></li> + + <li><code><p><a href="http://sqlite.org/c3ref/bind_blob.html"><code>sqlite3_bind</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 class="method-subsection return"> - <h4 class="method-subtitle parameter-title">Return Value</h4> - <p>The <code>NSDate</code> object; or <code>nil</code> if no formatter is set.</p> +</div><div class="section-method"> + <a name="//api/name/update:withErrorAndBindings:" title="update:withErrorAndBindings:"></a> + <h3 class="method-title"><code><a href="#//api/name/update:withErrorAndBindings:">– update:withErrorAndBindings:</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)update:(NSString *)<em>sql</em> withErrorAndBindings:(NSError **)<em>outErr</em>, <em>...</em></code></div> + + + + + + + + + + <div class="method-subsection discussion-section"> + <h4 class="method-subtitle">Discussion</h4> + <p>Execute single update statement</p><div class="warning"><p><strong>Warning:</strong> <strong>Deprecated</strong>: Please use <code><executeUpdate:withErrorAndBindings></code> instead.</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/executeUpdate:withErrorAndBindings:">- executeUpdate:withErrorAndBindings:</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 class="method-subsection see-also-section"> - <h4 class="method-subtitle">See Also</h4> - <ul> +</div><div class="section-method"> + <a name="//api/name/executeUpdate:" title="executeUpdate:"></a> + <h3 class="method-title"><code><a href="#//api/name/executeUpdate:">– executeUpdate:</a></code> +</h3> + + <div class="method-info"> + <div class="pointy-thing"></div> + + <div class="method-info-container"> - <li><code><p><a href="#//api/name/hasDateFormatter">- hasDateFormatter</a></p></code></li> - <li><code><p><a href="#//api/name/setDateFormat:">- setDateFormat:</a></p></code></li> + <div class="method-subsection brief-description"> + <p>Execute single update statement</p> + </div> - <li><code><p><a href="#//api/name/dateFromString:">- dateFromString:</a></p></code></li> + + + <div class="method-subsection method-declaration"><code>- (BOOL)executeUpdate:(NSString *)<em>sql</em>, <em>...</em></code></div> + + - <li><code><p><a href="#//api/name/stringFromDate:">- stringFromDate:</a></p></code></li> + <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>...</code></th> + <td><p>Optional parameters to bind to <code>?</code> placeholders in the SQL statement. These should be Objective-C objects (e.g. <code>NSString</code>, <code>NSNumber</code>, etc.), not fundamental C data types (e.g. <code>int</code>, <code>char *</code>, etc.).</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> - <li><code><p><a href="#//api/name/storeableDateFormat:">+ storeableDateFormat:</a></p></code></li> + + + + + <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>, <a href="http://sqlite.org/c3ref/bind_blob.html"><code>sqlite3_bind</code></a> to bind values to <code>?</code> placeholders in the SQL with the optional list of parameters, and <a href="http://sqlite.org/c3ref/step.html"><code>sqlite_step</code></a> to perform the update.</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><div class="note"><p><strong>Note:</strong> This technique supports the use of <code>?</code> placeholders in the SQL, automatically binding any supplied value parameters to those placeholders. This approach is more robust than techniques that entail using <code>stringWithFormat</code> to manually build SQL statements, which can be problematic if the values happened to include any characters that needed to be quoted.</p></div><div class="note"><p><strong>Note:</strong> If you want to use this from Swift, please note that you must include <code>FMDatabaseVariadic.swift</code> in your project. Without that, you cannot use this method directly, and instead have to use methods such as <a href="#//api/name/executeUpdate:withArgumentsInArray:"><code>executeUpdate:withArgumentsInArray:</code></a>.</p></div> + </div> - </ul> + + + + + <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> + + <li><code><p><a href="#//api/name/lastErrorMessage">- lastErrorMessage</a></p></code></li> + + <li><code><p><a href="http://sqlite.org/c3ref/bind_blob.html"><code>sqlite3_bind</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 class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMDatabase.h</code><br /> - </div> - - -</div> - - <div class="section-method"> - <a name="//api/name/executeQuery:" title="executeQuery:"></a> - <h3 class="subsubtitle method-title">executeQuery:</h3> - - - - <div class="method-subsection brief-description"> - <p>Execute select statement</p> - </div> - - +</div><div class="section-method"> + <a name="//api/name/executeUpdateWithFormat:" title="executeUpdateWithFormat:"></a> + <h3 class="method-title"><code><a href="#//api/name/executeUpdateWithFormat:">– executeUpdateWithFormat:</a></code> +</h3> - <div class="method-subsection method-declaration"><code>- (FMResultSet *)executeQuery:(NSString *)<em>sql</em>, <em>...</em></code></div> + <div class="method-info"> + <div class="pointy-thing"></div> - - - <div class="method-subsection arguments-section parameters"> - <h4 class="method-subtitle parameter-title">Parameters</h4> - - <dl class="argument-def parameter-def"> - <dt><em>sql</em></dt> - <dd><p>The SELECT statement to be performed, with optional <code>?</code> placeholders.</p></dd> - </dl> - - <dl class="argument-def parameter-def"> - <dt><em>...</em></dt> - <dd><p>Optional parameters to bind to <code>?</code> placeholders in the SQL statement. These should be Objective-C objects (e.g. <code>NSString</code>, <code>NSNumber</code>, etc.), not fundamental C data types (e.g. <code>int</code>, <code>char *</code>, etc.).</p></dd> - </dl> - + <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)executeUpdateWithFormat:(NSString *)<em>format</em>, <em>...</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>format</code></th> + <td><p>The SQL to be performed, with <code>printf</code>-style escape sequences.</p></td> + </tr> + + <tr> + <th scope="row" class="argument-name"><code>...</code></th> + <td><p>Optional parameters to bind to use in conjunction with the <code>printf</code>-style escape sequences in the SQL statement.</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/step.html"><code>sqlite_step</code></a> to perform the update. Unlike the other <code>executeUpdate</code> methods, this uses printf-style formatters (e.g. <code>%s</code>, <code>%d</code>, etc.) to build the SQL. Do not use <code>?</code> placeholders in the SQL if you use this method.</p><div class="note"><p><strong>Note:</strong> This method does not technically perform a traditional printf-style replacement. What this method actually does is replace the printf-style percent sequences with a SQLite <code>?</code> placeholder, and then bind values to that placeholder. Thus the following command</p> + +<pre><code>[db executeUpdateWithFormat:@"INSERT INTO test (name) VALUES (%@)", @"Gus"]; +</code></pre> + +<p>is actually replacing the <code>%@</code> with <code>?</code> placeholder, and then performing something equivalent to <a href="#//api/name/executeUpdate:"><code>executeUpdate:</code></a></p> + +<pre><code>[db executeUpdate:@"INSERT INTO test (name) VALUES (?)", @"Gus"]; +</code></pre> + +<p>There are two reasons why this distinction is important. First, the printf-style escape sequences can only be used where it is permissible to use a SQLite <code>?</code> placeholder. You can use it only for values in SQL statements, but not for table names or column names or any other non-value context. This method also cannot be used in conjunction with <code>pragma</code> statements and the like. Second, note the lack of quotation marks in the SQL. The <code>VALUES</code> clause was <em>not</em> <code>VALUES ('%@')</code> (like you might have to do if you built a SQL statement using <code>NSString</code> method <code>stringWithFormat</code>), but rather simply <code>VALUES (%@)</code>.</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/executeUpdate:">- executeUpdate:</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 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="section-method"> + <a name="//api/name/executeUpdate:withArgumentsInArray:" title="executeUpdate:withArgumentsInArray:"></a> + <h3 class="method-title"><code><a href="#//api/name/executeUpdate:withArgumentsInArray:">– executeUpdate:withArgumentsInArray:</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> withArgumentsInArray:(NSArray *)<em>arguments</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>arguments</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> + + </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> + </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> + + <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 class="method-subsection discussion-section"> - <h4 class="method-subtitle">Discussion</h4> - <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> +</div><div class="section-method"> + <a name="//api/name/executeUpdate:withParameterDictionary:" title="executeUpdate:withParameterDictionary:"></a> + <h3 class="method-title"><code><a href="#//api/name/executeUpdate:withParameterDictionary:">– executeUpdate:withParameterDictionary:</a></code> +</h3> -<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> + <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> + + -<p>This method employs <a href="http://sqlite.org/c3ref/bind_blob.html"><code>sqlite3_bind</code></a> for any optional value parameters. This properly escapes any characters that need escape sequences (e.g. quotation marks), which eliminates simple SQL errors as well as protects against SQL injection attacks. This method natively handles <code>NSString</code>, <code>NSNumber</code>, <code>NSNull</code>, <code>NSDate</code>, and <code>NSData</code> objects. All other object types will be interpreted as text values using the object’s <code>description</code> method.</p> + <div class="method-subsection method-declaration"><code>- (BOOL)executeUpdate:(NSString *)<em>sql</em> withParameterDictionary:(NSDictionary *)<em>arguments</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>arguments</code></th> + <td><p>A <code>NSDictionary</code> of objects keyed by column names that will be used when binding values to the <code>?</code> placeholders in the SQL statement.</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/step.html"><code>sqlite_step</code></a> to perform the update. Unlike the other <code>executeUpdate</code> methods, this uses printf-style formatters (e.g. <code>%s</code>, <code>%d</code>, etc.) to build the SQL.</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> + </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> + + <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 class="method-subsection see-also-section"> - <h4 class="method-subtitle">See Also</h4> - <ul> +</div><div class="section-method"> + <a name="//api/name/executeUpdate:withVAList:" title="executeUpdate:withVAList:"></a> + <h3 class="method-title"><code><a href="#//api/name/executeUpdate:withVAList:">– executeUpdate:withVAList:</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> withVAList:(va_list)<em>args</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>args</code></th> + <td><p>A <code>va_list</code> of arguments.</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/step.html"><code>sqlite_step</code></a> to perform the update. Unlike the other <code>executeUpdate</code> methods, this uses printf-style formatters (e.g. <code>%s</code>, <code>%d</code>, etc.) to build the SQL.</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> + </div> + + + + - <li><code><p><a href="../Classes/FMResultSet.html">FMResultSet</a></p></code></li> + <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> + + <li><code><p><a href="#//api/name/lastErrorMessage">- lastErrorMessage</a></p></code></li> + + </ul> + </div> + + - <li><code><p><a href="../Classes/FMResultSet.html#//api/name/next"><code>FMResultSet next</code></a></p></code></li> + <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> - <li><code><p><a href="http://sqlite.org/c3ref/bind_blob.html"><code>sqlite3_bind</code></a></p></code></li> - </ul> + </div> </div> - - - - <div class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMDatabase.h</code><br /> - </div> - - -</div> - - <div class="section-method"> - <a name="//api/name/executeQuery:withArgumentsInArray:" title="executeQuery:withArgumentsInArray:"></a> - <h3 class="subsubtitle method-title">executeQuery:withArgumentsInArray:</h3> - - - - <div class="method-subsection brief-description"> - <p>Execute select statement</p> - </div> - - +</div><div class="section-method"> + <a name="//api/name/executeStatements:" title="executeStatements:"></a> + <h3 class="method-title"><code><a href="#//api/name/executeStatements:">– executeStatements:</a></code> +</h3> - <div class="method-subsection method-declaration"><code>- (FMResultSet *)executeQuery:(NSString *)<em>sql</em> withArgumentsInArray:(NSArray *)<em>arguments</em></code></div> + <div class="method-info"> + <div class="pointy-thing"></div> - - - <div class="method-subsection arguments-section parameters"> - <h4 class="method-subtitle parameter-title">Parameters</h4> - - <dl class="argument-def parameter-def"> - <dt><em>sql</em></dt> - <dd><p>The SELECT statement to be performed, with optional <code>?</code> placeholders.</p></dd> - </dl> - - <dl class="argument-def parameter-def"> - <dt><em>arguments</em></dt> - <dd><p>A <code>NSArray</code> of objects to be used when binding values to the <code>?</code> placeholders in the SQL statement.</p></dd> - </dl> - + <div class="method-info-container"> + + + <div class="method-subsection brief-description"> + <p>Execute multiple SQL statements</p> + </div> + + + + <div class="method-subsection method-declaration"><code>- (BOOL)executeStatements:(NSString *)<em>sql</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</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 multiple SQL statements</p> + +<p>This executes a series of SQL statements that are combined in a single string (e.g. the SQL generated by the <code>sqlite3</code> command line <code>.dump</code> command). This accepts no value parameters, but rather simply expects a single string with multiple SQL statements, each terminated with a semicolon. This uses <code>sqlite3_exec</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/executeStatements:withResultBlock:">- executeStatements:withResultBlock:</a></p></code></li> + + <li><code><p><a href="http://sqlite.org/c3ref/exec.html">sqlite3_exec()</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 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="section-method"> + <a name="//api/name/executeStatements:withResultBlock:" title="executeStatements:withResultBlock:"></a> + <h3 class="method-title"><code><a href="#//api/name/executeStatements:withResultBlock:">– executeStatements:withResultBlock:</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 multiple SQL statements with callback handler</p> + </div> + + + + <div class="method-subsection method-declaration"><code>- (BOOL)executeStatements:(NSString *)<em>sql</em> withResultBlock:(FMDBExecuteStatementsCallbackBlock)<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>sql</code></th> + <td><p>The SQL to be performed.</p></td> + </tr> + + <tr> + <th scope="row" class="argument-name"><code>block</code></th> + <td><p>A block that will be called for any result sets returned by any SQL statements. + Note, if you supply this block, it must return integer value, zero upon success (this would be a good opportunity to use SQLITE_OK), + non-zero value upon failure (which will stop the bulk execution of the SQL). If a statement returns values, the block will be called with the results from the query in NSDictionary *resultsDictionary. + This may be <code>nil</code> if you don’t care to receive any results.</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 multiple SQL statements with callback handler</p> + +<p>This executes a series of SQL statements that are combined in a single string (e.g. the SQL generated by the <code>sqlite3</code> command line <code>.dump</code> command). This accepts no value parameters, but rather simply expects a single string with multiple SQL statements, each terminated with a semicolon. This uses <code>sqlite3_exec</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/executeStatements:">- executeStatements:</a></p></code></li> + + <li><code><p><a href="http://sqlite.org/c3ref/exec.html">sqlite3_exec()</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 class="method-subsection discussion-section"> - <h4 class="method-subtitle">Discussion</h4> - <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> +</div><div class="section-method"> + <a name="//api/name/lastInsertRowId" title="lastInsertRowId"></a> + <h3 class="method-title"><code><a href="#//api/name/lastInsertRowId">– lastInsertRowId</a></code> +</h3> -<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> + <div class="method-info"> + <div class="pointy-thing"></div> + + <div class="method-info-container"> + + + <div class="method-subsection brief-description"> + <p>Last insert rowid</p> + </div> + + + + <div class="method-subsection method-declaration"><code>- (sqlite_int64)lastInsertRowId</code></div> + + + + + + <div class="method-subsection return"> + <h4 class="method-subtitle parameter-title">Return Value</h4> + <p>The rowid of the last inserted row.</p> + </div> + + + + + + <div class="method-subsection discussion-section"> + <h4 class="method-subtitle">Discussion</h4> + <p>Last insert rowid</p> + +<p>Each entry in an SQLite table has a unique 64-bit signed integer key called the “rowid”. The rowid is always available as an undeclared column named <code>ROWID</code>, <code>OID</code>, or <code>_ROWID_</code> as long as those names are not also used by explicitly declared columns. If the table has a column of type <code>INTEGER PRIMARY KEY</code> then that column is another alias for the rowid.</p> + +<p>This routine returns the rowid of the most recent successful <code>INSERT</code> into the database from the database connection in the first argument. As of SQLite version 3.7.7, this routines records the last insert rowid of both ordinary tables and virtual tables. If no successful <code>INSERT</code>s have ever occurred on that database connection, zero is returned.</p> + </div> + + + + + + <div class="method-subsection see-also-section"> + <h4 class="method-subtitle">See Also</h4> + <ul> + + <li><code><p><a href="http://sqlite.org/c3ref/last_insert_rowid.html">sqlite3_last_insert_rowid()</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 class="method-subsection see-also-section"> - <h4 class="method-subtitle">See Also</h4> - <ul> +</div><div class="section-method"> + <a name="//api/name/changes" title="changes"></a> + <h3 class="method-title"><code><a href="#//api/name/changes">– changes</a></code> +</h3> + + <div class="method-info"> + <div class="pointy-thing"></div> + + <div class="method-info-container"> + + + <div class="method-subsection brief-description"> + <p>The number of rows changed by prior SQL statement.</p> + </div> + + + + <div class="method-subsection method-declaration"><code>- (int)changes</code></div> + + + + + + <div class="method-subsection return"> + <h4 class="method-subtitle parameter-title">Return Value</h4> + <p>The number of rows changed by prior SQL statement.</p> + </div> + + + + + + <div class="method-subsection discussion-section"> + <h4 class="method-subtitle">Discussion</h4> + <p>The number of rows changed by prior SQL statement.</p> + +<p>This function returns the number of database rows that were changed or inserted or deleted by the most recently completed SQL statement on the database connection specified by the first parameter. Only changes that are directly specified by the INSERT, UPDATE, or DELETE statement are counted.</p> + </div> - <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 class="method-subsection see-also-section"> + <h4 class="method-subtitle">See Also</h4> + <ul> + + <li><code><p><a href="http://sqlite.org/c3ref/changes.html">sqlite3_changes()</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 class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMDatabase.h</code><br /> - </div> - - </div> + </div> - <div class="section-method"> - <a name="//api/name/executeQuery:withParameterDictionary:" title="executeQuery:withParameterDictionary:"></a> - <h3 class="subsubtitle method-title">executeQuery:withParameterDictionary:</h3> - - - - <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> withParameterDictionary:(NSDictionary *)<em>arguments</em></code></div> + <a title="Retrieving results" name="task_Retrieving results"></a> + <h2 class="task-title">Retrieving results</h2> - - - <div class="method-subsection arguments-section parameters"> - <h4 class="method-subtitle parameter-title">Parameters</h4> - - <dl class="argument-def parameter-def"> - <dt><em>sql</em></dt> - <dd><p>The SELECT statement to be performed, with optional <code>?</code> placeholders.</p></dd> - </dl> - - <dl class="argument-def parameter-def"> - <dt><em>arguments</em></dt> - <dd><p>A <code>NSDictionary</code> of objects keyed by column names that will be used when binding values to the <code>?</code> placeholders in the SQL statement.</p></dd> - </dl> - - </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>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> + <div class="task-list"> + <div class="section-method"> + <a name="//api/name/executeQuery:" title="executeQuery:"></a> + <h3 class="method-title"><code><a href="#//api/name/executeQuery:">– executeQuery:</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>, <em>...</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>...</code></th> + <td><p>Optional parameters to bind to <code>?</code> placeholders in the SQL statement. These should be Objective-C objects (e.g. <code>NSString</code>, <code>NSNumber</code>, etc.), not fundamental C data types (e.g. <code>int</code>, <code>char *</code>, etc.).</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> - </div> - - - - - - <div class="method-subsection see-also-section"> - <h4 class="method-subtitle">See Also</h4> - <ul> + +<p>This method employs <a href="http://sqlite.org/c3ref/bind_blob.html"><code>sqlite3_bind</code></a> for any optional value parameters. This properly escapes any characters that need escape sequences (e.g. quotation marks), which eliminates simple SQL errors as well as protects against SQL injection attacks. This method natively handles <code>NSString</code>, <code>NSNumber</code>, <code>NSNull</code>, <code>NSDate</code>, and <code>NSData</code> objects. All other object types will be interpreted as text values using the object’s <code>description</code> method.</p><div class="note"><p><strong>Note:</strong> If you want to use this from Swift, please note that you must include <code>FMDatabaseVariadic.swift</code> in your project. Without that, you cannot use this method directly, and instead have to use methods such as <a href="#//api/name/executeQuery:withArgumentsInArray:"><code>executeQuery:withArgumentsInArray:</code></a>.</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> + + <li><code><p><a href="http://sqlite.org/c3ref/bind_blob.html"><code>sqlite3_bind</code></a></p></code></li> + + </ul> + </div> + + - <li><code><p><a href="../Classes/FMResultSet.html">FMResultSet</a></p></code></li> + <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> - <li><code><p><a href="../Classes/FMResultSet.html#//api/name/next"><code>FMResultSet next</code></a></p></code></li> - </ul> + </div> </div> - - - - <div class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMDatabase.h</code><br /> - </div> - - -</div> - - <div class="section-method"> +</div><div class="section-method"> <a name="//api/name/executeQueryWithFormat:" title="executeQueryWithFormat:"></a> - <h3 class="subsubtitle method-title">executeQueryWithFormat:</h3> - - - - <div class="method-subsection brief-description"> - <p>Execute select statement</p> - </div> - - + <h3 class="method-title"><code><a href="#//api/name/executeQueryWithFormat:">– executeQueryWithFormat:</a></code> +</h3> - <div class="method-subsection method-declaration"><code>- (FMResultSet *)executeQueryWithFormat:(NSString *)<em>format</em>, <em>...</em></code></div> + <div class="method-info"> + <div class="pointy-thing"></div> - - - <div class="method-subsection arguments-section parameters"> - <h4 class="method-subtitle parameter-title">Parameters</h4> - - <dl class="argument-def parameter-def"> - <dt><em>format</em></dt> - <dd><p>The SQL to be performed, with <code>printf</code>-style escape sequences.</p></dd> - </dl> - - <dl class="argument-def parameter-def"> - <dt><em>...</em></dt> - <dd><p>Optional parameters to bind to use in conjunction with the <code>printf</code>-style escape sequences in the SQL statement.</p></dd> - </dl> - - </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>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> + <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 *)executeQueryWithFormat:(NSString *)<em>format</em>, <em>...</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>format</code></th> + <td><p>The SQL to be performed, with <code>printf</code>-style escape sequences.</p></td> + </tr> + + <tr> + <th scope="row" class="argument-name"><code>...</code></th> + <td><p>Optional parameters to bind to use in conjunction with the <code>printf</code>-style escape sequences in the SQL statement.</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><div class="note"><p><strong>Note:</strong> This method does not technically perform a traditional printf-style replacement. What this method actually does is replace the printf-style percent sequences with a SQLite <code>?</code> placeholder, and then bind values to that placeholder. Thus the following command</p> @@ -2148,1327 +1997,1986 @@ FMDatabase *db = [FMDatabase databaseWithPath:dbPath]; </code></pre> <p>There are two reasons why this distinction is important. First, the printf-style escape sequences can only be used where it is permissible to use a SQLite <code>?</code> placeholder. You can use it only for values in SQL statements, but not for table names or column names or any other non-value context. This method also cannot be used in conjunction with <code>pragma</code> statements and the like. Second, note the lack of quotation marks in the SQL. The <code>WHERE</code> clause was <em>not</em> <code>WHERE name='%@'</code> (like you might have to do if you built a SQL statement using <code>NSString</code> method <code>stringWithFormat</code>), but rather simply <code>WHERE name=%@</code>.</p></div> - </div> - - - - - - <div class="method-subsection see-also-section"> - <h4 class="method-subtitle">See Also</h4> - <ul> + </div> + + + + - <li><code><p><a href="#//api/name/executeQuery:">- executeQuery:</a></p></code></li> + <div class="method-subsection see-also-section"> + <h4 class="method-subtitle">See Also</h4> + <ul> + + <li><code><p><a href="#//api/name/executeQuery:">- executeQuery:</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> + + - <li><code><p><a href="../Classes/FMResultSet.html">FMResultSet</a></p></code></li> + <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> - <li><code><p><a href="../Classes/FMResultSet.html#//api/name/next"><code>FMResultSet next</code></a></p></code></li> - </ul> + </div> </div> - - - - <div class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMDatabase.h</code><br /> - </div> - - -</div> - - <div class="section-method"> - <a name="//api/name/executeStatements:" title="executeStatements:"></a> - <h3 class="subsubtitle method-title">executeStatements:</h3> - - - - <div class="method-subsection brief-description"> - <p>Execute multiple SQL statements</p> - </div> - - +</div><div class="section-method"> + <a name="//api/name/executeQuery:withArgumentsInArray:" title="executeQuery:withArgumentsInArray:"></a> + <h3 class="method-title"><code><a href="#//api/name/executeQuery:withArgumentsInArray:">– executeQuery:withArgumentsInArray:</a></code> +</h3> - <div class="method-subsection method-declaration"><code>- (BOOL)executeStatements:(NSString *)<em>sql</em></code></div> + <div class="method-info"> + <div class="pointy-thing"></div> - - - <div class="method-subsection arguments-section parameters"> - <h4 class="method-subtitle parameter-title">Parameters</h4> - - <dl class="argument-def parameter-def"> - <dt><em>sql</em></dt> - <dd><p>The SQL to be performed</p></dd> - </dl> - - </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>This executes a series of SQL statements that are combined in a single string (e.g. the SQL generated by the <code>sqlite3</code> command line <code>.dump</code> command). This accepts no value parameters, but rather simply expects a single string with multiple SQL statements, each terminated with a semicolon. This uses <code>sqlite3_exec</code>.</p> - </div> - - - - - - <div class="method-subsection see-also-section"> - <h4 class="method-subtitle">See Also</h4> - <ul> + <div class="method-info-container"> - <li><code><p><a href="#//api/name/executeStatements:withResultBlock:">- executeStatements:withResultBlock:</a></p></code></li> - <li><code><p><a href="http://sqlite.org/c3ref/exec.html">sqlite3_exec()</a></p></code></li> + <div class="method-subsection brief-description"> + <p>Execute select statement</p> + </div> - </ul> - </div> - - - - <div class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMDatabase.h</code><br /> - </div> - - -</div> - - <div class="section-method"> - <a name="//api/name/executeStatements:withResultBlock:" title="executeStatements:withResultBlock:"></a> - <h3 class="subsubtitle method-title">executeStatements:withResultBlock:</h3> - - - - <div class="method-subsection brief-description"> - <p>Execute multiple SQL statements with callback handler</p> - </div> - - + - <div class="method-subsection method-declaration"><code>- (BOOL)executeStatements:(NSString *)<em>sql</em> withResultBlock:(FMDBExecuteStatementsCallbackBlock)<em>block</em></code></div> + <div class="method-subsection method-declaration"><code>- (FMResultSet *)executeQuery:(NSString *)<em>sql</em> withArgumentsInArray:(NSArray *)<em>arguments</em></code></div> - - - <div class="method-subsection arguments-section parameters"> - <h4 class="method-subtitle parameter-title">Parameters</h4> - - <dl class="argument-def parameter-def"> - <dt><em>sql</em></dt> - <dd><p>The SQL to be performed.</p></dd> - </dl> - - <dl class="argument-def parameter-def"> - <dt><em>block</em></dt> - <dd><p>A block that will be called for any result sets returned by any SQL statements. - Note, if you supply this block, it must return integer value, zero upon success (this would be a good opportunity to use SQLITE_OK), - non-zero value upon failure (which will stop the bulk execution of the SQL). If a statement returns values, the block will be called with the results from the query in NSDictionary *resultsDictionary. - This may be <code>nil</code> if you don’t care to receive any results.</p></dd> - </dl> - - </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>This executes a series of SQL statements that are combined in a single string (e.g. the SQL generated by the <code>sqlite3</code> command line <code>.dump</code> command). This accepts no value parameters, but rather simply expects a single string with multiple SQL statements, each terminated with a semicolon. This uses <code>sqlite3_exec</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/executeStatements:">- executeStatements:</a></p></code></li> + <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>arguments</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> + + </table> + </div> - <li><code><p><a href="http://sqlite.org/c3ref/exec.html">sqlite3_exec()</a></p></code></li> + + + <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> - </ul> - </div> - - - - <div class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMDatabase.h</code><br /> - </div> - - -</div> - - <div class="section-method"> - <a name="//api/name/executeUpdate:" title="executeUpdate:"></a> - <h3 class="subsubtitle method-title">executeUpdate:</h3> - - - - <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>, <em>...</em></code></div> + - - - <div class="method-subsection arguments-section parameters"> - <h4 class="method-subtitle parameter-title">Parameters</h4> - - <dl class="argument-def parameter-def"> - <dt><em>sql</em></dt> - <dd><p>The SQL to be performed, with optional <code>?</code> placeholders.</p></dd> - </dl> - - <dl class="argument-def parameter-def"> - <dt><em>...</em></dt> - <dd><p>Optional parameters to bind to <code>?</code> placeholders in the SQL statement. These should be Objective-C objects (e.g. <code>NSString</code>, <code>NSNumber</code>, etc.), not fundamental C data types (e.g. <code>int</code>, <code>char *</code>, etc.).</p></dd> - </dl> - - </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>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>, <a href="http://sqlite.org/c3ref/bind_blob.html"><code>sqlite3_bind</code></a> to bind values to <code>?</code> placeholders in the SQL with the optional list of parameters, and <a href="http://sqlite.org/c3ref/step.html"><code>sqlite_step</code></a> to perform the update.</p> + + <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> + </div> + -<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><div class="note"><p><strong>Note:</strong> This technique supports the use of <code>?</code> placeholders in the SQL, automatically binding any supplied value parameters to those placeholders. This approach is more robust than techniques that entail using <code>stringWithFormat</code> to manually build SQL statements, which can be problematic if the values happened to include any characters that needed to be quoted.</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/lastError">- lastError</a></p></code></li> + + + <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> + + </ul> + </div> - <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> + <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> - <li><code><p><a href="http://sqlite.org/c3ref/bind_blob.html"><code>sqlite3_bind</code></a></p></code></li> - </ul> + </div> </div> - - - - <div class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMDatabase.h</code><br /> - </div> - - -</div> - - <div class="section-method"> - <a name="//api/name/executeUpdate:withArgumentsInArray:" title="executeUpdate:withArgumentsInArray:"></a> - <h3 class="subsubtitle method-title">executeUpdate:withArgumentsInArray:</h3> - - - - <div class="method-subsection brief-description"> - <p>Execute single update statement</p> - </div> - - +</div><div class="section-method"> + <a name="//api/name/executeQuery:withParameterDictionary:" title="executeQuery:withParameterDictionary:"></a> + <h3 class="method-title"><code><a href="#//api/name/executeQuery:withParameterDictionary:">– executeQuery:withParameterDictionary:</a></code> +</h3> - <div class="method-subsection method-declaration"><code>- (BOOL)executeUpdate:(NSString *)<em>sql</em> withArgumentsInArray:(NSArray *)<em>arguments</em></code></div> + <div class="method-info"> + <div class="pointy-thing"></div> - - - <div class="method-subsection arguments-section parameters"> - <h4 class="method-subtitle parameter-title">Parameters</h4> - - <dl class="argument-def parameter-def"> - <dt><em>sql</em></dt> - <dd><p>The SQL to be performed, with optional <code>?</code> placeholders.</p></dd> - </dl> - - <dl class="argument-def parameter-def"> - <dt><em>arguments</em></dt> - <dd><p>A <code>NSArray</code> of objects to be used when binding values to the <code>?</code> placeholders in the SQL statement.</p></dd> - </dl> - - </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>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> + <div class="method-info-container"> + + + <div class="method-subsection brief-description"> + <p>Execute select statement</p> + </div> + + -<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> - </div> - - - - - - <div class="method-subsection see-also-section"> - <h4 class="method-subtitle">See Also</h4> - <ul> + <div class="method-subsection method-declaration"><code>- (FMResultSet *)executeQuery:(NSString *)<em>sql</em> withParameterDictionary:(NSDictionary *)<em>arguments</em></code></div> + + - <li><code><p><a href="#//api/name/lastError">- lastError</a></p></code></li> + <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>arguments</code></th> + <td><p>A <code>NSDictionary</code> of objects keyed by column names that will be used when binding values to the <code>?</code> placeholders in the SQL statement.</p></td> + </tr> + + </table> + </div> - <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> + <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> - </ul> - </div> - - - - <div class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMDatabase.h</code><br /> - </div> - - -</div> - - <div class="section-method"> - <a name="//api/name/executeUpdate:withErrorAndBindings:" title="executeUpdate:withErrorAndBindings:"></a> - <h3 class="subsubtitle method-title">executeUpdate:withErrorAndBindings:</h3> - - - - <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> withErrorAndBindings:(NSError **)<em>outErr</em>, <em>...</em></code></div> + - - - <div class="method-subsection arguments-section parameters"> - <h4 class="method-subtitle parameter-title">Parameters</h4> - - <dl class="argument-def parameter-def"> - <dt><em>sql</em></dt> - <dd><p>The SQL to be performed, with optional <code>?</code> placeholders.</p></dd> - </dl> - - <dl class="argument-def parameter-def"> - <dt><em>outErr</em></dt> - <dd><p>A reference to the <code>NSError</code> pointer to be updated with an auto released <code>NSError</code> object if an error if an error occurs. If <code>nil</code>, no <code>NSError</code> object will be returned.</p></dd> - </dl> - - <dl class="argument-def parameter-def"> - <dt><em>...</em></dt> - <dd><p>Optional parameters to bind to <code>?</code> placeholders in the SQL statement. These should be Objective-C objects (e.g. <code>NSString</code>, <code>NSNumber</code>, etc.), not fundamental C data types (e.g. <code>int</code>, <code>char *</code>, etc.).</p></dd> - </dl> - - </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>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>, <a href="http://sqlite.org/c3ref/bind_blob.html"><code>sqlite3_bind</code></a> to bind values to <code>?</code> placeholders in the SQL with the optional list of parameters, and <a href="http://sqlite.org/c3ref/step.html"><code>sqlite_step</code></a> to perform the update.</p> + + <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> + </div> + -<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> - </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> + + + <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> + + </ul> + </div> - <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> + <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> - <li><code><p><a href="http://sqlite.org/c3ref/bind_blob.html"><code>sqlite3_bind</code></a></p></code></li> - </ul> + </div> </div> - - - - <div class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMDatabase.h</code><br /> - </div> - - </div> + </div> - <div class="section-method"> - <a name="//api/name/executeUpdate:withParameterDictionary:" title="executeUpdate:withParameterDictionary:"></a> - <h3 class="subsubtitle method-title">executeUpdate:withParameterDictionary:</h3> - - - - <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> withParameterDictionary:(NSDictionary *)<em>arguments</em></code></div> + <a title="Transactions" name="task_Transactions"></a> + <h2 class="task-title">Transactions</h2> - - - <div class="method-subsection arguments-section parameters"> - <h4 class="method-subtitle parameter-title">Parameters</h4> - - <dl class="argument-def parameter-def"> - <dt><em>sql</em></dt> - <dd><p>The SQL to be performed, with optional <code>?</code> placeholders.</p></dd> - </dl> - - <dl class="argument-def parameter-def"> - <dt><em>arguments</em></dt> - <dd><p>A <code>NSDictionary</code> of objects keyed by column names that will be used when binding values to the <code>?</code> placeholders in the SQL statement.</p></dd> - </dl> - - </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>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/step.html"><code>sqlite_step</code></a> to perform the update. Unlike the other <code>executeUpdate</code> methods, this uses printf-style formatters (e.g. <code>%s</code>, <code>%d</code>, etc.) to build the SQL.</p> + <div class="task-list"> + <div class="section-method"> + <a name="//api/name/beginTransaction" title="beginTransaction"></a> + <h3 class="method-title"><code><a href="#//api/name/beginTransaction">– beginTransaction</a></code> +</h3> -<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> - </div> - - - - - - <div class="method-subsection see-also-section"> - <h4 class="method-subtitle">See Also</h4> - <ul> + <div class="method-info"> + <div class="pointy-thing"></div> + + <div class="method-info-container"> - <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> + <div class="method-subsection brief-description"> + <p>Begin a transaction</p> + </div> - <li><code><p><a href="#//api/name/lastErrorMessage">- lastErrorMessage</a></p></code></li> + + + <div class="method-subsection method-declaration"><code>- (BOOL)beginTransaction</code></div> + + - </ul> - </div> - - - - <div class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMDatabase.h</code><br /> - </div> - - -</div> - - <div class="section-method"> - <a name="//api/name/executeUpdate:withVAList:" title="executeUpdate:withVAList:"></a> - <h3 class="subsubtitle method-title">executeUpdate:withVAList:</h3> - - - - <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> withVAList:(va_list)<em>args</em></code></div> + + <div class="method-subsection return"> + <h4 class="method-subtitle parameter-title">Return Value</h4> + <p><code>YES</code> on success; <code>NO</code> on 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 arguments-section parameters"> - <h4 class="method-subtitle parameter-title">Parameters</h4> - - <dl class="argument-def parameter-def"> - <dt><em>sql</em></dt> - <dd><p>The SQL to be performed, with optional <code>?</code> placeholders.</p></dd> - </dl> - - <dl class="argument-def parameter-def"> - <dt><em>args</em></dt> - <dd><p>A <code>va_list</code> of arguments.</p></dd> - </dl> - - </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>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/step.html"><code>sqlite_step</code></a> to perform the update. Unlike the other <code>executeUpdate</code> methods, this uses printf-style formatters (e.g. <code>%s</code>, <code>%d</code>, etc.) to build the SQL.</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> - </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> + <div class="method-subsection discussion-section"> + <h4 class="method-subtitle">Discussion</h4> + <p>Begin a transaction</p> + </div> - <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 class="method-subsection see-also-section"> + <h4 class="method-subtitle">See Also</h4> + <ul> + + <li><code><p><a href="#//api/name/commit">- commit</a></p></code></li> + + <li><code><p><a href="#//api/name/rollback">- rollback</a></p></code></li> + + <li><code><p><a href="#//api/name/beginDeferredTransaction">- beginDeferredTransaction</a></p></code></li> + + <li><code><p><a href="#//api/name/inTransaction">- inTransaction</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 class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMDatabase.h</code><br /> - </div> - - -</div> - - <div class="section-method"> - <a name="//api/name/executeUpdateWithFormat:" title="executeUpdateWithFormat:"></a> - <h3 class="subsubtitle method-title">executeUpdateWithFormat:</h3> - - - - <div class="method-subsection brief-description"> - <p>Execute single update statement</p> - </div> - - +</div><div class="section-method"> + <a name="//api/name/beginDeferredTransaction" title="beginDeferredTransaction"></a> + <h3 class="method-title"><code><a href="#//api/name/beginDeferredTransaction">– beginDeferredTransaction</a></code> +</h3> - <div class="method-subsection method-declaration"><code>- (BOOL)executeUpdateWithFormat:(NSString *)<em>format</em>, <em>...</em></code></div> + <div class="method-info"> + <div class="pointy-thing"></div> - - - <div class="method-subsection arguments-section parameters"> - <h4 class="method-subtitle parameter-title">Parameters</h4> - - <dl class="argument-def parameter-def"> - <dt><em>format</em></dt> - <dd><p>The SQL to be performed, with <code>printf</code>-style escape sequences.</p></dd> - </dl> - - <dl class="argument-def parameter-def"> - <dt><em>...</em></dt> - <dd><p>Optional parameters to bind to use in conjunction with the <code>printf</code>-style escape sequences in the SQL statement.</p></dd> - </dl> - + <div class="method-info-container"> + + + <div class="method-subsection brief-description"> + <p>Begin a deferred transaction</p> + </div> + + + + <div class="method-subsection method-declaration"><code>- (BOOL)beginDeferredTransaction</code></div> + + + + + + <div class="method-subsection return"> + <h4 class="method-subtitle parameter-title">Return Value</h4> + <p><code>YES</code> on success; <code>NO</code> on 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>Begin a deferred transaction</p> + </div> + + + + + + <div class="method-subsection see-also-section"> + <h4 class="method-subtitle">See Also</h4> + <ul> + + <li><code><p><a href="#//api/name/commit">- commit</a></p></code></li> + + <li><code><p><a href="#//api/name/rollback">- rollback</a></p></code></li> + + <li><code><p><a href="#//api/name/beginTransaction">- beginTransaction</a></p></code></li> + + <li><code><p><a href="#//api/name/inTransaction">- inTransaction</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 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="section-method"> + <a name="//api/name/commit" title="commit"></a> + <h3 class="method-title"><code><a href="#//api/name/commit">– commit</a></code> +</h3> + + <div class="method-info"> + <div class="pointy-thing"></div> + + <div class="method-info-container"> + + + <div class="method-subsection brief-description"> + <p>Commit a transaction</p> + </div> + + + + <div class="method-subsection method-declaration"><code>- (BOOL)commit</code></div> + + + + + + <div class="method-subsection return"> + <h4 class="method-subtitle parameter-title">Return Value</h4> + <p><code>YES</code> on success; <code>NO</code> on 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>Commit a transaction</p> + +<p>Commit a transaction that was initiated with either <a href="#//api/name/beginTransaction"><code>beginTransaction</code></a> or with <a href="#//api/name/beginDeferredTransaction"><code>beginDeferredTransaction</code></a>.</p> + </div> + + + + + + <div class="method-subsection see-also-section"> + <h4 class="method-subtitle">See Also</h4> + <ul> + + <li><code><p><a href="#//api/name/beginTransaction">- beginTransaction</a></p></code></li> + + <li><code><p><a href="#//api/name/beginDeferredTransaction">- beginDeferredTransaction</a></p></code></li> + + <li><code><p><a href="#//api/name/rollback">- rollback</a></p></code></li> + + <li><code><p><a href="#//api/name/inTransaction">- inTransaction</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 class="method-subsection discussion-section"> - <h4 class="method-subtitle">Discussion</h4> - <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/step.html"><code>sqlite_step</code></a> to perform the update. Unlike the other <code>executeUpdate</code> methods, this uses printf-style formatters (e.g. <code>%s</code>, <code>%d</code>, etc.) to build the SQL. Do not use <code>?</code> placeholders in the SQL if you use this method.</p><div class="note"><p><strong>Note:</strong> This method does not technically perform a traditional printf-style replacement. What this method actually does is replace the printf-style percent sequences with a SQLite <code>?</code> placeholder, and then bind values to that placeholder. Thus the following command</p> +</div><div class="section-method"> + <a name="//api/name/rollback" title="rollback"></a> + <h3 class="method-title"><code><a href="#//api/name/rollback">– rollback</a></code> +</h3> -<pre><code>[db executeUpdateWithFormat:@"INSERT INTO test (name) VALUES (%@)", @"Gus"]; -</code></pre> + <div class="method-info"> + <div class="pointy-thing"></div> -<p>is actually replacing the <code>%@</code> with <code>?</code> placeholder, and then performing something equivalent to <a href="#//api/name/executeUpdate:"><code>executeUpdate:</code></a></p> + <div class="method-info-container"> + + + <div class="method-subsection brief-description"> + <p>Rollback a transaction</p> + </div> + + -<pre><code>[db executeUpdate:@"INSERT INTO test (name) VALUES (?)", @"Gus"]; -</code></pre> + <div class="method-subsection method-declaration"><code>- (BOOL)rollback</code></div> -<p>There are two reasons why this distinction is important. First, the printf-style escape sequences can only be used where it is permissible to use a SQLite <code>?</code> placeholder. You can use it only for values in SQL statements, but not for table names or column names or any other non-value context. This method also cannot be used in conjunction with <code>pragma</code> statements and the like. Second, note the lack of quotation marks in the SQL. The <code>VALUES</code> clause was <em>not</em> <code>VALUES ('%@')</code> (like you might have to do if you built a SQL statement using <code>NSString</code> method <code>stringWithFormat</code>), but rather simply <code>VALUES (%@)</code>.</p></div> + + + + + <div class="method-subsection return"> + <h4 class="method-subtitle parameter-title">Return Value</h4> + <p><code>YES</code> on success; <code>NO</code> on 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>Rollback a transaction</p> + +<p>Rollback a transaction that was initiated with either <a href="#//api/name/beginTransaction"><code>beginTransaction</code></a> or with <a href="#//api/name/beginDeferredTransaction"><code>beginDeferredTransaction</code></a>.</p> + </div> + + + + + + <div class="method-subsection see-also-section"> + <h4 class="method-subtitle">See Also</h4> + <ul> + + <li><code><p><a href="#//api/name/beginTransaction">- beginTransaction</a></p></code></li> + + <li><code><p><a href="#//api/name/beginDeferredTransaction">- beginDeferredTransaction</a></p></code></li> + + <li><code><p><a href="#//api/name/commit">- commit</a></p></code></li> + + <li><code><p><a href="#//api/name/inTransaction">- inTransaction</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 class="method-subsection see-also-section"> - <h4 class="method-subtitle">See Also</h4> - <ul> +</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> +</h3> + + <div class="method-info"> + <div class="pointy-thing"></div> + + <div class="method-info-container"> + + + <div class="method-subsection brief-description"> + <p>Identify whether currently in a transaction or not</p> + </div> + + + + <div class="method-subsection method-declaration"><code>- (BOOL)inTransaction</code></div> + + - <li><code><p><a href="#//api/name/executeUpdate:">- executeUpdate:</a></p></code></li> + - <li><code><p><a href="#//api/name/lastError">- lastError</a></p></code></li> + <div class="method-subsection return"> + <h4 class="method-subtitle parameter-title">Return Value</h4> + <p><code>YES</code> if currently within transaction; <code>NO</code> if not.</p> + </div> - <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 class="method-subsection discussion-section"> + <h4 class="method-subtitle">Discussion</h4> + <p>Identify whether currently in a transaction or not</p> + </div> + + + + + + <div class="method-subsection see-also-section"> + <h4 class="method-subtitle">See Also</h4> + <ul> + + <li><code><p><a href="#//api/name/beginTransaction">- beginTransaction</a></p></code></li> + + <li><code><p><a href="#//api/name/beginDeferredTransaction">- beginDeferredTransaction</a></p></code></li> + + <li><code><p><a href="#//api/name/commit">- commit</a></p></code></li> + + <li><code><p><a href="#//api/name/rollback">- rollback</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 class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMDatabase.h</code><br /> - </div> - - </div> + </div> - <div class="section-method"> - <a name="//api/name/goodConnection" title="goodConnection"></a> - <h3 class="subsubtitle method-title">goodConnection</h3> - - - - <div class="method-subsection brief-description"> - <p>Test to see if we have a good connection to the database.</p> - </div> - - - <div class="method-subsection method-declaration"><code>- (BOOL)goodConnection</code></div> + <a title="Cached statements and result sets" name="task_Cached statements and result sets"></a> + <h2 class="task-title">Cached statements and result sets</h2> - - - - - <div class="method-subsection return"> - <h4 class="method-subtitle parameter-title">Return Value</h4> - <p><code>YES</code> if everything succeeds, <code>NO</code> on failure.</p> - </div> - - - - - - <div class="method-subsection discussion-section"> - <h4 class="method-subtitle">Discussion</h4> - <p>This will confirm whether:</p> + <div class="task-list"> + <div class="section-method"> + <a name="//api/name/clearCachedStatements" title="clearCachedStatements"></a> + <h3 class="method-title"><code><a href="#//api/name/clearCachedStatements">– clearCachedStatements</a></code> +</h3> -<ul> -<li>is database open</li> -<li>if open, it will try a simple SELECT statement and confirm that it succeeds.</li> -</ul> + <div class="method-info"> + <div class="pointy-thing"></div> + + <div class="method-info-container"> + + + <div class="method-subsection brief-description"> + <p>Clear cached statements</p> + </div> + + + + <div class="method-subsection method-declaration"><code>- (void)clearCachedStatements</code></div> + + + + + + + + + + <div class="method-subsection discussion-section"> + <h4 class="method-subtitle">Discussion</h4> + <p>Clear cached statements</p> + </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 class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMDatabase.h</code><br /> - </div> - - -</div> - - <div class="section-method"> - <a name="//api/name/hadError" title="hadError"></a> - <h3 class="subsubtitle method-title">hadError</h3> - - - - <div class="method-subsection brief-description"> - <p>Had error</p> - </div> - - +</div><div class="section-method"> + <a name="//api/name/closeOpenResultSets" title="closeOpenResultSets"></a> + <h3 class="method-title"><code><a href="#//api/name/closeOpenResultSets">– closeOpenResultSets</a></code> +</h3> - <div class="method-subsection method-declaration"><code>- (BOOL)hadError</code></div> + <div class="method-info"> + <div class="pointy-thing"></div> - - - - - <div class="method-subsection return"> - <h4 class="method-subtitle parameter-title">Return Value</h4> - <p><code>YES</code> if there was an error, <code>NO</code> if no error.</p> + <div class="method-info-container"> + + + <div class="method-subsection brief-description"> + <p>Close all open result sets</p> + </div> + + + + <div class="method-subsection method-declaration"><code>- (void)closeOpenResultSets</code></div> + + + + + + + + + + <div class="method-subsection discussion-section"> + <h4 class="method-subtitle">Discussion</h4> + <p>Close all open result sets</p> + </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 class="method-subsection see-also-section"> - <h4 class="method-subtitle">See Also</h4> - <ul> +</div><div class="section-method"> + <a name="//api/name/hasOpenResultSets" title="hasOpenResultSets"></a> + <h3 class="method-title"><code><a href="#//api/name/hasOpenResultSets">– hasOpenResultSets</a></code> +</h3> + + <div class="method-info"> + <div class="pointy-thing"></div> + + <div class="method-info-container"> - <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> + <div class="method-subsection brief-description"> + <p>Whether database has any open result sets</p> + </div> - <li><code><p><a href="#//api/name/lastErrorMessage">- lastErrorMessage</a></p></code></li> + + + <div class="method-subsection method-declaration"><code>- (BOOL)hasOpenResultSets</code></div> + + + + - </ul> + <div class="method-subsection return"> + <h4 class="method-subtitle parameter-title">Return Value</h4> + <p><code>YES</code> if there are open result sets; <code>NO</code> if not.</p> + </div> + + + + + + <div class="method-subsection discussion-section"> + <h4 class="method-subtitle">Discussion</h4> + <p>Whether database has any open result sets</p> + </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 class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMDatabase.h</code><br /> - </div> - - -</div> - - <div class="section-method"> - <a name="//api/name/hasDateFormatter" title="hasDateFormatter"></a> - <h3 class="subsubtitle method-title">hasDateFormatter</h3> - - - - <div class="method-subsection brief-description"> - <p>Test whether the database has a date formatter assigned.</p> - </div> - - +</div><div class="section-method"> + <a name="//api/name/shouldCacheStatements" title="shouldCacheStatements"></a> + <h3 class="method-title"><code><a href="#//api/name/shouldCacheStatements">– shouldCacheStatements</a></code> +</h3> - <div class="method-subsection method-declaration"><code>- (BOOL)hasDateFormatter</code></div> + <div class="method-info"> + <div class="pointy-thing"></div> - - - - - <div class="method-subsection return"> - <h4 class="method-subtitle parameter-title">Return Value</h4> - <p><code>YES</code> if there is a date formatter; <code>NO</code> if not.</p> + <div class="method-info-container"> + + + <div class="method-subsection brief-description"> + <p>Return whether should cache statements or not</p> + </div> + + + + <div class="method-subsection method-declaration"><code>- (BOOL)shouldCacheStatements</code></div> + + + + + + <div class="method-subsection return"> + <h4 class="method-subtitle parameter-title">Return Value</h4> + <p><code>YES</code> if should cache statements; <code>NO</code> if not.</p> + </div> + + + + + + <div class="method-subsection discussion-section"> + <h4 class="method-subtitle">Discussion</h4> + <p>Return whether should cache statements or not</p> + </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 class="method-subsection see-also-section"> - <h4 class="method-subtitle">See Also</h4> - <ul> +</div><div class="section-method"> + <a name="//api/name/setShouldCacheStatements:" title="setShouldCacheStatements:"></a> + <h3 class="method-title"><code><a href="#//api/name/setShouldCacheStatements:">– setShouldCacheStatements:</a></code> +</h3> + + <div class="method-info"> + <div class="pointy-thing"></div> + + <div class="method-info-container"> - <li><code><p><a href="#//api/name/hasDateFormatter">- hasDateFormatter</a></p></code></li> - <li><code><p><a href="#//api/name/setDateFormat:">- setDateFormat:</a></p></code></li> + <div class="method-subsection brief-description"> + <p>Set whether should cache statements or not</p> + </div> - <li><code><p><a href="#//api/name/dateFromString:">- dateFromString:</a></p></code></li> + + + <div class="method-subsection method-declaration"><code>- (void)setShouldCacheStatements:(BOOL)<em>value</em></code></div> + + - <li><code><p><a href="#//api/name/stringFromDate:">- stringFromDate:</a></p></code></li> + <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>value</code></th> + <td><p><code>YES</code> if should cache statements; <code>NO</code> if not.</p></td> + </tr> + + </table> + </div> + + + + + + - <li><code><p><a href="#//api/name/storeableDateFormat:">+ storeableDateFormat:</a></p></code></li> + <div class="method-subsection discussion-section"> + <h4 class="method-subtitle">Discussion</h4> + <p>Set whether should cache statements or not</p> + </div> - </ul> + + + + + + + <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 class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMDatabase.h</code><br /> - </div> - - </div> + </div> - <div class="section-method"> - <a name="//api/name/hasOpenResultSets" title="hasOpenResultSets"></a> - <h3 class="subsubtitle method-title">hasOpenResultSets</h3> - - - - <div class="method-subsection brief-description"> - <p>Whether database has any open result sets</p> - </div> - - - <div class="method-subsection method-declaration"><code>- (BOOL)hasOpenResultSets</code></div> + <a title="Encryption methods" name="task_Encryption methods"></a> + <h2 class="task-title">Encryption methods</h2> - - - - - <div class="method-subsection return"> - <h4 class="method-subtitle parameter-title">Return Value</h4> - <p><code>YES</code> if there are open result sets; <code>NO</code> if not.</p> + <div class="task-list"> + <div class="section-method"> + <a name="//api/name/setKey:" title="setKey:"></a> + <h3 class="method-title"><code><a href="#//api/name/setKey:">– setKey:</a></code> +</h3> + + <div class="method-info"> + <div class="pointy-thing"></div> + + <div class="method-info-container"> + + + <div class="method-subsection brief-description"> + <p>Set encryption key.</p> + </div> + + + + <div class="method-subsection method-declaration"><code>- (BOOL)setKey:(NSString *)<em>key</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>key</code></th> + <td><p>The key to be used.</p></td> + </tr> + + </table> + </div> + + + + <div class="method-subsection return"> + <h4 class="method-subtitle parameter-title">Return Value</h4> + <p><code>YES</code> if success, <code>NO</code> on error.</p> + </div> + + + + + + <div class="method-subsection discussion-section"> + <h4 class="method-subtitle">Discussion</h4> + <p>Set encryption key.</p><div class="warning"><p><strong>Warning:</strong> You need to have purchased the sqlite encryption extensions for this method to work.</p></div> + </div> + + + + + + <div class="method-subsection see-also-section"> + <h4 class="method-subtitle">See Also</h4> + <ul> + + <li><code><p><a href="http://www.sqlite-encrypt.com/develop-guide.htm">http://www.sqlite-encrypt.com/develop-guide.htm</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 class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMDatabase.h</code><br /> - </div> - - -</div> - - <div class="section-method"> - <a name="//api/name/inSavePoint:" title="inSavePoint:"></a> - <h3 class="subsubtitle method-title">inSavePoint:</h3> - - - - <div class="method-subsection brief-description"> - <p>Start save point</p> - </div> - - +</div><div class="section-method"> + <a name="//api/name/rekey:" title="rekey:"></a> + <h3 class="method-title"><code><a href="#//api/name/rekey:">– rekey:</a></code> +</h3> - <div class="method-subsection method-declaration"><code>- (NSError *)inSavePoint:(void ( ^ ) ( BOOL *rollback ))<em>block</em></code></div> + <div class="method-info"> + <div class="pointy-thing"></div> - - - <div class="method-subsection arguments-section parameters"> - <h4 class="method-subtitle parameter-title">Parameters</h4> - - <dl class="argument-def parameter-def"> - <dt><em>block</em></dt> - <dd><p>Block of code to perform from within save point.</p></dd> - </dl> - + <div class="method-info-container"> + + + <div class="method-subsection brief-description"> + <p>Reset encryption key</p> + </div> + + + + <div class="method-subsection method-declaration"><code>- (BOOL)rekey:(NSString *)<em>key</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>key</code></th> + <td><p>The key to be used.</p></td> + </tr> + + </table> + </div> + + + + <div class="method-subsection return"> + <h4 class="method-subtitle parameter-title">Return Value</h4> + <p><code>YES</code> if success, <code>NO</code> on error.</p> + </div> + + + + + + <div class="method-subsection discussion-section"> + <h4 class="method-subtitle">Discussion</h4> + <p>Reset encryption key</p><div class="warning"><p><strong>Warning:</strong> You need to have purchased the sqlite encryption extensions for this method to work.</p></div> + </div> + + + + + + <div class="method-subsection see-also-section"> + <h4 class="method-subtitle">See Also</h4> + <ul> + + <li><code><p><a href="http://www.sqlite-encrypt.com/develop-guide.htm">http://www.sqlite-encrypt.com/develop-guide.htm</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 class="method-subsection return"> - <h4 class="method-subtitle parameter-title">Return Value</h4> - <p>The NSError corresponding to the error, if any. If no error, returns <code>nil</code>.</p> +</div><div class="section-method"> + <a name="//api/name/setKeyWithData:" title="setKeyWithData:"></a> + <h3 class="method-title"><code><a href="#//api/name/setKeyWithData:">– setKeyWithData:</a></code> +</h3> + + <div class="method-info"> + <div class="pointy-thing"></div> + + <div class="method-info-container"> + + + <div class="method-subsection brief-description"> + <p>Set encryption key using <code>keyData</code>.</p> + </div> + + + + <div class="method-subsection method-declaration"><code>- (BOOL)setKeyWithData:(NSData *)<em>keyData</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>keyData</code></th> + <td><p>The <code>NSData</code> to be used.</p></td> + </tr> + + </table> + </div> + + + + <div class="method-subsection return"> + <h4 class="method-subtitle parameter-title">Return Value</h4> + <p><code>YES</code> if success, <code>NO</code> on error.</p> + </div> + + + + + + <div class="method-subsection discussion-section"> + <h4 class="method-subtitle">Discussion</h4> + <p>Set encryption key using <code>keyData</code>.</p><div class="warning"><p><strong>Warning:</strong> You need to have purchased the sqlite encryption extensions for this method to work.</p></div> + </div> + + + + + + <div class="method-subsection see-also-section"> + <h4 class="method-subtitle">See Also</h4> + <ul> + + <li><code><p><a href="http://www.sqlite-encrypt.com/develop-guide.htm">http://www.sqlite-encrypt.com/develop-guide.htm</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 class="method-subsection see-also-section"> - <h4 class="method-subtitle">See Also</h4> - <ul> +</div><div class="section-method"> + <a name="//api/name/rekeyWithData:" title="rekeyWithData:"></a> + <h3 class="method-title"><code><a href="#//api/name/rekeyWithData:">– rekeyWithData:</a></code> +</h3> + + <div class="method-info"> + <div class="pointy-thing"></div> + + <div class="method-info-container"> + + + <div class="method-subsection brief-description"> + <p>Reset encryption key using <code>keyData</code>.</p> + </div> + + + + <div class="method-subsection method-declaration"><code>- (BOOL)rekeyWithData:(NSData *)<em>keyData</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>keyData</code></th> + <td><p>The <code>NSData</code> to be used.</p></td> + </tr> + + </table> + </div> + + + + <div class="method-subsection return"> + <h4 class="method-subtitle parameter-title">Return Value</h4> + <p><code>YES</code> if success, <code>NO</code> on error.</p> + </div> + + + + - <li><code><p><a href="#//api/name/startSavePointWithName:error:">- startSavePointWithName:error:</a></p></code></li> + <div class="method-subsection discussion-section"> + <h4 class="method-subtitle">Discussion</h4> + <p>Reset encryption key using <code>keyData</code>.</p><div class="warning"><p><strong>Warning:</strong> You need to have purchased the sqlite encryption extensions for this method to work.</p></div> + </div> + + - <li><code><p><a href="#//api/name/releaseSavePointWithName:error:">- releaseSavePointWithName:error:</a></p></code></li> + - <li><code><p><a href="#//api/name/rollbackToSavePointWithName:error:">- rollbackToSavePointWithName:error:</a></p></code></li> + <div class="method-subsection see-also-section"> + <h4 class="method-subtitle">See Also</h4> + <ul> + + <li><code><p><a href="http://www.sqlite-encrypt.com/develop-guide.htm">http://www.sqlite-encrypt.com/develop-guide.htm</a></p></code></li> + + </ul> + </div> - </ul> + + + <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 class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMDatabase.h</code><br /> - </div> - - </div> + </div> - <div class="section-method"> - <a name="//api/name/inTransaction" title="inTransaction"></a> - <h3 class="subsubtitle method-title">inTransaction</h3> - - - - <div class="method-subsection brief-description"> - <p>Identify whether currently in a transaction or not</p> - </div> - - - <div class="method-subsection method-declaration"><code>- (BOOL)inTransaction</code></div> + <a title="General inquiry methods" name="task_General inquiry methods"></a> + <h2 class="task-title">General inquiry methods</h2> - - - - - <div class="method-subsection return"> - <h4 class="method-subtitle parameter-title">Return Value</h4> - <p><code>YES</code> if currently within transaction; <code>NO</code> if not.</p> + <div class="task-list"> + <div class="section-method"> + <a name="//api/name/databasePath" title="databasePath"></a> + <h3 class="method-title"><code><a href="#//api/name/databasePath">– databasePath</a></code> +</h3> + + <div class="method-info"> + <div class="pointy-thing"></div> + + <div class="method-info-container"> + + + <div class="method-subsection brief-description"> + <p>The path of the database file</p> + </div> + + + + <div class="method-subsection method-declaration"><code>- (NSString *)databasePath</code></div> + + + + + + <div class="method-subsection return"> + <h4 class="method-subtitle parameter-title">Return Value</h4> + <p>path of database.</p> + </div> + + + + + + <div class="method-subsection discussion-section"> + <h4 class="method-subtitle">Discussion</h4> + <p>The path of the database file</p> + </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 class="method-subsection see-also-section"> - <h4 class="method-subtitle">See Also</h4> - <ul> +</div><div class="section-method"> + <a name="//api/name/sqliteHandle" title="sqliteHandle"></a> + <h3 class="method-title"><code><a href="#//api/name/sqliteHandle">– sqliteHandle</a></code> +</h3> + + <div class="method-info"> + <div class="pointy-thing"></div> + + <div class="method-info-container"> + + + <div class="method-subsection brief-description"> + <p>The underlying SQLite handle</p> + </div> + + + + <div class="method-subsection method-declaration"><code>- (sqlite3 *)sqliteHandle</code></div> + + + + + + <div class="method-subsection return"> + <h4 class="method-subtitle parameter-title">Return Value</h4> + <p>The <code>sqlite3</code> pointer.</p> + </div> + + - <li><code><p><a href="#//api/name/beginTransaction">- beginTransaction</a></p></code></li> + - <li><code><p><a href="#//api/name/beginDeferredTransaction">- beginDeferredTransaction</a></p></code></li> + <div class="method-subsection discussion-section"> + <h4 class="method-subtitle">Discussion</h4> + <p>The underlying SQLite handle</p> + </div> - <li><code><p><a href="#//api/name/commit">- commit</a></p></code></li> + - <li><code><p><a href="#//api/name/rollback">- rollback</a></p></code></li> + - </ul> + + + <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 class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMDatabase.h</code><br /> - </div> - - </div> + </div> - <div class="section-method"> - <a name="//api/name/initWithPath:" title="initWithPath:"></a> - <h3 class="subsubtitle method-title">initWithPath:</h3> - - - - <div class="method-subsection brief-description"> - <p>Initialize a <code>FMDatabase</code> object.</p> - </div> - - - <div class="method-subsection method-declaration"><code>- (instancetype)initWithPath:(NSString *)<em>inPath</em></code></div> + <a title="Retrieving error codes" name="task_Retrieving error codes"></a> + <h2 class="task-title">Retrieving error codes</h2> - - - <div class="method-subsection arguments-section parameters"> - <h4 class="method-subtitle parameter-title">Parameters</h4> - - <dl class="argument-def parameter-def"> - <dt><em>inPath</em></dt> - <dd><p>Path of database file</p></dd> - </dl> - + <div class="task-list"> + <div class="section-method"> + <a name="//api/name/lastErrorMessage" title="lastErrorMessage"></a> + <h3 class="method-title"><code><a href="#//api/name/lastErrorMessage">– lastErrorMessage</a></code> +</h3> + + <div class="method-info"> + <div class="pointy-thing"></div> + + <div class="method-info-container"> + + + <div class="method-subsection brief-description"> + <p>Last error message</p> + </div> + + + + <div class="method-subsection method-declaration"><code>- (NSString *)lastErrorMessage</code></div> + + + + + + <div class="method-subsection return"> + <h4 class="method-subtitle parameter-title">Return Value</h4> + <p><code>NSString</code> of the last error message.</p> + </div> + + + + + + <div class="method-subsection discussion-section"> + <h4 class="method-subtitle">Discussion</h4> + <p>Last error message</p> + +<p>Returns the English-language text that describes the most recent failed SQLite API call associated with a database connection. If a prior API call failed but the most recent API call succeeded, this return value is undefined.</p> + </div> + + + + + + <div class="method-subsection see-also-section"> + <h4 class="method-subtitle">See Also</h4> + <ul> + + <li><code><p><a href="http://sqlite.org/c3ref/errcode.html">sqlite3_errmsg()</a></p></code></li> + + <li><code><p><a href="#//api/name/lastErrorCode">- lastErrorCode</a></p></code></li> + + <li><code><p><a href="#//api/name/lastError">- lastError</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 class="method-subsection return"> - <h4 class="method-subtitle parameter-title">Return Value</h4> - <p><code>FMDatabase</code> object if successful; <code>nil</code> if failure.</p> +</div><div class="section-method"> + <a name="//api/name/lastErrorCode" title="lastErrorCode"></a> + <h3 class="method-title"><code><a href="#//api/name/lastErrorCode">– lastErrorCode</a></code> +</h3> + + <div class="method-info"> + <div class="pointy-thing"></div> + + <div class="method-info-container"> + + + <div class="method-subsection brief-description"> + <p>Last error code</p> + </div> + + + + <div class="method-subsection method-declaration"><code>- (int)lastErrorCode</code></div> + + + + + + <div class="method-subsection return"> + <h4 class="method-subtitle parameter-title">Return Value</h4> + <p>Integer value of the last error code.</p> + </div> + + + + + + <div class="method-subsection discussion-section"> + <h4 class="method-subtitle">Discussion</h4> + <p>Last error code</p> + +<p>Returns the numeric result code or extended result code for the most recent failed SQLite API call associated with a database connection. If a prior API call failed but the most recent API call succeeded, this return value is undefined.</p> + </div> + + + + + + <div class="method-subsection see-also-section"> + <h4 class="method-subtitle">See Also</h4> + <ul> + + <li><code><p><a href="http://sqlite.org/c3ref/errcode.html">sqlite3_errcode()</a></p></code></li> + + <li><code><p><a href="#//api/name/lastErrorMessage">- lastErrorMessage</a></p></code></li> + + <li><code><p><a href="#//api/name/lastError">- lastError</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 class="method-subsection discussion-section"> - <h4 class="method-subtitle">Discussion</h4> - <p>An <code>FMDatabase</code> is created with a path to a SQLite database file. This path can be one of these three:</p> +</div><div class="section-method"> + <a name="//api/name/hadError" title="hadError"></a> + <h3 class="method-title"><code><a href="#//api/name/hadError">– hadError</a></code> +</h3> -<ol> -<li>A file system path. The file does not have to exist on disk. If it does not exist, it is created for you.</li> -<li>An empty string (<code>@""</code>). An empty database is created at a temporary location. This database is deleted with the <code>FMDatabase</code> connection is closed.</li> -<li><code>nil</code>. An in-memory database is created. This database will be destroyed with the <code>FMDatabase</code> connection is closed.</li> -</ol> + <div class="method-info"> + <div class="pointy-thing"></div> + <div class="method-info-container"> + + + <div class="method-subsection brief-description"> + <p>Had error</p> + </div> + + -<p>For example, to create/open a database in your Mac OS X <code>tmp</code> folder:</p> + <div class="method-subsection method-declaration"><code>- (BOOL)hadError</code></div> -<pre><code>FMDatabase *db = [FMDatabase databaseWithPath:@"/tmp/tmp.db"]; -</code></pre> + + -<p>Or, in iOS, you might open a database in the app’s <code>Documents</code> directory:</p> + + <div class="method-subsection return"> + <h4 class="method-subtitle parameter-title">Return Value</h4> + <p><code>YES</code> if there was an error, <code>NO</code> if no error.</p> + </div> + -<pre><code>NSString *docsPath = NSSearchPathForDirectoriesInDomains(NSDocumentDirectory, NSUserDomainMask, YES)[0]; -NSString *dbPath = [docsPath stringByAppendingPathComponent:@"test.db"]; -FMDatabase *db = [FMDatabase databaseWithPath:dbPath]; -</code></pre> + -<p>(For more information on temporary and in-memory databases, read the sqlite documentation on the subject: <a href="http://www.sqlite.org/inmemorydb.html">http://www.sqlite.org/inmemorydb.html</a>)</p> + + <div class="method-subsection discussion-section"> + <h4 class="method-subtitle">Discussion</h4> + <p>Had error</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> + + <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 class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMDatabase.h</code><br /> - </div> - - -</div> - - <div class="section-method"> +</div><div class="section-method"> <a name="//api/name/lastError" title="lastError"></a> - <h3 class="subsubtitle method-title">lastError</h3> - - - - <div class="method-subsection brief-description"> - <p>Last error</p> - </div> - - + <h3 class="method-title"><code><a href="#//api/name/lastError">– lastError</a></code> +</h3> - <div class="method-subsection method-declaration"><code>- (NSError *)lastError</code></div> + <div class="method-info"> + <div class="pointy-thing"></div> + + <div class="method-info-container"> + + + <div class="method-subsection brief-description"> + <p>Last error</p> + </div> + + + + <div class="method-subsection method-declaration"><code>- (NSError *)lastError</code></div> + + + + + + <div class="method-subsection return"> + <h4 class="method-subtitle parameter-title">Return Value</h4> + <p><code>NSError</code> representing the last error.</p> + </div> + + + + + + <div class="method-subsection discussion-section"> + <h4 class="method-subtitle">Discussion</h4> + <p>Last error</p> + </div> + + + - - - - - <div class="method-subsection return"> - <h4 class="method-subtitle parameter-title">Return Value</h4> - <p><code>NSError</code> representing the last error.</p> - </div> - - - - - - - - - - <div class="method-subsection see-also-section"> - <h4 class="method-subtitle">See Also</h4> - <ul> - <li><code><p><a href="#//api/name/lastErrorCode">- lastErrorCode</a></p></code></li> + <div class="method-subsection see-also-section"> + <h4 class="method-subtitle">See Also</h4> + <ul> + + <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> - <li><code><p><a href="#//api/name/lastErrorMessage">- lastErrorMessage</a></p></code></li> - </ul> + </div> </div> - - - - <div class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMDatabase.h</code><br /> - </div> - - </div> + </div> - <div class="section-method"> - <a name="//api/name/lastErrorCode" title="lastErrorCode"></a> - <h3 class="subsubtitle method-title">lastErrorCode</h3> - - - - <div class="method-subsection brief-description"> - <p>Last error code</p> - </div> - - - <div class="method-subsection method-declaration"><code>- (int)lastErrorCode</code></div> + <a title="Save points" name="task_Save points"></a> + <h2 class="task-title">Save points</h2> + + <div class="task-list"> + <div class="section-method"> + <a name="//api/name/startSavePointWithName:error:" title="startSavePointWithName:error:"></a> + <h3 class="method-title"><code><a href="#//api/name/startSavePointWithName:error:">– startSavePointWithName: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>Start save point</p> + </div> + + + + <div class="method-subsection method-declaration"><code>- (BOOL)startSavePointWithName:(NSString *)<em>name</em> error:(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>name</code></th> + <td><p>Name of save point.</p></td> + </tr> + + <tr> + <th scope="row" class="argument-name"><code>outErr</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>Integer value of the last error code.</p> - </div> - - - - - - <div class="method-subsection discussion-section"> - <h4 class="method-subtitle">Discussion</h4> - <p>Returns the numeric result code or extended result code for the most recent failed SQLite API call associated with a database connection. If a prior API call failed but the most recent API call succeeded, this return value is undefined.</p> - </div> - - - - - - <div class="method-subsection see-also-section"> - <h4 class="method-subtitle">See Also</h4> - <ul> - <li><code><p><a href="http://sqlite.org/c3ref/errcode.html">sqlite3_errcode()</a></p></code></li> + <div class="method-subsection return"> + <h4 class="method-subtitle parameter-title">Return Value</h4> + <p><code>YES</code> on success; <code>NO</code> on 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> - <li><code><p><a href="#//api/name/lastErrorMessage">- lastErrorMessage</a></p></code></li> + - <li><code><p><a href="#//api/name/lastError">- lastError</a></p></code></li> + - </ul> + <div class="method-subsection discussion-section"> + <h4 class="method-subtitle">Discussion</h4> + <p>Start save point</p> + </div> + + + + + + <div class="method-subsection see-also-section"> + <h4 class="method-subtitle">See Also</h4> + <ul> + + <li><code><p><a href="#//api/name/releaseSavePointWithName:error:">- releaseSavePointWithName:error:</a></p></code></li> + + <li><code><p><a href="#//api/name/rollbackToSavePointWithName:error:">- rollbackToSavePointWithName:error:</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 class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMDatabase.h</code><br /> - </div> - - -</div> - - <div class="section-method"> - <a name="//api/name/lastErrorMessage" title="lastErrorMessage"></a> - <h3 class="subsubtitle method-title">lastErrorMessage</h3> - - - - <div class="method-subsection brief-description"> - <p>Last error message</p> - </div> - - +</div><div class="section-method"> + <a name="//api/name/releaseSavePointWithName:error:" title="releaseSavePointWithName:error:"></a> + <h3 class="method-title"><code><a href="#//api/name/releaseSavePointWithName:error:">– releaseSavePointWithName:error:</a></code> +</h3> - <div class="method-subsection method-declaration"><code>- (NSString *)lastErrorMessage</code></div> + <div class="method-info"> + <div class="pointy-thing"></div> - - - - - <div class="method-subsection return"> - <h4 class="method-subtitle parameter-title">Return Value</h4> - <p><code>NSString</code> of the last error message.</p> + <div class="method-info-container"> + + + <div class="method-subsection brief-description"> + <p>Release save point</p> + </div> + + + + <div class="method-subsection method-declaration"><code>- (BOOL)releaseSavePointWithName:(NSString *)<em>name</em> error:(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>name</code></th> + <td><p>Name of save point.</p></td> + </tr> + + <tr> + <th scope="row" class="argument-name"><code>outErr</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> on success; <code>NO</code> on 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>Release save point</p> + </div> + + + + + + <div class="method-subsection see-also-section"> + <h4 class="method-subtitle">See Also</h4> + <ul> + + <li><code><p><a href="#//api/name/startSavePointWithName:error:">- startSavePointWithName:error:</a></p></code></li> + + <li><code><p><a href="#//api/name/rollbackToSavePointWithName:error:">- rollbackToSavePointWithName:error:</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 class="method-subsection discussion-section"> - <h4 class="method-subtitle">Discussion</h4> - <p>Returns the English-language text that describes the most recent failed SQLite API call associated with a database connection. If a prior API call failed but the most recent API call succeeded, this return value is undefined.</p> +</div><div class="section-method"> + <a name="//api/name/rollbackToSavePointWithName:error:" title="rollbackToSavePointWithName:error:"></a> + <h3 class="method-title"><code><a href="#//api/name/rollbackToSavePointWithName:error:">– rollbackToSavePointWithName: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>Roll back to save point</p> + </div> + + + + <div class="method-subsection method-declaration"><code>- (BOOL)rollbackToSavePointWithName:(NSString *)<em>name</em> error:(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>name</code></th> + <td><p>Name of save point.</p></td> + </tr> + + <tr> + <th scope="row" class="argument-name"><code>outErr</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> on success; <code>NO</code> on 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>Roll back to save point</p> + </div> + + + + + + <div class="method-subsection see-also-section"> + <h4 class="method-subtitle">See Also</h4> + <ul> + + <li><code><p><a href="#//api/name/startSavePointWithName:error:">- startSavePointWithName:error:</a></p></code></li> + + <li><code><p><a href="#//api/name/releaseSavePointWithName:error:">- releaseSavePointWithName:error:</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 class="method-subsection see-also-section"> - <h4 class="method-subtitle">See Also</h4> - <ul> +</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"> + <div class="pointy-thing"></div> + + <div class="method-info-container"> - <li><code><p><a href="http://sqlite.org/c3ref/errcode.html">sqlite3_errmsg()</a></p></code></li> - <li><code><p><a href="#//api/name/lastErrorCode">- lastErrorCode</a></p></code></li> + <div class="method-subsection brief-description"> + <p>Start save point</p> + </div> - <li><code><p><a href="#//api/name/lastError">- lastError</a></p></code></li> + + + <div class="method-subsection method-declaration"><code>- (NSError *)inSavePoint:(void ( ^ ) ( 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>Block of code to perform from within save point.</p></td> + </tr> + + </table> + </div> + + - </ul> + <div class="method-subsection return"> + <h4 class="method-subtitle parameter-title">Return Value</h4> + <p>The NSError corresponding to the error, if any. If no error, returns <code>nil</code>.</p> + </div> + + + + + + <div class="method-subsection discussion-section"> + <h4 class="method-subtitle">Discussion</h4> + <p>Start save point</p> + </div> + + + + + + <div class="method-subsection see-also-section"> + <h4 class="method-subtitle">See Also</h4> + <ul> + + <li><code><p><a href="#//api/name/startSavePointWithName:error:">- startSavePointWithName:error:</a></p></code></li> + + <li><code><p><a href="#//api/name/releaseSavePointWithName:error:">- releaseSavePointWithName:error:</a></p></code></li> + + <li><code><p><a href="#//api/name/rollbackToSavePointWithName:error:">- rollbackToSavePointWithName:error:</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 class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMDatabase.h</code><br /> - </div> - - </div> + </div> - <div class="section-method"> - <a name="//api/name/lastInsertRowId" title="lastInsertRowId"></a> - <h3 class="subsubtitle method-title">lastInsertRowId</h3> - - - - <div class="method-subsection brief-description"> - <p>Last insert rowid</p> - </div> - - - <div class="method-subsection method-declaration"><code>- (sqlite_int64)lastInsertRowId</code></div> + <a title="SQLite library status" name="task_SQLite library status"></a> + <h2 class="task-title">SQLite library status</h2> - - - - - <div class="method-subsection return"> - <h4 class="method-subtitle parameter-title">Return Value</h4> - <p>The rowid of the last inserted row.</p> - </div> - - - - - - <div class="method-subsection discussion-section"> - <h4 class="method-subtitle">Discussion</h4> - <p>Each entry in an SQLite table has a unique 64-bit signed integer key called the “rowid”. The rowid is always available as an undeclared column named <code>ROWID</code>, <code>OID</code>, or <code>_ROWID_</code> as long as those names are not also used by explicitly declared columns. If the table has a column of type <code>INTEGER PRIMARY KEY</code> then that column is another alias for the rowid.</p> + <div class="task-list"> + <div class="section-method"> + <a name="//api/name/isSQLiteThreadSafe" title="isSQLiteThreadSafe"></a> + <h3 class="method-title"><code><a href="#//api/name/isSQLiteThreadSafe">+ isSQLiteThreadSafe</a></code> +</h3> -<p>This routine returns the rowid of the most recent successful <code>INSERT</code> into the database from the database connection in the first argument. As of SQLite version 3.7.7, this routines records the last insert rowid of both ordinary tables and virtual tables. If no successful <code>INSERT</code>s have ever occurred on that database connection, zero is returned.</p> + <div class="method-info"> + <div class="pointy-thing"></div> + + <div class="method-info-container"> + + + <div class="method-subsection brief-description"> + <p>Test to see if the library is threadsafe</p> + </div> + + + + <div class="method-subsection method-declaration"><code>+ (BOOL)isSQLiteThreadSafe</code></div> + + + + + + <div class="method-subsection return"> + <h4 class="method-subtitle parameter-title">Return Value</h4> + <p><code>NO</code> if and only if SQLite was compiled with mutexing code omitted due to the SQLITE_THREADSAFE compile-time option being set to 0.</p> + </div> + + + + + + <div class="method-subsection discussion-section"> + <h4 class="method-subtitle">Discussion</h4> + <p>Test to see if the library is threadsafe</p> + </div> + + + + + + <div class="method-subsection see-also-section"> + <h4 class="method-subtitle">See Also</h4> + <ul> + + <li><code><p><a href="http://sqlite.org/c3ref/threadsafe.html">sqlite3_threadsafe()</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 class="method-subsection see-also-section"> - <h4 class="method-subtitle">See Also</h4> - <ul> +</div><div class="section-method"> + <a name="//api/name/sqliteLibVersion" title="sqliteLibVersion"></a> + <h3 class="method-title"><code><a href="#//api/name/sqliteLibVersion">+ sqliteLibVersion</a></code> +</h3> + + <div class="method-info"> + <div class="pointy-thing"></div> + + <div class="method-info-container"> - <li><code><p><a href="http://sqlite.org/c3ref/last_insert_rowid.html">sqlite3_last_insert_rowid()</a></p></code></li> - </ul> + <div class="method-subsection brief-description"> + <p>Run-time library version numbers</p> + </div> + + + + <div class="method-subsection method-declaration"><code>+ (NSString *)sqliteLibVersion</code></div> + + + + + + <div class="method-subsection return"> + <h4 class="method-subtitle parameter-title">Return Value</h4> + <p>The sqlite library version string.</p> + </div> + + + + + + <div class="method-subsection discussion-section"> + <h4 class="method-subtitle">Discussion</h4> + <p>Run-time library version numbers</p> + </div> + + + + + + <div class="method-subsection see-also-section"> + <h4 class="method-subtitle">See Also</h4> + <ul> + + <li><code><p><a href="http://sqlite.org/c3ref/libversion.html">sqlite3_libversion()</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 class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMDatabase.h</code><br /> - </div> - - </div> + </div> - <div class="section-method"> + + <a title="Make SQL function" name="task_Make SQL function"></a> + <h2 class="task-title">Make SQL function</h2> + + <div class="task-list"> + <div class="section-method"> <a name="//api/name/makeFunctionNamed:maximumArguments:withBlock:" title="makeFunctionNamed:maximumArguments:withBlock:"></a> - <h3 class="subsubtitle method-title">makeFunctionNamed:maximumArguments:withBlock:</h3> - - - - <div class="method-subsection brief-description"> - <p>Adds SQL functions or aggregates or to redefine the behavior of existing SQL functions or aggregates.</p> - </div> - - + <h3 class="method-title"><code><a href="#//api/name/makeFunctionNamed:maximumArguments:withBlock:">– makeFunctionNamed:maximumArguments:withBlock:</a></code> +</h3> - <div class="method-subsection method-declaration"><code>- (void)makeFunctionNamed:(NSString *)<em>name</em> maximumArguments:(int)<em>count</em> withBlock:(void ( ^ ) ( sqlite3_context *context , int argc , sqlite3_value **argv ))<em>block</em></code></div> + <div class="method-info"> + <div class="pointy-thing"></div> - - - <div class="method-subsection arguments-section parameters"> - <h4 class="method-subtitle parameter-title">Parameters</h4> - - <dl class="argument-def parameter-def"> - <dt><em>name</em></dt> - <dd><p>Name of function</p></dd> - </dl> - - <dl class="argument-def parameter-def"> - <dt><em>count</em></dt> - <dd><p>Maximum number of parameters</p></dd> - </dl> - - <dl class="argument-def parameter-def"> - <dt><em>block</em></dt> - <dd><p>The block of code for the function</p></dd> - </dl> - - </div> - - - - - - - - <div class="method-subsection discussion-section"> - <h4 class="method-subtitle">Discussion</h4> - <p>For example:</p> + <div class="method-info-container"> + + + <div class="method-subsection brief-description"> + <p>Adds SQL functions or aggregates or to redefine the behavior of existing SQL functions or aggregates.</p> + </div> + + + + <div class="method-subsection method-declaration"><code>- (void)makeFunctionNamed:(NSString *)<em>name</em> maximumArguments:(int)<em>count</em> withBlock:(void ( ^ ) ( sqlite3_context *context , int argc , sqlite3_value **argv ))<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>name</code></th> + <td><p>Name of function</p></td> + </tr> + + <tr> + <th scope="row" class="argument-name"><code>count</code></th> + <td><p>Maximum number of parameters</p></td> + </tr> + + <tr> + <th scope="row" class="argument-name"><code>block</code></th> + <td><p>The block of code for the function</p></td> + </tr> + + </table> + </div> + + + + + + + + <div class="method-subsection discussion-section"> + <h4 class="method-subtitle">Discussion</h4> + <p>Adds SQL functions or aggregates or to redefine the behavior of existing SQL functions or aggregates.</p> + +<p>For example:</p> <pre><code>[queue inDatabase:^(FMDatabase *adb) { @@ -3501,1113 +4009,453 @@ FMDatabase *db = [FMDatabase databaseWithPath:dbPath]; FMDBQuickCheck(rowCount == 2); }]; </code></pre> - </div> - - - - - - <div class="method-subsection see-also-section"> - <h4 class="method-subtitle">See Also</h4> - <ul> - - <li><code><p><a href="http://sqlite.org/c3ref/create_function.html">sqlite3_create_function()</a></p></code></li> + </div> - </ul> - </div> - - - - <div class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMDatabase.h</code><br /> - </div> - - -</div> - - <div class="section-method"> - <a name="//api/name/open" title="open"></a> - <h3 class="subsubtitle method-title">open</h3> - - - - <div class="method-subsection brief-description"> - <p>Opening a new database connection</p> - </div> - - - <div class="method-subsection method-declaration"><code>- (BOOL)open</code></div> + - - - - - <div class="method-subsection return"> - <h4 class="method-subtitle parameter-title">Return Value</h4> - <p><code>YES</code> if successful, <code>NO</code> on error.</p> - </div> - - - - - - <div class="method-subsection discussion-section"> - <h4 class="method-subtitle">Discussion</h4> - <p>The database is opened for reading and writing, and is created if it does not already exist.</p> - </div> - - - - - - <div class="method-subsection see-also-section"> - <h4 class="method-subtitle">See Also</h4> - <ul> - <li><code><p><a href="http://sqlite.org/c3ref/open.html">sqlite3_open()</a></p></code></li> + <div class="method-subsection see-also-section"> + <h4 class="method-subtitle">See Also</h4> + <ul> + + <li><code><p><a href="http://sqlite.org/c3ref/create_function.html">sqlite3_create_function()</a></p></code></li> + + </ul> + </div> - <li><code><p><a href="#//api/name/openWithFlags:">- openWithFlags:</a></p></code></li> + + + <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> - <li><code><p><a href="#//api/name/close">- close</a></p></code></li> - </ul> + </div> </div> - - - - <div class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMDatabase.h</code><br /> - </div> - - </div> + </div> - <div class="section-method"> - <a name="//api/name/openWithFlags:" title="openWithFlags:"></a> - <h3 class="subsubtitle method-title">openWithFlags:</h3> - - - - <div class="method-subsection brief-description"> - <p>Opening a new database connection with flags</p> - </div> - - - - <div class="method-subsection method-declaration"><code>- (BOOL)openWithFlags:(int)<em>flags</em></code></div> - - - <div class="method-subsection arguments-section parameters"> - <h4 class="method-subtitle parameter-title">Parameters</h4> - - <dl class="argument-def parameter-def"> - <dt><em>flags</em></dt> - <dd><p>one of the following three values, optionally combined with the <code>SQLITE_OPEN_NOMUTEX</code>, <code>SQLITE_OPEN_FULLMUTEX</code>, <code>SQLITE_OPEN_SHAREDCACHE</code>, <code>SQLITE_OPEN_PRIVATECACHE</code>, and/or <code>SQLITE_OPEN_URI</code> flags:</p> + <a title="Date formatter" name="task_Date formatter"></a> + <h2 class="task-title">Date formatter</h2> -<p><code>SQLITE_OPEN_READONLY</code></p> + <div class="task-list"> + <div class="section-method"> + <a name="//api/name/storeableDateFormat:" title="storeableDateFormat:"></a> + <h3 class="method-title"><code><a href="#//api/name/storeableDateFormat:">+ storeableDateFormat:</a></code> +</h3> -<p>The database is opened in read-only mode. If the database does not already exist, an error is returned.</p> + <div class="method-info"> + <div class="pointy-thing"></div> -<p><code>SQLITE_OPEN_READWRITE</code></p> + <div class="method-info-container"> + + + <div class="method-subsection brief-description"> + <p>Generate an <code>NSDateFormatter</code> that won’t be broken by permutations of timezones or locales.</p> + </div> + + -<p>The database is opened for reading and writing if possible, or reading only if the file is write protected by the operating system. In either case the database must already exist, otherwise an error is returned.</p> + <div class="method-subsection method-declaration"><code>+ (NSDateFormatter *)storeableDateFormat:(NSString *)<em>format</em></code></div> -<p><code>SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE</code></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>format</code></th> + <td><p>A valid NSDateFormatter format string.</p></td> + </tr> + + </table> + </div> + -<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></dd> - </dl> - - </div> - - - - <div class="method-subsection return"> - <h4 class="method-subtitle parameter-title">Return Value</h4> - <p><code>YES</code> if successful, <code>NO</code> on error.</p> - </div> - - - - - - - - - - <div class="method-subsection see-also-section"> - <h4 class="method-subtitle">See Also</h4> - <ul> - <li><code><p><a href="http://sqlite.org/c3ref/open.html">sqlite3_open_v2()</a></p></code></li> + <div class="method-subsection return"> + <h4 class="method-subtitle parameter-title">Return Value</h4> + <p>A <code>NSDateFormatter</code> that can be used for converting dates to strings and vice versa.</p> + </div> - <li><code><p><a href="#//api/name/open">- open</a></p></code></li> + - <li><code><p><a href="#//api/name/close">- close</a></p></code></li> + - </ul> - </div> - - - - <div class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMDatabase.h</code><br /> - </div> - - -</div> - - <div class="section-method"> - <a name="//api/name/rekey:" title="rekey:"></a> - <h3 class="subsubtitle method-title">rekey:</h3> - - - - <div class="method-subsection brief-description"> - <p>Reset encryption key</p> - </div> - - + <div class="method-subsection discussion-section"> + <h4 class="method-subtitle">Discussion</h4> + <p>Generate an <code>NSDateFormatter</code> that won’t be broken by permutations of timezones or locales.</p> - <div class="method-subsection method-declaration"><code>- (BOOL)rekey:(NSString *)<em>key</em></code></div> +<p>Use this method to generate values to set the dateFormat property.</p> - - - <div class="method-subsection arguments-section parameters"> - <h4 class="method-subtitle parameter-title">Parameters</h4> - - <dl class="argument-def parameter-def"> - <dt><em>key</em></dt> - <dd><p>The key to be used.</p></dd> - </dl> - - </div> - - - - <div class="method-subsection return"> - <h4 class="method-subtitle parameter-title">Return Value</h4> - <p><code>YES</code> if success, <code>NO</code> on error.</p> - </div> - - - - - - <div class="method-subsection discussion-section"> - <h4 class="method-subtitle">Discussion</h4> - <div class="warning"><p><strong>Warning:</strong> You need to have purchased the sqlite encryption extensions for this method to work.</p></div> - </div> - - - - - - <div class="method-subsection see-also-section"> - <h4 class="method-subtitle">See Also</h4> - <ul> +<p>Example:</p> + +<pre><code>myDB.dateFormat = [FMDatabase storeableDateFormat:@"yyyy-MM-dd HH:mm:ss"]; +</code></pre><div class="warning"><p><strong>Warning:</strong> Note that <code>NSDateFormatter</code> is not thread-safe, so the formatter generated by this method should be assigned to only one FMDB instance and should not be used for other purposes.</p></div> + </div> - <li><code><p><a href="http://www.sqlite-encrypt.com/develop-guide.htm">http://www.sqlite-encrypt.com/develop-guide.htm</a></p></code></li> + - </ul> - </div> - - - - <div class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMDatabase.h</code><br /> - </div> - - -</div> - - <div class="section-method"> - <a name="//api/name/rekeyWithData:" title="rekeyWithData:"></a> - <h3 class="subsubtitle method-title">rekeyWithData:</h3> - - - - <div class="method-subsection brief-description"> - <p>Reset encryption key using <code>keyData</code>.</p> - </div> - - - <div class="method-subsection method-declaration"><code>- (BOOL)rekeyWithData:(NSData *)<em>keyData</em></code></div> + + <div class="method-subsection see-also-section"> + <h4 class="method-subtitle">See Also</h4> + <ul> + + <li><code><p><a href="#//api/name/hasDateFormatter">- hasDateFormatter</a></p></code></li> + + <li><code><p><a href="#//api/name/setDateFormat:">- setDateFormat:</a></p></code></li> + + <li><code><p><a href="#//api/name/dateFromString:">- dateFromString:</a></p></code></li> + + <li><code><p><a href="#//api/name/stringFromDate:">- stringFromDate:</a></p></code></li> + + <li><code><p><a href="#//api/name/storeableDateFormat:">+ storeableDateFormat:</a></p></code></li> + + </ul> + </div> + - - - <div class="method-subsection arguments-section parameters"> - <h4 class="method-subtitle parameter-title">Parameters</h4> - - <dl class="argument-def parameter-def"> - <dt><em>keyData</em></dt> - <dd><p>The <code>NSData</code> to be used.</p></dd> - </dl> - - </div> - - - - <div class="method-subsection return"> - <h4 class="method-subtitle parameter-title">Return Value</h4> - <p><code>YES</code> if success, <code>NO</code> on error.</p> - </div> - - - - - - <div class="method-subsection discussion-section"> - <h4 class="method-subtitle">Discussion</h4> - <div class="warning"><p><strong>Warning:</strong> You need to have purchased the sqlite encryption extensions for this method to work.</p></div> - </div> - - - - - - <div class="method-subsection see-also-section"> - <h4 class="method-subtitle">See Also</h4> - <ul> - <li><code><p><a href="http://www.sqlite-encrypt.com/develop-guide.htm">http://www.sqlite-encrypt.com/develop-guide.htm</a></p></code></li> + <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> + - </ul> + </div> </div> - - - - <div class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMDatabase.h</code><br /> - </div> - - -</div> - - <div class="section-method"> - <a name="//api/name/releaseSavePointWithName:error:" title="releaseSavePointWithName:error:"></a> - <h3 class="subsubtitle method-title">releaseSavePointWithName:error:</h3> - - - - <div class="method-subsection brief-description"> - <p>Release save point</p> - </div> - - +</div><div class="section-method"> + <a name="//api/name/hasDateFormatter" title="hasDateFormatter"></a> + <h3 class="method-title"><code><a href="#//api/name/hasDateFormatter">– hasDateFormatter</a></code> +</h3> - <div class="method-subsection method-declaration"><code>- (BOOL)releaseSavePointWithName:(NSString *)<em>name</em> error:(NSError **)<em>outErr</em></code></div> + <div class="method-info"> + <div class="pointy-thing"></div> - - - <div class="method-subsection arguments-section parameters"> - <h4 class="method-subtitle parameter-title">Parameters</h4> - - <dl class="argument-def parameter-def"> - <dt><em>name</em></dt> - <dd><p>Name of save point.</p></dd> - </dl> - - <dl class="argument-def parameter-def"> - <dt><em>outErr</em></dt> - <dd><p>A <code>NSError</code> object to receive any error object (if any).</p></dd> - </dl> - - </div> - - - - <div class="method-subsection return"> - <h4 class="method-subtitle parameter-title">Return Value</h4> - <p><code>YES</code> on success; <code>NO</code> on 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 see-also-section"> - <h4 class="method-subtitle">See Also</h4> - <ul> + <div class="method-info-container"> - <li><code><p><a href="#//api/name/startSavePointWithName:error:">- startSavePointWithName:error:</a></p></code></li> - <li><code><p><a href="#//api/name/rollbackToSavePointWithName:error:">- rollbackToSavePointWithName:error:</a></p></code></li> + <div class="method-subsection brief-description"> + <p>Test whether the database has a date formatter assigned.</p> + </div> - </ul> - </div> - - - - <div class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMDatabase.h</code><br /> - </div> - - -</div> - - <div class="section-method"> - <a name="//api/name/rollback" title="rollback"></a> - <h3 class="subsubtitle method-title">rollback</h3> - - - - <div class="method-subsection brief-description"> - <p>Rollback a transaction</p> - </div> - - + - <div class="method-subsection method-declaration"><code>- (BOOL)rollback</code></div> + <div class="method-subsection method-declaration"><code>- (BOOL)hasDateFormatter</code></div> - - - - - <div class="method-subsection return"> - <h4 class="method-subtitle parameter-title">Return Value</h4> - <p><code>YES</code> on success; <code>NO</code> on 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>Rollback a transaction that was initiated with either <a href="#//api/name/beginTransaction"><code>beginTransaction</code></a> or with <a href="#//api/name/beginDeferredTransaction"><code>beginDeferredTransaction</code></a>.</p> - </div> - - - - - - <div class="method-subsection see-also-section"> - <h4 class="method-subtitle">See Also</h4> - <ul> + - <li><code><p><a href="#//api/name/beginTransaction">- beginTransaction</a></p></code></li> + - <li><code><p><a href="#//api/name/beginDeferredTransaction">- beginDeferredTransaction</a></p></code></li> + <div class="method-subsection return"> + <h4 class="method-subtitle parameter-title">Return Value</h4> + <p><code>YES</code> if there is a date formatter; <code>NO</code> if not.</p> + </div> - <li><code><p><a href="#//api/name/commit">- commit</a></p></code></li> + - <li><code><p><a href="#//api/name/inTransaction">- inTransaction</a></p></code></li> + + + <div class="method-subsection discussion-section"> + <h4 class="method-subtitle">Discussion</h4> + <p>Test whether the database has a date formatter assigned.</p> + </div> - </ul> - </div> - - - - <div class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMDatabase.h</code><br /> - </div> - - -</div> - - <div class="section-method"> - <a name="//api/name/rollbackToSavePointWithName:error:" title="rollbackToSavePointWithName:error:"></a> - <h3 class="subsubtitle method-title">rollbackToSavePointWithName:error:</h3> - - - - <div class="method-subsection brief-description"> - <p>Roll back to save point</p> - </div> - - - <div class="method-subsection method-declaration"><code>- (BOOL)rollbackToSavePointWithName:(NSString *)<em>name</em> error:(NSError **)<em>outErr</em></code></div> + + + + <div class="method-subsection see-also-section"> + <h4 class="method-subtitle">See Also</h4> + <ul> + + <li><code><p><a href="#//api/name/hasDateFormatter">- hasDateFormatter</a></p></code></li> + + <li><code><p><a href="#//api/name/setDateFormat:">- setDateFormat:</a></p></code></li> + + <li><code><p><a href="#//api/name/dateFromString:">- dateFromString:</a></p></code></li> + + <li><code><p><a href="#//api/name/stringFromDate:">- stringFromDate:</a></p></code></li> + + <li><code><p><a href="#//api/name/storeableDateFormat:">+ storeableDateFormat:</a></p></code></li> + + </ul> + </div> + - - - <div class="method-subsection arguments-section parameters"> - <h4 class="method-subtitle parameter-title">Parameters</h4> - - <dl class="argument-def parameter-def"> - <dt><em>name</em></dt> - <dd><p>Name of save point.</p></dd> - </dl> - - <dl class="argument-def parameter-def"> - <dt><em>outErr</em></dt> - <dd><p>A <code>NSError</code> object to receive any error object (if any).</p></dd> - </dl> - - </div> - - - - <div class="method-subsection return"> - <h4 class="method-subtitle parameter-title">Return Value</h4> - <p><code>YES</code> on success; <code>NO</code> on 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 see-also-section"> - <h4 class="method-subtitle">See Also</h4> - <ul> - <li><code><p><a href="#//api/name/startSavePointWithName:error:">- startSavePointWithName:error:</a></p></code></li> + <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> - <li><code><p><a href="#//api/name/releaseSavePointWithName:error:">- releaseSavePointWithName:error:</a></p></code></li> - </ul> + </div> </div> - - - - <div class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMDatabase.h</code><br /> - </div> - - -</div> - - <div class="section-method"> +</div><div class="section-method"> <a name="//api/name/setDateFormat:" title="setDateFormat:"></a> - <h3 class="subsubtitle method-title">setDateFormat:</h3> - - - - <div class="method-subsection brief-description"> - <p>Set to a date formatter to use string dates with sqlite instead of the default UNIX timestamps.</p> - </div> - - + <h3 class="method-title"><code><a href="#//api/name/setDateFormat:">– setDateFormat:</a></code> +</h3> - <div class="method-subsection method-declaration"><code>- (void)setDateFormat:(NSDateFormatter *)<em>format</em></code></div> + <div class="method-info"> + <div class="pointy-thing"></div> - - - <div class="method-subsection arguments-section parameters"> - <h4 class="method-subtitle parameter-title">Parameters</h4> - - <dl class="argument-def parameter-def"> - <dt><em>format</em></dt> - <dd><p>Set to nil to use UNIX timestamps. Defaults to nil. Should be set using a formatter generated using FMDatabase::storeableDateFormat.</p></dd> - </dl> - - </div> - - - - - - - - <div class="method-subsection discussion-section"> - <h4 class="method-subtitle">Discussion</h4> - <div class="warning"><p><strong>Warning:</strong> Note there is no direct getter for the <code>NSDateFormatter</code>, and you should not use the formatter you pass to FMDB for other purposes, as <code>NSDateFormatter</code> is not thread-safe.</p></div> - </div> - - - - - - <div class="method-subsection see-also-section"> - <h4 class="method-subtitle">See Also</h4> - <ul> + <div class="method-info-container"> - <li><code><p><a href="#//api/name/hasDateFormatter">- hasDateFormatter</a></p></code></li> - <li><code><p><a href="#//api/name/setDateFormat:">- setDateFormat:</a></p></code></li> + <div class="method-subsection brief-description"> + <p>Set to a date formatter to use string dates with sqlite instead of the default UNIX timestamps.</p> + </div> - <li><code><p><a href="#//api/name/dateFromString:">- dateFromString:</a></p></code></li> + + + <div class="method-subsection method-declaration"><code>- (void)setDateFormat:(NSDateFormatter *)<em>format</em></code></div> + + - <li><code><p><a href="#//api/name/stringFromDate:">- stringFromDate:</a></p></code></li> + <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>format</code></th> + <td><p>Set to nil to use UNIX timestamps. Defaults to nil. Should be set using a formatter generated using FMDatabase::storeableDateFormat.</p></td> + </tr> + + </table> + </div> - <li><code><p><a href="#//api/name/storeableDateFormat:">+ storeableDateFormat:</a></p></code></li> + - </ul> - </div> - - - - <div class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMDatabase.h</code><br /> - </div> - - -</div> - - <div class="section-method"> - <a name="//api/name/setKey:" title="setKey:"></a> - <h3 class="subsubtitle method-title">setKey:</h3> - - - - <div class="method-subsection brief-description"> - <p>Set encryption key.</p> - </div> - - - <div class="method-subsection method-declaration"><code>- (BOOL)setKey:(NSString *)<em>key</em></code></div> + - - - <div class="method-subsection arguments-section parameters"> - <h4 class="method-subtitle parameter-title">Parameters</h4> - - <dl class="argument-def parameter-def"> - <dt><em>key</em></dt> - <dd><p>The key to be used.</p></dd> - </dl> - - </div> - - - - <div class="method-subsection return"> - <h4 class="method-subtitle parameter-title">Return Value</h4> - <p><code>YES</code> if success, <code>NO</code> on error.</p> - </div> - - - - - - <div class="method-subsection discussion-section"> - <h4 class="method-subtitle">Discussion</h4> - <div class="warning"><p><strong>Warning:</strong> You need to have purchased the sqlite encryption extensions for this method to work.</p></div> - </div> - - - - - - <div class="method-subsection see-also-section"> - <h4 class="method-subtitle">See Also</h4> - <ul> - <li><code><p><a href="http://www.sqlite-encrypt.com/develop-guide.htm">http://www.sqlite-encrypt.com/develop-guide.htm</a></p></code></li> + <div class="method-subsection discussion-section"> + <h4 class="method-subtitle">Discussion</h4> + <p>Set to a date formatter to use string dates with sqlite instead of the default UNIX timestamps.</p><div class="warning"><p><strong>Warning:</strong> Note there is no direct getter for the <code>NSDateFormatter</code>, and you should not use the formatter you pass to FMDB for other purposes, as <code>NSDateFormatter</code> is not thread-safe.</p></div> + </div> - </ul> - </div> - - - - <div class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMDatabase.h</code><br /> - </div> - - -</div> - - <div class="section-method"> - <a name="//api/name/setKeyWithData:" title="setKeyWithData:"></a> - <h3 class="subsubtitle method-title">setKeyWithData:</h3> - - - - <div class="method-subsection brief-description"> - <p>Set encryption key using <code>keyData</code>.</p> - </div> - - - <div class="method-subsection method-declaration"><code>- (BOOL)setKeyWithData:(NSData *)<em>keyData</em></code></div> + - - - <div class="method-subsection arguments-section parameters"> - <h4 class="method-subtitle parameter-title">Parameters</h4> - - <dl class="argument-def parameter-def"> - <dt><em>keyData</em></dt> - <dd><p>The <code>NSData</code> to be used.</p></dd> - </dl> - - </div> - - - - <div class="method-subsection return"> - <h4 class="method-subtitle parameter-title">Return Value</h4> - <p><code>YES</code> if success, <code>NO</code> on error.</p> - </div> - - - - - - <div class="method-subsection discussion-section"> - <h4 class="method-subtitle">Discussion</h4> - <div class="warning"><p><strong>Warning:</strong> You need to have purchased the sqlite encryption extensions for this method to work.</p></div> - </div> - - - - - - <div class="method-subsection see-also-section"> - <h4 class="method-subtitle">See Also</h4> - <ul> - <li><code><p><a href="http://www.sqlite-encrypt.com/develop-guide.htm">http://www.sqlite-encrypt.com/develop-guide.htm</a></p></code></li> + <div class="method-subsection see-also-section"> + <h4 class="method-subtitle">See Also</h4> + <ul> + + <li><code><p><a href="#//api/name/hasDateFormatter">- hasDateFormatter</a></p></code></li> + + <li><code><p><a href="#//api/name/setDateFormat:">- setDateFormat:</a></p></code></li> + + <li><code><p><a href="#//api/name/dateFromString:">- dateFromString:</a></p></code></li> + + <li><code><p><a href="#//api/name/stringFromDate:">- stringFromDate:</a></p></code></li> + + <li><code><p><a href="#//api/name/storeableDateFormat:">+ storeableDateFormat:</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> + - </ul> + </div> </div> - - - - <div class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMDatabase.h</code><br /> - </div> - - -</div> - - <div class="section-method"> - <a name="//api/name/setShouldCacheStatements:" title="setShouldCacheStatements:"></a> - <h3 class="subsubtitle method-title">setShouldCacheStatements:</h3> - - - - <div class="method-subsection brief-description"> - <p>Set whether should cache statements or not</p> - </div> - - +</div><div class="section-method"> + <a name="//api/name/dateFromString:" title="dateFromString:"></a> + <h3 class="method-title"><code><a href="#//api/name/dateFromString:">– dateFromString:</a></code> +</h3> - <div class="method-subsection method-declaration"><code>- (void)setShouldCacheStatements:(BOOL)<em>value</em></code></div> + <div class="method-info"> + <div class="pointy-thing"></div> - - - <div class="method-subsection arguments-section parameters"> - <h4 class="method-subtitle parameter-title">Parameters</h4> - - <dl class="argument-def parameter-def"> - <dt><em>value</em></dt> - <dd><p><code>YES</code> if should cache statements; <code>NO</code> if not.</p></dd> - </dl> - - </div> - - - - - - - - - - - - - - <div class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMDatabase.h</code><br /> - </div> - - -</div> - - <div class="section-method"> - <a name="//api/name/shouldCacheStatements" title="shouldCacheStatements"></a> - <h3 class="subsubtitle method-title">shouldCacheStatements</h3> - - - - <div class="method-subsection brief-description"> - <p>Return whether should cache statements or not</p> - </div> - - + <div class="method-info-container"> + + + <div class="method-subsection brief-description"> + <p>Convert the supplied NSString to NSDate, using the current database formatter.</p> + </div> + + - <div class="method-subsection method-declaration"><code>- (BOOL)shouldCacheStatements</code></div> + <div class="method-subsection method-declaration"><code>- (NSDate *)dateFromString:(NSString *)<em>s</em></code></div> - - - - - <div class="method-subsection return"> - <h4 class="method-subtitle parameter-title">Return Value</h4> - <p><code>YES</code> if should cache statements; <code>NO</code> if not.</p> - </div> - - - - - - - - - - - - <div class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMDatabase.h</code><br /> - </div> - - -</div> - - <div class="section-method"> - <a name="//api/name/sqliteHandle" title="sqliteHandle"></a> - <h3 class="subsubtitle method-title">sqliteHandle</h3> - - - - <div class="method-subsection brief-description"> - <p>The underlying SQLite handle</p> - </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>s</code></th> + <td><p><code>NSString</code> to convert to <code>NSDate</code>.</p></td> + </tr> + + </table> + </div> + - <div class="method-subsection method-declaration"><code>- (sqlite3 *)sqliteHandle</code></div> + + <div class="method-subsection return"> + <h4 class="method-subtitle parameter-title">Return Value</h4> + <p>The <code>NSDate</code> object; or <code>nil</code> if no formatter is set.</p> + </div> + - - - - - <div class="method-subsection return"> - <h4 class="method-subtitle parameter-title">Return Value</h4> - <p>The <code>sqlite3</code> pointer.</p> - </div> - - - - - - - - - - - - <div class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMDatabase.h</code><br /> - </div> - - -</div> - - <div class="section-method"> - <a name="//api/name/startSavePointWithName:error:" title="startSavePointWithName:error:"></a> - <h3 class="subsubtitle method-title">startSavePointWithName:error:</h3> - - - - <div class="method-subsection brief-description"> - <p>Start save point</p> - </div> - - + - <div class="method-subsection method-declaration"><code>- (BOOL)startSavePointWithName:(NSString *)<em>name</em> error:(NSError **)<em>outErr</em></code></div> + + <div class="method-subsection discussion-section"> + <h4 class="method-subtitle">Discussion</h4> + <p>Convert the supplied NSString to NSDate, using the current database formatter.</p> + </div> + - - - <div class="method-subsection arguments-section parameters"> - <h4 class="method-subtitle parameter-title">Parameters</h4> - - <dl class="argument-def parameter-def"> - <dt><em>name</em></dt> - <dd><p>Name of save point.</p></dd> - </dl> - - <dl class="argument-def parameter-def"> - <dt><em>outErr</em></dt> - <dd><p>A <code>NSError</code> object to receive any error object (if any).</p></dd> - </dl> - - </div> - - - - <div class="method-subsection return"> - <h4 class="method-subtitle parameter-title">Return Value</h4> - <p><code>YES</code> on success; <code>NO</code> on 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 see-also-section"> - <h4 class="method-subtitle">See Also</h4> - <ul> - <li><code><p><a href="#//api/name/releaseSavePointWithName:error:">- releaseSavePointWithName:error:</a></p></code></li> + - <li><code><p><a href="#//api/name/rollbackToSavePointWithName:error:">- rollbackToSavePointWithName:error:</a></p></code></li> + <div class="method-subsection see-also-section"> + <h4 class="method-subtitle">See Also</h4> + <ul> + + <li><code><p><a href="#//api/name/hasDateFormatter">- hasDateFormatter</a></p></code></li> + + <li><code><p><a href="#//api/name/setDateFormat:">- setDateFormat:</a></p></code></li> + + <li><code><p><a href="#//api/name/dateFromString:">- dateFromString:</a></p></code></li> + + <li><code><p><a href="#//api/name/stringFromDate:">- stringFromDate:</a></p></code></li> + + <li><code><p><a href="#//api/name/storeableDateFormat:">+ storeableDateFormat:</a></p></code></li> + + </ul> + </div> - </ul> + + + <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 class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMDatabase.h</code><br /> - </div> - - -</div> - - <div class="section-method"> +</div><div class="section-method"> <a name="//api/name/stringFromDate:" title="stringFromDate:"></a> - <h3 class="subsubtitle method-title">stringFromDate:</h3> - - - - <div class="method-subsection brief-description"> - <p>Convert the supplied NSDate to NSString, using the current database formatter.</p> - </div> - - + <h3 class="method-title"><code><a href="#//api/name/stringFromDate:">– stringFromDate:</a></code> +</h3> - <div class="method-subsection method-declaration"><code>- (NSString *)stringFromDate:(NSDate *)<em>date</em></code></div> + <div class="method-info"> + <div class="pointy-thing"></div> - - - <div class="method-subsection arguments-section parameters"> - <h4 class="method-subtitle parameter-title">Parameters</h4> - - <dl class="argument-def parameter-def"> - <dt><em>date</em></dt> - <dd><p><code>NSDate</code> of date to convert to <code>NSString</code>.</p></dd> - </dl> - - </div> - - - - <div class="method-subsection return"> - <h4 class="method-subtitle parameter-title">Return Value</h4> - <p>The <code>NSString</code> representation of the date; <code>nil</code> if no formatter is set.</p> - </div> - - - - - - - - - - <div class="method-subsection see-also-section"> - <h4 class="method-subtitle">See Also</h4> - <ul> + <div class="method-info-container"> - <li><code><p><a href="#//api/name/hasDateFormatter">- hasDateFormatter</a></p></code></li> - <li><code><p><a href="#//api/name/setDateFormat:">- setDateFormat:</a></p></code></li> + <div class="method-subsection brief-description"> + <p>Convert the supplied NSDate to NSString, using the current database formatter.</p> + </div> - <li><code><p><a href="#//api/name/dateFromString:">- dateFromString:</a></p></code></li> + + + <div class="method-subsection method-declaration"><code>- (NSString *)stringFromDate:(NSDate *)<em>date</em></code></div> + + - <li><code><p><a href="#//api/name/stringFromDate:">- stringFromDate:</a></p></code></li> + <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>date</code></th> + <td><p><code>NSDate</code> of date to convert to <code>NSString</code>.</p></td> + </tr> + + </table> + </div> - <li><code><p><a href="#//api/name/storeableDateFormat:">+ storeableDateFormat:</a></p></code></li> + + + <div class="method-subsection return"> + <h4 class="method-subtitle parameter-title">Return Value</h4> + <p>The <code>NSString</code> representation of the date; <code>nil</code> if no formatter is set.</p> + </div> - </ul> - </div> - - - - <div class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMDatabase.h</code><br /> - </div> - - -</div> - - <div class="section-method"> - <a name="//api/name/update:withErrorAndBindings:" title="update:withErrorAndBindings:"></a> - <h3 class="subsubtitle method-title">update:withErrorAndBindings:</h3> - - - - <div class="method-subsection brief-description"> - <p>Execute single update statement</p> - </div> - - - <div class="method-subsection method-declaration"><code>- (BOOL)update:(NSString *)<em>sql</em> withErrorAndBindings:(NSError **)<em>outErr</em>, <em>...</em></code></div> + - - - - - - - - - <div class="method-subsection discussion-section"> - <h4 class="method-subtitle">Discussion</h4> - <div class="warning"><p><strong>Warning:</strong> <strong>Deprecated</strong>: Please use <code><executeUpdate:withErrorAndBindings></code> instead.</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/executeUpdate:withErrorAndBindings:">- executeUpdate:withErrorAndBindings:</a></p></code></li> + <div class="method-subsection discussion-section"> + <h4 class="method-subtitle">Discussion</h4> + <p>Convert the supplied NSDate to NSString, using the current database formatter.</p> + </div> + + + + + + <div class="method-subsection see-also-section"> + <h4 class="method-subtitle">See Also</h4> + <ul> + + <li><code><p><a href="#//api/name/hasDateFormatter">- hasDateFormatter</a></p></code></li> + + <li><code><p><a href="#//api/name/setDateFormat:">- setDateFormat:</a></p></code></li> + + <li><code><p><a href="#//api/name/dateFromString:">- dateFromString:</a></p></code></li> + + <li><code><p><a href="#//api/name/stringFromDate:">- stringFromDate:</a></p></code></li> + + <li><code><p><a href="#//api/name/storeableDateFormat:">+ storeableDateFormat:</a></p></code></li> + + </ul> + </div> + + - </ul> + <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 class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMDatabase.h</code><br /> - </div> - - </div> + </div> </div> - </div> - <div class="main-navigation navigation-bottom"> - <ul> - <li><a href="../index.html">Index</a></li> - <li><a href="../hierarchy.html">Hierarchy</a></li> -</ul> - </div> - <div id="footer"> - <hr /> + + + </main> + + <footer> <div class="footer-copyright"> - <p><span class="copyright">© 2014 ccgus. All rights reserved. (Last updated: 2014-05-25)</span><br /> - <span class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.1 (build 858)</a>.</span></p> + <p class="copyright">Copyright © 2015 ccgus. All rights reserved. Updated: 2015-01-25</p> + + + <p class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.2.1 (build 1333)</a>.</p> </div> - </div> - </div> - </article> - <script type="text/javascript"> - function jumpToChange() - { - window.location.hash = this.options[this.selectedIndex].value; - } - - function toggleTOC() - { - var contents = document.getElementById('contents'); - var tocContainer = document.getElementById('tocContainer'); - - if (this.getAttribute('class') == 'open') - { - this.setAttribute('class', ''); - contents.setAttribute('class', ''); - tocContainer.setAttribute('class', ''); - - window.name = "hideTOC"; - } - else - { - this.setAttribute('class', 'open'); - contents.setAttribute('class', 'isShowingTOC'); - tocContainer.setAttribute('class', 'isShowingTOC'); - - window.name = ""; - } - return false; - } - - function toggleTOCEntryChildren(e) - { - e.stopPropagation(); - var currentClass = this.getAttribute('class'); - if (currentClass == 'children') { - this.setAttribute('class', 'children open'); - } - else if (currentClass == 'children open') { - this.setAttribute('class', 'children'); - } - return false; - } - - function tocEntryClick(e) - { - e.stopPropagation(); - return true; - } - - function init() - { - var selectElement = document.getElementById('jumpTo'); - selectElement.addEventListener('change', jumpToChange, false); - - var tocButton = document.getElementById('table_of_contents'); - tocButton.addEventListener('click', toggleTOC, false); - - var taskTreeItem = document.getElementById('task_treeitem'); - if (taskTreeItem.getElementsByTagName('li').length > 0) - { - taskTreeItem.setAttribute('class', 'children'); - taskTreeItem.firstChild.setAttribute('class', 'disclosure'); - } - - var tocList = document.getElementById('toc'); - - var tocEntries = tocList.getElementsByTagName('li'); - for (var i = 0; i < tocEntries.length; i++) { - tocEntries[i].addEventListener('click', toggleTOCEntryChildren, false); - } - - var tocLinks = tocList.getElementsByTagName('a'); - for (var i = 0; i < tocLinks.length; i++) { - tocLinks[i].addEventListener('click', tocEntryClick, false); - } - - if (window.name == "hideTOC") { - toggleTOC.call(tocButton); - } - } - - window.onload = init; - - // If showing in Xcode, hide the TOC and Header - if (navigator.userAgent.match(/xcode/i)) { - document.getElementById("contents").className = "hideInXcode" - document.getElementById("tocContainer").className = "hideInXcode" - document.getElementById("top_header").className = "hideInXcode" - } - - </script> - </body> + </footer> + </div> + </div> + </article> + + <script src="../js/script.js"></script> +</body> </html>
\ No newline at end of file diff --git a/html/Classes/FMDatabasePool.html b/html/Classes/FMDatabasePool.html index b7c3146..524cc1b 100644 --- a/html/Classes/FMDatabasePool.html +++ b/html/Classes/FMDatabasePool.html @@ -1,188 +1,135 @@ -<!DOCTYPE HTML> +<!DOCTYPE html> <html> - <head> - <meta http-equiv="Content-Type" content="html/html; charset=utf-8" /> - <title>FMDatabasePool Class Reference</title> - <meta id="xcode-display" name="xcode-display" content="render"/> - <meta name="viewport" content="width=550" /> - <link rel="stylesheet" type="text/css" href="../css/styles.css" media="all" /> - <link rel="stylesheet" type="text/css" media="print" href="../css/stylesPrint.css" /> - <meta name="generator" content="appledoc 2.1 (build 858)" /> - </head> - <body> - <header id="top_header"> - <div id="library" class="hideInXcode"> - <h1><a id="libraryTitle" href="../index.html">FMDB </a></h1> - <a id="developerHome" href="../index.html">ccgus</a> - </div> - - <div id="title" role="banner"> - <h1 class="hideInXcode">FMDatabasePool Class Reference</h1> - </div> - <ul id="headerButtons" role="toolbar"> - <li id="toc_button"> - <button aria-label="Show Table of Contents" role="checkbox" class="open" id="table_of_contents"><span class="disclosure"></span>Table of Contents</button> - </li> - <li id="jumpto_button" role="navigation"> - <select id="jumpTo"> - <option value="top">Jump To…</option> - - <option value="overview">Overview</option> - - - - - <option value="tasks">Tasks</option> - - - - - - <option value="properties">Properties</option> - - <option value="//api/name/delegate"> delegate</option> - - <option value="//api/name/maximumNumberOfDatabasesToCreate"> maximumNumberOfDatabasesToCreate</option> - - <option value="//api/name/openFlags"> openFlags</option> - - <option value="//api/name/path"> path</option> - - - - - <option value="class_methods">Class Methods</option> - - <option value="//api/name/databasePoolWithPath:"> + databasePoolWithPath:</option> - - <option value="//api/name/databasePoolWithPath:flags:"> + databasePoolWithPath:flags:</option> - - - - - <option value="instance_methods">Instance Methods</option> - - <option value="//api/name/countOfCheckedInDatabases"> - countOfCheckedInDatabases</option> - - <option value="//api/name/countOfCheckedOutDatabases"> - countOfCheckedOutDatabases</option> - - <option value="//api/name/countOfOpenDatabases"> - countOfOpenDatabases</option> - - <option value="//api/name/inDatabase:"> - inDatabase:</option> - - <option value="//api/name/inDeferredTransaction:"> - inDeferredTransaction:</option> - - <option value="//api/name/inSavePoint:"> - inSavePoint:</option> - - <option value="//api/name/inTransaction:"> - inTransaction:</option> - - <option value="//api/name/initWithPath:"> - initWithPath:</option> - - <option value="//api/name/initWithPath:flags:"> - initWithPath:flags:</option> - - <option value="//api/name/releaseAllDatabases"> - releaseAllDatabases</option> - - - -</select> - </li> - </ul> - </header> - <nav id="tocContainer" class="isShowingTOC"> - <ul id="toc" role="tree"> - -<li role="treeitem"><span class="nodisclosure"></span><span class="sectionName"><a href="#overview">Overview</a></span></li> - +<head> + <meta charset="utf-8"> + <title>FMDatabasePool Class Reference</title> + <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)"> +</head> +<body class="appledoc"> + <header> + <div class="container" class="hide-in-xcode"> + + <h1 id="library-title"> + <a href="../index.html">FMDB </a> + </h1> -<li role="treeitem" id="task_treeitem"><span class="nodisclosure"></span><span class="sectionName"><a href="#tasks">Tasks</a></span><ul> - -</ul></li> - + <p id="developer-home"> + <a href="../index.html">ccgus</a> + </p> + + </div> + </header> + <aside> + <div class="container"> + <nav> + <ul id="header-buttons" role="toolbar"> + <li><a href="../index.html">Index</a></li> +<li><a href="../hierarchy.html">Hierarchy</a></li> + <li id="on-this-page" role="navigation"> + <label> + On This Page + <div class="chevron"> + <div class="chevy chevron-left"></div> + <div class="chevy chevron-right"></div> + </div> -<li role="treeitem" class="children"><span class="disclosure"></span><span class="sectionName"><a href="#properties">Properties</a></span><ul> - - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/delegate">delegate</a></span></li> - - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/maximumNumberOfDatabasesToCreate">maximumNumberOfDatabasesToCreate</a></span></li> - - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/openFlags">openFlags</a></span></li> + <select id="jump-to"> + <option value="top">Jump To…</option> - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/path">path</a></span></li> + <option value="overview">Overview</option> -</ul></li> - - -<li role="treeitem" class="children"><span class="disclosure"></span><span class="sectionName"><a href="#class_methods">Class Methods</a></span><ul> - - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/databasePoolWithPath:">databasePoolWithPath:</a></span></li> - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/databasePoolWithPath:flags:">databasePoolWithPath:flags:</a></span></li> -</ul></li> - - - -<li role="treeitem" class="children"><span class="disclosure"></span><span class="sectionName"><a href="#instance_methods">Instance Methods</a></span><ul> - - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/countOfCheckedInDatabases">countOfCheckedInDatabases</a></span></li> + <option value="tasks">Tasks</option> - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/countOfCheckedOutDatabases">countOfCheckedOutDatabases</a></span></li> - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/countOfOpenDatabases">countOfOpenDatabases</a></span></li> + - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/inDatabase:">inDatabase:</a></span></li> - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/inDeferredTransaction:">inDeferredTransaction:</a></span></li> + <optgroup label="Properties"> + + <option value="//api/name/delegate">delegate</option> + + <option value="//api/name/maximumNumberOfDatabasesToCreate">maximumNumberOfDatabasesToCreate</option> + + <option value="//api/name/openFlags">openFlags</option> + + <option value="//api/name/path">path</option> + + </optgroup> - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/inSavePoint:">inSavePoint:</a></span></li> + - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/inTransaction:">inTransaction:</a></span></li> + <optgroup label="Class Methods"> + + <option value="//api/name/databasePoolWithPath:">+ databasePoolWithPath:</option> + + <option value="//api/name/databasePoolWithPath:flags:">+ databasePoolWithPath:flags:</option> + + </optgroup> - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/initWithPath:">initWithPath:</a></span></li> + - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/initWithPath:flags:">initWithPath:flags:</a></span></li> + <optgroup label="Instance Methods"> + + <option value="//api/name/countOfCheckedInDatabases">- countOfCheckedInDatabases</option> + + <option value="//api/name/countOfCheckedOutDatabases">- countOfCheckedOutDatabases</option> + + <option value="//api/name/countOfOpenDatabases">- countOfOpenDatabases</option> + + <option value="//api/name/inDatabase:">- inDatabase:</option> + + <option value="//api/name/inDeferredTransaction:">- inDeferredTransaction:</option> + + <option value="//api/name/inSavePoint:">- inSavePoint:</option> + + <option value="//api/name/inTransaction:">- inTransaction:</option> + + <option value="//api/name/initWithPath:">- initWithPath:</option> + + <option value="//api/name/initWithPath:flags:">- initWithPath:flags:</option> + + <option value="//api/name/releaseAllDatabases">- releaseAllDatabases</option> + + </optgroup> - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/releaseAllDatabases">releaseAllDatabases</a></span></li> -</ul></li> - - - </ul> - </nav> - <article> - <div id="contents" class="isShowingTOC" role="main"> - <a title="FMDatabasePool Class Reference" name="top"></a> - <div class="main-navigation navigation-top"> - <ul> - <li><a href="../index.html">Index</a></li> - <li><a href="../hierarchy.html">Hierarchy</a></li> -</ul> - </div> - <div id="header"> - <div class="section-header"> - <h1 class="title title-header">FMDatabasePool Class Reference</h1> - </div> - </div> - <div id="container"> +</select> + </label> + </li> + </ul> + </nav> + </div> + </aside> + + <article> + <div id="overview_contents" class="container"> + <div id="content"> + <main role="main"> + <h1 class="title">FMDatabasePool Class Reference</h1> + <div class="section section-specification"><table cellspacing="0"><tbody> <tr> - <td class="specification-title">Inherits from</td> - <td class="specification-value">NSObject</td> + <th>Inherits from</th> + <td>NSObject</td> </tr><tr> - <td class="specification-title">Declared in</td> - <td class="specification-value">FMDatabasePool.h<br />FMDatabasePool.m</td> + <th>Declared in</th> + <td>FMDatabasePool.h<br />FMDatabasePool.m</td> </tr> </tbody></table></div> - - + + <div class="section section-overview"> <a title="Overview" name="overview"></a> @@ -207,989 +154,931 @@ in the main.m file.</p></div> </div> - + <div class="section section-tasks"> <a title="Tasks" name="tasks"></a> - <h2 class="subtitle subtitle-tasks">Tasks</h2> - - - - <h3 class="subsubtitle task-title">Other Methods</h3> - - <ul class="task-list"> - <li> - <span class="tooltip"> - <code><a href="#//api/name/databasePoolWithPath:">+ databasePoolWithPath:</a></code> - <span class="tooltip"><p>Create pool using path.</p></span> - </span> - - -</li><li> - <span class="tooltip"> - <code><a href="#//api/name/databasePoolWithPath:flags:">+ databasePoolWithPath:flags:</a></code> - <span class="tooltip"><p>Create pool using path and specified flags</p></span> - </span> - - -</li><li> - <span class="tooltip"> - <code><a href="#//api/name/initWithPath:flags:">– initWithPath:flags:</a></code> - <span class="tooltip"><p>Create pool using path and specified flags.</p></span> - </span> - - -</li><li> - <span class="tooltip"> - <code><a href="#//api/name/initWithPath:">– initWithPath:</a></code> - <span class="tooltip"><p>Create pool using path.</p></span> - </span> - - -</li><li> - <span class="tooltip"> - <code><a href="#//api/name/countOfCheckedInDatabases">– countOfCheckedInDatabases</a></code> - <span class="tooltip"><p>Number of checked-in databases in pool</p></span> - </span> - - -</li><li> - <span class="tooltip"> - <code><a href="#//api/name/countOfCheckedOutDatabases">– countOfCheckedOutDatabases</a></code> - <span class="tooltip"><p>Number of checked-out databases in pool</p></span> - </span> - - -</li><li> - <span class="tooltip"> - <code><a href="#//api/name/countOfOpenDatabases">– countOfOpenDatabases</a></code> - <span class="tooltip"><p>Total number of databases in pool</p></span> - </span> - - -</li><li> - <span class="tooltip"> - <code><a href="#//api/name/releaseAllDatabases">– releaseAllDatabases</a></code> - <span class="tooltip"><p>Release all databases in pool</p></span> - </span> - - -</li><li> - <span class="tooltip"> - <code><a href="#//api/name/inDatabase:">– inDatabase:</a></code> - <span class="tooltip"><p>Synchronously perform database operations in pool.</p></span> - </span> - - -</li><li> - <span class="tooltip"> - <code><a href="#//api/name/inDeferredTransaction:">– inDeferredTransaction:</a></code> - <span class="tooltip"><p>Synchronously perform database operations in pool using deferred transaction.</p></span> - </span> - - -</li><li> - <span class="tooltip"> - <code><a href="#//api/name/inTransaction:">– inTransaction:</a></code> - <span class="tooltip"><p>Synchronously perform database operations in pool using transaction.</p></span> - </span> - - -</li><li> - <span class="tooltip"> - <code><a href="#//api/name/inSavePoint:">– inSavePoint:</a></code> - <span class="tooltip"><p>Synchronously perform database operations in pool using save point.</p></span> - </span> - - -</li> - </ul> - - - - <h3 class="subsubtitle task-title">Other Methods</h3> - - <ul class="task-list"> - <li> - <span class="tooltip"> - <code><a href="#//api/name/path"> path</a></code> - <span class="tooltip"><p>Database path</p></span> - </span> - <span class="task-item-suffix">property</span> - -</li><li> - <span class="tooltip"> - <code><a href="#//api/name/delegate"> delegate</a></code> - <span class="tooltip"><p>Delegate object</p></span> - </span> - <span class="task-item-suffix">property</span> - -</li><li> - <span class="tooltip"> - <code><a href="#//api/name/maximumNumberOfDatabasesToCreate"> maximumNumberOfDatabasesToCreate</a></code> - <span class="tooltip"><p>Maximum number of databases to create</p></span> - </span> - <span class="task-item-suffix">property</span> - -</li><li> - <span class="tooltip"> - <code><a href="#//api/name/openFlags"> openFlags</a></code> - <span class="tooltip"><p>Open flags</p></span> - </span> - <span class="task-item-suffix">property</span> - -</li> - </ul> - </div> - - - - - - <div class="section section-methods"> - <a title="Properties" name="properties"></a> - <h2 class="subtitle subtitle-methods">Properties</h2> + - <div class="section-method"> - <a name="//api/name/delegate" title="delegate"></a> - <h3 class="subsubtitle method-title">delegate</h3> - - - - <div class="method-subsection brief-description"> - <p>Delegate object</p> - </div> - - + <h2 class="task-title">Other Methods</h2> - <div class="method-subsection method-declaration"><code>@property (atomic, assign) id delegate</code></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> +</h3> - - - - - - - - - - - - - - - <div class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMDatabasePool.h</code><br /> - </div> - - -</div> - - <div class="section-method"> - <a name="//api/name/maximumNumberOfDatabasesToCreate" title="maximumNumberOfDatabasesToCreate"></a> - <h3 class="subsubtitle method-title">maximumNumberOfDatabasesToCreate</h3> - - - - <div class="method-subsection brief-description"> - <p>Maximum number of databases to create</p> - </div> - - + <div class="method-info"> + <div class="pointy-thing"></div> - <div class="method-subsection method-declaration"><code>@property (atomic, assign) NSUInteger maximumNumberOfDatabasesToCreate</code></div> + <div class="method-info-container"> + + + <div class="method-subsection brief-description"> + <p>Create pool using path.</p> + </div> + + - - - - - - - - - - - - - - - <div class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMDatabasePool.h</code><br /> - </div> - - -</div> - - <div class="section-method"> - <a name="//api/name/openFlags" title="openFlags"></a> - <h3 class="subsubtitle method-title">openFlags</h3> - - - - <div class="method-subsection brief-description"> - <p>Open flags</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, 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 declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMDatabasePool.h</code><br /> - </div> - - -</div> - - <div class="section-method"> - <a name="//api/name/path" title="path"></a> - <h3 class="subsubtitle method-title">path</h3> - - - - <div class="method-subsection brief-description"> - <p>Database path</p> - </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 method-declaration"><code>@property (atomic, retain) NSString *path</code></div> + - - - - - - - - - - - - - - - <div class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMDatabasePool.h</code><br /> - </div> - - -</div> - - </div> - - - - <div class="section section-methods"> - <a title="Class Methods" name="class_methods"></a> - <h2 class="subtitle subtitle-methods">Class Methods</h2> - - <div class="section-method"> - <a name="//api/name/databasePoolWithPath:" title="databasePoolWithPath:"></a> - <h3 class="subsubtitle method-title">databasePoolWithPath:</h3> - - - - <div class="method-subsection brief-description"> - <p>Create pool using path.</p> - </div> - - + + <div class="method-subsection discussion-section"> + <h4 class="method-subtitle">Discussion</h4> + <p>Create pool using path.</p> + </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> - - <dl class="argument-def parameter-def"> - <dt><em>aPath</em></dt> - <dd><p>The file path of the database.</p></dd> - </dl> - - </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 class="method-subsection declared-in-section"> + <h4 class="method-subtitle">Declared In</h4> + <p><code class="declared-in-ref">FMDatabasePool.h</code></p> + </div> + + + </div> </div> - - - - - - - - - - - - <div class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMDatabasePool.h</code><br /> - </div> - - -</div> - - <div class="section-method"> +</div><div class="section-method"> <a name="//api/name/databasePoolWithPath:flags:" title="databasePoolWithPath:flags:"></a> - <h3 class="subsubtitle method-title">databasePoolWithPath:flags:</h3> - - - - <div class="method-subsection brief-description"> - <p>Create pool using path and specified flags</p> - </div> - - + <h3 class="method-title"><code><a href="#//api/name/databasePoolWithPath:flags:">+ databasePoolWithPath:flags:</a></code> +</h3> - <div class="method-subsection method-declaration"><code>+ (instancetype)databasePoolWithPath:(NSString *)<em>aPath</em> flags:(int)<em>openFlags</em></code></div> + <div class="method-info"> + <div class="pointy-thing"></div> - - - <div class="method-subsection arguments-section parameters"> - <h4 class="method-subtitle parameter-title">Parameters</h4> - - <dl class="argument-def parameter-def"> - <dt><em>aPath</em></dt> - <dd><p>The file path of the database.</p></dd> - </dl> - - <dl class="argument-def parameter-def"> - <dt><em>openFlags</em></dt> - <dd><p>Flags passed to the openWithFlags method of the database</p></dd> - </dl> - + <div class="method-info-container"> + + + <div class="method-subsection brief-description"> + <p>Create pool using path and specified flags</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 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> + </div> + + + + + + + + <div class="method-subsection declared-in-section"> + <h4 class="method-subtitle">Declared In</h4> + <p><code class="declared-in-ref">FMDatabasePool.h</code></p> + </div> + + + </div> </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="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> +</h3> + + <div class="method-info"> + <div class="pointy-thing"></div> + + <div class="method-info-container"> + + + <div class="method-subsection brief-description"> + <p>Create pool using path and specified flags.</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 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> + </div> + + + + + + + + <div class="method-subsection declared-in-section"> + <h4 class="method-subtitle">Declared In</h4> + <p><code class="declared-in-ref">FMDatabasePool.h</code></p> + </div> + + + </div> </div> - - - - - - - - - - - - <div class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMDatabasePool.h</code><br /> - </div> - - -</div> - - </div> - - - - <div class="section section-methods"> - <a title="Instance Methods" name="instance_methods"></a> - <h2 class="subtitle subtitle-methods">Instance Methods</h2> - - <div class="section-method"> +</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> +</h3> + + <div class="method-info"> + <div class="pointy-thing"></div> + + <div class="method-info-container"> + + + <div class="method-subsection brief-description"> + <p>Create pool using path.</p> + </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 <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> + </div> + + + + + + + + <div class="method-subsection declared-in-section"> + <h4 class="method-subtitle">Declared In</h4> + <p><code class="declared-in-ref">FMDatabasePool.h</code></p> + </div> + + + </div> + </div> +</div><div class="section-method"> <a name="//api/name/countOfCheckedInDatabases" title="countOfCheckedInDatabases"></a> - <h3 class="subsubtitle method-title">countOfCheckedInDatabases</h3> - - - - <div class="method-subsection brief-description"> - <p>Number of checked-in databases in pool</p> - </div> - - + <h3 class="method-title"><code><a href="#//api/name/countOfCheckedInDatabases">– countOfCheckedInDatabases</a></code> +</h3> - <div class="method-subsection method-declaration"><code>- (NSUInteger)countOfCheckedInDatabases</code></div> + <div class="method-info"> + <div class="pointy-thing"></div> - - - - - <div class="method-subsection return"> - <h4 class="method-subtitle parameter-title">Return Value</h4> - <p>Number of databases</p> + <div class="method-info-container"> + + + <div class="method-subsection brief-description"> + <p>Number of checked-in databases in pool</p> + </div> + + + + <div class="method-subsection method-declaration"><code>- (NSUInteger)countOfCheckedInDatabases</code></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>Number of checked-in databases in pool</p> + </div> + + + + + + + + <div class="method-subsection declared-in-section"> + <h4 class="method-subtitle">Declared In</h4> + <p><code class="declared-in-ref">FMDatabasePool.h</code></p> + </div> + + + </div> </div> - - - - - - - - - - - - <div class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMDatabasePool.h</code><br /> - </div> - - -</div> - - <div class="section-method"> +</div><div class="section-method"> <a name="//api/name/countOfCheckedOutDatabases" title="countOfCheckedOutDatabases"></a> - <h3 class="subsubtitle method-title">countOfCheckedOutDatabases</h3> - - - - <div class="method-subsection brief-description"> - <p>Number of checked-out databases in pool</p> - </div> - - + <h3 class="method-title"><code><a href="#//api/name/countOfCheckedOutDatabases">– countOfCheckedOutDatabases</a></code> +</h3> - <div class="method-subsection method-declaration"><code>- (NSUInteger)countOfCheckedOutDatabases</code></div> + <div class="method-info"> + <div class="pointy-thing"></div> - - - - - <div class="method-subsection return"> - <h4 class="method-subtitle parameter-title">Return Value</h4> - <p>Number of databases</p> + <div class="method-info-container"> + + + <div class="method-subsection brief-description"> + <p>Number of checked-out databases in pool</p> + </div> + + + + <div class="method-subsection method-declaration"><code>- (NSUInteger)countOfCheckedOutDatabases</code></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>Number of checked-out databases in pool</p> + </div> + + + + + + + + <div class="method-subsection declared-in-section"> + <h4 class="method-subtitle">Declared In</h4> + <p><code class="declared-in-ref">FMDatabasePool.h</code></p> + </div> + + + </div> </div> - - - - - - - - - - - - <div class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMDatabasePool.h</code><br /> - </div> - - -</div> - - <div class="section-method"> +</div><div class="section-method"> <a name="//api/name/countOfOpenDatabases" title="countOfOpenDatabases"></a> - <h3 class="subsubtitle method-title">countOfOpenDatabases</h3> - - - - <div class="method-subsection brief-description"> - <p>Total number of databases in pool</p> - </div> - - + <h3 class="method-title"><code><a href="#//api/name/countOfOpenDatabases">– countOfOpenDatabases</a></code> +</h3> - <div class="method-subsection method-declaration"><code>- (NSUInteger)countOfOpenDatabases</code></div> + <div class="method-info"> + <div class="pointy-thing"></div> - - - - - <div class="method-subsection return"> - <h4 class="method-subtitle parameter-title">Return Value</h4> - <p>Number of databases</p> + <div class="method-info-container"> + + + <div class="method-subsection brief-description"> + <p>Total number of databases in pool</p> + </div> + + + + <div class="method-subsection method-declaration"><code>- (NSUInteger)countOfOpenDatabases</code></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>Total number of databases in pool</p> + </div> + + + + + + + + <div class="method-subsection declared-in-section"> + <h4 class="method-subtitle">Declared In</h4> + <p><code class="declared-in-ref">FMDatabasePool.h</code></p> + </div> + + + </div> </div> - - - - - - - - - - - - <div class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMDatabasePool.h</code><br /> - </div> - - -</div> - - <div class="section-method"> +</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> +</h3> + + <div class="method-info"> + <div class="pointy-thing"></div> + + <div class="method-info-container"> + + + <div class="method-subsection brief-description"> + <p>Release all databases in pool</p> + </div> + + + + <div class="method-subsection method-declaration"><code>- (void)releaseAllDatabases</code></div> + + + + + + + + + + <div class="method-subsection discussion-section"> + <h4 class="method-subtitle">Discussion</h4> + <p>Release all databases in pool</p> + </div> + + + + + + + + <div class="method-subsection declared-in-section"> + <h4 class="method-subtitle">Declared In</h4> + <p><code class="declared-in-ref">FMDatabasePool.h</code></p> + </div> + + + </div> + </div> +</div><div class="section-method"> <a name="//api/name/inDatabase:" title="inDatabase:"></a> - <h3 class="subsubtitle method-title">inDatabase:</h3> - - - - <div class="method-subsection brief-description"> - <p>Synchronously perform database operations in pool.</p> - </div> - - + <h3 class="method-title"><code><a href="#//api/name/inDatabase:">– inDatabase:</a></code> +</h3> - <div class="method-subsection method-declaration"><code>- (void)inDatabase:(void ( ^ ) ( FMDatabase *db ))<em>block</em></code></div> + <div class="method-info"> + <div class="pointy-thing"></div> - - - <div class="method-subsection arguments-section parameters"> - <h4 class="method-subtitle parameter-title">Parameters</h4> - - <dl class="argument-def parameter-def"> - <dt><em>block</em></dt> - <dd><p>The code to be run on the <code>FMDatabasePool</code> pool.</p></dd> - </dl> - + <div class="method-info-container"> + + + <div class="method-subsection brief-description"> + <p>Synchronously perform database operations 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 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 discussion-section"> + <h4 class="method-subtitle">Discussion</h4> + <p>Synchronously perform database operations in pool.</p> + </div> + + + + + + + + <div class="method-subsection declared-in-section"> + <h4 class="method-subtitle">Declared In</h4> + <p><code class="declared-in-ref">FMDatabasePool.h</code></p> + </div> + + + </div> </div> - - - - - - - - - - - - - - <div class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMDatabasePool.h</code><br /> - </div> - - -</div> - - <div class="section-method"> +</div><div class="section-method"> <a name="//api/name/inDeferredTransaction:" title="inDeferredTransaction:"></a> - <h3 class="subsubtitle method-title">inDeferredTransaction:</h3> - - - - <div class="method-subsection brief-description"> - <p>Synchronously perform database operations in pool using deferred transaction.</p> - </div> - - + <h3 class="method-title"><code><a href="#//api/name/inDeferredTransaction:">– inDeferredTransaction:</a></code> +</h3> - <div class="method-subsection method-declaration"><code>- (void)inDeferredTransaction:(void ( ^ ) ( FMDatabase *db , BOOL *rollback ))<em>block</em></code></div> + <div class="method-info"> + <div class="pointy-thing"></div> - - - <div class="method-subsection arguments-section parameters"> - <h4 class="method-subtitle parameter-title">Parameters</h4> - - <dl class="argument-def parameter-def"> - <dt><em>block</em></dt> - <dd><p>The code to be run on the <code>FMDatabasePool</code> pool.</p></dd> - </dl> - - </div> - - - - - - - - - - - - - - <div class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMDatabasePool.h</code><br /> - </div> - - -</div> - - <div class="section-method"> - <a name="//api/name/inSavePoint:" title="inSavePoint:"></a> - <h3 class="subsubtitle method-title">inSavePoint:</h3> - - - - <div class="method-subsection brief-description"> - <p>Synchronously perform database operations in pool using save point.</p> - </div> - - + <div class="method-info-container"> + + + <div class="method-subsection brief-description"> + <p>Synchronously perform database operations in pool using deferred transaction.</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> - - - <div class="method-subsection arguments-section parameters"> - <h4 class="method-subtitle parameter-title">Parameters</h4> - - <dl class="argument-def parameter-def"> - <dt><em>block</em></dt> - <dd><p>The code to be run on the <code>FMDatabasePool</code> pool.</p></dd> - </dl> - - </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> - <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 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 discussion-section"> + <h4 class="method-subtitle">Discussion</h4> + <p>Synchronously perform database operations in pool using deferred transaction.</p> + </div> + + + + + + + + <div class="method-subsection declared-in-section"> + <h4 class="method-subtitle">Declared In</h4> + <p><code class="declared-in-ref">FMDatabasePool.h</code></p> + </div> + + + </div> </div> - - - - - - - - <div class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMDatabasePool.h</code><br /> - </div> - - -</div> - - <div class="section-method"> +</div><div class="section-method"> <a name="//api/name/inTransaction:" title="inTransaction:"></a> - <h3 class="subsubtitle method-title">inTransaction:</h3> - - - - <div class="method-subsection brief-description"> - <p>Synchronously perform database operations in pool using transaction.</p> - </div> - - + <h3 class="method-title"><code><a href="#//api/name/inTransaction:">– inTransaction:</a></code> +</h3> - <div class="method-subsection method-declaration"><code>- (void)inTransaction:(void ( ^ ) ( FMDatabase *db , BOOL *rollback ))<em>block</em></code></div> + <div class="method-info"> + <div class="pointy-thing"></div> - - - <div class="method-subsection arguments-section parameters"> - <h4 class="method-subtitle parameter-title">Parameters</h4> - - <dl class="argument-def parameter-def"> - <dt><em>block</em></dt> - <dd><p>The code to be run on the <code>FMDatabasePool</code> pool.</p></dd> - </dl> - - </div> - - - - - - - - - - - - - - <div class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMDatabasePool.h</code><br /> - </div> - - -</div> - - <div class="section-method"> - <a name="//api/name/initWithPath:" title="initWithPath:"></a> - <h3 class="subsubtitle method-title">initWithPath:</h3> - - - - <div class="method-subsection brief-description"> - <p>Create pool using path.</p> - </div> - - + <div class="method-info-container"> + + + <div class="method-subsection brief-description"> + <p>Synchronously perform database operations in pool using transaction.</p> + </div> + + - <div class="method-subsection method-declaration"><code>- (instancetype)initWithPath:(NSString *)<em>aPath</em></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> - - <dl class="argument-def parameter-def"> - <dt><em>aPath</em></dt> - <dd><p>The file path of the database.</p></dd> - </dl> - + + + <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 discussion-section"> + <h4 class="method-subtitle">Discussion</h4> + <p>Synchronously perform database operations in pool using transaction.</p> + </div> + + + + + + + + <div class="method-subsection declared-in-section"> + <h4 class="method-subtitle">Declared In</h4> + <p><code class="declared-in-ref">FMDatabasePool.h</code></p> + </div> + + + </div> </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="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"> + <div class="pointy-thing"></div> + + <div class="method-info-container"> + + + <div class="method-subsection brief-description"> + <p>Synchronously perform database operations in pool using save point.</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 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> + </div> + + + + + + + + <div class="method-subsection declared-in-section"> + <h4 class="method-subtitle">Declared In</h4> + <p><code class="declared-in-ref">FMDatabasePool.h</code></p> + </div> + + + </div> </div> - - - - - - - - - - - - <div class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMDatabasePool.h</code><br /> - </div> - - </div> + </div> - <div class="section-method"> - <a name="//api/name/initWithPath:flags:" title="initWithPath:flags:"></a> - <h3 class="subsubtitle method-title">initWithPath:flags:</h3> - - - - <div class="method-subsection brief-description"> - <p>Create pool using path and specified flags.</p> - </div> - - - <div class="method-subsection method-declaration"><code>- (instancetype)initWithPath:(NSString *)<em>aPath</em> flags:(int)<em>openFlags</em></code></div> + + <h2 class="task-title">Other Methods</h2> - - - <div class="method-subsection arguments-section parameters"> - <h4 class="method-subtitle parameter-title">Parameters</h4> - - <dl class="argument-def parameter-def"> - <dt><em>aPath</em></dt> - <dd><p>The file path of the database.</p></dd> - </dl> - - <dl class="argument-def parameter-def"> - <dt><em>openFlags</em></dt> - <dd><p>Flags passed to the openWithFlags method of the database</p></dd> - </dl> - + <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>Database path</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>Database path</p> + </div> + + + + + + + + <div class="method-subsection declared-in-section"> + <h4 class="method-subtitle">Declared In</h4> + <p><code class="declared-in-ref">FMDatabasePool.h</code></p> + </div> + + + </div> </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="section-method"> + <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"> + <div class="pointy-thing"></div> + + <div class="method-info-container"> + + + <div class="method-subsection brief-description"> + <p>Delegate object</p> + </div> + + + + <div class="method-subsection method-declaration"><code>@property (atomic, assign) id delegate</code></div> + + + + + + + + + + <div class="method-subsection discussion-section"> + <h4 class="method-subtitle">Discussion</h4> + <p>Delegate object</p> + </div> + + + + + + + + <div class="method-subsection declared-in-section"> + <h4 class="method-subtitle">Declared In</h4> + <p><code class="declared-in-ref">FMDatabasePool.h</code></p> + </div> + + + </div> </div> - - - - - - - - - - - - <div class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMDatabasePool.h</code><br /> - </div> - - -</div> - - <div class="section-method"> - <a name="//api/name/releaseAllDatabases" title="releaseAllDatabases"></a> - <h3 class="subsubtitle method-title">releaseAllDatabases</h3> - - - - <div class="method-subsection brief-description"> - <p>Release all databases in pool</p> - </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> +</h3> - <div class="method-subsection method-declaration"><code>- (void)releaseAllDatabases</code></div> + <div class="method-info"> + <div class="pointy-thing"></div> - - - - - - - - - - - - - - - <div class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMDatabasePool.h</code><br /> - </div> - - + <div class="method-info-container"> + + + <div class="method-subsection brief-description"> + <p>Maximum number of databases to create</p> + </div> + + + + <div class="method-subsection method-declaration"><code>@property (atomic, assign) NSUInteger maximumNumberOfDatabasesToCreate</code></div> + + + + + + + + + + <div class="method-subsection discussion-section"> + <h4 class="method-subtitle">Discussion</h4> + <p>Maximum number of databases to create</p> + </div> + + + + + + + + <div class="method-subsection declared-in-section"> + <h4 class="method-subtitle">Declared In</h4> + <p><code class="declared-in-ref">FMDatabasePool.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">FMDatabasePool.h</code></p> + </div> + + + </div> + </div> </div> + </div> </div> - </div> - <div class="main-navigation navigation-bottom"> - <ul> - <li><a href="../index.html">Index</a></li> - <li><a href="../hierarchy.html">Hierarchy</a></li> -</ul> - </div> - <div id="footer"> - <hr /> + + + </main> + + <footer> <div class="footer-copyright"> - <p><span class="copyright">© 2014 ccgus. All rights reserved. (Last updated: 2014-05-25)</span><br /> - <span class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.1 (build 858)</a>.</span></p> + <p class="copyright">Copyright © 2015 ccgus. All rights reserved. Updated: 2015-01-25</p> + + + <p class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.2.1 (build 1333)</a>.</p> </div> - </div> - </div> - </article> - <script type="text/javascript"> - function jumpToChange() - { - window.location.hash = this.options[this.selectedIndex].value; - } - - function toggleTOC() - { - var contents = document.getElementById('contents'); - var tocContainer = document.getElementById('tocContainer'); - - if (this.getAttribute('class') == 'open') - { - this.setAttribute('class', ''); - contents.setAttribute('class', ''); - tocContainer.setAttribute('class', ''); - - window.name = "hideTOC"; - } - else - { - this.setAttribute('class', 'open'); - contents.setAttribute('class', 'isShowingTOC'); - tocContainer.setAttribute('class', 'isShowingTOC'); - - window.name = ""; - } - return false; - } - - function toggleTOCEntryChildren(e) - { - e.stopPropagation(); - var currentClass = this.getAttribute('class'); - if (currentClass == 'children') { - this.setAttribute('class', 'children open'); - } - else if (currentClass == 'children open') { - this.setAttribute('class', 'children'); - } - return false; - } - - function tocEntryClick(e) - { - e.stopPropagation(); - return true; - } - - function init() - { - var selectElement = document.getElementById('jumpTo'); - selectElement.addEventListener('change', jumpToChange, false); - - var tocButton = document.getElementById('table_of_contents'); - tocButton.addEventListener('click', toggleTOC, false); - - var taskTreeItem = document.getElementById('task_treeitem'); - if (taskTreeItem.getElementsByTagName('li').length > 0) - { - taskTreeItem.setAttribute('class', 'children'); - taskTreeItem.firstChild.setAttribute('class', 'disclosure'); - } - - var tocList = document.getElementById('toc'); - - var tocEntries = tocList.getElementsByTagName('li'); - for (var i = 0; i < tocEntries.length; i++) { - tocEntries[i].addEventListener('click', toggleTOCEntryChildren, false); - } - - var tocLinks = tocList.getElementsByTagName('a'); - for (var i = 0; i < tocLinks.length; i++) { - tocLinks[i].addEventListener('click', tocEntryClick, false); - } - - if (window.name == "hideTOC") { - toggleTOC.call(tocButton); - } - } - - window.onload = init; - - // If showing in Xcode, hide the TOC and Header - if (navigator.userAgent.match(/xcode/i)) { - document.getElementById("contents").className = "hideInXcode" - document.getElementById("tocContainer").className = "hideInXcode" - document.getElementById("top_header").className = "hideInXcode" - } - - </script> - </body> + </footer> + </div> + </div> + </article> + + <script src="../js/script.js"></script> +</body> </html>
\ No newline at end of file diff --git a/html/Classes/FMDatabaseQueue.html b/html/Classes/FMDatabaseQueue.html index 5f322e1..f6953c7 100644 --- a/html/Classes/FMDatabaseQueue.html +++ b/html/Classes/FMDatabaseQueue.html @@ -1,172 +1,127 @@ -<!DOCTYPE HTML> +<!DOCTYPE html> <html> - <head> - <meta http-equiv="Content-Type" content="html/html; charset=utf-8" /> - <title>FMDatabaseQueue Class Reference</title> - <meta id="xcode-display" name="xcode-display" content="render"/> - <meta name="viewport" content="width=550" /> - <link rel="stylesheet" type="text/css" href="../css/styles.css" media="all" /> - <link rel="stylesheet" type="text/css" media="print" href="../css/stylesPrint.css" /> - <meta name="generator" content="appledoc 2.1 (build 858)" /> - </head> - <body> - <header id="top_header"> - <div id="library" class="hideInXcode"> - <h1><a id="libraryTitle" href="../index.html">FMDB </a></h1> - <a id="developerHome" href="../index.html">ccgus</a> - </div> +<head> + <meta charset="utf-8"> + + <title>FMDatabaseQueue Class Reference</title> + + <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)"> +</head> +<body class="appledoc"> + <header> + <div class="container" class="hide-in-xcode"> - <div id="title" role="banner"> - <h1 class="hideInXcode">FMDatabaseQueue Class Reference</h1> - </div> - <ul id="headerButtons" role="toolbar"> - <li id="toc_button"> - <button aria-label="Show Table of Contents" role="checkbox" class="open" id="table_of_contents"><span class="disclosure"></span>Table of Contents</button> - </li> - <li id="jumpto_button" role="navigation"> - <select id="jumpTo"> + <h1 id="library-title"> + <a href="../index.html">FMDB </a> + </h1> + + <p id="developer-home"> + <a href="../index.html">ccgus</a> + </p> + + </div> + </header> + + <aside> + <div class="container"> + <nav> + <ul id="header-buttons" role="toolbar"> + <li><a href="../index.html">Index</a></li> +<li><a href="../hierarchy.html">Hierarchy</a></li> + + <li id="on-this-page" role="navigation"> + <label> + On This Page + + <div class="chevron"> + <div class="chevy chevron-left"></div> + <div class="chevy chevron-right"></div> + </div> + + <select id="jump-to"> <option value="top">Jump To…</option> <option value="overview">Overview</option> - + <option value="tasks">Tasks</option> - - - - <option value="properties">Properties</option> - - <option value="//api/name/openFlags"> openFlags</option> - - <option value="//api/name/path"> path</option> - - - - - <option value="class_methods">Class Methods</option> - - <option value="//api/name/databaseClass"> + databaseClass</option> - - <option value="//api/name/databaseQueueWithPath:"> + databaseQueueWithPath:</option> - - <option value="//api/name/databaseQueueWithPath:flags:"> + databaseQueueWithPath:flags:</option> - - - - - <option value="instance_methods">Instance Methods</option> - - <option value="//api/name/close"> - close</option> - - <option value="//api/name/inDatabase:"> - inDatabase:</option> - - <option value="//api/name/inDeferredTransaction:"> - inDeferredTransaction:</option> - - <option value="//api/name/inSavePoint:"> - inSavePoint:</option> - - <option value="//api/name/inTransaction:"> - inTransaction:</option> - - <option value="//api/name/initWithPath:"> - initWithPath:</option> - - <option value="//api/name/initWithPath:flags:"> - initWithPath:flags:</option> - - - -</select> - </li> - </ul> - </header> - <nav id="tocContainer" class="isShowingTOC"> - <ul id="toc" role="tree"> - -<li role="treeitem"><span class="nodisclosure"></span><span class="sectionName"><a href="#overview">Overview</a></span></li> - - - -<li role="treeitem" id="task_treeitem"><span class="nodisclosure"></span><span class="sectionName"><a href="#tasks">Tasks</a></span><ul> -</ul></li> - - - - - -<li role="treeitem" class="children"><span class="disclosure"></span><span class="sectionName"><a href="#properties">Properties</a></span><ul> - - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/openFlags">openFlags</a></span></li> - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/path">path</a></span></li> + <optgroup label="Properties"> + + <option value="//api/name/openFlags">openFlags</option> + + <option value="//api/name/path">path</option> + + </optgroup> -</ul></li> - - -<li role="treeitem" class="children"><span class="disclosure"></span><span class="sectionName"><a href="#class_methods">Class Methods</a></span><ul> - - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/databaseClass">databaseClass</a></span></li> - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/databaseQueueWithPath:">databaseQueueWithPath:</a></span></li> - - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/databaseQueueWithPath:flags:">databaseQueueWithPath:flags:</a></span></li> + <optgroup label="Class Methods"> + + <option value="//api/name/databaseClass">+ databaseClass</option> + + <option value="//api/name/databaseQueueWithPath:">+ databaseQueueWithPath:</option> + + <option value="//api/name/databaseQueueWithPath:flags:">+ databaseQueueWithPath:flags:</option> + + </optgroup> -</ul></li> - - -<li role="treeitem" class="children"><span class="disclosure"></span><span class="sectionName"><a href="#instance_methods">Instance Methods</a></span><ul> - - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/close">close</a></span></li> - - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/inDatabase:">inDatabase:</a></span></li> - - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/inDeferredTransaction:">inDeferredTransaction:</a></span></li> - - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/inSavePoint:">inSavePoint:</a></span></li> - - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/inTransaction:">inTransaction:</a></span></li> - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/initWithPath:">initWithPath:</a></span></li> + <optgroup label="Instance Methods"> + + <option value="//api/name/close">- close</option> + + <option value="//api/name/inDatabase:">- inDatabase:</option> + + <option value="//api/name/inDeferredTransaction:">- inDeferredTransaction:</option> + + <option value="//api/name/inSavePoint:">- inSavePoint:</option> + + <option value="//api/name/inTransaction:">- inTransaction:</option> + + <option value="//api/name/initWithPath:">- initWithPath:</option> + + <option value="//api/name/initWithPath:flags:">- initWithPath:flags:</option> + + </optgroup> - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/initWithPath:flags:">initWithPath:flags:</a></span></li> -</ul></li> - - - </ul> - </nav> - <article> - <div id="contents" class="isShowingTOC" role="main"> - <a title="FMDatabaseQueue Class Reference" name="top"></a> - <div class="main-navigation navigation-top"> - <ul> - <li><a href="../index.html">Index</a></li> - <li><a href="../hierarchy.html">Hierarchy</a></li> -</ul> - </div> - <div id="header"> - <div class="section-header"> - <h1 class="title title-header">FMDatabaseQueue Class Reference</h1> - </div> - </div> - <div id="container"> +</select> + </label> + </li> + </ul> + </nav> + </div> + </aside> + + <article> + <div id="overview_contents" class="container"> + <div id="content"> + <main role="main"> + <h1 class="title">FMDatabaseQueue Class Reference</h1> + <div class="section section-specification"><table cellspacing="0"><tbody> <tr> - <td class="specification-title">Inherits from</td> - <td class="specification-value">NSObject</td> + <th>Inherits from</th> + <td>NSObject</td> </tr><tr> - <td class="specification-title">Declared in</td> - <td class="specification-value">FMDatabaseQueue.h<br />FMDatabaseQueue.m</td> + <th>Declared in</th> + <td>FMDatabaseQueue.h<br />FMDatabaseQueue.m</td> </tr> </tbody></table></div> - - + + <div class="section section-overview"> <a title="Overview" name="overview"></a> @@ -223,802 +178,734 @@ </div> - + <div class="section section-tasks"> <a title="Tasks" name="tasks"></a> - <h2 class="subtitle subtitle-tasks">Tasks</h2> - - - - <h3 class="subsubtitle task-title">Other Methods</h3> - - <ul class="task-list"> - <li> - <span class="tooltip"> - <code><a href="#//api/name/databaseQueueWithPath:">+ databaseQueueWithPath:</a></code> - <span class="tooltip"><p>Create queue using path.</p></span> - </span> - - -</li><li> - <span class="tooltip"> - <code><a href="#//api/name/databaseQueueWithPath:flags:">+ databaseQueueWithPath:flags:</a></code> - <span class="tooltip"><p>Create queue using path and specified flags.</p></span> - </span> - - -</li><li> - <span class="tooltip"> - <code><a href="#//api/name/databaseClass">+ databaseClass</a></code> - <span class="tooltip"><p>Returns the Class of ‘FMDatabase’ subclass, that will be used to instantiate database object.</p></span> - </span> - - -</li><li> - <span class="tooltip"> - <code><a href="#//api/name/initWithPath:flags:">– initWithPath:flags:</a></code> - <span class="tooltip"><p>Create queue using path and specified flags.</p></span> - </span> - - -</li><li> - <span class="tooltip"> - <code><a href="#//api/name/initWithPath:">– initWithPath:</a></code> - <span class="tooltip"><p>Create queue using path.</p></span> - </span> - - -</li><li> - <span class="tooltip"> - <code><a href="#//api/name/close">– close</a></code> - <span class="tooltip"><p>Close database used by queue.</p></span> - </span> - - -</li><li> - <span class="tooltip"> - <code><a href="#//api/name/inDatabase:">– inDatabase:</a></code> - <span class="tooltip"><p>Synchronously perform database operations on queue.</p></span> - </span> - - -</li><li> - <span class="tooltip"> - <code><a href="#//api/name/inDeferredTransaction:">– inDeferredTransaction:</a></code> - <span class="tooltip"><p>Synchronously perform database operations on queue, using deferred transactions.</p></span> - </span> - - -</li><li> - <span class="tooltip"> - <code><a href="#//api/name/inTransaction:">– inTransaction:</a></code> - <span class="tooltip"><p>Synchronously perform database operations on queue, using transactions.</p></span> - </span> - - -</li><li> - <span class="tooltip"> - <code><a href="#//api/name/inSavePoint:">– inSavePoint:</a></code> - <span class="tooltip"><p>Synchronously perform database operations using save point.</p></span> - </span> - - -</li> - </ul> - + - <h3 class="subsubtitle task-title">Other Methods</h3> - - <ul class="task-list"> - <li> - <span class="tooltip"> - <code><a href="#//api/name/path"> path</a></code> - <span class="tooltip"><p>Path of database</p></span> - </span> - <span class="task-item-suffix">property</span> - -</li><li> - <span class="tooltip"> - <code><a href="#//api/name/openFlags"> openFlags</a></code> - <span class="tooltip"><p>Open flags</p></span> - </span> - <span class="task-item-suffix">property</span> - -</li> - </ul> - - </div> - - - - - - <div class="section section-methods"> - <a title="Properties" name="properties"></a> - <h2 class="subtitle subtitle-methods">Properties</h2> - - <div class="section-method"> - <a name="//api/name/openFlags" title="openFlags"></a> - <h3 class="subsubtitle method-title">openFlags</h3> - - - - <div class="method-subsection brief-description"> - <p>Open flags</p> - </div> - - + <h2 class="task-title">Other Methods</h2> - <div class="method-subsection method-declaration"><code>@property (atomic, readonly) int openFlags</code></div> + <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> - - - - - - - - - - - - - - - <div class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMDatabaseQueue.h</code><br /> - </div> - - -</div> - - <div class="section-method"> - <a name="//api/name/path" title="path"></a> - <h3 class="subsubtitle method-title">path</h3> - - - - <div class="method-subsection brief-description"> - <p>Path of database</p> - </div> - - + <div class="method-info"> + <div class="pointy-thing"></div> - <div class="method-subsection method-declaration"><code>@property (atomic, retain) NSString *path</code></div> + <div class="method-info-container"> + + + <div class="method-subsection brief-description"> + <p>Create queue using path.</p> + </div> + + - - - - - - - - - - - - - - - <div class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMDatabaseQueue.h</code><br /> - </div> - - -</div> - - </div> - - - - <div class="section section-methods"> - <a title="Class Methods" name="class_methods"></a> - <h2 class="subtitle subtitle-methods">Class Methods</h2> - - <div class="section-method"> - <a name="//api/name/databaseClass" title="databaseClass"></a> - <h3 class="subsubtitle method-title">databaseClass</h3> - - - - <div class="method-subsection brief-description"> - <p>Returns the Class of ‘FMDatabase’ subclass, that will be used to instantiate database object.</p> - </div> - - + <div class="method-subsection method-declaration"><code>+ (instancetype)databaseQueueWithPath:(NSString *)<em>aPath</em></code></div> - <div class="method-subsection method-declaration"><code>+ (Class)databaseClass</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> - </div> - - - - - - <div class="method-subsection discussion-section"> - <h4 class="method-subtitle">Discussion</h4> - <p>Subclasses can override this method to return specified Class of ‘FMDatabase’ subclass.</p> + + <div class="method-subsection return"> + <h4 class="method-subtitle parameter-title">Return Value</h4> + <p>The <code>FMDatabaseQueue</code> object. <code>nil</code> on error.</p> + </div> + + + + + + <div class="method-subsection discussion-section"> + <h4 class="method-subtitle">Discussion</h4> + <p>Create queue using path.</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 class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMDatabaseQueue.h</code><br /> - </div> - - -</div> - - <div class="section-method"> - <a name="//api/name/databaseQueueWithPath:" title="databaseQueueWithPath:"></a> - <h3 class="subsubtitle method-title">databaseQueueWithPath:</h3> - - - - <div class="method-subsection brief-description"> - <p>Create queue using path.</p> - </div> - - +</div><div class="section-method"> + <a name="//api/name/databaseQueueWithPath:flags:" title="databaseQueueWithPath:flags:"></a> + <h3 class="method-title"><code><a href="#//api/name/databaseQueueWithPath:flags:">+ databaseQueueWithPath:flags:</a></code> +</h3> - <div class="method-subsection method-declaration"><code>+ (instancetype)databaseQueueWithPath:(NSString *)<em>aPath</em></code></div> + <div class="method-info"> + <div class="pointy-thing"></div> - - - <div class="method-subsection arguments-section parameters"> - <h4 class="method-subtitle parameter-title">Parameters</h4> - - <dl class="argument-def parameter-def"> - <dt><em>aPath</em></dt> - <dd><p>The file path of the database.</p></dd> - </dl> - + <div class="method-info-container"> + + + <div class="method-subsection brief-description"> + <p>Create queue using path and specified flags.</p> + </div> + + + + <div class="method-subsection method-declaration"><code>+ (instancetype)databaseQueueWithPath:(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>FMDatabaseQueue</code> object. <code>nil</code> on error.</p> + </div> + + + + + + <div class="method-subsection discussion-section"> + <h4 class="method-subtitle">Discussion</h4> + <p>Create queue using path and specified 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 class="method-subsection return"> - <h4 class="method-subtitle parameter-title">Return Value</h4> - <p>The <code>FMDatabaseQueue</code> object. <code>nil</code> on error.</p> +</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> +</h3> + + <div class="method-info"> + <div class="pointy-thing"></div> + + <div class="method-info-container"> + + + <div class="method-subsection brief-description"> + <p>Returns the Class of ‘FMDatabase’ subclass, that will be used to instantiate database object.</p> + </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>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> + + + + + + + + <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 class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMDatabaseQueue.h</code><br /> - </div> - - -</div> - - <div class="section-method"> - <a name="//api/name/databaseQueueWithPath:flags:" title="databaseQueueWithPath:flags:"></a> - <h3 class="subsubtitle method-title">databaseQueueWithPath:flags:</h3> - - - - <div class="method-subsection brief-description"> - <p>Create queue using path and specified flags.</p> - </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> +</h3> - <div class="method-subsection method-declaration"><code>+ (instancetype)databaseQueueWithPath:(NSString *)<em>aPath</em> flags:(int)<em>openFlags</em></code></div> + <div class="method-info"> + <div class="pointy-thing"></div> - - - <div class="method-subsection arguments-section parameters"> - <h4 class="method-subtitle parameter-title">Parameters</h4> - - <dl class="argument-def parameter-def"> - <dt><em>aPath</em></dt> - <dd><p>The file path of the database.</p></dd> - </dl> - - <dl class="argument-def parameter-def"> - <dt><em>openFlags</em></dt> - <dd><p>Flags passed to the openWithFlags method of the database</p></dd> - </dl> - + <div class="method-info-container"> + + + <div class="method-subsection brief-description"> + <p>Create queue using path and specified flags.</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 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>FMDatabaseQueue</code> object. <code>nil</code> on error.</p> + </div> + + + + + + <div class="method-subsection discussion-section"> + <h4 class="method-subtitle">Discussion</h4> + <p>Create queue using path and specified 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 class="method-subsection return"> - <h4 class="method-subtitle parameter-title">Return Value</h4> - <p>The <code>FMDatabaseQueue</code> object. <code>nil</code> on error.</p> +</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> +</h3> + + <div class="method-info"> + <div class="pointy-thing"></div> + + <div class="method-info-container"> + + + <div class="method-subsection brief-description"> + <p>Create queue using path.</p> + </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 <code>FMDatabaseQueue</code> object. <code>nil</code> on error.</p> + </div> + + + + + + <div class="method-subsection discussion-section"> + <h4 class="method-subtitle">Discussion</h4> + <p>Create queue using path.</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 class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMDatabaseQueue.h</code><br /> - </div> - - -</div> - - </div> - - - - <div class="section section-methods"> - <a title="Instance Methods" name="instance_methods"></a> - <h2 class="subtitle subtitle-methods">Instance Methods</h2> - - <div class="section-method"> +</div><div class="section-method"> <a name="//api/name/close" title="close"></a> - <h3 class="subsubtitle method-title">close</h3> - - - - <div class="method-subsection brief-description"> - <p>Close database used by queue.</p> - </div> - - + <h3 class="method-title"><code><a href="#//api/name/close">– close</a></code> +</h3> - <div class="method-subsection method-declaration"><code>- (void)close</code></div> + <div class="method-info"> + <div class="pointy-thing"></div> - - - - - - - - - - - - - - - <div class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMDatabaseQueue.h</code><br /> - </div> - - -</div> - - <div class="section-method"> + <div class="method-info-container"> + + + <div class="method-subsection brief-description"> + <p>Close database used by queue.</p> + </div> + + + + <div class="method-subsection method-declaration"><code>- (void)close</code></div> + + + + + + + + + + <div class="method-subsection discussion-section"> + <h4 class="method-subtitle">Discussion</h4> + <p>Close database used by queue.</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/inDatabase:" title="inDatabase:"></a> - <h3 class="subsubtitle method-title">inDatabase:</h3> - - - - <div class="method-subsection brief-description"> - <p>Synchronously perform database operations on queue.</p> - </div> - - + <h3 class="method-title"><code><a href="#//api/name/inDatabase:">– inDatabase:</a></code> +</h3> - <div class="method-subsection method-declaration"><code>- (void)inDatabase:(void ( ^ ) ( FMDatabase *db ))<em>block</em></code></div> + <div class="method-info"> + <div class="pointy-thing"></div> - - - <div class="method-subsection arguments-section parameters"> - <h4 class="method-subtitle parameter-title">Parameters</h4> - - <dl class="argument-def parameter-def"> - <dt><em>block</em></dt> - <dd><p>The code to be run on the queue of <code>FMDatabaseQueue</code></p></dd> - </dl> - + <div class="method-info-container"> + + + <div class="method-subsection brief-description"> + <p>Synchronously perform database operations on queue.</p> + </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 queue of <code>FMDatabaseQueue</code></p></td> + </tr> + + </table> + </div> + + + + + + + + <div class="method-subsection discussion-section"> + <h4 class="method-subtitle">Discussion</h4> + <p>Synchronously perform database operations on queue.</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 class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMDatabaseQueue.h</code><br /> - </div> - - -</div> - - <div class="section-method"> +</div><div class="section-method"> <a name="//api/name/inDeferredTransaction:" title="inDeferredTransaction:"></a> - <h3 class="subsubtitle method-title">inDeferredTransaction:</h3> - - - - <div class="method-subsection brief-description"> - <p>Synchronously perform database operations on queue, using deferred transactions.</p> - </div> - - + <h3 class="method-title"><code><a href="#//api/name/inDeferredTransaction:">– inDeferredTransaction:</a></code> +</h3> - <div class="method-subsection method-declaration"><code>- (void)inDeferredTransaction:(void ( ^ ) ( FMDatabase *db , BOOL *rollback ))<em>block</em></code></div> + <div class="method-info"> + <div class="pointy-thing"></div> - - - <div class="method-subsection arguments-section parameters"> - <h4 class="method-subtitle parameter-title">Parameters</h4> - - <dl class="argument-def parameter-def"> - <dt><em>block</em></dt> - <dd><p>The code to be run on the queue of <code>FMDatabaseQueue</code></p></dd> - </dl> - - </div> - - - - - - - - - - - - - - <div class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMDatabaseQueue.h</code><br /> - </div> - - -</div> - - <div class="section-method"> - <a name="//api/name/inSavePoint:" title="inSavePoint:"></a> - <h3 class="subsubtitle method-title">inSavePoint:</h3> - - - - <div class="method-subsection brief-description"> - <p>Synchronously perform database operations using save point.</p> - </div> - - + <div class="method-info-container"> + + + <div class="method-subsection brief-description"> + <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> - - - <div class="method-subsection arguments-section parameters"> - <h4 class="method-subtitle parameter-title">Parameters</h4> - - <dl class="argument-def parameter-def"> - <dt><em>block</em></dt> - <dd><p>The code to be run on the queue of <code>FMDatabaseQueue</code></p></dd> - </dl> - + + + <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 discussion-section"> + <h4 class="method-subtitle">Discussion</h4> + <p>Synchronously perform database operations on queue, using deferred transactions.</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 class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMDatabaseQueue.h</code><br /> - </div> - - -</div> - - <div class="section-method"> +</div><div class="section-method"> <a name="//api/name/inTransaction:" title="inTransaction:"></a> - <h3 class="subsubtitle method-title">inTransaction:</h3> - - - - <div class="method-subsection brief-description"> - <p>Synchronously perform database operations on queue, using transactions.</p> - </div> - - + <h3 class="method-title"><code><a href="#//api/name/inTransaction:">– inTransaction:</a></code> +</h3> - <div class="method-subsection method-declaration"><code>- (void)inTransaction:(void ( ^ ) ( FMDatabase *db , BOOL *rollback ))<em>block</em></code></div> + <div class="method-info"> + <div class="pointy-thing"></div> - - - <div class="method-subsection arguments-section parameters"> - <h4 class="method-subtitle parameter-title">Parameters</h4> - - <dl class="argument-def parameter-def"> - <dt><em>block</em></dt> - <dd><p>The code to be run on the queue of <code>FMDatabaseQueue</code></p></dd> - </dl> - - </div> - - - - - - - - - - - - - - <div class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMDatabaseQueue.h</code><br /> - </div> - - -</div> - - <div class="section-method"> - <a name="//api/name/initWithPath:" title="initWithPath:"></a> - <h3 class="subsubtitle method-title">initWithPath:</h3> - - - - <div class="method-subsection brief-description"> - <p>Create queue using path.</p> - </div> - - + <div class="method-info-container"> + + + <div class="method-subsection brief-description"> + <p>Synchronously perform database operations on queue, using transactions.</p> + </div> + + - <div class="method-subsection method-declaration"><code>- (instancetype)initWithPath:(NSString *)<em>aPath</em></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> - - <dl class="argument-def parameter-def"> - <dt><em>aPath</em></dt> - <dd><p>The file path of the database.</p></dd> - </dl> - + + + <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 discussion-section"> + <h4 class="method-subtitle">Discussion</h4> + <p>Synchronously perform database operations on queue, using transactions.</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 class="method-subsection return"> - <h4 class="method-subtitle parameter-title">Return Value</h4> - <p>The <code>FMDatabaseQueue</code> object. <code>nil</code> on error.</p> +</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"> + <div class="pointy-thing"></div> + + <div class="method-info-container"> + + + <div class="method-subsection brief-description"> + <p>Synchronously perform database operations using save point.</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 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 discussion-section"> + <h4 class="method-subtitle">Discussion</h4> + <p>Synchronously perform database operations using save point.</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 class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMDatabaseQueue.h</code><br /> - </div> - - </div> + </div> - <div class="section-method"> - <a name="//api/name/initWithPath:flags:" title="initWithPath:flags:"></a> - <h3 class="subsubtitle method-title">initWithPath:flags:</h3> - - - - <div class="method-subsection brief-description"> - <p>Create queue using path and specified flags.</p> - </div> - - - <div class="method-subsection method-declaration"><code>- (instancetype)initWithPath:(NSString *)<em>aPath</em> flags:(int)<em>openFlags</em></code></div> + + <h2 class="task-title">Other Methods</h2> - - - <div class="method-subsection arguments-section parameters"> - <h4 class="method-subtitle parameter-title">Parameters</h4> - - <dl class="argument-def parameter-def"> - <dt><em>aPath</em></dt> - <dd><p>The file path of the database.</p></dd> - </dl> - - <dl class="argument-def parameter-def"> - <dt><em>openFlags</em></dt> - <dd><p>Flags passed to the openWithFlags method of the database</p></dd> - </dl> - + <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 class="method-subsection return"> - <h4 class="method-subtitle parameter-title">Return Value</h4> - <p>The <code>FMDatabaseQueue</code> object. <code>nil</code> on error.</p> +</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 class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMDatabaseQueue.h</code><br /> - </div> - - </div> + </div> </div> - </div> - <div class="main-navigation navigation-bottom"> - <ul> - <li><a href="../index.html">Index</a></li> - <li><a href="../hierarchy.html">Hierarchy</a></li> -</ul> - </div> - <div id="footer"> - <hr /> + + + </main> + + <footer> <div class="footer-copyright"> - <p><span class="copyright">© 2014 ccgus. All rights reserved. (Last updated: 2014-05-25)</span><br /> - <span class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.1 (build 858)</a>.</span></p> + <p class="copyright">Copyright © 2015 ccgus. All rights reserved. Updated: 2015-01-25</p> + + + <p class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.2.1 (build 1333)</a>.</p> </div> - </div> + </footer> </div> - </article> - <script type="text/javascript"> - function jumpToChange() - { - window.location.hash = this.options[this.selectedIndex].value; - } - - function toggleTOC() - { - var contents = document.getElementById('contents'); - var tocContainer = document.getElementById('tocContainer'); - - if (this.getAttribute('class') == 'open') - { - this.setAttribute('class', ''); - contents.setAttribute('class', ''); - tocContainer.setAttribute('class', ''); - - window.name = "hideTOC"; - } - else - { - this.setAttribute('class', 'open'); - contents.setAttribute('class', 'isShowingTOC'); - tocContainer.setAttribute('class', 'isShowingTOC'); - - window.name = ""; - } - return false; - } - - function toggleTOCEntryChildren(e) - { - e.stopPropagation(); - var currentClass = this.getAttribute('class'); - if (currentClass == 'children') { - this.setAttribute('class', 'children open'); - } - else if (currentClass == 'children open') { - this.setAttribute('class', 'children'); - } - return false; - } - - function tocEntryClick(e) - { - e.stopPropagation(); - return true; - } - - function init() - { - var selectElement = document.getElementById('jumpTo'); - selectElement.addEventListener('change', jumpToChange, false); - - var tocButton = document.getElementById('table_of_contents'); - tocButton.addEventListener('click', toggleTOC, false); - - var taskTreeItem = document.getElementById('task_treeitem'); - if (taskTreeItem.getElementsByTagName('li').length > 0) - { - taskTreeItem.setAttribute('class', 'children'); - taskTreeItem.firstChild.setAttribute('class', 'disclosure'); - } - - var tocList = document.getElementById('toc'); - - var tocEntries = tocList.getElementsByTagName('li'); - for (var i = 0; i < tocEntries.length; i++) { - tocEntries[i].addEventListener('click', toggleTOCEntryChildren, false); - } - - var tocLinks = tocList.getElementsByTagName('a'); - for (var i = 0; i < tocLinks.length; i++) { - tocLinks[i].addEventListener('click', tocEntryClick, false); - } - - if (window.name == "hideTOC") { - toggleTOC.call(tocButton); - } - } - - window.onload = init; - - // If showing in Xcode, hide the TOC and Header - if (navigator.userAgent.match(/xcode/i)) { - document.getElementById("contents").className = "hideInXcode" - document.getElementById("tocContainer").className = "hideInXcode" - document.getElementById("top_header").className = "hideInXcode" - } - - </script> - </body> + </div> + </article> + + <script src="../js/script.js"></script> +</body> </html>
\ No newline at end of file diff --git a/html/Classes/FMResultSet.html b/html/Classes/FMResultSet.html index 9a57d02..ebdfd2a 100644 --- a/html/Classes/FMResultSet.html +++ b/html/Classes/FMResultSet.html @@ -1,290 +1,187 @@ -<!DOCTYPE HTML> +<!DOCTYPE html> <html> - <head> - <meta http-equiv="Content-Type" content="html/html; charset=utf-8" /> - <title>FMResultSet Class Reference</title> - <meta id="xcode-display" name="xcode-display" content="render"/> - <meta name="viewport" content="width=550" /> - <link rel="stylesheet" type="text/css" href="../css/styles.css" media="all" /> - <link rel="stylesheet" type="text/css" media="print" href="../css/stylesPrint.css" /> - <meta name="generator" content="appledoc 2.1 (build 858)" /> - </head> - <body> - <header id="top_header"> - <div id="library" class="hideInXcode"> - <h1><a id="libraryTitle" href="../index.html">FMDB </a></h1> - <a id="developerHome" href="../index.html">ccgus</a> - </div> - - <div id="title" role="banner"> - <h1 class="hideInXcode">FMResultSet Class Reference</h1> - </div> - <ul id="headerButtons" role="toolbar"> - <li id="toc_button"> - <button aria-label="Show Table of Contents" role="checkbox" class="open" id="table_of_contents"><span class="disclosure"></span>Table of Contents</button> - </li> - <li id="jumpto_button" role="navigation"> - <select id="jumpTo"> +<head> + <meta charset="utf-8"> + + <title>FMResultSet Class Reference</title> + + <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)"> +</head> +<body class="appledoc"> + <header> + <div class="container" class="hide-in-xcode"> + + <h1 id="library-title"> + <a href="../index.html">FMDB </a> + </h1> + + <p id="developer-home"> + <a href="../index.html">ccgus</a> + </p> + + </div> + </header> + + <aside> + <div class="container"> + <nav> + <ul id="header-buttons" role="toolbar"> + <li><a href="../index.html">Index</a></li> +<li><a href="../hierarchy.html">Hierarchy</a></li> + + <li id="on-this-page" role="navigation"> + <label> + On This Page + + <div class="chevron"> + <div class="chevy chevron-left"></div> + <div class="chevy chevron-right"></div> + </div> + + <select id="jump-to"> <option value="top">Jump To…</option> <option value="overview">Overview</option> - + <option value="tasks">Tasks</option> - - - - <option value="properties">Properties</option> - - <option value="//api/name/query"> query</option> - - <option value="//api/name/statement"> statement</option> - - - - - <option value="class_methods">Class Methods</option> - - <option value="//api/name/resultSetWithStatement:usingParentDatabase:"> + resultSetWithStatement:usingParentDatabase:</option> - - - - - <option value="instance_methods">Instance Methods</option> - - <option value="//api/name/UTF8StringForColumnIndex:"> - UTF8StringForColumnIndex:</option> - - <option value="//api/name/UTF8StringForColumnName:"> - UTF8StringForColumnName:</option> - - <option value="//api/name/boolForColumn:"> - boolForColumn:</option> - - <option value="//api/name/boolForColumnIndex:"> - boolForColumnIndex:</option> - - <option value="//api/name/close"> - close</option> - - <option value="//api/name/columnCount"> - columnCount</option> - - <option value="//api/name/columnIndexForName:"> - columnIndexForName:</option> - - <option value="//api/name/columnIndexIsNull:"> - columnIndexIsNull:</option> - - <option value="//api/name/columnIsNull:"> - columnIsNull:</option> - - <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> - - <option value="//api/name/dataNoCopyForColumn:"> - dataNoCopyForColumn:</option> - - <option value="//api/name/dataNoCopyForColumnIndex:"> - dataNoCopyForColumnIndex:</option> - - <option value="//api/name/dateForColumn:"> - dateForColumn:</option> - - <option value="//api/name/dateForColumnIndex:"> - dateForColumnIndex:</option> - - <option value="//api/name/doubleForColumn:"> - doubleForColumn:</option> - - <option value="//api/name/doubleForColumnIndex:"> - doubleForColumnIndex:</option> - - <option value="//api/name/hasAnotherRow"> - hasAnotherRow</option> - - <option value="//api/name/intForColumn:"> - intForColumn:</option> - - <option value="//api/name/intForColumnIndex:"> - intForColumnIndex:</option> - - <option value="//api/name/kvcMagic:"> - kvcMagic:</option> - - <option value="//api/name/longForColumn:"> - longForColumn:</option> - - <option value="//api/name/longForColumnIndex:"> - longForColumnIndex:</option> - - <option value="//api/name/longLongIntForColumn:"> - longLongIntForColumn:</option> - - <option value="//api/name/longLongIntForColumnIndex:"> - longLongIntForColumnIndex:</option> - - <option value="//api/name/next"> - next</option> - - <option value="//api/name/objectAtIndexedSubscript:"> - objectAtIndexedSubscript:</option> - - <option value="//api/name/objectForColumnIndex:"> - objectForColumnIndex:</option> - - <option value="//api/name/objectForColumnName:"> - objectForColumnName:</option> - - <option value="//api/name/objectForKeyedSubscript:"> - objectForKeyedSubscript:</option> - - <option value="//api/name/resultDict"> - resultDict</option> - - <option value="//api/name/resultDictionary"> - resultDictionary</option> - - <option value="//api/name/stringForColumn:"> - stringForColumn:</option> - - <option value="//api/name/stringForColumnIndex:"> - stringForColumnIndex:</option> - - <option value="//api/name/unsignedLongLongIntForColumn:"> - unsignedLongLongIntForColumn:</option> - - <option value="//api/name/unsignedLongLongIntForColumnIndex:"> - unsignedLongLongIntForColumnIndex:</option> - - - -</select> - </li> - </ul> - </header> - <nav id="tocContainer" class="isShowingTOC"> - <ul id="toc" role="tree"> - -<li role="treeitem"><span class="nodisclosure"></span><span class="sectionName"><a href="#overview">Overview</a></span></li> - - - -<li role="treeitem" id="task_treeitem"><span class="nodisclosure"></span><span class="sectionName"><a href="#tasks">Tasks</a></span><ul> - - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#task_Properties">Properties</a></span></li> - -</ul></li> - - - - - -<li role="treeitem" class="children"><span class="disclosure"></span><span class="sectionName"><a href="#properties">Properties</a></span><ul> - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/query">query</a></span></li> - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/statement">statement</a></span></li> + <optgroup label="Properties"> + + <option value="//api/name/query">query</option> + + <option value="//api/name/statement">statement</option> + + </optgroup> -</ul></li> - - -<li role="treeitem" class="children"><span class="disclosure"></span><span class="sectionName"><a href="#class_methods">Class Methods</a></span><ul> - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/resultSetWithStatement:usingParentDatabase:">resultSetWithStatement:usingParentDatabase:</a></span></li> + <optgroup label="Class Methods"> + + <option value="//api/name/resultSetWithStatement:usingParentDatabase:">+ resultSetWithStatement:usingParentDatabase:</option> + + </optgroup> -</ul></li> - - -<li role="treeitem" class="children"><span class="disclosure"></span><span class="sectionName"><a href="#instance_methods">Instance Methods</a></span><ul> - - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/UTF8StringForColumnIndex:">UTF8StringForColumnIndex:</a></span></li> - - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/UTF8StringForColumnName:">UTF8StringForColumnName:</a></span></li> - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/boolForColumn:">boolForColumn:</a></span></li> - - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/boolForColumnIndex:">boolForColumnIndex:</a></span></li> - - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/close">close</a></span></li> - - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/columnCount">columnCount</a></span></li> - - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/columnIndexForName:">columnIndexForName:</a></span></li> - - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/columnIndexIsNull:">columnIndexIsNull:</a></span></li> - - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/columnIsNull:">columnIsNull:</a></span></li> - - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/columnNameForIndex:">columnNameForIndex:</a></span></li> - - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/columnNameToIndexMap">columnNameToIndexMap</a></span></li> - - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/dataForColumn:">dataForColumn:</a></span></li> - - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/dataForColumnIndex:">dataForColumnIndex:</a></span></li> - - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/dataNoCopyForColumn:">dataNoCopyForColumn:</a></span></li> - - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/dataNoCopyForColumnIndex:">dataNoCopyForColumnIndex:</a></span></li> - - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/dateForColumn:">dateForColumn:</a></span></li> - - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/dateForColumnIndex:">dateForColumnIndex:</a></span></li> - - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/doubleForColumn:">doubleForColumn:</a></span></li> - - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/doubleForColumnIndex:">doubleForColumnIndex:</a></span></li> - - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/hasAnotherRow">hasAnotherRow</a></span></li> - - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/intForColumn:">intForColumn:</a></span></li> - - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/intForColumnIndex:">intForColumnIndex:</a></span></li> - - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/kvcMagic:">kvcMagic:</a></span></li> - - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/longForColumn:">longForColumn:</a></span></li> - - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/longForColumnIndex:">longForColumnIndex:</a></span></li> - - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/longLongIntForColumn:">longLongIntForColumn:</a></span></li> - - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/longLongIntForColumnIndex:">longLongIntForColumnIndex:</a></span></li> - - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/next">next</a></span></li> - - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/objectAtIndexedSubscript:">objectAtIndexedSubscript:</a></span></li> - - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/objectForColumnIndex:">objectForColumnIndex:</a></span></li> - - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/objectForColumnName:">objectForColumnName:</a></span></li> - - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/objectForKeyedSubscript:">objectForKeyedSubscript:</a></span></li> - - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/resultDict">resultDict</a></span></li> - - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/resultDictionary">resultDictionary</a></span></li> - - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/stringForColumn:">stringForColumn:</a></span></li> - - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/stringForColumnIndex:">stringForColumnIndex:</a></span></li> - - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/unsignedLongLongIntForColumn:">unsignedLongLongIntForColumn:</a></span></li> + <optgroup label="Instance Methods"> + + <option value="//api/name/UTF8StringForColumnIndex:">- UTF8StringForColumnIndex:</option> + + <option value="//api/name/UTF8StringForColumnName:">- UTF8StringForColumnName:</option> + + <option value="//api/name/boolForColumn:">- boolForColumn:</option> + + <option value="//api/name/boolForColumnIndex:">- boolForColumnIndex:</option> + + <option value="//api/name/close">- close</option> + + <option value="//api/name/columnCount">- columnCount</option> + + <option value="//api/name/columnIndexForName:">- columnIndexForName:</option> + + <option value="//api/name/columnIndexIsNull:">- columnIndexIsNull:</option> + + <option value="//api/name/columnIsNull:">- columnIsNull:</option> + + <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> + + <option value="//api/name/dataNoCopyForColumn:">- dataNoCopyForColumn:</option> + + <option value="//api/name/dataNoCopyForColumnIndex:">- dataNoCopyForColumnIndex:</option> + + <option value="//api/name/dateForColumn:">- dateForColumn:</option> + + <option value="//api/name/dateForColumnIndex:">- dateForColumnIndex:</option> + + <option value="//api/name/doubleForColumn:">- doubleForColumn:</option> + + <option value="//api/name/doubleForColumnIndex:">- doubleForColumnIndex:</option> + + <option value="//api/name/hasAnotherRow">- hasAnotherRow</option> + + <option value="//api/name/intForColumn:">- intForColumn:</option> + + <option value="//api/name/intForColumnIndex:">- intForColumnIndex:</option> + + <option value="//api/name/kvcMagic:">- kvcMagic:</option> + + <option value="//api/name/longForColumn:">- longForColumn:</option> + + <option value="//api/name/longForColumnIndex:">- longForColumnIndex:</option> + + <option value="//api/name/longLongIntForColumn:">- longLongIntForColumn:</option> + + <option value="//api/name/longLongIntForColumnIndex:">- longLongIntForColumnIndex:</option> + + <option value="//api/name/next">- next</option> + + <option value="//api/name/nextWithError:">- nextWithError:</option> + + <option value="//api/name/objectAtIndexedSubscript:">- objectAtIndexedSubscript:</option> + + <option value="//api/name/objectForColumnIndex:">- objectForColumnIndex:</option> + + <option value="//api/name/objectForColumnName:">- objectForColumnName:</option> + + <option value="//api/name/objectForKeyedSubscript:">- objectForKeyedSubscript:</option> + + <option value="//api/name/resultDict">- resultDict</option> + + <option value="//api/name/resultDictionary">- resultDictionary</option> + + <option value="//api/name/stringForColumn:">- stringForColumn:</option> + + <option value="//api/name/stringForColumnIndex:">- stringForColumnIndex:</option> + + <option value="//api/name/unsignedLongLongIntForColumn:">- unsignedLongLongIntForColumn:</option> + + <option value="//api/name/unsignedLongLongIntForColumnIndex:">- unsignedLongLongIntForColumnIndex:</option> + + </optgroup> - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/unsignedLongLongIntForColumnIndex:">unsignedLongLongIntForColumnIndex:</a></span></li> -</ul></li> - - - </ul> - </nav> - <article> - <div id="contents" class="isShowingTOC" role="main"> - <a title="FMResultSet Class Reference" name="top"></a> - <div class="main-navigation navigation-top"> - <ul> - <li><a href="../index.html">Index</a></li> - <li><a href="../hierarchy.html">Hierarchy</a></li> -</ul> - </div> - <div id="header"> - <div class="section-header"> - <h1 class="title title-header">FMResultSet Class Reference</h1> - </div> - </div> - <div id="container"> +</select> + </label> + </li> + </ul> + </nav> + </div> + </aside> + + <article> + <div id="overview_contents" class="container"> + <div id="content"> + <main role="main"> + <h1 class="title">FMResultSet Class Reference</h1> + <div class="section section-specification"><table cellspacing="0"><tbody> <tr> - <td class="specification-title">Inherits from</td> - <td class="specification-value">NSObject</td> + <th>Inherits from</th> + <td>NSObject</td> </tr><tr> - <td class="specification-title">Declared in</td> - <td class="specification-value">FMResultSet.h<br />FMResultSet.m</td> + <th>Declared in</th> + <td>FMResultSet.h<br />FMResultSet.m</td> </tr> </tbody></table></div> - - + + <div class="section section-overview"> <a title="Overview" name="overview"></a> @@ -300,1920 +197,2425 @@ </div> - + <div class="section section-tasks"> <a title="Tasks" name="tasks"></a> - <h2 class="subtitle subtitle-tasks">Tasks</h2> + - - <h3 class="subsubtitle task-title">Other Methods</h3> - - <ul class="task-list"> - <li> - <span class="tooltip"> - <code><a href="#//api/name/resultSetWithStatement:usingParentDatabase:">+ resultSetWithStatement:usingParentDatabase:</a></code> - <span class="tooltip"><p>Create result set from <a href="../Classes/FMStatement.html"><code>FMStatement</code></a></p></span> - </span> - - -</li><li> - <span class="tooltip"> - <code><a href="#//api/name/close">– close</a></code> - <span class="tooltip"><p>Close result set</p></span> - </span> - - -</li><li> - <span class="tooltip"> - <code><a href="#//api/name/columnCount">– columnCount</a></code> - <span class="tooltip"><p>How many columns in result set</p></span> - </span> - - -</li><li> - <span class="tooltip"> - <code><a href="#//api/name/columnNameToIndexMap">– columnNameToIndexMap</a></code> - <span class="tooltip"><p><code>NSMutableDictionary</code> mapping column names to numeric index</p></span> - </span> - - -</li><li> - <span class="tooltip"> - <code><a href="#//api/name/kvcMagic:">– kvcMagic:</a></code> - <span class="tooltip"><p>Performs <code>setValue</code> to yield support for key value observing.</p></span> - </span> - - -</li><li> - <span class="tooltip"> - <code><a href="#//api/name/resultDict">– resultDict</a></code> - <span class="tooltip"><p>Returns a dictionary of the row results</p></span> - </span> - - -</li><li> - <span class="tooltip"> - <code><a href="#//api/name/resultDictionary">– resultDictionary</a></code> - <span class="tooltip"><p>Returns a dictionary of the row results mapped to case sensitive keys of the column names.</p></span> - </span> - - -</li><li> - <span class="tooltip"> - <code><a href="#//api/name/next">– next</a></code> - <span class="tooltip"><p>Retrieve next row for result set.</p></span> - </span> - - -</li><li> - <span class="tooltip"> - <code><a href="#//api/name/hasAnotherRow">– hasAnotherRow</a></code> - <span class="tooltip"><p>Did the last call to <a href="#//api/name/next"><code>next</code></a> succeed in retrieving another row?</p></span> - </span> - - -</li><li> - <span class="tooltip"> - <code><a href="#//api/name/columnIndexForName:">– columnIndexForName:</a></code> - <span class="tooltip"><p>Column index for column name</p></span> - </span> - - -</li><li> - <span class="tooltip"> - <code><a href="#//api/name/intForColumn:">– intForColumn:</a></code> - <span class="tooltip"><p>Result set integer value for column.</p></span> - </span> - - -</li><li> - <span class="tooltip"> - <code><a href="#//api/name/intForColumnIndex:">– intForColumnIndex:</a></code> - <span class="tooltip"><p>Result set integer value for column.</p></span> - </span> - - -</li><li> - <span class="tooltip"> - <code><a href="#//api/name/longForColumn:">– longForColumn:</a></code> - <span class="tooltip"><p>Result set <code>long</code> value for column.</p></span> - </span> - - -</li><li> - <span class="tooltip"> - <code><a href="#//api/name/longForColumnIndex:">– longForColumnIndex:</a></code> - <span class="tooltip"><p>Result set long value for column.</p></span> - </span> - - -</li><li> - <span class="tooltip"> - <code><a href="#//api/name/longLongIntForColumn:">– longLongIntForColumn:</a></code> - <span class="tooltip"><p>Result set <code>long long int</code> value for column.</p></span> - </span> - - -</li><li> - <span class="tooltip"> - <code><a href="#//api/name/longLongIntForColumnIndex:">– longLongIntForColumnIndex:</a></code> - <span class="tooltip"><p>Result set <code>long long int</code> value for column.</p></span> - </span> - - -</li><li> - <span class="tooltip"> - <code><a href="#//api/name/unsignedLongLongIntForColumn:">– unsignedLongLongIntForColumn:</a></code> - <span class="tooltip"><p>Result set <code>unsigned long long int</code> value for column.</p></span> - </span> - - -</li><li> - <span class="tooltip"> - <code><a href="#//api/name/unsignedLongLongIntForColumnIndex:">– unsignedLongLongIntForColumnIndex:</a></code> - <span class="tooltip"><p>Result set <code>unsigned long long int</code> value for column.</p></span> - </span> - - -</li><li> - <span class="tooltip"> - <code><a href="#//api/name/boolForColumn:">– boolForColumn:</a></code> - <span class="tooltip"><p>Result set <code>BOOL</code> value for column.</p></span> - </span> - - -</li><li> - <span class="tooltip"> - <code><a href="#//api/name/boolForColumnIndex:">– boolForColumnIndex:</a></code> - <span class="tooltip"><p>Result set <code>BOOL</code> value for column.</p></span> - </span> - - -</li><li> - <span class="tooltip"> - <code><a href="#//api/name/doubleForColumn:">– doubleForColumn:</a></code> - <span class="tooltip"><p>Result set <code>double</code> value for column.</p></span> - </span> - - -</li><li> - <span class="tooltip"> - <code><a href="#//api/name/doubleForColumnIndex:">– doubleForColumnIndex:</a></code> - <span class="tooltip"><p>Result set <code>double</code> value for column.</p></span> - </span> - - -</li><li> - <span class="tooltip"> - <code><a href="#//api/name/stringForColumnIndex:">– stringForColumnIndex:</a></code> - <span class="tooltip"><p>Result set <code>NSString</code> value for column.</p></span> - </span> - - -</li><li> - <span class="tooltip"> - <code><a href="#//api/name/stringForColumn:">– stringForColumn:</a></code> - <span class="tooltip"><p>Result set <code>NSString</code> value for column.</p></span> - </span> - - -</li><li> - <span class="tooltip"> - <code><a href="#//api/name/dateForColumn:">– dateForColumn:</a></code> - <span class="tooltip"><p>Result set <code>NSDate</code> value for column.</p></span> - </span> - - -</li><li> - <span class="tooltip"> - <code><a href="#//api/name/dateForColumnIndex:">– dateForColumnIndex:</a></code> - <span class="tooltip"><p>Result set <code>NSDate</code> value for column.</p></span> - </span> - - -</li><li> - <span class="tooltip"> - <code><a href="#//api/name/dataForColumn:">– dataForColumn:</a></code> - <span class="tooltip"><p>Result set <code>NSData</code> value for column.</p></span> - </span> - - -</li><li> - <span class="tooltip"> - <code><a href="#//api/name/dataForColumnIndex:">– dataForColumnIndex:</a></code> - <span class="tooltip"><p>Result set <code>NSData</code> value for column.</p></span> - </span> - - -</li><li> - <span class="tooltip"> - <code><a href="#//api/name/dataNoCopyForColumn:">– dataNoCopyForColumn:</a></code> - <span class="tooltip"><p>Result set <code>NSData</code> value for column.</p></span> - </span> - - -</li><li> - <span class="tooltip"> - <code><a href="#//api/name/dataNoCopyForColumnIndex:">– dataNoCopyForColumnIndex:</a></code> - <span class="tooltip"><p>Result set <code>NSData</code> value for column.</p></span> - </span> - - -</li><li> - <span class="tooltip"> - <code><a href="#//api/name/columnIndexIsNull:">– columnIndexIsNull:</a></code> - <span class="tooltip"><p>Is the column <code>NULL</code>?</p></span> - </span> - - -</li><li> - <span class="tooltip"> - <code><a href="#//api/name/columnIsNull:">– columnIsNull:</a></code> - <span class="tooltip"><p>Is the column <code>NULL</code>?</p></span> - </span> - - -</li><li> - <span class="tooltip"> - <code><a href="#//api/name/UTF8StringForColumnIndex:">– UTF8StringForColumnIndex:</a></code> - <span class="tooltip"><p>Result set <code>(const unsigned char *)</code> value for column.</p></span> - </span> - - -</li><li> - <span class="tooltip"> - <code><a href="#//api/name/UTF8StringForColumnName:">– UTF8StringForColumnName:</a></code> - <span class="tooltip"><p>Result set <code>(const unsigned char *)</code> value for column.</p></span> - </span> - - -</li><li> - <span class="tooltip"> - <code><a href="#//api/name/objectForColumnIndex:">– objectForColumnIndex:</a></code> - <span class="tooltip"><p>Result set object for column.</p></span> - </span> - - -</li><li> - <span class="tooltip"> - <code><a href="#//api/name/objectForColumnName:">– objectForColumnName:</a></code> - <span class="tooltip"><p>Result set object for column.</p></span> - </span> - - -</li><li> - <span class="tooltip"> - <code><a href="#//api/name/columnNameForIndex:">– columnNameForIndex:</a></code> - <span class="tooltip"><p>Column name for column index</p></span> - </span> - - -</li><li> - <span class="tooltip"> - <code><a href="#//api/name/objectAtIndexedSubscript:">– objectAtIndexedSubscript:</a></code> - <span class="tooltip"><p>Result set object for column.</p></span> - </span> - - -</li><li> - <span class="tooltip"> - <code><a href="#//api/name/objectForKeyedSubscript:">– objectForKeyedSubscript:</a></code> - <span class="tooltip"><p>Result set object for column.</p></span> - </span> - - -</li> - </ul> - - - <a title="Properties" name="task_Properties"></a> - <h3 class="subsubtitle task-title">Properties</h3> - - <ul class="task-list"> - <li> - <span class="tooltip"> - <code><a href="#//api/name/query"> query</a></code> - <span class="tooltip"><p>Executed query</p></span> - </span> - <span class="task-item-suffix">property</span> - -</li><li> - <span class="tooltip"> - <code><a href="#//api/name/statement"> statement</a></code> - <span class="tooltip"><p><code>FMStatement</code> used by result set.</p></span> - </span> - <span class="task-item-suffix">property</span> - -</li> - </ul> - - </div> - + <h2 class="task-title">Other Methods</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"> + <div class="pointy-thing"></div> + + <div class="method-info-container"> + + + <div class="method-subsection brief-description"> + <p>Create result set from <a href="../Classes/FMStatement.html"><code>FMStatement</code></a></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 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> + </div> + + + + + + + + <div class="method-subsection declared-in-section"> + <h4 class="method-subtitle">Declared In</h4> + <p><code class="declared-in-ref">FMResultSet.h</code></p> + </div> + + + </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> +</h3> + + <div class="method-info"> + <div class="pointy-thing"></div> + + <div class="method-info-container"> + + + <div class="method-subsection brief-description"> + <p>Close result set</p> + </div> + + + + <div class="method-subsection method-declaration"><code>- (void)close</code></div> + + + + + + + + + + <div class="method-subsection discussion-section"> + <h4 class="method-subtitle">Discussion</h4> + <p>Close result set</p> + </div> + + + + + + + + <div class="method-subsection declared-in-section"> + <h4 class="method-subtitle">Declared In</h4> + <p><code class="declared-in-ref">FMResultSet.h</code></p> + </div> + + + </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> +</h3> + + <div class="method-info"> + <div class="pointy-thing"></div> + + <div class="method-info-container"> + + + <div class="method-subsection brief-description"> + <p>How many columns in result set</p> + </div> + + + + <div class="method-subsection method-declaration"><code>- (int)columnCount</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> + </div> + + + + + + + + <div class="method-subsection declared-in-section"> + <h4 class="method-subtitle">Declared In</h4> + <p><code class="declared-in-ref">FMResultSet.h</code></p> + </div> + + + </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> +</h3> + + <div class="method-info"> + <div class="pointy-thing"></div> + + <div class="method-info-container"> + + + <div class="method-subsection brief-description"> + <p><code>NSMutableDictionary</code> mapping column names to numeric index</p> + </div> + + + + <div class="method-subsection method-declaration"><code>- (NSMutableDictionary *)columnNameToIndexMap</code></div> + + + + + + + + + + <div class="method-subsection discussion-section"> + <h4 class="method-subtitle">Discussion</h4> + <p><code>NSMutableDictionary</code> mapping column names to numeric index</p> + </div> + + + + + + + + <div class="method-subsection declared-in-section"> + <h4 class="method-subtitle">Declared In</h4> + <p><code class="declared-in-ref">FMResultSet.h</code></p> + </div> + + + </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> +</h3> + + <div class="method-info"> + <div class="pointy-thing"></div> + + <div class="method-info-container"> + + + <div class="method-subsection brief-description"> + <p>Performs <code>setValue</code> to yield support for key value observing.</p> + </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> + + + + + + + + <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> + </div> + + + + + + + + <div class="method-subsection declared-in-section"> + <h4 class="method-subtitle">Declared In</h4> + <p><code class="declared-in-ref">FMResultSet.h</code></p> + </div> + + + </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> +</h3> + + <div class="method-info"> + <div class="pointy-thing"></div> + + <div class="method-info-container"> + + + <div class="method-subsection brief-description"> + <p>Returns a dictionary of the row results</p> + </div> + + + + <div class="method-subsection method-declaration"><code>- (NSDictionary *)resultDict</code></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> + </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"> + <h4 class="method-subtitle">Declared In</h4> + <p><code class="declared-in-ref">FMResultSet.h</code></p> + </div> + + + </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> +</h3> + + <div class="method-info"> + <div class="pointy-thing"></div> + + <div class="method-info-container"> + + + <div class="method-subsection brief-description"> + <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>- (NSDictionary *)resultDictionary</code></div> + + + + + + <div class="method-subsection return"> + <h4 class="method-subtitle parameter-title">Return Value</h4> + <p><code>NSDictionary</code> of the row results.</p> + </div> + + + + + + <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> + </div> + + + + + + + + <div class="method-subsection declared-in-section"> + <h4 class="method-subtitle">Declared In</h4> + <p><code class="declared-in-ref">FMResultSet.h</code></p> + </div> + + + </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> +</h3> + + <div class="method-info"> + <div class="pointy-thing"></div> + + <div class="method-info-container"> + + + <div class="method-subsection brief-description"> + <p>Retrieve next row for result set.</p> + </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>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> - <div class="section section-methods"> - <a title="Properties" name="properties"></a> - <h2 class="subtitle subtitle-methods">Properties</h2> - - <div class="section-method"> - <a name="//api/name/query" title="query"></a> - <h3 class="subsubtitle method-title">query</h3> - - - - <div class="method-subsection brief-description"> - <p>Executed query</p> - </div> - - + </ul> + </div> + - <div class="method-subsection method-declaration"><code>@property (atomic, retain) NSString *query</code></div> + + <div class="method-subsection declared-in-section"> + <h4 class="method-subtitle">Declared In</h4> + <p><code class="declared-in-ref">FMResultSet.h</code></p> + </div> + + + </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> +</h3> - - - - - - - - - - - - - - - <div class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMResultSet.h</code><br /> - </div> - - -</div> - - <div class="section-method"> - <a name="//api/name/statement" title="statement"></a> - <h3 class="subsubtitle method-title">statement</h3> - - - - <div class="method-subsection brief-description"> - <p><code>FMStatement</code> used by result set.</p> - </div> - - + <div class="method-info"> + <div class="pointy-thing"></div> - <div class="method-subsection method-declaration"><code>@property (atomic, retain) FMStatement *statement</code></div> + <div class="method-info-container"> + + + <div class="method-subsection brief-description"> + <p>Retrieve next row for result set.</p> + </div> + + - - - - - - - - - - - - - - - <div class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMResultSet.h</code><br /> - </div> - - -</div> - - </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>‘YES’ if row successfully retrieved; ‘NO’ if end of result set reached</p> + </div> + + + + + + <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> + </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> - <div class="section section-methods"> - <a title="Class Methods" name="class_methods"></a> - <h2 class="subtitle subtitle-methods">Class Methods</h2> - - <div class="section-method"> - <a name="//api/name/resultSetWithStatement:usingParentDatabase:" title="resultSetWithStatement:usingParentDatabase:"></a> - <h3 class="subsubtitle method-title">resultSetWithStatement:usingParentDatabase:</h3> - - - - <div class="method-subsection brief-description"> - <p>Create result set from <a href="../Classes/FMStatement.html"><code>FMStatement</code></a></p> - </div> - - - - <div class="method-subsection method-declaration"><code>+ (instancetype)resultSetWithStatement:(FMStatement *)<em>statement</em> usingParentDatabase:(FMDatabase *)<em>aDB</em></code></div> + </ul> + </div> + - - - <div class="method-subsection arguments-section parameters"> - <h4 class="method-subtitle parameter-title">Parameters</h4> - - <dl class="argument-def parameter-def"> - <dt><em>statement</em></dt> - <dd><p>A <a href="../Classes/FMStatement.html"><code>FMStatement</code></a> to be performed</p></dd> - </dl> - - <dl class="argument-def parameter-def"> - <dt><em>aDB</em></dt> - <dd><p>A <a href="../Classes/FMDatabase.html"><code>FMDatabase</code></a> to be used</p></dd> - </dl> - - </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 class="method-subsection declared-in-section"> + <h4 class="method-subtitle">Declared In</h4> + <p><code class="declared-in-ref">FMResultSet.h</code></p> + </div> + + + </div> </div> - - - - - - - - - - - - <div class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMResultSet.h</code><br /> - </div> - - -</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> +</h3> + + <div class="method-info"> + <div class="pointy-thing"></div> + + <div class="method-info-container"> + + + <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> + </div> + + + + <div class="method-subsection method-declaration"><code>- (BOOL)hasAnotherRow</code></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> + </div> + + + + + + <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> + </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> - <div class="section section-methods"> - <a title="Instance Methods" name="instance_methods"></a> - <h2 class="subtitle subtitle-methods">Instance Methods</h2> - - <div class="section-method"> - <a name="//api/name/UTF8StringForColumnIndex:" title="UTF8StringForColumnIndex:"></a> - <h3 class="subsubtitle method-title">UTF8StringForColumnIndex:</h3> - - - - <div class="method-subsection brief-description"> - <p>Result set <code>(const unsigned char *)</code> value for column.</p> - </div> - - - - <div class="method-subsection method-declaration"><code>- (const unsigned char *)UTF8StringForColumnIndex:(int)<em>columnIdx</em></code></div> + </ul> + </div> + - - - <div class="method-subsection arguments-section parameters"> - <h4 class="method-subtitle parameter-title">Parameters</h4> - - <dl class="argument-def parameter-def"> - <dt><em>columnIdx</em></dt> - <dd><p>Zero-based index for column.</p></dd> - </dl> - - </div> - - - - <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> + + <div class="method-subsection declared-in-section"> + <h4 class="method-subtitle">Declared In</h4> + <p><code class="declared-in-ref">FMResultSet.h</code></p> + </div> + + + </div> </div> - - - - - - - - - - - - <div class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMResultSet.h</code><br /> - </div> - - -</div> - - <div class="section-method"> - <a name="//api/name/UTF8StringForColumnName:" title="UTF8StringForColumnName:"></a> - <h3 class="subsubtitle method-title">UTF8StringForColumnName:</h3> - - - - <div class="method-subsection brief-description"> - <p>Result set <code>(const unsigned char *)</code> value for column.</p> - </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> +</h3> - <div class="method-subsection method-declaration"><code>- (const unsigned char *)UTF8StringForColumnName:(NSString *)<em>columnName</em></code></div> + <div class="method-info"> + <div class="pointy-thing"></div> - - - <div class="method-subsection arguments-section parameters"> - <h4 class="method-subtitle parameter-title">Parameters</h4> - - <dl class="argument-def parameter-def"> - <dt><em>columnName</em></dt> - <dd><p><code>NSString</code> value of the name of the column.</p></dd> - </dl> - + <div class="method-info-container"> + + + <div class="method-subsection brief-description"> + <p>Column index for column name</p> + </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>Zero-based index for column.</p> + </div> + + + + + + <div class="method-subsection discussion-section"> + <h4 class="method-subtitle">Discussion</h4> + <p>Column index for column name</p> + </div> + + + + + + + + <div class="method-subsection declared-in-section"> + <h4 class="method-subtitle">Declared In</h4> + <p><code class="declared-in-ref">FMResultSet.h</code></p> + </div> + + + </div> </div> - - - - <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> +</div><div class="section-method"> + <a name="//api/name/intForColumn:" title="intForColumn:"></a> + <h3 class="method-title"><code><a href="#//api/name/intForColumn:">– intForColumn:</a></code> +</h3> + + <div class="method-info"> + <div class="pointy-thing"></div> + + <div class="method-info-container"> + + + <div class="method-subsection brief-description"> + <p>Result set integer value for column.</p> + </div> + + + + <div class="method-subsection method-declaration"><code>- (int)intForColumn:(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>int</code> value of the result set’s column.</p> + </div> + + + + + + <div class="method-subsection discussion-section"> + <h4 class="method-subtitle">Discussion</h4> + <p>Result set integer value for column.</p> + </div> + + + + + + + + <div class="method-subsection declared-in-section"> + <h4 class="method-subtitle">Declared In</h4> + <p><code class="declared-in-ref">FMResultSet.h</code></p> + </div> + + + </div> </div> - - - - - - - - - - - - <div class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMResultSet.h</code><br /> - </div> - - -</div> - - <div class="section-method"> - <a name="//api/name/boolForColumn:" title="boolForColumn:"></a> - <h3 class="subsubtitle method-title">boolForColumn:</h3> - - - - <div class="method-subsection brief-description"> - <p>Result set <code>BOOL</code> value for column.</p> - </div> - - +</div><div class="section-method"> + <a name="//api/name/intForColumnIndex:" title="intForColumnIndex:"></a> + <h3 class="method-title"><code><a href="#//api/name/intForColumnIndex:">– intForColumnIndex:</a></code> +</h3> - <div class="method-subsection method-declaration"><code>- (BOOL)boolForColumn:(NSString *)<em>columnName</em></code></div> + <div class="method-info"> + <div class="pointy-thing"></div> - - - <div class="method-subsection arguments-section parameters"> - <h4 class="method-subtitle parameter-title">Parameters</h4> - - <dl class="argument-def parameter-def"> - <dt><em>columnName</em></dt> - <dd><p><code>NSString</code> value of the name of the column.</p></dd> - </dl> - + <div class="method-info-container"> + + + <div class="method-subsection brief-description"> + <p>Result set integer value for column.</p> + </div> + + + + <div class="method-subsection method-declaration"><code>- (int)intForColumnIndex:(int)<em>columnIdx</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>columnIdx</code></th> + <td><p>Zero-based index for column.</p></td> + </tr> + + </table> + </div> + + + + <div class="method-subsection return"> + <h4 class="method-subtitle parameter-title">Return Value</h4> + <p><code>int</code> value of the result set’s column.</p> + </div> + + + + + + <div class="method-subsection discussion-section"> + <h4 class="method-subtitle">Discussion</h4> + <p>Result set integer value for column.</p> + </div> + + + + + + + + <div class="method-subsection declared-in-section"> + <h4 class="method-subtitle">Declared In</h4> + <p><code class="declared-in-ref">FMResultSet.h</code></p> + </div> + + + </div> </div> - - - - <div class="method-subsection return"> - <h4 class="method-subtitle parameter-title">Return Value</h4> - <p><code>BOOL</code> value of the result set’s column.</p> +</div><div class="section-method"> + <a name="//api/name/longForColumn:" title="longForColumn:"></a> + <h3 class="method-title"><code><a href="#//api/name/longForColumn:">– longForColumn:</a></code> +</h3> + + <div class="method-info"> + <div class="pointy-thing"></div> + + <div class="method-info-container"> + + + <div class="method-subsection brief-description"> + <p>Result set <code>long</code> value for column.</p> + </div> + + + + <div class="method-subsection method-declaration"><code>- (long)longForColumn:(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>long</code> value of the result set’s column.</p> + </div> + + + + + + <div class="method-subsection discussion-section"> + <h4 class="method-subtitle">Discussion</h4> + <p>Result set <code>long</code> value for column.</p> + </div> + + + + + + + + <div class="method-subsection declared-in-section"> + <h4 class="method-subtitle">Declared In</h4> + <p><code class="declared-in-ref">FMResultSet.h</code></p> + </div> + + + </div> </div> - - - - - - - - - - - - <div class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMResultSet.h</code><br /> - </div> - - -</div> - - <div class="section-method"> - <a name="//api/name/boolForColumnIndex:" title="boolForColumnIndex:"></a> - <h3 class="subsubtitle method-title">boolForColumnIndex:</h3> - - - - <div class="method-subsection brief-description"> - <p>Result set <code>BOOL</code> value for column.</p> - </div> - - +</div><div class="section-method"> + <a name="//api/name/longForColumnIndex:" title="longForColumnIndex:"></a> + <h3 class="method-title"><code><a href="#//api/name/longForColumnIndex:">– longForColumnIndex:</a></code> +</h3> - <div class="method-subsection method-declaration"><code>- (BOOL)boolForColumnIndex:(int)<em>columnIdx</em></code></div> + <div class="method-info"> + <div class="pointy-thing"></div> - - - <div class="method-subsection arguments-section parameters"> - <h4 class="method-subtitle parameter-title">Parameters</h4> - - <dl class="argument-def parameter-def"> - <dt><em>columnIdx</em></dt> - <dd><p>Zero-based index for column.</p></dd> - </dl> - + <div class="method-info-container"> + + + <div class="method-subsection brief-description"> + <p>Result set long value for column.</p> + </div> + + + + <div class="method-subsection method-declaration"><code>- (long)longForColumnIndex:(int)<em>columnIdx</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>columnIdx</code></th> + <td><p>Zero-based index for column.</p></td> + </tr> + + </table> + </div> + + + + <div class="method-subsection return"> + <h4 class="method-subtitle parameter-title">Return Value</h4> + <p><code>long</code> value of the result set’s column.</p> + </div> + + + + + + <div class="method-subsection discussion-section"> + <h4 class="method-subtitle">Discussion</h4> + <p>Result set long value for column.</p> + </div> + + + + + + + + <div class="method-subsection declared-in-section"> + <h4 class="method-subtitle">Declared In</h4> + <p><code class="declared-in-ref">FMResultSet.h</code></p> + </div> + + + </div> </div> - - - - <div class="method-subsection return"> - <h4 class="method-subtitle parameter-title">Return Value</h4> - <p><code>BOOL</code> value of the result set’s column.</p> +</div><div class="section-method"> + <a name="//api/name/longLongIntForColumn:" title="longLongIntForColumn:"></a> + <h3 class="method-title"><code><a href="#//api/name/longLongIntForColumn:">– longLongIntForColumn:</a></code> +</h3> + + <div class="method-info"> + <div class="pointy-thing"></div> + + <div class="method-info-container"> + + + <div class="method-subsection brief-description"> + <p>Result set <code>long long int</code> value for column.</p> + </div> + + + + <div class="method-subsection method-declaration"><code>- (long long int)longLongIntForColumn:(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>long long int</code> value of the result set’s column.</p> + </div> + + + + + + <div class="method-subsection discussion-section"> + <h4 class="method-subtitle">Discussion</h4> + <p>Result set <code>long long int</code> value for column.</p> + </div> + + + + + + + + <div class="method-subsection declared-in-section"> + <h4 class="method-subtitle">Declared In</h4> + <p><code class="declared-in-ref">FMResultSet.h</code></p> + </div> + + + </div> </div> - - - - - - - - - - - - <div class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMResultSet.h</code><br /> - </div> - - -</div> - - <div class="section-method"> - <a name="//api/name/close" title="close"></a> - <h3 class="subsubtitle method-title">close</h3> - - - - <div class="method-subsection brief-description"> - <p>Close result set</p> - </div> - - +</div><div class="section-method"> + <a name="//api/name/longLongIntForColumnIndex:" title="longLongIntForColumnIndex:"></a> + <h3 class="method-title"><code><a href="#//api/name/longLongIntForColumnIndex:">– longLongIntForColumnIndex:</a></code> +</h3> - <div class="method-subsection method-declaration"><code>- (void)close</code></div> + <div class="method-info"> + <div class="pointy-thing"></div> - - - - - - - - - - - - - - - <div class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMResultSet.h</code><br /> - </div> - - -</div> - - <div class="section-method"> - <a name="//api/name/columnCount" title="columnCount"></a> - <h3 class="subsubtitle method-title">columnCount</h3> - - - - <div class="method-subsection brief-description"> - <p>How many columns in result set</p> - </div> - - + <div class="method-info-container"> + + + <div class="method-subsection brief-description"> + <p>Result set <code>long long int</code> value for column.</p> + </div> + + - <div class="method-subsection method-declaration"><code>- (int)columnCount</code></div> + <div class="method-subsection method-declaration"><code>- (long long int)longLongIntForColumnIndex:(int)<em>columnIdx</em></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 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>columnIdx</code></th> + <td><p>Zero-based index for column.</p></td> + </tr> + + </table> + </div> + + + + <div class="method-subsection return"> + <h4 class="method-subtitle parameter-title">Return Value</h4> + <p><code>long long int</code> value of the result set’s column.</p> + </div> + + + + + + <div class="method-subsection discussion-section"> + <h4 class="method-subtitle">Discussion</h4> + <p>Result set <code>long long int</code> value for column.</p> + </div> + + + + + + + + <div class="method-subsection declared-in-section"> + <h4 class="method-subtitle">Declared In</h4> + <p><code class="declared-in-ref">FMResultSet.h</code></p> + </div> + + + </div> </div> - - - - - - - - - - - - <div class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMResultSet.h</code><br /> - </div> - - -</div> - - <div class="section-method"> - <a name="//api/name/columnIndexForName:" title="columnIndexForName:"></a> - <h3 class="subsubtitle method-title">columnIndexForName:</h3> - - - - <div class="method-subsection brief-description"> - <p>Column index for column name</p> - </div> - - +</div><div class="section-method"> + <a name="//api/name/unsignedLongLongIntForColumn:" title="unsignedLongLongIntForColumn:"></a> + <h3 class="method-title"><code><a href="#//api/name/unsignedLongLongIntForColumn:">– unsignedLongLongIntForColumn:</a></code> +</h3> - <div class="method-subsection method-declaration"><code>- (int)columnIndexForName:(NSString *)<em>columnName</em></code></div> + <div class="method-info"> + <div class="pointy-thing"></div> - - - <div class="method-subsection arguments-section parameters"> - <h4 class="method-subtitle parameter-title">Parameters</h4> - - <dl class="argument-def parameter-def"> - <dt><em>columnName</em></dt> - <dd><p><code>NSString</code> value of the name of the column.</p></dd> - </dl> - + <div class="method-info-container"> + + + <div class="method-subsection brief-description"> + <p>Result set <code>unsigned long long int</code> value for column.</p> + </div> + + + + <div class="method-subsection method-declaration"><code>- (unsigned long long int)unsignedLongLongIntForColumn:(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>unsigned long long int</code> value of the result set’s column.</p> + </div> + + + + + + <div class="method-subsection discussion-section"> + <h4 class="method-subtitle">Discussion</h4> + <p>Result set <code>unsigned long long int</code> value for column.</p> + </div> + + + + + + + + <div class="method-subsection declared-in-section"> + <h4 class="method-subtitle">Declared In</h4> + <p><code class="declared-in-ref">FMResultSet.h</code></p> + </div> + + + </div> </div> - - - - <div class="method-subsection return"> - <h4 class="method-subtitle parameter-title">Return Value</h4> - <p>Zero-based index for column.</p> +</div><div class="section-method"> + <a name="//api/name/unsignedLongLongIntForColumnIndex:" title="unsignedLongLongIntForColumnIndex:"></a> + <h3 class="method-title"><code><a href="#//api/name/unsignedLongLongIntForColumnIndex:">– unsignedLongLongIntForColumnIndex:</a></code> +</h3> + + <div class="method-info"> + <div class="pointy-thing"></div> + + <div class="method-info-container"> + + + <div class="method-subsection brief-description"> + <p>Result set <code>unsigned long long int</code> value for column.</p> + </div> + + + + <div class="method-subsection method-declaration"><code>- (unsigned long long int)unsignedLongLongIntForColumnIndex:(int)<em>columnIdx</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>columnIdx</code></th> + <td><p>Zero-based index for column.</p></td> + </tr> + + </table> + </div> + + + + <div class="method-subsection return"> + <h4 class="method-subtitle parameter-title">Return Value</h4> + <p><code>unsigned long long int</code> value of the result set’s column.</p> + </div> + + + + + + <div class="method-subsection discussion-section"> + <h4 class="method-subtitle">Discussion</h4> + <p>Result set <code>unsigned long long int</code> value for column.</p> + </div> + + + + + + + + <div class="method-subsection declared-in-section"> + <h4 class="method-subtitle">Declared In</h4> + <p><code class="declared-in-ref">FMResultSet.h</code></p> + </div> + + + </div> </div> - - - - - - - - - - - - <div class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMResultSet.h</code><br /> - </div> - - -</div> - - <div class="section-method"> - <a name="//api/name/columnIndexIsNull:" title="columnIndexIsNull:"></a> - <h3 class="subsubtitle method-title">columnIndexIsNull:</h3> - - - - <div class="method-subsection brief-description"> - <p>Is the column <code>NULL</code>?</p> - </div> - - +</div><div class="section-method"> + <a name="//api/name/boolForColumn:" title="boolForColumn:"></a> + <h3 class="method-title"><code><a href="#//api/name/boolForColumn:">– boolForColumn:</a></code> +</h3> - <div class="method-subsection method-declaration"><code>- (BOOL)columnIndexIsNull:(int)<em>columnIdx</em></code></div> + <div class="method-info"> + <div class="pointy-thing"></div> - - - <div class="method-subsection arguments-section parameters"> - <h4 class="method-subtitle parameter-title">Parameters</h4> - - <dl class="argument-def parameter-def"> - <dt><em>columnIdx</em></dt> - <dd><p>Zero-based index for column.</p></dd> - </dl> - + <div class="method-info-container"> + + + <div class="method-subsection brief-description"> + <p>Result set <code>BOOL</code> value for column.</p> + </div> + + + + <div class="method-subsection method-declaration"><code>- (BOOL)boolForColumn:(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>BOOL</code> value of the result set’s column.</p> + </div> + + + + + + <div class="method-subsection discussion-section"> + <h4 class="method-subtitle">Discussion</h4> + <p>Result set <code>BOOL</code> value for column.</p> + </div> + + + + + + + + <div class="method-subsection declared-in-section"> + <h4 class="method-subtitle">Declared In</h4> + <p><code class="declared-in-ref">FMResultSet.h</code></p> + </div> + + + </div> </div> - - - - <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> +</div><div class="section-method"> + <a name="//api/name/boolForColumnIndex:" title="boolForColumnIndex:"></a> + <h3 class="method-title"><code><a href="#//api/name/boolForColumnIndex:">– boolForColumnIndex:</a></code> +</h3> + + <div class="method-info"> + <div class="pointy-thing"></div> + + <div class="method-info-container"> + + + <div class="method-subsection brief-description"> + <p>Result set <code>BOOL</code> value for column.</p> + </div> + + + + <div class="method-subsection method-declaration"><code>- (BOOL)boolForColumnIndex:(int)<em>columnIdx</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>columnIdx</code></th> + <td><p>Zero-based index for column.</p></td> + </tr> + + </table> + </div> + + + + <div class="method-subsection return"> + <h4 class="method-subtitle parameter-title">Return Value</h4> + <p><code>BOOL</code> value of the result set’s column.</p> + </div> + + + + + + <div class="method-subsection discussion-section"> + <h4 class="method-subtitle">Discussion</h4> + <p>Result set <code>BOOL</code> value for column.</p> + </div> + + + + + + + + <div class="method-subsection declared-in-section"> + <h4 class="method-subtitle">Declared In</h4> + <p><code class="declared-in-ref">FMResultSet.h</code></p> + </div> + + + </div> </div> - - - - - - - - - - - - <div class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMResultSet.h</code><br /> - </div> - - -</div> - - <div class="section-method"> - <a name="//api/name/columnIsNull:" title="columnIsNull:"></a> - <h3 class="subsubtitle method-title">columnIsNull:</h3> - - - - <div class="method-subsection brief-description"> - <p>Is the column <code>NULL</code>?</p> - </div> - - +</div><div class="section-method"> + <a name="//api/name/doubleForColumn:" title="doubleForColumn:"></a> + <h3 class="method-title"><code><a href="#//api/name/doubleForColumn:">– doubleForColumn:</a></code> +</h3> - <div class="method-subsection method-declaration"><code>- (BOOL)columnIsNull:(NSString *)<em>columnName</em></code></div> + <div class="method-info"> + <div class="pointy-thing"></div> - - - <div class="method-subsection arguments-section parameters"> - <h4 class="method-subtitle parameter-title">Parameters</h4> - - <dl class="argument-def parameter-def"> - <dt><em>columnName</em></dt> - <dd><p><code>NSString</code> value of the name of the column.</p></dd> - </dl> - + <div class="method-info-container"> + + + <div class="method-subsection brief-description"> + <p>Result set <code>double</code> value for column.</p> + </div> + + + + <div class="method-subsection method-declaration"><code>- (double)doubleForColumn:(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>double</code> value of the result set’s column.</p> + </div> + + + + + + <div class="method-subsection discussion-section"> + <h4 class="method-subtitle">Discussion</h4> + <p>Result set <code>double</code> value for column.</p> + </div> + + + + + + + + <div class="method-subsection declared-in-section"> + <h4 class="method-subtitle">Declared In</h4> + <p><code class="declared-in-ref">FMResultSet.h</code></p> + </div> + + + </div> </div> - - - - <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> +</div><div class="section-method"> + <a name="//api/name/doubleForColumnIndex:" title="doubleForColumnIndex:"></a> + <h3 class="method-title"><code><a href="#//api/name/doubleForColumnIndex:">– doubleForColumnIndex:</a></code> +</h3> + + <div class="method-info"> + <div class="pointy-thing"></div> + + <div class="method-info-container"> + + + <div class="method-subsection brief-description"> + <p>Result set <code>double</code> value for column.</p> + </div> + + + + <div class="method-subsection method-declaration"><code>- (double)doubleForColumnIndex:(int)<em>columnIdx</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>columnIdx</code></th> + <td><p>Zero-based index for column.</p></td> + </tr> + + </table> + </div> + + + + <div class="method-subsection return"> + <h4 class="method-subtitle parameter-title">Return Value</h4> + <p><code>double</code> value of the result set’s column.</p> + </div> + + + + + + <div class="method-subsection discussion-section"> + <h4 class="method-subtitle">Discussion</h4> + <p>Result set <code>double</code> value for column.</p> + </div> + + + + + + + + <div class="method-subsection declared-in-section"> + <h4 class="method-subtitle">Declared In</h4> + <p><code class="declared-in-ref">FMResultSet.h</code></p> + </div> + + + </div> </div> - - - - - - - - - - - - <div class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMResultSet.h</code><br /> - </div> - - -</div> - - <div class="section-method"> - <a name="//api/name/columnNameForIndex:" title="columnNameForIndex:"></a> - <h3 class="subsubtitle method-title">columnNameForIndex:</h3> - - - - <div class="method-subsection brief-description"> - <p>Column name for column index</p> - </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> +</h3> - <div class="method-subsection method-declaration"><code>- (NSString *)columnNameForIndex:(int)<em>columnIdx</em></code></div> + <div class="method-info"> + <div class="pointy-thing"></div> - - - <div class="method-subsection arguments-section parameters"> - <h4 class="method-subtitle parameter-title">Parameters</h4> - - <dl class="argument-def parameter-def"> - <dt><em>columnIdx</em></dt> - <dd><p>Zero-based index for column.</p></dd> - </dl> - + <div class="method-info-container"> + + + <div class="method-subsection brief-description"> + <p>Result set <code>NSString</code> value for column.</p> + </div> + + + + <div class="method-subsection method-declaration"><code>- (NSString *)stringForColumnIndex:(int)<em>columnIdx</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>columnIdx</code></th> + <td><p>Zero-based index for column.</p></td> + </tr> + + </table> + </div> + + + + <div class="method-subsection return"> + <h4 class="method-subtitle parameter-title">Return Value</h4> + <p><code>NSString</code> value of the result set’s column.</p> + </div> + + + + + + <div class="method-subsection discussion-section"> + <h4 class="method-subtitle">Discussion</h4> + <p>Result set <code>NSString</code> value for column.</p> + </div> + + + + + + + + <div class="method-subsection declared-in-section"> + <h4 class="method-subtitle">Declared In</h4> + <p><code class="declared-in-ref">FMResultSet.h</code></p> + </div> + + + </div> </div> - - - - <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> +</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> +</h3> + + <div class="method-info"> + <div class="pointy-thing"></div> + + <div class="method-info-container"> + + + <div class="method-subsection brief-description"> + <p>Result set <code>NSString</code> value for column.</p> + </div> + + + + <div class="method-subsection method-declaration"><code>- (NSString *)stringForColumn:(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>NSString</code> value of the result set’s column.</p> + </div> + + + + + + <div class="method-subsection discussion-section"> + <h4 class="method-subtitle">Discussion</h4> + <p>Result set <code>NSString</code> value for column.</p> + </div> + + + + + + + + <div class="method-subsection declared-in-section"> + <h4 class="method-subtitle">Declared In</h4> + <p><code class="declared-in-ref">FMResultSet.h</code></p> + </div> + + + </div> </div> - - - - - - - - - - - - <div class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMResultSet.h</code><br /> - </div> - - -</div> - - <div class="section-method"> - <a name="//api/name/columnNameToIndexMap" title="columnNameToIndexMap"></a> - <h3 class="subsubtitle method-title">columnNameToIndexMap</h3> - - - - <div class="method-subsection brief-description"> - <p><code>NSMutableDictionary</code> mapping column names to numeric index</p> - </div> - - +</div><div class="section-method"> + <a name="//api/name/dateForColumn:" title="dateForColumn:"></a> + <h3 class="method-title"><code><a href="#//api/name/dateForColumn:">– dateForColumn:</a></code> +</h3> - <div class="method-subsection method-declaration"><code>- (NSMutableDictionary *)columnNameToIndexMap</code></div> + <div class="method-info"> + <div class="pointy-thing"></div> - - - - - - - - - - - - - - - <div class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMResultSet.h</code><br /> - </div> - - -</div> - - <div class="section-method"> - <a name="//api/name/dataForColumn:" title="dataForColumn:"></a> - <h3 class="subsubtitle method-title">dataForColumn:</h3> - - - - <div class="method-subsection brief-description"> - <p>Result set <code>NSData</code> value for column.</p> - </div> - - + <div class="method-info-container"> + + + <div class="method-subsection brief-description"> + <p>Result set <code>NSDate</code> value for column.</p> + </div> + + - <div class="method-subsection method-declaration"><code>- (NSData *)dataForColumn:(NSString *)<em>columnName</em></code></div> + <div class="method-subsection method-declaration"><code>- (NSDate *)dateForColumn:(NSString *)<em>columnName</em></code></div> - - - <div class="method-subsection arguments-section parameters"> - <h4 class="method-subtitle parameter-title">Parameters</h4> - - <dl class="argument-def parameter-def"> - <dt><em>columnName</em></dt> - <dd><p><code>NSString</code> value of the name of the column.</p></dd> - </dl> - + + + <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>NSDate</code> value of the result set’s column.</p> + </div> + + + + + + <div class="method-subsection discussion-section"> + <h4 class="method-subtitle">Discussion</h4> + <p>Result set <code>NSDate</code> value for column.</p> + </div> + + + + + + + + <div class="method-subsection declared-in-section"> + <h4 class="method-subtitle">Declared In</h4> + <p><code class="declared-in-ref">FMResultSet.h</code></p> + </div> + + + </div> </div> - - - - <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> +</div><div class="section-method"> + <a name="//api/name/dateForColumnIndex:" title="dateForColumnIndex:"></a> + <h3 class="method-title"><code><a href="#//api/name/dateForColumnIndex:">– dateForColumnIndex:</a></code> +</h3> + + <div class="method-info"> + <div class="pointy-thing"></div> + + <div class="method-info-container"> + + + <div class="method-subsection brief-description"> + <p>Result set <code>NSDate</code> value for column.</p> + </div> + + + + <div class="method-subsection method-declaration"><code>- (NSDate *)dateForColumnIndex:(int)<em>columnIdx</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>columnIdx</code></th> + <td><p>Zero-based index for column.</p></td> + </tr> + + </table> + </div> + + + + <div class="method-subsection return"> + <h4 class="method-subtitle parameter-title">Return Value</h4> + <p><code>NSDate</code> value of the result set’s column.</p> + </div> + + + + + + <div class="method-subsection discussion-section"> + <h4 class="method-subtitle">Discussion</h4> + <p>Result set <code>NSDate</code> value for column.</p> + </div> + + + + + + + + <div class="method-subsection declared-in-section"> + <h4 class="method-subtitle">Declared In</h4> + <p><code class="declared-in-ref">FMResultSet.h</code></p> + </div> + + + </div> </div> - - - - - - <div class="method-subsection discussion-section"> - <h4 class="method-subtitle">Discussion</h4> - <p>This is useful when storing binary data in table (such as image or the like).</p> +</div><div class="section-method"> + <a name="//api/name/dataForColumn:" title="dataForColumn:"></a> + <h3 class="method-title"><code><a href="#//api/name/dataForColumn:">– dataForColumn:</a></code> +</h3> + + <div class="method-info"> + <div class="pointy-thing"></div> + + <div class="method-info-container"> + + + <div class="method-subsection brief-description"> + <p>Result set <code>NSData</code> value for column.</p> + </div> + + + + <div class="method-subsection method-declaration"><code>- (NSData *)dataForColumn:(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>NSData</code> value of the result set’s column.</p> + </div> + + + + + + <div class="method-subsection discussion-section"> + <h4 class="method-subtitle">Discussion</h4> + <p>Result set <code>NSData</code> value for column.</p> + +<p>This is useful when storing binary data in table (such as image or the like).</p> + </div> + + + + + + + + <div class="method-subsection declared-in-section"> + <h4 class="method-subtitle">Declared In</h4> + <p><code class="declared-in-ref">FMResultSet.h</code></p> + </div> + + + </div> </div> - - - - - - - - <div class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMResultSet.h</code><br /> - </div> - - -</div> - - <div class="section-method"> +</div><div class="section-method"> <a name="//api/name/dataForColumnIndex:" title="dataForColumnIndex:"></a> - <h3 class="subsubtitle method-title">dataForColumnIndex:</h3> - - - - <div class="method-subsection brief-description"> - <p>Result set <code>NSData</code> value for column.</p> - </div> - - + <h3 class="method-title"><code><a href="#//api/name/dataForColumnIndex:">– dataForColumnIndex:</a></code> +</h3> - <div class="method-subsection method-declaration"><code>- (NSData *)dataForColumnIndex:(int)<em>columnIdx</em></code></div> + <div class="method-info"> + <div class="pointy-thing"></div> - - - <div class="method-subsection arguments-section parameters"> - <h4 class="method-subtitle parameter-title">Parameters</h4> - - <dl class="argument-def parameter-def"> - <dt><em>columnIdx</em></dt> - <dd><p>Zero-based index for column.</p></dd> - </dl> - - </div> - - - - <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> + <div class="method-info-container"> + + + <div class="method-subsection brief-description"> + <p>Result set <code>NSData</code> value for column.</p> + </div> + + + + <div class="method-subsection method-declaration"><code>- (NSData *)dataForColumnIndex:(int)<em>columnIdx</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>columnIdx</code></th> + <td><p>Zero-based index for column.</p></td> + </tr> + + </table> + </div> + + + + <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> + </div> + + + + + + <div class="method-subsection discussion-section"> + <h4 class="method-subtitle">Discussion</h4> + <p>Result set <code>NSData</code> value for column.</p> + </div> + + + + + + + + <div class="method-subsection declared-in-section"> + <h4 class="method-subtitle">Declared In</h4> + <p><code class="declared-in-ref">FMResultSet.h</code></p> + </div> + + + </div> </div> - - - - - - - - - - - - <div class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMResultSet.h</code><br /> - </div> - - -</div> - - <div class="section-method"> +</div><div class="section-method"> <a name="//api/name/dataNoCopyForColumn:" title="dataNoCopyForColumn:"></a> - <h3 class="subsubtitle method-title">dataNoCopyForColumn:</h3> - - - - <div class="method-subsection brief-description"> - <p>Result set <code>NSData</code> value for column.</p> - </div> - - + <h3 class="method-title"><code><a href="#//api/name/dataNoCopyForColumn:">– dataNoCopyForColumn:</a></code> +</h3> - <div class="method-subsection method-declaration"><code>- (NSData *)dataNoCopyForColumn:(NSString *)<em>columnName</em></code></div> + <div class="method-info"> + <div class="pointy-thing"></div> - - - <div class="method-subsection arguments-section parameters"> - <h4 class="method-subtitle parameter-title">Parameters</h4> - - <dl class="argument-def parameter-def"> - <dt><em>columnName</em></dt> - <dd><p><code>NSString</code> value of the name of the column.</p></dd> - </dl> - - </div> - - - - <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> - </div> - - - - - - <div class="method-subsection discussion-section"> - <h4 class="method-subtitle">Discussion</h4> - <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 + <div class="method-info-container"> + + + <div class="method-subsection brief-description"> + <p>Result set <code>NSData</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 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>NSData</code> value of the result set’s column.</p> + </div> + + + + + + <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> + </div> + + + + + + + + <div class="method-subsection declared-in-section"> + <h4 class="method-subtitle">Declared In</h4> + <p><code class="declared-in-ref">FMResultSet.h</code></p> + </div> + + + </div> </div> - - - - - - - - <div class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMResultSet.h</code><br /> - </div> - - -</div> - - <div class="section-method"> +</div><div class="section-method"> <a name="//api/name/dataNoCopyForColumnIndex:" title="dataNoCopyForColumnIndex:"></a> - <h3 class="subsubtitle method-title">dataNoCopyForColumnIndex:</h3> - - - - <div class="method-subsection brief-description"> - <p>Result set <code>NSData</code> value for column.</p> - </div> - - + <h3 class="method-title"><code><a href="#//api/name/dataNoCopyForColumnIndex:">– dataNoCopyForColumnIndex:</a></code> +</h3> - <div class="method-subsection method-declaration"><code>- (NSData *)dataNoCopyForColumnIndex:(int)<em>columnIdx</em></code></div> + <div class="method-info"> + <div class="pointy-thing"></div> - - - <div class="method-subsection arguments-section parameters"> - <h4 class="method-subtitle parameter-title">Parameters</h4> - - <dl class="argument-def parameter-def"> - <dt><em>columnIdx</em></dt> - <dd><p>Zero-based index for column.</p></dd> - </dl> - - </div> - - - - <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> - </div> - - - - - - <div class="method-subsection discussion-section"> - <h4 class="method-subtitle">Discussion</h4> - <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 + <div class="method-info-container"> + + + <div class="method-subsection brief-description"> + <p>Result set <code>NSData</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 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>columnIdx</code></th> + <td><p>Zero-based index for column.</p></td> + </tr> + + </table> + </div> + + + + <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> + </div> + + + + + + <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> - </div> - - - - - - - - <div class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMResultSet.h</code><br /> - </div> - - -</div> - - <div class="section-method"> - <a name="//api/name/dateForColumn:" title="dateForColumn:"></a> - <h3 class="subsubtitle method-title">dateForColumn:</h3> - - - - <div class="method-subsection brief-description"> - <p>Result set <code>NSDate</code> value for column.</p> - </div> - - + </div> + - <div class="method-subsection method-declaration"><code>- (NSDate *)dateForColumn:(NSString *)<em>columnName</em></code></div> + - - - <div class="method-subsection arguments-section parameters"> - <h4 class="method-subtitle parameter-title">Parameters</h4> - - <dl class="argument-def parameter-def"> - <dt><em>columnName</em></dt> - <dd><p><code>NSString</code> value of the name of the column.</p></dd> - </dl> - - </div> - - - - <div class="method-subsection return"> - <h4 class="method-subtitle parameter-title">Return Value</h4> - <p><code>NSDate</code> value of the result set’s column.</p> + + + + <div class="method-subsection declared-in-section"> + <h4 class="method-subtitle">Declared In</h4> + <p><code class="declared-in-ref">FMResultSet.h</code></p> + </div> + + + </div> </div> - - - - - - - - - - - - <div class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMResultSet.h</code><br /> - </div> - - -</div> - - <div class="section-method"> - <a name="//api/name/dateForColumnIndex:" title="dateForColumnIndex:"></a> - <h3 class="subsubtitle method-title">dateForColumnIndex:</h3> - - - - <div class="method-subsection brief-description"> - <p>Result set <code>NSDate</code> value for column.</p> - </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> +</h3> - <div class="method-subsection method-declaration"><code>- (NSDate *)dateForColumnIndex:(int)<em>columnIdx</em></code></div> + <div class="method-info"> + <div class="pointy-thing"></div> - - - <div class="method-subsection arguments-section parameters"> - <h4 class="method-subtitle parameter-title">Parameters</h4> - - <dl class="argument-def parameter-def"> - <dt><em>columnIdx</em></dt> - <dd><p>Zero-based index for column.</p></dd> - </dl> - - </div> - - - - <div class="method-subsection return"> - <h4 class="method-subtitle parameter-title">Return Value</h4> - <p><code>NSDate</code> value of the result set’s column.</p> - </div> - - - - - - - - - - - - <div class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMResultSet.h</code><br /> - </div> - - -</div> - - <div class="section-method"> - <a name="//api/name/doubleForColumn:" title="doubleForColumn:"></a> - <h3 class="subsubtitle method-title">doubleForColumn:</h3> - - - - <div class="method-subsection brief-description"> - <p>Result set <code>double</code> value for column.</p> - </div> - - + <div class="method-info-container"> + + + <div class="method-subsection brief-description"> + <p>Is the column <code>NULL</code>?</p> + </div> + + - <div class="method-subsection method-declaration"><code>- (double)doubleForColumn:(NSString *)<em>columnName</em></code></div> + <div class="method-subsection method-declaration"><code>- (BOOL)columnIndexIsNull:(int)<em>columnIdx</em></code></div> - - - <div class="method-subsection arguments-section parameters"> - <h4 class="method-subtitle parameter-title">Parameters</h4> - - <dl class="argument-def parameter-def"> - <dt><em>columnName</em></dt> - <dd><p><code>NSString</code> value of the name of the column.</p></dd> - </dl> - - </div> - - - - <div class="method-subsection return"> - <h4 class="method-subtitle parameter-title">Return Value</h4> - <p><code>double</code> value of the result set’s column.</p> - </div> - - - - - - - - - - - - <div class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMResultSet.h</code><br /> - </div> - - -</div> - - <div class="section-method"> - <a name="//api/name/doubleForColumnIndex:" title="doubleForColumnIndex:"></a> - <h3 class="subsubtitle method-title">doubleForColumnIndex:</h3> - - - - <div class="method-subsection brief-description"> - <p>Result set <code>double</code> value for column.</p> - </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>columnIdx</code></th> + <td><p>Zero-based index for column.</p></td> + </tr> + + </table> + </div> + - <div class="method-subsection method-declaration"><code>- (double)doubleForColumnIndex:(int)<em>columnIdx</em></code></div> + + <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> + </div> + - - - <div class="method-subsection arguments-section parameters"> - <h4 class="method-subtitle parameter-title">Parameters</h4> - - <dl class="argument-def parameter-def"> - <dt><em>columnIdx</em></dt> - <dd><p>Zero-based index for column.</p></dd> - </dl> - - </div> - - - - <div class="method-subsection return"> - <h4 class="method-subtitle parameter-title">Return Value</h4> - <p><code>double</code> value of the result set’s column.</p> - </div> - - - - - - - - - - - - <div class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMResultSet.h</code><br /> - </div> - - -</div> - - <div class="section-method"> - <a name="//api/name/hasAnotherRow" title="hasAnotherRow"></a> - <h3 class="subsubtitle method-title">hasAnotherRow</h3> - - - - <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> - </div> - - + - <div class="method-subsection method-declaration"><code>- (BOOL)hasAnotherRow</code></div> + + <div class="method-subsection discussion-section"> + <h4 class="method-subtitle">Discussion</h4> + <p>Is the column <code>NULL</code>?</p> + </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> - </div> - - - - - - <div class="method-subsection discussion-section"> - <h4 class="method-subtitle">Discussion</h4> - <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> - - - - - - <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> + + + + + <div class="method-subsection declared-in-section"> + <h4 class="method-subtitle">Declared In</h4> + <p><code class="declared-in-ref">FMResultSet.h</code></p> + </div> + - </ul> + </div> </div> - - - - <div class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMResultSet.h</code><br /> - </div> - - -</div> - - <div class="section-method"> - <a name="//api/name/intForColumn:" title="intForColumn:"></a> - <h3 class="subsubtitle method-title">intForColumn:</h3> - - - - <div class="method-subsection brief-description"> - <p>Result set integer value for column.</p> - </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> +</h3> - <div class="method-subsection method-declaration"><code>- (int)intForColumn:(NSString *)<em>columnName</em></code></div> + <div class="method-info"> + <div class="pointy-thing"></div> - - - <div class="method-subsection arguments-section parameters"> - <h4 class="method-subtitle parameter-title">Parameters</h4> - - <dl class="argument-def parameter-def"> - <dt><em>columnName</em></dt> - <dd><p><code>NSString</code> value of the name of the column.</p></dd> - </dl> - - </div> - - - - <div class="method-subsection return"> - <h4 class="method-subtitle parameter-title">Return Value</h4> - <p><code>int</code> value of the result set’s column.</p> - </div> - - - - - - - - - - - - <div class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMResultSet.h</code><br /> - </div> - - -</div> - - <div class="section-method"> - <a name="//api/name/intForColumnIndex:" title="intForColumnIndex:"></a> - <h3 class="subsubtitle method-title">intForColumnIndex:</h3> - - - - <div class="method-subsection brief-description"> - <p>Result set integer value for column.</p> - </div> - - + <div class="method-info-container"> + + + <div class="method-subsection brief-description"> + <p>Is the column <code>NULL</code>?</p> + </div> + + - <div class="method-subsection method-declaration"><code>- (int)intForColumnIndex:(int)<em>columnIdx</em></code></div> + <div class="method-subsection method-declaration"><code>- (BOOL)columnIsNull:(NSString *)<em>columnName</em></code></div> - - - <div class="method-subsection arguments-section parameters"> - <h4 class="method-subtitle parameter-title">Parameters</h4> - - <dl class="argument-def parameter-def"> - <dt><em>columnIdx</em></dt> - <dd><p>Zero-based index for column.</p></dd> - </dl> - - </div> - - - - <div class="method-subsection return"> - <h4 class="method-subtitle parameter-title">Return Value</h4> - <p><code>int</code> value of the result set’s column.</p> - </div> - - - - - - - - - - - - <div class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMResultSet.h</code><br /> - </div> - - -</div> - - <div class="section-method"> - <a name="//api/name/kvcMagic:" title="kvcMagic:"></a> - <h3 class="subsubtitle method-title">kvcMagic:</h3> - - - - <div class="method-subsection brief-description"> - <p>Performs <code>setValue</code> to yield support for key value observing.</p> - </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 method-declaration"><code>- (void)kvcMagic:(id)<em>object</em></code></div> + + <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> + </div> + - - - <div class="method-subsection arguments-section parameters"> - <h4 class="method-subtitle parameter-title">Parameters</h4> - - <dl class="argument-def parameter-def"> - <dt><em>object</em></dt> - <dd><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></dd> - </dl> - - </div> - - - - - - - - - - - - - - <div class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMResultSet.h</code><br /> - </div> - - -</div> - - <div class="section-method"> - <a name="//api/name/longForColumn:" title="longForColumn:"></a> - <h3 class="subsubtitle method-title">longForColumn:</h3> - - - - <div class="method-subsection brief-description"> - <p>Result set <code>long</code> value for column.</p> - </div> - - + - <div class="method-subsection method-declaration"><code>- (long)longForColumn:(NSString *)<em>columnName</em></code></div> + + <div class="method-subsection discussion-section"> + <h4 class="method-subtitle">Discussion</h4> + <p>Is the column <code>NULL</code>?</p> + </div> + - - - <div class="method-subsection arguments-section parameters"> - <h4 class="method-subtitle parameter-title">Parameters</h4> - - <dl class="argument-def parameter-def"> - <dt><em>columnName</em></dt> - <dd><p><code>NSString</code> value of the name of the column.</p></dd> - </dl> - - </div> - - - - <div class="method-subsection return"> - <h4 class="method-subtitle parameter-title">Return Value</h4> - <p><code>long</code> value of the result set’s column.</p> - </div> - - - - - - - - - - - - <div class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMResultSet.h</code><br /> - </div> - - -</div> - - <div class="section-method"> - <a name="//api/name/longForColumnIndex:" title="longForColumnIndex:"></a> - <h3 class="subsubtitle method-title">longForColumnIndex:</h3> - - - - <div class="method-subsection brief-description"> - <p>Result set long value for column.</p> - </div> - - + - <div class="method-subsection method-declaration"><code>- (long)longForColumnIndex:(int)<em>columnIdx</em></code></div> + - - - <div class="method-subsection arguments-section parameters"> - <h4 class="method-subtitle parameter-title">Parameters</h4> - - <dl class="argument-def parameter-def"> - <dt><em>columnIdx</em></dt> - <dd><p>Zero-based index for column.</p></dd> - </dl> - - </div> - - - - <div class="method-subsection return"> - <h4 class="method-subtitle parameter-title">Return Value</h4> - <p><code>long</code> value of the result set’s column.</p> + + <div class="method-subsection declared-in-section"> + <h4 class="method-subtitle">Declared In</h4> + <p><code class="declared-in-ref">FMResultSet.h</code></p> + </div> + + + </div> </div> - - - - - - - - - - - - <div class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMResultSet.h</code><br /> - </div> - - -</div> - - <div class="section-method"> - <a name="//api/name/longLongIntForColumn:" title="longLongIntForColumn:"></a> - <h3 class="subsubtitle method-title">longLongIntForColumn:</h3> - - - - <div class="method-subsection brief-description"> - <p>Result set <code>long long int</code> value for column.</p> - </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> +</h3> - <div class="method-subsection method-declaration"><code>- (long long int)longLongIntForColumn:(NSString *)<em>columnName</em></code></div> + <div class="method-info"> + <div class="pointy-thing"></div> - - - <div class="method-subsection arguments-section parameters"> - <h4 class="method-subtitle parameter-title">Parameters</h4> - - <dl class="argument-def parameter-def"> - <dt><em>columnName</em></dt> - <dd><p><code>NSString</code> value of the name of the column.</p></dd> - </dl> - - </div> - - - - <div class="method-subsection return"> - <h4 class="method-subtitle parameter-title">Return Value</h4> - <p><code>long long int</code> value of the result set’s column.</p> - </div> - - - - - - - - - - - - <div class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMResultSet.h</code><br /> - </div> - - -</div> - - <div class="section-method"> - <a name="//api/name/longLongIntForColumnIndex:" title="longLongIntForColumnIndex:"></a> - <h3 class="subsubtitle method-title">longLongIntForColumnIndex:</h3> - - - - <div class="method-subsection brief-description"> - <p>Result set <code>long long int</code> value for column.</p> - </div> - - + <div class="method-info-container"> + + + <div class="method-subsection brief-description"> + <p>Result set <code>(const unsigned char *)</code> value for column.</p> + </div> + + - <div class="method-subsection method-declaration"><code>- (long long int)longLongIntForColumnIndex:(int)<em>columnIdx</em></code></div> + <div class="method-subsection method-declaration"><code>- (const unsigned char *)UTF8StringForColumnIndex:(int)<em>columnIdx</em></code></div> - - - <div class="method-subsection arguments-section parameters"> - <h4 class="method-subtitle parameter-title">Parameters</h4> - - <dl class="argument-def parameter-def"> - <dt><em>columnIdx</em></dt> - <dd><p>Zero-based index for column.</p></dd> - </dl> - + + + <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>columnIdx</code></th> + <td><p>Zero-based index for column.</p></td> + </tr> + + </table> + </div> + + + + <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> + </div> + + + + + + <div class="method-subsection discussion-section"> + <h4 class="method-subtitle">Discussion</h4> + <p>Result set <code>(const unsigned char *)</code> value for column.</p> + </div> + + + + + + + + <div class="method-subsection declared-in-section"> + <h4 class="method-subtitle">Declared In</h4> + <p><code class="declared-in-ref">FMResultSet.h</code></p> + </div> + + + </div> </div> - - - - <div class="method-subsection return"> - <h4 class="method-subtitle parameter-title">Return Value</h4> - <p><code>long long int</code> value of the result set’s column.</p> +</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> +</h3> + + <div class="method-info"> + <div class="pointy-thing"></div> + + <div class="method-info-container"> + + + <div class="method-subsection brief-description"> + <p>Result set <code>(const unsigned char *)</code> value 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 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>(const unsigned char *)</code> value of the result set’s column.</p> + </div> + + + + + + <div class="method-subsection discussion-section"> + <h4 class="method-subtitle">Discussion</h4> + <p>Result set <code>(const unsigned char *)</code> value for column.</p> + </div> + + + + + + + + <div class="method-subsection declared-in-section"> + <h4 class="method-subtitle">Declared In</h4> + <p><code class="declared-in-ref">FMResultSet.h</code></p> + </div> + + + </div> </div> - - - - - - - - - - - - <div class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMResultSet.h</code><br /> - </div> - - -</div> - - <div class="section-method"> - <a name="//api/name/next" title="next"></a> - <h3 class="subsubtitle method-title">next</h3> - - - - <div class="method-subsection brief-description"> - <p>Retrieve next row for result set.</p> - </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> +</h3> - <div class="method-subsection method-declaration"><code>- (BOOL)next</code></div> + <div class="method-info"> + <div class="pointy-thing"></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 class="method-info-container"> + + + <div class="method-subsection brief-description"> + <p>Result set object for column.</p> + </div> + + + + <div class="method-subsection method-declaration"><code>- (id)objectForColumnIndex:(int)<em>columnIdx</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>columnIdx</code></th> + <td><p>Zero-based index for 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> + </div> + + + + + + <div class="method-subsection discussion-section"> + <h4 class="method-subtitle">Discussion</h4> + <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"> + <h4 class="method-subtitle">Declared In</h4> + <p><code class="declared-in-ref">FMResultSet.h</code></p> + </div> + + + </div> </div> - - - - - - <div class="method-subsection discussion-section"> - <h4 class="method-subtitle">Discussion</h4> - <p>You must always invoke <code>next</code> before attempting to access the values returned in a query, even if you’re only expecting one.</p> +</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> +</h3> + + <div class="method-info"> + <div class="pointy-thing"></div> + + <div class="method-info-container"> + + + <div class="method-subsection brief-description"> + <p>Result set object for column.</p> + </div> + + + + <div class="method-subsection method-declaration"><code>- (id)objectForColumnName:(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>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> + + + + + + <div class="method-subsection discussion-section"> + <h4 class="method-subtitle">Discussion</h4> + <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"> + <h4 class="method-subtitle">Declared In</h4> + <p><code class="declared-in-ref">FMResultSet.h</code></p> + </div> + + + </div> </div> - - - - - - <div class="method-subsection see-also-section"> - <h4 class="method-subtitle">See Also</h4> - <ul> +</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> +</h3> + + <div class="method-info"> + <div class="pointy-thing"></div> + + <div class="method-info-container"> + + + <div class="method-subsection brief-description"> + <p>Column name for column index</p> + </div> + + + + <div class="method-subsection method-declaration"><code>- (NSString *)columnNameForIndex:(int)<em>columnIdx</em></code></div> + + - <li><code><p><a href="#//api/name/hasAnotherRow">- hasAnotherRow</a></p></code></li> + <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>columnIdx</code></th> + <td><p>Zero-based index for column.</p></td> + </tr> + + </table> + </div> + + + + <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> + </div> + + + + + + <div class="method-subsection discussion-section"> + <h4 class="method-subtitle">Discussion</h4> + <p>Column name for column index</p> + </div> + + + + + + + + <div class="method-subsection declared-in-section"> + <h4 class="method-subtitle">Declared In</h4> + <p><code class="declared-in-ref">FMResultSet.h</code></p> + </div> - </ul> + + </div> </div> - - - - <div class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMResultSet.h</code><br /> - </div> - - -</div> - - <div class="section-method"> +</div><div class="section-method"> <a name="//api/name/objectAtIndexedSubscript:" title="objectAtIndexedSubscript:"></a> - <h3 class="subsubtitle method-title">objectAtIndexedSubscript:</h3> - - - - <div class="method-subsection brief-description"> - <p>Result set object for column.</p> - </div> - - + <h3 class="method-title"><code><a href="#//api/name/objectAtIndexedSubscript:">– objectAtIndexedSubscript:</a></code> +</h3> - <div class="method-subsection method-declaration"><code>- (id)objectAtIndexedSubscript:(int)<em>columnIdx</em></code></div> + <div class="method-info"> + <div class="pointy-thing"></div> - - - <div class="method-subsection arguments-section parameters"> - <h4 class="method-subtitle parameter-title">Parameters</h4> - - <dl class="argument-def parameter-def"> - <dt><em>columnIdx</em></dt> - <dd><p>Zero-based index for column.</p></dd> - </dl> - - </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> - </div> - - - - - - <div class="method-subsection discussion-section"> - <h4 class="method-subtitle">Discussion</h4> - <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> + <div class="method-info-container"> + + + <div class="method-subsection brief-description"> + <p>Result set object for column.</p> + </div> + + + + <div class="method-subsection method-declaration"><code>- (id)objectAtIndexedSubscript:(int)<em>columnIdx</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>columnIdx</code></th> + <td><p>Zero-based index for 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> + </div> + + + + + + <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> @@ -2227,182 +2629,71 @@ If you don’t, you’re going to be in a world of hurt when you try and <pre><code>id result = [rs objectForColumnName:0]; </code></pre> - </div> - - - - - - - - <div class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMResultSet.h</code><br /> - </div> - - -</div> - - <div class="section-method"> - <a name="//api/name/objectForColumnIndex:" title="objectForColumnIndex:"></a> - <h3 class="subsubtitle method-title">objectForColumnIndex:</h3> - - - - <div class="method-subsection brief-description"> - <p>Result set object for column.</p> - </div> - - + </div> + - <div class="method-subsection method-declaration"><code>- (id)objectForColumnIndex:(int)<em>columnIdx</em></code></div> + - - - <div class="method-subsection arguments-section parameters"> - <h4 class="method-subtitle parameter-title">Parameters</h4> - - <dl class="argument-def parameter-def"> - <dt><em>columnIdx</em></dt> - <dd><p>Zero-based index for column.</p></dd> - </dl> - - </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> - </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> + + + <div class="method-subsection declared-in-section"> + <h4 class="method-subtitle">Declared In</h4> + <p><code class="declared-in-ref">FMResultSet.h</code></p> + </div> - </ul> + + </div> </div> - - - - <div class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMResultSet.h</code><br /> - </div> - - -</div> - - <div class="section-method"> - <a name="//api/name/objectForColumnName:" title="objectForColumnName:"></a> - <h3 class="subsubtitle method-title">objectForColumnName:</h3> - - - - <div class="method-subsection brief-description"> - <p>Result set object for column.</p> - </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> +</h3> - <div class="method-subsection method-declaration"><code>- (id)objectForColumnName:(NSString *)<em>columnName</em></code></div> + <div class="method-info"> + <div class="pointy-thing"></div> - - - <div class="method-subsection arguments-section parameters"> - <h4 class="method-subtitle parameter-title">Parameters</h4> - - <dl class="argument-def parameter-def"> - <dt><em>columnName</em></dt> - <dd><p><code>NSString</code> value of the name of the column.</p></dd> - </dl> - - </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> - </div> - - - - - - - - - - <div class="method-subsection see-also-section"> - <h4 class="method-subtitle">See Also</h4> - <ul> + <div class="method-info-container"> - <li><code><p><a href="#//api/name/objectForKeyedSubscript:">- objectForKeyedSubscript:</a></p></code></li> - </ul> - </div> - - - - <div class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMResultSet.h</code><br /> - </div> - - -</div> - - <div class="section-method"> - <a name="//api/name/objectForKeyedSubscript:" title="objectForKeyedSubscript:"></a> - <h3 class="subsubtitle method-title">objectForKeyedSubscript:</h3> - - - - <div class="method-subsection brief-description"> - <p>Result set object for column.</p> - </div> - - + <div class="method-subsection brief-description"> + <p>Result set object for column.</p> + </div> + + - <div class="method-subsection method-declaration"><code>- (id)objectForKeyedSubscript:(NSString *)<em>columnName</em></code></div> + <div class="method-subsection method-declaration"><code>- (id)objectForKeyedSubscript:(NSString *)<em>columnName</em></code></div> - - - <div class="method-subsection arguments-section parameters"> - <h4 class="method-subtitle parameter-title">Parameters</h4> - - <dl class="argument-def parameter-def"> - <dt><em>columnName</em></dt> - <dd><p><code>NSString</code> value of the name of the column.</p></dd> - </dl> - - </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> - </div> - - - - - - <div class="method-subsection discussion-section"> - <h4 class="method-subtitle">Discussion</h4> - <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> + + + <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> + </div> + + + + + + <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> @@ -2416,433 +2707,146 @@ If you don’t, you’re going to be in a world of hurt when you try and <pre><code>id result = [rs objectForColumnName:@"employee_name"]; </code></pre> - </div> - - - - - - - - <div class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMResultSet.h</code><br /> - </div> - - -</div> - - <div class="section-method"> - <a name="//api/name/resultDict" title="resultDict"></a> - <h3 class="subsubtitle method-title">resultDict</h3> - - - - <div class="method-subsection brief-description"> - <p>Returns a dictionary of the row results</p> - </div> - - + </div> + - <div class="method-subsection method-declaration"><code>- (NSDictionary *)resultDict</code></div> + - - - - - - - - - <div class="method-subsection discussion-section"> - <h4 class="method-subtitle">Discussion</h4> - <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> + + + <div class="method-subsection declared-in-section"> + <h4 class="method-subtitle">Declared In</h4> + <p><code class="declared-in-ref">FMResultSet.h</code></p> + </div> - </ul> + + </div> </div> - - - - <div class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMResultSet.h</code><br /> - </div> - - </div> + </div> - <div class="section-method"> - <a name="//api/name/resultDictionary" title="resultDictionary"></a> - <h3 class="subsubtitle method-title">resultDictionary</h3> - - - - <div class="method-subsection brief-description"> - <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>- (NSDictionary *)resultDictionary</code></div> + <a title="Properties" name="task_Properties"></a> + <h2 class="task-title">Properties</h2> - - - - - <div class="method-subsection return"> - <h4 class="method-subtitle parameter-title">Return Value</h4> - <p><code>NSDictionary</code> of the row results.</p> - </div> - - - - - - <div class="method-subsection discussion-section"> - <h4 class="method-subtitle">Discussion</h4> - <div class="warning"><p><strong>Warning:</strong> The keys to the dictionary are case sensitive of the column names.</p></div> - </div> - - - - - - - - <div class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMResultSet.h</code><br /> - </div> - - -</div> - - <div class="section-method"> - <a name="//api/name/stringForColumn:" title="stringForColumn:"></a> - <h3 class="subsubtitle method-title">stringForColumn:</h3> - - - - <div class="method-subsection brief-description"> - <p>Result set <code>NSString</code> value for column.</p> - </div> - - + <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> +</h3> - <div class="method-subsection method-declaration"><code>- (NSString *)stringForColumn:(NSString *)<em>columnName</em></code></div> + <div class="method-info"> + <div class="pointy-thing"></div> - - - <div class="method-subsection arguments-section parameters"> - <h4 class="method-subtitle parameter-title">Parameters</h4> - - <dl class="argument-def parameter-def"> - <dt><em>columnName</em></dt> - <dd><p><code>NSString</code> value of the name of the column.</p></dd> - </dl> - - </div> - - - - <div class="method-subsection return"> - <h4 class="method-subtitle parameter-title">Return Value</h4> - <p><code>NSString</code> value of the result set’s column.</p> - </div> - - - - - - - - - - - - <div class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMResultSet.h</code><br /> - </div> - - -</div> - - <div class="section-method"> - <a name="//api/name/stringForColumnIndex:" title="stringForColumnIndex:"></a> - <h3 class="subsubtitle method-title">stringForColumnIndex:</h3> - - - - <div class="method-subsection brief-description"> - <p>Result set <code>NSString</code> value for column.</p> - </div> - - + <div class="method-info-container"> + + + <div class="method-subsection brief-description"> + <p>Executed query</p> + </div> + + - <div class="method-subsection method-declaration"><code>- (NSString *)stringForColumnIndex:(int)<em>columnIdx</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> - - <dl class="argument-def parameter-def"> - <dt><em>columnIdx</em></dt> - <dd><p>Zero-based index for column.</p></dd> - </dl> - - </div> - - - - <div class="method-subsection return"> - <h4 class="method-subtitle parameter-title">Return Value</h4> - <p><code>NSString</code> value of the result set’s column.</p> - </div> - - - - - - - - - - - - <div class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMResultSet.h</code><br /> - </div> - - -</div> - - <div class="section-method"> - <a name="//api/name/unsignedLongLongIntForColumn:" title="unsignedLongLongIntForColumn:"></a> - <h3 class="subsubtitle method-title">unsignedLongLongIntForColumn:</h3> - - - - <div class="method-subsection brief-description"> - <p>Result set <code>unsigned long long int</code> value for column.</p> - </div> - - + + - <div class="method-subsection method-declaration"><code>- (unsigned long long int)unsignedLongLongIntForColumn:(NSString *)<em>columnName</em></code></div> + - - - <div class="method-subsection arguments-section parameters"> - <h4 class="method-subtitle parameter-title">Parameters</h4> - - <dl class="argument-def parameter-def"> - <dt><em>columnName</em></dt> - <dd><p><code>NSString</code> value of the name of the column.</p></dd> - </dl> - - </div> - - - - <div class="method-subsection return"> - <h4 class="method-subtitle parameter-title">Return Value</h4> - <p><code>unsigned long long int</code> value of the result set’s column.</p> - </div> - - - - - - - - - - - - <div class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMResultSet.h</code><br /> - </div> - - -</div> - - <div class="section-method"> - <a name="//api/name/unsignedLongLongIntForColumnIndex:" title="unsignedLongLongIntForColumnIndex:"></a> - <h3 class="subsubtitle method-title">unsignedLongLongIntForColumnIndex:</h3> - - - - <div class="method-subsection brief-description"> - <p>Result set <code>unsigned long long int</code> value for column.</p> - </div> - - + - <div class="method-subsection method-declaration"><code>- (unsigned long long int)unsignedLongLongIntForColumnIndex:(int)<em>columnIdx</em></code></div> + + <div class="method-subsection discussion-section"> + <h4 class="method-subtitle">Discussion</h4> + <p>Executed query</p> + </div> + - - - <div class="method-subsection arguments-section parameters"> - <h4 class="method-subtitle parameter-title">Parameters</h4> - - <dl class="argument-def parameter-def"> - <dt><em>columnIdx</em></dt> - <dd><p>Zero-based index for column.</p></dd> - </dl> - + + + + + + <div class="method-subsection declared-in-section"> + <h4 class="method-subtitle">Declared In</h4> + <p><code class="declared-in-ref">FMResultSet.h</code></p> + </div> + + + </div> </div> - - - - <div class="method-subsection return"> - <h4 class="method-subtitle parameter-title">Return Value</h4> - <p><code>unsigned long long int</code> value of the result set’s column.</p> +</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> +</h3> + + <div class="method-info"> + <div class="pointy-thing"></div> + + <div class="method-info-container"> + + + <div class="method-subsection brief-description"> + <p><code>FMStatement</code> used by result set.</p> + </div> + + + + <div class="method-subsection method-declaration"><code>@property (atomic, retain) FMStatement *statement</code></div> + + + + + + + + + + <div class="method-subsection discussion-section"> + <h4 class="method-subtitle">Discussion</h4> + <p><code>FMStatement</code> used by result set.</p> + </div> + + + + + + + + <div class="method-subsection declared-in-section"> + <h4 class="method-subtitle">Declared In</h4> + <p><code class="declared-in-ref">FMResultSet.h</code></p> + </div> + + + </div> </div> - - - - - - - - - - - - <div class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMResultSet.h</code><br /> - </div> - - </div> + </div> </div> - </div> - <div class="main-navigation navigation-bottom"> - <ul> - <li><a href="../index.html">Index</a></li> - <li><a href="../hierarchy.html">Hierarchy</a></li> -</ul> - </div> - <div id="footer"> - <hr /> + + + </main> + + <footer> <div class="footer-copyright"> - <p><span class="copyright">© 2014 ccgus. All rights reserved. (Last updated: 2014-05-25)</span><br /> - <span class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.1 (build 858)</a>.</span></p> + <p class="copyright">Copyright © 2015 ccgus. All rights reserved. Updated: 2015-01-25</p> + + + <p class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.2.1 (build 1333)</a>.</p> </div> - </div> - </div> - </article> - <script type="text/javascript"> - function jumpToChange() - { - window.location.hash = this.options[this.selectedIndex].value; - } - - function toggleTOC() - { - var contents = document.getElementById('contents'); - var tocContainer = document.getElementById('tocContainer'); - - if (this.getAttribute('class') == 'open') - { - this.setAttribute('class', ''); - contents.setAttribute('class', ''); - tocContainer.setAttribute('class', ''); - - window.name = "hideTOC"; - } - else - { - this.setAttribute('class', 'open'); - contents.setAttribute('class', 'isShowingTOC'); - tocContainer.setAttribute('class', 'isShowingTOC'); - - window.name = ""; - } - return false; - } - - function toggleTOCEntryChildren(e) - { - e.stopPropagation(); - var currentClass = this.getAttribute('class'); - if (currentClass == 'children') { - this.setAttribute('class', 'children open'); - } - else if (currentClass == 'children open') { - this.setAttribute('class', 'children'); - } - return false; - } - - function tocEntryClick(e) - { - e.stopPropagation(); - return true; - } - - function init() - { - var selectElement = document.getElementById('jumpTo'); - selectElement.addEventListener('change', jumpToChange, false); - - var tocButton = document.getElementById('table_of_contents'); - tocButton.addEventListener('click', toggleTOC, false); - - var taskTreeItem = document.getElementById('task_treeitem'); - if (taskTreeItem.getElementsByTagName('li').length > 0) - { - taskTreeItem.setAttribute('class', 'children'); - taskTreeItem.firstChild.setAttribute('class', 'disclosure'); - } - - var tocList = document.getElementById('toc'); - - var tocEntries = tocList.getElementsByTagName('li'); - for (var i = 0; i < tocEntries.length; i++) { - tocEntries[i].addEventListener('click', toggleTOCEntryChildren, false); - } - - var tocLinks = tocList.getElementsByTagName('a'); - for (var i = 0; i < tocLinks.length; i++) { - tocLinks[i].addEventListener('click', tocEntryClick, false); - } - - if (window.name == "hideTOC") { - toggleTOC.call(tocButton); - } - } - - window.onload = init; - - // If showing in Xcode, hide the TOC and Header - if (navigator.userAgent.match(/xcode/i)) { - document.getElementById("contents").className = "hideInXcode" - document.getElementById("tocContainer").className = "hideInXcode" - document.getElementById("top_header").className = "hideInXcode" - } - - </script> - </body> + </footer> + </div> + </div> + </article> + + <script src="../js/script.js"></script> +</body> </html>
\ No newline at end of file diff --git a/html/Classes/FMStatement.html b/html/Classes/FMStatement.html index 8676ef0..e5852f6 100644 --- a/html/Classes/FMStatement.html +++ b/html/Classes/FMStatement.html @@ -1,145 +1,111 @@ -<!DOCTYPE HTML> +<!DOCTYPE html> <html> - <head> - <meta http-equiv="Content-Type" content="html/html; charset=utf-8" /> - <title>FMStatement Class Reference</title> - <meta id="xcode-display" name="xcode-display" content="render"/> - <meta name="viewport" content="width=550" /> - <link rel="stylesheet" type="text/css" href="../css/styles.css" media="all" /> - <link rel="stylesheet" type="text/css" media="print" href="../css/stylesPrint.css" /> - <meta name="generator" content="appledoc 2.1 (build 858)" /> - </head> - <body> - <header id="top_header"> - <div id="library" class="hideInXcode"> - <h1><a id="libraryTitle" href="../index.html">FMDB </a></h1> - <a id="developerHome" href="../index.html">ccgus</a> - </div> +<head> + <meta charset="utf-8"> + + <title>FMStatement Class Reference</title> + + <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)"> +</head> +<body class="appledoc"> + <header> + <div class="container" class="hide-in-xcode"> - <div id="title" role="banner"> - <h1 class="hideInXcode">FMStatement Class Reference</h1> - </div> - <ul id="headerButtons" role="toolbar"> - <li id="toc_button"> - <button aria-label="Show Table of Contents" role="checkbox" class="open" id="table_of_contents"><span class="disclosure"></span>Table of Contents</button> - </li> - <li id="jumpto_button" role="navigation"> - <select id="jumpTo"> + <h1 id="library-title"> + <a href="../index.html">FMDB </a> + </h1> + + <p id="developer-home"> + <a href="../index.html">ccgus</a> + </p> + + </div> + </header> + + <aside> + <div class="container"> + <nav> + <ul id="header-buttons" role="toolbar"> + <li><a href="../index.html">Index</a></li> +<li><a href="../hierarchy.html">Hierarchy</a></li> + + <li id="on-this-page" role="navigation"> + <label> + On This Page + + <div class="chevron"> + <div class="chevy chevron-left"></div> + <div class="chevy chevron-right"></div> + </div> + + <select id="jump-to"> <option value="top">Jump To…</option> <option value="overview">Overview</option> - + <option value="tasks">Tasks</option> - - - - <option value="properties">Properties</option> - - <option value="//api/name/inUse"> inUse</option> - - <option value="//api/name/query"> query</option> - - <option value="//api/name/statement"> statement</option> - - <option value="//api/name/useCount"> useCount</option> - - - - - - - <option value="instance_methods">Instance Methods</option> - - <option value="//api/name/close"> - close</option> - - <option value="//api/name/reset"> - reset</option> - - - -</select> - </li> - </ul> - </header> - <nav id="tocContainer" class="isShowingTOC"> - <ul id="toc" role="tree"> - -<li role="treeitem"><span class="nodisclosure"></span><span class="sectionName"><a href="#overview">Overview</a></span></li> - - - -<li role="treeitem" id="task_treeitem"><span class="nodisclosure"></span><span class="sectionName"><a href="#tasks">Tasks</a></span><ul> - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#task_Properties">Properties</a></span></li> - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#task_Closing and Resetting">Closing and Resetting</a></span></li> + <optgroup label="Properties"> + + <option value="//api/name/inUse">inUse</option> + + <option value="//api/name/query">query</option> + + <option value="//api/name/statement">statement</option> + + <option value="//api/name/useCount">useCount</option> + + </optgroup> -</ul></li> - - - - -<li role="treeitem" class="children"><span class="disclosure"></span><span class="sectionName"><a href="#properties">Properties</a></span><ul> - - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/inUse">inUse</a></span></li> - - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/query">query</a></span></li> - - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/statement">statement</a></span></li> - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/useCount">useCount</a></span></li> - -</ul></li> - - - - -<li role="treeitem" class="children"><span class="disclosure"></span><span class="sectionName"><a href="#instance_methods">Instance Methods</a></span><ul> - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/close">close</a></span></li> + <optgroup label="Instance Methods"> + + <option value="//api/name/close">- close</option> + + <option value="//api/name/reset">- reset</option> + + </optgroup> - <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/reset">reset</a></span></li> -</ul></li> - - - </ul> - </nav> - <article> - <div id="contents" class="isShowingTOC" role="main"> - <a title="FMStatement Class Reference" name="top"></a> - <div class="main-navigation navigation-top"> - <ul> - <li><a href="../index.html">Index</a></li> - <li><a href="../hierarchy.html">Hierarchy</a></li> -</ul> - </div> - <div id="header"> - <div class="section-header"> - <h1 class="title title-header">FMStatement Class Reference</h1> - </div> - </div> - <div id="container"> +</select> + </label> + </li> + </ul> + </nav> + </div> + </aside> + + <article> + <div id="overview_contents" class="container"> + <div id="content"> + <main role="main"> + <h1 class="title">FMStatement Class Reference</h1> + <div class="section section-specification"><table cellspacing="0"><tbody> <tr> - <td class="specification-title">Inherits from</td> - <td class="specification-value">NSObject</td> + <th>Inherits from</th> + <td>NSObject</td> </tr><tr> - <td class="specification-title">Declared in</td> - <td class="specification-value">FMDatabase.h</td> + <th>Declared in</th> + <td>FMDatabase.h</td> </tr> </tbody></table></div> - - + + <div class="section section-overview"> <a title="Overview" name="overview"></a> @@ -159,427 +125,334 @@ </div> - + <div class="section section-tasks"> <a title="Tasks" name="tasks"></a> - <h2 class="subtitle subtitle-tasks">Tasks</h2> - + <a title="Properties" name="task_Properties"></a> - <h3 class="subsubtitle task-title">Properties</h3> - - <ul class="task-list"> - <li> - <span class="tooltip"> - <code><a href="#//api/name/useCount"> useCount</a></code> - <span class="tooltip"><p>Usage count</p></span> - </span> - <span class="task-item-suffix">property</span> - -</li><li> - <span class="tooltip"> - <code><a href="#//api/name/query"> query</a></code> - <span class="tooltip"><p>SQL statement</p></span> - </span> - <span class="task-item-suffix">property</span> - -</li><li> - <span class="tooltip"> - <code><a href="#//api/name/statement"> statement</a></code> - <span class="tooltip"><p>SQLite sqlite3_stmt</p></span> - </span> - <span class="task-item-suffix">property</span> - -</li><li> - <span class="tooltip"> - <code><a href="#//api/name/inUse"> inUse</a></code> - <span class="tooltip"><p>Indication of whether the statement is in use</p></span> - </span> - <span class="task-item-suffix">property</span> - -</li> - </ul> - - - <a title="Closing and Resetting" name="task_Closing and Resetting"></a> - <h3 class="subsubtitle task-title">Closing and Resetting</h3> - - <ul class="task-list"> - <li> - <span class="tooltip"> - <code><a href="#//api/name/close">– close</a></code> - <span class="tooltip"><p>Close statement</p></span> - </span> - - -</li><li> - <span class="tooltip"> - <code><a href="#//api/name/reset">– reset</a></code> - <span class="tooltip"><p>Reset statement</p></span> - </span> - - -</li> - </ul> - - </div> - - - + <h2 class="task-title">Properties</h2> + + <div class="task-list"> + <div class="section-method"> + <a name="//api/name/useCount" title="useCount"></a> + <h3 class="method-title"><code><a href="#//api/name/useCount"> useCount</a></code> +</h3> + + <div class="method-info"> + <div class="pointy-thing"></div> + + <div class="method-info-container"> + + + <div class="method-subsection brief-description"> + <p>Usage count</p> + </div> + + + + <div class="method-subsection method-declaration"><code>@property (atomic, assign) long useCount</code></div> + + + + + + + + + + <div class="method-subsection discussion-section"> + <h4 class="method-subtitle">Discussion</h4> + <p>Usage count</p> + </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/query" title="query"></a> + <h3 class="method-title"><code><a href="#//api/name/query"> query</a></code> +</h3> + + <div class="method-info"> + <div class="pointy-thing"></div> + + <div class="method-info-container"> + + + <div class="method-subsection brief-description"> + <p>SQL statement</p> + </div> + + + + <div class="method-subsection method-declaration"><code>@property (atomic, retain) NSString *query</code></div> + + + + + + + + + + <div class="method-subsection discussion-section"> + <h4 class="method-subtitle">Discussion</h4> + <p>SQL statement</p> + </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/statement" title="statement"></a> + <h3 class="method-title"><code><a href="#//api/name/statement"> statement</a></code> +</h3> + + <div class="method-info"> + <div class="pointy-thing"></div> + + <div class="method-info-container"> + + + <div class="method-subsection brief-description"> + <p>SQLite sqlite3_stmt</p> + </div> + + + + <div class="method-subsection method-declaration"><code>@property (atomic, assign) sqlite3_stmt *statement</code></div> + + + + + + + + + + <div class="method-subsection discussion-section"> + <h4 class="method-subtitle">Discussion</h4> + <p>SQLite sqlite3_stmt</p> + </div> + + + + + + <div class="method-subsection see-also-section"> + <h4 class="method-subtitle">See Also</h4> + <ul> + <li><code><p><a href="http://www.sqlite.org/c3ref/stmt.html"><code>sqlite3_stmt</code></a></p></code></li> - <div class="section section-methods"> - <a title="Properties" name="properties"></a> - <h2 class="subtitle subtitle-methods">Properties</h2> - - <div class="section-method"> + </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/inUse" title="inUse"></a> - <h3 class="subsubtitle method-title">inUse</h3> - - - - <div class="method-subsection brief-description"> - <p>Indication of whether the statement is in use</p> - </div> - - + <h3 class="method-title"><code><a href="#//api/name/inUse"> inUse</a></code> +</h3> - <div class="method-subsection method-declaration"><code>@property (atomic, assign) BOOL inUse</code></div> + <div class="method-info"> + <div class="pointy-thing"></div> - - - - - - - - - - - - - - - <div class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMDatabase.h</code><br /> - </div> - - -</div> - - <div class="section-method"> - <a name="//api/name/query" title="query"></a> - <h3 class="subsubtitle method-title">query</h3> - - - - <div class="method-subsection brief-description"> - <p>SQL statement</p> - </div> - - + <div class="method-info-container"> + + + <div class="method-subsection brief-description"> + <p>Indication of whether the statement is in use</p> + </div> + + - <div class="method-subsection method-declaration"><code>@property (atomic, retain) NSString *query</code></div> + <div class="method-subsection method-declaration"><code>@property (atomic, assign) BOOL inUse</code></div> - - - - - - - - - - - - - - - <div class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMDatabase.h</code><br /> - </div> - - -</div> - - <div class="section-method"> - <a name="//api/name/statement" title="statement"></a> - <h3 class="subsubtitle method-title">statement</h3> - - - - <div class="method-subsection brief-description"> - <p>SQLite sqlite3_stmt</p> - </div> - - + + - <div class="method-subsection method-declaration"><code>@property (atomic, assign) sqlite3_stmt *statement</code></div> + - - - - - - - - - - - - - <div class="method-subsection see-also-section"> - <h4 class="method-subtitle">See Also</h4> - <ul> - <li><code><p><a href="http://www.sqlite.org/c3ref/stmt.html"><code>sqlite3_stmt</code></a></p></code></li> + + + <div class="method-subsection discussion-section"> + <h4 class="method-subtitle">Discussion</h4> + <p>Indication of whether the statement is in use</p> + </div> + + + + + + - </ul> + <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 class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMDatabase.h</code><br /> - </div> - - </div> + </div> - <div class="section-method"> - <a name="//api/name/useCount" title="useCount"></a> - <h3 class="subsubtitle method-title">useCount</h3> - - - - <div class="method-subsection brief-description"> - <p>Usage count</p> - </div> - - - <div class="method-subsection method-declaration"><code>@property (atomic, assign) long useCount</code></div> + <a title="Closing and Resetting" name="task_Closing and Resetting"></a> + <h2 class="task-title">Closing and Resetting</h2> - - - - - - - - - - - - - - - <div class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMDatabase.h</code><br /> - </div> - - -</div> - - </div> - - - - - - <div class="section section-methods"> - <a title="Instance Methods" name="instance_methods"></a> - <h2 class="subtitle subtitle-methods">Instance Methods</h2> - - <div class="section-method"> + <div class="task-list"> + <div class="section-method"> <a name="//api/name/close" title="close"></a> - <h3 class="subsubtitle method-title">close</h3> - - - - <div class="method-subsection brief-description"> - <p>Close statement</p> - </div> - - + <h3 class="method-title"><code><a href="#//api/name/close">– close</a></code> +</h3> - <div class="method-subsection method-declaration"><code>- (void)close</code></div> + <div class="method-info"> + <div class="pointy-thing"></div> - - - - - - - - - - - - - - - <div class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMDatabase.h</code><br /> - </div> - - -</div> - - <div class="section-method"> + <div class="method-info-container"> + + + <div class="method-subsection brief-description"> + <p>Close statement</p> + </div> + + + + <div class="method-subsection method-declaration"><code>- (void)close</code></div> + + + + + + + + + + <div class="method-subsection discussion-section"> + <h4 class="method-subtitle">Discussion</h4> + <p>Close statement</p> + </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/reset" title="reset"></a> - <h3 class="subsubtitle method-title">reset</h3> - - - - <div class="method-subsection brief-description"> - <p>Reset statement</p> - </div> - - + <h3 class="method-title"><code><a href="#//api/name/reset">– reset</a></code> +</h3> - <div class="method-subsection method-declaration"><code>- (void)reset</code></div> + <div class="method-info"> + <div class="pointy-thing"></div> - - - - - - - - - - - - - - - <div class="method-subsection declared-in-section"> - <h4 class="method-subtitle">Declared In</h4> - <code class="declared-in-ref">FMDatabase.h</code><br /> - </div> - - + <div class="method-info-container"> + + + <div class="method-subsection brief-description"> + <p>Reset statement</p> + </div> + + + + <div class="method-subsection method-declaration"><code>- (void)reset</code></div> + + + + + + + + + + <div class="method-subsection discussion-section"> + <h4 class="method-subtitle">Discussion</h4> + <p>Reset statement</p> + </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> </div> - </div> - <div class="main-navigation navigation-bottom"> - <ul> - <li><a href="../index.html">Index</a></li> - <li><a href="../hierarchy.html">Hierarchy</a></li> -</ul> - </div> - <div id="footer"> - <hr /> + + + </main> + + <footer> <div class="footer-copyright"> - <p><span class="copyright">© 2014 ccgus. All rights reserved. (Last updated: 2014-05-25)</span><br /> - <span class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.1 (build 858)</a>.</span></p> + <p class="copyright">Copyright © 2015 ccgus. All rights reserved. Updated: 2015-01-25</p> + + + <p class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.2.1 (build 1333)</a>.</p> </div> - </div> + </footer> </div> - </article> - <script type="text/javascript"> - function jumpToChange() - { - window.location.hash = this.options[this.selectedIndex].value; - } - - function toggleTOC() - { - var contents = document.getElementById('contents'); - var tocContainer = document.getElementById('tocContainer'); - - if (this.getAttribute('class') == 'open') - { - this.setAttribute('class', ''); - contents.setAttribute('class', ''); - tocContainer.setAttribute('class', ''); - - window.name = "hideTOC"; - } - else - { - this.setAttribute('class', 'open'); - contents.setAttribute('class', 'isShowingTOC'); - tocContainer.setAttribute('class', 'isShowingTOC'); - - window.name = ""; - } - return false; - } - - function toggleTOCEntryChildren(e) - { - e.stopPropagation(); - var currentClass = this.getAttribute('class'); - if (currentClass == 'children') { - this.setAttribute('class', 'children open'); - } - else if (currentClass == 'children open') { - this.setAttribute('class', 'children'); - } - return false; - } - - function tocEntryClick(e) - { - e.stopPropagation(); - return true; - } - - function init() - { - var selectElement = document.getElementById('jumpTo'); - selectElement.addEventListener('change', jumpToChange, false); - - var tocButton = document.getElementById('table_of_contents'); - tocButton.addEventListener('click', toggleTOC, false); - - var taskTreeItem = document.getElementById('task_treeitem'); - if (taskTreeItem.getElementsByTagName('li').length > 0) - { - taskTreeItem.setAttribute('class', 'children'); - taskTreeItem.firstChild.setAttribute('class', 'disclosure'); - } - - var tocList = document.getElementById('toc'); - - var tocEntries = tocList.getElementsByTagName('li'); - for (var i = 0; i < tocEntries.length; i++) { - tocEntries[i].addEventListener('click', toggleTOCEntryChildren, false); - } - - var tocLinks = tocList.getElementsByTagName('a'); - for (var i = 0; i < tocLinks.length; i++) { - tocLinks[i].addEventListener('click', tocEntryClick, false); - } - - if (window.name == "hideTOC") { - toggleTOC.call(tocButton); - } - } - - window.onload = init; - - // If showing in Xcode, hide the TOC and Header - if (navigator.userAgent.match(/xcode/i)) { - document.getElementById("contents").className = "hideInXcode" - document.getElementById("tocContainer").className = "hideInXcode" - document.getElementById("top_header").className = "hideInXcode" - } - - </script> - </body> + </div> + </article> + + <script src="../js/script.js"></script> +</body> </html>
\ No newline at end of file diff --git a/html/css/scss/_index.scss b/html/css/scss/_index.scss new file mode 100644 index 0000000..7e98029 --- /dev/null +++ b/html/css/scss/_index.scss @@ -0,0 +1,13 @@ +.index-container { + display: flex; + flex-direction: row; + flex-wrap: wrap; + + @media (max-width: $mobile-max-width) { + flex-direction: column; + } + + .index-column { + flex: 1 1 33%; + } +} diff --git a/html/css/scss/_layout.scss b/html/css/scss/_layout.scss new file mode 100644 index 0000000..40bd6d4 --- /dev/null +++ b/html/css/scss/_layout.scss @@ -0,0 +1,303 @@ +* { + box-sizing: border-box; +} + +.clear { + clear: both; +} + +.clearfix { + &:before, &:after { + clear: both; + display: table; + content: ""; + } +} + +.xcode .hide-in-xcode { + display: none; +} + +body { + font: 62.5% $body-font; + background: $body-background; +} + +h1, h2, h3 { + font-weight: 300; + color: #808080; +} + +h1 { + font-size: 2em; + color: #000; +} + +h4 { + font-size: 13px; + line-height: 1.5; + margin: 21px 0 0 0; +} + +a { + color: $tint-color; + text-decoration: none; +} + +pre, code { + font-family: $code-font; + word-wrap: break-word; +} + +pre > code, .method-declaration code { + display: inline-block; + font-size: .85em; + padding: 4px 0 4px 10px; + border-left: 5px solid rgba(0, 155, 51, .2); + + &:before { + content: "Objective-C"; + display: block; + + font: 9px/1 $body-font; + color: #009b33; + text-transform: uppercase; + letter-spacing: 2px; + padding-bottom: 6px; + } +} + +pre > code { + font-size: inherit; +} + +table, th, td { + border: 1px solid #e9e9e9; +} + +table { + width: 100%; +} + +th, td { + padding: 7px; + + > :first-child { + margin-top: 0; + } + + > :last-child { + margin-bottom: 0; + } +} + +.container { + @extend .clearfix; + + max-width: 980px; + padding: 0 10px; + margin: 0 auto; + + @media (max-width: $mobile-max-width) { + padding: 0; + } +} + +header { + position: fixed; + top: 0; + left: 0; + width: 100%; + z-index: 2; + + background: #414141; + color: #fff; + font-size: 1.1em; + line-height: 25px; + letter-spacing: .05em; + + #library-title { + float: left; + } + + #developer-home { + float: right; + } + + h1 { + font-size: inherit; + font-weight: inherit; + margin: 0; + } + + p { + margin: 0; + } + + h1, a { + color: inherit; + } + + @media (max-width: $mobile-max-width) { + position: absolute; + + .container { + padding: 0 10px; + } + } +} + +aside { + position: fixed; + top: 25px; + left: 0; + width: 100%; + height: 25px; + z-index: 2; + + font-size: 1.1em; + + @media (max-width: $mobile-max-width) { + position: absolute; + } + + #header-buttons { + background: rgba(255, 255, 255, .8); + margin: 0 1px; + padding: 0; + list-style: none; + text-align: right; + line-height: 32px; + + li { + display: inline-block; + cursor: pointer; + padding: 0 10px; + } + + label, select { + cursor: inherit; + } + + #on-this-page { + position: relative; + + .chevron { + display: inline-block; + width: 14px; + height: 4px; + position: relative; + + .chevy { + background: #878787; + height: 2px; + position: absolute; + width: 10px; + + &.chevron-left { + left: 0; + transform: rotateZ(45deg) scale(0.6); + } + + &.chevron-right { + right: 0; + transform: rotateZ(-45deg) scale(0.6); + } + } + } + + #jump-to { + opacity: 0; + font-size: 16px; + + position: absolute; + top: 5px; + left: 0; + width: 100%; + height: 100%; + } + } + } +} + +article { + margin-top: 25px; + + #content { + @extend .clearfix; + + background: $content-background; + border: 1px solid $content-border; + padding: 15px 25px 30px 25px; + + font-size: 1.4em; + line-height: 1.45; + + position: relative; + + @media (max-width: $mobile-max-width) { + padding: 15px 10px 20px 10px; + } + + .navigation-top { + position: absolute; + top: 15px; + right: 25px; + } + + .title { + margin: 21px 0 0 0; + padding: 15px 0; + } + + p { + color: #414141; + margin: 0 0 15px 0; + } + + th, td { + p:last-child { + margin-bottom: 0; + } + } + + main { + ul { + list-style: none; + margin-left: 24px; + margin-bottom: 12px; + padding: 0; + + li { + position: relative; + padding-left: 1.3em; + + &:before { + content: "\02022"; + + color: #414141; + font-size: 1.08em; + line-height: 1; + + position: absolute; + left: 0; + padding-top: 2px; + } + } + } + } + + footer { + @extend .clearfix; + + .footer-copyright { + margin: 70px 25px 10px 0; + } + + p { + font-size: .71em; + color: #a0a0a0; + } + } + } +} diff --git a/html/css/scss/_normalize.scss b/html/css/scss/_normalize.scss new file mode 100644 index 0000000..9b8848a --- /dev/null +++ b/html/css/scss/_normalize.scss @@ -0,0 +1,581 @@ +/* ========================================================================== + Normalize.scss settings + ========================================================================== */ +/** + * Includes legacy browser support IE6/7 + * + * Set to false if you want to drop support for IE6 and IE7 + */ + +$legacy_browser_support: false !default; + +/* Base + ========================================================================== */ + +/** + * 1. Set default font family to sans-serif. + * 2. Prevent iOS text size adjust after orientation change, without disabling + * user zoom. + * 3. Corrects text resizing oddly in IE 6/7 when body `font-size` is set using + * `em` units. + */ + +html { + font-family: sans-serif; /* 1 */ + -ms-text-size-adjust: 100%; /* 2 */ + -webkit-text-size-adjust: 100%; /* 2 */ + @if $legacy_browser_support { + *font-size: 100%; /* 3 */ + } +} + +/** + * Remove default margin. + */ + +body { + margin: 0; +} + +/* HTML5 display definitions + ========================================================================== */ + +/** + * Correct `block` display not defined for any HTML5 element in IE 8/9. + * Correct `block` display not defined for `details` or `summary` in IE 10/11 + * and Firefox. + * Correct `block` display not defined for `main` in IE 11. + */ + +article, +aside, +details, +figcaption, +figure, +footer, +header, +hgroup, +main, +menu, +nav, +section, +summary { + display: block; +} + +/** + * 1. Correct `inline-block` display not defined in IE 6/7/8/9 and Firefox 3. + * 2. Normalize vertical alignment of `progress` in Chrome, Firefox, and Opera. + */ + +audio, +canvas, +progress, +video { + display: inline-block; /* 1 */ + vertical-align: baseline; /* 2 */ + @if $legacy_browser_support { + *display: inline; + *zoom: 1; + } +} + +/** + * Prevents modern browsers from displaying `audio` without controls. + * Remove excess height in iOS 5 devices. + */ + +audio:not([controls]) { + display: none; + height: 0; +} + +/** + * Address `[hidden]` styling not present in IE 8/9/10. + * Hide the `template` element in IE 8/9/11, Safari, and Firefox < 22. + */ + +[hidden], +template { + display: none; +} + +/* Links + ========================================================================== */ + +/** + * Remove the gray background color from active links in IE 10. + */ + +a { + background-color: transparent; +} + +/** + * Improve readability when focused and also mouse hovered in all browsers. + */ + +a { + &:active, &:hover { + outline: 0; + }; +} + +/* Text-level semantics + ========================================================================== */ + +/** + * Address styling not present in IE 8/9/10/11, Safari, and Chrome. + */ + +abbr[title] { + border-bottom: 1px dotted; +} + +/** + * Address style set to `bolder` in Firefox 4+, Safari, and Chrome. + */ + +b, +strong { + font-weight: bold; +} + +@if $legacy_browser_support { + blockquote { + margin: 1em 40px; + } +} + +/** + * Address styling not present in Safari and Chrome. + */ + +dfn { + font-style: italic; +} + +/** + * Address variable `h1` font-size and margin within `section` and `article` + * contexts in Firefox 4+, Safari, and Chrome. + */ + +h1 { + font-size: 2em; + margin: 0.67em 0; +} + +@if $legacy_browser_support { + h2 { + font-size: 1.5em; + margin: 0.83em 0; + } + + h3 { + font-size: 1.17em; + margin: 1em 0; + } + + h4 { + font-size: 1em; + margin: 1.33em 0; + } + + h5 { + font-size: 0.83em; + margin: 1.67em 0; + } + + h6 { + font-size: 0.67em; + margin: 2.33em 0; + } +} + +/** + * Addresses styling not present in IE 8/9. + */ + +mark { + background: #ff0; + color: #000; +} + +@if $legacy_browser_support { + + /** + * Addresses margins set differently in IE 6/7. + */ + + p, + pre { + *margin: 1em 0; + } + + /* + * Addresses CSS quotes not supported in IE 6/7. + */ + + q { + *quotes: none; + } + + /* + * Addresses `quotes` property not supported in Safari 4. + */ + + q:before, + q:after { + content: ''; + content: none; + } +} + +/** + * Address inconsistent and variable font size in all browsers. + */ + +small { + font-size: 80%; +} + +/** + * Prevent `sub` and `sup` affecting `line-height` in all browsers. + */ + +sub, +sup { + font-size: 75%; + line-height: 0; + position: relative; + vertical-align: baseline; +} + +sup { + top: -0.5em; +} + +sub { + bottom: -0.25em; +} + +@if $legacy_browser_support { + + /* ========================================================================== + Lists + ========================================================================== */ + + /* + * Addresses margins set differently in IE 6/7. + */ + + dl, + menu, + ol, + ul { + *margin: 1em 0; + } + + dd { + *margin: 0 0 0 40px; + } + + /* + * Addresses paddings set differently in IE 6/7. + */ + + menu, + ol, + ul { + *padding: 0 0 0 40px; + } + + /* + * Corrects list images handled incorrectly in IE 7. + */ + + nav ul, + nav ol { + *list-style: none; + *list-style-image: none; + } + +} + +/* Embedded content + ========================================================================== */ + +/** + * 1. Remove border when inside `a` element in IE 8/9/10. + * 2. Improves image quality when scaled in IE 7. + */ + +img { + border: 0; + @if $legacy_browser_support { + *-ms-interpolation-mode: bicubic; /* 2 */ + } +} + +/** + * Correct overflow not hidden in IE 9/10/11. + */ + +svg:not(:root) { + overflow: hidden; +} + +/* Grouping content + ========================================================================== */ + +/** + * Address margin not present in IE 8/9 and Safari. + */ + +figure { + margin: 1em 40px; +} + +/** + * Address differences between Firefox and other browsers. + */ + +hr { + -moz-box-sizing: content-box; + box-sizing: content-box; + height: 0; +} + +/** + * Contain overflow in all browsers. + */ + +pre { + overflow: auto; +} + +/** + * Address odd `em`-unit font size rendering in all browsers. + * Correct font family set oddly in IE 6, Safari 4/5, and Chrome. + */ + +code, +kbd, +pre, +samp { + font-family: monospace, monospace; + @if $legacy_browser_support { + _font-family: 'courier new', monospace; + } + font-size: 1em; +} + +/* Forms + ========================================================================== */ + +/** + * Known limitation: by default, Chrome and Safari on OS X allow very limited + * styling of `select`, unless a `border` property is set. + */ + +/** + * 1. Correct color not being inherited. + * Known issue: affects color of disabled elements. + * 2. Correct font properties not being inherited. + * 3. Address margins set differently in Firefox 4+, Safari, and Chrome. + * 4. Improves appearance and consistency in all browsers. + */ + +button, +input, +optgroup, +select, +textarea { + color: inherit; /* 1 */ + font: inherit; /* 2 */ + margin: 0; /* 3 */ + @if $legacy_browser_support { + vertical-align: baseline; /* 3 */ + *vertical-align: middle; /* 3 */ + } +} + +/** + * Address `overflow` set to `hidden` in IE 8/9/10/11. + */ + +button { + overflow: visible; +} + +/** + * Address inconsistent `text-transform` inheritance for `button` and `select`. + * All other form control elements do not inherit `text-transform` values. + * Correct `button` style inheritance in Firefox, IE 8/9/10/11, and Opera. + * Correct `select` style inheritance in Firefox. + */ + +button, +select { + text-transform: none; +} + +/** + * 1. Avoid the WebKit bug in Android 4.0.* where (2) destroys native `audio` + * and `video` controls. + * 2. Correct inability to style clickable `input` types in iOS. + * 3. Improve usability and consistency of cursor style between image-type + * `input` and others. + * 4. Removes inner spacing in IE 7 without affecting normal text inputs. + * Known issue: inner spacing remains in IE 6. + */ + +button, +html input[type="button"], /* 1 */ +input[type="reset"], +input[type="submit"] { + -webkit-appearance: button; /* 2 */ + cursor: pointer; /* 3 */ + @if $legacy_browser_support { + *overflow: visible; /* 4 */ + } +} + +/** + * Re-set default cursor for disabled elements. + */ + +button[disabled], +html input[disabled] { + cursor: default; +} + +/** + * Remove inner padding and border in Firefox 4+. + */ + +button::-moz-focus-inner, +input::-moz-focus-inner { + border: 0; + padding: 0; +} + +/** + * Address Firefox 4+ setting `line-height` on `input` using `!important` in + * the UA stylesheet. + */ + +input { + line-height: normal; +} + +/** + * 1. Address box sizing set to `content-box` in IE 8/9/10. + * 2. Remove excess padding in IE 8/9/10. + * Known issue: excess padding remains in IE 6. + */ + +input[type="checkbox"], +input[type="radio"] { + box-sizing: border-box; /* 1 */ + padding: 0; /* 2 */ + @if $legacy_browser_support { + *height: 13px; /* 3 */ + *width: 13px; /* 3 */ + } +} + +/** + * Fix the cursor style for Chrome's increment/decrement buttons. For certain + * `font-size` values of the `input`, it causes the cursor style of the + * decrement button to change from `default` to `text`. + */ + +input[type="number"]::-webkit-inner-spin-button, +input[type="number"]::-webkit-outer-spin-button { + height: auto; +} + +/** + * 1. Address `appearance` set to `searchfield` in Safari and Chrome. + * 2. Address `box-sizing` set to `border-box` in Safari and Chrome + * (include `-moz` to future-proof). + */ + +input[type="search"] { + -webkit-appearance: textfield; /* 1 */ + -moz-box-sizing: content-box; + -webkit-box-sizing: content-box; /* 2 */ + box-sizing: content-box; +} + +/** + * Remove inner padding and search cancel button in Safari and Chrome on OS X. + * Safari (but not Chrome) clips the cancel button when the search input has + * padding (and `textfield` appearance). + */ + +input[type="search"]::-webkit-search-cancel-button, +input[type="search"]::-webkit-search-decoration { + -webkit-appearance: none; +} + +/** + * Define consistent border, margin, and padding. + */ + +fieldset { + border: 1px solid #c0c0c0; + margin: 0 2px; + padding: 0.35em 0.625em 0.75em; +} + +/** + * 1. Correct `color` not being inherited in IE 8/9/10/11. + * 2. Remove padding so people aren't caught out if they zero out fieldsets. + * 3. Corrects text not wrapping in Firefox 3. + * 4. Corrects alignment displayed oddly in IE 6/7. + */ + +legend { + border: 0; /* 1 */ + padding: 0; /* 2 */ + @if $legacy_browser_support { + white-space: normal; /* 3 */ + *margin-left: -7px; /* 4 */ + } +} + +/** + * Remove default vertical scrollbar in IE 8/9/10/11. + */ + +textarea { + overflow: auto; +} + +/** + * Don't inherit the `font-weight` (applied by a rule above). + * NOTE: the default cannot safely be changed in Chrome and Safari on OS X. + */ + +optgroup { + font-weight: bold; +} + +/* Tables + ========================================================================== */ + +/** + * Remove most spacing between table cells. + */ + +table { + border-collapse: collapse; + border-spacing: 0; +} + +td, +th { + padding: 0; +} diff --git a/html/css/scss/_object.scss b/html/css/scss/_object.scss new file mode 100644 index 0000000..22eebd8 --- /dev/null +++ b/html/css/scss/_object.scss @@ -0,0 +1,89 @@ +.section-specification { + table { + width: auto; + + th { + text-align: left; + } + } +} + +.method-title { + margin-left: -15px; + margin-bottom: 8px; + transition: margin-left .3s ease-out; + + .section-method.hide & { + margin-left: 0; + } + + code { + font-weight: 400; + font-size: .85em; + } +} + +.method-info { + background: $object-background; + border-bottom: 1px solid $object-border; + margin: 0 -25px; + padding: 20px 25px 0 25px; + transition: height .3s ease-out; + + position: relative; + + .pointy-thing { + background: $content-background; + height: 10px; + border-bottom: 1px solid $object-border; + margin: -20px -25px 16px -25px; + + &:before { + display: inline-block; + content: ""; + + background: $object-background; + border: 1px solid $object-border; + border-bottom: 0; + border-right: 0; + + position: absolute; + left: 21px; + top: 3px; + width: 12px; + height: 12px; + transform: rotate(45deg); + } + } + + .method-subsection { + margin-bottom: 15px; + + .argument-name { + width: 1px; + text-align: right; + + code { + color: #808080; + font-style: italic; + font-weight: 400; + } + } + } +} + +.section-method { + &.hide .method-info { + height: 0 !important; + overflow: hidden; + display: none; + } + + &.hide.animating .method-info { + display: block; + } + + &.animating .method-info { + overflow: hidden; + } +} diff --git a/html/css/scss/_print.scss b/html/css/scss/_print.scss new file mode 100644 index 0000000..61bdf99 --- /dev/null +++ b/html/css/scss/_print.scss @@ -0,0 +1,42 @@ +@media print { + body { + background: #fff; + padding: 8px; + } + + header { + position: static; + background: #fff; + color: #000; + } + + aside { + display: none; + } + + .container { + max-width: none; + padding: 0; + } + + article { + margin-top: 0; + + #content { + border: 0; + background: #fff; + padding: 15px 0 0 0; + + .title { + margin-top: 0; + padding-top: 0; + } + } + } + + .method-info { + &, & .pointy-thing { + background: #fff; + } + } +} diff --git a/html/css/scss/_variables.scss b/html/css/scss/_variables.scss new file mode 100644 index 0000000..cbaff3c --- /dev/null +++ b/html/css/scss/_variables.scss @@ -0,0 +1,11 @@ +$body-font: -apple-system-font, "Helvetica Neue", Helvetica, sans-serif; +$code-font: "Source Code Pro", Monaco, Menlo, Consolas, monospace; + +$body-background: #f2f2f2; +$content-background: #fff; +$content-border: #e9e9e9; +$tint-color: #08c; +$object-background: #f9f9f9; +$object-border: #e9e9e9; + +$mobile-max-width: 650px; diff --git a/html/css/scss/_xcode.scss b/html/css/scss/_xcode.scss new file mode 100644 index 0000000..340b1f6 --- /dev/null +++ b/html/css/scss/_xcode.scss @@ -0,0 +1,29 @@ +.xcode { + header, aside { + display: none; + } + + .container { + padding: 0; + } + + article { + margin-top: 0; + + #content { + border: 0; + margin: 0; + } + } + + .method-info { + &, .section-method.hide & { + max-height: auto; + overflow: visible; + + &.hiding { + display: block; + } + } + } +} diff --git a/html/css/scss/style.scss b/html/css/scss/style.scss new file mode 100644 index 0000000..648a608 --- /dev/null +++ b/html/css/scss/style.scss @@ -0,0 +1 @@ +@import "variables", "normalize", "layout", "index", "object", "print", "xcode"; diff --git a/html/css/style.css b/html/css/style.css new file mode 100644 index 0000000..2e0648e --- /dev/null +++ b/html/css/style.css @@ -0,0 +1,2 @@ +html{font-family:sans-serif;-ms-text-size-adjust:100%;-webkit-text-size-adjust:100%}body{margin:0}article,aside,details,figcaption,figure,footer,header,hgroup,main,menu,nav,section,summary{display:block}audio,canvas,progress,video{display:inline-block;vertical-align:baseline}audio:not([controls]){display:none;height:0}[hidden],template{display:none}a{background-color:transparent}a:active,a:hover{outline:0}abbr[title]{border-bottom:1px dotted}b,strong{font-weight:700}dfn{font-style:italic}h1{font-size:2em;margin:.67em 0}mark{background:#ff0;color:#000}small{font-size:80%}sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}sup{top:-.5em}sub{bottom:-.25em}img{border:0}svg:not(:root){overflow:hidden}figure{margin:1em 40px}hr{box-sizing:content-box;height:0}pre{overflow:auto}code,kbd,pre,samp{font-family:monospace,monospace;font-size:1em}button,input,optgroup,select,textarea{color:inherit;font:inherit;margin:0}button{overflow:visible}button,select{text-transform:none}button,html input[type=button],input[type=reset],input[type=submit]{-webkit-appearance:button;cursor:pointer}button[disabled],html input[disabled]{cursor:default}button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}input{line-height:normal}input[type=checkbox],input[type=radio]{box-sizing:border-box;padding:0}input[type=number]::-webkit-inner-spin-button,input[type=number]::-webkit-outer-spin-button{height:auto}input[type=search]{-webkit-appearance:textfield;box-sizing:content-box}input[type=search]::-webkit-search-cancel-button,input[type=search]::-webkit-search-decoration{-webkit-appearance:none}fieldset{border:1px solid silver;margin:0 2px;padding:.35em .625em .75em}legend{border:0;padding:0}textarea{overflow:auto}optgroup{font-weight:700}table{border-collapse:collapse;border-spacing:0}td,th{padding:0}*{box-sizing:border-box}.clear{clear:both}.clearfix:before,.container:before,article #content:before,article #content footer:before,.clearfix:after,.container:after,article #content:after,article #content footer:after{clear:both;display:table;content:""}.xcode .hide-in-xcode{display:none}body{font:62.5% -apple-system-font,"Helvetica Neue",Helvetica,sans-serif;background:#f2f2f2}h1,h2,h3{font-weight:300;color:gray}h1{font-size:2em;color:#000}h4{font-size:13px;line-height:1.5;margin:21px 0 0}a{color:#08c;text-decoration:none}pre,code{font-family:Source Code Pro,Monaco,Menlo,Consolas,monospace;word-wrap:break-word}pre>code,.method-declaration code{display:inline-block;font-size:.85em;padding:4px 0 4px 10px;border-left:5px solid rgba(0,155,51,.2)}pre>code:before,.method-declaration code:before{content:"Objective-C";display:block;font:9px/1 -apple-system-font,"Helvetica Neue",Helvetica,sans-serif;color:#009b33;text-transform:uppercase;letter-spacing:2px;padding-bottom:6px}pre>code{font-size:inherit}table,th,td{border:1px solid #e9e9e9}table{width:100%}th,td{padding:7px}th>:first-child,td>:first-child{margin-top:0}th>:last-child,td>:last-child{margin-bottom:0}.container{max-width:980px;padding:0 10px;margin:0 auto}@media(max-width:650px){.container{padding:0}}header{position:fixed;top:0;left:0;width:100%;z-index:2;background:#414141;color:#fff;font-size:1.1em;line-height:25px;letter-spacing:.05em}header #library-title{float:left}header #developer-home{float:right}header h1{font-size:inherit;font-weight:inherit;margin:0}header p{margin:0}header h1,header a{color:inherit}@media(max-width:650px){header{position:absolute}header .container{padding:0 10px}}aside{position:fixed;top:25px;left:0;width:100%;height:25px;z-index:2;font-size:1.1em}aside #header-buttons{background:rgba(255,255,255,.8);margin:0 1px;padding:0;list-style:none;text-align:right;line-height:32px}aside #header-buttons li{display:inline-block;cursor:pointer;padding:0 10px}aside #header-buttons label,aside #header-buttons select{cursor:inherit}aside #header-buttons #on-this-page{position:relative}aside #header-buttons #on-this-page .chevron{display:inline-block;width:14px;height:4px;position:relative}aside #header-buttons #on-this-page .chevron .chevy{background:#878787;height:2px;position:absolute;width:10px}aside #header-buttons #on-this-page .chevron .chevy.chevron-left{left:0;-webkit-transform:rotateZ(45deg) scale(.6);transform:rotateZ(45deg) scale(.6)}aside #header-buttons #on-this-page .chevron .chevy.chevron-right{right:0;-webkit-transform:rotateZ(-45deg) scale(.6);transform:rotateZ(-45deg) scale(.6)}aside #header-buttons #on-this-page #jump-to{opacity:0;filter:alpha(opacity=0);font-size:16px;position:absolute;top:5px;left:0;width:100%;height:100%}article{margin-top:25px}article #content{background:#fff;border:1px solid #e9e9e9;padding:15px 25px 30px;font-size:1.4em;line-height:1.45;position:relative}@media(max-width:650px){article #content{padding:15px 10px 20px}}article #content .navigation-top{position:absolute;top:15px;right:25px}article #content .title{margin:21px 0 0;padding:15px 0}article #content p{color:#414141;margin:0 0 15px}article #content th p:last-child,article #content td p:last-child{margin-bottom:0}article #content main ul{list-style:none;margin-left:24px;margin-bottom:12px;padding:0}article #content main ul li{position:relative;padding-left:1.3em}article #content main ul li:before{content:"\02022";color:#414141;font-size:1.08em;line-height:1;position:absolute;left:0;padding-top:2px}article #content footer .footer-copyright{margin:70px 25px 10px 0}article #content footer p{font-size:.71em;color:#a0a0a0}.index-container{display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-box-orient:horizontal;-webkit-box-direction:normal;-webkit-flex-direction:row;-ms-flex-direction:row;flex-direction:row;-webkit-flex-wrap:wrap;-ms-flex-wrap:wrap;flex-wrap:wrap}@media(max-width:650px){.index-container{-webkit-box-orient:vertical;-webkit-box-direction:normal;-webkit-flex-direction:column;-ms-flex-direction:column;flex-direction:column}}.index-container .index-column{-webkit-box-flex:1;-webkit-flex:1 1 33%;-ms-flex:1 1 33%;flex:1 1 33%}.section-specification table{width:auto}.section-specification table th{text-align:left}.method-title{margin-left:-15px;margin-bottom:8px;-webkit-transition:margin-left .3s ease-out;transition:margin-left .3s ease-out}.section-method.hide .method-title{margin-left:0}.method-title code{font-weight:400;font-size:.85em}.method-info{background:#f9f9f9;border-bottom:1px solid #e9e9e9;margin:0 -25px;padding:20px 25px 0;-webkit-transition:height .3s ease-out;transition:height .3s ease-out;position:relative}.method-info .pointy-thing{background:#fff;height:10px;border-bottom:1px solid #e9e9e9;margin:-20px -25px 16px}.method-info .pointy-thing:before{display:inline-block;content:"";background:#f9f9f9;border:1px solid #e9e9e9;border-bottom:0;border-right:0;position:absolute;left:21px;top:3px;width:12px;height:12px;-webkit-transform:rotate(45deg);-ms-transform:rotate(45deg);transform:rotate(45deg)}.method-info .method-subsection{margin-bottom:15px}.method-info .method-subsection .argument-name{width:1px;text-align:right}.method-info .method-subsection .argument-name code{color:gray;font-style:italic;font-weight:400}.section-method.hide .method-info{height:0!important;overflow:hidden;display:none}.section-method.hide.animating .method-info{display:block}.section-method.animating .method-info{overflow:hidden}@media print{body{background:#fff;padding:8px}header{position:static;background:#fff;color:#000}aside{display:none}.container{max-width:none;padding:0}article{margin-top:0}article #content{border:0;background:#fff;padding:15px 0 0}article #content .title{margin-top:0;padding-top:0}.method-info,.method-info .pointy-thing{background:#fff}}.xcode header,.xcode aside{display:none}.xcode .container{padding:0}.xcode article{margin-top:0}.xcode article #content{border:0;margin:0}.xcode .section-method.hide .method-info,.xcode .section-method.hide.animating .method-info,.xcode .section-method.animating .method-info{height:auto!important;overflow:visible;display:block}.xcode .section-method.hide .method-title{margin-left:-15px} +/*# sourceMappingURL=to.css.map */
\ No newline at end of file diff --git a/html/css/styles.css b/html/css/styles.css deleted file mode 100755 index 1ad2618..0000000 --- a/html/css/styles.css +++ /dev/null @@ -1,588 +0,0 @@ -body { - font-family: 'Lucida Grande',Geneva,Helvetica,Arial,sans-serif; - font-size: 13px; -} - -code { - font-family: Courier, Consolas, monospace; - font-size: 13px; - color: #666; -} - -pre { - font-family: Courier, Consolas, monospace; - font-size: 13px; - line-height: 18px; - tab-interval: 0.5em; - border: 1px solid #C7CFD5; - background-color: #F1F5F9; - color: #666; - padding: 0.3em 1em; -} - -ul { - list-style-type: square; -} - -li { - margin-bottom: 10px; -} - -a, a code { - text-decoration: none; - color: #36C; -} - -a:hover, a:hover code { - text-decoration: underline; - color: #36C; -} - -h2 { - border-bottom: 1px solid #8391A8; - color: #3C4C6C; - font-size: 187%; - font-weight: normal; - margin-top: 1.75em; - padding-bottom: 2px; -} - -table { - margin-bottom: 4em; - border-collapse:collapse; - vertical-align: middle; -} - -td { - border: 1px solid #9BB3CD; - padding: .667em; - font-size: 100%; -} - -th { - border: 1px solid #9BB3CD; - padding: .3em .667em .3em .667em; - background: #93A5BB; - font-size: 103%; - font-weight: bold; - color: white; - text-align: left; -} - -/* @group Common page elements */ - -#top_header { - height: 91px; - left: 0; - min-width: 598px; - position: absolute; - right: 0; - top: 0; - z-index: 900; -} - -#footer { - clear: both; - padding-top: 20px; - text-align: center; -} - -#contents, #overview_contents { - -webkit-overflow-scrolling: touch; - border-top: 1px solid #2B334F; - position: absolute; - top: 91px; - left: 0; - right: 0; - bottom: 0; - overflow-x: hidden; - overflow-y: auto; - padding-left: 2em; - padding-right: 2em; - padding-top: 1em; - min-width: 550px; -} - -#contents.isShowingTOC { - left: 230px; - min-width: 320px; -} - -.copyright { - font-size: 12px; -} - -.generator { - font-size: 11px; -} - -.main-navigation ul li { - display: inline; - margin-left: 15px; - list-style: none; -} - -.navigation-top { - clear: both; - float: right; -} - -.navigation-bottom { - clear: both; - float: right; - margin-top: 20px; - margin-bottom: -10px; -} - -.open > .disclosure { - background-image: url("../img/disclosure_open.png"); -} - -.disclosure { - background: url("../img/disclosure.png") no-repeat scroll 0 0; -} - -.disclosure, .nodisclosure { - display: inline-block; - height: 8px; - margin-right: 5px; - position: relative; - width: 9px; -} - -/* @end */ - -/* @group Header */ - -#top_header #library { - background: url("../img/library_background.png") repeat-x 0 0 #485E78; - background-color: #ccc; - height: 35px; - font-size: 115%; -} - -#top_header #library #libraryTitle { - color: #FFFFFF; - margin-left: 15px; - text-shadow: 0 -1px 0 #485E78; - top: 8px; - position: absolute; -} - -#libraryTitle { - left: 0; -} - -#top_header #library #developerHome { - color: #92979E; - right: 15px; - top: 8px; - position: absolute; -} - -#top_header #library a:hover { - text-decoration: none; -} - -#top_header #title { - background: url("../img/title_background.png") repeat-x 0 0 #8A98A9; - border-bottom: 1px solid #B6B6B6; - height: 25px; - overflow: hidden; -} - -#top_header h1 { - font-size: 115%; - font-weight: normal; - margin: 0; - padding: 3px 0 2px; - text-align: center; - text-shadow: 0 1px 0 #D5D5D5; - white-space: nowrap; -} - -#headerButtons { - background-color: #D8D8D8; - background-image: url("../img/button_bar_background.png"); - border-bottom: 1px solid #EDEDED; - border-top: 1px solid #2B334F; - font-size: 8pt; - height: 28px; - left: 0; - list-style: none outside none; - margin: 0; - overflow: hidden; - padding: 0; - position: absolute; - right: 0; - top: 61px; -} - -#headerButtons li { - background-repeat: no-repeat; - display: inline; - margin-top: 0; - margin-bottom: 0; - padding: 0; -} - -#toc_button button { - border-color: #ACACAC; - border-style: none solid none none; - border-width: 0 1px 0 0; - height: 28px; - margin: 0; - padding-left: 30px; - text-align: left; - width: 230px; -} - -li#jumpto_button { - left: 230px; - margin-left: 0; - position: absolute; -} - -li#jumpto_button select { - height: 22px; - margin: 5px 2px 0 10px; - max-width: 300px; -} - -/* @end */ - -/* @group Table of contents */ - -#tocContainer.isShowingTOC { - border-right: 1px solid #ACACAC; - display: block; - overflow-x: hidden; - overflow-y: auto; - padding: 0; -} - -#tocContainer { - background-color: #E4EBF7; - border-top: 1px solid #2B334F; - bottom: 0; - display: none; - left: 0; - overflow: hidden; - position: absolute; - top: 91px; - width: 229px; -} - -#tocContainer > ul#toc { - font-size: 11px; - margin: 0; - padding: 12px 0 18px; - width: 209px; - -moz-user-select: none; - -webkit-user-select: none; - user-select: none; -} - -#tocContainer > ul#toc > li { - margin: 0; - padding: 0 0 7px 30px; - text-indent: -15px; -} - -#tocContainer > ul#toc > li > .sectionName a { - color: #000000; - font-weight: bold; -} - -#tocContainer > ul#toc > li > .sectionName a:hover { - text-decoration: none; -} - -#tocContainer > ul#toc li.children > ul { - display: none; - height: 0; -} - -#tocContainer > ul#toc > li > ul { - margin: 0; - padding: 0; -} - -#tocContainer > ul#toc > li > ul, ul#toc > li > ul > li { - margin-left: 0; - margin-bottom: 0; - padding-left: 15px; -} - -#tocContainer > ul#toc > li ul { - list-style: none; - margin-right: 0; - padding-right: 0; -} - -#tocContainer > ul#toc li.children.open > ul { - display: block; - height: auto; - margin-left: -15px; - padding-left: 0; -} - -#tocContainer > ul#toc > li > ul, ul#toc > li > ul > li { - margin-left: 0; - padding-left: 15px; -} - -#tocContainer li ul li { - margin-top: 0.583em; - overflow: hidden; - text-overflow: ellipsis; - white-space: nowrap; -} - -#tocContainer li ul li span.sectionName { - white-space: normal; -} - -#tocContainer > ul#toc > li > ul > li > .sectionName a { - font-weight: bold; -} - -#tocContainer > ul#toc > li > ul a { - color: #4F4F4F; -} - -/* @end */ - -/* @group Index formatting */ - -.index-title { - font-size: 13px; - font-weight: normal; -} - -.index-column { - float: left; - width: 30%; - min-width: 200px; - font-size: 11px; -} - -.index-column ul { - margin: 8px 0 0 0; - padding: 0; - list-style: none; -} - -.index-column ul li { - margin: 0 0 3px 0; - padding: 0; -} - -.hierarchy-column { - min-width: 400px; -} - -.hierarchy-column ul { - margin: 3px 0 0 15px; -} - -.hierarchy-column ul li { - list-style-type: square; -} - -/* @end */ - -/* @group Common formatting elements */ - -.title { - font-weight: normal; - font-size: 215%; - margin-top:0; -} - -.subtitle { - font-weight: normal; - font-size: 180%; - color: #3C4C6C; - border-bottom: 1px solid #5088C5; -} - -.subsubtitle { - font-weight: normal; - font-size: 145%; - height: 0.7em; -} - -.note { - border: 1px solid #5088C5; - background-color: white; - margin: 1.667em 0 1.75em 0; - padding: 0 .667em .083em .750em; -} - -.warning { - border: 1px solid #5088C5; - background-color: #F0F3F7; - margin-bottom: 0.5em; - padding: 0.3em 0.8em; -} - -.bug { - border: 1px solid #000; - background-color: #ffffcc; - margin-bottom: 0.5em; - padding: 0.3em 0.8em; -} - -.deprecated { - color: #F60425; -} - -/* @end */ - -/* @group Common layout */ - -.section { - margin-top: 3em; -} - -/* @end */ - -/* @group Object specification section */ - -.section-specification { - margin-left: 2.5em; - margin-right: 2.5em; - font-size: 12px; -} - -.section-specification table { - margin-bottom: 0em; - border-top: 1px solid #d6e0e5; -} - -.section-specification td { - vertical-align: top; - border-bottom: 1px solid #d6e0e5; - border-left-width: 0px; - border-right-width: 0px; - border-top-width: 0px; - padding: .6em; -} - -.section-specification .specification-title { - font-weight: bold; -} - -/* @end */ - -/* @group Tasks section */ - -.task-list { - list-style-type: none; - padding-left: 0px; -} - -.task-list li { - margin-bottom: 3px; -} - -.task-item-suffix { - color: #996; - font-size: 12px; - font-style: italic; - margin-left: 0.5em; -} - -span.tooltip span.tooltip { - font-size: 1.0em; - display: none; - padding: 0.3em; - border: 1px solid #aaa; - background-color: #fdfec8; - color: #000; - text-align: left; -} - -span.tooltip:hover span.tooltip { - display: block; - position: absolute; - margin-left: 2em; -} - -/* @end */ - -/* @group Method section */ - -.section-method { - margin-top: 2.3em; -} - -.method-title { - margin-bottom: 1.5em; -} - -.method-subtitle { - margin-top: 0.7em; - margin-bottom: 0.2em; -} - -.method-subsection p { - margin-top: 0.4em; - margin-bottom: 0.8em; -} - -.method-declaration { - margin-top:1.182em; - margin-bottom:.909em; -} - -.method-declaration code { - font:14px Courier, Consolas, monospace; - color:#000; -} - -.declaration { - color: #000; -} - -.argument-def { - margin-top: 0.3em; - margin-bottom: 0.3em; -} - -.argument-def dd { - margin-left: 1.25em; -} - -.see-also-section ul { - list-style-type: none; - padding-left: 0px; - margin-top: 0; -} - -.see-also-section li { - margin-bottom: 3px; -} - -.declared-in-ref { - color: #666; -} - -#tocContainer.hideInXcode { - display: none; - border: 0px solid black; -} - -#top_header.hideInXcode { - display: none; -} - -#contents.hideInXcode { - border: 0px solid black; - top: 0px; - left: 0px; -} - -/* @end */ - diff --git a/html/css/stylesPrint.css b/html/css/stylesPrint.css deleted file mode 100644 index dc54cd2..0000000 --- a/html/css/stylesPrint.css +++ /dev/null @@ -1,22 +0,0 @@ - -header { - display: none; -} - -div.main-navigation, div.navigation-top { - display: none; -} - -div#overview_contents, div#contents.isShowingTOC, div#contents { - overflow: visible; - position: relative; - top: 0px; - border: none; - left: 0; -} -#tocContainer.isShowingTOC { - display: none; -} -nav { - display: none; -}
\ No newline at end of file diff --git a/html/hierarchy.html b/html/hierarchy.html index dcb9dba..a1fd22c 100644 --- a/html/hierarchy.html +++ b/html/hierarchy.html @@ -1,65 +1,76 @@ -<!DOCTYPE HTML> +<!DOCTYPE html> <html> - <head> - <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> - <title>FMDB Hierarchy</title> - <link rel="stylesheet" type="text/css" href="css/styles.css" media="all" /> - <link rel="stylesheet" type="text/css" media="print" href="css/stylesPrint.css" /> - <meta name="generator" content="appledoc 2.1 (build 858)" /> - </head> - <body> - <header id="top_header"> - <div id="library" class="hideInXcode"> - <h1><a id="libraryTitle" href="index.html">FMDB </a></h1> - <a id="developerHome" href="index.html">ccgus</a> - </div> +<head> + <meta charset="utf-8"> + + <title>FMDB Hierarchy</title> + + <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)"> +</head> +<body class="appledoc"> + <header> + <div class="container" class="hide-in-xcode"> - <div id="title" role="banner"> - <h1 class="hideInXcode">FMDB Hierarchy</h1> - </div> - <ul id="headerButtons" role="toolbar"></ul> - </header> - <article> - <div id="overview_contents" role="main"> - <div class="main-navigation navigation-top"> - <a href="index.html">Previous</a> - </div> - <div id="header"> - <div class="section-header"> - <h1 class="title title-header">FMDB Hierarchy</h1> - </div> - </div> - <div id="container"> + <h1 id="library-title"> + <a href="index.html">FMDB </a> + </h1> + + <p id="developer-home"> + <a href="index.html">ccgus</a> + </p> + + </div> + </header> + + <aside> + <div class="container"> + <nav> + <ul id="header-buttons" role="toolbar"> + <li><a href="index.html">Home</a></li> + </ul> + </nav> + </div> + </aside> + + <article> + <div id="overview-contents" class="container"> + <div id="content"> + <main role="main"> + <h1 class="title">FMDB Hierarchy</h1> + <div class="index-column hierarchy-column"> <h2 class="index-title">Class Hierarchy</h2> - <ul> - - <li>NSObject - <ul> - - <li><a href="Classes/FMDatabase.html">FMDatabase</a></li> - - <li><a href="Classes/FMDatabasePool.html">FMDatabasePool</a></li> - - <li><a href="Classes/FMDatabaseQueue.html">FMDatabaseQueue</a></li> - - <li><a href="Classes/FMResultSet.html">FMResultSet</a></li> - - <li><a href="Classes/FMStatement.html">FMStatement</a></li> - - </ul> +<ul> + + <li>NSObject +<ul> + + <li><a href="Classes/FMDatabase.html">FMDatabase</a></li> + + <li><a href="Classes/FMDatabasePool.html">FMDatabasePool</a></li> + + <li><a href="Classes/FMDatabaseQueue.html">FMDatabaseQueue</a></li> + + <li><a href="Classes/FMResultSet.html">FMResultSet</a></li> + + <li><a href="Classes/FMStatement.html">FMStatement</a></li> + +</ul> </li> - - </ul> + +</ul> </div> + - <div class="index-column"> + <h2 class="index-title">Category References</h2> <ul> @@ -72,21 +83,22 @@ </div> - </div> - <div class="main-navigation navigation-bottom"> - <a href="index.html">Previous</a> - </div> - <div id="footer"> - <hr /> - <div class="footer-copyright"> - <p><span class="copyright">© 2014 ccgus. All rights reserved. (Last updated: 2014-05-25)</span><br /> - - <span class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.1 (build 858)</a>.</span></p> - - - </div> - </div> + + <footer> + <div class="footer-copyright"> + + <p class="copyright">Copyright © 2015 ccgus. All rights reserved. Updated: 2015-01-25</p> + + + <p class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.2.1 (build 1333)</a>.</p> + + </div> + </footer> + </main> </div> - </article> - </body> + </div> + </article> + + <script src="js/script.js"></script> +</body> </html>
\ No newline at end of file diff --git a/html/img/button_bar_background.png b/html/img/button_bar_background.png Binary files differindex abea717..71d1019 100644 --- a/html/img/button_bar_background.png +++ b/html/img/button_bar_background.png diff --git a/html/img/library_background.png b/html/img/library_background.png Binary files differindex 7b3486b..3006248 100644 --- a/html/img/library_background.png +++ b/html/img/library_background.png diff --git a/html/img/title_background.png b/html/img/title_background.png Binary files differindex 3bf0bb1..846e496 100644 --- a/html/img/title_background.png +++ b/html/img/title_background.png diff --git a/html/index.html b/html/index.html index cd07a44..fb5a6ce 100644 --- a/html/index.html +++ b/html/index.html @@ -1,88 +1,104 @@ -<!DOCTYPE HTML> +<!DOCTYPE html> <html> - <head> - <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> - <title>FMDB Reference</title> - <link rel="stylesheet" type="text/css" href="css/styles.css" media="all" /> - <link rel="stylesheet" type="text/css" media="print" href="css/stylesPrint.css" /> - <meta name="generator" content="appledoc 2.1 (build 858)" /> - </head> - <body> - <header id="top_header"> - <div id="library" class="hideInXcode"> - <h1><a id="libraryTitle" href="index.html">FMDB </a></h1> - <a id="developerHome" href="index.html">ccgus</a> - </div> +<head> + <meta charset="utf-8"> + + <title>FMDB Reference</title> + + <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)"> +</head> +<body class="appledoc"> + <header> + <div class="container" class="hide-in-xcode"> - <div id="title" role="banner"> - <h1 class="hideInXcode">FMDB Reference</h1> - </div> - <ul id="headerButtons" role="toolbar"></ul> - </header> - <article> - <div id="overview_contents" role="main"> - <div class="main-navigation navigation-top"> - <a href="hierarchy.html">Next</a> - </div> - <div id="header"> - <div class="section-header"> - <h1 class="title title-header">FMDB Reference</h1> - </div> - </div> - <div id="container"> - - - - - - <div class="index-column"> - <h2 class="index-title">Class References</h2> - <ul> - - <li><a href="Classes/FMDatabase.html">FMDatabase</a></li> - - <li><a href="Classes/FMDatabasePool.html">FMDatabasePool</a></li> - - <li><a href="Classes/FMDatabaseQueue.html">FMDatabaseQueue</a></li> - - <li><a href="Classes/FMResultSet.html">FMResultSet</a></li> - - <li><a href="Classes/FMStatement.html">FMStatement</a></li> - - </ul> - </div> - + <h1 id="library-title"> + <a href="index.html">FMDB </a> + </h1> + + <p id="developer-home"> + <a href="index.html">ccgus</a> + </p> + + </div> + </header> + + <aside> + <div class="container"> + <nav> + <ul id="header-buttons" role="toolbar"> + <li><a href="hierarchy.html">Hierarchy</a></li> + </ul> + </nav> + </div> + </aside> + + <article> + <div id="overview-contents" class="container"> + <div id="content"> + <main role="main"> + <h1 class="title">FMDB Reference</h1> + + + <div class="index-container"> + + - <div class="index-column"> + <div class="index-column"> + <h2 class="index-title">Class References</h2> + <ul> + + <li><a href="Classes/FMDatabase.html">FMDatabase</a></li> + + <li><a href="Classes/FMDatabasePool.html">FMDatabasePool</a></li> + + <li><a href="Classes/FMDatabaseQueue.html">FMDatabaseQueue</a></li> + + <li><a href="Classes/FMResultSet.html">FMResultSet</a></li> + + <li><a href="Classes/FMStatement.html">FMStatement</a></li> + + </ul> + </div> + - <h2 class="index-title">Category References</h2> - <ul> + <div class="index-column"> - <li><a href="Categories/FMDatabase+FMDatabaseAdditions.html">FMDatabase(FMDatabaseAdditions)</a></li> + - <li><a href="Categories/NSObject+FMDatabasePoolDelegate.html">NSObject(FMDatabasePoolDelegate)</a></li> + - </ul> - - </div> - - </div> - <div class="main-navigation navigation-bottom"> - <a href="hierarchy.html">Next</a> - </div> - <div id="footer"> - <hr /> - <div class="footer-copyright"> - <p><span class="copyright">© 2014 ccgus. All rights reserved. (Last updated: 2014-05-25)</span><br /> - - <span class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.1 (build 858)</a>.</span></p> + <h2 class="index-title">Category References</h2> + <ul> + + <li><a href="Categories/FMDatabase+FMDatabaseAdditions.html">FMDatabase(FMDatabaseAdditions)</a></li> + + <li><a href="Categories/NSObject+FMDatabasePoolDelegate.html">NSObject(FMDatabasePoolDelegate)</a></li> + + </ul> + + </div> - </div> - </div> + + <footer> + <div class="footer-copyright"> + + <p class="copyright">Copyright © 2015 ccgus. All rights reserved. Updated: 2015-01-25</p> + + + <p class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.2.1 (build 1333)</a>.</p> + + </div> + </footer> + </main> </div> - </article> - </body> + </div> + </article> + + <script src="js/script.js"></script> +</body> </html>
\ No newline at end of file diff --git a/html/js/script.js b/html/js/script.js new file mode 100644 index 0000000..ca915ee --- /dev/null +++ b/html/js/script.js @@ -0,0 +1,58 @@ +function $() { + return document.querySelector.apply(document, arguments); +} + +if (navigator.userAgent.indexOf("Xcode") != -1) { + document.documentElement.classList.add("xcode"); +} + +var jumpTo = $("#jump-to"); + +if (jumpTo) { + jumpTo.addEventListener("change", function(e) { + location.hash = this.options[this.selectedIndex].value; + }); +} + +function hashChanged() { + if (/^#\/\/api\//.test(location.hash)) { + var element = document.querySelector("a[name='" + location.hash.substring(1) + "']"); + + if (!element) { + return; + } + + element = element.parentNode; + + element.classList.remove("hide"); + fixScrollPosition(element); + } +} + +function fixScrollPosition(element) { + var scrollTop = element.offsetTop - 150; + document.documentElement.scrollTop = scrollTop; + document.body.scrollTop = scrollTop; +} + +[].forEach.call(document.querySelectorAll(".section-method"), function(element) { + element.classList.add("hide"); + + element.querySelector(".method-title a").addEventListener("click", function(e) { + var info = element.querySelector(".method-info"), + infoContainer = element.querySelector(".method-info-container"); + + element.classList.add("animating"); + info.style.height = (infoContainer.clientHeight + 40) + "px"; + fixScrollPosition(element); + element.classList.toggle("hide"); + + setTimeout(function() { + element.classList.remove("animating"); + info.style.height = "auto"; + }, 300); + }); +}); + +window.addEventListener("hashchange", hashChanged); +hashChanged(); |
