FMDatabasePool.html 80 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <title>FMDatabasePool Class Reference</title>
  5. <link rel="stylesheet" type="text/css" href="../css/jazzy.css" />
  6. <link rel="stylesheet" type="text/css" href="../css/highlight.css" />
  7. <meta charset='utf-8'>
  8. <script src="../js/jquery.min.js" defer></script>
  9. <script src="../js/jazzy.js" defer></script>
  10. </head>
  11. <body>
  12. <a name="//apple_ref/objc/Class/FMDatabasePool" class="dashAnchor"></a>
  13. <a title="FMDatabasePool Class Reference"></a>
  14. <header>
  15. <div class="content-wrapper">
  16. <p><a href="../index.html">FMDB 2.7.7 Docs</a> (89% documented)</p>
  17. <p class="header-right"><a href="https://github.com/ccgus/fmdb"><img src="../img/gh.png"/>View on GitHub</a></p>
  18. </div>
  19. </header>
  20. <div class="content-wrapper">
  21. <p id="breadcrumbs">
  22. <a href="../index.html">FMDB Reference</a>
  23. <img id="carat" src="../img/carat.png" />
  24. FMDatabasePool Class Reference
  25. </p>
  26. </div>
  27. <div class="content-wrapper">
  28. <nav class="sidebar">
  29. <ul class="nav-groups">
  30. <li class="nav-group-name">
  31. <a href="../Categories.html">Categories</a>
  32. <ul class="nav-group-tasks">
  33. <li class="nav-group-task">
  34. <a href="../Categories/NSObject%28FMDatabasePoolDelegate%29.html">NSObject(FMDatabasePoolDelegate)</a>
  35. </li>
  36. </ul>
  37. </li>
  38. <li class="nav-group-name">
  39. <a href="../Classes.html">Classes</a>
  40. <ul class="nav-group-tasks">
  41. <li class="nav-group-task">
  42. <a href="../Classes/FMDatabase.html">FMDatabase</a>
  43. </li>
  44. <li class="nav-group-task">
  45. <a href="../Classes/FMDatabasePool.html">FMDatabasePool</a>
  46. </li>
  47. <li class="nav-group-task">
  48. <a href="../Classes/FMDatabaseQueue.html">FMDatabaseQueue</a>
  49. </li>
  50. <li class="nav-group-task">
  51. <a href="../Classes/FMResultSet.html">FMResultSet</a>
  52. </li>
  53. <li class="nav-group-task">
  54. <a href="../Classes/FMStatement.html">FMStatement</a>
  55. </li>
  56. </ul>
  57. </li>
  58. <li class="nav-group-name">
  59. <a href="../Constants.html">Constants</a>
  60. <ul class="nav-group-tasks">
  61. <li class="nav-group-task">
  62. <a href="../Constants.html#/c:@FMDBVersionNumber">FMDBVersionNumber</a>
  63. </li>
  64. <li class="nav-group-task">
  65. <a href="../Constants.html#/c:@FMDBVersionString">FMDBVersionString</a>
  66. </li>
  67. </ul>
  68. </li>
  69. <li class="nav-group-name">
  70. <a href="../Enums.html">Enumerations</a>
  71. <ul class="nav-group-tasks">
  72. <li class="nav-group-task">
  73. <a href="../Enums/FMDBCheckpointMode.html">FMDBCheckpointMode</a>
  74. </li>
  75. <li class="nav-group-task">
  76. <a href="../Enums/SqliteValueType.html">SqliteValueType</a>
  77. </li>
  78. </ul>
  79. </li>
  80. <li class="nav-group-name">
  81. <a href="../Type%20Definitions.html">Type Definitions</a>
  82. <ul class="nav-group-tasks">
  83. <li class="nav-group-task">
  84. <a href="../Type%20Definitions.html#/c:FMDatabase.h@T@FMDBExecuteStatementsCallbackBlock">FMDBExecuteStatementsCallbackBlock</a>
  85. </li>
  86. </ul>
  87. </li>
  88. </ul>
  89. </nav>
  90. <article class="main-content">
  91. <section>
  92. <section class="section">
  93. <h1>FMDatabasePool</h1>
  94. <div class="declaration">
  95. <div class="language">
  96. <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">FMDatabasePool</span> <span class="p">:</span> <span class="nc">NSObject</span></code></pre>
  97. </div>
  98. </div>
  99. <p>Pool of <code><a href="../Classes/FMDatabase.html">FMDatabase</a></code> objects.</p>
  100. <p>See also</p>
  101. <ul>
  102. <li><code><a href="../Classes/FMDatabaseQueue.html">FMDatabaseQueue</a></code></li>
  103. <li><p><code><a href="../Classes/FMDatabase.html">FMDatabase</a></code> </p></li>
  104. </ul><div class="aside aside-warning">
  105. <p class="aside-title">Warning</p>
  106. <p>Before using <code>FMDatabasePool</code> , please consider using <code><a href="../Classes/FMDatabaseQueue.html">FMDatabaseQueue</a></code> instead.</p>
  107. </div>
  108. <p>If you really really really know what you&rsquo;re doing and <code>FMDatabasePool</code> is what
  109. you really really need (ie, you&rsquo;re using a read only database), OK you can use
  110. it. But just be careful not to deadlock!</p>
  111. <p>For an example on deadlocking, search for:
  112. <code>ONLY_USE_THE_POOL_IF_YOU_ARE_DOING_READS_OTHERWISE_YOULL_DEADLOCK_USE_FMDATABASEQUEUE_INSTEAD</code>
  113. in the main.m file.</p>
  114. </section>
  115. <section class="section task-group-section">
  116. <div class="task-group">
  117. <ul>
  118. <li class="item">
  119. <div>
  120. <code>
  121. <a name="/c:objc(cs)FMDatabasePool(py)path"></a>
  122. <a name="//apple_ref/objc/Property/path" class="dashAnchor"></a>
  123. <a class="token" href="#/c:objc(cs)FMDatabasePool(py)path">path</a>
  124. </code>
  125. </div>
  126. <div class="height-container">
  127. <div class="pointer-container"></div>
  128. <section class="section">
  129. <div class="pointer"></div>
  130. <div class="abstract">
  131. <p>Database path</p>
  132. </div>
  133. <div class="declaration">
  134. <h4>Declaration</h4>
  135. <div class="language">
  136. <p class="aside-title">Objective-C</p>
  137. <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">copy</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">path</span><span class="p">;</span></code></pre>
  138. </div>
  139. <div class="language">
  140. <p class="aside-title">Swift</p>
  141. <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">path</span><span class="p">:</span> <span class="kt">String</span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>
  142. </div>
  143. </div>
  144. </section>
  145. </div>
  146. </li>
  147. <li class="item">
  148. <div>
  149. <code>
  150. <a name="/c:objc(cs)FMDatabasePool(py)delegate"></a>
  151. <a name="//apple_ref/objc/Property/delegate" class="dashAnchor"></a>
  152. <a class="token" href="#/c:objc(cs)FMDatabasePool(py)delegate">delegate</a>
  153. </code>
  154. </div>
  155. <div class="height-container">
  156. <div class="pointer-container"></div>
  157. <section class="section">
  158. <div class="pointer"></div>
  159. <div class="abstract">
  160. <p>Delegate object</p>
  161. </div>
  162. <div class="declaration">
  163. <h4>Declaration</h4>
  164. <div class="language">
  165. <p class="aside-title">Objective-C</p>
  166. <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">)</span> <span class="n">id</span> <span class="n">delegate</span><span class="p">;</span></code></pre>
  167. </div>
  168. <div class="language">
  169. <p class="aside-title">Swift</p>
  170. <pre class="highlight swift"><code><span class="kd">unowned(unsafe)</span> <span class="k">var</span> <span class="nv">delegate</span><span class="p">:</span> <span class="kt">AnyObject</span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>
  171. </div>
  172. </div>
  173. </section>
  174. </div>
  175. </li>
  176. <li class="item">
  177. <div>
  178. <code>
  179. <a name="/c:objc(cs)FMDatabasePool(py)maximumNumberOfDatabasesToCreate"></a>
  180. <a name="//apple_ref/objc/Property/maximumNumberOfDatabasesToCreate" class="dashAnchor"></a>
  181. <a class="token" href="#/c:objc(cs)FMDatabasePool(py)maximumNumberOfDatabasesToCreate">maximumNumberOfDatabasesToCreate</a>
  182. </code>
  183. </div>
  184. <div class="height-container">
  185. <div class="pointer-container"></div>
  186. <section class="section">
  187. <div class="pointer"></div>
  188. <div class="abstract">
  189. <p>Maximum number of databases to create</p>
  190. </div>
  191. <div class="declaration">
  192. <h4>Declaration</h4>
  193. <div class="language">
  194. <p class="aside-title">Objective-C</p>
  195. <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="n">NSUInteger</span> <span class="n">maximumNumberOfDatabasesToCreate</span><span class="p">;</span></code></pre>
  196. </div>
  197. <div class="language">
  198. <p class="aside-title">Swift</p>
  199. <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">maximumNumberOfDatabasesToCreate</span><span class="p">:</span> <span class="kt">UInt</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>
  200. </div>
  201. </div>
  202. </section>
  203. </div>
  204. </li>
  205. <li class="item">
  206. <div>
  207. <code>
  208. <a name="/c:objc(cs)FMDatabasePool(py)openFlags"></a>
  209. <a name="//apple_ref/objc/Property/openFlags" class="dashAnchor"></a>
  210. <a class="token" href="#/c:objc(cs)FMDatabasePool(py)openFlags">openFlags</a>
  211. </code>
  212. </div>
  213. <div class="height-container">
  214. <div class="pointer-container"></div>
  215. <section class="section">
  216. <div class="pointer"></div>
  217. <div class="abstract">
  218. <p>Open flags</p>
  219. </div>
  220. <div class="declaration">
  221. <h4>Declaration</h4>
  222. <div class="language">
  223. <p class="aside-title">Objective-C</p>
  224. <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readonly</span><span class="p">)</span> <span class="kt">int</span> <span class="n">openFlags</span><span class="p">;</span></code></pre>
  225. </div>
  226. <div class="language">
  227. <p class="aside-title">Swift</p>
  228. <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">openFlags</span><span class="p">:</span> <span class="kt">Int32</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
  229. </div>
  230. </div>
  231. </section>
  232. </div>
  233. </li>
  234. <li class="item">
  235. <div>
  236. <code>
  237. <a name="/c:objc(cs)FMDatabasePool(py)vfsName"></a>
  238. <a name="//apple_ref/objc/Property/vfsName" class="dashAnchor"></a>
  239. <a class="token" href="#/c:objc(cs)FMDatabasePool(py)vfsName">vfsName</a>
  240. </code>
  241. </div>
  242. <div class="height-container">
  243. <div class="pointer-container"></div>
  244. <section class="section">
  245. <div class="pointer"></div>
  246. <div class="abstract">
  247. <p>Custom virtual file system name</p>
  248. </div>
  249. <div class="declaration">
  250. <h4>Declaration</h4>
  251. <div class="language">
  252. <p class="aside-title">Objective-C</p>
  253. <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">copy</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">vfsName</span><span class="p">;</span></code></pre>
  254. </div>
  255. <div class="language">
  256. <p class="aside-title">Swift</p>
  257. <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">vfsName</span><span class="p">:</span> <span class="kt">String</span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>
  258. </div>
  259. </div>
  260. </section>
  261. </div>
  262. </li>
  263. </ul>
  264. </div>
  265. <div class="task-group">
  266. <div class="task-name-container">
  267. <a name="/Initialization"></a>
  268. <a name="//apple_ref/objc/Section/Initialization" class="dashAnchor"></a>
  269. <div class="section-name-container">
  270. <a class="section-name-link" href="#/Initialization"></a>
  271. <h3 class="section-name"><p>Initialization</p>
  272. </h3>
  273. </div>
  274. </div>
  275. <ul>
  276. <li class="item">
  277. <div>
  278. <code>
  279. <a name="/c:objc(cs)FMDatabasePool(cm)databasePoolWithPath:"></a>
  280. <a name="//apple_ref/objc/Method/+databasePoolWithPath:" class="dashAnchor"></a>
  281. <a class="token" href="#/c:objc(cs)FMDatabasePool(cm)databasePoolWithPath:">+databasePoolWithPath:<wbr></a>
  282. </code>
  283. </div>
  284. <div class="height-container">
  285. <div class="pointer-container"></div>
  286. <section class="section">
  287. <div class="pointer"></div>
  288. <div class="abstract">
  289. <p>Create pool using path.</p>
  290. </div>
  291. <div class="declaration">
  292. <h4>Declaration</h4>
  293. <div class="language">
  294. <p class="aside-title">Objective-C</p>
  295. <pre class="highlight objective_c"><code><span class="k">+</span> <span class="p">(</span><span class="n">nonnull</span> <span class="n">instancetype</span><span class="p">)</span><span class="nf">databasePoolWithPath</span><span class="p">:(</span><span class="n">NSString</span> <span class="o">*</span><span class="n">_Nullable</span><span class="p">)</span><span class="nv">aPath</span><span class="p">;</span></code></pre>
  296. </div>
  297. </div>
  298. <div>
  299. <h4>Parameters</h4>
  300. <table class="graybox">
  301. <tbody>
  302. <tr>
  303. <td>
  304. <code>
  305. <em>aPath</em>
  306. </code>
  307. </td>
  308. <td>
  309. <div>
  310. <p>The file path of the database.</p>
  311. </div>
  312. </td>
  313. </tr>
  314. </tbody>
  315. </table>
  316. </div>
  317. <div>
  318. <h4>Return Value</h4>
  319. <p>The <code>FMDatabasePool</code> object. <code>nil</code> on error.</p>
  320. </div>
  321. </section>
  322. </div>
  323. </li>
  324. <li class="item">
  325. <div>
  326. <code>
  327. <a name="/c:objc(cs)FMDatabasePool(cm)databasePoolWithURL:"></a>
  328. <a name="//apple_ref/objc/Method/+databasePoolWithURL:" class="dashAnchor"></a>
  329. <a class="token" href="#/c:objc(cs)FMDatabasePool(cm)databasePoolWithURL:">+databasePoolWithURL:<wbr></a>
  330. </code>
  331. </div>
  332. <div class="height-container">
  333. <div class="pointer-container"></div>
  334. <section class="section">
  335. <div class="pointer"></div>
  336. <div class="abstract">
  337. <p>Create pool using file URL.</p>
  338. </div>
  339. <div class="declaration">
  340. <h4>Declaration</h4>
  341. <div class="language">
  342. <p class="aside-title">Objective-C</p>
  343. <pre class="highlight objective_c"><code><span class="k">+</span> <span class="p">(</span><span class="n">nonnull</span> <span class="n">instancetype</span><span class="p">)</span><span class="nf">databasePoolWithURL</span><span class="p">:(</span><span class="n">NSURL</span> <span class="o">*</span><span class="n">_Nullable</span><span class="p">)</span><span class="nv">url</span><span class="p">;</span></code></pre>
  344. </div>
  345. </div>
  346. <div>
  347. <h4>Parameters</h4>
  348. <table class="graybox">
  349. <tbody>
  350. <tr>
  351. <td>
  352. <code>
  353. <em>url</em>
  354. </code>
  355. </td>
  356. <td>
  357. <div>
  358. <p>The file <code>NSURL</code> of the database.</p>
  359. </div>
  360. </td>
  361. </tr>
  362. </tbody>
  363. </table>
  364. </div>
  365. <div>
  366. <h4>Return Value</h4>
  367. <p>The <code>FMDatabasePool</code> object. <code>nil</code> on error.</p>
  368. </div>
  369. </section>
  370. </div>
  371. </li>
  372. <li class="item">
  373. <div>
  374. <code>
  375. <a name="/c:objc(cs)FMDatabasePool(cm)databasePoolWithPath:flags:"></a>
  376. <a name="//apple_ref/objc/Method/+databasePoolWithPath:flags:" class="dashAnchor"></a>
  377. <a class="token" href="#/c:objc(cs)FMDatabasePool(cm)databasePoolWithPath:flags:">+databasePoolWithPath:<wbr>flags:<wbr></a>
  378. </code>
  379. </div>
  380. <div class="height-container">
  381. <div class="pointer-container"></div>
  382. <section class="section">
  383. <div class="pointer"></div>
  384. <div class="abstract">
  385. <p>Create pool using path and specified flags</p>
  386. </div>
  387. <div class="declaration">
  388. <h4>Declaration</h4>
  389. <div class="language">
  390. <p class="aside-title">Objective-C</p>
  391. <pre class="highlight objective_c"><code><span class="k">+</span> <span class="p">(</span><span class="n">nonnull</span> <span class="n">instancetype</span><span class="p">)</span><span class="nf">databasePoolWithPath</span><span class="p">:(</span><span class="n">NSString</span> <span class="o">*</span><span class="n">_Nullable</span><span class="p">)</span><span class="nv">aPath</span>
  392. <span class="nf">flags</span><span class="p">:(</span><span class="kt">int</span><span class="p">)</span><span class="nv">openFlags</span><span class="p">;</span></code></pre>
  393. </div>
  394. </div>
  395. <div>
  396. <h4>Parameters</h4>
  397. <table class="graybox">
  398. <tbody>
  399. <tr>
  400. <td>
  401. <code>
  402. <em>aPath</em>
  403. </code>
  404. </td>
  405. <td>
  406. <div>
  407. <p>The file path of the database.</p>
  408. </div>
  409. </td>
  410. </tr>
  411. <tr>
  412. <td>
  413. <code>
  414. <em>openFlags</em>
  415. </code>
  416. </td>
  417. <td>
  418. <div>
  419. <p>Flags passed to the openWithFlags method of the database.</p>
  420. </div>
  421. </td>
  422. </tr>
  423. </tbody>
  424. </table>
  425. </div>
  426. <div>
  427. <h4>Return Value</h4>
  428. <p>The <code>FMDatabasePool</code> object. <code>nil</code> on error.</p>
  429. </div>
  430. </section>
  431. </div>
  432. </li>
  433. <li class="item">
  434. <div>
  435. <code>
  436. <a name="/c:objc(cs)FMDatabasePool(cm)databasePoolWithURL:flags:"></a>
  437. <a name="//apple_ref/objc/Method/+databasePoolWithURL:flags:" class="dashAnchor"></a>
  438. <a class="token" href="#/c:objc(cs)FMDatabasePool(cm)databasePoolWithURL:flags:">+databasePoolWithURL:<wbr>flags:<wbr></a>
  439. </code>
  440. </div>
  441. <div class="height-container">
  442. <div class="pointer-container"></div>
  443. <section class="section">
  444. <div class="pointer"></div>
  445. <div class="abstract">
  446. <p>Create pool using file URL and specified flags</p>
  447. </div>
  448. <div class="declaration">
  449. <h4>Declaration</h4>
  450. <div class="language">
  451. <p class="aside-title">Objective-C</p>
  452. <pre class="highlight objective_c"><code><span class="k">+</span> <span class="p">(</span><span class="n">nonnull</span> <span class="n">instancetype</span><span class="p">)</span><span class="nf">databasePoolWithURL</span><span class="p">:(</span><span class="n">NSURL</span> <span class="o">*</span><span class="n">_Nullable</span><span class="p">)</span><span class="nv">url</span>
  453. <span class="nf">flags</span><span class="p">:(</span><span class="kt">int</span><span class="p">)</span><span class="nv">openFlags</span><span class="p">;</span></code></pre>
  454. </div>
  455. </div>
  456. <div>
  457. <h4>Parameters</h4>
  458. <table class="graybox">
  459. <tbody>
  460. <tr>
  461. <td>
  462. <code>
  463. <em>url</em>
  464. </code>
  465. </td>
  466. <td>
  467. <div>
  468. <p>The file <code>NSURL</code> of the database.</p>
  469. </div>
  470. </td>
  471. </tr>
  472. <tr>
  473. <td>
  474. <code>
  475. <em>openFlags</em>
  476. </code>
  477. </td>
  478. <td>
  479. <div>
  480. <p>Flags passed to the openWithFlags method of the database.</p>
  481. </div>
  482. </td>
  483. </tr>
  484. </tbody>
  485. </table>
  486. </div>
  487. <div>
  488. <h4>Return Value</h4>
  489. <p>The <code>FMDatabasePool</code> object. <code>nil</code> on error.</p>
  490. </div>
  491. </section>
  492. </div>
  493. </li>
  494. <li class="item">
  495. <div>
  496. <code>
  497. <a name="/c:objc(cs)FMDatabasePool(im)initWithPath:"></a>
  498. <a name="//apple_ref/objc/Method/-initWithPath:" class="dashAnchor"></a>
  499. <a class="token" href="#/c:objc(cs)FMDatabasePool(im)initWithPath:">-initWithPath:<wbr></a>
  500. </code>
  501. </div>
  502. <div class="height-container">
  503. <div class="pointer-container"></div>
  504. <section class="section">
  505. <div class="pointer"></div>
  506. <div class="abstract">
  507. <p>Create pool using path.</p>
  508. </div>
  509. <div class="declaration">
  510. <h4>Declaration</h4>
  511. <div class="language">
  512. <p class="aside-title">Objective-C</p>
  513. <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">nonnull</span> <span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithPath</span><span class="p">:(</span><span class="n">NSString</span> <span class="o">*</span><span class="n">_Nullable</span><span class="p">)</span><span class="nv">aPath</span><span class="p">;</span></code></pre>
  514. </div>
  515. <div class="language">
  516. <p class="aside-title">Swift</p>
  517. <pre class="highlight swift"><code><span class="nf">init</span><span class="p">(</span><span class="n"><a href="../Classes/FMDatabasePool.html#/c:objc(cs)FMDatabasePool(py)path">path</a></span> <span class="nv">aPath</span><span class="p">:</span> <span class="kt">String</span><span class="p">?)</span></code></pre>
  518. </div>
  519. </div>
  520. <div>
  521. <h4>Parameters</h4>
  522. <table class="graybox">
  523. <tbody>
  524. <tr>
  525. <td>
  526. <code>
  527. <em>aPath</em>
  528. </code>
  529. </td>
  530. <td>
  531. <div>
  532. <p>The file path of the database.</p>
  533. </div>
  534. </td>
  535. </tr>
  536. </tbody>
  537. </table>
  538. </div>
  539. <div>
  540. <h4>Return Value</h4>
  541. <p>The <code>FMDatabasePool</code> object. <code>nil</code> on error.</p>
  542. </div>
  543. </section>
  544. </div>
  545. </li>
  546. <li class="item">
  547. <div>
  548. <code>
  549. <a name="/c:objc(cs)FMDatabasePool(im)initWithURL:"></a>
  550. <a name="//apple_ref/objc/Method/-initWithURL:" class="dashAnchor"></a>
  551. <a class="token" href="#/c:objc(cs)FMDatabasePool(im)initWithURL:">-initWithURL:<wbr></a>
  552. </code>
  553. </div>
  554. <div class="height-container">
  555. <div class="pointer-container"></div>
  556. <section class="section">
  557. <div class="pointer"></div>
  558. <div class="abstract">
  559. <p>Create pool using file URL.</p>
  560. </div>
  561. <div class="declaration">
  562. <h4>Declaration</h4>
  563. <div class="language">
  564. <p class="aside-title">Objective-C</p>
  565. <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">nonnull</span> <span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithURL</span><span class="p">:(</span><span class="n">NSURL</span> <span class="o">*</span><span class="n">_Nullable</span><span class="p">)</span><span class="nv">url</span><span class="p">;</span></code></pre>
  566. </div>
  567. <div class="language">
  568. <p class="aside-title">Swift</p>
  569. <pre class="highlight swift"><code><span class="nf">init</span><span class="p">(</span><span class="nv">url</span><span class="p">:</span> <span class="kt">URL</span><span class="p">?)</span></code></pre>
  570. </div>
  571. </div>
  572. <div>
  573. <h4>Parameters</h4>
  574. <table class="graybox">
  575. <tbody>
  576. <tr>
  577. <td>
  578. <code>
  579. <em>url</em>
  580. </code>
  581. </td>
  582. <td>
  583. <div>
  584. <p>The file `NSURL of the database.</p>
  585. </div>
  586. </td>
  587. </tr>
  588. </tbody>
  589. </table>
  590. </div>
  591. <div>
  592. <h4>Return Value</h4>
  593. <p>The <code>FMDatabasePool</code> object. <code>nil</code> on error.</p>
  594. </div>
  595. </section>
  596. </div>
  597. </li>
  598. <li class="item">
  599. <div>
  600. <code>
  601. <a name="/c:objc(cs)FMDatabasePool(im)initWithPath:flags:"></a>
  602. <a name="//apple_ref/objc/Method/-initWithPath:flags:" class="dashAnchor"></a>
  603. <a class="token" href="#/c:objc(cs)FMDatabasePool(im)initWithPath:flags:">-initWithPath:<wbr>flags:<wbr></a>
  604. </code>
  605. </div>
  606. <div class="height-container">
  607. <div class="pointer-container"></div>
  608. <section class="section">
  609. <div class="pointer"></div>
  610. <div class="abstract">
  611. <p>Create pool using path and specified flags.</p>
  612. </div>
  613. <div class="declaration">
  614. <h4>Declaration</h4>
  615. <div class="language">
  616. <p class="aside-title">Objective-C</p>
  617. <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">nonnull</span> <span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithPath</span><span class="p">:(</span><span class="n">NSString</span> <span class="o">*</span><span class="n">_Nullable</span><span class="p">)</span><span class="nv">aPath</span>
  618. <span class="nf">flags</span><span class="p">:(</span><span class="kt">int</span><span class="p">)</span><span class="nv">openFlags</span><span class="p">;</span></code></pre>
  619. </div>
  620. <div class="language">
  621. <p class="aside-title">Swift</p>
  622. <pre class="highlight swift"><code><span class="nf">init</span><span class="p">(</span><span class="n"><a href="../Classes/FMDatabasePool.html#/c:objc(cs)FMDatabasePool(py)path">path</a></span> <span class="nv">aPath</span><span class="p">:</span> <span class="kt">String</span><span class="p">?,</span> <span class="n">flags</span> <span class="nv">openFlags</span><span class="p">:</span> <span class="kt">Int32</span><span class="p">)</span></code></pre>
  623. </div>
  624. </div>
  625. <div>
  626. <h4>Parameters</h4>
  627. <table class="graybox">
  628. <tbody>
  629. <tr>
  630. <td>
  631. <code>
  632. <em>aPath</em>
  633. </code>
  634. </td>
  635. <td>
  636. <div>
  637. <p>The file path of the database.</p>
  638. </div>
  639. </td>
  640. </tr>
  641. <tr>
  642. <td>
  643. <code>
  644. <em>openFlags</em>
  645. </code>
  646. </td>
  647. <td>
  648. <div>
  649. <p>Flags passed to the openWithFlags method of the database</p>
  650. </div>
  651. </td>
  652. </tr>
  653. </tbody>
  654. </table>
  655. </div>
  656. <div>
  657. <h4>Return Value</h4>
  658. <p>The <code>FMDatabasePool</code> object. <code>nil</code> on error.</p>
  659. </div>
  660. </section>
  661. </div>
  662. </li>
  663. <li class="item">
  664. <div>
  665. <code>
  666. <a name="/c:objc(cs)FMDatabasePool(im)initWithURL:flags:"></a>
  667. <a name="//apple_ref/objc/Method/-initWithURL:flags:" class="dashAnchor"></a>
  668. <a class="token" href="#/c:objc(cs)FMDatabasePool(im)initWithURL:flags:">-initWithURL:<wbr>flags:<wbr></a>
  669. </code>
  670. </div>
  671. <div class="height-container">
  672. <div class="pointer-container"></div>
  673. <section class="section">
  674. <div class="pointer"></div>
  675. <div class="abstract">
  676. <p>Create pool using file URL and specified flags.</p>
  677. </div>
  678. <div class="declaration">
  679. <h4>Declaration</h4>
  680. <div class="language">
  681. <p class="aside-title">Objective-C</p>
  682. <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">nonnull</span> <span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithURL</span><span class="p">:(</span><span class="n">NSURL</span> <span class="o">*</span><span class="n">_Nullable</span><span class="p">)</span><span class="nv">url</span> <span class="nf">flags</span><span class="p">:(</span><span class="kt">int</span><span class="p">)</span><span class="nv">openFlags</span><span class="p">;</span></code></pre>
  683. </div>
  684. <div class="language">
  685. <p class="aside-title">Swift</p>
  686. <pre class="highlight swift"><code><span class="nf">init</span><span class="p">(</span><span class="nv">url</span><span class="p">:</span> <span class="kt">URL</span><span class="p">?,</span> <span class="n">flags</span> <span class="nv">openFlags</span><span class="p">:</span> <span class="kt">Int32</span><span class="p">)</span></code></pre>
  687. </div>
  688. </div>
  689. <div>
  690. <h4>Parameters</h4>
  691. <table class="graybox">
  692. <tbody>
  693. <tr>
  694. <td>
  695. <code>
  696. <em>url</em>
  697. </code>
  698. </td>
  699. <td>
  700. <div>
  701. <p>The file <code>NSURL</code> of the database.</p>
  702. </div>
  703. </td>
  704. </tr>
  705. <tr>
  706. <td>
  707. <code>
  708. <em>openFlags</em>
  709. </code>
  710. </td>
  711. <td>
  712. <div>
  713. <p>Flags passed to the openWithFlags method of the database</p>
  714. </div>
  715. </td>
  716. </tr>
  717. </tbody>
  718. </table>
  719. </div>
  720. <div>
  721. <h4>Return Value</h4>
  722. <p>The <code>FMDatabasePool</code> object. <code>nil</code> on error.</p>
  723. </div>
  724. </section>
  725. </div>
  726. </li>
  727. <li class="item">
  728. <div>
  729. <code>
  730. <a name="/c:objc(cs)FMDatabasePool(im)initWithPath:flags:vfs:"></a>
  731. <a name="//apple_ref/objc/Method/-initWithPath:flags:vfs:" class="dashAnchor"></a>
  732. <a class="token" href="#/c:objc(cs)FMDatabasePool(im)initWithPath:flags:vfs:">-initWithPath:<wbr>flags:<wbr>vfs:<wbr></a>
  733. </code>
  734. </div>
  735. <div class="height-container">
  736. <div class="pointer-container"></div>
  737. <section class="section">
  738. <div class="pointer"></div>
  739. <div class="abstract">
  740. <p>Create pool using path and specified flags.</p>
  741. </div>
  742. <div class="declaration">
  743. <h4>Declaration</h4>
  744. <div class="language">
  745. <p class="aside-title">Objective-C</p>
  746. <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">nonnull</span> <span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithPath</span><span class="p">:(</span><span class="n">NSString</span> <span class="o">*</span><span class="n">_Nullable</span><span class="p">)</span><span class="nv">aPath</span>
  747. <span class="nf">flags</span><span class="p">:(</span><span class="kt">int</span><span class="p">)</span><span class="nv">openFlags</span>
  748. <span class="nf">vfs</span><span class="p">:(</span><span class="n">NSString</span> <span class="o">*</span><span class="n">_Nullable</span><span class="p">)</span><span class="nv">vfsName</span><span class="p">;</span></code></pre>
  749. </div>
  750. <div class="language">
  751. <p class="aside-title">Swift</p>
  752. <pre class="highlight swift"><code><span class="nf">init</span><span class="p">(</span><span class="n"><a href="../Classes/FMDatabasePool.html#/c:objc(cs)FMDatabasePool(py)path">path</a></span> <span class="nv">aPath</span><span class="p">:</span> <span class="kt">String</span><span class="p">?,</span> <span class="n">flags</span> <span class="nv">openFlags</span><span class="p">:</span> <span class="kt">Int32</span><span class="p">,</span> <span class="n">vfs</span> <span class="nv">vfsName</span><span class="p">:</span> <span class="kt">String</span><span class="p">?)</span></code></pre>
  753. </div>
  754. </div>
  755. <div>
  756. <h4>Parameters</h4>
  757. <table class="graybox">
  758. <tbody>
  759. <tr>
  760. <td>
  761. <code>
  762. <em>aPath</em>
  763. </code>
  764. </td>
  765. <td>
  766. <div>
  767. <p>The file path of the database.</p>
  768. </div>
  769. </td>
  770. </tr>
  771. <tr>
  772. <td>
  773. <code>
  774. <em>openFlags</em>
  775. </code>
  776. </td>
  777. <td>
  778. <div>
  779. <p>Flags passed to the openWithFlags method of the database</p>
  780. </div>
  781. </td>
  782. </tr>
  783. <tr>
  784. <td>
  785. <code>
  786. <em>vfsName</em>
  787. </code>
  788. </td>
  789. <td>
  790. <div>
  791. <p>The name of a custom virtual file system</p>
  792. </div>
  793. </td>
  794. </tr>
  795. </tbody>
  796. </table>
  797. </div>
  798. <div>
  799. <h4>Return Value</h4>
  800. <p>The <code>FMDatabasePool</code> object. <code>nil</code> on error.</p>
  801. </div>
  802. </section>
  803. </div>
  804. </li>
  805. <li class="item">
  806. <div>
  807. <code>
  808. <a name="/c:objc(cs)FMDatabasePool(im)initWithURL:flags:vfs:"></a>
  809. <a name="//apple_ref/objc/Method/-initWithURL:flags:vfs:" class="dashAnchor"></a>
  810. <a class="token" href="#/c:objc(cs)FMDatabasePool(im)initWithURL:flags:vfs:">-initWithURL:<wbr>flags:<wbr>vfs:<wbr></a>
  811. </code>
  812. </div>
  813. <div class="height-container">
  814. <div class="pointer-container"></div>
  815. <section class="section">
  816. <div class="pointer"></div>
  817. <div class="abstract">
  818. <p>Create pool using file URL and specified flags.</p>
  819. </div>
  820. <div class="declaration">
  821. <h4>Declaration</h4>
  822. <div class="language">
  823. <p class="aside-title">Objective-C</p>
  824. <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">nonnull</span> <span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithURL</span><span class="p">:(</span><span class="n">NSURL</span> <span class="o">*</span><span class="n">_Nullable</span><span class="p">)</span><span class="nv">url</span>
  825. <span class="nf">flags</span><span class="p">:(</span><span class="kt">int</span><span class="p">)</span><span class="nv">openFlags</span>
  826. <span class="nf">vfs</span><span class="p">:(</span><span class="n">NSString</span> <span class="o">*</span><span class="n">_Nullable</span><span class="p">)</span><span class="nv">vfsName</span><span class="p">;</span></code></pre>
  827. </div>
  828. <div class="language">
  829. <p class="aside-title">Swift</p>
  830. <pre class="highlight swift"><code><span class="nf">init</span><span class="p">(</span><span class="nv">url</span><span class="p">:</span> <span class="kt">URL</span><span class="p">?,</span> <span class="n">flags</span> <span class="nv">openFlags</span><span class="p">:</span> <span class="kt">Int32</span><span class="p">,</span> <span class="n">vfs</span> <span class="nv">vfsName</span><span class="p">:</span> <span class="kt">String</span><span class="p">?)</span></code></pre>
  831. </div>
  832. </div>
  833. <div>
  834. <h4>Parameters</h4>
  835. <table class="graybox">
  836. <tbody>
  837. <tr>
  838. <td>
  839. <code>
  840. <em>url</em>
  841. </code>
  842. </td>
  843. <td>
  844. <div>
  845. <p>The file <code>NSURL</code> of the database.</p>
  846. </div>
  847. </td>
  848. </tr>
  849. <tr>
  850. <td>
  851. <code>
  852. <em>openFlags</em>
  853. </code>
  854. </td>
  855. <td>
  856. <div>
  857. <p>Flags passed to the openWithFlags method of the database</p>
  858. </div>
  859. </td>
  860. </tr>
  861. <tr>
  862. <td>
  863. <code>
  864. <em>vfsName</em>
  865. </code>
  866. </td>
  867. <td>
  868. <div>
  869. <p>The name of a custom virtual file system</p>
  870. </div>
  871. </td>
  872. </tr>
  873. </tbody>
  874. </table>
  875. </div>
  876. <div>
  877. <h4>Return Value</h4>
  878. <p>The <code>FMDatabasePool</code> object. <code>nil</code> on error.</p>
  879. </div>
  880. </section>
  881. </div>
  882. </li>
  883. <li class="item">
  884. <div>
  885. <code>
  886. <a name="/c:objc(cs)FMDatabasePool(cm)databaseClass"></a>
  887. <a name="//apple_ref/objc/Method/+databaseClass" class="dashAnchor"></a>
  888. <a class="token" href="#/c:objc(cs)FMDatabasePool(cm)databaseClass">+databaseClass</a>
  889. </code>
  890. </div>
  891. <div class="height-container">
  892. <div class="pointer-container"></div>
  893. <section class="section">
  894. <div class="pointer"></div>
  895. <div class="abstract">
  896. <p>Returns the Class of &lsquo;FMDatabase&rsquo; subclass, that will be used to instantiate database object.</p>
  897. <p>Subclasses can override this method to return specified Class of &lsquo;FMDatabase&rsquo; subclass.</p>
  898. </div>
  899. <div class="declaration">
  900. <h4>Declaration</h4>
  901. <div class="language">
  902. <p class="aside-title">Objective-C</p>
  903. <pre class="highlight objective_c"><code><span class="k">+</span> <span class="p">(</span><span class="n">nonnull</span> <span class="n">Class</span><span class="p">)</span><span class="n">databaseClass</span><span class="p">;</span></code></pre>
  904. </div>
  905. <div class="language">
  906. <p class="aside-title">Swift</p>
  907. <pre class="highlight swift"><code><span class="kd">class</span> <span class="kd">func</span> <span class="nf">databaseClass</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="kt">AnyClass</span></code></pre>
  908. </div>
  909. </div>
  910. <div>
  911. <h4>Return Value</h4>
  912. <p>The Class of &lsquo;FMDatabase&rsquo; subclass, that will be used to instantiate database object.</p>
  913. </div>
  914. </section>
  915. </div>
  916. </li>
  917. </ul>
  918. </div>
  919. <div class="task-group">
  920. <div class="task-name-container">
  921. <a name="/Keeping%20track%20of%20checked%20in/out%20databases"></a>
  922. <a name="//apple_ref/objc/Section/Keeping track of checked in/out databases" class="dashAnchor"></a>
  923. <div class="section-name-container">
  924. <a class="section-name-link" href="#/Keeping%20track%20of%20checked%20in/out%20databases"></a>
  925. <h3 class="section-name"><p>Keeping track of checked in/out databases</p>
  926. </h3>
  927. </div>
  928. </div>
  929. <ul>
  930. <li class="item">
  931. <div>
  932. <code>
  933. <a name="/c:objc(cs)FMDatabasePool(py)countOfCheckedInDatabases"></a>
  934. <a name="//apple_ref/objc/Property/countOfCheckedInDatabases" class="dashAnchor"></a>
  935. <a class="token" href="#/c:objc(cs)FMDatabasePool(py)countOfCheckedInDatabases">countOfCheckedInDatabases</a>
  936. </code>
  937. </div>
  938. <div class="height-container">
  939. <div class="pointer-container"></div>
  940. <section class="section">
  941. <div class="pointer"></div>
  942. <div class="abstract">
  943. <p>Number of checked-in databases in pool</p>
  944. </div>
  945. <div class="declaration">
  946. <h4>Declaration</h4>
  947. <div class="language">
  948. <p class="aside-title">Objective-C</p>
  949. <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nonatomic</span><span class="p">,</span> <span class="n">readonly</span><span class="p">)</span> <span class="n">NSUInteger</span> <span class="n">countOfCheckedInDatabases</span><span class="p">;</span></code></pre>
  950. </div>
  951. <div class="language">
  952. <p class="aside-title">Swift</p>
  953. <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">countOfCheckedInDatabases</span><span class="p">:</span> <span class="kt">UInt</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
  954. </div>
  955. </div>
  956. </section>
  957. </div>
  958. </li>
  959. <li class="item">
  960. <div>
  961. <code>
  962. <a name="/c:objc(cs)FMDatabasePool(py)countOfCheckedOutDatabases"></a>
  963. <a name="//apple_ref/objc/Property/countOfCheckedOutDatabases" class="dashAnchor"></a>
  964. <a class="token" href="#/c:objc(cs)FMDatabasePool(py)countOfCheckedOutDatabases">countOfCheckedOutDatabases</a>
  965. </code>
  966. </div>
  967. <div class="height-container">
  968. <div class="pointer-container"></div>
  969. <section class="section">
  970. <div class="pointer"></div>
  971. <div class="abstract">
  972. <p>Number of checked-out databases in pool</p>
  973. </div>
  974. <div class="declaration">
  975. <h4>Declaration</h4>
  976. <div class="language">
  977. <p class="aside-title">Objective-C</p>
  978. <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nonatomic</span><span class="p">,</span> <span class="n">readonly</span><span class="p">)</span> <span class="n">NSUInteger</span> <span class="n">countOfCheckedOutDatabases</span><span class="p">;</span></code></pre>
  979. </div>
  980. <div class="language">
  981. <p class="aside-title">Swift</p>
  982. <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">countOfCheckedOutDatabases</span><span class="p">:</span> <span class="kt">UInt</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
  983. </div>
  984. </div>
  985. </section>
  986. </div>
  987. </li>
  988. <li class="item">
  989. <div>
  990. <code>
  991. <a name="/c:objc(cs)FMDatabasePool(py)countOfOpenDatabases"></a>
  992. <a name="//apple_ref/objc/Property/countOfOpenDatabases" class="dashAnchor"></a>
  993. <a class="token" href="#/c:objc(cs)FMDatabasePool(py)countOfOpenDatabases">countOfOpenDatabases</a>
  994. </code>
  995. </div>
  996. <div class="height-container">
  997. <div class="pointer-container"></div>
  998. <section class="section">
  999. <div class="pointer"></div>
  1000. <div class="abstract">
  1001. <p>Total number of databases in pool</p>
  1002. </div>
  1003. <div class="declaration">
  1004. <h4>Declaration</h4>
  1005. <div class="language">
  1006. <p class="aside-title">Objective-C</p>
  1007. <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nonatomic</span><span class="p">,</span> <span class="n">readonly</span><span class="p">)</span> <span class="n">NSUInteger</span> <span class="n">countOfOpenDatabases</span><span class="p">;</span></code></pre>
  1008. </div>
  1009. <div class="language">
  1010. <p class="aside-title">Swift</p>
  1011. <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">countOfOpenDatabases</span><span class="p">:</span> <span class="kt">UInt</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
  1012. </div>
  1013. </div>
  1014. </section>
  1015. </div>
  1016. </li>
  1017. <li class="item">
  1018. <div>
  1019. <code>
  1020. <a name="/c:objc(cs)FMDatabasePool(im)releaseAllDatabases"></a>
  1021. <a name="//apple_ref/objc/Method/-releaseAllDatabases" class="dashAnchor"></a>
  1022. <a class="token" href="#/c:objc(cs)FMDatabasePool(im)releaseAllDatabases">-releaseAllDatabases</a>
  1023. </code>
  1024. </div>
  1025. <div class="height-container">
  1026. <div class="pointer-container"></div>
  1027. <section class="section">
  1028. <div class="pointer"></div>
  1029. <div class="abstract">
  1030. <p>Release all databases in pool</p>
  1031. </div>
  1032. <div class="declaration">
  1033. <h4>Declaration</h4>
  1034. <div class="language">
  1035. <p class="aside-title">Objective-C</p>
  1036. <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="n">releaseAllDatabases</span><span class="p">;</span></code></pre>
  1037. </div>
  1038. <div class="language">
  1039. <p class="aside-title">Swift</p>
  1040. <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">releaseAllDatabases</span><span class="p">()</span></code></pre>
  1041. </div>
  1042. </div>
  1043. </section>
  1044. </div>
  1045. </li>
  1046. </ul>
  1047. </div>
  1048. <div class="task-group">
  1049. <div class="task-name-container">
  1050. <a name="/Perform%20database%20operations%20in%20pool"></a>
  1051. <a name="//apple_ref/objc/Section/Perform database operations in pool" class="dashAnchor"></a>
  1052. <div class="section-name-container">
  1053. <a class="section-name-link" href="#/Perform%20database%20operations%20in%20pool"></a>
  1054. <h3 class="section-name"><p>Perform database operations in pool</p>
  1055. </h3>
  1056. </div>
  1057. </div>
  1058. <ul>
  1059. <li class="item">
  1060. <div>
  1061. <code>
  1062. <a name="/c:objc(cs)FMDatabasePool(im)inDatabase:"></a>
  1063. <a name="//apple_ref/objc/Method/-inDatabase:" class="dashAnchor"></a>
  1064. <a class="token" href="#/c:objc(cs)FMDatabasePool(im)inDatabase:">-inDatabase:<wbr></a>
  1065. </code>
  1066. </div>
  1067. <div class="height-container">
  1068. <div class="pointer-container"></div>
  1069. <section class="section">
  1070. <div class="pointer"></div>
  1071. <div class="abstract">
  1072. <p>Synchronously perform database operations in pool.</p>
  1073. </div>
  1074. <div class="declaration">
  1075. <h4>Declaration</h4>
  1076. <div class="language">
  1077. <p class="aside-title">Objective-C</p>
  1078. <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">inDatabase</span><span class="p">:(</span><span class="n">nonnull</span> <span class="kt">void</span> <span class="p">(</span><span class="o">^</span><span class="p">)(</span><span class="n"><a href="../Classes/FMDatabase.html">FMDatabase</a></span> <span class="o">*</span><span class="n">_Nonnull</span><span class="p">))</span><span class="nv">block</span><span class="p">;</span></code></pre>
  1079. </div>
  1080. <div class="language">
  1081. <p class="aside-title">Swift</p>
  1082. <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">inDatabase</span><span class="p">(</span><span class="n">_</span> <span class="nv">block</span><span class="p">:</span> <span class="p">(</span><span class="kt"><a href="../Classes/FMDatabase.html">FMDatabase</a></span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Void</span><span class="p">)</span></code></pre>
  1083. </div>
  1084. </div>
  1085. <div>
  1086. <h4>Parameters</h4>
  1087. <table class="graybox">
  1088. <tbody>
  1089. <tr>
  1090. <td>
  1091. <code>
  1092. <em>block</em>
  1093. </code>
  1094. </td>
  1095. <td>
  1096. <div>
  1097. <p>The code to be run on the <code>FMDatabasePool</code> pool.</p>
  1098. </div>
  1099. </td>
  1100. </tr>
  1101. </tbody>
  1102. </table>
  1103. </div>
  1104. </section>
  1105. </div>
  1106. </li>
  1107. <li class="item">
  1108. <div>
  1109. <code>
  1110. <a name="/c:objc(cs)FMDatabasePool(im)inTransaction:"></a>
  1111. <a name="//apple_ref/objc/Method/-inTransaction:" class="dashAnchor"></a>
  1112. <a class="token" href="#/c:objc(cs)FMDatabasePool(im)inTransaction:">-inTransaction:<wbr></a>
  1113. </code>
  1114. </div>
  1115. <div class="height-container">
  1116. <div class="pointer-container"></div>
  1117. <section class="section">
  1118. <div class="pointer"></div>
  1119. <div class="abstract">
  1120. <p>Synchronously perform database operations in pool using transaction.</p>
  1121. <div class="aside aside-warning">
  1122. <p class="aside-title">Warning</p>
  1123. <p>Unlike SQLite&rsquo;s <code>BEGIN TRANSACTION</code>, this method currently performs
  1124. an exclusive transaction, not a deferred transaction. This behavior
  1125. is likely to change in future versions of FMDB, whereby this method
  1126. will likely eventually adopt standard SQLite behavior and perform
  1127. deferred transactions. If you really need exclusive tranaction, it is
  1128. recommended that you use <code>inExclusiveTransaction</code>, instead, not only
  1129. to make your intent explicit, but also to future-proof your code.</p>
  1130. </div>
  1131. </div>
  1132. <div class="declaration">
  1133. <h4>Declaration</h4>
  1134. <div class="language">
  1135. <p class="aside-title">Objective-C</p>
  1136. <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">inTransaction</span><span class="p">:(</span><span class="n">nonnull</span> <span class="kt">void</span> <span class="p">(</span><span class="o">^</span><span class="p">)(</span><span class="n"><a href="../Classes/FMDatabase.html">FMDatabase</a></span> <span class="o">*</span><span class="n">_Nonnull</span><span class="p">,</span>
  1137. <span class="n">BOOL</span> <span class="o">*</span><span class="n">_Nonnull</span><span class="p">))</span><span class="n">block</span><span class="p">;</span></code></pre>
  1138. </div>
  1139. <div class="language">
  1140. <p class="aside-title">Swift</p>
  1141. <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">inTransaction</span><span class="p">(</span><span class="n">_</span> <span class="nv">block</span><span class="p">:</span> <span class="p">(</span><span class="kt"><a href="../Classes/FMDatabase.html">FMDatabase</a></span><span class="p">,</span> <span class="kt">UnsafeMutablePointer</span><span class="o">&lt;</span><span class="kt">ObjCBool</span><span class="o">&gt;</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Void</span><span class="p">)</span></code></pre>
  1142. </div>
  1143. </div>
  1144. <div>
  1145. <h4>Parameters</h4>
  1146. <table class="graybox">
  1147. <tbody>
  1148. <tr>
  1149. <td>
  1150. <code>
  1151. <em>block</em>
  1152. </code>
  1153. </td>
  1154. <td>
  1155. <div>
  1156. <p>The code to be run on the <code>FMDatabasePool</code> pool.</p>
  1157. </div>
  1158. </td>
  1159. </tr>
  1160. </tbody>
  1161. </table>
  1162. </div>
  1163. </section>
  1164. </div>
  1165. </li>
  1166. <li class="item">
  1167. <div>
  1168. <code>
  1169. <a name="/c:objc(cs)FMDatabasePool(im)inExclusiveTransaction:"></a>
  1170. <a name="//apple_ref/objc/Method/-inExclusiveTransaction:" class="dashAnchor"></a>
  1171. <a class="token" href="#/c:objc(cs)FMDatabasePool(im)inExclusiveTransaction:">-inExclusiveTransaction:<wbr></a>
  1172. </code>
  1173. </div>
  1174. <div class="height-container">
  1175. <div class="pointer-container"></div>
  1176. <section class="section">
  1177. <div class="pointer"></div>
  1178. <div class="abstract">
  1179. <p>Synchronously perform database operations in pool using exclusive transaction.</p>
  1180. </div>
  1181. <div class="declaration">
  1182. <h4>Declaration</h4>
  1183. <div class="language">
  1184. <p class="aside-title">Objective-C</p>
  1185. <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">inExclusiveTransaction</span><span class="p">:(</span><span class="n">nonnull</span> <span class="kt">void</span> <span class="p">(</span><span class="o">^</span><span class="p">)(</span><span class="n"><a href="../Classes/FMDatabase.html">FMDatabase</a></span> <span class="o">*</span><span class="n">_Nonnull</span><span class="p">,</span>
  1186. <span class="n">BOOL</span> <span class="o">*</span><span class="n">_Nonnull</span><span class="p">))</span><span class="n">block</span><span class="p">;</span></code></pre>
  1187. </div>
  1188. <div class="language">
  1189. <p class="aside-title">Swift</p>
  1190. <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">inExclusiveTransaction</span><span class="p">(</span><span class="n">_</span> <span class="nv">block</span><span class="p">:</span> <span class="p">(</span><span class="kt"><a href="../Classes/FMDatabase.html">FMDatabase</a></span><span class="p">,</span> <span class="kt">UnsafeMutablePointer</span><span class="o">&lt;</span><span class="kt">ObjCBool</span><span class="o">&gt;</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Void</span><span class="p">)</span></code></pre>
  1191. </div>
  1192. </div>
  1193. <div>
  1194. <h4>Parameters</h4>
  1195. <table class="graybox">
  1196. <tbody>
  1197. <tr>
  1198. <td>
  1199. <code>
  1200. <em>block</em>
  1201. </code>
  1202. </td>
  1203. <td>
  1204. <div>
  1205. <p>The code to be run on the <code>FMDatabasePool</code> pool.</p>
  1206. </div>
  1207. </td>
  1208. </tr>
  1209. </tbody>
  1210. </table>
  1211. </div>
  1212. </section>
  1213. </div>
  1214. </li>
  1215. <li class="item">
  1216. <div>
  1217. <code>
  1218. <a name="/c:objc(cs)FMDatabasePool(im)inDeferredTransaction:"></a>
  1219. <a name="//apple_ref/objc/Method/-inDeferredTransaction:" class="dashAnchor"></a>
  1220. <a class="token" href="#/c:objc(cs)FMDatabasePool(im)inDeferredTransaction:">-inDeferredTransaction:<wbr></a>
  1221. </code>
  1222. </div>
  1223. <div class="height-container">
  1224. <div class="pointer-container"></div>
  1225. <section class="section">
  1226. <div class="pointer"></div>
  1227. <div class="abstract">
  1228. <p>Synchronously perform database operations in pool using deferred transaction.</p>
  1229. </div>
  1230. <div class="declaration">
  1231. <h4>Declaration</h4>
  1232. <div class="language">
  1233. <p class="aside-title">Objective-C</p>
  1234. <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">inDeferredTransaction</span><span class="p">:(</span><span class="n">nonnull</span> <span class="kt">void</span> <span class="p">(</span><span class="o">^</span><span class="p">)(</span><span class="n"><a href="../Classes/FMDatabase.html">FMDatabase</a></span> <span class="o">*</span><span class="n">_Nonnull</span><span class="p">,</span>
  1235. <span class="n">BOOL</span> <span class="o">*</span><span class="n">_Nonnull</span><span class="p">))</span><span class="n">block</span><span class="p">;</span></code></pre>
  1236. </div>
  1237. <div class="language">
  1238. <p class="aside-title">Swift</p>
  1239. <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">inDeferredTransaction</span><span class="p">(</span><span class="n">_</span> <span class="nv">block</span><span class="p">:</span> <span class="p">(</span><span class="kt"><a href="../Classes/FMDatabase.html">FMDatabase</a></span><span class="p">,</span> <span class="kt">UnsafeMutablePointer</span><span class="o">&lt;</span><span class="kt">ObjCBool</span><span class="o">&gt;</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Void</span><span class="p">)</span></code></pre>
  1240. </div>
  1241. </div>
  1242. <div>
  1243. <h4>Parameters</h4>
  1244. <table class="graybox">
  1245. <tbody>
  1246. <tr>
  1247. <td>
  1248. <code>
  1249. <em>block</em>
  1250. </code>
  1251. </td>
  1252. <td>
  1253. <div>
  1254. <p>The code to be run on the <code>FMDatabasePool</code> pool.</p>
  1255. </div>
  1256. </td>
  1257. </tr>
  1258. </tbody>
  1259. </table>
  1260. </div>
  1261. </section>
  1262. </div>
  1263. </li>
  1264. <li class="item">
  1265. <div>
  1266. <code>
  1267. <a name="/c:objc(cs)FMDatabasePool(im)inImmediateTransaction:"></a>
  1268. <a name="//apple_ref/objc/Method/-inImmediateTransaction:" class="dashAnchor"></a>
  1269. <a class="token" href="#/c:objc(cs)FMDatabasePool(im)inImmediateTransaction:">-inImmediateTransaction:<wbr></a>
  1270. </code>
  1271. </div>
  1272. <div class="height-container">
  1273. <div class="pointer-container"></div>
  1274. <section class="section">
  1275. <div class="pointer"></div>
  1276. <div class="abstract">
  1277. <p>Synchronously perform database operations on queue, using immediate transactions.</p>
  1278. </div>
  1279. <div class="declaration">
  1280. <h4>Declaration</h4>
  1281. <div class="language">
  1282. <p class="aside-title">Objective-C</p>
  1283. <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">inImmediateTransaction</span><span class="p">:(</span><span class="n">nonnull</span> <span class="kt">void</span> <span class="p">(</span><span class="o">^</span><span class="p">)(</span><span class="n"><a href="../Classes/FMDatabase.html">FMDatabase</a></span> <span class="o">*</span><span class="n">_Nonnull</span><span class="p">,</span>
  1284. <span class="n">BOOL</span> <span class="o">*</span><span class="n">_Nonnull</span><span class="p">))</span><span class="n">block</span><span class="p">;</span></code></pre>
  1285. </div>
  1286. <div class="language">
  1287. <p class="aside-title">Swift</p>
  1288. <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">inImmediateTransaction</span><span class="p">(</span><span class="n">_</span> <span class="nv">block</span><span class="p">:</span> <span class="p">(</span><span class="kt"><a href="../Classes/FMDatabase.html">FMDatabase</a></span><span class="p">,</span> <span class="kt">UnsafeMutablePointer</span><span class="o">&lt;</span><span class="kt">ObjCBool</span><span class="o">&gt;</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Void</span><span class="p">)</span></code></pre>
  1289. </div>
  1290. </div>
  1291. <div>
  1292. <h4>Parameters</h4>
  1293. <table class="graybox">
  1294. <tbody>
  1295. <tr>
  1296. <td>
  1297. <code>
  1298. <em>block</em>
  1299. </code>
  1300. </td>
  1301. <td>
  1302. <div>
  1303. <p>The code to be run on the queue of <code><a href="../Classes/FMDatabaseQueue.html">FMDatabaseQueue</a></code></p>
  1304. </div>
  1305. </td>
  1306. </tr>
  1307. </tbody>
  1308. </table>
  1309. </div>
  1310. </section>
  1311. </div>
  1312. </li>
  1313. <li class="item">
  1314. <div>
  1315. <code>
  1316. <a name="/c:objc(cs)FMDatabasePool(im)inSavePoint:"></a>
  1317. <a name="//apple_ref/objc/Method/-inSavePoint:" class="dashAnchor"></a>
  1318. <a class="token" href="#/c:objc(cs)FMDatabasePool(im)inSavePoint:">-inSavePoint:<wbr></a>
  1319. </code>
  1320. </div>
  1321. <div class="height-container">
  1322. <div class="pointer-container"></div>
  1323. <section class="section">
  1324. <div class="pointer"></div>
  1325. <div class="abstract">
  1326. <p>Synchronously perform database operations in pool using save point.</p>
  1327. <div class="aside aside-warning">
  1328. <p class="aside-title">Warning</p>
  1329. <p>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 <code>startSavePointWithName:error:</code> instead.</p>
  1330. </div>
  1331. </div>
  1332. <div class="declaration">
  1333. <h4>Declaration</h4>
  1334. <div class="language">
  1335. <p class="aside-title">Objective-C</p>
  1336. <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">NSError</span> <span class="o">*</span><span class="n">_Nullable</span><span class="p">)</span><span class="nf">inSavePoint</span><span class="p">:(</span><span class="n">nonnull</span> <span class="kt">void</span> <span class="p">(</span><span class="o">^</span><span class="p">)(</span><span class="n"><a href="../Classes/FMDatabase.html">FMDatabase</a></span> <span class="o">*</span><span class="n">_Nonnull</span><span class="p">,</span>
  1337. <span class="n">BOOL</span> <span class="o">*</span><span class="n">_Nonnull</span><span class="p">))</span><span class="n">block</span><span class="p">;</span></code></pre>
  1338. </div>
  1339. <div class="language">
  1340. <p class="aside-title">Swift</p>
  1341. <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">inSavePoint</span><span class="p">(</span><span class="n">_</span> <span class="nv">block</span><span class="p">:</span> <span class="p">(</span><span class="kt"><a href="../Classes/FMDatabase.html">FMDatabase</a></span><span class="p">,</span> <span class="kt">UnsafeMutablePointer</span><span class="o">&lt;</span><span class="kt">ObjCBool</span><span class="o">&gt;</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Void</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Error</span><span class="p">?</span></code></pre>
  1342. </div>
  1343. </div>
  1344. <div>
  1345. <h4>Parameters</h4>
  1346. <table class="graybox">
  1347. <tbody>
  1348. <tr>
  1349. <td>
  1350. <code>
  1351. <em>block</em>
  1352. </code>
  1353. </td>
  1354. <td>
  1355. <div>
  1356. <p>The code to be run on the <code>FMDatabasePool</code> pool.</p>
  1357. </div>
  1358. </td>
  1359. </tr>
  1360. </tbody>
  1361. </table>
  1362. </div>
  1363. <div>
  1364. <h4>Return Value</h4>
  1365. <p><code>NSError</code> object if error; <code>nil</code> if successful.</p>
  1366. </div>
  1367. </section>
  1368. </div>
  1369. </li>
  1370. </ul>
  1371. </div>
  1372. </section>
  1373. </section>
  1374. <section id="footer">
  1375. <p>&copy; 2020 <a class="link" href="https://github.com/ccgus/fmdb" target="_blank" rel="external">Gus Mueller, Flying Meat</a>. All rights reserved. (Last updated: 2020-05-09)</p>
  1376. <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
  1377. </section>
  1378. </article>
  1379. </div>
  1380. </body>
  1381. </div>
  1382. </html>