diff options
Diffstat (limited to 'html/docsets/FMDB.docset/Contents/Resources/Documents/Classes/FMDatabaseQueue.html')
| -rw-r--r-- | html/docsets/FMDB.docset/Contents/Resources/Documents/Classes/FMDatabaseQueue.html | 1617 |
1 files changed, 1617 insertions, 0 deletions
diff --git a/html/docsets/FMDB.docset/Contents/Resources/Documents/Classes/FMDatabaseQueue.html b/html/docsets/FMDB.docset/Contents/Resources/Documents/Classes/FMDatabaseQueue.html new file mode 100644 index 0000000..72a5805 --- /dev/null +++ b/html/docsets/FMDB.docset/Contents/Resources/Documents/Classes/FMDatabaseQueue.html @@ -0,0 +1,1617 @@ +<!DOCTYPE html> +<html lang="en"> + <head> + <title>FMDatabaseQueue 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/FMDatabaseQueue" class="dashAnchor"></a> + <a title="FMDatabaseQueue 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" /> + FMDatabaseQueue 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>FMDatabaseQueue</h1> + <div class="declaration"> + <div class="language"> + <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">FMDatabaseQueue</span> <span class="p">:</span> <span class="nc">NSObject</span></code></pre> + + </div> + </div> + <p>To perform queries and updates on multiple threads, you’ll want to use <code>FMDatabaseQueue</code> .</p> + +<p>Using a single instance of <code><a href="../Classes/FMDatabase.html">FMDatabase</a></code> from multiple threads at once is a bad idea. It has always been OK to make a <code><a href="../Classes/FMDatabase.html">FMDatabase</a></code> object <em>per thread</em>. Just don’t share a single instance across threads, and definitely not across multiple threads at the same time.</p> + +<p>Instead, use <code>FMDatabaseQueue</code> . Here’s how to use it:</p> + +<p>First, make your queue.</p> +<pre class="highlight objective_c"><code><span class="n">FMDatabaseQueue</span> <span class="o">*</span><span class="n">queue</span> <span class="o">=</span> <span class="p">[</span><span class="n">FMDatabaseQueue</span> <span class="nf">databaseQueueWithPath</span><span class="p">:</span><span class="n">aPath</span><span class="p">];</span> +</code></pre> + +<p>Then use it like so:</p> +<pre class="highlight objective_c"><code><span class="p">[</span><span class="n">queue</span> <span class="nf">inDatabase</span><span class="p">:</span><span class="o">^</span><span class="p">(</span><span class="n">FMDatabase</span> <span class="o">*</span><span class="n">db</span><span class="p">)</span> <span class="p">{</span> + <span class="p">[</span><span class="n">db</span> <span class="nf">executeUpdate</span><span class="p">:</span><span class="s">@"INSERT INTO myTable VALUES (?)"</span><span class="p">,</span> <span class="p">[</span><span class="n">NSNumber</span> <span class="nf">numberWithInt</span><span class="p">:</span><span class="mi">1</span><span class="p">]];</span> + <span class="p">[</span><span class="n">db</span> <span class="nf">executeUpdate</span><span class="p">:</span><span class="s">@"INSERT INTO myTable VALUES (?)"</span><span class="p">,</span> <span class="p">[</span><span class="n">NSNumber</span> <span class="nf">numberWithInt</span><span class="p">:</span><span class="mi">2</span><span class="p">]];</span> + <span class="p">[</span><span class="n">db</span> <span class="nf">executeUpdate</span><span class="p">:</span><span class="s">@"INSERT INTO myTable VALUES (?)"</span><span class="p">,</span> <span class="p">[</span><span class="n">NSNumber</span> <span class="nf">numberWithInt</span><span class="p">:</span><span class="mi">3</span><span class="p">]];</span> + + <span class="n">FMResultSet</span> <span class="o">*</span><span class="n">rs</span> <span class="o">=</span> <span class="p">[</span><span class="n">db</span> <span class="nf">executeQuery</span><span class="p">:</span><span class="s">@"select * from foo"</span><span class="p">];</span> + <span class="k">while</span> <span class="p">([</span><span class="n">rs</span> <span class="nf">next</span><span class="p">])</span> <span class="p">{</span> + <span class="c1">//… +</span> <span class="p">}</span> +<span class="p">}];</span> +</code></pre> + +<p>An easy way to wrap things up in a transaction can be done like this:</p> +<pre class="highlight objective_c"><code><span class="p">[</span><span class="n">queue</span> <span class="nf">inTransaction</span><span class="p">:</span><span class="o">^</span><span class="p">(</span><span class="n">FMDatabase</span> <span class="o">*</span><span class="n">db</span><span class="p">,</span> <span class="n">BOOL</span> <span class="o">*</span><span class="n">rollback</span><span class="p">)</span> <span class="p">{</span> + <span class="p">[</span><span class="n">db</span> <span class="nf">executeUpdate</span><span class="p">:</span><span class="s">@"INSERT INTO myTable VALUES (?)"</span><span class="p">,</span> <span class="p">[</span><span class="n">NSNumber</span> <span class="nf">numberWithInt</span><span class="p">:</span><span class="mi">1</span><span class="p">]];</span> + <span class="p">[</span><span class="n">db</span> <span class="nf">executeUpdate</span><span class="p">:</span><span class="s">@"INSERT INTO myTable VALUES (?)"</span><span class="p">,</span> <span class="p">[</span><span class="n">NSNumber</span> <span class="nf">numberWithInt</span><span class="p">:</span><span class="mi">2</span><span class="p">]];</span> + <span class="p">[</span><span class="n">db</span> <span class="nf">executeUpdate</span><span class="p">:</span><span class="s">@"INSERT INTO myTable VALUES (?)"</span><span class="p">,</span> <span class="p">[</span><span class="n">NSNumber</span> <span class="nf">numberWithInt</span><span class="p">:</span><span class="mi">3</span><span class="p">]];</span> + + <span class="c1">// if (whoopsSomethingWrongHappened) { +</span> <span class="c1">// *rollback = YES; +</span> <span class="c1">// return; +</span> <span class="c1">// } +</span> + <span class="c1">// etc… +</span> <span class="p">[</span><span class="n">db</span> <span class="nf">executeUpdate</span><span class="p">:</span><span class="s">@"INSERT INTO myTable VALUES (?)"</span><span class="p">,</span> <span class="p">[</span><span class="n">NSNumber</span> <span class="nf">numberWithInt</span><span class="p">:</span><span class="mi">4</span><span class="p">]];</span> +<span class="p">}];</span> +</code></pre> + +<p><code>FMDatabaseQueue</code> will run the blocks on a serialized queue (hence the name of the class). So if you call <code>FMDatabaseQueue</code> ‘s methods from multiple threads at the same time, they will be executed in the order they are received. This way queries and updates won’t step on each other’s toes, and every one is happy.</p> +<div class="aside aside-warning"> + <p class="aside-title">Warning</p> + <p>Do not instantiate a single <code><a href="../Classes/FMDatabase.html">FMDatabase</a></code> object and use it across multiple threads. Use <code>FMDatabaseQueue</code> instead.</p> + +</div><div class="aside aside-warning"> + <p class="aside-title">Warning</p> + <p>The calls to <code>FMDatabaseQueue</code> ’s methods are blocking. So even though you are passing along blocks, they will <strong>not</strong> be run on another thread.</p> + +</div> + +<p>@sa FMDatabase</p> + + </section> + <section class="section task-group-section"> + <div class="task-group"> + <ul> + <li class="item"> + <div> + <code> + <a name="/c:objc(cs)FMDatabaseQueue(py)path"></a> + <a name="//apple_ref/objc/Property/path" class="dashAnchor"></a> + <a class="token" href="#/c:objc(cs)FMDatabaseQueue(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>Path of database</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">retain</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)FMDatabaseQueue(py)openFlags"></a> + <a name="//apple_ref/objc/Property/openFlags" class="dashAnchor"></a> + <a class="token" href="#/c:objc(cs)FMDatabaseQueue(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)FMDatabaseQueue(py)vfsName"></a> + <a name="//apple_ref/objc/Property/vfsName" class="dashAnchor"></a> + <a class="token" href="#/c:objc(cs)FMDatabaseQueue(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,%20opening,%20and%20closing%20of%20queue"></a> + <a name="//apple_ref/objc/Section/Initialization, opening, and closing of queue" class="dashAnchor"></a> + <div class="section-name-container"> + <a class="section-name-link" href="#/Initialization,%20opening,%20and%20closing%20of%20queue"></a> + <h3 class="section-name"><p>Initialization, opening, and closing of queue</p> +</h3> + </div> + </div> + <ul> + <li class="item"> + <div> + <code> + <a name="/c:objc(cs)FMDatabaseQueue(cm)databaseQueueWithPath:"></a> + <a name="//apple_ref/objc/Method/+databaseQueueWithPath:" class="dashAnchor"></a> + <a class="token" href="#/c:objc(cs)FMDatabaseQueue(cm)databaseQueueWithPath:">+databaseQueueWithPath:<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 queue 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">nullable</span> <span class="n">instancetype</span><span class="p">)</span><span class="nf">databaseQueueWithPath</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>FMDatabaseQueue</code> object. <code>nil</code> on error.</p> + </div> + </section> + </div> + </li> + <li class="item"> + <div> + <code> + <a name="/c:objc(cs)FMDatabaseQueue(cm)databaseQueueWithURL:"></a> + <a name="//apple_ref/objc/Method/+databaseQueueWithURL:" class="dashAnchor"></a> + <a class="token" href="#/c:objc(cs)FMDatabaseQueue(cm)databaseQueueWithURL:">+databaseQueueWithURL:<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 queue 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">nullable</span> <span class="n">instancetype</span><span class="p">)</span><span class="nf">databaseQueueWithURL</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>FMDatabaseQueue</code> object. <code>nil</code> on error.</p> + </div> + </section> + </div> + </li> + <li class="item"> + <div> + <code> + <a name="/c:objc(cs)FMDatabaseQueue(cm)databaseQueueWithPath:flags:"></a> + <a name="//apple_ref/objc/Method/+databaseQueueWithPath:flags:" class="dashAnchor"></a> + <a class="token" href="#/c:objc(cs)FMDatabaseQueue(cm)databaseQueueWithPath:flags:">+databaseQueueWithPath:<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 queue 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">nullable</span> <span class="n">instancetype</span><span class="p">)</span><span class="nf">databaseQueueWithPath</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>FMDatabaseQueue</code> object. <code>nil</code> on error.</p> + </div> + </section> + </div> + </li> + <li class="item"> + <div> + <code> + <a name="/c:objc(cs)FMDatabaseQueue(cm)databaseQueueWithURL:flags:"></a> + <a name="//apple_ref/objc/Method/+databaseQueueWithURL:flags:" class="dashAnchor"></a> + <a class="token" href="#/c:objc(cs)FMDatabaseQueue(cm)databaseQueueWithURL:flags:">+databaseQueueWithURL:<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 queue 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">nullable</span> <span class="n">instancetype</span><span class="p">)</span><span class="nf">databaseQueueWithURL</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>FMDatabaseQueue</code> object. <code>nil</code> on error.</p> + </div> + </section> + </div> + </li> + <li class="item"> + <div> + <code> + <a name="/c:objc(cs)FMDatabaseQueue(im)initWithPath:"></a> + <a name="//apple_ref/objc/Method/-initWithPath:" class="dashAnchor"></a> + <a class="token" href="#/c:objc(cs)FMDatabaseQueue(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 queue 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">nullable</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/FMDatabaseQueue.html#/c:objc(cs)FMDatabaseQueue(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>FMDatabaseQueue</code> object. <code>nil</code> on error.</p> + </div> + </section> + </div> + </li> + <li class="item"> + <div> + <code> + <a name="/c:objc(cs)FMDatabaseQueue(im)initWithURL:"></a> + <a name="//apple_ref/objc/Method/-initWithURL:" class="dashAnchor"></a> + <a class="token" href="#/c:objc(cs)FMDatabaseQueue(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 queue 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">nullable</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>FMDatabaseQueue</code> object. <code>nil</code> on error.</p> + </div> + </section> + </div> + </li> + <li class="item"> + <div> + <code> + <a name="/c:objc(cs)FMDatabaseQueue(im)initWithPath:flags:"></a> + <a name="//apple_ref/objc/Method/-initWithPath:flags:" class="dashAnchor"></a> + <a class="token" href="#/c:objc(cs)FMDatabaseQueue(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 queue 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">nullable</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/FMDatabaseQueue.html#/c:objc(cs)FMDatabaseQueue(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>FMDatabaseQueue</code> object. <code>nil</code> on error.</p> + </div> + </section> + </div> + </li> + <li class="item"> + <div> + <code> + <a name="/c:objc(cs)FMDatabaseQueue(im)initWithURL:flags:"></a> + <a name="//apple_ref/objc/Method/-initWithURL:flags:" class="dashAnchor"></a> + <a class="token" href="#/c:objc(cs)FMDatabaseQueue(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 queue 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">nullable</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 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>FMDatabaseQueue</code> object. <code>nil</code> on error.</p> + </div> + </section> + </div> + </li> + <li class="item"> + <div> + <code> + <a name="/c:objc(cs)FMDatabaseQueue(im)initWithPath:flags:vfs:"></a> + <a name="//apple_ref/objc/Method/-initWithPath:flags:vfs:" class="dashAnchor"></a> + <a class="token" href="#/c:objc(cs)FMDatabaseQueue(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 queue 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">nullable</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/FMDatabaseQueue.html#/c:objc(cs)FMDatabaseQueue(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>FMDatabaseQueue</code> object. <code>nil</code> on error.</p> + </div> + </section> + </div> + </li> + <li class="item"> + <div> + <code> + <a name="/c:objc(cs)FMDatabaseQueue(im)initWithURL:flags:vfs:"></a> + <a name="//apple_ref/objc/Method/-initWithURL:flags:vfs:" class="dashAnchor"></a> + <a class="token" href="#/c:objc(cs)FMDatabaseQueue(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 queue 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">nullable</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 `NSURL 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>FMDatabaseQueue</code> object. <code>nil</code> on error.</p> + </div> + </section> + </div> + </li> + <li class="item"> + <div> + <code> + <a name="/c:objc(cs)FMDatabaseQueue(cm)databaseClass"></a> + <a name="//apple_ref/objc/Method/+databaseClass" class="dashAnchor"></a> + <a class="token" href="#/c:objc(cs)FMDatabaseQueue(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> + <li class="item"> + <div> + <code> + <a name="/c:objc(cs)FMDatabaseQueue(im)close"></a> + <a name="//apple_ref/objc/Method/-close" class="dashAnchor"></a> + <a class="token" href="#/c:objc(cs)FMDatabaseQueue(im)close">-close</a> + </code> + </div> + <div class="height-container"> + <div class="pointer-container"></div> + <section class="section"> + <div class="pointer"></div> + <div class="abstract"> + <p>Close database used by queue.</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">close</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">close</span><span class="p">()</span></code></pre> + + </div> + </div> + </section> + </div> + </li> + <li class="item"> + <div> + <code> + <a name="/c:objc(cs)FMDatabaseQueue(im)interrupt"></a> + <a name="//apple_ref/objc/Method/-interrupt" class="dashAnchor"></a> + <a class="token" href="#/c:objc(cs)FMDatabaseQueue(im)interrupt">-interrupt</a> + </code> + </div> + <div class="height-container"> + <div class="pointer-container"></div> + <section class="section"> + <div class="pointer"></div> + <div class="abstract"> + <p>Interupt pending database operation.</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">interrupt</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">interrupt</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="/Dispatching%20database%20operations%20to%20queue"></a> + <a name="//apple_ref/objc/Section/Dispatching database operations to queue" class="dashAnchor"></a> + <div class="section-name-container"> + <a class="section-name-link" href="#/Dispatching%20database%20operations%20to%20queue"></a> + <h3 class="section-name"><p>Dispatching database operations to queue</p> +</h3> + </div> + </div> + <ul> + <li class="item"> + <div> + <code> + <a name="/c:objc(cs)FMDatabaseQueue(im)inDatabase:"></a> + <a name="//apple_ref/objc/Method/-inDatabase:" class="dashAnchor"></a> + <a class="token" href="#/c:objc(cs)FMDatabaseQueue(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 on queue.</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 queue of <code>FMDatabaseQueue</code></p> + </div> + </td> + </tr> + </tbody> + </table> + </div> + </section> + </div> + </li> + <li class="item"> + <div> + <code> + <a name="/c:objc(cs)FMDatabaseQueue(im)inTransaction:"></a> + <a name="//apple_ref/objc/Method/-inTransaction:" class="dashAnchor"></a> + <a class="token" href="#/c:objc(cs)FMDatabaseQueue(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 on queue, using transactions.</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 queue of <code>FMDatabaseQueue</code> </p> + </div> + </td> + </tr> + </tbody> + </table> + </div> + </section> + </div> + </li> + <li class="item"> + <div> + <code> + <a name="/c:objc(cs)FMDatabaseQueue(im)inDeferredTransaction:"></a> + <a name="//apple_ref/objc/Method/-inDeferredTransaction:" class="dashAnchor"></a> + <a class="token" href="#/c:objc(cs)FMDatabaseQueue(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 on queue, using deferred 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">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 queue of <code>FMDatabaseQueue</code></p> + </div> + </td> + </tr> + </tbody> + </table> + </div> + </section> + </div> + </li> + <li class="item"> + <div> + <code> + <a name="/c:objc(cs)FMDatabaseQueue(im)inExclusiveTransaction:"></a> + <a name="//apple_ref/objc/Method/-inExclusiveTransaction:" class="dashAnchor"></a> + <a class="token" href="#/c:objc(cs)FMDatabaseQueue(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 on queue, using exclusive 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">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 queue of <code>FMDatabaseQueue</code></p> + </div> + </td> + </tr> + </tbody> + </table> + </div> + </section> + </div> + </li> + <li class="item"> + <div> + <code> + <a name="/c:objc(cs)FMDatabaseQueue(im)inImmediateTransaction:"></a> + <a name="//apple_ref/objc/Method/-inImmediateTransaction:" class="dashAnchor"></a> + <a class="token" href="#/c:objc(cs)FMDatabaseQueue(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>FMDatabaseQueue</code></p> + </div> + </td> + </tr> + </tbody> + </table> + </div> + </section> + </div> + </li> + <li class="item"> + <div> + <code> + <a name="/c:objc(cs)FMDatabaseQueue(im)inSavePoint:"></a> + <a name="//apple_ref/objc/Method/-inSavePoint:" class="dashAnchor"></a> + <a class="token" href="#/c:objc(cs)FMDatabaseQueue(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 using save point.</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">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 queue of <code>FMDatabaseQueue</code></p> + </div> + </td> + </tr> + </tbody> + </table> + </div> + </section> + </div> + </li> + </ul> + </div> + <div class="task-group"> + <div class="task-name-container"> + <a name="/Checkpoint"></a> + <a name="//apple_ref/objc/Section/Checkpoint" class="dashAnchor"></a> + <div class="section-name-container"> + <a class="section-name-link" href="#/Checkpoint"></a> + <h3 class="section-name"><p>Checkpoint</p> +</h3> + </div> + </div> + <ul> + <li class="item"> + <div> + <code> + <a name="/c:objc(cs)FMDatabaseQueue(im)checkpoint:error:"></a> + <a name="//apple_ref/objc/Method/-checkpoint:error:" class="dashAnchor"></a> + <a class="token" href="#/c:objc(cs)FMDatabaseQueue(im)checkpoint:error:">-checkpoint:<wbr>error:<wbr></a> + </code> + </div> + <div class="height-container"> + <div class="pointer-container"></div> + <section class="section"> + <div class="pointer"></div> + <div class="abstract"> + <p>Performs a WAL checkpoint</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">BOOL</span><span class="p">)</span><span class="nf">checkpoint</span><span class="p">:(</span><span class="n"><a href="../Enums/FMDBCheckpointMode.html">FMDBCheckpointMode</a></span><span class="p">)</span><span class="nv">checkpointMode</span> + <span class="nf">error</span><span class="p">:(</span><span class="n">NSError</span> <span class="o">*</span><span class="n">_Nullable</span> <span class="o">*</span><span class="n">_Nullable</span><span class="p">)</span><span class="nv">error</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">checkpoint</span><span class="p">(</span><span class="n">_</span> <span class="nv">checkpointMode</span><span class="p">:</span> <span class="kt"><a href="../Enums/FMDBCheckpointMode.html">FMDBCheckpointMode</a></span><span class="p">)</span> <span class="k">throws</span></code></pre> + + </div> + </div> + <div> + <h4>Parameters</h4> + <table class="graybox"> + <tbody> + <tr> + <td> + <code> + <em>checkpointMode</em> + </code> + </td> + <td> + <div> + <p>The checkpoint mode for sqlite3_wal_checkpoint_v2</p> + </div> + </td> + </tr> + <tr> + <td> + <code> + <em>error</em> + </code> + </td> + <td> + <div> + <p>The NSError corresponding to the error, if any.</p> + </div> + </td> + </tr> + </tbody> + </table> + </div> + <div> + <h4>Return Value</h4> + <p>YES on success, otherwise NO.</p> + </div> + </section> + </div> + </li> + <li class="item"> + <div> + <code> + <a name="/c:objc(cs)FMDatabaseQueue(im)checkpoint:name:error:"></a> + <a name="//apple_ref/objc/Method/-checkpoint:name:error:" class="dashAnchor"></a> + <a class="token" href="#/c:objc(cs)FMDatabaseQueue(im)checkpoint:name:error:">-checkpoint:<wbr>name:<wbr>error:<wbr></a> + </code> + </div> + <div class="height-container"> + <div class="pointer-container"></div> + <section class="section"> + <div class="pointer"></div> + <div class="abstract"> + <p>Performs a WAL checkpoint</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">BOOL</span><span class="p">)</span><span class="nf">checkpoint</span><span class="p">:(</span><span class="n"><a href="../Enums/FMDBCheckpointMode.html">FMDBCheckpointMode</a></span><span class="p">)</span><span class="nv">checkpointMode</span> + <span class="nf">name</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">name</span> + <span class="nf">error</span><span class="p">:(</span><span class="n">NSError</span> <span class="o">*</span><span class="n">_Nullable</span> <span class="o">*</span><span class="n">_Nullable</span><span class="p">)</span><span class="nv">error</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">checkpoint</span><span class="p">(</span><span class="n">_</span> <span class="nv">checkpointMode</span><span class="p">:</span> <span class="kt"><a href="../Enums/FMDBCheckpointMode.html">FMDBCheckpointMode</a></span><span class="p">,</span> <span class="nv">name</span><span class="p">:</span> <span class="kt">String</span><span class="p">?)</span> <span class="k">throws</span></code></pre> + + </div> + </div> + <div> + <h4>Parameters</h4> + <table class="graybox"> + <tbody> + <tr> + <td> + <code> + <em>checkpointMode</em> + </code> + </td> + <td> + <div> + <p>The checkpoint mode for sqlite3_wal_checkpoint_v2</p> + </div> + </td> + </tr> + <tr> + <td> + <code> + <em>name</em> + </code> + </td> + <td> + <div> + <p>The db name for sqlite3_wal_checkpoint_v2</p> + </div> + </td> + </tr> + <tr> + <td> + <code> + <em>error</em> + </code> + </td> + <td> + <div> + <p>The NSError corresponding to the error, if any.</p> + </div> + </td> + </tr> + </tbody> + </table> + </div> + <div> + <h4>Return Value</h4> + <p>YES on success, otherwise NO.</p> + </div> + </section> + </div> + </li> + <li class="item"> + <div> + <code> + <a name="/c:objc(cs)FMDatabaseQueue(im)checkpoint:name:logFrameCount:checkpointCount:error:"></a> + <a name="//apple_ref/objc/Method/-checkpoint:name:logFrameCount:checkpointCount:error:" class="dashAnchor"></a> + <a class="token" href="#/c:objc(cs)FMDatabaseQueue(im)checkpoint:name:logFrameCount:checkpointCount:error:">-checkpoint:<wbr>name:<wbr>logFrameCount:<wbr>checkpointCount:<wbr>error:<wbr></a> + </code> + </div> + <div class="height-container"> + <div class="pointer-container"></div> + <section class="section"> + <div class="pointer"></div> + <div class="abstract"> + <p>Performs a WAL checkpoint</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">BOOL</span><span class="p">)</span><span class="nf">checkpoint</span><span class="p">:(</span><span class="n"><a href="../Enums/FMDBCheckpointMode.html">FMDBCheckpointMode</a></span><span class="p">)</span><span class="nv">checkpointMode</span> + <span class="nf">name</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">name</span> + <span class="nf">logFrameCount</span><span class="p">:(</span><span class="kt">int</span> <span class="o">*</span><span class="n">_Nullable</span><span class="p">)</span><span class="nv">logFrameCount</span> + <span class="nf">checkpointCount</span><span class="p">:(</span><span class="kt">int</span> <span class="o">*</span><span class="n">_Nullable</span><span class="p">)</span><span class="nv">checkpointCount</span> + <span class="nf">error</span><span class="p">:(</span><span class="n">NSError</span> <span class="o">*</span><span class="n">_Nullable</span> <span class="o">*</span><span class="n">_Nullable</span><span class="p">)</span><span class="nv">error</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">checkpoint</span><span class="p">(</span><span class="n">_</span> <span class="nv">checkpointMode</span><span class="p">:</span> <span class="kt"><a href="../Enums/FMDBCheckpointMode.html">FMDBCheckpointMode</a></span><span class="p">,</span> <span class="nv">name</span><span class="p">:</span> <span class="kt">String</span><span class="p">?,</span> <span class="nv">logFrameCount</span><span class="p">:</span> <span class="kt">UnsafeMutablePointer</span><span class="o"><</span><span class="kt">Int32</span><span class="o">></span><span class="p">?,</span> <span class="nv">checkpointCount</span><span class="p">:</span> <span class="kt">UnsafeMutablePointer</span><span class="o"><</span><span class="kt">Int32</span><span class="o">></span><span class="p">?)</span> <span class="k">throws</span></code></pre> + + </div> + </div> + <div> + <h4>Parameters</h4> + <table class="graybox"> + <tbody> + <tr> + <td> + <code> + <em>checkpointMode</em> + </code> + </td> + <td> + <div> + <p>The checkpoint mode for sqlite3_wal_checkpoint_v2</p> + </div> + </td> + </tr> + <tr> + <td> + <code> + <em>name</em> + </code> + </td> + <td> + <div> + <p>The db name for sqlite3_wal_checkpoint_v2</p> + </div> + </td> + </tr> + <tr> + <td> + <code> + <em>error</em> + </code> + </td> + <td> + <div> + <p>The NSError corresponding to the error, if any.</p> + </div> + </td> + </tr> + <tr> + <td> + <code> + <em>logFrameCount</em> + </code> + </td> + <td> + <div> + <p>If not NULL, then this is set to the total number of frames in the log file or to -1 if the checkpoint could not run because of an error or because the database is not in WAL mode.</p> + </div> + </td> + </tr> + <tr> + <td> + <code> + <em>checkpointCount</em> + </code> + </td> + <td> + <div> + <p>If not NULL, then this is set to the total number of checkpointed frames in the log file (including any that were already checkpointed before the function was called) or to -1 if the checkpoint could not run due to an error or because the database is not in WAL mode.</p> + </div> + </td> + </tr> + </tbody> + </table> + </div> + <div> + <h4>Return Value</h4> + <p>YES on success, otherwise NO.</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> |