FMDatabasePool.html 26 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084
  1. <!DOCTYPE html>
  2. <html>
  3. <head>
  4. <meta charset="utf-8">
  5. <title>FMDatabasePool Class Reference</title>
  6. <link rel="stylesheet" href="../css/style.css">
  7. <meta name="viewport" content="initial-scale=1, maximum-scale=1.4">
  8. <meta name="generator" content="appledoc 2.2.1 (build 1333)">
  9. </head>
  10. <body class="appledoc">
  11. <header>
  12. <div class="container" class="hide-in-xcode">
  13. <h1 id="library-title">
  14. <a href="../index.html">FMDB </a>
  15. </h1>
  16. <p id="developer-home">
  17. <a href="../index.html">ccgus</a>
  18. </p>
  19. </div>
  20. </header>
  21. <aside>
  22. <div class="container">
  23. <nav>
  24. <ul id="header-buttons" role="toolbar">
  25. <li><a href="../index.html">Index</a></li>
  26. <li><a href="../hierarchy.html">Hierarchy</a></li>
  27. <li id="on-this-page" role="navigation">
  28. <label>
  29. On This Page
  30. <div class="chevron">
  31. <div class="chevy chevron-left"></div>
  32. <div class="chevy chevron-right"></div>
  33. </div>
  34. <select id="jump-to">
  35. <option value="top">Jump To&#133;</option>
  36. <option value="overview">Overview</option>
  37. <option value="tasks">Tasks</option>
  38. <optgroup label="Properties">
  39. <option value="//api/name/delegate">delegate</option>
  40. <option value="//api/name/maximumNumberOfDatabasesToCreate">maximumNumberOfDatabasesToCreate</option>
  41. <option value="//api/name/openFlags">openFlags</option>
  42. <option value="//api/name/path">path</option>
  43. </optgroup>
  44. <optgroup label="Class Methods">
  45. <option value="//api/name/databasePoolWithPath:">+ databasePoolWithPath:</option>
  46. <option value="//api/name/databasePoolWithPath:flags:">+ databasePoolWithPath:flags:</option>
  47. </optgroup>
  48. <optgroup label="Instance Methods">
  49. <option value="//api/name/countOfCheckedInDatabases">- countOfCheckedInDatabases</option>
  50. <option value="//api/name/countOfCheckedOutDatabases">- countOfCheckedOutDatabases</option>
  51. <option value="//api/name/countOfOpenDatabases">- countOfOpenDatabases</option>
  52. <option value="//api/name/inDatabase:">- inDatabase:</option>
  53. <option value="//api/name/inDeferredTransaction:">- inDeferredTransaction:</option>
  54. <option value="//api/name/inSavePoint:">- inSavePoint:</option>
  55. <option value="//api/name/inTransaction:">- inTransaction:</option>
  56. <option value="//api/name/initWithPath:">- initWithPath:</option>
  57. <option value="//api/name/initWithPath:flags:">- initWithPath:flags:</option>
  58. <option value="//api/name/releaseAllDatabases">- releaseAllDatabases</option>
  59. </optgroup>
  60. </select>
  61. </label>
  62. </li>
  63. </ul>
  64. </nav>
  65. </div>
  66. </aside>
  67. <article>
  68. <div id="overview_contents" class="container">
  69. <div id="content">
  70. <main role="main">
  71. <h1 class="title">FMDatabasePool Class Reference</h1>
  72. <div class="section section-specification"><table cellspacing="0"><tbody>
  73. <tr>
  74. <th>Inherits from</th>
  75. <td>NSObject</td>
  76. </tr><tr>
  77. <th>Declared in</th>
  78. <td>FMDatabasePool.h<br />FMDatabasePool.m</td>
  79. </tr>
  80. </tbody></table></div>
  81. <div class="section section-overview">
  82. <a title="Overview" name="overview"></a>
  83. <h2 class="subtitle subtitle-overview">Overview</h2>
  84. <p>Pool of <a href="../Classes/FMDatabase.html"><code>FMDatabase</code></a> objects.</p>
  85. <h3>See also</h3>
  86. <ul>
  87. <li><a href="../Classes/FMDatabaseQueue.html"><code>FMDatabaseQueue</code></a></li>
  88. <li><a href="../Classes/FMDatabase.html"><code>FMDatabase</code></a></li>
  89. </ul>
  90. <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>
  91. <p>If you really really really know what you&rsquo;re doing and <code>FMDatabasePool</code> is what
  92. you really really need (ie, you&rsquo;re using a read only database), OK you can use
  93. it. But just be careful not to deadlock!</p>
  94. <p>For an example on deadlocking, search for:
  95. <code>ONLY_USE_THE_POOL_IF_YOU_ARE_DOING_READS_OTHERWISE_YOULL_DEADLOCK_USE_FMDATABASEQUEUE_INSTEAD</code>
  96. in the main.m file.</p></div>
  97. </div>
  98. <div class="section section-tasks">
  99. <a title="Tasks" name="tasks"></a>
  100. <h2 class="task-title">Other Methods</h2>
  101. <div class="task-list">
  102. <div class="section-method">
  103. <a name="//api/name/databasePoolWithPath:" title="databasePoolWithPath:"></a>
  104. <h3 class="method-title"><code><a href="#//api/name/databasePoolWithPath:">+&nbsp;databasePoolWithPath:</a></code>
  105. </h3>
  106. <div class="method-info">
  107. <div class="pointy-thing"></div>
  108. <div class="method-info-container">
  109. <div class="method-subsection brief-description">
  110. <p>Create pool using path.</p>
  111. </div>
  112. <div class="method-subsection method-declaration"><code>+ (instancetype)databasePoolWithPath:(NSString *)<em>aPath</em></code></div>
  113. <div class="method-subsection arguments-section parameters">
  114. <h4 class="method-subtitle parameter-title">Parameters</h4>
  115. <table class="argument-def parameter-def">
  116. <tr>
  117. <th scope="row" class="argument-name"><code>aPath</code></th>
  118. <td><p>The file path of the database.</p></td>
  119. </tr>
  120. </table>
  121. </div>
  122. <div class="method-subsection return">
  123. <h4 class="method-subtitle parameter-title">Return Value</h4>
  124. <p>The <code>FMDatabasePool</code> object. <code>nil</code> on error.</p>
  125. </div>
  126. <div class="method-subsection discussion-section">
  127. <h4 class="method-subtitle">Discussion</h4>
  128. <p>Create pool using path.</p>
  129. </div>
  130. <div class="method-subsection declared-in-section">
  131. <h4 class="method-subtitle">Declared In</h4>
  132. <p><code class="declared-in-ref">FMDatabasePool.h</code></p>
  133. </div>
  134. </div>
  135. </div>
  136. </div><div class="section-method">
  137. <a name="//api/name/databasePoolWithPath:flags:" title="databasePoolWithPath:flags:"></a>
  138. <h3 class="method-title"><code><a href="#//api/name/databasePoolWithPath:flags:">+&nbsp;databasePoolWithPath:flags:</a></code>
  139. </h3>
  140. <div class="method-info">
  141. <div class="pointy-thing"></div>
  142. <div class="method-info-container">
  143. <div class="method-subsection brief-description">
  144. <p>Create pool using path and specified flags</p>
  145. </div>
  146. <div class="method-subsection method-declaration"><code>+ (instancetype)databasePoolWithPath:(NSString *)<em>aPath</em> flags:(int)<em>openFlags</em></code></div>
  147. <div class="method-subsection arguments-section parameters">
  148. <h4 class="method-subtitle parameter-title">Parameters</h4>
  149. <table class="argument-def parameter-def">
  150. <tr>
  151. <th scope="row" class="argument-name"><code>aPath</code></th>
  152. <td><p>The file path of the database.</p></td>
  153. </tr>
  154. <tr>
  155. <th scope="row" class="argument-name"><code>openFlags</code></th>
  156. <td><p>Flags passed to the openWithFlags method of the database</p></td>
  157. </tr>
  158. </table>
  159. </div>
  160. <div class="method-subsection return">
  161. <h4 class="method-subtitle parameter-title">Return Value</h4>
  162. <p>The <code>FMDatabasePool</code> object. <code>nil</code> on error.</p>
  163. </div>
  164. <div class="method-subsection discussion-section">
  165. <h4 class="method-subtitle">Discussion</h4>
  166. <p>Create pool using path and specified flags</p>
  167. </div>
  168. <div class="method-subsection declared-in-section">
  169. <h4 class="method-subtitle">Declared In</h4>
  170. <p><code class="declared-in-ref">FMDatabasePool.h</code></p>
  171. </div>
  172. </div>
  173. </div>
  174. </div><div class="section-method">
  175. <a name="//api/name/initWithPath:flags:" title="initWithPath:flags:"></a>
  176. <h3 class="method-title"><code><a href="#//api/name/initWithPath:flags:">&ndash;&nbsp;initWithPath:flags:</a></code>
  177. </h3>
  178. <div class="method-info">
  179. <div class="pointy-thing"></div>
  180. <div class="method-info-container">
  181. <div class="method-subsection brief-description">
  182. <p>Create pool using path and specified flags.</p>
  183. </div>
  184. <div class="method-subsection method-declaration"><code>- (instancetype)initWithPath:(NSString *)<em>aPath</em> flags:(int)<em>openFlags</em></code></div>
  185. <div class="method-subsection arguments-section parameters">
  186. <h4 class="method-subtitle parameter-title">Parameters</h4>
  187. <table class="argument-def parameter-def">
  188. <tr>
  189. <th scope="row" class="argument-name"><code>aPath</code></th>
  190. <td><p>The file path of the database.</p></td>
  191. </tr>
  192. <tr>
  193. <th scope="row" class="argument-name"><code>openFlags</code></th>
  194. <td><p>Flags passed to the openWithFlags method of the database</p></td>
  195. </tr>
  196. </table>
  197. </div>
  198. <div class="method-subsection return">
  199. <h4 class="method-subtitle parameter-title">Return Value</h4>
  200. <p>The <code>FMDatabasePool</code> object. <code>nil</code> on error.</p>
  201. </div>
  202. <div class="method-subsection discussion-section">
  203. <h4 class="method-subtitle">Discussion</h4>
  204. <p>Create pool using path and specified flags.</p>
  205. </div>
  206. <div class="method-subsection declared-in-section">
  207. <h4 class="method-subtitle">Declared In</h4>
  208. <p><code class="declared-in-ref">FMDatabasePool.h</code></p>
  209. </div>
  210. </div>
  211. </div>
  212. </div><div class="section-method">
  213. <a name="//api/name/initWithPath:" title="initWithPath:"></a>
  214. <h3 class="method-title"><code><a href="#//api/name/initWithPath:">&ndash;&nbsp;initWithPath:</a></code>
  215. </h3>
  216. <div class="method-info">
  217. <div class="pointy-thing"></div>
  218. <div class="method-info-container">
  219. <div class="method-subsection brief-description">
  220. <p>Create pool using path.</p>
  221. </div>
  222. <div class="method-subsection method-declaration"><code>- (instancetype)initWithPath:(NSString *)<em>aPath</em></code></div>
  223. <div class="method-subsection arguments-section parameters">
  224. <h4 class="method-subtitle parameter-title">Parameters</h4>
  225. <table class="argument-def parameter-def">
  226. <tr>
  227. <th scope="row" class="argument-name"><code>aPath</code></th>
  228. <td><p>The file path of the database.</p></td>
  229. </tr>
  230. </table>
  231. </div>
  232. <div class="method-subsection return">
  233. <h4 class="method-subtitle parameter-title">Return Value</h4>
  234. <p>The <code>FMDatabasePool</code> object. <code>nil</code> on error.</p>
  235. </div>
  236. <div class="method-subsection discussion-section">
  237. <h4 class="method-subtitle">Discussion</h4>
  238. <p>Create pool using path.</p>
  239. </div>
  240. <div class="method-subsection declared-in-section">
  241. <h4 class="method-subtitle">Declared In</h4>
  242. <p><code class="declared-in-ref">FMDatabasePool.h</code></p>
  243. </div>
  244. </div>
  245. </div>
  246. </div><div class="section-method">
  247. <a name="//api/name/countOfCheckedInDatabases" title="countOfCheckedInDatabases"></a>
  248. <h3 class="method-title"><code><a href="#//api/name/countOfCheckedInDatabases">&ndash;&nbsp;countOfCheckedInDatabases</a></code>
  249. </h3>
  250. <div class="method-info">
  251. <div class="pointy-thing"></div>
  252. <div class="method-info-container">
  253. <div class="method-subsection brief-description">
  254. <p>Number of checked-in databases in pool</p>
  255. </div>
  256. <div class="method-subsection method-declaration"><code>- (NSUInteger)countOfCheckedInDatabases</code></div>
  257. <div class="method-subsection return">
  258. <h4 class="method-subtitle parameter-title">Return Value</h4>
  259. <p>Number of databases</p>
  260. </div>
  261. <div class="method-subsection discussion-section">
  262. <h4 class="method-subtitle">Discussion</h4>
  263. <p>Number of checked-in databases in pool</p>
  264. </div>
  265. <div class="method-subsection declared-in-section">
  266. <h4 class="method-subtitle">Declared In</h4>
  267. <p><code class="declared-in-ref">FMDatabasePool.h</code></p>
  268. </div>
  269. </div>
  270. </div>
  271. </div><div class="section-method">
  272. <a name="//api/name/countOfCheckedOutDatabases" title="countOfCheckedOutDatabases"></a>
  273. <h3 class="method-title"><code><a href="#//api/name/countOfCheckedOutDatabases">&ndash;&nbsp;countOfCheckedOutDatabases</a></code>
  274. </h3>
  275. <div class="method-info">
  276. <div class="pointy-thing"></div>
  277. <div class="method-info-container">
  278. <div class="method-subsection brief-description">
  279. <p>Number of checked-out databases in pool</p>
  280. </div>
  281. <div class="method-subsection method-declaration"><code>- (NSUInteger)countOfCheckedOutDatabases</code></div>
  282. <div class="method-subsection return">
  283. <h4 class="method-subtitle parameter-title">Return Value</h4>
  284. <p>Number of databases</p>
  285. </div>
  286. <div class="method-subsection discussion-section">
  287. <h4 class="method-subtitle">Discussion</h4>
  288. <p>Number of checked-out databases in pool</p>
  289. </div>
  290. <div class="method-subsection declared-in-section">
  291. <h4 class="method-subtitle">Declared In</h4>
  292. <p><code class="declared-in-ref">FMDatabasePool.h</code></p>
  293. </div>
  294. </div>
  295. </div>
  296. </div><div class="section-method">
  297. <a name="//api/name/countOfOpenDatabases" title="countOfOpenDatabases"></a>
  298. <h3 class="method-title"><code><a href="#//api/name/countOfOpenDatabases">&ndash;&nbsp;countOfOpenDatabases</a></code>
  299. </h3>
  300. <div class="method-info">
  301. <div class="pointy-thing"></div>
  302. <div class="method-info-container">
  303. <div class="method-subsection brief-description">
  304. <p>Total number of databases in pool</p>
  305. </div>
  306. <div class="method-subsection method-declaration"><code>- (NSUInteger)countOfOpenDatabases</code></div>
  307. <div class="method-subsection return">
  308. <h4 class="method-subtitle parameter-title">Return Value</h4>
  309. <p>Number of databases</p>
  310. </div>
  311. <div class="method-subsection discussion-section">
  312. <h4 class="method-subtitle">Discussion</h4>
  313. <p>Total number of databases in pool</p>
  314. </div>
  315. <div class="method-subsection declared-in-section">
  316. <h4 class="method-subtitle">Declared In</h4>
  317. <p><code class="declared-in-ref">FMDatabasePool.h</code></p>
  318. </div>
  319. </div>
  320. </div>
  321. </div><div class="section-method">
  322. <a name="//api/name/releaseAllDatabases" title="releaseAllDatabases"></a>
  323. <h3 class="method-title"><code><a href="#//api/name/releaseAllDatabases">&ndash;&nbsp;releaseAllDatabases</a></code>
  324. </h3>
  325. <div class="method-info">
  326. <div class="pointy-thing"></div>
  327. <div class="method-info-container">
  328. <div class="method-subsection brief-description">
  329. <p>Release all databases in pool</p>
  330. </div>
  331. <div class="method-subsection method-declaration"><code>- (void)releaseAllDatabases</code></div>
  332. <div class="method-subsection discussion-section">
  333. <h4 class="method-subtitle">Discussion</h4>
  334. <p>Release all databases in pool</p>
  335. </div>
  336. <div class="method-subsection declared-in-section">
  337. <h4 class="method-subtitle">Declared In</h4>
  338. <p><code class="declared-in-ref">FMDatabasePool.h</code></p>
  339. </div>
  340. </div>
  341. </div>
  342. </div><div class="section-method">
  343. <a name="//api/name/inDatabase:" title="inDatabase:"></a>
  344. <h3 class="method-title"><code><a href="#//api/name/inDatabase:">&ndash;&nbsp;inDatabase:</a></code>
  345. </h3>
  346. <div class="method-info">
  347. <div class="pointy-thing"></div>
  348. <div class="method-info-container">
  349. <div class="method-subsection brief-description">
  350. <p>Synchronously perform database operations in pool.</p>
  351. </div>
  352. <div class="method-subsection method-declaration"><code>- (void)inDatabase:(void ( ^ ) ( FMDatabase *db ))<em>block</em></code></div>
  353. <div class="method-subsection arguments-section parameters">
  354. <h4 class="method-subtitle parameter-title">Parameters</h4>
  355. <table class="argument-def parameter-def">
  356. <tr>
  357. <th scope="row" class="argument-name"><code>block</code></th>
  358. <td><p>The code to be run on the <code>FMDatabasePool</code> pool.</p></td>
  359. </tr>
  360. </table>
  361. </div>
  362. <div class="method-subsection discussion-section">
  363. <h4 class="method-subtitle">Discussion</h4>
  364. <p>Synchronously perform database operations in pool.</p>
  365. </div>
  366. <div class="method-subsection declared-in-section">
  367. <h4 class="method-subtitle">Declared In</h4>
  368. <p><code class="declared-in-ref">FMDatabasePool.h</code></p>
  369. </div>
  370. </div>
  371. </div>
  372. </div><div class="section-method">
  373. <a name="//api/name/inDeferredTransaction:" title="inDeferredTransaction:"></a>
  374. <h3 class="method-title"><code><a href="#//api/name/inDeferredTransaction:">&ndash;&nbsp;inDeferredTransaction:</a></code>
  375. </h3>
  376. <div class="method-info">
  377. <div class="pointy-thing"></div>
  378. <div class="method-info-container">
  379. <div class="method-subsection brief-description">
  380. <p>Synchronously perform database operations in pool using deferred transaction.</p>
  381. </div>
  382. <div class="method-subsection method-declaration"><code>- (void)inDeferredTransaction:(void ( ^ ) ( FMDatabase *db , BOOL *rollback ))<em>block</em></code></div>
  383. <div class="method-subsection arguments-section parameters">
  384. <h4 class="method-subtitle parameter-title">Parameters</h4>
  385. <table class="argument-def parameter-def">
  386. <tr>
  387. <th scope="row" class="argument-name"><code>block</code></th>
  388. <td><p>The code to be run on the <code>FMDatabasePool</code> pool.</p></td>
  389. </tr>
  390. </table>
  391. </div>
  392. <div class="method-subsection discussion-section">
  393. <h4 class="method-subtitle">Discussion</h4>
  394. <p>Synchronously perform database operations in pool using deferred transaction.</p>
  395. </div>
  396. <div class="method-subsection declared-in-section">
  397. <h4 class="method-subtitle">Declared In</h4>
  398. <p><code class="declared-in-ref">FMDatabasePool.h</code></p>
  399. </div>
  400. </div>
  401. </div>
  402. </div><div class="section-method">
  403. <a name="//api/name/inTransaction:" title="inTransaction:"></a>
  404. <h3 class="method-title"><code><a href="#//api/name/inTransaction:">&ndash;&nbsp;inTransaction:</a></code>
  405. </h3>
  406. <div class="method-info">
  407. <div class="pointy-thing"></div>
  408. <div class="method-info-container">
  409. <div class="method-subsection brief-description">
  410. <p>Synchronously perform database operations in pool using transaction.</p>
  411. </div>
  412. <div class="method-subsection method-declaration"><code>- (void)inTransaction:(void ( ^ ) ( FMDatabase *db , BOOL *rollback ))<em>block</em></code></div>
  413. <div class="method-subsection arguments-section parameters">
  414. <h4 class="method-subtitle parameter-title">Parameters</h4>
  415. <table class="argument-def parameter-def">
  416. <tr>
  417. <th scope="row" class="argument-name"><code>block</code></th>
  418. <td><p>The code to be run on the <code>FMDatabasePool</code> pool.</p></td>
  419. </tr>
  420. </table>
  421. </div>
  422. <div class="method-subsection discussion-section">
  423. <h4 class="method-subtitle">Discussion</h4>
  424. <p>Synchronously perform database operations in pool using transaction.</p>
  425. </div>
  426. <div class="method-subsection declared-in-section">
  427. <h4 class="method-subtitle">Declared In</h4>
  428. <p><code class="declared-in-ref">FMDatabasePool.h</code></p>
  429. </div>
  430. </div>
  431. </div>
  432. </div><div class="section-method">
  433. <a name="//api/name/inSavePoint:" title="inSavePoint:"></a>
  434. <h3 class="method-title"><code><a href="#//api/name/inSavePoint:">&ndash;&nbsp;inSavePoint:</a></code>
  435. </h3>
  436. <div class="method-info">
  437. <div class="pointy-thing"></div>
  438. <div class="method-info-container">
  439. <div class="method-subsection brief-description">
  440. <p>Synchronously perform database operations in pool using save point.</p>
  441. </div>
  442. <div class="method-subsection method-declaration"><code>- (NSError *)inSavePoint:(void ( ^ ) ( FMDatabase *db , BOOL *rollback ))<em>block</em></code></div>
  443. <div class="method-subsection arguments-section parameters">
  444. <h4 class="method-subtitle parameter-title">Parameters</h4>
  445. <table class="argument-def parameter-def">
  446. <tr>
  447. <th scope="row" class="argument-name"><code>block</code></th>
  448. <td><p>The code to be run on the <code>FMDatabasePool</code> pool.</p></td>
  449. </tr>
  450. </table>
  451. </div>
  452. <div class="method-subsection return">
  453. <h4 class="method-subtitle parameter-title">Return Value</h4>
  454. <p><code>NSError</code> object if error; <code>nil</code> if successful.</p>
  455. </div>
  456. <div class="method-subsection discussion-section">
  457. <h4 class="method-subtitle">Discussion</h4>
  458. <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&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>
  459. </div>
  460. <div class="method-subsection declared-in-section">
  461. <h4 class="method-subtitle">Declared In</h4>
  462. <p><code class="declared-in-ref">FMDatabasePool.h</code></p>
  463. </div>
  464. </div>
  465. </div>
  466. </div>
  467. </div>
  468. <h2 class="task-title">Other Methods</h2>
  469. <div class="task-list">
  470. <div class="section-method">
  471. <a name="//api/name/path" title="path"></a>
  472. <h3 class="method-title"><code><a href="#//api/name/path">&nbsp;&nbsp;path</a></code>
  473. </h3>
  474. <div class="method-info">
  475. <div class="pointy-thing"></div>
  476. <div class="method-info-container">
  477. <div class="method-subsection brief-description">
  478. <p>Database path</p>
  479. </div>
  480. <div class="method-subsection method-declaration"><code>@property (atomic, retain) NSString *path</code></div>
  481. <div class="method-subsection discussion-section">
  482. <h4 class="method-subtitle">Discussion</h4>
  483. <p>Database path</p>
  484. </div>
  485. <div class="method-subsection declared-in-section">
  486. <h4 class="method-subtitle">Declared In</h4>
  487. <p><code class="declared-in-ref">FMDatabasePool.h</code></p>
  488. </div>
  489. </div>
  490. </div>
  491. </div><div class="section-method">
  492. <a name="//api/name/delegate" title="delegate"></a>
  493. <h3 class="method-title"><code><a href="#//api/name/delegate">&nbsp;&nbsp;delegate</a></code>
  494. </h3>
  495. <div class="method-info">
  496. <div class="pointy-thing"></div>
  497. <div class="method-info-container">
  498. <div class="method-subsection brief-description">
  499. <p>Delegate object</p>
  500. </div>
  501. <div class="method-subsection method-declaration"><code>@property (atomic, assign) id delegate</code></div>
  502. <div class="method-subsection discussion-section">
  503. <h4 class="method-subtitle">Discussion</h4>
  504. <p>Delegate object</p>
  505. </div>
  506. <div class="method-subsection declared-in-section">
  507. <h4 class="method-subtitle">Declared In</h4>
  508. <p><code class="declared-in-ref">FMDatabasePool.h</code></p>
  509. </div>
  510. </div>
  511. </div>
  512. </div><div class="section-method">
  513. <a name="//api/name/maximumNumberOfDatabasesToCreate" title="maximumNumberOfDatabasesToCreate"></a>
  514. <h3 class="method-title"><code><a href="#//api/name/maximumNumberOfDatabasesToCreate">&nbsp;&nbsp;maximumNumberOfDatabasesToCreate</a></code>
  515. </h3>
  516. <div class="method-info">
  517. <div class="pointy-thing"></div>
  518. <div class="method-info-container">
  519. <div class="method-subsection brief-description">
  520. <p>Maximum number of databases to create</p>
  521. </div>
  522. <div class="method-subsection method-declaration"><code>@property (atomic, assign) NSUInteger maximumNumberOfDatabasesToCreate</code></div>
  523. <div class="method-subsection discussion-section">
  524. <h4 class="method-subtitle">Discussion</h4>
  525. <p>Maximum number of databases to create</p>
  526. </div>
  527. <div class="method-subsection declared-in-section">
  528. <h4 class="method-subtitle">Declared In</h4>
  529. <p><code class="declared-in-ref">FMDatabasePool.h</code></p>
  530. </div>
  531. </div>
  532. </div>
  533. </div><div class="section-method">
  534. <a name="//api/name/openFlags" title="openFlags"></a>
  535. <h3 class="method-title"><code><a href="#//api/name/openFlags">&nbsp;&nbsp;openFlags</a></code>
  536. </h3>
  537. <div class="method-info">
  538. <div class="pointy-thing"></div>
  539. <div class="method-info-container">
  540. <div class="method-subsection brief-description">
  541. <p>Open flags</p>
  542. </div>
  543. <div class="method-subsection method-declaration"><code>@property (atomic, readonly) int openFlags</code></div>
  544. <div class="method-subsection discussion-section">
  545. <h4 class="method-subtitle">Discussion</h4>
  546. <p>Open flags</p>
  547. </div>
  548. <div class="method-subsection declared-in-section">
  549. <h4 class="method-subtitle">Declared In</h4>
  550. <p><code class="declared-in-ref">FMDatabasePool.h</code></p>
  551. </div>
  552. </div>
  553. </div>
  554. </div>
  555. </div>
  556. </div>
  557. </main>
  558. <footer>
  559. <div class="footer-copyright">
  560. <p class="copyright">Copyright &copy; 2015 ccgus. All rights reserved. Updated: 2015-01-25</p>
  561. <p class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.2.1 (build 1333)</a>.</p>
  562. </div>
  563. </footer>
  564. </div>
  565. </div>
  566. </article>
  567. <script src="../js/script.js"></script>
  568. </body>
  569. </html>