| 1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195 |
- <!DOCTYPE HTML>
- <html>
- <head>
- <meta http-equiv="Content-Type" content="html/html; charset=utf-8" />
- <title>FMDatabasePool Class Reference</title>
- <meta id="xcode-display" name="xcode-display" content="render"/>
- <meta name="viewport" content="width=550" />
- <link rel="stylesheet" type="text/css" href="../css/styles.css" media="all" />
- <link rel="stylesheet" type="text/css" media="print" href="../css/stylesPrint.css" />
- <meta name="generator" content="appledoc 2.1 (build 858)" />
- </head>
- <body>
- <header id="top_header">
- <div id="library" class="hideInXcode">
- <h1><a id="libraryTitle" href="../index.html">FMDB </a></h1>
- <a id="developerHome" href="../index.html">ccgus</a>
- </div>
-
- <div id="title" role="banner">
- <h1 class="hideInXcode">FMDatabasePool Class Reference</h1>
- </div>
- <ul id="headerButtons" role="toolbar">
- <li id="toc_button">
- <button aria-label="Show Table of Contents" role="checkbox" class="open" id="table_of_contents"><span class="disclosure"></span>Table of Contents</button>
- </li>
- <li id="jumpto_button" role="navigation">
- <select id="jumpTo">
- <option value="top">Jump To…</option>
-
- <option value="overview">Overview</option>
-
-
-
-
- <option value="tasks">Tasks</option>
-
-
-
-
-
- <option value="properties">Properties</option>
-
- <option value="//api/name/delegate"> delegate</option>
-
- <option value="//api/name/maximumNumberOfDatabasesToCreate"> maximumNumberOfDatabasesToCreate</option>
-
- <option value="//api/name/openFlags"> openFlags</option>
-
- <option value="//api/name/path"> path</option>
-
-
-
-
- <option value="class_methods">Class Methods</option>
-
- <option value="//api/name/databasePoolWithPath:"> + databasePoolWithPath:</option>
-
- <option value="//api/name/databasePoolWithPath:flags:"> + databasePoolWithPath:flags:</option>
-
-
-
-
- <option value="instance_methods">Instance Methods</option>
-
- <option value="//api/name/countOfCheckedInDatabases"> - countOfCheckedInDatabases</option>
-
- <option value="//api/name/countOfCheckedOutDatabases"> - countOfCheckedOutDatabases</option>
-
- <option value="//api/name/countOfOpenDatabases"> - countOfOpenDatabases</option>
-
- <option value="//api/name/inDatabase:"> - inDatabase:</option>
-
- <option value="//api/name/inDeferredTransaction:"> - inDeferredTransaction:</option>
-
- <option value="//api/name/inSavePoint:"> - inSavePoint:</option>
-
- <option value="//api/name/inTransaction:"> - inTransaction:</option>
-
- <option value="//api/name/initWithPath:"> - initWithPath:</option>
-
- <option value="//api/name/initWithPath:flags:"> - initWithPath:flags:</option>
-
- <option value="//api/name/releaseAllDatabases"> - releaseAllDatabases</option>
-
-
-
- </select>
- </li>
- </ul>
- </header>
- <nav id="tocContainer" class="isShowingTOC">
- <ul id="toc" role="tree">
-
- <li role="treeitem"><span class="nodisclosure"></span><span class="sectionName"><a href="#overview">Overview</a></span></li>
- <li role="treeitem" id="task_treeitem"><span class="nodisclosure"></span><span class="sectionName"><a href="#tasks">Tasks</a></span><ul>
-
- </ul></li>
- <li role="treeitem" class="children"><span class="disclosure"></span><span class="sectionName"><a href="#properties">Properties</a></span><ul>
-
- <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/delegate">delegate</a></span></li>
-
- <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/maximumNumberOfDatabasesToCreate">maximumNumberOfDatabasesToCreate</a></span></li>
-
- <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/openFlags">openFlags</a></span></li>
-
- <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/path">path</a></span></li>
-
- </ul></li>
- <li role="treeitem" class="children"><span class="disclosure"></span><span class="sectionName"><a href="#class_methods">Class Methods</a></span><ul>
-
- <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/databasePoolWithPath:">databasePoolWithPath:</a></span></li>
-
- <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/databasePoolWithPath:flags:">databasePoolWithPath:flags:</a></span></li>
-
- </ul></li>
- <li role="treeitem" class="children"><span class="disclosure"></span><span class="sectionName"><a href="#instance_methods">Instance Methods</a></span><ul>
-
- <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/countOfCheckedInDatabases">countOfCheckedInDatabases</a></span></li>
-
- <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/countOfCheckedOutDatabases">countOfCheckedOutDatabases</a></span></li>
-
- <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/countOfOpenDatabases">countOfOpenDatabases</a></span></li>
-
- <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/inDatabase:">inDatabase:</a></span></li>
-
- <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/inDeferredTransaction:">inDeferredTransaction:</a></span></li>
-
- <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/inSavePoint:">inSavePoint:</a></span></li>
-
- <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/inTransaction:">inTransaction:</a></span></li>
-
- <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/initWithPath:">initWithPath:</a></span></li>
-
- <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/initWithPath:flags:">initWithPath:flags:</a></span></li>
-
- <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/releaseAllDatabases">releaseAllDatabases</a></span></li>
-
- </ul></li>
- </ul>
- </nav>
- <article>
- <div id="contents" class="isShowingTOC" role="main">
- <a title="FMDatabasePool Class Reference" name="top"></a>
- <div class="main-navigation navigation-top">
- <ul>
- <li><a href="../index.html">Index</a></li>
- <li><a href="../hierarchy.html">Hierarchy</a></li>
- </ul>
- </div>
- <div id="header">
- <div class="section-header">
- <h1 class="title title-header">FMDatabasePool Class Reference</h1>
- </div>
- </div>
- <div id="container">
-
- <div class="section section-specification"><table cellspacing="0"><tbody>
- <tr>
- <td class="specification-title">Inherits from</td>
- <td class="specification-value">NSObject</td>
- </tr><tr>
- <td class="specification-title">Declared in</td>
- <td class="specification-value">FMDatabasePool.h<br />FMDatabasePool.m</td>
- </tr>
- </tbody></table></div>
-
-
-
-
- <div class="section section-overview">
- <a title="Overview" name="overview"></a>
- <h2 class="subtitle subtitle-overview">Overview</h2>
- <p>Pool of <a href="../Classes/FMDatabase.html"><code>FMDatabase</code></a> objects.</p>
- <h3>See also</h3>
- <ul>
- <li><a href="../Classes/FMDatabaseQueue.html"><code>FMDatabaseQueue</code></a></li>
- <li><a href="../Classes/FMDatabase.html"><code>FMDatabase</code></a></li>
- </ul>
- <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>
- <p>If you really really really know what you’re doing and <code>FMDatabasePool</code> is what
- you really really need (ie, you’re using a read only database), OK you can use
- it. But just be careful not to deadlock!</p>
- <p>For an example on deadlocking, search for:
- <code>ONLY_USE_THE_POOL_IF_YOU_ARE_DOING_READS_OTHERWISE_YOULL_DEADLOCK_USE_FMDATABASEQUEUE_INSTEAD</code>
- in the main.m file.</p></div>
- </div>
-
-
-
-
-
- <div class="section section-tasks">
- <a title="Tasks" name="tasks"></a>
- <h2 class="subtitle subtitle-tasks">Tasks</h2>
-
-
-
- <h3 class="subsubtitle task-title">Other Methods</h3>
- <ul class="task-list">
- <li>
- <span class="tooltip">
- <code><a href="#//api/name/databasePoolWithPath:">+ databasePoolWithPath:</a></code>
- <span class="tooltip"><p>Create pool using path.</p></span>
- </span>
-
-
- </li><li>
- <span class="tooltip">
- <code><a href="#//api/name/databasePoolWithPath:flags:">+ databasePoolWithPath:flags:</a></code>
- <span class="tooltip"><p>Create pool using path and specified flags</p></span>
- </span>
-
-
- </li><li>
- <span class="tooltip">
- <code><a href="#//api/name/initWithPath:flags:">– initWithPath:flags:</a></code>
- <span class="tooltip"><p>Create pool using path and specified flags.</p></span>
- </span>
-
-
- </li><li>
- <span class="tooltip">
- <code><a href="#//api/name/initWithPath:">– initWithPath:</a></code>
- <span class="tooltip"><p>Create pool using path.</p></span>
- </span>
-
-
- </li><li>
- <span class="tooltip">
- <code><a href="#//api/name/countOfCheckedInDatabases">– countOfCheckedInDatabases</a></code>
- <span class="tooltip"><p>Number of checked-in databases in pool</p></span>
- </span>
-
-
- </li><li>
- <span class="tooltip">
- <code><a href="#//api/name/countOfCheckedOutDatabases">– countOfCheckedOutDatabases</a></code>
- <span class="tooltip"><p>Number of checked-out databases in pool</p></span>
- </span>
-
-
- </li><li>
- <span class="tooltip">
- <code><a href="#//api/name/countOfOpenDatabases">– countOfOpenDatabases</a></code>
- <span class="tooltip"><p>Total number of databases in pool</p></span>
- </span>
-
-
- </li><li>
- <span class="tooltip">
- <code><a href="#//api/name/releaseAllDatabases">– releaseAllDatabases</a></code>
- <span class="tooltip"><p>Release all databases in pool</p></span>
- </span>
-
-
- </li><li>
- <span class="tooltip">
- <code><a href="#//api/name/inDatabase:">– inDatabase:</a></code>
- <span class="tooltip"><p>Synchronously perform database operations in pool.</p></span>
- </span>
-
-
- </li><li>
- <span class="tooltip">
- <code><a href="#//api/name/inDeferredTransaction:">– inDeferredTransaction:</a></code>
- <span class="tooltip"><p>Synchronously perform database operations in pool using deferred transaction.</p></span>
- </span>
-
-
- </li><li>
- <span class="tooltip">
- <code><a href="#//api/name/inTransaction:">– inTransaction:</a></code>
- <span class="tooltip"><p>Synchronously perform database operations in pool using transaction.</p></span>
- </span>
-
-
- </li><li>
- <span class="tooltip">
- <code><a href="#//api/name/inSavePoint:">– inSavePoint:</a></code>
- <span class="tooltip"><p>Synchronously perform database operations in pool using save point.</p></span>
- </span>
-
-
- </li>
- </ul>
-
-
-
- <h3 class="subsubtitle task-title">Other Methods</h3>
- <ul class="task-list">
- <li>
- <span class="tooltip">
- <code><a href="#//api/name/path"> path</a></code>
- <span class="tooltip"><p>Database path</p></span>
- </span>
- <span class="task-item-suffix">property</span>
-
- </li><li>
- <span class="tooltip">
- <code><a href="#//api/name/delegate"> delegate</a></code>
- <span class="tooltip"><p>Delegate object</p></span>
- </span>
- <span class="task-item-suffix">property</span>
-
- </li><li>
- <span class="tooltip">
- <code><a href="#//api/name/maximumNumberOfDatabasesToCreate"> maximumNumberOfDatabasesToCreate</a></code>
- <span class="tooltip"><p>Maximum number of databases to create</p></span>
- </span>
- <span class="task-item-suffix">property</span>
-
- </li><li>
- <span class="tooltip">
- <code><a href="#//api/name/openFlags"> openFlags</a></code>
- <span class="tooltip"><p>Open flags</p></span>
- </span>
- <span class="task-item-suffix">property</span>
-
- </li>
- </ul>
-
- </div>
-
-
-
-
-
- <div class="section section-methods">
- <a title="Properties" name="properties"></a>
- <h2 class="subtitle subtitle-methods">Properties</h2>
-
- <div class="section-method">
- <a name="//api/name/delegate" title="delegate"></a>
- <h3 class="subsubtitle method-title">delegate</h3>
-
-
-
- <div class="method-subsection brief-description">
- <p>Delegate object</p>
- </div>
-
-
- <div class="method-subsection method-declaration"><code>@property (atomic, assign) id delegate</code></div>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <div class="method-subsection declared-in-section">
- <h4 class="method-subtitle">Declared In</h4>
- <code class="declared-in-ref">FMDatabasePool.h</code><br />
- </div>
-
-
- </div>
-
- <div class="section-method">
- <a name="//api/name/maximumNumberOfDatabasesToCreate" title="maximumNumberOfDatabasesToCreate"></a>
- <h3 class="subsubtitle method-title">maximumNumberOfDatabasesToCreate</h3>
-
-
-
- <div class="method-subsection brief-description">
- <p>Maximum number of databases to create</p>
- </div>
-
-
- <div class="method-subsection method-declaration"><code>@property (atomic, assign) NSUInteger maximumNumberOfDatabasesToCreate</code></div>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <div class="method-subsection declared-in-section">
- <h4 class="method-subtitle">Declared In</h4>
- <code class="declared-in-ref">FMDatabasePool.h</code><br />
- </div>
-
-
- </div>
-
- <div class="section-method">
- <a name="//api/name/openFlags" title="openFlags"></a>
- <h3 class="subsubtitle method-title">openFlags</h3>
-
-
-
- <div class="method-subsection brief-description">
- <p>Open flags</p>
- </div>
-
-
- <div class="method-subsection method-declaration"><code>@property (atomic, readonly) int openFlags</code></div>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <div class="method-subsection declared-in-section">
- <h4 class="method-subtitle">Declared In</h4>
- <code class="declared-in-ref">FMDatabasePool.h</code><br />
- </div>
-
-
- </div>
-
- <div class="section-method">
- <a name="//api/name/path" title="path"></a>
- <h3 class="subsubtitle method-title">path</h3>
-
-
-
- <div class="method-subsection brief-description">
- <p>Database path</p>
- </div>
-
-
- <div class="method-subsection method-declaration"><code>@property (atomic, retain) NSString *path</code></div>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <div class="method-subsection declared-in-section">
- <h4 class="method-subtitle">Declared In</h4>
- <code class="declared-in-ref">FMDatabasePool.h</code><br />
- </div>
-
-
- </div>
-
- </div>
-
-
-
- <div class="section section-methods">
- <a title="Class Methods" name="class_methods"></a>
- <h2 class="subtitle subtitle-methods">Class Methods</h2>
-
- <div class="section-method">
- <a name="//api/name/databasePoolWithPath:" title="databasePoolWithPath:"></a>
- <h3 class="subsubtitle method-title">databasePoolWithPath:</h3>
-
-
-
- <div class="method-subsection brief-description">
- <p>Create pool using path.</p>
- </div>
-
-
- <div class="method-subsection method-declaration"><code>+ (instancetype)databasePoolWithPath:(NSString *)<em>aPath</em></code></div>
-
-
- <div class="method-subsection arguments-section parameters">
- <h4 class="method-subtitle parameter-title">Parameters</h4>
-
- <dl class="argument-def parameter-def">
- <dt><em>aPath</em></dt>
- <dd><p>The file path of the database.</p></dd>
- </dl>
-
- </div>
-
-
-
- <div class="method-subsection return">
- <h4 class="method-subtitle parameter-title">Return Value</h4>
- <p>The <code>FMDatabasePool</code> object. <code>nil</code> on error.</p>
- </div>
-
-
-
-
-
-
-
-
-
-
-
- <div class="method-subsection declared-in-section">
- <h4 class="method-subtitle">Declared In</h4>
- <code class="declared-in-ref">FMDatabasePool.h</code><br />
- </div>
-
-
- </div>
-
- <div class="section-method">
- <a name="//api/name/databasePoolWithPath:flags:" title="databasePoolWithPath:flags:"></a>
- <h3 class="subsubtitle method-title">databasePoolWithPath:flags:</h3>
-
-
-
- <div class="method-subsection brief-description">
- <p>Create pool using path and specified flags</p>
- </div>
-
-
- <div class="method-subsection method-declaration"><code>+ (instancetype)databasePoolWithPath:(NSString *)<em>aPath</em> flags:(int)<em>openFlags</em></code></div>
-
-
- <div class="method-subsection arguments-section parameters">
- <h4 class="method-subtitle parameter-title">Parameters</h4>
-
- <dl class="argument-def parameter-def">
- <dt><em>aPath</em></dt>
- <dd><p>The file path of the database.</p></dd>
- </dl>
-
- <dl class="argument-def parameter-def">
- <dt><em>openFlags</em></dt>
- <dd><p>Flags passed to the openWithFlags method of the database</p></dd>
- </dl>
-
- </div>
-
-
-
- <div class="method-subsection return">
- <h4 class="method-subtitle parameter-title">Return Value</h4>
- <p>The <code>FMDatabasePool</code> object. <code>nil</code> on error.</p>
- </div>
-
-
-
-
-
-
-
-
-
-
-
- <div class="method-subsection declared-in-section">
- <h4 class="method-subtitle">Declared In</h4>
- <code class="declared-in-ref">FMDatabasePool.h</code><br />
- </div>
-
-
- </div>
-
- </div>
-
-
-
- <div class="section section-methods">
- <a title="Instance Methods" name="instance_methods"></a>
- <h2 class="subtitle subtitle-methods">Instance Methods</h2>
-
- <div class="section-method">
- <a name="//api/name/countOfCheckedInDatabases" title="countOfCheckedInDatabases"></a>
- <h3 class="subsubtitle method-title">countOfCheckedInDatabases</h3>
-
-
-
- <div class="method-subsection brief-description">
- <p>Number of checked-in databases in pool</p>
- </div>
-
-
- <div class="method-subsection method-declaration"><code>- (NSUInteger)countOfCheckedInDatabases</code></div>
-
-
-
-
- <div class="method-subsection return">
- <h4 class="method-subtitle parameter-title">Return Value</h4>
- <p>Number of databases</p>
- </div>
-
-
-
-
-
-
-
-
-
-
-
- <div class="method-subsection declared-in-section">
- <h4 class="method-subtitle">Declared In</h4>
- <code class="declared-in-ref">FMDatabasePool.h</code><br />
- </div>
-
-
- </div>
-
- <div class="section-method">
- <a name="//api/name/countOfCheckedOutDatabases" title="countOfCheckedOutDatabases"></a>
- <h3 class="subsubtitle method-title">countOfCheckedOutDatabases</h3>
-
-
-
- <div class="method-subsection brief-description">
- <p>Number of checked-out databases in pool</p>
- </div>
-
-
- <div class="method-subsection method-declaration"><code>- (NSUInteger)countOfCheckedOutDatabases</code></div>
-
-
-
-
- <div class="method-subsection return">
- <h4 class="method-subtitle parameter-title">Return Value</h4>
- <p>Number of databases</p>
- </div>
-
-
-
-
-
-
-
-
-
-
-
- <div class="method-subsection declared-in-section">
- <h4 class="method-subtitle">Declared In</h4>
- <code class="declared-in-ref">FMDatabasePool.h</code><br />
- </div>
-
-
- </div>
-
- <div class="section-method">
- <a name="//api/name/countOfOpenDatabases" title="countOfOpenDatabases"></a>
- <h3 class="subsubtitle method-title">countOfOpenDatabases</h3>
-
-
-
- <div class="method-subsection brief-description">
- <p>Total number of databases in pool</p>
- </div>
-
-
- <div class="method-subsection method-declaration"><code>- (NSUInteger)countOfOpenDatabases</code></div>
-
-
-
-
- <div class="method-subsection return">
- <h4 class="method-subtitle parameter-title">Return Value</h4>
- <p>Number of databases</p>
- </div>
-
-
-
-
-
-
-
-
-
-
-
- <div class="method-subsection declared-in-section">
- <h4 class="method-subtitle">Declared In</h4>
- <code class="declared-in-ref">FMDatabasePool.h</code><br />
- </div>
-
-
- </div>
-
- <div class="section-method">
- <a name="//api/name/inDatabase:" title="inDatabase:"></a>
- <h3 class="subsubtitle method-title">inDatabase:</h3>
-
-
-
- <div class="method-subsection brief-description">
- <p>Synchronously perform database operations in pool.</p>
- </div>
-
-
- <div class="method-subsection method-declaration"><code>- (void)inDatabase:(void ( ^ ) ( FMDatabase *db ))<em>block</em></code></div>
-
-
- <div class="method-subsection arguments-section parameters">
- <h4 class="method-subtitle parameter-title">Parameters</h4>
-
- <dl class="argument-def parameter-def">
- <dt><em>block</em></dt>
- <dd><p>The code to be run on the <code>FMDatabasePool</code> pool.</p></dd>
- </dl>
-
- </div>
-
-
-
-
-
-
-
-
-
-
-
-
-
- <div class="method-subsection declared-in-section">
- <h4 class="method-subtitle">Declared In</h4>
- <code class="declared-in-ref">FMDatabasePool.h</code><br />
- </div>
-
-
- </div>
-
- <div class="section-method">
- <a name="//api/name/inDeferredTransaction:" title="inDeferredTransaction:"></a>
- <h3 class="subsubtitle method-title">inDeferredTransaction:</h3>
-
-
-
- <div class="method-subsection brief-description">
- <p>Synchronously perform database operations in pool using deferred transaction.</p>
- </div>
-
-
- <div class="method-subsection method-declaration"><code>- (void)inDeferredTransaction:(void ( ^ ) ( FMDatabase *db , BOOL *rollback ))<em>block</em></code></div>
-
-
- <div class="method-subsection arguments-section parameters">
- <h4 class="method-subtitle parameter-title">Parameters</h4>
-
- <dl class="argument-def parameter-def">
- <dt><em>block</em></dt>
- <dd><p>The code to be run on the <code>FMDatabasePool</code> pool.</p></dd>
- </dl>
-
- </div>
-
-
-
-
-
-
-
-
-
-
-
-
-
- <div class="method-subsection declared-in-section">
- <h4 class="method-subtitle">Declared In</h4>
- <code class="declared-in-ref">FMDatabasePool.h</code><br />
- </div>
-
-
- </div>
-
- <div class="section-method">
- <a name="//api/name/inSavePoint:" title="inSavePoint:"></a>
- <h3 class="subsubtitle method-title">inSavePoint:</h3>
-
-
-
- <div class="method-subsection brief-description">
- <p>Synchronously perform database operations in pool using save point.</p>
- </div>
-
-
- <div class="method-subsection method-declaration"><code>- (NSError *)inSavePoint:(void ( ^ ) ( FMDatabase *db , BOOL *rollback ))<em>block</em></code></div>
-
-
- <div class="method-subsection arguments-section parameters">
- <h4 class="method-subtitle parameter-title">Parameters</h4>
-
- <dl class="argument-def parameter-def">
- <dt><em>block</em></dt>
- <dd><p>The code to be run on the <code>FMDatabasePool</code> pool.</p></dd>
- </dl>
-
- </div>
-
-
-
- <div class="method-subsection return">
- <h4 class="method-subtitle parameter-title">Return Value</h4>
- <p><code>NSError</code> object if error; <code>nil</code> if successful.</p>
- </div>
-
-
-
-
-
- <div class="method-subsection discussion-section">
- <h4 class="method-subtitle">Discussion</h4>
- <div class="warning"><p><strong>Warning:</strong> You can not nest these, since calling it will pull another database out of the pool and you’ll get a deadlock. If you need to nest, use <a href="../Classes/FMDatabase.html#//api/name/startSavePointWithName:error:"><code>[FMDatabase startSavePointWithName:error:]</code></a> instead.</p></div>
- </div>
-
-
-
-
-
-
-
- <div class="method-subsection declared-in-section">
- <h4 class="method-subtitle">Declared In</h4>
- <code class="declared-in-ref">FMDatabasePool.h</code><br />
- </div>
-
-
- </div>
-
- <div class="section-method">
- <a name="//api/name/inTransaction:" title="inTransaction:"></a>
- <h3 class="subsubtitle method-title">inTransaction:</h3>
-
-
-
- <div class="method-subsection brief-description">
- <p>Synchronously perform database operations in pool using transaction.</p>
- </div>
-
-
- <div class="method-subsection method-declaration"><code>- (void)inTransaction:(void ( ^ ) ( FMDatabase *db , BOOL *rollback ))<em>block</em></code></div>
-
-
- <div class="method-subsection arguments-section parameters">
- <h4 class="method-subtitle parameter-title">Parameters</h4>
-
- <dl class="argument-def parameter-def">
- <dt><em>block</em></dt>
- <dd><p>The code to be run on the <code>FMDatabasePool</code> pool.</p></dd>
- </dl>
-
- </div>
-
-
-
-
-
-
-
-
-
-
-
-
-
- <div class="method-subsection declared-in-section">
- <h4 class="method-subtitle">Declared In</h4>
- <code class="declared-in-ref">FMDatabasePool.h</code><br />
- </div>
-
-
- </div>
-
- <div class="section-method">
- <a name="//api/name/initWithPath:" title="initWithPath:"></a>
- <h3 class="subsubtitle method-title">initWithPath:</h3>
-
-
-
- <div class="method-subsection brief-description">
- <p>Create pool using path.</p>
- </div>
-
-
- <div class="method-subsection method-declaration"><code>- (instancetype)initWithPath:(NSString *)<em>aPath</em></code></div>
-
-
- <div class="method-subsection arguments-section parameters">
- <h4 class="method-subtitle parameter-title">Parameters</h4>
-
- <dl class="argument-def parameter-def">
- <dt><em>aPath</em></dt>
- <dd><p>The file path of the database.</p></dd>
- </dl>
-
- </div>
-
-
-
- <div class="method-subsection return">
- <h4 class="method-subtitle parameter-title">Return Value</h4>
- <p>The <code>FMDatabasePool</code> object. <code>nil</code> on error.</p>
- </div>
-
-
-
-
-
-
-
-
-
-
-
- <div class="method-subsection declared-in-section">
- <h4 class="method-subtitle">Declared In</h4>
- <code class="declared-in-ref">FMDatabasePool.h</code><br />
- </div>
-
-
- </div>
-
- <div class="section-method">
- <a name="//api/name/initWithPath:flags:" title="initWithPath:flags:"></a>
- <h3 class="subsubtitle method-title">initWithPath:flags:</h3>
-
-
-
- <div class="method-subsection brief-description">
- <p>Create pool using path and specified flags.</p>
- </div>
-
-
- <div class="method-subsection method-declaration"><code>- (instancetype)initWithPath:(NSString *)<em>aPath</em> flags:(int)<em>openFlags</em></code></div>
-
-
- <div class="method-subsection arguments-section parameters">
- <h4 class="method-subtitle parameter-title">Parameters</h4>
-
- <dl class="argument-def parameter-def">
- <dt><em>aPath</em></dt>
- <dd><p>The file path of the database.</p></dd>
- </dl>
-
- <dl class="argument-def parameter-def">
- <dt><em>openFlags</em></dt>
- <dd><p>Flags passed to the openWithFlags method of the database</p></dd>
- </dl>
-
- </div>
-
-
-
- <div class="method-subsection return">
- <h4 class="method-subtitle parameter-title">Return Value</h4>
- <p>The <code>FMDatabasePool</code> object. <code>nil</code> on error.</p>
- </div>
-
-
-
-
-
-
-
-
-
-
-
- <div class="method-subsection declared-in-section">
- <h4 class="method-subtitle">Declared In</h4>
- <code class="declared-in-ref">FMDatabasePool.h</code><br />
- </div>
-
-
- </div>
-
- <div class="section-method">
- <a name="//api/name/releaseAllDatabases" title="releaseAllDatabases"></a>
- <h3 class="subsubtitle method-title">releaseAllDatabases</h3>
-
-
-
- <div class="method-subsection brief-description">
- <p>Release all databases in pool</p>
- </div>
-
-
- <div class="method-subsection method-declaration"><code>- (void)releaseAllDatabases</code></div>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <div class="method-subsection declared-in-section">
- <h4 class="method-subtitle">Declared In</h4>
- <code class="declared-in-ref">FMDatabasePool.h</code><br />
- </div>
-
-
- </div>
-
- </div>
-
-
- </div>
- <div class="main-navigation navigation-bottom">
- <ul>
- <li><a href="../index.html">Index</a></li>
- <li><a href="../hierarchy.html">Hierarchy</a></li>
- </ul>
- </div>
- <div id="footer">
- <hr />
- <div class="footer-copyright">
- <p><span class="copyright">© 2014 ccgus. All rights reserved. (Last updated: 2014-05-25)</span><br />
-
- <span class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.1 (build 858)</a>.</span></p>
-
- </div>
- </div>
- </div>
- </article>
- <script type="text/javascript">
- function jumpToChange()
- {
- window.location.hash = this.options[this.selectedIndex].value;
- }
-
- function toggleTOC()
- {
- var contents = document.getElementById('contents');
- var tocContainer = document.getElementById('tocContainer');
-
- if (this.getAttribute('class') == 'open')
- {
- this.setAttribute('class', '');
- contents.setAttribute('class', '');
- tocContainer.setAttribute('class', '');
-
- window.name = "hideTOC";
- }
- else
- {
- this.setAttribute('class', 'open');
- contents.setAttribute('class', 'isShowingTOC');
- tocContainer.setAttribute('class', 'isShowingTOC');
-
- window.name = "";
- }
- return false;
- }
-
- function toggleTOCEntryChildren(e)
- {
- e.stopPropagation();
- var currentClass = this.getAttribute('class');
- if (currentClass == 'children') {
- this.setAttribute('class', 'children open');
- }
- else if (currentClass == 'children open') {
- this.setAttribute('class', 'children');
- }
- return false;
- }
-
- function tocEntryClick(e)
- {
- e.stopPropagation();
- return true;
- }
-
- function init()
- {
- var selectElement = document.getElementById('jumpTo');
- selectElement.addEventListener('change', jumpToChange, false);
-
- var tocButton = document.getElementById('table_of_contents');
- tocButton.addEventListener('click', toggleTOC, false);
-
- var taskTreeItem = document.getElementById('task_treeitem');
- if (taskTreeItem.getElementsByTagName('li').length > 0)
- {
- taskTreeItem.setAttribute('class', 'children');
- taskTreeItem.firstChild.setAttribute('class', 'disclosure');
- }
-
- var tocList = document.getElementById('toc');
-
- var tocEntries = tocList.getElementsByTagName('li');
- for (var i = 0; i < tocEntries.length; i++) {
- tocEntries[i].addEventListener('click', toggleTOCEntryChildren, false);
- }
-
- var tocLinks = tocList.getElementsByTagName('a');
- for (var i = 0; i < tocLinks.length; i++) {
- tocLinks[i].addEventListener('click', tocEntryClick, false);
- }
-
- if (window.name == "hideTOC") {
- toggleTOC.call(tocButton);
- }
- }
-
- window.onload = init;
-
- // If showing in Xcode, hide the TOC and Header
- if (navigator.userAgent.match(/xcode/i)) {
- document.getElementById("contents").className = "hideInXcode"
- document.getElementById("tocContainer").className = "hideInXcode"
- document.getElementById("top_header").className = "hideInXcode"
- }
-
- </script>
- </body>
- </html>
|