FMDatabasePool.html 30 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195
  1. <!DOCTYPE HTML>
  2. <html>
  3. <head>
  4. <meta http-equiv="Content-Type" content="html/html; charset=utf-8" />
  5. <title>FMDatabasePool Class Reference</title>
  6. <meta id="xcode-display" name="xcode-display" content="render"/>
  7. <meta name="viewport" content="width=550" />
  8. <link rel="stylesheet" type="text/css" href="../css/styles.css" media="all" />
  9. <link rel="stylesheet" type="text/css" media="print" href="../css/stylesPrint.css" />
  10. <meta name="generator" content="appledoc 2.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">FMDatabasePool Class 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="properties">Properties</option>
  31. <option value="//api/name/delegate">&nbsp;&nbsp;&nbsp;&nbsp;delegate</option>
  32. <option value="//api/name/maximumNumberOfDatabasesToCreate">&nbsp;&nbsp;&nbsp;&nbsp;maximumNumberOfDatabasesToCreate</option>
  33. <option value="//api/name/openFlags">&nbsp;&nbsp;&nbsp;&nbsp;openFlags</option>
  34. <option value="//api/name/path">&nbsp;&nbsp;&nbsp;&nbsp;path</option>
  35. <option value="class_methods">Class Methods</option>
  36. <option value="//api/name/databasePoolWithPath:">&nbsp;&nbsp;&nbsp;&nbsp;+ databasePoolWithPath:</option>
  37. <option value="//api/name/databasePoolWithPath:flags:">&nbsp;&nbsp;&nbsp;&nbsp;+ databasePoolWithPath:flags:</option>
  38. <option value="instance_methods">Instance Methods</option>
  39. <option value="//api/name/countOfCheckedInDatabases">&nbsp;&nbsp;&nbsp;&nbsp;- countOfCheckedInDatabases</option>
  40. <option value="//api/name/countOfCheckedOutDatabases">&nbsp;&nbsp;&nbsp;&nbsp;- countOfCheckedOutDatabases</option>
  41. <option value="//api/name/countOfOpenDatabases">&nbsp;&nbsp;&nbsp;&nbsp;- countOfOpenDatabases</option>
  42. <option value="//api/name/inDatabase:">&nbsp;&nbsp;&nbsp;&nbsp;- inDatabase:</option>
  43. <option value="//api/name/inDeferredTransaction:">&nbsp;&nbsp;&nbsp;&nbsp;- inDeferredTransaction:</option>
  44. <option value="//api/name/inSavePoint:">&nbsp;&nbsp;&nbsp;&nbsp;- inSavePoint:</option>
  45. <option value="//api/name/inTransaction:">&nbsp;&nbsp;&nbsp;&nbsp;- inTransaction:</option>
  46. <option value="//api/name/initWithPath:">&nbsp;&nbsp;&nbsp;&nbsp;- initWithPath:</option>
  47. <option value="//api/name/initWithPath:flags:">&nbsp;&nbsp;&nbsp;&nbsp;- initWithPath:flags:</option>
  48. <option value="//api/name/releaseAllDatabases">&nbsp;&nbsp;&nbsp;&nbsp;- releaseAllDatabases</option>
  49. </select>
  50. </li>
  51. </ul>
  52. </header>
  53. <nav id="tocContainer" class="isShowingTOC">
  54. <ul id="toc" role="tree">
  55. <li role="treeitem"><span class="nodisclosure"></span><span class="sectionName"><a href="#overview">Overview</a></span></li>
  56. <li role="treeitem" id="task_treeitem"><span class="nodisclosure"></span><span class="sectionName"><a href="#tasks">Tasks</a></span><ul>
  57. </ul></li>
  58. <li role="treeitem" class="children"><span class="disclosure"></span><span class="sectionName"><a href="#properties">Properties</a></span><ul>
  59. <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/delegate">delegate</a></span></li>
  60. <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/maximumNumberOfDatabasesToCreate">maximumNumberOfDatabasesToCreate</a></span></li>
  61. <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/openFlags">openFlags</a></span></li>
  62. <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/path">path</a></span></li>
  63. </ul></li>
  64. <li role="treeitem" class="children"><span class="disclosure"></span><span class="sectionName"><a href="#class_methods">Class Methods</a></span><ul>
  65. <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/databasePoolWithPath:">databasePoolWithPath:</a></span></li>
  66. <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/databasePoolWithPath:flags:">databasePoolWithPath:flags:</a></span></li>
  67. </ul></li>
  68. <li role="treeitem" class="children"><span class="disclosure"></span><span class="sectionName"><a href="#instance_methods">Instance Methods</a></span><ul>
  69. <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/countOfCheckedInDatabases">countOfCheckedInDatabases</a></span></li>
  70. <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/countOfCheckedOutDatabases">countOfCheckedOutDatabases</a></span></li>
  71. <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/countOfOpenDatabases">countOfOpenDatabases</a></span></li>
  72. <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/inDatabase:">inDatabase:</a></span></li>
  73. <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/inDeferredTransaction:">inDeferredTransaction:</a></span></li>
  74. <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/inSavePoint:">inSavePoint:</a></span></li>
  75. <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/inTransaction:">inTransaction:</a></span></li>
  76. <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/initWithPath:">initWithPath:</a></span></li>
  77. <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/initWithPath:flags:">initWithPath:flags:</a></span></li>
  78. <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/releaseAllDatabases">releaseAllDatabases</a></span></li>
  79. </ul></li>
  80. </ul>
  81. </nav>
  82. <article>
  83. <div id="contents" class="isShowingTOC" role="main">
  84. <a title="FMDatabasePool Class 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">FMDatabasePool Class 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">Inherits from</td>
  100. <td class="specification-value">NSObject</td>
  101. </tr><tr>
  102. <td class="specification-title">Declared in</td>
  103. <td class="specification-value">FMDatabasePool.h<br />FMDatabasePool.m</td>
  104. </tr>
  105. </tbody></table></div>
  106. <div class="section section-overview">
  107. <a title="Overview" name="overview"></a>
  108. <h2 class="subtitle subtitle-overview">Overview</h2>
  109. <p>Pool of <a href="../Classes/FMDatabase.html"><code>FMDatabase</code></a> objects.</p>
  110. <h3>See also</h3>
  111. <ul>
  112. <li><a href="../Classes/FMDatabaseQueue.html"><code>FMDatabaseQueue</code></a></li>
  113. <li><a href="../Classes/FMDatabase.html"><code>FMDatabase</code></a></li>
  114. </ul>
  115. <div class="warning"><p><strong>Warning:</strong> Before using <code>FMDatabasePool</code>, please consider using <a href="../Classes/FMDatabaseQueue.html"><code>FMDatabaseQueue</code></a> instead.</p>
  116. <p>If you really really really know what you&rsquo;re doing and <code>FMDatabasePool</code> is what
  117. you really really need (ie, you&rsquo;re using a read only database), OK you can use
  118. it. But just be careful not to deadlock!</p>
  119. <p>For an example on deadlocking, search for:
  120. <code>ONLY_USE_THE_POOL_IF_YOU_ARE_DOING_READS_OTHERWISE_YOULL_DEADLOCK_USE_FMDATABASEQUEUE_INSTEAD</code>
  121. in the main.m file.</p></div>
  122. </div>
  123. <div class="section section-tasks">
  124. <a title="Tasks" name="tasks"></a>
  125. <h2 class="subtitle subtitle-tasks">Tasks</h2>
  126. <h3 class="subsubtitle task-title">Other Methods</h3>
  127. <ul class="task-list">
  128. <li>
  129. <span class="tooltip">
  130. <code><a href="#//api/name/databasePoolWithPath:">+&nbsp;databasePoolWithPath:</a></code>
  131. <span class="tooltip"><p>Create pool using path.</p></span>
  132. </span>
  133. </li><li>
  134. <span class="tooltip">
  135. <code><a href="#//api/name/databasePoolWithPath:flags:">+&nbsp;databasePoolWithPath:flags:</a></code>
  136. <span class="tooltip"><p>Create pool using path and specified flags</p></span>
  137. </span>
  138. </li><li>
  139. <span class="tooltip">
  140. <code><a href="#//api/name/initWithPath:flags:">&ndash;&nbsp;initWithPath:flags:</a></code>
  141. <span class="tooltip"><p>Create pool using path and specified flags.</p></span>
  142. </span>
  143. </li><li>
  144. <span class="tooltip">
  145. <code><a href="#//api/name/initWithPath:">&ndash;&nbsp;initWithPath:</a></code>
  146. <span class="tooltip"><p>Create pool using path.</p></span>
  147. </span>
  148. </li><li>
  149. <span class="tooltip">
  150. <code><a href="#//api/name/countOfCheckedInDatabases">&ndash;&nbsp;countOfCheckedInDatabases</a></code>
  151. <span class="tooltip"><p>Number of checked-in databases in pool</p></span>
  152. </span>
  153. </li><li>
  154. <span class="tooltip">
  155. <code><a href="#//api/name/countOfCheckedOutDatabases">&ndash;&nbsp;countOfCheckedOutDatabases</a></code>
  156. <span class="tooltip"><p>Number of checked-out databases in pool</p></span>
  157. </span>
  158. </li><li>
  159. <span class="tooltip">
  160. <code><a href="#//api/name/countOfOpenDatabases">&ndash;&nbsp;countOfOpenDatabases</a></code>
  161. <span class="tooltip"><p>Total number of databases in pool</p></span>
  162. </span>
  163. </li><li>
  164. <span class="tooltip">
  165. <code><a href="#//api/name/releaseAllDatabases">&ndash;&nbsp;releaseAllDatabases</a></code>
  166. <span class="tooltip"><p>Release all databases in pool</p></span>
  167. </span>
  168. </li><li>
  169. <span class="tooltip">
  170. <code><a href="#//api/name/inDatabase:">&ndash;&nbsp;inDatabase:</a></code>
  171. <span class="tooltip"><p>Synchronously perform database operations in pool.</p></span>
  172. </span>
  173. </li><li>
  174. <span class="tooltip">
  175. <code><a href="#//api/name/inDeferredTransaction:">&ndash;&nbsp;inDeferredTransaction:</a></code>
  176. <span class="tooltip"><p>Synchronously perform database operations in pool using deferred transaction.</p></span>
  177. </span>
  178. </li><li>
  179. <span class="tooltip">
  180. <code><a href="#//api/name/inTransaction:">&ndash;&nbsp;inTransaction:</a></code>
  181. <span class="tooltip"><p>Synchronously perform database operations in pool using transaction.</p></span>
  182. </span>
  183. </li><li>
  184. <span class="tooltip">
  185. <code><a href="#//api/name/inSavePoint:">&ndash;&nbsp;inSavePoint:</a></code>
  186. <span class="tooltip"><p>Synchronously perform database operations in pool using save point.</p></span>
  187. </span>
  188. </li>
  189. </ul>
  190. <h3 class="subsubtitle task-title">Other Methods</h3>
  191. <ul class="task-list">
  192. <li>
  193. <span class="tooltip">
  194. <code><a href="#//api/name/path">&nbsp;&nbsp;path</a></code>
  195. <span class="tooltip"><p>Database path</p></span>
  196. </span>
  197. <span class="task-item-suffix">property</span>
  198. </li><li>
  199. <span class="tooltip">
  200. <code><a href="#//api/name/delegate">&nbsp;&nbsp;delegate</a></code>
  201. <span class="tooltip"><p>Delegate object</p></span>
  202. </span>
  203. <span class="task-item-suffix">property</span>
  204. </li><li>
  205. <span class="tooltip">
  206. <code><a href="#//api/name/maximumNumberOfDatabasesToCreate">&nbsp;&nbsp;maximumNumberOfDatabasesToCreate</a></code>
  207. <span class="tooltip"><p>Maximum number of databases to create</p></span>
  208. </span>
  209. <span class="task-item-suffix">property</span>
  210. </li><li>
  211. <span class="tooltip">
  212. <code><a href="#//api/name/openFlags">&nbsp;&nbsp;openFlags</a></code>
  213. <span class="tooltip"><p>Open flags</p></span>
  214. </span>
  215. <span class="task-item-suffix">property</span>
  216. </li>
  217. </ul>
  218. </div>
  219. <div class="section section-methods">
  220. <a title="Properties" name="properties"></a>
  221. <h2 class="subtitle subtitle-methods">Properties</h2>
  222. <div class="section-method">
  223. <a name="//api/name/delegate" title="delegate"></a>
  224. <h3 class="subsubtitle method-title">delegate</h3>
  225. <div class="method-subsection brief-description">
  226. <p>Delegate object</p>
  227. </div>
  228. <div class="method-subsection method-declaration"><code>@property (atomic, assign) id delegate</code></div>
  229. <div class="method-subsection declared-in-section">
  230. <h4 class="method-subtitle">Declared In</h4>
  231. <code class="declared-in-ref">FMDatabasePool.h</code><br />
  232. </div>
  233. </div>
  234. <div class="section-method">
  235. <a name="//api/name/maximumNumberOfDatabasesToCreate" title="maximumNumberOfDatabasesToCreate"></a>
  236. <h3 class="subsubtitle method-title">maximumNumberOfDatabasesToCreate</h3>
  237. <div class="method-subsection brief-description">
  238. <p>Maximum number of databases to create</p>
  239. </div>
  240. <div class="method-subsection method-declaration"><code>@property (atomic, assign) NSUInteger maximumNumberOfDatabasesToCreate</code></div>
  241. <div class="method-subsection declared-in-section">
  242. <h4 class="method-subtitle">Declared In</h4>
  243. <code class="declared-in-ref">FMDatabasePool.h</code><br />
  244. </div>
  245. </div>
  246. <div class="section-method">
  247. <a name="//api/name/openFlags" title="openFlags"></a>
  248. <h3 class="subsubtitle method-title">openFlags</h3>
  249. <div class="method-subsection brief-description">
  250. <p>Open flags</p>
  251. </div>
  252. <div class="method-subsection method-declaration"><code>@property (atomic, readonly) int openFlags</code></div>
  253. <div class="method-subsection declared-in-section">
  254. <h4 class="method-subtitle">Declared In</h4>
  255. <code class="declared-in-ref">FMDatabasePool.h</code><br />
  256. </div>
  257. </div>
  258. <div class="section-method">
  259. <a name="//api/name/path" title="path"></a>
  260. <h3 class="subsubtitle method-title">path</h3>
  261. <div class="method-subsection brief-description">
  262. <p>Database path</p>
  263. </div>
  264. <div class="method-subsection method-declaration"><code>@property (atomic, retain) NSString *path</code></div>
  265. <div class="method-subsection declared-in-section">
  266. <h4 class="method-subtitle">Declared In</h4>
  267. <code class="declared-in-ref">FMDatabasePool.h</code><br />
  268. </div>
  269. </div>
  270. </div>
  271. <div class="section section-methods">
  272. <a title="Class Methods" name="class_methods"></a>
  273. <h2 class="subtitle subtitle-methods">Class Methods</h2>
  274. <div class="section-method">
  275. <a name="//api/name/databasePoolWithPath:" title="databasePoolWithPath:"></a>
  276. <h3 class="subsubtitle method-title">databasePoolWithPath:</h3>
  277. <div class="method-subsection brief-description">
  278. <p>Create pool using path.</p>
  279. </div>
  280. <div class="method-subsection method-declaration"><code>+ (instancetype)databasePoolWithPath:(NSString *)<em>aPath</em></code></div>
  281. <div class="method-subsection arguments-section parameters">
  282. <h4 class="method-subtitle parameter-title">Parameters</h4>
  283. <dl class="argument-def parameter-def">
  284. <dt><em>aPath</em></dt>
  285. <dd><p>The file path of the database.</p></dd>
  286. </dl>
  287. </div>
  288. <div class="method-subsection return">
  289. <h4 class="method-subtitle parameter-title">Return Value</h4>
  290. <p>The <code>FMDatabasePool</code> object. <code>nil</code> on error.</p>
  291. </div>
  292. <div class="method-subsection declared-in-section">
  293. <h4 class="method-subtitle">Declared In</h4>
  294. <code class="declared-in-ref">FMDatabasePool.h</code><br />
  295. </div>
  296. </div>
  297. <div class="section-method">
  298. <a name="//api/name/databasePoolWithPath:flags:" title="databasePoolWithPath:flags:"></a>
  299. <h3 class="subsubtitle method-title">databasePoolWithPath:flags:</h3>
  300. <div class="method-subsection brief-description">
  301. <p>Create pool using path and specified flags</p>
  302. </div>
  303. <div class="method-subsection method-declaration"><code>+ (instancetype)databasePoolWithPath:(NSString *)<em>aPath</em> flags:(int)<em>openFlags</em></code></div>
  304. <div class="method-subsection arguments-section parameters">
  305. <h4 class="method-subtitle parameter-title">Parameters</h4>
  306. <dl class="argument-def parameter-def">
  307. <dt><em>aPath</em></dt>
  308. <dd><p>The file path of the database.</p></dd>
  309. </dl>
  310. <dl class="argument-def parameter-def">
  311. <dt><em>openFlags</em></dt>
  312. <dd><p>Flags passed to the openWithFlags method of the database</p></dd>
  313. </dl>
  314. </div>
  315. <div class="method-subsection return">
  316. <h4 class="method-subtitle parameter-title">Return Value</h4>
  317. <p>The <code>FMDatabasePool</code> object. <code>nil</code> on error.</p>
  318. </div>
  319. <div class="method-subsection declared-in-section">
  320. <h4 class="method-subtitle">Declared In</h4>
  321. <code class="declared-in-ref">FMDatabasePool.h</code><br />
  322. </div>
  323. </div>
  324. </div>
  325. <div class="section section-methods">
  326. <a title="Instance Methods" name="instance_methods"></a>
  327. <h2 class="subtitle subtitle-methods">Instance Methods</h2>
  328. <div class="section-method">
  329. <a name="//api/name/countOfCheckedInDatabases" title="countOfCheckedInDatabases"></a>
  330. <h3 class="subsubtitle method-title">countOfCheckedInDatabases</h3>
  331. <div class="method-subsection brief-description">
  332. <p>Number of checked-in databases in pool</p>
  333. </div>
  334. <div class="method-subsection method-declaration"><code>- (NSUInteger)countOfCheckedInDatabases</code></div>
  335. <div class="method-subsection return">
  336. <h4 class="method-subtitle parameter-title">Return Value</h4>
  337. <p>Number of databases</p>
  338. </div>
  339. <div class="method-subsection declared-in-section">
  340. <h4 class="method-subtitle">Declared In</h4>
  341. <code class="declared-in-ref">FMDatabasePool.h</code><br />
  342. </div>
  343. </div>
  344. <div class="section-method">
  345. <a name="//api/name/countOfCheckedOutDatabases" title="countOfCheckedOutDatabases"></a>
  346. <h3 class="subsubtitle method-title">countOfCheckedOutDatabases</h3>
  347. <div class="method-subsection brief-description">
  348. <p>Number of checked-out databases in pool</p>
  349. </div>
  350. <div class="method-subsection method-declaration"><code>- (NSUInteger)countOfCheckedOutDatabases</code></div>
  351. <div class="method-subsection return">
  352. <h4 class="method-subtitle parameter-title">Return Value</h4>
  353. <p>Number of databases</p>
  354. </div>
  355. <div class="method-subsection declared-in-section">
  356. <h4 class="method-subtitle">Declared In</h4>
  357. <code class="declared-in-ref">FMDatabasePool.h</code><br />
  358. </div>
  359. </div>
  360. <div class="section-method">
  361. <a name="//api/name/countOfOpenDatabases" title="countOfOpenDatabases"></a>
  362. <h3 class="subsubtitle method-title">countOfOpenDatabases</h3>
  363. <div class="method-subsection brief-description">
  364. <p>Total number of databases in pool</p>
  365. </div>
  366. <div class="method-subsection method-declaration"><code>- (NSUInteger)countOfOpenDatabases</code></div>
  367. <div class="method-subsection return">
  368. <h4 class="method-subtitle parameter-title">Return Value</h4>
  369. <p>Number of databases</p>
  370. </div>
  371. <div class="method-subsection declared-in-section">
  372. <h4 class="method-subtitle">Declared In</h4>
  373. <code class="declared-in-ref">FMDatabasePool.h</code><br />
  374. </div>
  375. </div>
  376. <div class="section-method">
  377. <a name="//api/name/inDatabase:" title="inDatabase:"></a>
  378. <h3 class="subsubtitle method-title">inDatabase:</h3>
  379. <div class="method-subsection brief-description">
  380. <p>Synchronously perform database operations in pool.</p>
  381. </div>
  382. <div class="method-subsection method-declaration"><code>- (void)inDatabase:(void ( ^ ) ( FMDatabase *db ))<em>block</em></code></div>
  383. <div class="method-subsection arguments-section parameters">
  384. <h4 class="method-subtitle parameter-title">Parameters</h4>
  385. <dl class="argument-def parameter-def">
  386. <dt><em>block</em></dt>
  387. <dd><p>The code to be run on the <code>FMDatabasePool</code> pool.</p></dd>
  388. </dl>
  389. </div>
  390. <div class="method-subsection declared-in-section">
  391. <h4 class="method-subtitle">Declared In</h4>
  392. <code class="declared-in-ref">FMDatabasePool.h</code><br />
  393. </div>
  394. </div>
  395. <div class="section-method">
  396. <a name="//api/name/inDeferredTransaction:" title="inDeferredTransaction:"></a>
  397. <h3 class="subsubtitle method-title">inDeferredTransaction:</h3>
  398. <div class="method-subsection brief-description">
  399. <p>Synchronously perform database operations in pool using deferred transaction.</p>
  400. </div>
  401. <div class="method-subsection method-declaration"><code>- (void)inDeferredTransaction:(void ( ^ ) ( FMDatabase *db , BOOL *rollback ))<em>block</em></code></div>
  402. <div class="method-subsection arguments-section parameters">
  403. <h4 class="method-subtitle parameter-title">Parameters</h4>
  404. <dl class="argument-def parameter-def">
  405. <dt><em>block</em></dt>
  406. <dd><p>The code to be run on the <code>FMDatabasePool</code> pool.</p></dd>
  407. </dl>
  408. </div>
  409. <div class="method-subsection declared-in-section">
  410. <h4 class="method-subtitle">Declared In</h4>
  411. <code class="declared-in-ref">FMDatabasePool.h</code><br />
  412. </div>
  413. </div>
  414. <div class="section-method">
  415. <a name="//api/name/inSavePoint:" title="inSavePoint:"></a>
  416. <h3 class="subsubtitle method-title">inSavePoint:</h3>
  417. <div class="method-subsection brief-description">
  418. <p>Synchronously perform database operations in pool using save point.</p>
  419. </div>
  420. <div class="method-subsection method-declaration"><code>- (NSError *)inSavePoint:(void ( ^ ) ( FMDatabase *db , BOOL *rollback ))<em>block</em></code></div>
  421. <div class="method-subsection arguments-section parameters">
  422. <h4 class="method-subtitle parameter-title">Parameters</h4>
  423. <dl class="argument-def parameter-def">
  424. <dt><em>block</em></dt>
  425. <dd><p>The code to be run on the <code>FMDatabasePool</code> pool.</p></dd>
  426. </dl>
  427. </div>
  428. <div class="method-subsection return">
  429. <h4 class="method-subtitle parameter-title">Return Value</h4>
  430. <p><code>NSError</code> object if error; <code>nil</code> if successful.</p>
  431. </div>
  432. <div class="method-subsection discussion-section">
  433. <h4 class="method-subtitle">Discussion</h4>
  434. <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&rsquo;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>
  435. </div>
  436. <div class="method-subsection declared-in-section">
  437. <h4 class="method-subtitle">Declared In</h4>
  438. <code class="declared-in-ref">FMDatabasePool.h</code><br />
  439. </div>
  440. </div>
  441. <div class="section-method">
  442. <a name="//api/name/inTransaction:" title="inTransaction:"></a>
  443. <h3 class="subsubtitle method-title">inTransaction:</h3>
  444. <div class="method-subsection brief-description">
  445. <p>Synchronously perform database operations in pool using transaction.</p>
  446. </div>
  447. <div class="method-subsection method-declaration"><code>- (void)inTransaction:(void ( ^ ) ( FMDatabase *db , BOOL *rollback ))<em>block</em></code></div>
  448. <div class="method-subsection arguments-section parameters">
  449. <h4 class="method-subtitle parameter-title">Parameters</h4>
  450. <dl class="argument-def parameter-def">
  451. <dt><em>block</em></dt>
  452. <dd><p>The code to be run on the <code>FMDatabasePool</code> pool.</p></dd>
  453. </dl>
  454. </div>
  455. <div class="method-subsection declared-in-section">
  456. <h4 class="method-subtitle">Declared In</h4>
  457. <code class="declared-in-ref">FMDatabasePool.h</code><br />
  458. </div>
  459. </div>
  460. <div class="section-method">
  461. <a name="//api/name/initWithPath:" title="initWithPath:"></a>
  462. <h3 class="subsubtitle method-title">initWithPath:</h3>
  463. <div class="method-subsection brief-description">
  464. <p>Create pool using path.</p>
  465. </div>
  466. <div class="method-subsection method-declaration"><code>- (instancetype)initWithPath:(NSString *)<em>aPath</em></code></div>
  467. <div class="method-subsection arguments-section parameters">
  468. <h4 class="method-subtitle parameter-title">Parameters</h4>
  469. <dl class="argument-def parameter-def">
  470. <dt><em>aPath</em></dt>
  471. <dd><p>The file path of the database.</p></dd>
  472. </dl>
  473. </div>
  474. <div class="method-subsection return">
  475. <h4 class="method-subtitle parameter-title">Return Value</h4>
  476. <p>The <code>FMDatabasePool</code> object. <code>nil</code> on error.</p>
  477. </div>
  478. <div class="method-subsection declared-in-section">
  479. <h4 class="method-subtitle">Declared In</h4>
  480. <code class="declared-in-ref">FMDatabasePool.h</code><br />
  481. </div>
  482. </div>
  483. <div class="section-method">
  484. <a name="//api/name/initWithPath:flags:" title="initWithPath:flags:"></a>
  485. <h3 class="subsubtitle method-title">initWithPath:flags:</h3>
  486. <div class="method-subsection brief-description">
  487. <p>Create pool using path and specified flags.</p>
  488. </div>
  489. <div class="method-subsection method-declaration"><code>- (instancetype)initWithPath:(NSString *)<em>aPath</em> flags:(int)<em>openFlags</em></code></div>
  490. <div class="method-subsection arguments-section parameters">
  491. <h4 class="method-subtitle parameter-title">Parameters</h4>
  492. <dl class="argument-def parameter-def">
  493. <dt><em>aPath</em></dt>
  494. <dd><p>The file path of the database.</p></dd>
  495. </dl>
  496. <dl class="argument-def parameter-def">
  497. <dt><em>openFlags</em></dt>
  498. <dd><p>Flags passed to the openWithFlags method of the database</p></dd>
  499. </dl>
  500. </div>
  501. <div class="method-subsection return">
  502. <h4 class="method-subtitle parameter-title">Return Value</h4>
  503. <p>The <code>FMDatabasePool</code> object. <code>nil</code> on error.</p>
  504. </div>
  505. <div class="method-subsection declared-in-section">
  506. <h4 class="method-subtitle">Declared In</h4>
  507. <code class="declared-in-ref">FMDatabasePool.h</code><br />
  508. </div>
  509. </div>
  510. <div class="section-method">
  511. <a name="//api/name/releaseAllDatabases" title="releaseAllDatabases"></a>
  512. <h3 class="subsubtitle method-title">releaseAllDatabases</h3>
  513. <div class="method-subsection brief-description">
  514. <p>Release all databases in pool</p>
  515. </div>
  516. <div class="method-subsection method-declaration"><code>- (void)releaseAllDatabases</code></div>
  517. <div class="method-subsection declared-in-section">
  518. <h4 class="method-subtitle">Declared In</h4>
  519. <code class="declared-in-ref">FMDatabasePool.h</code><br />
  520. </div>
  521. </div>
  522. </div>
  523. </div>
  524. <div class="main-navigation navigation-bottom">
  525. <ul>
  526. <li><a href="../index.html">Index</a></li>
  527. <li><a href="../hierarchy.html">Hierarchy</a></li>
  528. </ul>
  529. </div>
  530. <div id="footer">
  531. <hr />
  532. <div class="footer-copyright">
  533. <p><span class="copyright">&copy; 2014 ccgus. All rights reserved. (Last updated: 2014-05-25)</span><br />
  534. <span class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.1 (build 858)</a>.</span></p>
  535. </div>
  536. </div>
  537. </div>
  538. </article>
  539. <script type="text/javascript">
  540. function jumpToChange()
  541. {
  542. window.location.hash = this.options[this.selectedIndex].value;
  543. }
  544. function toggleTOC()
  545. {
  546. var contents = document.getElementById('contents');
  547. var tocContainer = document.getElementById('tocContainer');
  548. if (this.getAttribute('class') == 'open')
  549. {
  550. this.setAttribute('class', '');
  551. contents.setAttribute('class', '');
  552. tocContainer.setAttribute('class', '');
  553. window.name = "hideTOC";
  554. }
  555. else
  556. {
  557. this.setAttribute('class', 'open');
  558. contents.setAttribute('class', 'isShowingTOC');
  559. tocContainer.setAttribute('class', 'isShowingTOC');
  560. window.name = "";
  561. }
  562. return false;
  563. }
  564. function toggleTOCEntryChildren(e)
  565. {
  566. e.stopPropagation();
  567. var currentClass = this.getAttribute('class');
  568. if (currentClass == 'children') {
  569. this.setAttribute('class', 'children open');
  570. }
  571. else if (currentClass == 'children open') {
  572. this.setAttribute('class', 'children');
  573. }
  574. return false;
  575. }
  576. function tocEntryClick(e)
  577. {
  578. e.stopPropagation();
  579. return true;
  580. }
  581. function init()
  582. {
  583. var selectElement = document.getElementById('jumpTo');
  584. selectElement.addEventListener('change', jumpToChange, false);
  585. var tocButton = document.getElementById('table_of_contents');
  586. tocButton.addEventListener('click', toggleTOC, false);
  587. var taskTreeItem = document.getElementById('task_treeitem');
  588. if (taskTreeItem.getElementsByTagName('li').length > 0)
  589. {
  590. taskTreeItem.setAttribute('class', 'children');
  591. taskTreeItem.firstChild.setAttribute('class', 'disclosure');
  592. }
  593. var tocList = document.getElementById('toc');
  594. var tocEntries = tocList.getElementsByTagName('li');
  595. for (var i = 0; i < tocEntries.length; i++) {
  596. tocEntries[i].addEventListener('click', toggleTOCEntryChildren, false);
  597. }
  598. var tocLinks = tocList.getElementsByTagName('a');
  599. for (var i = 0; i < tocLinks.length; i++) {
  600. tocLinks[i].addEventListener('click', tocEntryClick, false);
  601. }
  602. if (window.name == "hideTOC") {
  603. toggleTOC.call(tocButton);
  604. }
  605. }
  606. window.onload = init;
  607. // If showing in Xcode, hide the TOC and Header
  608. if (navigator.userAgent.match(/xcode/i)) {
  609. document.getElementById("contents").className = "hideInXcode"
  610. document.getElementById("tocContainer").className = "hideInXcode"
  611. document.getElementById("top_header").className = "hideInXcode"
  612. }
  613. </script>
  614. </body>
  615. </html>