diff options
Diffstat (limited to 'html/docsets/FMDB.docset/Contents/Resources/Documents/Classes/FMDatabasePool.html')
| -rw-r--r-- | html/docsets/FMDB.docset/Contents/Resources/Documents/Classes/FMDatabasePool.html | 1467 |
1 files changed, 1467 insertions, 0 deletions
diff --git a/html/docsets/FMDB.docset/Contents/Resources/Documents/Classes/FMDatabasePool.html b/html/docsets/FMDB.docset/Contents/Resources/Documents/Classes/FMDatabasePool.html new file mode 100644 index 0000000..81dac6a --- /dev/null +++ b/html/docsets/FMDB.docset/Contents/Resources/Documents/Classes/FMDatabasePool.html @@ -0,0 +1,1467 @@ +<!DOCTYPE html> +<html lang="en"> + <head> + <title>FMDatabasePool Class Reference</title> + <link rel="stylesheet" type="text/css" href="../css/jazzy.css" /> + <link rel="stylesheet" type="text/css" href="../css/highlight.css" /> + <meta charset='utf-8'> + <script src="../js/jquery.min.js" defer></script> + <script src="../js/jazzy.js" defer></script> + + </head> + <body> + <a name="//apple_ref/objc/Class/FMDatabasePool" class="dashAnchor"></a> + <a title="FMDatabasePool Class Reference"></a> + <header> + <div class="content-wrapper"> + <p><a href="../index.html">FMDB 2.7.7 Docs</a> (89% documented)</p> + <p class="header-right"><a href="https://github.com/ccgus/fmdb"><img src="../img/gh.png"/>View on GitHub</a></p> + </div> + </header> + <div class="content-wrapper"> + <p id="breadcrumbs"> + <a href="../index.html">FMDB Reference</a> + <img id="carat" src="../img/carat.png" /> + FMDatabasePool Class Reference + </p> + </div> + <div class="content-wrapper"> + <nav class="sidebar"> + <ul class="nav-groups"> + <li class="nav-group-name"> + <a href="../Categories.html">Categories</a> + <ul class="nav-group-tasks"> + <li class="nav-group-task"> + <a href="../Categories/NSObject%28FMDatabasePoolDelegate%29.html">NSObject(FMDatabasePoolDelegate)</a> + </li> + </ul> + </li> + <li class="nav-group-name"> + <a href="../Classes.html">Classes</a> + <ul class="nav-group-tasks"> + <li class="nav-group-task"> + <a href="../Classes/FMDatabase.html">FMDatabase</a> + </li> + <li class="nav-group-task"> + <a href="../Classes/FMDatabasePool.html">FMDatabasePool</a> + </li> + <li class="nav-group-task"> + <a href="../Classes/FMDatabaseQueue.html">FMDatabaseQueue</a> + </li> + <li class="nav-group-task"> + <a href="../Classes/FMResultSet.html">FMResultSet</a> + </li> + <li class="nav-group-task"> + <a href="../Classes/FMStatement.html">FMStatement</a> + </li> + </ul> + </li> + <li class="nav-group-name"> + <a href="../Constants.html">Constants</a> + <ul class="nav-group-tasks"> + <li class="nav-group-task"> + <a href="../Constants.html#/c:@FMDBVersionNumber">FMDBVersionNumber</a> + </li> + <li class="nav-group-task"> + <a href="../Constants.html#/c:@FMDBVersionString">FMDBVersionString</a> + </li> + </ul> + </li> + <li class="nav-group-name"> + <a href="../Enums.html">Enumerations</a> + <ul class="nav-group-tasks"> + <li class="nav-group-task"> + <a href="../Enums/FMDBCheckpointMode.html">FMDBCheckpointMode</a> + </li> + <li class="nav-group-task"> + <a href="../Enums/SqliteValueType.html">SqliteValueType</a> + </li> + </ul> + </li> + <li class="nav-group-name"> + <a href="../Type%20Definitions.html">Type Definitions</a> + <ul class="nav-group-tasks"> + <li class="nav-group-task"> + <a href="../Type%20Definitions.html#/c:FMDatabase.h@T@FMDBExecuteStatementsCallbackBlock">FMDBExecuteStatementsCallbackBlock</a> + </li> + </ul> + </li> + </ul> + </nav> + <article class="main-content"> + <section> + <section class="section"> + <h1>FMDatabasePool</h1> + <div class="declaration"> + <div class="language"> + <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> + + </div> + </div> + <p>Pool of <code><a href="../Classes/FMDatabase.html">FMDatabase</a></code> objects.</p> + +<p>See also</p> + +<ul> +<li><code><a href="../Classes/FMDatabaseQueue.html">FMDatabaseQueue</a></code></li> +<li><p><code><a href="../Classes/FMDatabase.html">FMDatabase</a></code> </p></li> +</ul><div class="aside aside-warning"> + <p class="aside-title">Warning</p> + <p>Before using <code>FMDatabasePool</code> , please consider using <code><a href="../Classes/FMDatabaseQueue.html">FMDatabaseQueue</a></code> instead.</p> + +</div> + +<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> + + </section> + <section class="section task-group-section"> + <div class="task-group"> + <ul> + <li class="item"> + <div> + <code> + <a name="/c:objc(cs)FMDatabasePool(py)path"></a> + <a name="//apple_ref/objc/Property/path" class="dashAnchor"></a> + <a class="token" href="#/c:objc(cs)FMDatabasePool(py)path">path</a> + </code> + </div> + <div class="height-container"> + <div class="pointer-container"></div> + <section class="section"> + <div class="pointer"></div> + <div class="abstract"> + <p>Database path</p> + + </div> + <div class="declaration"> + <h4>Declaration</h4> + <div class="language"> + <p class="aside-title">Objective-C</p> + <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> + + </div> + <div class="language"> + <p class="aside-title">Swift</p> + <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> + + </div> + </div> + </section> + </div> + </li> + <li class="item"> + <div> + <code> + <a name="/c:objc(cs)FMDatabasePool(py)delegate"></a> + <a name="//apple_ref/objc/Property/delegate" class="dashAnchor"></a> + <a class="token" href="#/c:objc(cs)FMDatabasePool(py)delegate">delegate</a> + </code> + </div> + <div class="height-container"> + <div class="pointer-container"></div> + <section class="section"> + <div class="pointer"></div> + <div class="abstract"> + <p>Delegate object</p> + + </div> + <div class="declaration"> + <h4>Declaration</h4> + <div class="language"> + <p class="aside-title">Objective-C</p> + <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> + + </div> + <div class="language"> + <p class="aside-title">Swift</p> + <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> + + </div> + </div> + </section> + </div> + </li> + <li class="item"> + <div> + <code> + <a name="/c:objc(cs)FMDatabasePool(py)maximumNumberOfDatabasesToCreate"></a> + <a name="//apple_ref/objc/Property/maximumNumberOfDatabasesToCreate" class="dashAnchor"></a> + <a class="token" href="#/c:objc(cs)FMDatabasePool(py)maximumNumberOfDatabasesToCreate">maximumNumberOfDatabasesToCreate</a> + </code> + </div> + <div class="height-container"> + <div class="pointer-container"></div> + <section class="section"> + <div class="pointer"></div> + <div class="abstract"> + <p>Maximum number of databases to create</p> + + </div> + <div class="declaration"> + <h4>Declaration</h4> + <div class="language"> + <p class="aside-title">Objective-C</p> + <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> + + </div> + <div class="language"> + <p class="aside-title">Swift</p> + <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> + + </div> + </div> + </section> + </div> + </li> + <li class="item"> + <div> + <code> + <a name="/c:objc(cs)FMDatabasePool(py)openFlags"></a> + <a name="//apple_ref/objc/Property/openFlags" class="dashAnchor"></a> + <a class="token" href="#/c:objc(cs)FMDatabasePool(py)openFlags">openFlags</a> + </code> + </div> + <div class="height-container"> + <div class="pointer-container"></div> + <section class="section"> + <div class="pointer"></div> + <div class="abstract"> + <p>Open flags</p> + + </div> + <div class="declaration"> + <h4>Declaration</h4> + <div class="language"> + <p class="aside-title">Objective-C</p> + <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> + + </div> + <div class="language"> + <p class="aside-title">Swift</p> + <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> + + </div> + </div> + </section> + </div> + </li> + <li class="item"> + <div> + <code> + <a name="/c:objc(cs)FMDatabasePool(py)vfsName"></a> + <a name="//apple_ref/objc/Property/vfsName" class="dashAnchor"></a> + <a class="token" href="#/c:objc(cs)FMDatabasePool(py)vfsName">vfsName</a> + </code> + </div> + <div class="height-container"> + <div class="pointer-container"></div> + <section class="section"> + <div class="pointer"></div> + <div class="abstract"> + <p>Custom virtual file system name</p> + + </div> + <div class="declaration"> + <h4>Declaration</h4> + <div class="language"> + <p class="aside-title">Objective-C</p> + <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> + + </div> + <div class="language"> + <p class="aside-title">Swift</p> + <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> + + </div> + </div> + </section> + </div> + </li> + </ul> + </div> + <div class="task-group"> + <div class="task-name-container"> + <a name="/Initialization"></a> + <a name="//apple_ref/objc/Section/Initialization" class="dashAnchor"></a> + <div class="section-name-container"> + <a class="section-name-link" href="#/Initialization"></a> + <h3 class="section-name"><p>Initialization</p> +</h3> + </div> + </div> + <ul> + <li class="item"> + <div> + <code> + <a name="/c:objc(cs)FMDatabasePool(cm)databasePoolWithPath:"></a> + <a name="//apple_ref/objc/Method/+databasePoolWithPath:" class="dashAnchor"></a> + <a class="token" href="#/c:objc(cs)FMDatabasePool(cm)databasePoolWithPath:">+databasePoolWithPath:<wbr></a> + </code> + </div> + <div class="height-container"> + <div class="pointer-container"></div> + <section class="section"> + <div class="pointer"></div> + <div class="abstract"> + <p>Create pool using path.</p> + + </div> + <div class="declaration"> + <h4>Declaration</h4> + <div class="language"> + <p class="aside-title">Objective-C</p> + <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> + + </div> + </div> + <div> + <h4>Parameters</h4> + <table class="graybox"> + <tbody> + <tr> + <td> + <code> + <em>aPath</em> + </code> + </td> + <td> + <div> + <p>The file path of the database.</p> + </div> + </td> + </tr> + </tbody> + </table> + </div> + <div> + <h4>Return Value</h4> + <p>The <code>FMDatabasePool</code> object. <code>nil</code> on error.</p> + </div> + </section> + </div> + </li> + <li class="item"> + <div> + <code> + <a name="/c:objc(cs)FMDatabasePool(cm)databasePoolWithURL:"></a> + <a name="//apple_ref/objc/Method/+databasePoolWithURL:" class="dashAnchor"></a> + <a class="token" href="#/c:objc(cs)FMDatabasePool(cm)databasePoolWithURL:">+databasePoolWithURL:<wbr></a> + </code> + </div> + <div class="height-container"> + <div class="pointer-container"></div> + <section class="section"> + <div class="pointer"></div> + <div class="abstract"> + <p>Create pool using file URL.</p> + + </div> + <div class="declaration"> + <h4>Declaration</h4> + <div class="language"> + <p class="aside-title">Objective-C</p> + <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> + + </div> + </div> + <div> + <h4>Parameters</h4> + <table class="graybox"> + <tbody> + <tr> + <td> + <code> + <em>url</em> + </code> + </td> + <td> + <div> + <p>The file <code>NSURL</code> of the database.</p> + </div> + </td> + </tr> + </tbody> + </table> + </div> + <div> + <h4>Return Value</h4> + <p>The <code>FMDatabasePool</code> object. <code>nil</code> on error.</p> + </div> + </section> + </div> + </li> + <li class="item"> + <div> + <code> + <a name="/c:objc(cs)FMDatabasePool(cm)databasePoolWithPath:flags:"></a> + <a name="//apple_ref/objc/Method/+databasePoolWithPath:flags:" class="dashAnchor"></a> + <a class="token" href="#/c:objc(cs)FMDatabasePool(cm)databasePoolWithPath:flags:">+databasePoolWithPath:<wbr>flags:<wbr></a> + </code> + </div> + <div class="height-container"> + <div class="pointer-container"></div> + <section class="section"> + <div class="pointer"></div> + <div class="abstract"> + <p>Create pool using path and specified flags</p> + + </div> + <div class="declaration"> + <h4>Declaration</h4> + <div class="language"> + <p class="aside-title">Objective-C</p> + <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="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> + + </div> + </div> + <div> + <h4>Parameters</h4> + <table class="graybox"> + <tbody> + <tr> + <td> + <code> + <em>aPath</em> + </code> + </td> + <td> + <div> + <p>The file path of the database.</p> + </div> + </td> + </tr> + <tr> + <td> + <code> + <em>openFlags</em> + </code> + </td> + <td> + <div> + <p>Flags passed to the openWithFlags method of the database.</p> + </div> + </td> + </tr> + </tbody> + </table> + </div> + <div> + <h4>Return Value</h4> + <p>The <code>FMDatabasePool</code> object. <code>nil</code> on error.</p> + </div> + </section> + </div> + </li> + <li class="item"> + <div> + <code> + <a name="/c:objc(cs)FMDatabasePool(cm)databasePoolWithURL:flags:"></a> + <a name="//apple_ref/objc/Method/+databasePoolWithURL:flags:" class="dashAnchor"></a> + <a class="token" href="#/c:objc(cs)FMDatabasePool(cm)databasePoolWithURL:flags:">+databasePoolWithURL:<wbr>flags:<wbr></a> + </code> + </div> + <div class="height-container"> + <div class="pointer-container"></div> + <section class="section"> + <div class="pointer"></div> + <div class="abstract"> + <p>Create pool using file URL and specified flags</p> + + </div> + <div class="declaration"> + <h4>Declaration</h4> + <div class="language"> + <p class="aside-title">Objective-C</p> + <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="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> + + </div> + </div> + <div> + <h4>Parameters</h4> + <table class="graybox"> + <tbody> + <tr> + <td> + <code> + <em>url</em> + </code> + </td> + <td> + <div> + <p>The file <code>NSURL</code> of the database.</p> + </div> + </td> + </tr> + <tr> + <td> + <code> + <em>openFlags</em> + </code> + </td> + <td> + <div> + <p>Flags passed to the openWithFlags method of the database.</p> + </div> + </td> + </tr> + </tbody> + </table> + </div> + <div> + <h4>Return Value</h4> + <p>The <code>FMDatabasePool</code> object. <code>nil</code> on error.</p> + </div> + </section> + </div> + </li> + <li class="item"> + <div> + <code> + <a name="/c:objc(cs)FMDatabasePool(im)initWithPath:"></a> + <a name="//apple_ref/objc/Method/-initWithPath:" class="dashAnchor"></a> + <a class="token" href="#/c:objc(cs)FMDatabasePool(im)initWithPath:">-initWithPath:<wbr></a> + </code> + </div> + <div class="height-container"> + <div class="pointer-container"></div> + <section class="section"> + <div class="pointer"></div> + <div class="abstract"> + <p>Create pool using path.</p> + + </div> + <div class="declaration"> + <h4>Declaration</h4> + <div class="language"> + <p class="aside-title">Objective-C</p> + <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> + + </div> + <div class="language"> + <p class="aside-title">Swift</p> + <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> + + </div> + </div> + <div> + <h4>Parameters</h4> + <table class="graybox"> + <tbody> + <tr> + <td> + <code> + <em>aPath</em> + </code> + </td> + <td> + <div> + <p>The file path of the database.</p> + </div> + </td> + </tr> + </tbody> + </table> + </div> + <div> + <h4>Return Value</h4> + <p>The <code>FMDatabasePool</code> object. <code>nil</code> on error.</p> + </div> + </section> + </div> + </li> + <li class="item"> + <div> + <code> + <a name="/c:objc(cs)FMDatabasePool(im)initWithURL:"></a> + <a name="//apple_ref/objc/Method/-initWithURL:" class="dashAnchor"></a> + <a class="token" href="#/c:objc(cs)FMDatabasePool(im)initWithURL:">-initWithURL:<wbr></a> + </code> + </div> + <div class="height-container"> + <div class="pointer-container"></div> + <section class="section"> + <div class="pointer"></div> + <div class="abstract"> + <p>Create pool using file URL.</p> + + </div> + <div class="declaration"> + <h4>Declaration</h4> + <div class="language"> + <p class="aside-title">Objective-C</p> + <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> + + </div> + <div class="language"> + <p class="aside-title">Swift</p> + <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> + + </div> + </div> + <div> + <h4>Parameters</h4> + <table class="graybox"> + <tbody> + <tr> + <td> + <code> + <em>url</em> + </code> + </td> + <td> + <div> + <p>The file `NSURL of the database.</p> + </div> + </td> + </tr> + </tbody> + </table> + </div> + <div> + <h4>Return Value</h4> + <p>The <code>FMDatabasePool</code> object. <code>nil</code> on error.</p> + </div> + </section> + </div> + </li> + <li class="item"> + <div> + <code> + <a name="/c:objc(cs)FMDatabasePool(im)initWithPath:flags:"></a> + <a name="//apple_ref/objc/Method/-initWithPath:flags:" class="dashAnchor"></a> + <a class="token" href="#/c:objc(cs)FMDatabasePool(im)initWithPath:flags:">-initWithPath:<wbr>flags:<wbr></a> + </code> + </div> + <div class="height-container"> + <div class="pointer-container"></div> + <section class="section"> + <div class="pointer"></div> + <div class="abstract"> + <p>Create pool using path and specified flags.</p> + + </div> + <div class="declaration"> + <h4>Declaration</h4> + <div class="language"> + <p class="aside-title">Objective-C</p> + <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="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> + + </div> + <div class="language"> + <p class="aside-title">Swift</p> + <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> + + </div> + </div> + <div> + <h4>Parameters</h4> + <table class="graybox"> + <tbody> + <tr> + <td> + <code> + <em>aPath</em> + </code> + </td> + <td> + <div> + <p>The file path of the database.</p> + </div> + </td> + </tr> + <tr> + <td> + <code> + <em>openFlags</em> + </code> + </td> + <td> + <div> + <p>Flags passed to the openWithFlags method of the database</p> + </div> + </td> + </tr> + </tbody> + </table> + </div> + <div> + <h4>Return Value</h4> + <p>The <code>FMDatabasePool</code> object. <code>nil</code> on error.</p> + </div> + </section> + </div> + </li> + <li class="item"> + <div> + <code> + <a name="/c:objc(cs)FMDatabasePool(im)initWithURL:flags:"></a> + <a name="//apple_ref/objc/Method/-initWithURL:flags:" class="dashAnchor"></a> + <a class="token" href="#/c:objc(cs)FMDatabasePool(im)initWithURL:flags:">-initWithURL:<wbr>flags:<wbr></a> + </code> + </div> + <div class="height-container"> + <div class="pointer-container"></div> + <section class="section"> + <div class="pointer"></div> + <div class="abstract"> + <p>Create pool using file URL and specified flags.</p> + + </div> + <div class="declaration"> + <h4>Declaration</h4> + <div class="language"> + <p class="aside-title">Objective-C</p> + <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> + + </div> + <div class="language"> + <p class="aside-title">Swift</p> + <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> + + </div> + </div> + <div> + <h4>Parameters</h4> + <table class="graybox"> + <tbody> + <tr> + <td> + <code> + <em>url</em> + </code> + </td> + <td> + <div> + <p>The file <code>NSURL</code> of the database.</p> + </div> + </td> + </tr> + <tr> + <td> + <code> + <em>openFlags</em> + </code> + </td> + <td> + <div> + <p>Flags passed to the openWithFlags method of the database</p> + </div> + </td> + </tr> + </tbody> + </table> + </div> + <div> + <h4>Return Value</h4> + <p>The <code>FMDatabasePool</code> object. <code>nil</code> on error.</p> + </div> + </section> + </div> + </li> + <li class="item"> + <div> + <code> + <a name="/c:objc(cs)FMDatabasePool(im)initWithPath:flags:vfs:"></a> + <a name="//apple_ref/objc/Method/-initWithPath:flags:vfs:" class="dashAnchor"></a> + <a class="token" href="#/c:objc(cs)FMDatabasePool(im)initWithPath:flags:vfs:">-initWithPath:<wbr>flags:<wbr>vfs:<wbr></a> + </code> + </div> + <div class="height-container"> + <div class="pointer-container"></div> + <section class="section"> + <div class="pointer"></div> + <div class="abstract"> + <p>Create pool using path and specified flags.</p> + + </div> + <div class="declaration"> + <h4>Declaration</h4> + <div class="language"> + <p class="aside-title">Objective-C</p> + <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="nf">flags</span><span class="p">:(</span><span class="kt">int</span><span class="p">)</span><span class="nv">openFlags</span> + <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> + + </div> + <div class="language"> + <p class="aside-title">Swift</p> + <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> + + </div> + </div> + <div> + <h4>Parameters</h4> + <table class="graybox"> + <tbody> + <tr> + <td> + <code> + <em>aPath</em> + </code> + </td> + <td> + <div> + <p>The file path of the database.</p> + </div> + </td> + </tr> + <tr> + <td> + <code> + <em>openFlags</em> + </code> + </td> + <td> + <div> + <p>Flags passed to the openWithFlags method of the database</p> + </div> + </td> + </tr> + <tr> + <td> + <code> + <em>vfsName</em> + </code> + </td> + <td> + <div> + <p>The name of a custom virtual file system</p> + </div> + </td> + </tr> + </tbody> + </table> + </div> + <div> + <h4>Return Value</h4> + <p>The <code>FMDatabasePool</code> object. <code>nil</code> on error.</p> + </div> + </section> + </div> + </li> + <li class="item"> + <div> + <code> + <a name="/c:objc(cs)FMDatabasePool(im)initWithURL:flags:vfs:"></a> + <a name="//apple_ref/objc/Method/-initWithURL:flags:vfs:" class="dashAnchor"></a> + <a class="token" href="#/c:objc(cs)FMDatabasePool(im)initWithURL:flags:vfs:">-initWithURL:<wbr>flags:<wbr>vfs:<wbr></a> + </code> + </div> + <div class="height-container"> + <div class="pointer-container"></div> + <section class="section"> + <div class="pointer"></div> + <div class="abstract"> + <p>Create pool using file URL and specified flags.</p> + + </div> + <div class="declaration"> + <h4>Declaration</h4> + <div class="language"> + <p class="aside-title">Objective-C</p> + <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="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> + + </div> + <div class="language"> + <p class="aside-title">Swift</p> + <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> + + </div> + </div> + <div> + <h4>Parameters</h4> + <table class="graybox"> + <tbody> + <tr> + <td> + <code> + <em>url</em> + </code> + </td> + <td> + <div> + <p>The file <code>NSURL</code> of the database.</p> + </div> + </td> + </tr> + <tr> + <td> + <code> + <em>openFlags</em> + </code> + </td> + <td> + <div> + <p>Flags passed to the openWithFlags method of the database</p> + </div> + </td> + </tr> + <tr> + <td> + <code> + <em>vfsName</em> + </code> + </td> + <td> + <div> + <p>The name of a custom virtual file system</p> + </div> + </td> + </tr> + </tbody> + </table> + </div> + <div> + <h4>Return Value</h4> + <p>The <code>FMDatabasePool</code> object. <code>nil</code> on error.</p> + </div> + </section> + </div> + </li> + <li class="item"> + <div> + <code> + <a name="/c:objc(cs)FMDatabasePool(cm)databaseClass"></a> + <a name="//apple_ref/objc/Method/+databaseClass" class="dashAnchor"></a> + <a class="token" href="#/c:objc(cs)FMDatabasePool(cm)databaseClass">+databaseClass</a> + </code> + </div> + <div class="height-container"> + <div class="pointer-container"></div> + <section class="section"> + <div class="pointer"></div> + <div class="abstract"> + <p>Returns the Class of ‘FMDatabase’ subclass, that will be used to instantiate database object.</p> + +<p>Subclasses can override this method to return specified Class of ‘FMDatabase’ subclass.</p> + + </div> + <div class="declaration"> + <h4>Declaration</h4> + <div class="language"> + <p class="aside-title">Objective-C</p> + <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> + + </div> + <div class="language"> + <p class="aside-title">Swift</p> + <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">-></span> <span class="kt">AnyClass</span></code></pre> + + </div> + </div> + <div> + <h4>Return Value</h4> + <p>The Class of ‘FMDatabase’ subclass, that will be used to instantiate database object.</p> + </div> + </section> + </div> + </li> + </ul> + </div> + <div class="task-group"> + <div class="task-name-container"> + <a name="/Keeping%20track%20of%20checked%20in/out%20databases"></a> + <a name="//apple_ref/objc/Section/Keeping track of checked in/out databases" class="dashAnchor"></a> + <div class="section-name-container"> + <a class="section-name-link" href="#/Keeping%20track%20of%20checked%20in/out%20databases"></a> + <h3 class="section-name"><p>Keeping track of checked in/out databases</p> +</h3> + </div> + </div> + <ul> + <li class="item"> + <div> + <code> + <a name="/c:objc(cs)FMDatabasePool(py)countOfCheckedInDatabases"></a> + <a name="//apple_ref/objc/Property/countOfCheckedInDatabases" class="dashAnchor"></a> + <a class="token" href="#/c:objc(cs)FMDatabasePool(py)countOfCheckedInDatabases">countOfCheckedInDatabases</a> + </code> + </div> + <div class="height-container"> + <div class="pointer-container"></div> + <section class="section"> + <div class="pointer"></div> + <div class="abstract"> + <p>Number of checked-in databases in pool</p> + + </div> + <div class="declaration"> + <h4>Declaration</h4> + <div class="language"> + <p class="aside-title">Objective-C</p> + <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> + + </div> + <div class="language"> + <p class="aside-title">Swift</p> + <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> + + </div> + </div> + </section> + </div> + </li> + <li class="item"> + <div> + <code> + <a name="/c:objc(cs)FMDatabasePool(py)countOfCheckedOutDatabases"></a> + <a name="//apple_ref/objc/Property/countOfCheckedOutDatabases" class="dashAnchor"></a> + <a class="token" href="#/c:objc(cs)FMDatabasePool(py)countOfCheckedOutDatabases">countOfCheckedOutDatabases</a> + </code> + </div> + <div class="height-container"> + <div class="pointer-container"></div> + <section class="section"> + <div class="pointer"></div> + <div class="abstract"> + <p>Number of checked-out databases in pool</p> + + </div> + <div class="declaration"> + <h4>Declaration</h4> + <div class="language"> + <p class="aside-title">Objective-C</p> + <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> + + </div> + <div class="language"> + <p class="aside-title">Swift</p> + <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> + + </div> + </div> + </section> + </div> + </li> + <li class="item"> + <div> + <code> + <a name="/c:objc(cs)FMDatabasePool(py)countOfOpenDatabases"></a> + <a name="//apple_ref/objc/Property/countOfOpenDatabases" class="dashAnchor"></a> + <a class="token" href="#/c:objc(cs)FMDatabasePool(py)countOfOpenDatabases">countOfOpenDatabases</a> + </code> + </div> + <div class="height-container"> + <div class="pointer-container"></div> + <section class="section"> + <div class="pointer"></div> + <div class="abstract"> + <p>Total number of databases in pool</p> + + </div> + <div class="declaration"> + <h4>Declaration</h4> + <div class="language"> + <p class="aside-title">Objective-C</p> + <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> + + </div> + <div class="language"> + <p class="aside-title">Swift</p> + <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> + + </div> + </div> + </section> + </div> + </li> + <li class="item"> + <div> + <code> + <a name="/c:objc(cs)FMDatabasePool(im)releaseAllDatabases"></a> + <a name="//apple_ref/objc/Method/-releaseAllDatabases" class="dashAnchor"></a> + <a class="token" href="#/c:objc(cs)FMDatabasePool(im)releaseAllDatabases">-releaseAllDatabases</a> + </code> + </div> + <div class="height-container"> + <div class="pointer-container"></div> + <section class="section"> + <div class="pointer"></div> + <div class="abstract"> + <p>Release all databases in pool</p> + + </div> + <div class="declaration"> + <h4>Declaration</h4> + <div class="language"> + <p class="aside-title">Objective-C</p> + <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> + + </div> + <div class="language"> + <p class="aside-title">Swift</p> + <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">releaseAllDatabases</span><span class="p">()</span></code></pre> + + </div> + </div> + </section> + </div> + </li> + </ul> + </div> + <div class="task-group"> + <div class="task-name-container"> + <a name="/Perform%20database%20operations%20in%20pool"></a> + <a name="//apple_ref/objc/Section/Perform database operations in pool" class="dashAnchor"></a> + <div class="section-name-container"> + <a class="section-name-link" href="#/Perform%20database%20operations%20in%20pool"></a> + <h3 class="section-name"><p>Perform database operations in pool</p> +</h3> + </div> + </div> + <ul> + <li class="item"> + <div> + <code> + <a name="/c:objc(cs)FMDatabasePool(im)inDatabase:"></a> + <a name="//apple_ref/objc/Method/-inDatabase:" class="dashAnchor"></a> + <a class="token" href="#/c:objc(cs)FMDatabasePool(im)inDatabase:">-inDatabase:<wbr></a> + </code> + </div> + <div class="height-container"> + <div class="pointer-container"></div> + <section class="section"> + <div class="pointer"></div> + <div class="abstract"> + <p>Synchronously perform database operations in pool.</p> + + </div> + <div class="declaration"> + <h4>Declaration</h4> + <div class="language"> + <p class="aside-title">Objective-C</p> + <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> + + </div> + <div class="language"> + <p class="aside-title">Swift</p> + <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">-></span> <span class="kt">Void</span><span class="p">)</span></code></pre> + + </div> + </div> + <div> + <h4>Parameters</h4> + <table class="graybox"> + <tbody> + <tr> + <td> + <code> + <em>block</em> + </code> + </td> + <td> + <div> + <p>The code to be run on the <code>FMDatabasePool</code> pool.</p> + </div> + </td> + </tr> + </tbody> + </table> + </div> + </section> + </div> + </li> + <li class="item"> + <div> + <code> + <a name="/c:objc(cs)FMDatabasePool(im)inTransaction:"></a> + <a name="//apple_ref/objc/Method/-inTransaction:" class="dashAnchor"></a> + <a class="token" href="#/c:objc(cs)FMDatabasePool(im)inTransaction:">-inTransaction:<wbr></a> + </code> + </div> + <div class="height-container"> + <div class="pointer-container"></div> + <section class="section"> + <div class="pointer"></div> + <div class="abstract"> + <p>Synchronously perform database operations in pool using transaction.</p> +<div class="aside aside-warning"> + <p class="aside-title">Warning</p> + <p>Unlike SQLite’s <code>BEGIN TRANSACTION</code>, this method currently performs + an exclusive transaction, not a deferred transaction. This behavior + is likely to change in future versions of FMDB, whereby this method + will likely eventually adopt standard SQLite behavior and perform + deferred transactions. If you really need exclusive tranaction, it is + recommended that you use <code>inExclusiveTransaction</code>, instead, not only + to make your intent explicit, but also to future-proof your code.</p> + +</div> + + </div> + <div class="declaration"> + <h4>Declaration</h4> + <div class="language"> + <p class="aside-title">Objective-C</p> + <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> + <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> + + </div> + <div class="language"> + <p class="aside-title">Swift</p> + <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"><</span><span class="kt">ObjCBool</span><span class="o">></span><span class="p">)</span> <span class="o">-></span> <span class="kt">Void</span><span class="p">)</span></code></pre> + + </div> + </div> + <div> + <h4>Parameters</h4> + <table class="graybox"> + <tbody> + <tr> + <td> + <code> + <em>block</em> + </code> + </td> + <td> + <div> + <p>The code to be run on the <code>FMDatabasePool</code> pool.</p> + </div> + </td> + </tr> + </tbody> + </table> + </div> + </section> + </div> + </li> + <li class="item"> + <div> + <code> + <a name="/c:objc(cs)FMDatabasePool(im)inExclusiveTransaction:"></a> + <a name="//apple_ref/objc/Method/-inExclusiveTransaction:" class="dashAnchor"></a> + <a class="token" href="#/c:objc(cs)FMDatabasePool(im)inExclusiveTransaction:">-inExclusiveTransaction:<wbr></a> + </code> + </div> + <div class="height-container"> + <div class="pointer-container"></div> + <section class="section"> + <div class="pointer"></div> + <div class="abstract"> + <p>Synchronously perform database operations in pool using exclusive transaction.</p> + + </div> + <div class="declaration"> + <h4>Declaration</h4> + <div class="language"> + <p class="aside-title">Objective-C</p> + <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> + <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> + + </div> + <div class="language"> + <p class="aside-title">Swift</p> + <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"><</span><span class="kt">ObjCBool</span><span class="o">></span><span class="p">)</span> <span class="o">-></span> <span class="kt">Void</span><span class="p">)</span></code></pre> + + </div> + </div> + <div> + <h4>Parameters</h4> + <table class="graybox"> + <tbody> + <tr> + <td> + <code> + <em>block</em> + </code> + </td> + <td> + <div> + <p>The code to be run on the <code>FMDatabasePool</code> pool.</p> + </div> + </td> + </tr> + </tbody> + </table> + </div> + </section> + </div> + </li> + <li class="item"> + <div> + <code> + <a name="/c:objc(cs)FMDatabasePool(im)inDeferredTransaction:"></a> + <a name="//apple_ref/objc/Method/-inDeferredTransaction:" class="dashAnchor"></a> + <a class="token" href="#/c:objc(cs)FMDatabasePool(im)inDeferredTransaction:">-inDeferredTransaction:<wbr></a> + </code> + </div> + <div class="height-container"> + <div class="pointer-container"></div> + <section class="section"> + <div class="pointer"></div> + <div class="abstract"> + <p>Synchronously perform database operations in pool using deferred transaction.</p> + + </div> + <div class="declaration"> + <h4>Declaration</h4> + <div class="language"> + <p class="aside-title">Objective-C</p> + <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> + <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> + + </div> + <div class="language"> + <p class="aside-title">Swift</p> + <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"><</span><span class="kt">ObjCBool</span><span class="o">></span><span class="p">)</span> <span class="o">-></span> <span class="kt">Void</span><span class="p">)</span></code></pre> + + </div> + </div> + <div> + <h4>Parameters</h4> + <table class="graybox"> + <tbody> + <tr> + <td> + <code> + <em>block</em> + </code> + </td> + <td> + <div> + <p>The code to be run on the <code>FMDatabasePool</code> pool.</p> + </div> + </td> + </tr> + </tbody> + </table> + </div> + </section> + </div> + </li> + <li class="item"> + <div> + <code> + <a name="/c:objc(cs)FMDatabasePool(im)inImmediateTransaction:"></a> + <a name="//apple_ref/objc/Method/-inImmediateTransaction:" class="dashAnchor"></a> + <a class="token" href="#/c:objc(cs)FMDatabasePool(im)inImmediateTransaction:">-inImmediateTransaction:<wbr></a> + </code> + </div> + <div class="height-container"> + <div class="pointer-container"></div> + <section class="section"> + <div class="pointer"></div> + <div class="abstract"> + <p>Synchronously perform database operations on queue, using immediate transactions.</p> + + </div> + <div class="declaration"> + <h4>Declaration</h4> + <div class="language"> + <p class="aside-title">Objective-C</p> + <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> + <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> + + </div> + <div class="language"> + <p class="aside-title">Swift</p> + <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"><</span><span class="kt">ObjCBool</span><span class="o">></span><span class="p">)</span> <span class="o">-></span> <span class="kt">Void</span><span class="p">)</span></code></pre> + + </div> + </div> + <div> + <h4>Parameters</h4> + <table class="graybox"> + <tbody> + <tr> + <td> + <code> + <em>block</em> + </code> + </td> + <td> + <div> + <p>The code to be run on the queue of <code><a href="../Classes/FMDatabaseQueue.html">FMDatabaseQueue</a></code></p> + </div> + </td> + </tr> + </tbody> + </table> + </div> + </section> + </div> + </li> + <li class="item"> + <div> + <code> + <a name="/c:objc(cs)FMDatabasePool(im)inSavePoint:"></a> + <a name="//apple_ref/objc/Method/-inSavePoint:" class="dashAnchor"></a> + <a class="token" href="#/c:objc(cs)FMDatabasePool(im)inSavePoint:">-inSavePoint:<wbr></a> + </code> + </div> + <div class="height-container"> + <div class="pointer-container"></div> + <section class="section"> + <div class="pointer"></div> + <div class="abstract"> + <p>Synchronously perform database operations in pool using save point.</p> +<div class="aside aside-warning"> + <p class="aside-title">Warning</p> + <p>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 <code>startSavePointWithName:error:</code> instead.</p> + +</div> + + </div> + <div class="declaration"> + <h4>Declaration</h4> + <div class="language"> + <p class="aside-title">Objective-C</p> + <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> + <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> + + </div> + <div class="language"> + <p class="aside-title">Swift</p> + <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"><</span><span class="kt">ObjCBool</span><span class="o">></span><span class="p">)</span> <span class="o">-></span> <span class="kt">Void</span><span class="p">)</span> <span class="o">-></span> <span class="kt">Error</span><span class="p">?</span></code></pre> + + </div> + </div> + <div> + <h4>Parameters</h4> + <table class="graybox"> + <tbody> + <tr> + <td> + <code> + <em>block</em> + </code> + </td> + <td> + <div> + <p>The code to be run on the <code>FMDatabasePool</code> pool.</p> + </div> + </td> + </tr> + </tbody> + </table> + </div> + <div> + <h4>Return Value</h4> + <p><code>NSError</code> object if error; <code>nil</code> if successful.</p> + </div> + </section> + </div> + </li> + </ul> + </div> + </section> + </section> + <section id="footer"> + <p>© 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> + <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> + </section> + </article> + </div> + </body> +</div> +</html> |