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