3.4 KiB
org-ql examples
- Contents
- Find entries matching a certain
CUSTOM_ID - Show entries with recent timestamps
- Stuck projects block agenda
- Listing bills coming due
Contents
Find entries matching a certain CUSTOM_ID
Since queries can contain both built-in org-ql predicate expressions and arbitrary expressions, they can be combined in useful ways. This example uses the built-in property predicate to quickly locate entries that have the CUSTOM_ID property set, and then compares the value of that property to the string issue.
(org-ql-query
:select #'org-get-heading
:from "~/org/tickets.org"
:where '(and (property "CUSTOM_ID")
(string-match "issue" (org-entry-get (point) "CUSTOM_ID"))))
Using the property predicate as the first clause of the two clauses joined with and allows org-ql to optimize the query by searching through the buffer directly to entries that set the CUSTOM_ID property, which is much faster than testing every entry in a buffer. Also, If the query were only the string-match call, it would signal an error on entries that didn't have the property set, because org-entry-get would return nil.
Show entries with recent timestamps
You can also access these views with the command org-ql-view.
;; Show entries with any timestamp from last 7 days:
(org-ql-view-recent-items 7)
;; Show entries clocked in last 30 days:
(org-ql-view-recent-items 30 'clocked)
;; Show entries closed in last 30 days:
(org-ql-view-recent-items 30 'closed)Stuck projects block agenda
Reddit user emptymatrix shared this example of replacing a traditional org-stuck-projects view like:
(setq org-stuck-projects
'("+@project/-DONE" ("NEXT") nil "SCHEDULED:"))
With this org-ql-block agenda view, like:
(setq org-agenda-custom-commands
'(("s" "Stuck Projects"
((org-ql-block '(and (tags "@project")
(not (done))
(not (descendants (todo "NEXT")))
(not (descendants (scheduled))))
((org-ql-block-header "Stuck Projects")))))))Listing bills coming due
This uses the example in the readme file, but maps across the elements returned by org-ql to present a simple list of titles and deadlines.
(org-ql (org-agenda-files)
(and (not (done))
(tags "bills")
(deadline auto))
:action (list (substring-no-properties (org-get-heading t t))
(org-entry-get (point) "DEADLINE"))
:sort deadline)
;;=> (("Electric bill" "<2018-08-23 Thu +1m>")
;; ("Rent" "<2018-09-01 Sat +1m>"))This could also be put in a script, which could use desktop notifications to remind of bills coming due: org-bills-due.el.