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 ;;;; Created:  Apr 2000
   9 ;;;;
  10 ;;;; $Id$
  11 ;;;;
  12 ;;;; This file, part of UMLisp, is
  13 ;;;;    Copyright (c) 2000-2006 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              (case *umls-sql-type*
  27                (:oracle
  28                 (cond
  29                  ((string-equal sqltype "VARCHAR")
  30                   (setq sqltype "VARCHAR2"))
  31                  ((string-equal sqltype "BIGINT")
  32                   (setq sqltype "VARCHAR2(20)")))))
  33
  34              (concatenate 'string
  35                (col c)
  36                " "
  37                (if (or (string-equal sqltype "VARCHAR")
  38                        (string-equal sqltype "CHAR"))
  39                    (format nil "~a (~a)" sqltype (cmax c))
  40                  sqltype))))))
  41     (format nil "CREATE TABLE ~a (~{~a~^,~})~A~A"
  42             (table file)
  43             (mapcar col-func (ucols file))
  44             (if (and (eq *umls-sql-type* :mysql)
  45                      (string-equal (table file) "MRCXT"))
  46                 " MAX_ROWS=200000000"
  47               "")
  48             (if (eq *umls-sql-type* :mysql)
  49                 " TYPE=MYISAM CHARACTER SET utf8"
  50                 ""))))
  51
  52 (defun create-custom-table-cmd (tablename sql-cmd)
  53   "Return SQL command to create a custom table"
  54   (format nil "CREATE TABLE ~a AS ~a;" tablename sql-cmd))
  55
  56 (defun insert-col-value (col value)
  57   (if (null (parse-fun col))
  58       value
  59       (format nil "~A" (funcall (parse-fun col) value))))
  60
  61 (defun insert-values-cmd (file values)
  62   "Return sql insert command for a row of values"
  63   (let ((insert-func
  64          (lambda (col value)
  65            (concatenate 'string (quote-str col)
  66                         (insert-col-value col value)
  67                         (quote-str col)))))
  68     (format
  69      nil "INSERT INTO ~a (~{~a~^,~}) VALUES (~A)"
  70      (table file)
  71      (fields file)
  72      (concat-separated-strings
  73       ","
  74       (mapcar insert-func (remove-custom-cols (ucols file)) values)
  75       (custom-col-values (custom-ucols-for-file file) values t)))))
  76
  77
  78 (defun custom-col-value (col values doquote)
  79   (let ((custom-value (funcall (custom-value-fun col) values)))
  80     (if custom-value
  81         (if doquote
  82             (concatenate 'string (quote-str col)
  83                          (escape-backslashes custom-value)
  84                          (quote-str col))
  85             (escape-backslashes custom-value))
  86         "")))
  87
  88 (defun custom-col-values (ucols values doquote)
  89   "Returns a list of string column values for SQL inserts for custom columns"
  90   (loop for col in ucols collect (custom-col-value col values doquote)))
  91
  92 (defun remove-custom-cols (cols)
  93   "Remove custom cols from a list col umls-cols"
  94   (remove-if #'custom-value-fun cols))
  95
  96 (defun find-custom-cols-for-filename (filename)
  97   (remove-if-not (lambda (x) (string-equal filename (car x))) +custom-cols+))
  98
  99 (defun find-custom-col (filename col)
 100   (find-if (lambda (x) (and (string-equal filename (car x))
 101                             (string-equal col (cadr x)))) +custom-cols+))
 102
 103 (defun custom-colnames-for-filename (filename)
 104   (mapcar #'cadr (find-custom-cols-for-filename filename)))
 105
 106 (defun custom-ucols-for-file (file)
 107   (remove-if-not #'custom-value-fun (ucols file)))
 108
 109 (defun noneng-lang-index-files ()
 110   (remove-if-not
 111    (lambda (f) (and (> (length (fil f)) 4)
 112                     (string-equal (fil f) "MRXW_" :end1 5)
 113                     (not (string-equal (fil f) "MRXW_ENG.RRF"))
 114                     (not (string-equal (fil f) "MRXW_NONENG.RRF"))))
 115    *umls-files*))
 116
 117 ;;; SQL Command Functions
 118
 119 (defun create-index-cmd (colname tablename length)
 120   "Return sql create index command"
 121   (format nil "CREATE INDEX ~a ON ~a (~a)"
 122           (concatenate 'string tablename "_" colname "_X")
 123           tablename
 124           (case *umls-sql-type*
 125             (:mysql
 126              (concatenate 'string colname
 127                           (if (integerp length)
 128                               (format nil " (~d)" length)
 129                               "")))
 130             ((:postgresql :postgresql-socket)
 131              ;; FIXME: incorrect syntax for postgresql?
 132              (if (integerp length)
 133                  (format nil "substr((~A)::text,1,~D)" colname length)
 134                  colname))
 135             (t
 136              colname))))
 137
 138 (defun create-all-tables-cmdfile ()
 139   "Return sql commands to create all tables. Not need for automated SQL import"
 140   (mapcar (lambda (f) (format nil "~a~%~%" (create-table-cmd f))) *umls-files*))
 141
 142 ;; SQL Execution functions
 143
 144 (defun sql-drop-tables (conn)
 145   "SQL Databases: drop all tables"
 146   (dolist (file *umls-files*)
 147     (ignore-errors
 148       (sql-execute (format nil "DROP TABLE ~a" (table file)) conn))))
 149
 150 (defun sql-create-tables (conn)
 151   "SQL Databases: create all tables"
 152   (dolist (file *umls-files*)
 153     (sql-execute (create-table-cmd file) conn)))
 154
 155 #+ignore
 156 (defun sql-create-kcon-table (conn)
 157   "Create concept table, one row per concept."
 158   (ignore-errors (execute-command "DROP TABLE KCON" :database conn))
 159   (execute-command
 160    (format nil "CREATE TABLE KCON (CUI INTEGER, STR ~A, LRL ~A)"
 161            (case *umls-sql-type*
 162              (:oracle
 163               (format nil "VARCHAR2(~D)"
 164                       (slot-value (find-ucol "STR" "MRCONSO.RRF") 'max)))
 165              (t "TEXT"))
 166            (case *umls-sql-type*
 167              (:mysql "TINYINT")
 168              ((:postgresql :postgresql-socket) "INT2")
 169              (:oracle "NUMBER(2,0)")
 170              (t "INTEGER")))
 171    :database conn)
 172   ;; KCON deprecated by KPFENG field in MRCONSO
 173   #+nil
 174   (dolist (tuple (query "select distinct cui from MRCONSO order by cui"
 175                         :database conn))
 176     (let ((cui (car tuple)))
 177       (execute-command
 178        (format nil "INSERT into KCON VALUES (~D,'~A',~D)"
 179                cui
 180                (add-sql-quotes (pfstr-hash cui) )
 181                (cui-lrl cui))
 182        :database conn))))
 183
 184 (defun sql-create-custom-tables (conn)
 185   "SQL Databases: create all custom tables"
 186   ;;(sql-create-kcon-table conn)
 187   (dolist (ct +custom-tables+)
 188     (sql-execute (create-custom-table-cmd (car ct) (cadr ct)) conn)))
 189
 190 (defun sql-insert-values (conn file)
 191   "SQL Databases: inserts all values for a file"
 192   (with-umls-file (line (fil file))
 193     (sql-execute (insert-values-cmd file line) conn)))
 194
 195 (defun sql-insert-all-values (conn)
 196   "SQL Databases: inserts all values for all files"
 197   (dolist (file *umls-files*)
 198     (sql-insert-values conn file)))
 199
 200 (defun drop-index-cmd (colname tablename)
 201   "Return sql create index command"
 202   (case *umls-sql-type*
 203     (:mysql
 204      (format nil "DROP INDEX ~a ON ~a"
 205              (concatenate 'string tablename "_" colname "_X")
 206              tablename))
 207     (t
 208      (format nil "DROP INDEX ~a"
 209              (concatenate 'string tablename "_" colname "_X")))))
 210
 211 (defun sql-create-indexes (conn &key (indexes +index-cols+) verbose)
 212   "SQL Databases: create all indexes"
 213   (dolist (idx indexes)
 214     (when verbose (format t "UMLS Import: Creating index ~S.~%" idx))
 215     (ignore-errors (sql-execute (drop-index-cmd (car idx) (cadr idx)) conn))
 216     (sql-execute (create-index-cmd (car idx) (cadr idx) (caddr idx)) conn)))
 217
 218 (defun make-usrl (conn)
 219   (if (eql :mysql *umls-sql-type*)
 220       (sql-execute "drop table if exists USRL" conn)
 221       (ignore-errors (sql-execute "drop table USRL" conn)))
 222   (sql-execute "create table USRL (sab varchar(80), srl integer)" conn)
 223   (dolist (tuple (mutex-sql-query
 224                   "select distinct SAB,SRL from MRCONSO order by SAB asc"))
 225     (sql-execute (format nil "insert into USRL (sab,srl) values ('~a',~d)"
 226                          (car tuple) (ensure-integer (cadr tuple)))
 227                  conn)))
 228
 229 (defun sql-create-special-tables (conn)
 230   (make-usrl conn)
 231   (make-ustats))
 232
 233 (defun create-umls-db-by-insert (&key verbose)
 234   "SQL Databases: initializes entire database via SQL insert commands"
 235   (ensure-ucols+ufiles)
 236   (ensure-preparse)
 237   (with-sql-connection (conn)
 238     (sql-drop-tables conn)
 239     (sql-create-tables conn)
 240     (sql-insert-all-values conn)
 241     (sql-create-indexes conn)
 242     (sql-create-custom-tables conn)
 243     (sql-create-indexes conn :indexes +custom-index-cols+ :verbose verbose)
 244     (sql-create-special-tables conn)))
 245
 246 (defun create-umls-db (&key (extension "-trans") (force-translation nil) (verbose nil))
 247   "SQL Databases: initializes entire database via SQL copy commands.
 248 This is much faster that using create-umls-db-insert."
 249   (when verbose (format t "UMLS Import: Starting.~%"))
 250   (ensure-ucols+ufiles)
 251   (when verbose (format t "UMLS Import: Preparsing files.~%"))
 252   (ensure-preparse)
 253   (when verbose (format t "UMLS Import: Converting text UMLS files to optimized format.~%"))
 254   (translate-all-files :extension extension :verbose verbose :force force-translation)
 255   (let ((copy-cmd
 256          (ecase (umls-sql-type)
 257            (:mysql #'mysql-copy-cmd)
 258            (:postgresql #'pg-copy-cmd))))
 259     (with-sql-connection (conn)
 260       (clsql:truncate-database :database conn)
 261       (sql-drop-tables conn)
 262       (sql-create-tables conn)
 263       (dolist (file *umls-files*)
 264         (when verbose (format t "UMLS Import: Importing file ~A to SQL.~%" (fil file)))
 265         (sql-execute (funcall copy-cmd file extension) conn))
 266       (When verbose (format t "UMLS Import: Creating SQL indices.~%"))
 267       (sql-create-indexes conn :verbose verbose)
 268       (When verbose (format t "UMLS Import: Creating custom tables.~%"))
 269       (sql-create-custom-tables conn)
 270       (When verbose (format t "UMLS Import: Creating custom indices.~%"))
 271       (sql-create-indexes conn :indexes +custom-index-cols+ :verbose verbose)
 272       (When verbose (format t "UMLS Import: Creating special tables.~%"))
 273       (sql-create-special-tables conn)))
 274   (When verbose (format t "UMLS Import: Completed.~%"))
 275   t)
 276
 277 (defun translate-all-files (&key (extension "-trans") verbose force)
 278   "Translate all *umls-files* to optimized import format."
 279   (make-noneng-index-file extension)
 280   (dolist (f (remove "MRXW_NONENG.RRF" *umls-files* :test #'string= :key #'fil))
 281     (when verbose (format t "UMLS Import: translating file ~S.~%" (fil f)))
 282     (translate-umls-file f extension :force force)))
 283
 284 (defun translate-umls-file (file extension &key force)
 285   "Translate a umls file into a format suitable for sql copy cmd"
 286   (translate-files file extension (list file) :force force))
 287
 288 (defun make-noneng-index-file (extension &key force)
 289   "Make non-english index file"
 290   (translate-files (find-ufile "MRXW_NONENG.RRF")
 291                    extension (noneng-lang-index-files) :force force))
 292
 293 (defun verify-translation-file (output-path input-ufiles)
 294   "Returns t if translation file exists and is correct size. Warns and deletes incomplete translation file."
 295   (when (probe-file output-path)
 296     (let ((translated-lines 0)
 297           (input-lines 0)
 298           (eof (cons nil nil)))
 299       (catch 'done-counting
 300         (with-open-file (ts output-path :direction :input
 301                             #+(and clisp unicode) :external-format
 302                             #+(and clisp unicode) charset:utf-8)
 303           (do ()
 304               ((eq (read-line ts nil eof) eof))
 305             (incf translated-lines)))
 306         (dolist (input-ufile input-ufiles)
 307           (with-umls-ufile (line input-ufile)
 308                            (incf input-lines)
 309                            (when (> input-lines translated-lines)
 310                              (throw 'done-counting 'incomplete)))))
 311       (cond
 312         ((< input-lines translated-lines)
 313           (format t "Translated file ~A incomplete, deleting...~%" output-path)
 314           (delete-file output-path)
 315           nil)
 316         ((eql input-lines translated-lines)
 317           (format t "Translated file ~A already exists: skipping...~%" output-path)
 318           t)
 319         ((eql input-lines 0)
 320           (warn "The number of input lines is 0 for output file ~A." output-path)
 321           nil)
 322         ((> translated-lines input-lines)
 323           (error "Shouldn't happen. Translated lines of ~A is ~D, greater than input lines ~D"
 324                  output-path translated-lines input-lines)
 325           (delete-file output-path)
 326           nil)))))
 327
 328 (defun translate-files (out-ufile extension input-ufiles &key force)
 329   "Translate a umls file into a format suitable for sql copy cmd"
 330   (let ((output-path (ufile-pathname out-ufile extension)))
 331     (when (and (not force) (verify-translation-file output-path input-ufiles))
 332       (return-from translate-files output-path))
 333     (with-open-file (ostream output-path :direction :output
 334                              :if-exists :overwrite
 335                              #+(and clisp unicode) :external-format
 336                              #+(and clisp unicode) charset:utf-8)
 337       (dolist (input-ufile input-ufiles)
 338         (with-umls-ufile (line input-ufile)
 339           (translate-line out-ufile line ostream)
 340           (princ #\newline ostream))))))
 341
 342 (defun translate-line (file line strm)
 343   "Translate a single line for sql output"
 344   (flet ((col-value (col value)
 345            (if (eq (datatype col) 'sql-u)
 346                (let ((ui (parse-ui value "")))
 347                  (if (stringp ui)
 348                      ui
 349                      (write-to-string ui)))
 350                (escape-backslashes value))))
 351     (print-separated-strings
 352      strm "|"
 353      (mapcar #'col-value (remove-custom-cols (ucols file)) line)
 354      (custom-col-values (custom-ucols-for-file file) line nil))))
 355
 356 (defun pg-copy-cmd (file extension)
 357   "Return postgresql copy statement for a file"
 358   (format
 359    nil "COPY ~a FROM '~a' using delimiters '|' with null as ''"
 360    (table file) (ufile-pathname file extension)))
 361
 362 (defun mysql-copy-cmd (file extension &key (local-file t))
 363   "Return mysql copy statement for a file"
 364   (format
 365    nil
 366    "LOAD DATA ~AINFILE \"~a\" INTO TABLE ~a FIELDS TERMINATED BY \"|\""
 367    (if local-file "LOCAL " "")
 368    (namestring (ufile-pathname file extension)) (table file)))
 369
 370
 371 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 372 ;;;
 373 ;;; Routines for analyzing cost of fixed size storage
 374 ;;;
 375 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 376
 377 (defun umls-fixed-size-waste ()
 378   "Display storage waste if using all fixed size storage"
 379   (let ((totalwaste 0)
 380         (totalunavoidable 0)
 381         (totalavoidable 0)
 382         (unavoidable '())
 383         (avoidable '()))
 384     (dolist (file *umls-files*)
 385       (dolist (col (ucols file))
 386         (let* ((avwaste (- (cmax col) (av col)))
 387                (cwaste (* avwaste (rws file))))
 388           (when (plusp cwaste)
 389             (if (<= avwaste 6)
 390                 (progn
 391                   (incf totalunavoidable cwaste)
 392                   (push (list (fil file) (col col)
 393                               avwaste cwaste)
 394                         unavoidable))
 395                 (progn
 396                   (incf totalavoidable cwaste)
 397                   (push (list (fil file) (col col)
 398                               avwaste cwaste)
 399                         avoidable)))
 400             (incf totalwaste cwaste)))))
 401     (values totalwaste totalavoidable totalunavoidable
 402             (nreverse avoidable) (nreverse unavoidable))))
 403
 404 (defun display-waste ()
 405   (ensure-ucols+ufiles)
 406   (multiple-value-bind (tw ta tu al ul) (umls-fixed-size-waste)
 407     (format t "Total waste: ~d~%" tw)
 408     (format t "Total avoidable: ~d~%" ta)
 409     (format t "Total unavoidable: ~d~%" tu)
 410     (format t "Avoidable:~%")
 411     (dolist (w al)
 412       (format t "  (~a,~a): ~a,~a~%" (car w) (cadr w) (caddr w) (cadddr w)))
 413     (format t "Unavoidable:~%")
 414     (dolist (w ul)
 415       (format t "  (~a,~a): ~a,~a~%" (car w) (cadr w) (caddr w) (cadddr w)))
 416     ))
 417
 418 (defun max-umls-field ()
 419   "Return length of longest field"
 420   (declare (optimize (speed 3) (space 0)))
 421   (ensure-ucols+ufiles)
 422   (let ((max 0))
 423     (declare (fixnum max))
 424     (dolist (ucol *umls-cols*)
 425       (when (> (cmax ucol) max)
 426         (setq max (cmax ucol))))
 427     max))
 428
 429 (defun max-umls-row ()
 430   "Return length of longest row"
 431   (declare (optimize (speed 3) (space 0)))
 432   (ensure-ucols+ufiles)
 433   (let ((rowsizes '()))
 434     (dolist (file *umls-files*)
 435       (let ((row 0))
 436         (dolist (ucol (ucols file))
 437           (incf row (1+ (cmax ucol))))
 438         (push row rowsizes)))
 439     (car (sort rowsizes #'>))))