FMDatabase+FMDatabaseAdditions.html 39 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560
  1. <!DOCTYPE HTML>
  2. <html>
  3. <head>
  4. <meta http-equiv="Content-Type" content="html/html; charset=utf-8" />
  5. <title>FMDatabase(FMDatabaseAdditions) Category Reference</title>
  6. <meta id="xcode-display" name="xcode-display" content="render"/>
  7. <meta name="viewport" content="width=550" />
  8. <link rel="stylesheet" type="text/css" href="../css/styles.css" media="all" />
  9. <link rel="stylesheet" type="text/css" media="print" href="../css/stylesPrint.css" />
  10. <meta name="generator" content="appledoc 2.1 (build 858)" />
  11. </head>
  12. <body>
  13. <header id="top_header">
  14. <div id="library" class="hideInXcode">
  15. <h1><a id="libraryTitle" href="../index.html">FMDB </a></h1>
  16. <a id="developerHome" href="../index.html">ccgus</a>
  17. </div>
  18. <div id="title" role="banner">
  19. <h1 class="hideInXcode">FMDatabase(FMDatabaseAdditions) Category Reference</h1>
  20. </div>
  21. <ul id="headerButtons" role="toolbar">
  22. <li id="toc_button">
  23. <button aria-label="Show Table of Contents" role="checkbox" class="open" id="table_of_contents"><span class="disclosure"></span>Table of Contents</button>
  24. </li>
  25. <li id="jumpto_button" role="navigation">
  26. <select id="jumpTo">
  27. <option value="top">Jump To&#133;</option>
  28. <option value="overview">Overview</option>
  29. <option value="tasks">Tasks</option>
  30. <option value="instance_methods">Instance Methods</option>
  31. <option value="//api/name/applicationID">&nbsp;&nbsp;&nbsp;&nbsp;- applicationID</option>
  32. <option value="//api/name/applicationIDString">&nbsp;&nbsp;&nbsp;&nbsp;- applicationIDString</option>
  33. <option value="//api/name/boolForQuery:">&nbsp;&nbsp;&nbsp;&nbsp;- boolForQuery:</option>
  34. <option value="//api/name/columnExists:columnName:">&nbsp;&nbsp;&nbsp;&nbsp;- columnExists:columnName:</option>
  35. <option value="//api/name/columnExists:inTableWithName:">&nbsp;&nbsp;&nbsp;&nbsp;- columnExists:inTableWithName:</option>
  36. <option value="//api/name/dataForQuery:">&nbsp;&nbsp;&nbsp;&nbsp;- dataForQuery:</option>
  37. <option value="//api/name/dateForQuery:">&nbsp;&nbsp;&nbsp;&nbsp;- dateForQuery:</option>
  38. <option value="//api/name/doubleForQuery:">&nbsp;&nbsp;&nbsp;&nbsp;- doubleForQuery:</option>
  39. <option value="//api/name/getSchema">&nbsp;&nbsp;&nbsp;&nbsp;- getSchema</option>
  40. <option value="//api/name/getTableSchema:">&nbsp;&nbsp;&nbsp;&nbsp;- getTableSchema:</option>
  41. <option value="//api/name/intForQuery:">&nbsp;&nbsp;&nbsp;&nbsp;- intForQuery:</option>
  42. <option value="//api/name/longForQuery:">&nbsp;&nbsp;&nbsp;&nbsp;- longForQuery:</option>
  43. <option value="//api/name/setApplicationID:">&nbsp;&nbsp;&nbsp;&nbsp;- setApplicationID:</option>
  44. <option value="//api/name/setApplicationIDString:">&nbsp;&nbsp;&nbsp;&nbsp;- setApplicationIDString:</option>
  45. <option value="//api/name/setUserVersion:">&nbsp;&nbsp;&nbsp;&nbsp;- setUserVersion:</option>
  46. <option value="//api/name/stringForQuery:">&nbsp;&nbsp;&nbsp;&nbsp;- stringForQuery:</option>
  47. <option value="//api/name/tableExists:">&nbsp;&nbsp;&nbsp;&nbsp;- tableExists:</option>
  48. <option value="//api/name/userVersion">&nbsp;&nbsp;&nbsp;&nbsp;- userVersion</option>
  49. <option value="//api/name/validateSQL:error:">&nbsp;&nbsp;&nbsp;&nbsp;- validateSQL:error:</option>
  50. </select>
  51. </li>
  52. </ul>
  53. </header>
  54. <nav id="tocContainer" class="isShowingTOC">
  55. <ul id="toc" role="tree">
  56. <li role="treeitem"><span class="nodisclosure"></span><span class="sectionName"><a href="#overview">Overview</a></span></li>
  57. <li role="treeitem" id="task_treeitem"><span class="nodisclosure"></span><span class="sectionName"><a href="#tasks">Tasks</a></span><ul>
  58. </ul></li>
  59. <li role="treeitem" class="children"><span class="disclosure"></span><span class="sectionName"><a href="#instance_methods">Instance Methods</a></span><ul>
  60. <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/applicationID">applicationID</a></span></li>
  61. <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/applicationIDString">applicationIDString</a></span></li>
  62. <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/boolForQuery:">boolForQuery:</a></span></li>
  63. <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/columnExists:columnName:">columnExists:columnName:</a></span></li>
  64. <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/columnExists:inTableWithName:">columnExists:inTableWithName:</a></span></li>
  65. <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/dataForQuery:">dataForQuery:</a></span></li>
  66. <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/dateForQuery:">dateForQuery:</a></span></li>
  67. <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/doubleForQuery:">doubleForQuery:</a></span></li>
  68. <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/getSchema">getSchema</a></span></li>
  69. <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/getTableSchema:">getTableSchema:</a></span></li>
  70. <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/intForQuery:">intForQuery:</a></span></li>
  71. <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/longForQuery:">longForQuery:</a></span></li>
  72. <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/setApplicationID:">setApplicationID:</a></span></li>
  73. <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/setApplicationIDString:">setApplicationIDString:</a></span></li>
  74. <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/setUserVersion:">setUserVersion:</a></span></li>
  75. <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/stringForQuery:">stringForQuery:</a></span></li>
  76. <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/tableExists:">tableExists:</a></span></li>
  77. <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/userVersion">userVersion</a></span></li>
  78. <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/validateSQL:error:">validateSQL:error:</a></span></li>
  79. </ul></li>
  80. </ul>
  81. </nav>
  82. <article>
  83. <div id="contents" class="isShowingTOC" role="main">
  84. <a title="FMDatabase(FMDatabaseAdditions) Category Reference" name="top"></a>
  85. <div class="main-navigation navigation-top">
  86. <ul>
  87. <li><a href="../index.html">Index</a></li>
  88. <li><a href="../hierarchy.html">Hierarchy</a></li>
  89. </ul>
  90. </div>
  91. <div id="header">
  92. <div class="section-header">
  93. <h1 class="title title-header">FMDatabase(FMDatabaseAdditions) Category Reference</h1>
  94. </div>
  95. </div>
  96. <div id="container">
  97. <div class="section section-specification"><table cellspacing="0"><tbody>
  98. <tr>
  99. <td class="specification-title">Declared in</td>
  100. <td class="specification-value">FMDatabaseAdditions.h<br />FMDatabaseAdditions.m</td>
  101. </tr>
  102. </tbody></table></div>
  103. <div class="section section-overview">
  104. <a title="Overview" name="overview"></a>
  105. <h2 class="subtitle subtitle-overview">Overview</h2>
  106. <p>Category of additions for <a href="../Classes/FMDatabase.html"><code>FMDatabase</code></a> class.</p>
  107. <h3>See also</h3>
  108. <ul>
  109. <li><a href="../Classes/FMDatabase.html"><code>FMDatabase</code></a></li>
  110. </ul>
  111. </div>
  112. <div class="section section-tasks">
  113. <a title="Tasks" name="tasks"></a>
  114. <h2 class="subtitle subtitle-tasks">Tasks</h2>
  115. <ul class="task-list">
  116. <li>
  117. <span class="tooltip">
  118. <code><a href="#//api/name/stringForQuery:">&ndash;&nbsp;stringForQuery:</a></code>
  119. <span class="tooltip"><p>Return <code>NSString</code> value for query</p></span>
  120. </span>
  121. </li><li>
  122. <span class="tooltip">
  123. <code><a href="#//api/name/intForQuery:">&ndash;&nbsp;intForQuery:</a></code>
  124. <span class="tooltip"><p>Return <code>int</code> value for query</p></span>
  125. </span>
  126. </li><li>
  127. <span class="tooltip">
  128. <code><a href="#//api/name/longForQuery:">&ndash;&nbsp;longForQuery:</a></code>
  129. <span class="tooltip"><p>Return <code>long</code> value for query</p></span>
  130. </span>
  131. </li><li>
  132. <span class="tooltip">
  133. <code><a href="#//api/name/boolForQuery:">&ndash;&nbsp;boolForQuery:</a></code>
  134. <span class="tooltip"><p>Return <code>BOOL</code> value for query</p></span>
  135. </span>
  136. </li><li>
  137. <span class="tooltip">
  138. <code><a href="#//api/name/doubleForQuery:">&ndash;&nbsp;doubleForQuery:</a></code>
  139. <span class="tooltip"><p>Return <code>double</code> value for query</p></span>
  140. </span>
  141. </li><li>
  142. <span class="tooltip">
  143. <code><a href="#//api/name/dataForQuery:">&ndash;&nbsp;dataForQuery:</a></code>
  144. <span class="tooltip"><p>Return <code>NSData</code> value for query</p></span>
  145. </span>
  146. </li><li>
  147. <span class="tooltip">
  148. <code><a href="#//api/name/dateForQuery:">&ndash;&nbsp;dateForQuery:</a></code>
  149. <span class="tooltip"><p>Return <code>NSDate</code> value for query</p></span>
  150. </span>
  151. </li><li>
  152. <span class="tooltip">
  153. <code><a href="#//api/name/tableExists:">&ndash;&nbsp;tableExists:</a></code>
  154. <span class="tooltip"><p>Does table exist in database?</p></span>
  155. </span>
  156. </li><li>
  157. <span class="tooltip">
  158. <code><a href="#//api/name/getSchema">&ndash;&nbsp;getSchema</a></code>
  159. <span class="tooltip"><p>The schema of the database.</p></span>
  160. </span>
  161. </li><li>
  162. <span class="tooltip">
  163. <code><a href="#//api/name/getTableSchema:">&ndash;&nbsp;getTableSchema:</a></code>
  164. <span class="tooltip"><p>The schema of the database.</p></span>
  165. </span>
  166. </li><li>
  167. <span class="tooltip">
  168. <code><a href="#//api/name/columnExists:inTableWithName:">&ndash;&nbsp;columnExists:inTableWithName:</a></code>
  169. <span class="tooltip"><p>Test to see if particular column exists for particular table in database</p></span>
  170. </span>
  171. </li><li>
  172. <span class="tooltip">
  173. <code><a href="#//api/name/applicationID">&ndash;&nbsp;applicationID</a></code>
  174. <span class="tooltip"><p>Retrieve application ID</p></span>
  175. </span>
  176. </li><li>
  177. <span class="tooltip">
  178. <code><a href="#//api/name/setApplicationID:">&ndash;&nbsp;setApplicationID:</a></code>
  179. <span class="tooltip"><p>Set the application ID</p></span>
  180. </span>
  181. </li><li>
  182. <span class="tooltip">
  183. <code><a href="#//api/name/applicationIDString">&ndash;&nbsp;applicationIDString</a></code>
  184. <span class="tooltip"><p>Retrieve application ID string</p></span>
  185. </span>
  186. </li><li>
  187. <span class="tooltip">
  188. <code><a href="#//api/name/setApplicationIDString:">&ndash;&nbsp;setApplicationIDString:</a></code>
  189. <span class="tooltip"><p>Set the application ID string</p></span>
  190. </span>
  191. </li><li>
  192. <span class="tooltip">
  193. <code><a href="#//api/name/userVersion">&ndash;&nbsp;userVersion</a></code>
  194. <span class="tooltip"><p>Retrieve user version</p></span>
  195. </span>
  196. </li><li>
  197. <span class="tooltip">
  198. <code><a href="#//api/name/setUserVersion:">&ndash;&nbsp;setUserVersion:</a></code>
  199. <span class="tooltip"><p>Set the user-version</p></span>
  200. </span>
  201. </li><li>
  202. <span class="tooltip">
  203. <code><a href="#//api/name/columnExists:columnName:">&ndash;&nbsp;columnExists:columnName:</a></code>
  204. <span class="tooltip"><p>Test to see if particular column exists for particular table in database</p></span>
  205. </span>
  206. </li><li>
  207. <span class="tooltip">
  208. <code><a href="#//api/name/validateSQL:error:">&ndash;&nbsp;validateSQL:error:</a></code>
  209. <span class="tooltip"><p>Validate SQL statement</p></span>
  210. </span>
  211. </li>
  212. </ul>
  213. </div>
  214. <div class="section section-methods">
  215. <a title="Instance Methods" name="instance_methods"></a>
  216. <h2 class="subtitle subtitle-methods">Instance Methods</h2>
  217. <div class="section-method">
  218. <a name="//api/name/applicationID" title="applicationID"></a>
  219. <h3 class="subsubtitle method-title">applicationID</h3>
  220. <div class="method-subsection brief-description">
  221. <p>Retrieve application ID</p>
  222. </div>
  223. <div class="method-subsection method-declaration"><code>- (uint32_t)applicationID</code></div>
  224. <div class="method-subsection return">
  225. <h4 class="method-subtitle parameter-title">Return Value</h4>
  226. <p>The <code>uint32_t</code> numeric value of the application ID.</p>
  227. </div>
  228. <div class="method-subsection see-also-section">
  229. <h4 class="method-subtitle">See Also</h4>
  230. <ul>
  231. <li><code><p><a href="#//api/name/setApplicationID:">- setApplicationID:</a></p></code></li>
  232. </ul>
  233. </div>
  234. <div class="method-subsection declared-in-section">
  235. <h4 class="method-subtitle">Declared In</h4>
  236. <code class="declared-in-ref">FMDatabaseAdditions.h</code><br />
  237. </div>
  238. </div>
  239. <div class="section-method">
  240. <a name="//api/name/applicationIDString" title="applicationIDString"></a>
  241. <h3 class="subsubtitle method-title">applicationIDString</h3>
  242. <div class="method-subsection brief-description">
  243. <p>Retrieve application ID string</p>
  244. </div>
  245. <div class="method-subsection method-declaration"><code>- (NSString *)applicationIDString</code></div>
  246. <div class="method-subsection return">
  247. <h4 class="method-subtitle parameter-title">Return Value</h4>
  248. <p>The <code>NSString</code> value of the application ID.</p>
  249. </div>
  250. <div class="method-subsection see-also-section">
  251. <h4 class="method-subtitle">See Also</h4>
  252. <ul>
  253. <li><code><p><a href="#//api/name/setApplicationIDString:">- setApplicationIDString:</a></p></code></li>
  254. </ul>
  255. </div>
  256. <div class="method-subsection declared-in-section">
  257. <h4 class="method-subtitle">Declared In</h4>
  258. <code class="declared-in-ref">FMDatabaseAdditions.h</code><br />
  259. </div>
  260. </div>
  261. <div class="section-method">
  262. <a name="//api/name/boolForQuery:" title="boolForQuery:"></a>
  263. <h3 class="subsubtitle method-title">boolForQuery:</h3>
  264. <div class="method-subsection brief-description">
  265. <p>Return <code>BOOL</code> value for query</p>
  266. </div>
  267. <div class="method-subsection method-declaration"><code>- (BOOL)boolForQuery:(NSString *)<em>query</em>, <em>...</em></code></div>
  268. <div class="method-subsection arguments-section parameters">
  269. <h4 class="method-subtitle parameter-title">Parameters</h4>
  270. <dl class="argument-def parameter-def">
  271. <dt><em>query</em></dt>
  272. <dd><p>The SQL query to be performed.</p></dd>
  273. </dl>
  274. <dl class="argument-def parameter-def">
  275. <dt><em>...</em></dt>
  276. <dd><p>A list of parameters that will be bound to the <code>?</code> placeholders in the SQL query.</p></dd>
  277. </dl>
  278. </div>
  279. <div class="method-subsection return">
  280. <h4 class="method-subtitle parameter-title">Return Value</h4>
  281. <p><code>BOOL</code> value.</p>
  282. </div>
  283. <div class="method-subsection declared-in-section">
  284. <h4 class="method-subtitle">Declared In</h4>
  285. <code class="declared-in-ref">FMDatabaseAdditions.h</code><br />
  286. </div>
  287. </div>
  288. <div class="section-method">
  289. <a name="//api/name/columnExists:columnName:" title="columnExists:columnName:"></a>
  290. <h3 class="subsubtitle method-title">columnExists:columnName:</h3>
  291. <div class="method-subsection brief-description">
  292. <p>Test to see if particular column exists for particular table in database</p>
  293. </div>
  294. <div class="method-subsection method-declaration"><code>- (BOOL)columnExists:(NSString *)<em>tableName</em> columnName:(NSString *)<em>columnName</em></code></div>
  295. <div class="method-subsection arguments-section parameters">
  296. <h4 class="method-subtitle parameter-title">Parameters</h4>
  297. <dl class="argument-def parameter-def">
  298. <dt><em>tableName</em></dt>
  299. <dd><p>The name of the table.</p></dd>
  300. </dl>
  301. <dl class="argument-def parameter-def">
  302. <dt><em>columnName</em></dt>
  303. <dd><p>The name of the column.</p></dd>
  304. </dl>
  305. </div>
  306. <div class="method-subsection return">
  307. <h4 class="method-subtitle parameter-title">Return Value</h4>
  308. <p><code>YES</code> if column exists in table in question; <code>NO</code> otherwise.</p>
  309. </div>
  310. <div class="method-subsection discussion-section">
  311. <h4 class="method-subtitle">Discussion</h4>
  312. <div class="warning"><p><strong>Warning:</strong> Deprecated - use <a href="#//api/name/columnExists:inTableWithName:"><code>columnExists:inTableWithName:</code></a> instead.</p></div>
  313. </div>
  314. <div class="method-subsection see-also-section">
  315. <h4 class="method-subtitle">See Also</h4>
  316. <ul>
  317. <li><code><p><a href="#//api/name/columnExists:inTableWithName:">- columnExists:inTableWithName:</a></p></code></li>
  318. </ul>
  319. </div>
  320. <div class="method-subsection declared-in-section">
  321. <h4 class="method-subtitle">Declared In</h4>
  322. <code class="declared-in-ref">FMDatabaseAdditions.h</code><br />
  323. </div>
  324. </div>
  325. <div class="section-method">
  326. <a name="//api/name/columnExists:inTableWithName:" title="columnExists:inTableWithName:"></a>
  327. <h3 class="subsubtitle method-title">columnExists:inTableWithName:</h3>
  328. <div class="method-subsection brief-description">
  329. <p>Test to see if particular column exists for particular table in database</p>
  330. </div>
  331. <div class="method-subsection method-declaration"><code>- (BOOL)columnExists:(NSString *)<em>columnName</em> inTableWithName:(NSString *)<em>tableName</em></code></div>
  332. <div class="method-subsection arguments-section parameters">
  333. <h4 class="method-subtitle parameter-title">Parameters</h4>
  334. <dl class="argument-def parameter-def">
  335. <dt><em>columnName</em></dt>
  336. <dd><p>The name of the column.</p></dd>
  337. </dl>
  338. <dl class="argument-def parameter-def">
  339. <dt><em>tableName</em></dt>
  340. <dd><p>The name of the table.</p></dd>
  341. </dl>
  342. </div>
  343. <div class="method-subsection return">
  344. <h4 class="method-subtitle parameter-title">Return Value</h4>
  345. <p><code>YES</code> if column exists in table in question; <code>NO</code> otherwise.</p>
  346. </div>
  347. <div class="method-subsection declared-in-section">
  348. <h4 class="method-subtitle">Declared In</h4>
  349. <code class="declared-in-ref">FMDatabaseAdditions.h</code><br />
  350. </div>
  351. </div>
  352. <div class="section-method">
  353. <a name="//api/name/dataForQuery:" title="dataForQuery:"></a>
  354. <h3 class="subsubtitle method-title">dataForQuery:</h3>
  355. <div class="method-subsection brief-description">
  356. <p>Return <code>NSData</code> value for query</p>
  357. </div>
  358. <div class="method-subsection method-declaration"><code>- (NSData *)dataForQuery:(NSString *)<em>query</em>, <em>...</em></code></div>
  359. <div class="method-subsection arguments-section parameters">
  360. <h4 class="method-subtitle parameter-title">Parameters</h4>
  361. <dl class="argument-def parameter-def">
  362. <dt><em>query</em></dt>
  363. <dd><p>The SQL query to be performed.</p></dd>
  364. </dl>
  365. <dl class="argument-def parameter-def">
  366. <dt><em>...</em></dt>
  367. <dd><p>A list of parameters that will be bound to the <code>?</code> placeholders in the SQL query.</p></dd>
  368. </dl>
  369. </div>
  370. <div class="method-subsection return">
  371. <h4 class="method-subtitle parameter-title">Return Value</h4>
  372. <p><code>NSData</code> value.</p>
  373. </div>
  374. <div class="method-subsection declared-in-section">
  375. <h4 class="method-subtitle">Declared In</h4>
  376. <code class="declared-in-ref">FMDatabaseAdditions.h</code><br />
  377. </div>
  378. </div>
  379. <div class="section-method">
  380. <a name="//api/name/dateForQuery:" title="dateForQuery:"></a>
  381. <h3 class="subsubtitle method-title">dateForQuery:</h3>
  382. <div class="method-subsection brief-description">
  383. <p>Return <code>NSDate</code> value for query</p>
  384. </div>
  385. <div class="method-subsection method-declaration"><code>- (NSDate *)dateForQuery:(NSString *)<em>query</em>, <em>...</em></code></div>
  386. <div class="method-subsection arguments-section parameters">
  387. <h4 class="method-subtitle parameter-title">Parameters</h4>
  388. <dl class="argument-def parameter-def">
  389. <dt><em>query</em></dt>
  390. <dd><p>The SQL query to be performed.</p></dd>
  391. </dl>
  392. <dl class="argument-def parameter-def">
  393. <dt><em>...</em></dt>
  394. <dd><p>A list of parameters that will be bound to the <code>?</code> placeholders in the SQL query.</p></dd>
  395. </dl>
  396. </div>
  397. <div class="method-subsection return">
  398. <h4 class="method-subtitle parameter-title">Return Value</h4>
  399. <p><code>NSDate</code> value.</p>
  400. </div>
  401. <div class="method-subsection declared-in-section">
  402. <h4 class="method-subtitle">Declared In</h4>
  403. <code class="declared-in-ref">FMDatabaseAdditions.h</code><br />
  404. </div>
  405. </div>
  406. <div class="section-method">
  407. <a name="//api/name/doubleForQuery:" title="doubleForQuery:"></a>
  408. <h3 class="subsubtitle method-title">doubleForQuery:</h3>
  409. <div class="method-subsection brief-description">
  410. <p>Return <code>double</code> value for query</p>
  411. </div>
  412. <div class="method-subsection method-declaration"><code>- (double)doubleForQuery:(NSString *)<em>query</em>, <em>...</em></code></div>
  413. <div class="method-subsection arguments-section parameters">
  414. <h4 class="method-subtitle parameter-title">Parameters</h4>
  415. <dl class="argument-def parameter-def">
  416. <dt><em>query</em></dt>
  417. <dd><p>The SQL query to be performed.</p></dd>
  418. </dl>
  419. <dl class="argument-def parameter-def">
  420. <dt><em>...</em></dt>
  421. <dd><p>A list of parameters that will be bound to the <code>?</code> placeholders in the SQL query.</p></dd>
  422. </dl>
  423. </div>
  424. <div class="method-subsection return">
  425. <h4 class="method-subtitle parameter-title">Return Value</h4>
  426. <p><code>double</code> value.</p>
  427. </div>
  428. <div class="method-subsection declared-in-section">
  429. <h4 class="method-subtitle">Declared In</h4>
  430. <code class="declared-in-ref">FMDatabaseAdditions.h</code><br />
  431. </div>
  432. </div>
  433. <div class="section-method">
  434. <a name="//api/name/getSchema" title="getSchema"></a>
  435. <h3 class="subsubtitle method-title">getSchema</h3>
  436. <div class="method-subsection brief-description">
  437. <p>The schema of the database.</p>
  438. </div>
  439. <div class="method-subsection method-declaration"><code>- (FMResultSet *)getSchema</code></div>
  440. <div class="method-subsection return">
  441. <h4 class="method-subtitle parameter-title">Return Value</h4>
  442. <p><code>FMResultSet</code> of schema; <code>nil</code> on error.</p>
  443. </div>
  444. <div class="method-subsection discussion-section">
  445. <h4 class="method-subtitle">Discussion</h4>
  446. <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>
  447. <ul>
  448. <li><code>type</code> - The type of entity (e.g. table, index, view, or trigger)</li>
  449. <li><code>name</code> - The name of the object</li>
  450. <li><code>tbl_name</code> - The name of the table to which the object references</li>
  451. <li><code>rootpage</code> - The page number of the root b-tree page for tables and indices</li>
  452. <li><code>sql</code> - The SQL that created the entity</li>
  453. </ul>
  454. </div>
  455. <div class="method-subsection see-also-section">
  456. <h4 class="method-subtitle">See Also</h4>
  457. <ul>
  458. <li><code><p><a href="http://www.sqlite.org/fileformat.html">SQLite File Format</a></p></code></li>
  459. </ul>
  460. </div>
  461. <div class="method-subsection declared-in-section">
  462. <h4 class="method-subtitle">Declared In</h4>
  463. <code class="declared-in-ref">FMDatabaseAdditions.h</code><br />
  464. </div>
  465. </div>
  466. <div class="section-method">
  467. <a name="//api/name/getTableSchema:" title="getTableSchema:"></a>
  468. <h3 class="subsubtitle method-title">getTableSchema:</h3>
  469. <div class="method-subsection brief-description">
  470. <p>The schema of the database.</p>
  471. </div>
  472. <div class="method-subsection method-declaration"><code>- (FMResultSet *)getTableSchema:(NSString *)<em>tableName</em></code></div>
  473. <div class="method-subsection arguments-section parameters">
  474. <h4 class="method-subtitle parameter-title">Parameters</h4>
  475. <dl class="argument-def parameter-def">
  476. <dt><em>tableName</em></dt>
  477. <dd><p>The name of the table for whom the schema will be returned.</p></dd>
  478. </dl>
  479. </div>
  480. <div class="method-subsection return">
  481. <h4 class="method-subtitle parameter-title">Return Value</h4>
  482. <p><code>FMResultSet</code> of schema; <code>nil</code> on error.</p>
  483. </div>
  484. <div class="method-subsection discussion-section">
  485. <h4 class="method-subtitle">Discussion</h4>
  486. <p>This will be the schema for a particular table as report by SQLite <code>PRAGMA</code>, for example:</p>
  487. <pre><code>PRAGMA table_info('employees')
  488. </code></pre>
  489. <p>This will report:</p>
  490. <ul>
  491. <li><code>cid</code> - The column ID number</li>
  492. <li><code>name</code> - The name of the column</li>
  493. <li><code>type</code> - The data type specified for the column</li>
  494. <li><code>notnull</code> - whether the field is defined as NOT NULL (i.e. values required)</li>
  495. <li><code>dflt_value</code> - The default value for the column</li>
  496. <li><code>pk</code> - Whether the field is part of the primary key of the table</li>
  497. </ul>
  498. </div>
  499. <div class="method-subsection see-also-section">
  500. <h4 class="method-subtitle">See Also</h4>
  501. <ul>
  502. <li><code><p><a href="http://www.sqlite.org/pragma.html#pragma_table_info">table_info</a></p></code></li>
  503. </ul>
  504. </div>
  505. <div class="method-subsection declared-in-section">
  506. <h4 class="method-subtitle">Declared In</h4>
  507. <code class="declared-in-ref">FMDatabaseAdditions.h</code><br />
  508. </div>
  509. </div>
  510. <div class="section-method">
  511. <a name="//api/name/intForQuery:" title="intForQuery:"></a>
  512. <h3 class="subsubtitle method-title">intForQuery:</h3>
  513. <div class="method-subsection brief-description">
  514. <p>Return <code>int</code> value for query</p>
  515. </div>
  516. <div class="method-subsection method-declaration"><code>- (int)intForQuery:(NSString *)<em>query</em>, <em>...</em></code></div>
  517. <div class="method-subsection arguments-section parameters">
  518. <h4 class="method-subtitle parameter-title">Parameters</h4>
  519. <dl class="argument-def parameter-def">
  520. <dt><em>query</em></dt>
  521. <dd><p>The SQL query to be performed.</p></dd>
  522. </dl>
  523. <dl class="argument-def parameter-def">
  524. <dt><em>...</em></dt>
  525. <dd><p>A list of parameters that will be bound to the <code>?</code> placeholders in the SQL query.</p></dd>
  526. </dl>
  527. </div>
  528. <div class="method-subsection return">
  529. <h4 class="method-subtitle parameter-title">Return Value</h4>
  530. <p><code>int</code> value.</p>
  531. </div>
  532. <div class="method-subsection declared-in-section">
  533. <h4 class="method-subtitle">Declared In</h4>
  534. <code class="declared-in-ref">FMDatabaseAdditions.h</code><br />
  535. </div>
  536. </div>
  537. <div class="section-method">
  538. <a name="//api/name/longForQuery:" title="longForQuery:"></a>
  539. <h3 class="subsubtitle method-title">longForQuery:</h3>
  540. <div class="method-subsection brief-description">
  541. <p>Return <code>long</code> value for query</p>
  542. </div>
  543. <div class="method-subsection method-declaration"><code>- (long)longForQuery:(NSString *)<em>query</em>, <em>...</em></code></div>
  544. <div class="method-subsection arguments-section parameters">
  545. <h4 class="method-subtitle parameter-title">Parameters</h4>
  546. <dl class="argument-def parameter-def">
  547. <dt><em>query</em></dt>
  548. <dd><p>The SQL query to be performed.</p></dd>
  549. </dl>
  550. <dl class="argument-def parameter-def">
  551. <dt><em>...</em></dt>
  552. <dd><p>A list of parameters that will be bound to the <code>?</code> placeholders in the SQL query.</p></dd>
  553. </dl>
  554. </div>
  555. <div class="method-subsection return">
  556. <h4 class="method-subtitle parameter-title">Return Value</h4>
  557. <p><code>long</code> value.</p>
  558. </div>
  559. <div class="method-subsection declared-in-section">
  560. <h4 class="method-subtitle">Declared In</h4>
  561. <code class="declared-in-ref">FMDatabaseAdditions.h</code><br />
  562. </div>
  563. </div>
  564. <div class="section-method">
  565. <a name="//api/name/setApplicationID:" title="setApplicationID:"></a>
  566. <h3 class="subsubtitle method-title">setApplicationID:</h3>
  567. <div class="method-subsection brief-description">
  568. <p>Set the application ID</p>
  569. </div>
  570. <div class="method-subsection method-declaration"><code>- (void)setApplicationID:(uint32_t)<em>appID</em></code></div>
  571. <div class="method-subsection arguments-section parameters">
  572. <h4 class="method-subtitle parameter-title">Parameters</h4>
  573. <dl class="argument-def parameter-def">
  574. <dt><em>appID</em></dt>
  575. <dd><p>The <code>uint32_t</code> numeric value of the application ID.</p></dd>
  576. </dl>
  577. </div>
  578. <div class="method-subsection see-also-section">
  579. <h4 class="method-subtitle">See Also</h4>
  580. <ul>
  581. <li><code><p><a href="#//api/name/applicationID">- applicationID</a></p></code></li>
  582. </ul>
  583. </div>
  584. <div class="method-subsection declared-in-section">
  585. <h4 class="method-subtitle">Declared In</h4>
  586. <code class="declared-in-ref">FMDatabaseAdditions.h</code><br />
  587. </div>
  588. </div>
  589. <div class="section-method">
  590. <a name="//api/name/setApplicationIDString:" title="setApplicationIDString:"></a>
  591. <h3 class="subsubtitle method-title">setApplicationIDString:</h3>
  592. <div class="method-subsection brief-description">
  593. <p>Set the application ID string</p>
  594. </div>
  595. <div class="method-subsection method-declaration"><code>- (void)setApplicationIDString:(NSString *)<em>string</em></code></div>
  596. <div class="method-subsection arguments-section parameters">
  597. <h4 class="method-subtitle parameter-title">Parameters</h4>
  598. <dl class="argument-def parameter-def">
  599. <dt><em>string</em></dt>
  600. <dd><p>The <code>NSString</code> value of the application ID.</p></dd>
  601. </dl>
  602. </div>
  603. <div class="method-subsection see-also-section">
  604. <h4 class="method-subtitle">See Also</h4>
  605. <ul>
  606. <li><code><p><a href="#//api/name/applicationIDString">- applicationIDString</a></p></code></li>
  607. </ul>
  608. </div>
  609. <div class="method-subsection declared-in-section">
  610. <h4 class="method-subtitle">Declared In</h4>
  611. <code class="declared-in-ref">FMDatabaseAdditions.h</code><br />
  612. </div>
  613. </div>
  614. <div class="section-method">
  615. <a name="//api/name/setUserVersion:" title="setUserVersion:"></a>
  616. <h3 class="subsubtitle method-title">setUserVersion:</h3>
  617. <div class="method-subsection brief-description">
  618. <p>Set the user-version</p>
  619. </div>
  620. <div class="method-subsection method-declaration"><code>- (void)setUserVersion:(uint32_t)<em>version</em></code></div>
  621. <div class="method-subsection arguments-section parameters">
  622. <h4 class="method-subtitle parameter-title">Parameters</h4>
  623. <dl class="argument-def parameter-def">
  624. <dt><em>version</em></dt>
  625. <dd><p>The <code>uint32_t</code> numeric value of the user version.</p></dd>
  626. </dl>
  627. </div>
  628. <div class="method-subsection see-also-section">
  629. <h4 class="method-subtitle">See Also</h4>
  630. <ul>
  631. <li><code><p><a href="#//api/name/userVersion">- userVersion</a></p></code></li>
  632. </ul>
  633. </div>
  634. <div class="method-subsection declared-in-section">
  635. <h4 class="method-subtitle">Declared In</h4>
  636. <code class="declared-in-ref">FMDatabaseAdditions.h</code><br />
  637. </div>
  638. </div>
  639. <div class="section-method">
  640. <a name="//api/name/stringForQuery:" title="stringForQuery:"></a>
  641. <h3 class="subsubtitle method-title">stringForQuery:</h3>
  642. <div class="method-subsection brief-description">
  643. <p>Return <code>NSString</code> value for query</p>
  644. </div>
  645. <div class="method-subsection method-declaration"><code>- (NSString *)stringForQuery:(NSString *)<em>query</em>, <em>...</em></code></div>
  646. <div class="method-subsection arguments-section parameters">
  647. <h4 class="method-subtitle parameter-title">Parameters</h4>
  648. <dl class="argument-def parameter-def">
  649. <dt><em>query</em></dt>
  650. <dd><p>The SQL query to be performed.</p></dd>
  651. </dl>
  652. <dl class="argument-def parameter-def">
  653. <dt><em>...</em></dt>
  654. <dd><p>A list of parameters that will be bound to the <code>?</code> placeholders in the SQL query.</p></dd>
  655. </dl>
  656. </div>
  657. <div class="method-subsection return">
  658. <h4 class="method-subtitle parameter-title">Return Value</h4>
  659. <p><code>NSString</code> value.</p>
  660. </div>
  661. <div class="method-subsection declared-in-section">
  662. <h4 class="method-subtitle">Declared In</h4>
  663. <code class="declared-in-ref">FMDatabaseAdditions.h</code><br />
  664. </div>
  665. </div>
  666. <div class="section-method">
  667. <a name="//api/name/tableExists:" title="tableExists:"></a>
  668. <h3 class="subsubtitle method-title">tableExists:</h3>
  669. <div class="method-subsection brief-description">
  670. <p>Does table exist in database?</p>
  671. </div>
  672. <div class="method-subsection method-declaration"><code>- (BOOL)tableExists:(NSString *)<em>tableName</em></code></div>
  673. <div class="method-subsection arguments-section parameters">
  674. <h4 class="method-subtitle parameter-title">Parameters</h4>
  675. <dl class="argument-def parameter-def">
  676. <dt><em>tableName</em></dt>
  677. <dd><p>The name of the table being looked for.</p></dd>
  678. </dl>
  679. </div>
  680. <div class="method-subsection return">
  681. <h4 class="method-subtitle parameter-title">Return Value</h4>
  682. <p><code>YES</code> if table found; <code>NO</code> if not found.</p>
  683. </div>
  684. <div class="method-subsection declared-in-section">
  685. <h4 class="method-subtitle">Declared In</h4>
  686. <code class="declared-in-ref">FMDatabaseAdditions.h</code><br />
  687. </div>
  688. </div>
  689. <div class="section-method">
  690. <a name="//api/name/userVersion" title="userVersion"></a>
  691. <h3 class="subsubtitle method-title">userVersion</h3>
  692. <div class="method-subsection brief-description">
  693. <p>Retrieve user version</p>
  694. </div>
  695. <div class="method-subsection method-declaration"><code>- (uint32_t)userVersion</code></div>
  696. <div class="method-subsection return">
  697. <h4 class="method-subtitle parameter-title">Return Value</h4>
  698. <p>The <code>uint32_t</code> numeric value of the user version.</p>
  699. </div>
  700. <div class="method-subsection see-also-section">
  701. <h4 class="method-subtitle">See Also</h4>
  702. <ul>
  703. <li><code><p><a href="#//api/name/setUserVersion:">- setUserVersion:</a></p></code></li>
  704. </ul>
  705. </div>
  706. <div class="method-subsection declared-in-section">
  707. <h4 class="method-subtitle">Declared In</h4>
  708. <code class="declared-in-ref">FMDatabaseAdditions.h</code><br />
  709. </div>
  710. </div>
  711. <div class="section-method">
  712. <a name="//api/name/validateSQL:error:" title="validateSQL:error:"></a>
  713. <h3 class="subsubtitle method-title">validateSQL:error:</h3>
  714. <div class="method-subsection brief-description">
  715. <p>Validate SQL statement</p>
  716. </div>
  717. <div class="method-subsection method-declaration"><code>- (BOOL)validateSQL:(NSString *)<em>sql</em> error:(NSError **)<em>error</em></code></div>
  718. <div class="method-subsection arguments-section parameters">
  719. <h4 class="method-subtitle parameter-title">Parameters</h4>
  720. <dl class="argument-def parameter-def">
  721. <dt><em>sql</em></dt>
  722. <dd><p>The SQL statement being validated.</p></dd>
  723. </dl>
  724. <dl class="argument-def parameter-def">
  725. <dt><em>error</em></dt>
  726. <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>
  727. </dl>
  728. </div>
  729. <div class="method-subsection return">
  730. <h4 class="method-subtitle parameter-title">Return Value</h4>
  731. <p><code>YES</code> if validation succeeded without incident; <code>NO</code> otherwise.</p>
  732. </div>
  733. <div class="method-subsection discussion-section">
  734. <h4 class="method-subtitle">Discussion</h4>
  735. <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>
  736. </div>
  737. <div class="method-subsection declared-in-section">
  738. <h4 class="method-subtitle">Declared In</h4>
  739. <code class="declared-in-ref">FMDatabaseAdditions.h</code><br />
  740. </div>
  741. </div>
  742. </div>
  743. </div>
  744. <div class="main-navigation navigation-bottom">
  745. <ul>
  746. <li><a href="../index.html">Index</a></li>
  747. <li><a href="../hierarchy.html">Hierarchy</a></li>
  748. </ul>
  749. </div>
  750. <div id="footer">
  751. <hr />
  752. <div class="footer-copyright">
  753. <p><span class="copyright">&copy; 2014 ccgus. All rights reserved. (Last updated: 2014-05-25)</span><br />
  754. <span class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.1 (build 858)</a>.</span></p>
  755. </div>
  756. </div>
  757. </div>
  758. </article>
  759. <script type="text/javascript">
  760. function jumpToChange()
  761. {
  762. window.location.hash = this.options[this.selectedIndex].value;
  763. }
  764. function toggleTOC()
  765. {
  766. var contents = document.getElementById('contents');
  767. var tocContainer = document.getElementById('tocContainer');
  768. if (this.getAttribute('class') == 'open')
  769. {
  770. this.setAttribute('class', '');
  771. contents.setAttribute('class', '');
  772. tocContainer.setAttribute('class', '');
  773. window.name = "hideTOC";
  774. }
  775. else
  776. {
  777. this.setAttribute('class', 'open');
  778. contents.setAttribute('class', 'isShowingTOC');
  779. tocContainer.setAttribute('class', 'isShowingTOC');
  780. window.name = "";
  781. }
  782. return false;
  783. }
  784. function toggleTOCEntryChildren(e)
  785. {
  786. e.stopPropagation();
  787. var currentClass = this.getAttribute('class');
  788. if (currentClass == 'children') {
  789. this.setAttribute('class', 'children open');
  790. }
  791. else if (currentClass == 'children open') {
  792. this.setAttribute('class', 'children');
  793. }
  794. return false;
  795. }
  796. function tocEntryClick(e)
  797. {
  798. e.stopPropagation();
  799. return true;
  800. }
  801. function init()
  802. {
  803. var selectElement = document.getElementById('jumpTo');
  804. selectElement.addEventListener('change', jumpToChange, false);
  805. var tocButton = document.getElementById('table_of_contents');
  806. tocButton.addEventListener('click', toggleTOC, false);
  807. var taskTreeItem = document.getElementById('task_treeitem');
  808. if (taskTreeItem.getElementsByTagName('li').length > 0)
  809. {
  810. taskTreeItem.setAttribute('class', 'children');
  811. taskTreeItem.firstChild.setAttribute('class', 'disclosure');
  812. }
  813. var tocList = document.getElementById('toc');
  814. var tocEntries = tocList.getElementsByTagName('li');
  815. for (var i = 0; i < tocEntries.length; i++) {
  816. tocEntries[i].addEventListener('click', toggleTOCEntryChildren, false);
  817. }
  818. var tocLinks = tocList.getElementsByTagName('a');
  819. for (var i = 0; i < tocLinks.length; i++) {
  820. tocLinks[i].addEventListener('click', tocEntryClick, false);
  821. }
  822. if (window.name == "hideTOC") {
  823. toggleTOC.call(tocButton);
  824. }
  825. }
  826. window.onload = init;
  827. // If showing in Xcode, hide the TOC and Header
  828. if (navigator.userAgent.match(/xcode/i)) {
  829. document.getElementById("contents").className = "hideInXcode"
  830. document.getElementById("tocContainer").className = "hideInXcode"
  831. document.getElementById("top_header").className = "hideInXcode"
  832. }
  833. </script>
  834. </body>
  835. </html>