jiri/org-ql
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Docs: Explain how caching works

Browse source 
Fixes #132.  Thanks to Mikhail Skorzhinskii (@mskorzhinskiy) for
suggesting.
This commit is contained in:
Adam Porter 2020-11-20 08:13:15 -06:00
parent f8a531f2be
commit e4fb1cce2e
2 changed files with 49 additions and 30 deletions
Download patch file Download diff file Expand all files Collapse all files

6
README.org
View file

@ -299,6 +299,12 @@ The variable =org-ql-block-header= may be bound to a string to use as the block
*** Listing / acting-on results
**** Caching
Org QL uses a per-buffer cache to speed up subsequent searches. It's keyed on query expressions, which means that, for the same query in the same buffer, if the buffer has not been modified since the last time the query was run, the cached result will be returned, and the query will not be evaluated in that buffer again.
Therefore, since query expressions are not guaranteed to be evaluated when these functions are called, they should be free of side effects. Any side effects should be done in the action expression instead.
**** Function: ~org-ql-select~
/Arguments:/ ~(buffers-or-files query &key action narrow sort)~