create-sql.lisp

   1 ;;;; -*- Mode: Lisp; Syntax: ANSI-Common-Lisp; Base: 10; Package: umlisp -*-
   2 ;;;; *************************************************************************
   3 ;;;; FILE IDENTIFICATION
   4 ;;;;
   5 ;;;; Name:          sql-create
   6 ;;;; Purpose:       Create SQL database for UMLisp
   7 ;;;; Author:        Kevin M. Rosenberg
   8 ;;;; Date Started:  Apr 2000
   9 ;;;;
  10 ;;;; $Id$
  11 ;;;;
  12 ;;;; This file, part of UMLisp, is
  13 ;;;;    Copyright (c) 2000-2003 by Kevin M. Rosenberg, M.D.
  14 ;;;;
  15 ;;;; UMLisp users are granted the rights to distribute and use this software
  16 ;;;; as governed by the terms of the GNU General Public License.
  17 ;;;; *************************************************************************
  18
  19 (in-package #:umlisp)
  20
  21 (defun create-table-cmd (file)
  22   "Return sql command to create a table"
  23   (let ((col-func
  24          (lambda (c)
  25            (let ((sqltype (sqltype c)))
  26              (concatenate 'string
  27                           (col c)
  28                           " "
  29                           (if (or (string-equal sqltype "VARCHAR")
  30                                   (string-equal sqltype "CHAR"))
  31                               (format nil "~a (~a)" sqltype (cmax c))
  32                               sqltype))))))
  33     (format nil "CREATE TABLE ~a (~{~a~^,~})" (table file)
  34             (mapcar col-func (ucols file)))))
  35
  36 (defun create-custom-table-cmd (tablename sql-cmd)
  37   "Return SQL command to create a custom table"
  38   (format nil "CREATE TABLE ~a AS ~a;" tablename sql-cmd))
  39
  40 (defun insert-col-value (col value)
  41   (if (null (parse-fun col))
  42       value
  43       (format nil "~A" (funcall (parse-fun col) value))))
  44
  45 (defun insert-values-cmd (file values)
  46   "Return sql insert command for a row of values"
  47   (let ((insert-func
  48          (lambda (col value)
  49            (concatenate 'string (quote-str col)
  50                         (insert-col-value col value)
  51                         (quote-str col)))))
  52     (format
  53      nil "INSERT INTO ~a (~{~a~^,~}) VALUES (~A)"
  54      (table file)
  55      (fields file)
  56      (concat-separated-strings
  57       ","
  58       (mapcar insert-func (remove-custom-cols (ucols file)) values)
  59       (custom-col-values (custom-ucols-for-file file) values t)))))
  60
  61
  62 (defun custom-col-value (col values doquote)
  63   (let ((custom-value (funcall (custom-value-fun col) values)))
  64     (if custom-value
  65         (if doquote
  66             (concatenate 'string (quote-str col)
  67                          (escape-backslashes custom-value)
  68                          (quote-str col))
  69             (escape-backslashes custom-value))
  70         "")))
  71
  72 (defun custom-col-values (ucols values doquote)
  73   "Returns a list of string column values for SQL inserts for custom columns"
  74   (loop for col in ucols collect (custom-col-value col values doquote)))
  75
  76 (defun remove-custom-cols (cols)
  77   "Remove custom cols from a list col umls-cols"
  78   (remove-if #'custom-value-fun cols))
  79
  80 (defun find-custom-cols-for-filename (filename)
  81   (remove-if-not (lambda (x) (string-equal filename (car x))) +custom-cols+))
  82
  83 (defun find-custom-col (filename col)
  84   (find-if (lambda (x) (and (string-equal filename (car x))
  85                             (string-equal col (cadr x)))) +custom-cols+))
  86
  87 (defun custom-colnames-for-filename (filename)
  88   (mapcar #'cadr (find-custom-cols-for-filename filename)))
  89
  90 (defun custom-ucols-for-file (file)
  91   (remove-if-not #'custom-value-fun (ucols file)))
  92
  93 (defun noneng-lang-index-files ()
  94   (remove-if-not
  95    (lambda (f) (and (> (length (fil f)) 4)
  96                     (string-equal (fil f) "MRXW." :end1 5)
  97                     (not (string-equal (fil f) "MRXW.ENG"))
  98                     (not (string-equal (fil f) "MRXW.NONENG"))))
  99    *umls-files*))
 100
 101 ;;; SQL Command Functions
 102
 103 (defun create-index-cmd (colname tablename length)
 104   "Return sql create index command"
 105   (format nil "CREATE INDEX ~a ON ~a (~a)"
 106           (concatenate 'string tablename "_" colname "_X")
 107           tablename
 108           (case *umls-sql-type*
 109             (:mysql
 110              (concatenate 'string colname
 111                           (if (integerp length)
 112                               (format nil " (~d)" length)
 113                               "")))
 114             ((:postgresql :postgresql-socket)
 115              (if (integerp length)
 116                  (format nil "substr(~A,1,~D)" colname length)
 117                  colname))
 118             (t
 119              colname))))
 120
 121 (defun create-all-tables-cmdfile ()
 122   "Return sql commands to create all tables. Not need for automated SQL import"
 123   (mapcar (lambda (f) (format nil "~a~%~%" (create-table-cmd f))) *umls-files*))
 124
 125 ;; SQL Execution functions
 126
 127 (defun sql-drop-tables (conn)
 128   "SQL Databases: drop all tables"
 129   (dolist (file *umls-files*)
 130     (ignore-errors
 131       (sql-execute (format nil "DROP TABLE ~a" (table file)) conn))))
 132
 133 (defun sql-create-tables (conn)
 134   "SQL Databases: create all tables"
 135   (dolist (file *umls-files*)
 136     (sql-execute (create-table-cmd file) conn)))
 137
 138 (defun sql-create-custom-tables (conn)
 139   "SQL Databases: create all custom tables"
 140   (dolist (ct +custom-tables+)
 141     (sql-execute (create-custom-table-cmd (car ct) (cadr ct)) conn)))
 142
 143 (defun sql-insert-values (conn file)
 144   "SQL Databases: inserts all values for a file"
 145   (with-umls-file (line (fil file))
 146     (sql-execute (insert-values-cmd file line) conn)))
 147
 148 (defun sql-insert-all-values (conn)
 149   "SQL Databases: inserts all values for all files"
 150   (dolist (file *umls-files*)
 151     (sql-insert-values conn file)))
 152
 153 (defun sql-create-indexes (conn &optional (indexes +index-cols+))
 154   "SQL Databases: create all indexes"
 155   (dolist (idx indexes)
 156     (sql-execute (create-index-cmd (car idx) (cadr idx) (caddr idx)) conn)))
 157
 158 (defun make-usrl (conn)
 159   (if (eql :mysql *umls-sql-type*)
 160       (sql-execute "drop table if exists USRL" conn)
 161       (ignore-errors (sql-execute "drop table USRL" conn)))
 162   (sql-execute "create table USRL (sab varchar(80), srl integer)" conn)
 163   (dolist (tuple (mutex-sql-query
 164                   "select distinct SAB,SRL from MRSO order by SAB asc"))
 165     (sql-execute (format nil "insert into USRL (sab,srl) values ('~a',~d)"
 166                          (car tuple) (ensure-integer (cadr tuple)))
 167                  conn)))
 168
 169 (defun sql-create-special-tables (conn)
 170   (make-usrl conn)
 171   (make-ustats))
 172
 173 (defun create-umls-db-by-insert ()
 174   "SQL Databases: initializes entire database via SQL insert commands"
 175   (ensure-ucols+ufiles)
 176   (ensure-preparse)
 177   (with-sql-connection (conn)
 178     (sql-drop-tables conn)
 179     (sql-create-tables conn)
 180     (sql-insert-all-values conn)
 181     (sql-create-indexes conn)
 182     (sql-create-custom-tables conn)
 183     (sql-create-indexes conn +custom-index-cols+)
 184     (sql-create-special-tables conn)))
 185
 186 (defun create-umls-db (&optional (extension ".trans"))
 187   "SQL Databases: initializes entire database via SQL copy commands.
 188 This is much faster that using create-umls-db-insert."
 189   (ignore-errors
 190     (clsql:destroy-database (list *umls-sql-host* (lookup-db-name *umls-sql-db*)
 191                                   *umls-sql-user* *umls-sql-passwd*)
 192                             :database-type *umls-sql-type*))
 193   (clsql:create-database (list *umls-sql-host* (lookup-db-name *umls-sql-db*)
 194                                *umls-sql-user* *umls-sql-passwd*)
 195                          :database-type *umls-sql-type*)
 196   (ensure-ucols+ufiles)
 197   (ensure-preparse)
 198   (translate-all-files extension)
 199   (let ((copy-cmd
 200          (ecase (umls-sql-type)
 201            (:mysql #'mysql-copy-cmd)
 202            (:postgresql #'pg-copy-cmd))))
 203     (with-sql-connection (conn)
 204       (sql-drop-tables conn)
 205       (sql-create-tables conn)
 206       (dolist (file *umls-files*)
 207         (sql-execute (funcall copy-cmd file extension) conn))
 208       (sql-create-indexes conn)
 209       (sql-create-custom-tables conn)
 210       (sql-create-indexes conn +custom-index-cols+)
 211       (sql-create-special-tables conn))))
 212
 213 (defun translate-all-files (&optional (extension ".trans"))
 214   "Copy translated files and return postgresql copy commands to import"
 215   (make-noneng-index-file extension)
 216   (dolist (f (remove "MRXW.NONENG" *umls-files* :test #'string= :key #'fil))
 217     (translate-umls-file f extension)))
 218
 219 (defun translate-umls-file (file extension)
 220   "Translate a umls file into a format suitable for sql copy cmd"
 221   (translate-files file extension (list file)))
 222
 223 (defun make-noneng-index-file (extension)
 224   "Make non-english index file"
 225   (translate-files (find-ufile "MRXW.NONENG")
 226                    extension (noneng-lang-index-files)))
 227
 228 (defun translate-files (out-ufile extension input-ufiles)
 229   "Translate a umls file into a format suitable for sql copy cmd"
 230   (let ((output-path (umls-pathname (fil out-ufile) extension)))
 231     (if (probe-file output-path)
 232         (format t "File ~A already exists: skipping~%" output-path)
 233       (with-open-file (ostream output-path :direction :output)
 234         (dolist (input-ufile input-ufiles)
 235           (with-umls-file (line (fil input-ufile))
 236             (translate-line out-ufile line ostream)
 237             (princ #\newline ostream)))))))
 238
 239 (defun translate-line (file line strm)
 240   "Translate a single line for sql output"
 241   (flet ((col-value (col value)
 242            (if (eq (datatype col) 'sql-u)
 243                (let ((ui (parse-ui value "")))
 244                  (if (stringp ui)
 245                      ui
 246                      (write-to-string ui)))
 247                (escape-backslashes value))))
 248     (print-separated-strings
 249      strm "|"
 250      (mapcar #'col-value (remove-custom-cols (ucols file)) line)
 251      (custom-col-values (custom-ucols-for-file file) line nil))))
 252
 253 (defun pg-copy-cmd (file extension)
 254   "Return postgresql copy statement for a file"
 255   (format
 256    nil "COPY ~a FROM '~a' using delimiters '|' with null as ''"
 257    (table file) (umls-pathname (fil file) extension)))
 258
 259 (defun mysql-copy-cmd (file extension)
 260   "Return mysql copy statement for a file"
 261   (format
 262    nil
 263    "LOAD DATA LOCAL INFILE \"~a\" INTO TABLE ~a FIELDS TERMINATED BY \"|\""
 264    (umls-pathname (fil file) extension) (table file)))
 265
 266
 267 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 268 ;;;
 269 ;;; Routines for analyzing cost of fixed size storage
 270 ;;;
 271 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 272
 273 (defun umls-fixed-size-waste ()
 274   "Display storage waste if using all fixed size storage"
 275   (let ((totalwaste 0)
 276         (totalunavoidable 0)
 277         (totalavoidable 0)
 278         (unavoidable '())
 279         (avoidable '()))
 280     (dolist (file *umls-files*)
 281       (dolist (col (ucols file))
 282         (let* ((avwaste (- (cmax col) (av col)))
 283                (cwaste (* avwaste (rws file))))
 284           (when (plusp cwaste)
 285             (if (<= avwaste 6)
 286                 (progn
 287                   (incf totalunavoidable cwaste)
 288                   (push (list (fil file) (col col)
 289                               avwaste cwaste)
 290                         unavoidable))
 291                 (progn
 292                   (incf totalavoidable cwaste)
 293                   (push (list (fil file) (col col)
 294                               avwaste cwaste)
 295                         avoidable)))
 296             (incf totalwaste cwaste)))))
 297     (values totalwaste totalavoidable totalunavoidable
 298             (nreverse avoidable) (nreverse unavoidable))))
 299
 300 (defun display-waste ()
 301   (ensure-ucols+ufiles)
 302   (multiple-value-bind (tw ta tu al ul) (umls-fixed-size-waste)
 303     (format t "Total waste: ~d~%" tw)
 304     (format t "Total avoidable: ~d~%" ta)
 305     (format t "Total unavoidable: ~d~%" tu)
 306     (format t "Avoidable:~%")
 307     (dolist (w al)
 308       (format t "  (~a,~a): ~a,~a~%" (car w) (cadr w) (caddr w) (cadddr w)))
 309     (format t "Unavoidable:~%")
 310     (dolist (w ul)
 311       (format t "  (~a,~a): ~a,~a~%" (car w) (cadr w) (caddr w) (cadddr w)))
 312     ))
 313
 314 (defun max-umls-field ()
 315   "Return length of longest field"
 316   (declare (optimize (speed 3) (space 0)))
 317   (ensure-ucols+ufiles)
 318   (let ((max 0))
 319     (declare (fixnum max))
 320     (dolist (ucol *umls-cols*)
 321       (when (> (cmax ucol) max)
 322         (setq max (cmax ucol))))
 323     max))
 324
 325 (defun max-umls-row ()
 326   "Return length of longest row"
 327   (declare (optimize (speed 3) (space 0)))
 328   (ensure-ucols+ufiles)
 329   (let ((rowsizes '()))
 330     (dolist (file *umls-files*)
 331       (let ((row 0))
 332         (dolist (ucol (ucols file))
 333           (incf row (1+ (cmax ucol))))
 334         (push row rowsizes)))
 335     (car (sort rowsizes #'>))))