awesome-emacs/org-roam
1
0
Fork 0
mirror of https://github.com/org-roam/org-roam synced 2025-08-01 12:17:21 -05:00
Code Issues Packages Projects Releases Wiki Activity

(docs): update documentation on database-connectors (#2298)

Browse Source 
Update docs to reflect sqlite-bulitin and sqlite-module
This commit is contained in:
Jethro Kuan
2022-12-24 10:50:01 -08:00
committed by GitHub
parent f9228ce319
commit 256fe73e7a
2 changed files with 27 additions and 26 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
doc/org-roam.org
View File

@ -486,19 +486,25 @@ To use ~emacsql-sqlite3~, ensure that the package is installed, and set:
(setq org-roam-database-connector 'sqlite3)
#+end_src
[[https://github.com/emacscollective/emacsql-libsqlite3/][**emacsql-libsqlite3**]]
[[https://melpa.org/#/emacsql-sqlite-module][**emacssql-sqlite-module**]] (previously emacsql-libsqlite3)
~emacs-libsqlite3~ is a relatively young package which uses an Emacs module that
~emacs-sqlite-module~ is a relatively young package which uses an Emacs module that
exposes parts of the SQLite C API to Emacs Lisp, instead of using subprocess as
~emacsql-sqlite~ does. It is expected to be a more performant drop-in
replacement for ~emacs-sqlite~.
At the moment it is experimental and does not work well with the SQL query load
required by Org-roam, but you may still try it by ensuring the package is
installed and setting:
#+begin_src emacs-lisp
(setq org-roam-database-connector 'sqlite-module)
#+end_src
[[https://melpa.org/#/emacsql-sqlite-builtin][**emacsql-sqlite-builtin**]]
~emacsql-sqlite-builtin~ uses the in-built SQLite support for Emacs 29 and
later. This is the recommended option if you are using a version of Emacs that
supports it.
#+begin_src emacs-lisp
(setq org-roam-database-connector 'libsqlite3)
(setq org-roam-database-connector 'sqlite-builtin)
#+end_src
** What to cache

35
doc/org-roam.texi
View File

@ -31,7 +31,7 @@ General Public License for more details.
@finalout
@titlepage
@title Org-roam User Manual
@subtitle for version 2.2.1
@subtitle for version 2.2.2
@author Jethro Kuan
@page
@vskip 0pt plus 1filll
@ -401,18 +401,7 @@ To use Melpa-Stable:
@end lisp
Org-roam also depends on a recent version of Org, which can be obtained in Org's
package repository (see @ref{Installation,,,org,}). To use Org's ELPA archive:
@lisp
(add-to-list 'package-archives '("org" . "https://orgmode.org/elpa/") t)
@end lisp
Once you have added your preferred archive, you need to update the
local package list using:
@example
M-x package-refresh-contents RET
@end example
package repository (see @ref{Installation,,,org,}).
Once you have done that, you can install Org-roam and its dependencies
using:
@ -803,19 +792,25 @@ To use @code{emacsql-sqlite3}, ensure that the package is installed, and set:
(setq org-roam-database-connector 'sqlite3)
@end lisp
@uref{https://github.com/emacscollective/emacsql-libsqlite3/, @strong{@strong{emacsql-libsqlite3}}}
@uref{https://melpa.org/#/emacsql-sqlite-module, @strong{@strong{emacssql-sqlite-module}}} (previously emacsql-libsqlite3)
@code{emacs-libsqlite3} is a relatively young package which uses an Emacs module that
@code{emacs-sqlite-module} is a relatively young package which uses an Emacs module that
exposes parts of the SQLite C API to Emacs Lisp, instead of using subprocess as
@code{emacsql-sqlite} does. It is expected to be a more performant drop-in
replacement for @code{emacs-sqlite}.
At the moment it is experimental and does not work well with the SQL query load
required by Org-roam, but you may still try it by ensuring the package is
installed and setting:
@lisp
(setq org-roam-database-connector 'sqlite-module)
@end lisp
@uref{https://melpa.org/#/emacsql-sqlite-builtin, @strong{@strong{emacsql-sqlite-builtin}}}
@code{emacsql-sqlite-builtin} uses the in-built SQLite support for Emacs 29 and
later. This is the recommended option if you are using a version of Emacs that
supports it.
@lisp
(setq org-roam-database-connector 'libsqlite3)
(setq org-roam-database-connector 'sqlite-builtin)
@end lisp
@node What to cache
@ -2555,4 +2550,4 @@ When GOTO is non-nil, go the note without creating an entry."
@printindex vr
Emacs 29.0.50 (Org mode 9.6)
@bye
@bye