Deploying to gh-pages from @ bc12d1cf04 🚀

manual.html

@@ -189,6 +189,8 @@ Concepts and Configuration
 </td></tr>
 <tr><td align="left" valign="top">&bull; <a href="#Org_002droam-Faces">Org-roam Faces</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
 </td></tr>
+<tr><td align="left" valign="top">&bull; <a href="#The-Database">The Database</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
+</td></tr>
 <tr><th colspan="3" align="left" valign="top"><pre class="menu-comment">
 
 Navigating Around
@@ -1072,6 +1074,8 @@ org-roam</code>.
 </td></tr>
 <tr><td align="left" valign="top">&bull; <a href="#Org_002droam-Faces" accesskey="4">Org-roam Faces</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
 </td></tr>
+<tr><td align="left" valign="top">&bull; <a href="#The-Database" accesskey="5">The Database</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
+</td></tr>
 </table>
 
 <hr>
@@ -1173,7 +1177,7 @@ system. The templating system is customizable (see <a href="#The-Templating-Syst
 <a name="Org_002droam-Faces"></a>
 <div class="header">
 <p>
-Previous: <a href="#Org_002droam-Files" accesskey="p" rel="prev">Org-roam Files</a>, Up: <a href="#Concepts-and-Configuration" accesskey="u" rel="up">Concepts and Configuration</a> &nbsp; [<a href="#Keystroke-Index" title="Index" rel="index">Index</a>]</p>
+Next: <a href="#The-Database" accesskey="n" rel="next">The Database</a>, Previous: <a href="#Org_002droam-Files" accesskey="p" rel="prev">Org-roam Files</a>, Up: <a href="#Concepts-and-Configuration" accesskey="u" rel="up">Concepts and Configuration</a> &nbsp; [<a href="#Keystroke-Index" title="Index" rel="index">Index</a>]</p>
 </div>
 <a name="Org_002droam-Faces-1"></a>
 <h3 class="section">8.4 Org-roam Faces</h3>
@@ -1197,6 +1201,35 @@ This distinguishes internal links from external links (e.g. external web links).
 <p>The <code>org-roam-link-invalid</code> face is applied to links that are broken. These are
 links to files or IDs that cannot be found.
 </p>
+<hr>
+<a name="The-Database"></a>
+<div class="header">
+<p>
+Previous: <a href="#Org_002droam-Faces" accesskey="p" rel="prev">Org-roam Faces</a>, Up: <a href="#Concepts-and-Configuration" accesskey="u" rel="up">Concepts and Configuration</a> &nbsp; [<a href="#Keystroke-Index" title="Index" rel="index">Index</a>]</p>
+</div>
+<a name="TODO-The-Database"></a>
+<h3 class="section">8.5 <strong>TODO</strong> The Database</h3>
+
+<p>Org-roam is backed by a Sqlite database.
+</p>
+<dl>
+<dt><a name="index-org_002droam_002ddb_002dupdate_002dmethod"></a>User Option: <strong>org-roam-db-update-method</strong></dt>
+<dd>
+<p>Method to update the Org-roam database.
+</p>
+<p><code>'immediate</code>: Update the database immediately upon file changes.
+</p>
+<p><code>'idle-timer</code>: Updates the database if dirty, if Emacs idles for
+<code>org-roam-db-update-idle-seconds</code>.
+</p></dd></dl>
+
+<dl>
+<dt><a name="index-org_002droam_002ddb_002dupdate_002didle_002dseconds"></a>User Option: <strong>org-roam-db-update-idle-seconds</strong></dt>
+<dd>
+<p>Number of idle seconds before triggering an Org-roam database update. This is
+only valid if <code>org-roam-db-update-method</code> is <code>'idle-timer</code>.
+</p></dd></dl>
+
 <hr>
 <a name="Inserting-Links"></a>
 <div class="header">
@@ -2510,6 +2543,8 @@ Previous: <a href="#Function-Index" accesskey="p" rel="prev">Function Index</a>,
 <tr><td></td><td valign="top"><a href="#index-org_002droam_002ddailies_002dcapture_002dtemplates"><code><code>org-roam-dailies-capture-templates</code></code></a>:</td><td>&nbsp;</td><td valign="top"><a href="#Configuration">Configuration</a></td></tr>
 <tr><td></td><td valign="top"><a href="#index-org_002droam_002ddailies_002ddirectory"><code><code>org-roam-dailies-directory</code></code></a>:</td><td>&nbsp;</td><td valign="top"><a href="#Configuration">Configuration</a></td></tr>
 <tr><td></td><td valign="top"><a href="#index-org_002droam_002ddb_002dlocation"><code>org-roam-db-location</code></a>:</td><td>&nbsp;</td><td valign="top"><a href="#Directories-and-Files">Directories and Files</a></td></tr>
+<tr><td></td><td valign="top"><a href="#index-org_002droam_002ddb_002dupdate_002didle_002dseconds"><code>org-roam-db-update-idle-seconds</code></a>:</td><td>&nbsp;</td><td valign="top"><a href="#The-Database">The Database</a></td></tr>
+<tr><td></td><td valign="top"><a href="#index-org_002droam_002ddb_002dupdate_002dmethod"><code>org-roam-db-update-method</code></a>:</td><td>&nbsp;</td><td valign="top"><a href="#The-Database">The Database</a></td></tr>
 <tr><td></td><td valign="top"><a href="#index-org_002droam_002ddirectory"><code>org-roam-directory</code></a>:</td><td>&nbsp;</td><td valign="top"><a href="#Directories-and-Files">Directories and Files</a></td></tr>
 <tr><td></td><td valign="top"><a href="#index-org_002droam_002dencrypt_002dfiles"><code>org-roam-encrypt-files</code></a>:</td><td>&nbsp;</td><td valign="top"><a href="#Encryption">Encryption</a></td></tr>
 <tr><td></td><td valign="top"><a href="#index-org_002droam_002dfile_002dexclude_002dregexp"><code>org-roam-file-exclude-regexp</code></a>:</td><td>&nbsp;</td><td valign="top"><a href="#Directories-and-Files">Directories and Files</a></td></tr>

org-roam.org

@@ -671,6 +671,23 @@ The ~org-roam-link-current~ face corresponds to links to the same file it is in.
 
 The ~org-roam-link-invalid~ face is applied to links that are broken. These are
 links to files or IDs that cannot be found.
+** TODO The Database
+
+Org-roam is backed by a Sqlite database.
+
+- User Option: org-roam-db-update-method
+
+  Method to update the Org-roam database.
+
+  ~'immediate~: Update the database immediately upon file changes.
+
+  ~'idle-timer~: Updates the database if dirty, if Emacs idles for
+  ~org-roam-db-update-idle-seconds~.
+
+- User Option: org-roam-db-update-idle-seconds
+
+  Number of idle seconds before triggering an Org-roam database update. This is
+  only valid if ~org-roam-db-update-method~ is ~'idle-timer~.
 
 * Inserting Links
 

org-roam.texi

@@ -119,6 +119,7 @@ Concepts and Configuration
 * The Org-roam Buffer::
 * Org-roam Files::
 * Org-roam Faces::
+* The Database::
 
 Navigating Around
 
@@ -878,6 +879,7 @@ org-roam}.
 * The Org-roam Buffer::
 * Org-roam Files::
 * Org-roam Faces::
+* The Database::
 @end menu
 
 @node Directories and Files
@@ -970,6 +972,27 @@ The @code{org-roam-link-current} face corresponds to links to the same file it i
 The @code{org-roam-link-invalid} face is applied to links that are broken. These are
 links to files or IDs that cannot be found.
 
+@node The Database
+@section @strong{TODO} The Database
+
+Org-roam is backed by a Sqlite database.
+
+@defopt org-roam-db-update-method
+
+Method to update the Org-roam database.
+
+@code{'immediate}: Update the database immediately upon file changes.
+
+@code{'idle-timer}: Updates the database if dirty, if Emacs idles for
+@code{org-roam-db-update-idle-seconds}.
+@end defopt
+
+@defopt org-roam-db-update-idle-seconds
+
+Number of idle seconds before triggering an Org-roam database update. This is
+only valid if @code{org-roam-db-update-method} is @code{'idle-timer}.
+@end defopt
+
 @node Inserting Links
 @chapter Inserting Links