2015-10-26 11:58:34 -04:00
|
|
|
;;; ob-sql.el --- Babel Functions for SQL -*- lexical-binding: t; -*-
|
2009-08-01 16:00:37 -04:00
|
|
|
|
2016-01-09 17:12:03 -05:00
|
|
|
;; Copyright (C) 2009-2016 Free Software Foundation, Inc.
|
2009-08-01 16:00:37 -04:00
|
|
|
|
|
|
|
;; Author: Eric Schulte
|
|
|
|
;; Keywords: literate programming, reproducible research
|
|
|
|
;; Homepage: http://orgmode.org
|
|
|
|
|
2010-06-25 12:32:35 -04:00
|
|
|
;; This file is part of GNU Emacs.
|
2009-08-01 16:00:37 -04:00
|
|
|
|
2010-06-25 12:32:35 -04:00
|
|
|
;; GNU Emacs is free software: you can redistribute it and/or modify
|
2009-08-01 16:00:37 -04:00
|
|
|
;; it under the terms of the GNU General Public License as published by
|
2010-06-25 12:32:35 -04:00
|
|
|
;; the Free Software Foundation, either version 3 of the License, or
|
|
|
|
;; (at your option) any later version.
|
|
|
|
|
|
|
|
;; GNU Emacs is distributed in the hope that it will be useful,
|
2009-08-01 16:00:37 -04:00
|
|
|
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
|
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
|
|
;; GNU General Public License for more details.
|
2010-06-25 12:32:35 -04:00
|
|
|
|
2009-08-01 16:00:37 -04:00
|
|
|
;; You should have received a copy of the GNU General Public License
|
2010-06-25 12:32:35 -04:00
|
|
|
;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
|
2009-08-01 16:00:37 -04:00
|
|
|
|
|
|
|
;;; Commentary:
|
|
|
|
|
|
|
|
;; Org-Babel support for evaluating sql source code.
|
2012-02-18 11:26:02 -05:00
|
|
|
;; (see also ob-sqlite.el)
|
2009-08-01 16:00:37 -04:00
|
|
|
;;
|
|
|
|
;; SQL is somewhat unique in that there are many different engines for
|
|
|
|
;; the evaluation of sql (Mysql, PostgreSQL, etc...), so much of this
|
|
|
|
;; file will have to be implemented engine by engine.
|
|
|
|
;;
|
|
|
|
;; Also SQL evaluation generally takes place inside of a database.
|
2009-08-01 21:05:18 -04:00
|
|
|
;;
|
2013-02-05 10:50:50 -05:00
|
|
|
;; Header args used:
|
|
|
|
;; - engine
|
|
|
|
;; - cmdline
|
|
|
|
;; - dbhost
|
2015-04-06 16:13:06 -04:00
|
|
|
;; - dbport
|
2013-02-05 10:50:50 -05:00
|
|
|
;; - dbuser
|
|
|
|
;; - dbpassword
|
|
|
|
;; - database
|
|
|
|
;; - colnames (default, nil, means "yes")
|
|
|
|
;; - result-params
|
|
|
|
;; - out-file
|
|
|
|
;; The following are used but not really implemented for SQL:
|
|
|
|
;; - colname-names
|
|
|
|
;; - rownames
|
|
|
|
;; - rowname-names
|
2009-08-01 21:05:18 -04:00
|
|
|
;;
|
|
|
|
;; TODO:
|
|
|
|
;;
|
|
|
|
;; - support for sessions
|
|
|
|
;; - support for more engines (currently only supports mysql)
|
|
|
|
;; - what's a reasonable way to drop table data into SQL?
|
2012-03-19 16:38:12 -04:00
|
|
|
;;
|
2009-08-01 16:00:37 -04:00
|
|
|
|
|
|
|
;;; Code:
|
2010-06-11 19:02:42 -04:00
|
|
|
(require 'ob)
|
2010-07-02 22:21:31 -04:00
|
|
|
|
|
|
|
(declare-function org-table-import "org-table" (file arg))
|
2012-10-02 05:19:29 -04:00
|
|
|
(declare-function orgtbl-to-csv "org-table" (table params))
|
|
|
|
(declare-function org-table-to-lisp "org-table" (&optional txt))
|
2016-06-08 01:49:54 -04:00
|
|
|
(declare-function cygwin-convert-file-name-to-windows "cygw32.c" (file &optional absolute-p))
|
2009-08-01 16:00:37 -04:00
|
|
|
|
2010-06-25 13:12:54 -04:00
|
|
|
(defvar org-babel-default-header-args:sql '())
|
|
|
|
|
2013-02-05 10:50:50 -05:00
|
|
|
(defconst org-babel-header-args:sql
|
|
|
|
'((engine . :any)
|
|
|
|
(out-file . :any)
|
|
|
|
(dbhost . :any)
|
2015-04-06 16:13:06 -04:00
|
|
|
(dbport . :any)
|
2013-02-05 10:50:50 -05:00
|
|
|
(dbuser . :any)
|
|
|
|
(dbpassword . :any)
|
|
|
|
(database . :any))
|
|
|
|
"SQL-specific header arguments.")
|
2011-10-26 08:19:54 -04:00
|
|
|
|
2010-11-30 21:32:01 -05:00
|
|
|
(defun org-babel-expand-body:sql (body params)
|
|
|
|
"Expand BODY according to the values of PARAMS."
|
|
|
|
(org-babel-sql-expand-vars
|
2015-10-29 15:26:11 -04:00
|
|
|
body (org-babel--get-vars params)))
|
2010-11-30 21:32:01 -05:00
|
|
|
|
2015-04-06 16:13:06 -04:00
|
|
|
(defun org-babel-sql-dbstring-mysql (host port user password database)
|
2013-02-05 10:50:50 -05:00
|
|
|
"Make MySQL cmd line args for database connection. Pass nil to omit that arg."
|
|
|
|
(combine-and-quote-strings
|
2014-09-20 09:09:29 -04:00
|
|
|
(delq nil
|
2013-02-05 10:50:50 -05:00
|
|
|
(list (when host (concat "-h" host))
|
2015-04-06 16:13:06 -04:00
|
|
|
(when port (format "-P%d" port))
|
2013-02-05 10:50:50 -05:00
|
|
|
(when user (concat "-u" user))
|
|
|
|
(when password (concat "-p" password))
|
|
|
|
(when database (concat "-D" database))))))
|
|
|
|
|
2016-09-16 03:12:56 -04:00
|
|
|
(defun org-babel-sql-dbstring-postgresql (host port user database)
|
2014-09-20 09:02:36 -04:00
|
|
|
"Make PostgreSQL command line args for database connection.
|
|
|
|
Pass nil to omit that arg."
|
|
|
|
(combine-and-quote-strings
|
|
|
|
(delq nil
|
|
|
|
(list (when host (concat "-h" host))
|
2016-09-16 03:12:56 -04:00
|
|
|
(when port (format "-p%d" port))
|
2014-09-20 09:02:36 -04:00
|
|
|
(when user (concat "-U" user))
|
|
|
|
(when database (concat "-d" database))))))
|
|
|
|
|
2015-12-18 04:44:25 -05:00
|
|
|
(defun org-babel-sql-dbstring-oracle (host port user password database)
|
|
|
|
"Make Oracle command line args for database connection."
|
|
|
|
(format "%s/%s@%s:%s/%s" user password host port database))
|
|
|
|
|
2016-06-08 01:49:54 -04:00
|
|
|
(defun org-babel-sql-dbstring-mssql (host user password database)
|
|
|
|
"Make sqlcmd commmand line args for database connection.
|
|
|
|
`sqlcmd' is the preferred command line tool to access Microsoft
|
|
|
|
SQL Server on Windows and Linux platform."
|
|
|
|
(mapconcat #'identity
|
|
|
|
(delq nil
|
|
|
|
(list (when host (format "-S \"%s\"" host))
|
|
|
|
(when user (format "-U \"%s\"" user))
|
|
|
|
(when password (format "-P \"%s\"" password))
|
|
|
|
(when database (format "-d \"%s\"" database))))
|
|
|
|
" "))
|
|
|
|
|
|
|
|
(defun org-babel-sql-convert-standard-filename (file)
|
|
|
|
"Convert the file name to OS standard.
|
|
|
|
If in Cygwin environment, uses Cygwin specific function to
|
|
|
|
convert the file name. Otherwise, uses Emacs' standard conversion
|
|
|
|
function."
|
|
|
|
(format "\"%s\""
|
|
|
|
(if (fboundp 'cygwin-convert-file-name-to-windows)
|
|
|
|
(cygwin-convert-file-name-to-windows file)
|
|
|
|
(convert-standard-filename file))))
|
|
|
|
|
2009-08-01 16:00:37 -04:00
|
|
|
(defun org-babel-execute:sql (body params)
|
2010-07-13 19:20:08 -04:00
|
|
|
"Execute a block of Sql code with Babel.
|
|
|
|
This function is called by `org-babel-execute-src-block'."
|
2016-09-22 13:45:15 -04:00
|
|
|
(let* ((result-params (cdr (assq :result-params params)))
|
|
|
|
(cmdline (cdr (assq :cmdline params)))
|
|
|
|
(dbhost (cdr (assq :dbhost params)))
|
2015-04-06 16:13:06 -04:00
|
|
|
(dbport (cdr (assq :dbport params)))
|
2016-09-22 13:45:15 -04:00
|
|
|
(dbuser (cdr (assq :dbuser params)))
|
|
|
|
(dbpassword (cdr (assq :dbpassword params)))
|
|
|
|
(database (cdr (assq :database params)))
|
|
|
|
(engine (cdr (assq :engine params)))
|
|
|
|
(colnames-p (not (equal "no" (cdr (assq :colnames params)))))
|
2010-08-25 16:43:07 -04:00
|
|
|
(in-file (org-babel-temp-file "sql-in-"))
|
2016-09-22 13:45:15 -04:00
|
|
|
(out-file (or (cdr (assq :out-file params))
|
2010-08-25 16:43:07 -04:00
|
|
|
(org-babel-temp-file "sql-out-")))
|
2010-12-21 12:33:37 -05:00
|
|
|
(header-delim "")
|
2015-12-20 10:57:07 -05:00
|
|
|
(command (pcase (intern engine)
|
|
|
|
(`dbi (format "dbish --batch %s < %s | sed '%s' > %s"
|
2012-05-16 21:26:56 -04:00
|
|
|
(or cmdline "")
|
|
|
|
(org-babel-process-file-name in-file)
|
2015-09-17 19:08:20 -04:00
|
|
|
"/^+/d;s/^|//;s/(NULL)/ /g;$d"
|
2012-05-16 21:26:56 -04:00
|
|
|
(org-babel-process-file-name out-file)))
|
2015-12-20 10:57:07 -05:00
|
|
|
(`monetdb (format "mclient -f tab %s < %s > %s"
|
|
|
|
(or cmdline "")
|
|
|
|
(org-babel-process-file-name in-file)
|
|
|
|
(org-babel-process-file-name out-file)))
|
2016-06-08 01:49:54 -04:00
|
|
|
(`mssql (format "sqlcmd %s -s \"\t\" %s -i %s -o %s"
|
2016-09-16 03:12:56 -04:00
|
|
|
(or cmdline "")
|
|
|
|
(org-babel-sql-dbstring-mssql
|
|
|
|
dbhost dbuser dbpassword database)
|
|
|
|
(org-babel-sql-convert-standard-filename
|
|
|
|
(org-babel-process-file-name in-file))
|
|
|
|
(org-babel-sql-convert-standard-filename
|
|
|
|
(org-babel-process-file-name out-file))))
|
2015-12-20 10:57:07 -05:00
|
|
|
(`mysql (format "mysql %s %s %s < %s > %s"
|
2015-04-06 16:13:06 -04:00
|
|
|
(org-babel-sql-dbstring-mysql
|
|
|
|
dbhost dbport dbuser dbpassword database)
|
2013-02-05 10:50:50 -05:00
|
|
|
(if colnames-p "" "-N")
|
2015-12-20 10:57:07 -05:00
|
|
|
(or cmdline "")
|
2010-09-22 16:40:14 -04:00
|
|
|
(org-babel-process-file-name in-file)
|
|
|
|
(org-babel-process-file-name out-file)))
|
2015-12-20 10:57:07 -05:00
|
|
|
(`postgresql (format
|
2016-09-16 03:12:56 -04:00
|
|
|
"%spsql --set=\"ON_ERROR_STOP=1\" %s -A -P \
|
2015-12-20 10:57:07 -05:00
|
|
|
footer=off -F \"\t\" %s -f %s -o %s %s"
|
2016-09-16 03:12:56 -04:00
|
|
|
(if dbpassword
|
|
|
|
(format "PGPASSWORD=%s " dbpassword)
|
|
|
|
"")
|
2014-01-08 11:56:21 -05:00
|
|
|
(if colnames-p "" "-t")
|
2015-12-20 10:57:07 -05:00
|
|
|
(org-babel-sql-dbstring-postgresql
|
2016-09-16 03:12:56 -04:00
|
|
|
dbhost dbport dbuser database)
|
2012-08-11 13:10:44 -04:00
|
|
|
(org-babel-process-file-name in-file)
|
|
|
|
(org-babel-process-file-name out-file)
|
|
|
|
(or cmdline "")))
|
2015-12-20 10:57:07 -05:00
|
|
|
(`oracle (format
|
|
|
|
"sqlplus -s %s < %s > %s"
|
|
|
|
(org-babel-sql-dbstring-oracle
|
|
|
|
dbhost dbport dbuser dbpassword database)
|
|
|
|
(org-babel-process-file-name in-file)
|
2015-12-18 04:44:25 -05:00
|
|
|
(org-babel-process-file-name out-file)))
|
2015-12-20 10:57:07 -05:00
|
|
|
(_ (error "No support for the %s SQL engine" engine)))))
|
2010-04-16 01:21:56 -04:00
|
|
|
(with-temp-file in-file
|
2012-05-16 21:26:56 -04:00
|
|
|
(insert
|
2015-12-20 10:57:07 -05:00
|
|
|
(pcase (intern engine)
|
|
|
|
(`dbi "/format partbox\n")
|
|
|
|
(`oracle "SET PAGESIZE 50000
|
2015-12-18 04:44:25 -05:00
|
|
|
SET NEWPAGE 0
|
|
|
|
SET TAB OFF
|
|
|
|
SET SPACE 0
|
|
|
|
SET LINESIZE 9999
|
|
|
|
SET ECHO OFF
|
|
|
|
SET FEEDBACK OFF
|
|
|
|
SET VERIFY OFF
|
|
|
|
SET HEADING ON
|
|
|
|
SET MARKUP HTML OFF SPOOL OFF
|
|
|
|
SET COLSEP '|'
|
|
|
|
|
2016-06-08 01:49:54 -04:00
|
|
|
")
|
|
|
|
(`mssql "SET NOCOUNT ON
|
|
|
|
|
2015-12-18 04:44:25 -05:00
|
|
|
")
|
2015-12-20 10:57:07 -05:00
|
|
|
(_ ""))
|
2012-05-16 21:26:56 -04:00
|
|
|
(org-babel-expand-body:sql body params)))
|
2013-02-09 16:18:24 -05:00
|
|
|
(org-babel-eval command "")
|
2012-11-18 20:02:09 -05:00
|
|
|
(org-babel-result-cond result-params
|
|
|
|
(with-temp-buffer
|
2015-12-20 10:57:07 -05:00
|
|
|
(progn (insert-file-contents-literally out-file) (buffer-string)))
|
2010-12-21 12:33:37 -05:00
|
|
|
(with-temp-buffer
|
2013-02-24 03:15:02 -05:00
|
|
|
(cond
|
2016-02-09 16:16:53 -05:00
|
|
|
((memq (intern engine) '(dbi mysql postgresql))
|
2015-12-20 10:57:07 -05:00
|
|
|
;; Add header row delimiter after column-names header in first line
|
|
|
|
(cond
|
|
|
|
(colnames-p
|
|
|
|
(with-temp-buffer
|
|
|
|
(insert-file-contents out-file)
|
|
|
|
(goto-char (point-min))
|
|
|
|
(forward-line 1)
|
|
|
|
(insert "-\n")
|
|
|
|
(setq header-delim "-")
|
|
|
|
(write-file out-file)))))
|
|
|
|
(t
|
|
|
|
;; Need to figure out the delimiter for the header row
|
|
|
|
(with-temp-buffer
|
|
|
|
(insert-file-contents out-file)
|
|
|
|
(goto-char (point-min))
|
|
|
|
(when (re-search-forward "^\\(-+\\)[^-]" nil t)
|
|
|
|
(setq header-delim (match-string-no-properties 1)))
|
|
|
|
(goto-char (point-max))
|
|
|
|
(forward-char -1)
|
|
|
|
(while (looking-at "\n")
|
|
|
|
(delete-char 1)
|
|
|
|
(goto-char (point-max))
|
|
|
|
(forward-char -1))
|
|
|
|
(write-file out-file))))
|
2011-10-18 12:15:04 -04:00
|
|
|
(org-table-import out-file '(16))
|
|
|
|
(org-babel-reassemble-table
|
|
|
|
(mapcar (lambda (x)
|
|
|
|
(if (string= (car x) header-delim)
|
|
|
|
'hline
|
|
|
|
x))
|
|
|
|
(org-table-to-lisp))
|
2016-09-22 13:45:15 -04:00
|
|
|
(org-babel-pick-name (cdr (assq :colname-names params))
|
|
|
|
(cdr (assq :colnames params)))
|
|
|
|
(org-babel-pick-name (cdr (assq :rowname-names params))
|
|
|
|
(cdr (assq :rownames params))))))))
|
2010-04-18 21:06:34 -04:00
|
|
|
|
2010-11-30 21:32:01 -05:00
|
|
|
(defun org-babel-sql-expand-vars (body vars)
|
|
|
|
"Expand the variables held in VARS in BODY."
|
|
|
|
(mapc
|
|
|
|
(lambda (pair)
|
|
|
|
(setq body
|
|
|
|
(replace-regexp-in-string
|
2015-09-17 19:08:20 -04:00
|
|
|
(format "$%s" (car pair))
|
Backport changes from Emacs revs 115081 and 115082
2013-11-12 Stefan Monnier <monnier@iro.umontreal.ca>
Address some byte-compiler warnings.
* ob-abc.el (org-babel-expand-body:abc): Use dolist.
(org-babel-execute:abc): Fix regexp quoting.
* ob-calc.el (org--var-syms): Rename from `var-syms'.
* ob-lilypond.el (ly-compile-lilyfile): Remove redundant let-binding.
* ob-table.el (sbe): Move debug declaration.
* org-clock.el (org--msg-extra): Rename from `msg-extra'.
* org.el (org-version): Avoid var name starting with _.
(org-inhibit-startup, org-called-with-limited-levels)
(org-link-search-inhibit-query, org-time-was-given)
(org-end-time-was-given, org-def, org-defdecode, org-with-time):
* org-colview.el (org-agenda-overriding-columns-format):
* org-agenda.el (org-agenda-multi, org-depend-tag-blocked)
(org-agenda-show-log-scoped):
* ob-python.el (py-which-bufname, python-shell-buffer-name):
* ob-haskell.el (org-export-copy-to-kill-ring):
* ob-exp.el (org-link-search-inhibit-query):
* ob-R.el (ess-eval-visibly-p):
* ob-core.el (org-src-window-setup): Declare before use.
(org-babel-expand-noweb-references): Remove unused `blocks-in-buffer'.
* ox-odt.el (org-odt-hfy-face-to-css):
* org-src.el (org-src-associate-babel-session, org-src-get-lang-mode):
* org-bibtex.el (org-bibtex-get, org-bibtex-ask, org-bibtex)
(org-bibtex-check):
* ob-tangle.el (org-babel-tangle, org-babel-spec-to-string)
(org-babel-tangle-single-block, org-babel-tangle-comment-links):
* ob-table.el (sbe):
* ob-sqlite.el (org-babel-sqlite-expand-vars):
* ob-sql.el (org-babel-sql-expand-vars):
* ob-shen.el (org-babel-execute:shen):
* ob-sh.el (org-babel-execute:sh, org-babel-sh-evaluate):
* ob-scala.el (org-babel-scala-evaluate):
* ob-ruby.el (org-babel-ruby-table-or-string)
(org-babel-ruby-evaluate):
* ob-python.el (org-babel-python-table-or-string)
(org-babel-python-evaluate-external-process)
(org-babel-python-evaluate-session):
* ob-picolisp.el (org-babel-execute:picolisp):
* ob-perl.el (org-babel-perl-evaluate):
* ob-maxima.el (org-babel-execute:maxima):
* ob-lisp.el (org-babel-execute:lisp):
* ob-java.el (org-babel-execute:java):
* ob-io.el (org-babel-io-evaluate):
* ob-haskell.el (org-babel-execute:haskell):
* ob-fortran.el (org-babel-execute:fortran):
* ob-exp.el (org-babel-exp-code):
* ob-emacs-lisp.el (org-babel-execute:emacs-lisp):
* ob-ditaa.el (org-babel-execute:ditaa):
* ob-core.el (org-babel-execute-src-block, org-babel-sha1-hash)
(org-babel-parse-header-arguments, org-babel-reassemble-table)
(org-babel-goto-src-block-head, org-babel-mark-block)
(org-babel-expand-noweb-references, org-babel-script-escape)
(org-babel-process-file-name):
* ob-clojure.el (org-babel-execute:clojure):
* ob-calc.el (org-babel-execute:calc):
* ob-awk.el (org-babel-execute:awk):
* ob-abc.el (org-babel-execute:abc):
* ob-R.el (org-babel-expand-body:R):
* ob-C.el (org-babel-C-execute): Avoid deprecated ((lambda) ...).
2013-11-12 Glenn Morris <rgm@gnu.org>
* ox-html.el (org-html-scripts): Add 2013 to copyright years.
(org-html-infojs-template): Copyright holder to FSF.
2013-11-12 14:57:31 -05:00
|
|
|
(let ((val (cdr pair)))
|
|
|
|
(if (listp val)
|
|
|
|
(let ((data-file (org-babel-temp-file "sql-data-")))
|
|
|
|
(with-temp-file data-file
|
|
|
|
(insert (orgtbl-to-csv
|
|
|
|
val '(:fmt (lambda (el) (if (stringp el)
|
|
|
|
el
|
|
|
|
(format "%S" el)))))))
|
|
|
|
data-file)
|
|
|
|
(if (stringp val) val (format "%S" val))))
|
2010-11-30 21:32:01 -05:00
|
|
|
body)))
|
|
|
|
vars)
|
|
|
|
body)
|
2009-08-01 16:00:37 -04:00
|
|
|
|
2015-10-26 11:58:34 -04:00
|
|
|
(defun org-babel-prep-session:sql (_session _params)
|
2010-07-13 19:20:08 -04:00
|
|
|
"Raise an error because Sql sessions aren't implemented."
|
2012-08-12 23:59:44 -04:00
|
|
|
(error "SQL sessions not yet implemented"))
|
2009-08-01 16:00:37 -04:00
|
|
|
|
2010-06-11 19:02:42 -04:00
|
|
|
(provide 'ob-sql)
|
2010-06-25 12:32:35 -04:00
|
|
|
|
2011-08-15 14:04:38 -04:00
|
|
|
|
2010-06-25 12:32:35 -04:00
|
|
|
|
2010-06-11 19:02:42 -04:00
|
|
|
;;; ob-sql.el ends here
|