Fix org recursive loading issue.
[ob-redis.git] / README.org
blob70c38c2a1915b63838e8e27bd5af477af5b6d426
1 * About
3 Add Redis commands execution support in Org-mode Babel.
5 This package is referenced from [[https://github.com/krisajenkins/ob-mongo][ob-mongo.el]].
7 * Installation
9 ** MELPA
11 #+begin_src emacs-lisp
12 (use-package ob-redis
13   :ensure t
14   :defer t
15   :commands (org-babel-execute:redis)
16   :config
17   (add-to-list 'org-babel-load-languages '(redis . t))
18   (org-babel-do-load-languages 'org-babel-load-languages org-babel-load-languages)
19   (add-to-list 'org-babel-tangle-lang-exts '("redis" . "redis")))
20 #+end_src
22 ** QUELPA
24 #+begin_src emacs-lisp
25 (use-package ob-redis
26   :quelpa (ob-redis :fetcher github :repo "stardiviner/ob-redis")
27   :defer t
28   :commands (org-babel-execute:redis)
29   :config
30   (add-to-list 'org-babel-load-languages '(redis . t))
31   (org-babel-do-load-languages 'org-babel-load-languages org-babel-load-languages)
32   (add-to-list 'org-babel-tangle-lang-exts '("redis" . "redis")))
33 #+end_src
35 * Usage
37 ** example
39 #+begin_example
40 ,#+begin_src redis db: 127.0.0.1:6379
41 SET myname "stardiviner"
42 GET myname
43 ,#+end_src
45 ,#+RESULTS:
46 : 127.0.0.1:6379> OK
47 : 127.0.0.1:6379> stardiviner
48 : 127.0.0.1:6379> 
49 #+end_example
51 ** options
53 The babel header argument ~db:~ can specify your redis server ip address.