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

(internal): simplify db update operations (#1212)

Browse Source 
Instead of maintaining a file queue to process for updating the Org-roam
database, we instead simply call `org-roam-db-build-cache` to rebuild
the db. `org-roam-db-build-cache` feels Fast Enough(TM), and basically
runs instantly if no files are modified. This greatly simplifies the
code, basically allowing to maintaining a single code path for db
operations.

This PR should also address the slowness wrt to ID links. Org-roam now
builds the headline information first, so there is no need to read the
file to check if the headline is there. The downside to this is that
this only works for IDs in Org-roam files.
This commit is contained in:
Jethro Kuan
2020-10-25 16:35:05 +08:00
committed by GitHub
parent a7cf48ea89
commit b937bc9655
2 changed files with 36 additions and 30 deletions
Download Patch File Download Diff File Expand all files Collapse all files

33
org-roam-db.el
View File

@ -84,6 +84,9 @@ value like `most-positive-fixnum'."
(defvar org-roam-db--connection (make-hash-table :test #'equal)
"Database connection to Org-roam database.")
(defvar org-roam-db-dirty nil
"Whether the org-roam database is dirty and requires an update.")
;;;; Core Functions
(defun org-roam-db--get-connection ()
@ -191,6 +194,10 @@ the current `org-roam-directory'."
(dolist (conn (hash-table-values org-roam-db--connection))
(org-roam-db--close conn)))
(defun org-roam-db--mark-dirty ()
"Mark the Org-roam database as dirty."
(setq org-roam-db-dirty t))
;;;; Database API
;;;;; Initialization
(defun org-roam-db--initialized-p ()
@ -494,8 +501,11 @@ If FORCE, force a rebuild of the cache from scratch."
(setq deleted-count (1+ deleted-count)))
(pcase-dolist (`(,file . _) modified-files)
(org-roam-db--clear-file file))
;; Process all the files for IDs first
;;
;; We do this so that link extraction is cheaper: this eliminates the need
;; to read the file to check if the ID really exists
(pcase-dolist (`(,file . ,contents-hash) modified-files)
(org-roam-message "Processed %s/%s modified files..." modified-count (length modified-files))
(let* ((attr (file-attributes file))
(atime (file-attribute-access-time attr))
(mtime (file-attribute-modification-time attr)))
@ -505,9 +515,18 @@ If FORCE, force a rebuild of the cache from scratch."
[:insert :into files
:values $v1]
(vector file contents-hash (list :atime atime :mtime mtime)))
(setq modified-count (1+ modified-count))
(when org-roam-enable-headline-linking
(setq id-count (+ id-count (org-roam-db--insert-ids))))
(setq id-count (+ id-count (org-roam-db--insert-ids)))))
(file-error
(setq org-roam-files (remove file org-roam-files))
(org-roam-db--clear-file file)
(lwarn '(org-roam) :warning
"Skipping unreadable file while building cache: %s" file)))))
(pcase-dolist (`(,file . _) modified-files)
(org-roam-message "Processed %s/%s modified files..." modified-count (length modified-files))
(condition-case nil
(org-roam--with-temp-buffer file
(setq modified-count (1+ modified-count))
(setq link-count (+ link-count (org-roam-db--insert-links)))
(setq tag-count (+ tag-count (org-roam-db--insert-tags)))
(setq title-count (+ title-count (org-roam-db--insert-titles)))
@ -516,7 +535,7 @@ If FORCE, force a rebuild of the cache from scratch."
(setq org-roam-files (remove file org-roam-files))
(org-roam-db--clear-file file)
(lwarn '(org-roam) :warning
"Skipping unreadable file while building cache: %s" file)))))
"Skipping unreadable file while building cache: %s" file))))
(org-roam-message "total: Δ%s, files-modified: Δ%s, ids: Δ%s, links: Δ%s, tags: Δ%s, titles: Δ%s, refs: Δ%s, deleted: Δ%s"
(length org-roam-files)
modified-count
@ -527,6 +546,12 @@ If FORCE, force a rebuild of the cache from scratch."
ref-count
deleted-count)))
(defun org-roam-db-update-cache ()
"Update the cache if the database is dirty."
(when org-roam-db-dirty
(org-roam-db-build-cache)
(setq org-roam-db-dirty nil)))
(provide 'org-roam-db)
;;; org-roam-db.el ends here

33
org-roam.el
View File

@ -307,9 +307,6 @@ descriptive warnings when certain operations fail (e.g. parsing).")
(defvar org-roam--file-update-timer nil
"Timer for updating the database on file changes.")
(defvar org-roam--file-update-queue nil
"List of files that need to be processed for a database update. Processed within `org-roam--file-update-timer'.")
;;;; Utilities
(defun org-roam--plist-to-alist (plist)
"Return an alist of the property-value pairs in PLIST."
@ -598,7 +595,8 @@ it as FILE-PATH."
:point begin))
(names (pcase type
("id"
(list (car (org-roam-id-find path nil nil 'keep-buffer))))
(when-let ((file-path (org-roam-id-get-file path)))
(list file-path)))
("cite" (list path))
("website" (list path))
("fuzzy" (list path))
@ -1253,23 +1251,6 @@ file."
(t
'org-link)))))
(defun org-roam--queue-file-for-update (&optional file-path)
"Queue FILE-PATH for `org-roam' database update.
This is a lightweight function that is called during `after-save-hook'
and only schedules the current Org file to be `org-roam' updated
during the next idle slot."
(let ((fp (or file-path buffer-file-name)))
(when (org-roam--org-roam-file-p file-path)
(add-to-list 'org-roam--file-update-queue fp))))
(defun org-roam--process-update-queue ()
"Process files queued in `org-roam--file-update-queue'."
(when org-roam--file-update-queue
(mapc #'org-roam-db--update-file org-roam--file-update-queue)
(org-roam-message "database updated during idle: %s."
(mapconcat #'file-name-nondirectory org-roam--file-update-queue ", ") )
(setq org-roam--file-update-queue nil)))
;;;; Hooks and Advices
(defcustom org-roam-file-setup-hook nil
"Hook that is run on setting up an Org-roam file."
@ -1284,7 +1265,7 @@ during the next idle slot."
(org-roam--setup-title-auto-update)
(add-hook 'post-command-hook #'org-roam-buffer--update-maybe nil t)
(add-hook 'before-save-hook #'org-roam-link--replace-link-on-save nil t)
(add-hook 'after-save-hook #'org-roam--queue-file-for-update nil t)
(add-hook 'after-save-hook #'org-roam-db--mark-dirty nil t)
(dolist (fn org-roam-completion-functions)
(add-hook 'completion-at-point-functions fn nil t))
(org-roam-buffer--update-maybe :redisplay t)))
@ -1421,7 +1402,7 @@ To be added to `org-roam-title-change-hook'."
(unless (string-match-p file-name new-file-name)
(rename-file file-name new-file-name)
(set-visited-file-name new-file-name t t)
(add-to-list 'org-roam--file-update-queue new-file-name)
(org-roam-db--mark-dirty)
(org-roam-message "File moved to %S" (abbreviate-file-name new-file-name))))))))
(defun org-roam--rename-file-advice (old-file new-file-or-dir &rest _args)
@ -1471,7 +1452,7 @@ When NEW-FILE-OR-DIR is a directory, we use it to compute the new file path."
"Update the database if a new Org ID is created."
(when (and org-roam-enable-headline-linking
(org-roam--org-roam-file-p))
(add-to-list 'org-roam--file-update-queue (buffer-file-name))))
(org-roam-db--mark-dirty)))
;;;###autoload
(define-minor-mode org-roam-mode
@ -1507,7 +1488,7 @@ M-x info for more information at Org-roam > Installation > Post-Installation Tas
(add-hook 'kill-emacs-hook #'org-roam-db--close-all)
(add-hook 'org-open-at-point-functions #'org-roam-open-id-at-point)
(unless org-roam--file-update-timer
(setq org-roam--file-update-timer (run-with-idle-timer org-roam-update-db-idle-seconds t #'org-roam--process-update-queue)))
(setq org-roam--file-update-timer (run-with-idle-timer org-roam-update-db-idle-seconds t #'org-roam-db-update-cache)))
(advice-add 'rename-file :after #'org-roam--rename-file-advice)
(advice-add 'delete-file :before #'org-roam--delete-file-advice)
(advice-add 'org-id-new :after #'org-roam--id-new-advice)
@ -1534,7 +1515,7 @@ M-x info for more information at Org-roam > Installation > Post-Installation Tas
(with-current-buffer buf
(remove-hook 'post-command-hook #'org-roam-buffer--update-maybe t)
(remove-hook 'before-save-hook #'org-roam-link--replace-link-on-save t)
(remove-hook 'after-save-hook #'org-roam--queue-file-for-update t))))))
(remove-hook 'after-save-hook #'org-roam-db--mark-dirty t))))))
;;; Interactive Commands
;;;###autoload