db-oracle/oracle-sql.lisp

   1 ;;;; -*- Mode: LISP; Syntax: ANSI-Common-Lisp; Base: 10 -*-
   2 ;;;; *************************************************************************
   3 ;;;; FILE IDENTIFICATION
   4 ;;;;
   5 ;;;; Name:          oracle-sql.lisp
   6 ;;;;
   7 ;;;; $Id$
   8 ;;;;
   9 ;;;; This file is part of CLSQL.
  10 ;;;;
  11 ;;;; CLSQL users are granted the rights to distribute and use this software
  12 ;;;; as governed by the terms of the Lisp Lesser GNU Public License
  13 ;;;; (http://opensource.franz.com/preamble.html), also known as the LLGPL.
  14 ;;;; *************************************************************************
  15
  16 (in-package #:clsql-oracle)
  17
  18 (defmethod database-initialize-database-type ((database-type (eql :oracle)))
  19   t)
  20
  21 ;;;; arbitrary parameters, tunable for performance or other reasons
  22
  23 (eval-when (:compile-toplevel :load-toplevel :execute)
  24   (defconstant +errbuf-len+ 512
  25     "the number of characters that we allocate for an error message buffer")
  26   (defconstant +n-buf-rows+ 200
  27     "the number of table rows that we buffer at once when reading a table.
  28 CMUCL has a compiled-in limit on how much C data can be allocated
  29 (through malloc() and friends) at any given time, typically 8 Mb.
  30 Setting this constant to a moderate value should make it less
  31 likely that we'll have to worry about the CMUCL limit."))
  32
  33
  34 (uffi:def-type vp-type :pointer-void)
  35 (uffi:def-type vpp-type (* :pointer-void))
  36
  37 (defmacro deref-vp (foreign-object)
  38   `(the vp-type (uffi:deref-pointer (the vpp-type ,foreign-object) :pointer-void)))
  39
  40 ;; constants - from OCI?
  41
  42 (defvar +unsigned-char-null-pointer+
  43   (uffi:make-null-pointer :unsigned-char))
  44 (defvar +unsigned-short-null-pointer+
  45   (uffi:make-null-pointer :unsigned-short))
  46 (defvar +unsigned-int-null-pointer+
  47   (uffi:make-null-pointer :unsigned-int))
  48
  49 (defconstant +var-not-in-list+       1007)
  50 (defconstant +no-data-found+         1403)
  51 (defconstant +null-value-returned+   1405)
  52 (defconstant +field-truncated+       1406)
  53
  54 (eval-when (:compile-toplevel :load-toplevel :execute)
  55   (defconstant SQLT-NUMBER 2)
  56   (defconstant SQLT-INT 3)
  57   (defconstant SQLT-FLT 4)
  58   (defconstant SQLT-STR 5)
  59   (defconstant SQLT-DATE 12))
  60
  61 ;;; Note that despite the suggestive class name (and the way that the
  62 ;;; *DEFAULT-DATABASE* variable holds an object of this class), a DB
  63 ;;; object is not actually a database but is instead a connection to a
  64 ;;; database. Thus, there's no obstacle to having any number of DB
  65 ;;; objects referring to the same database.
  66
  67 (uffi:def-type pointer-pointer-void '(* :pointer-void))
  68
  69 (defclass oracle-database (database)    ; was struct db
  70   ((envhp
  71     :reader envhp
  72     :initarg :envhp
  73     :type pointer-pointer-void
  74     :documentation
  75     "OCI environment handle")
  76    (errhp
  77     :reader errhp
  78     :initarg :errhp
  79     :type pointer-pointer-void
  80     :documentation
  81     "OCI error handle")
  82    (svchp
  83     :reader svchp
  84     :initarg :svchp
  85     :type pointer-pointer-void
  86     :documentation
  87     "OCI service context handle")
  88    (data-source-name
  89     :initarg :dsn
  90     :initform nil
  91     :documentation
  92     "optional data source name (used only for debugging/printing)")
  93    (user
  94     :initarg :user
  95     :reader user
  96     :type string
  97     :documentation
  98     "the \"user\" value given when data source connection was made")
  99    (date-format
 100     :initarg :date-format
 101     :reader date-format
 102     :initform "YYYY-MM-DD HH24:MI:SS\"+00\"")
 103    (date-format-length
 104     :type number
 105     :documentation
 106     "Each database connection can be configured with its own date
 107 output format.  In order to extract date strings from output buffers
 108 holding multiple date strings in fixed-width fields, we need to know
 109 the length of that format.")
 110    (server-version
 111     :type (or null string)
 112     :initarg :server-version
 113     :reader server-version
 114     :documentation
 115     "Version string of Oracle server.")
 116    (major-server-version
 117     :type (or null fixnum)
 118     :initarg :major-server-version
 119     :reader major-server-version
 120     :documentation
 121     "The major version number of the Oracle server, should be 8, 9, or 10")
 122    (client-version
 123     :type (or null string)
 124     :initarg :client-version
 125     :reader client-version
 126     :documentation
 127     "Version string of Oracle client.")
 128    (major-client-version
 129     :type (or null fixnum)
 130     :initarg :major-client-version
 131     :reader major-client-version
 132     :documentation
 133     "The major version number of the Oracle client, should be 8, 9, or 10")))
 134
 135
 136 ;;; Handle the messy case of return code=+oci-error+, querying the
 137 ;;; system for subcodes and reporting them as appropriate. ERRHP and
 138 ;;; NULLS-OK are as in the OERR function.
 139
 140 (defun handle-oci-error (&key database nulls-ok)
 141   (cond (database
 142          (with-slots (errhp) database
 143            (uffi:with-foreign-objects ((errbuf '(:array :unsigned-char
 144                                                  #.+errbuf-len+))
 145                                        (errcode :long))
 146              ;; ensure errbuf empty string
 147              (setf (uffi:deref-array errbuf '(:array :unsigned-char) 0)
 148                    (uffi:ensure-char-storable (code-char 0)))
 149
 150              (setf (uffi:deref-pointer errcode :long) 0)
 151              (uffi:with-cstring (sqlstate nil)
 152                (oci-error-get (deref-vp errhp) 1
 153                               sqlstate
 154                               errcode
 155                               (uffi:char-array-to-pointer errbuf)
 156                               +errbuf-len+ +oci-htype-error+))
 157              (let ((subcode (uffi:deref-pointer errcode :long)))
 158                (unless (and nulls-ok (= subcode +null-value-returned+))
 159                  (error 'sql-database-error
 160                         :database database
 161                         :error-id subcode
 162                         :message (uffi:convert-from-foreign-string errbuf)))))))
 163         (nulls-ok
 164          (error 'sql-database-error
 165                 :database database
 166                 :message "can't handle NULLS-OK without ERRHP"))
 167         (t
 168          (error 'sql-database-error
 169                 :database database
 170                 :message "OCI Error (and no ERRHP available to find subcode)"))))
 171
 172 ;;; Require an OCI success code.
 173 ;;;
 174 ;;; (The ordinary OCI error reporting mechanisms uses a fair amount of
 175 ;;; machinery (environments and other handles). In order to get to
 176 ;;; where we can use these mechanisms, we have to be able to allocate
 177 ;;; the machinery. The functions for allocating the machinery can
 178 ;;; return errors (e.g. out of memory) but shouldn't. Wrapping this function
 179 ;;; around function calls to such have-to-succeed functions enforces
 180 ;;; this condition.)
 181
 182 (defun osucc (code)
 183   (declare (type fixnum code))
 184   (unless (= code +oci-success+)
 185     (error 'sql-database-error
 186            :message (format nil "unexpected OCI failure, code=~S" code))))
 187
 188
 189 ;;; Enabling this can be handy for low-level debugging.
 190 #+nil
 191 (progn
 192   (trace oci-initialize #+oci-8-1-5 oci-env-create oci-handle-alloc oci-logon
 193          oci-error-get oci-stmt-prepare oci-stmt-execute
 194          oci-param-get oci-logon oci-attr-get oci-define-by-pos oci-stmt-fetch)
 195   (setf debug::*debug-print-length* nil))
 196
 197
 198 ;; Return the INDEXth string of the OCI array, represented as Lisp
 199 ;; SIMPLE-STRING. SIZE is the size of the fixed-width fields used by
 200 ;; Oracle to store strings within the array.
 201
 202 (uffi:def-type string-pointer (* :unsigned-char))
 203
 204 (defun deref-oci-string (arrayptr string-index size)
 205   (declare (type string-pointer arrayptr))
 206   (declare (type (mod #.+n-buf-rows+) string-index))
 207   (declare (type (and unsigned-byte fixnum) size))
 208   (let ((str (uffi:convert-from-foreign-string
 209               (uffi:make-pointer
 210                (+ (uffi:pointer-address arrayptr) (* string-index size))
 211                :unsigned-char))))
 212     (if (string-equal str "NULL") nil str)))
 213
 214 ;; the OCI library, part Z: no-longer used logic to convert from
 215 ;; Oracle's binary date representation to Common Lisp's native date
 216 ;; representation
 217
 218 #+nil
 219 (defvar +oci-date-bytes+ 7)
 220
 221 ;;; Return the INDEXth date in the OCI array, represented as
 222 ;;; a Common Lisp "universal time" (i.e. seconds since 1900).
 223
 224 #+nil
 225 (defun deref-oci-date (arrayptr index)
 226   (oci-date->universal-time (uffi:pointer-address
 227                              (uffi:deref-array arrayptr
 228                                                '(:array :unsigned-char)
 229                                                (* index +oci-date-bytes+)))))
 230 #+nil
 231 (defun oci-date->universal-time (oci-date)
 232   (declare (type (alien (* :unsigned-char)) oci-date))
 233   (flet (;; a character from OCI-DATE, interpreted as an unsigned byte
 234          (ub (i)
 235            (declare (type (mod #.+oci-date-bytes+) i))
 236            (mod (uffi:deref-array oci-date string-array i) 256)))
 237     (let* ((century (* (- (ub 0) 100) 100))
 238            (year    (+ century (- (ub 1) 100)))
 239            (month   (ub 2))
 240            (day     (ub 3))
 241            (hour    (1- (ub 4)))
 242            (minute  (1- (ub 5)))
 243            (second  (1- (ub 6))))
 244       (encode-universal-time second minute hour day month year))))
 245
 246
 247 (defmethod database-list-tables ((database oracle-database) &key owner)
 248   (let ((query
 249           (if owner
 250               (format nil
 251                       "select user_tables.table_name from user_tables,all_tables where user_tables.table_name=all_tables.table_name and all_tables.owner='~:@(~A~)'"
 252                       owner)
 253               "select table_name from user_tables")))
 254     (mapcar #'car (database-query query database nil nil))))
 255
 256
 257 (defmethod database-list-views ((database oracle-database) &key owner)
 258   (let ((query
 259           (if owner
 260               (format nil
 261                       "select user_views.view_name from user_views,all_views where user_views.view_name=all_views.view_name and all_views.owner='~:@(~A~)'"
 262                       owner)
 263               "select view_name from user_views")))
 264     (mapcar #'car
 265           (database-query query database nil nil))))
 266
 267 (defmethod database-list-indexes ((database oracle-database)
 268                                   &key (owner nil))
 269   (let ((query
 270           (if owner
 271               (format nil
 272                       "select user_indexes.index_name from user_indexes,all_indexes where user_indexes.index_name=all_indexes.index_name and all_indexes.owner='~:@(~A~)'"
 273                       owner)
 274               "select index_name from user_indexes")))
 275     (mapcar #'car (database-query query database nil nil))))
 276
 277 (defmethod database-list-table-indexes (table (database oracle-database)
 278                                         &key (owner nil))
 279   (let ((query
 280           (if owner
 281               (format nil
 282                       "select user_indexes.index_name from user_indexes,all_indexes where user_indexes.table_name='~A' and user_indexes.index_name=all_indexes.index_name and all_indexes.owner='~:@(~A~)'"
 283                       table owner)
 284               (format nil "select index_name from user_indexes where table_name='~A'"
 285                       table))))
 286     (mapcar #'car (database-query query database nil nil))))
 287
 288
 289 (defmethod database-list-attributes (table (database oracle-database) &key owner)
 290   (let ((query
 291           (if owner
 292               (format nil
 293                       "select user_tab_columns.column_name from user_tab_columns,all_tables where user_tab_columns.table_name='~A' and all_tables.table_name=user_tab_columns.table_name and all_tables.owner='~:@(~A~)'"
 294                       table owner)
 295               (format nil
 296                       "select column_name from user_tab_columns where table_name='~A'"
 297                       table))))
 298     (mapcar #'car (database-query query database nil nil))))
 299
 300 (defmethod database-attribute-type (attribute (table string)
 301                                          (database oracle-database)
 302                                          &key (owner nil))
 303   (let ((query
 304          (if owner
 305              (format nil
 306                      "select data_type,data_length,data_scale,nullable from user_tab_columns,all_tables where user_tab_columns.table_name='~A' and column_name='~A' and all_tables.table_name=user_tab_columns.table_name and all_tables.owner='~:@(~A~)'"
 307                      table attribute owner)
 308              (format nil
 309                      "select data_type,data_length,data_scale,nullable from user_tab_columns where table_name='~A' and column_name='~A'"
 310                      table attribute))))
 311     (destructuring-bind (type length scale nullable) (car (database-query query database :auto nil))
 312       (values (ensure-keyword type) length scale
 313               (if (char-equal #\Y (schar nullable 0)) 1 0)))))
 314
 315 ;; Return one row of the table referred to by QC, represented as a
 316 ;; list; or if there are no more rows, signal an error if EOF-ERRORP,
 317 ;; or return EOF-VALUE otherwise.
 318
 319 ;; KLUDGE: This CASE statement is a strong sign that the code would be
 320 ;; cleaner if CD were made into an abstract class, we made variant
 321 ;; classes for CD-for-column-of-strings, CD-for-column-of-floats,
 322 ;; etc., and defined virtual functions to handle operations like
 323 ;; get-an-element-from-column. (For a small special purpose module
 324 ;; like this, would arguably be overkill, so I'm not going to do it
 325 ;; now, but if this code ends up getting more complicated in
 326 ;; maintenance, it would become a really good idea.)
 327
 328 ;; Arguably this would be a good place to signal END-OF-FILE, but
 329 ;; since the ANSI spec specifically says that END-OF-FILE means a
 330 ;; STREAM which has no more data, and QC is not a STREAM, we signal
 331 ;; DBI-ERROR instead.
 332
 333 (uffi:def-type short-array '(:array :short))
 334 (uffi:def-type int-pointer '(* :int))
 335 (uffi:def-type double-pointer '(* :double))
 336
 337 ;;; the result of a database query: a cursor through a table
 338 (defstruct (oracle-result-set (:print-function print-query-cursor)
 339                               (:conc-name qc-)
 340                               (:constructor %make-query-cursor))
 341   (db (error "missing DB")   ; db conn. this table is associated with
 342     :type oracle-database
 343     :read-only t)
 344   (stmthp (error "missing STMTHP")      ; the statement handle used to create
 345 ;;  :type alien                 ; this table. owned by the QUERY-CURSOR
 346     :read-only t)                       ; object, deallocated on CLOSE-QUERY
 347   (cds) ;  (error "missing CDS")            ; column descriptors
 348 ;    :type (simple-array cd 1)
 349                                         ;    :read-only t)
 350   (n-from-oci
 351    0                         ; buffered rows: number of rows recv'd
 352    :type (integer 0 #.+n-buf-rows+))   ; from the database on the last read
 353   (n-to-dbi
 354    0                           ; number of buffered rows returned, i.e.
 355    :type (integer 0 #.+n-buf-rows+))   ; the index, within the buffered rows,
 356                                         ; of the next row which hasn't already
 357                                         ; been returned
 358   (total-n-from-oci
 359    0                   ; total number of bytes recv'd from OCI
 360    :type unsigned-byte)                ; in all reads
 361   (oci-end-seen-p nil))                 ; Have we seen the end of OCI
 362                                         ; data, i.e. OCI returning
 363                                         ; less data than we requested?
 364                                         ; OCI doesn't seem to like us
 365                                         ; to try to read more data
 366                                         ; from it after that..
 367
 368
 369 (defun fetch-row (qc &optional (eof-errorp t) eof-value)
 370   ;;(declare (optimize (speed 3)))
 371   (cond ((zerop (qc-n-from-oci qc))
 372          (if eof-errorp
 373              (error 'sql-database-error :message
 374                     (format nil "no more rows available in ~S" qc))
 375            eof-value))
 376         ((>= (qc-n-to-dbi qc)
 377              (qc-n-from-oci qc))
 378          (refill-qc-buffers qc)
 379          (fetch-row qc nil eof-value))
 380         (t
 381          (let ((cds (qc-cds qc))
 382                (reversed-result nil)
 383                (irow (qc-n-to-dbi qc)))
 384            (dotimes (icd (length cds))
 385              (let* ((cd (aref cds icd))
 386                     (b (foreign-resource-buffer (cd-buffer cd)))
 387                     (value
 388                      (let* ((arb (foreign-resource-buffer (cd-indicators cd)))
 389                             (indicator (uffi:deref-array arb '(:array :short) irow)))
 390                        ;;(declare (type short-array arb))
 391                        (unless (= indicator -1)
 392                          (ecase (cd-oci-data-type cd)
 393                            (#.SQLT-STR
 394                             (deref-oci-string b irow (cd-sizeof cd)))
 395                            (#.SQLT-FLT
 396                             (uffi:deref-array b '(:array :double) irow))
 397                            (#.SQLT-INT
 398                             (uffi:deref-array b '(:array :int) irow))
 399                            (#.SQLT-DATE
 400                             (deref-oci-string b irow (cd-sizeof cd))))))))
 401                (when (and (eq :string (cd-result-type cd))
 402                           value
 403                           (not (stringp value)))
 404                    (setq value (write-to-string value)))
 405                (push value reversed-result)))
 406            (incf (qc-n-to-dbi qc))
 407            (nreverse reversed-result)))))
 408
 409 (defun refill-qc-buffers (qc)
 410   (with-slots (errhp) (qc-db qc)
 411     (setf (qc-n-to-dbi qc) 0)
 412     (cond ((qc-oci-end-seen-p qc)
 413            (setf (qc-n-from-oci qc) 0))
 414           (t
 415            (let ((oci-code (%oci-stmt-fetch
 416                             (deref-vp (qc-stmthp qc))
 417                             (deref-vp errhp)
 418                             +n-buf-rows+
 419                             +oci-fetch-next+ +oci-default+)))
 420              (ecase oci-code
 421                (#.+oci-success+ (values))
 422                (#.+oci-no-data+ (setf (qc-oci-end-seen-p qc) t)
 423                                 (values))
 424                (#.+oci-error+ (handle-oci-error :database (qc-db qc)
 425                                                 :nulls-ok t))))
 426            (uffi:with-foreign-object (rowcount :long)
 427              (oci-attr-get (deref-vp (qc-stmthp qc))
 428                            +oci-htype-stmt+
 429                            rowcount
 430                            +unsigned-int-null-pointer+
 431                            +oci-attr-row-count+
 432                            (deref-vp errhp))
 433              (setf (qc-n-from-oci qc)
 434                    (- (uffi:deref-pointer rowcount :long)
 435                       (qc-total-n-from-oci qc)))
 436              (when (< (qc-n-from-oci qc) +n-buf-rows+)
 437                (setf (qc-oci-end-seen-p qc) t))
 438              (setf (qc-total-n-from-oci qc)
 439                    (uffi:deref-pointer rowcount :long)))))
 440     (values)))
 441
 442 ;; the guts of the SQL function
 443 ;;
 444 ;; (like the SQL function, but with the QUERY argument hardwired to T, so
 445 ;; that the return value is always a cursor instead of a list)
 446
 447 ;; Is this a SELECT statement?  SELECT statements are handled
 448 ;; specially by OCIStmtExecute().  (Non-SELECT statements absolutely
 449 ;; require a nonzero iteration count, while the ordinary choice for a
 450 ;; SELECT statement is a zero iteration count.
 451
 452 ;; SELECT statements are the only statements which return tables.  We
 453 ;; don't free STMTHP in this case, but instead give it to the new
 454 ;; QUERY-CURSOR, and the new QUERY-CURSOR becomes responsible for
 455 ;; freeing the STMTHP when it is no longer needed.
 456
 457 (defun sql-stmt-exec (sql-stmt-string db result-types field-names)
 458   (with-slots (envhp svchp errhp)
 459     db
 460     (let ((stmthp (uffi:allocate-foreign-object :pointer-void)))
 461       (uffi:with-foreign-object (stmttype :unsigned-short)
 462
 463         (oci-handle-alloc (deref-vp envhp)
 464                           stmthp
 465                           +oci-htype-stmt+ 0 +null-void-pointer-pointer+)
 466         (oci-stmt-prepare (deref-vp stmthp)
 467                           (deref-vp errhp)
 468                           (uffi:convert-to-cstring sql-stmt-string)
 469                           (length sql-stmt-string)
 470                           +oci-ntv-syntax+ +oci-default+ :database db)
 471         (oci-attr-get (deref-vp stmthp)
 472                       +oci-htype-stmt+
 473                       stmttype
 474                       +unsigned-int-null-pointer+
 475                       +oci-attr-stmt-type+
 476                       (deref-vp errhp)
 477                       :database db)
 478         (let* ((select-p (= (uffi:deref-pointer stmttype :unsigned-short) 1))
 479                (iters (if select-p 0 1)))
 480
 481           (oci-stmt-execute (deref-vp svchp)
 482                             (deref-vp stmthp)
 483                             (deref-vp errhp)
 484                             iters 0 +null-void-pointer+ +null-void-pointer+ +oci-default+
 485                             :database db)
 486           (cond (select-p
 487                  (make-query-cursor db stmthp result-types field-names))
 488                 (t
 489                  (oci-handle-free (deref-vp stmthp) +oci-htype-stmt+)
 490                  nil)))))))
 491
 492
 493 ;; Return a QUERY-CURSOR representing the table returned from the OCI
 494 ;; operation done through STMTHP.  TYPES is the argument of the same
 495 ;; name from the external SQL function, controlling type conversion
 496 ;; of the returned arguments.
 497
 498 (defun make-query-cursor (db stmthp result-types field-names)
 499   (let ((qc (%make-query-cursor :db db
 500                                 :stmthp stmthp
 501                                 :cds (make-query-cursor-cds db stmthp
 502                                                             result-types
 503                                                             field-names))))
 504     (refill-qc-buffers qc)
 505     qc))
 506
 507
 508 ;; the hairy part of MAKE-QUERY-CURSOR: Ask OCI for information
 509 ;; about table columns, translate the information into a Lisp
 510 ;; vector of column descriptors, and return it.
 511
 512 ;; Allegro defines several flavors of type conversion, but this
 513 ;; implementation only supports the :AUTO flavor.
 514
 515 ;; A note of explanation: OCI's internal number format uses 21
 516 ;; bytes (42 decimal digits). 2 separate (?) one-byte fields,
 517 ;; scale and precision, are used to deduce the nature of these
 518 ;; 21 bytes. See pp. 3-10, 3-26, and 6-13 of OCI documentation
 519 ;; for more details.
 520
 521 ;; When calling OCI C code to handle the conversion, we have
 522 ;; only two numeric types available to pass the return value:
 523 ;; double-float and signed-long. It would be possible to
 524 ;; bypass the OCI conversion functions and write Lisp code
 525 ;; which reads the 21-byte field directly and decodes
 526 ;; it. However this is left as an exercise for the reader. :-)
 527
 528 ;; The following table describes the mapping, based on the implicit
 529 ;; assumption that C's "signed long" type is a 32-bit integer.
 530 ;;
 531 ;;   Internal Values                     SQL Type        C Return Type
 532 ;;   ===============                     ========        =============
 533 ;;   Precision > 0        SCALE = -127   FLOAT       --> double-float
 534 ;;   Precision > 0 && <=9 SCALE = 0      INTEGER     --> signed-long
 535 ;;   Precision = 0 || > 9 SCALE = 0      BIG INTEGER --> double-float
 536 ;;   Precision > 0        SCALE > 0      DECIMAL     --> double-float
 537
 538 ;; (OCI uses 1-based indexing here.)
 539
 540 ;; KLUDGE: This should work for all other data types except those
 541 ;; which don't actually fit in their fixed-width field (BLOBs and the
 542 ;; like). As Winton says, we (Cadabra) don't need to worry much about
 543 ;; those, since we can't reason with them, so we don't use them. But
 544 ;; for a more general application it'd be good to have a more
 545 ;; selective and rigorously correct test here for whether we can
 546 ;; actually handle the given DEREF-DTYPE value. -- WHN 20000106
 547
 548 ;; Note: The OCI documentation doesn't seem to say whether the COLNAME
 549 ;; value returned here is a newly-allocated copy which we're
 550 ;; responsible for freeing, or a pointer into some system copy which
 551 ;; will be freed when the system itself is shut down.  But judging
 552 ;; from the way that the result is used in the cdemodsa.c example
 553 ;; program, it looks like the latter: we should make our own copy of
 554 ;; the value, but not try to free it.
 555
 556 ;; WORKAROUND: OCI seems to return ub2 values for the
 557 ;; +oci-attr-data-size+ attribute even though its documentation claims
 558 ;; that it returns a ub4, and even though the associated "sizep" value
 559 ;; is 4, not 2.  In order to make the code here work reliably, without
 560 ;; having to patch it later if OCI is ever fixed to match its
 561 ;; documentation, we pre-zero COLSIZE before making the call into OCI.
 562
 563 ;; To exercise the weird OCI behavior (thereby blowing up the code
 564 ;; below, beware!) try setting this value into COLSIZE, calling OCI,
 565 ;; then looking at the value in COLSIZE.  (setf colsize #x12345678)
 566 ;; debugging only
 567
 568
 569 (uffi:def-type byte-pointer (* :byte))
 570 (uffi:def-type ulong-pointer (* :unsigned-long))
 571 (uffi:def-type void-pointer-pointer (* :void-pointer))
 572
 573 (defun make-query-cursor-cds (database stmthp result-types field-names)
 574   (declare (optimize (safety 3) #+nil (speed 3))
 575            (type oracle-database database)
 576            (type pointer-pointer-void stmthp))
 577   (with-slots (errhp) database
 578     (uffi:with-foreign-objects ((dtype-foreign :unsigned-short)
 579                                 (parmdp :pointer-void)
 580                                 (precision :byte)
 581                                 (scale :byte)
 582                                 (colname '(* :unsigned-char))
 583                                 (colnamelen :unsigned-long)
 584                                 (colsize :unsigned-long)
 585                                 (colsizesize :unsigned-long)
 586                                 (defnp ':pointer-void))
 587       (let ((buffer nil)
 588             (sizeof nil))
 589         (do ((icolumn 0 (1+ icolumn))
 590              (cds-as-reversed-list nil))
 591             ((not (eql (oci-param-get (deref-vp stmthp)
 592                                       +oci-htype-stmt+
 593                                       (deref-vp errhp)
 594                                       parmdp
 595                                       (1+ icolumn) :database database)
 596                        +oci-success+))
 597              (coerce (reverse cds-as-reversed-list) 'simple-vector))
 598           ;; Decode type of ICOLUMNth column into a type we're prepared to
 599           ;; handle in Lisp.
 600           (oci-attr-get (deref-vp parmdp)
 601                         +oci-dtype-param+
 602                         dtype-foreign
 603                         +unsigned-int-null-pointer+
 604                         +oci-attr-data-type+
 605                         (deref-vp errhp))
 606           (let ((dtype (uffi:deref-pointer dtype-foreign :unsigned-short)))
 607             (declare (fixnum dtype))
 608             (case dtype
 609               (#.SQLT-DATE
 610                (setf buffer (acquire-foreign-resource :unsigned-char
 611                                                       (* 32 +n-buf-rows+)))
 612                (setf sizeof 32 dtype #.SQLT-STR))
 613               (#.SQLT-NUMBER
 614                (oci-attr-get (deref-vp parmdp)
 615                              +oci-dtype-param+
 616                              precision
 617                              +unsigned-int-null-pointer+
 618                              +oci-attr-precision+
 619                              (deref-vp errhp))
 620                (oci-attr-get (deref-vp parmdp)
 621                              +oci-dtype-param+
 622                              scale
 623                              +unsigned-int-null-pointer+
 624                              +oci-attr-scale+
 625                              (deref-vp errhp))
 626                (let ((*scale (uffi:deref-pointer scale :byte))
 627                      (*precision (uffi:deref-pointer precision :byte)))
 628
 629                  ;; (format t "scale=~d, precision=~d~%" *scale *precision)
 630                  (cond
 631                   ((or (and (zerop *scale) (not (zerop *precision)))
 632                        (and (minusp *scale) (< *precision 10)))
 633                    (setf buffer (acquire-foreign-resource :int +n-buf-rows+)
 634                          sizeof 4                       ;; sizeof(int)
 635                          dtype #.SQLT-INT))
 636                   (t
 637                    (setf buffer (acquire-foreign-resource :double +n-buf-rows+)
 638                          sizeof 8                   ;; sizeof(double)
 639                          dtype #.SQLT-FLT)))))
 640               ;; Default to SQL-STR
 641               (t
 642                (setf (uffi:deref-pointer colsize :unsigned-long) 0)
 643                (setf dtype #.SQLT-STR)
 644                (oci-attr-get (deref-vp parmdp)
 645                              +oci-dtype-param+
 646                              colsize
 647                              +unsigned-int-null-pointer+
 648                              +oci-attr-data-size+
 649                              (deref-vp errhp))
 650                (let ((colsize-including-null (1+ (uffi:deref-pointer colsize :unsigned-long))))
 651                  (setf buffer (acquire-foreign-resource
 652                                :unsigned-char (* +n-buf-rows+ colsize-including-null)))
 653                  (setf sizeof colsize-including-null))))
 654             (let ((retcodes (acquire-foreign-resource :unsigned-short +n-buf-rows+))
 655                   (indicators (acquire-foreign-resource :short +n-buf-rows+))
 656                   (colname-string ""))
 657               (when field-names
 658                 (oci-attr-get (deref-vp parmdp)
 659                               +oci-dtype-param+
 660                               colname
 661                               colnamelen
 662                               +oci-attr-name+
 663                               (deref-vp errhp))
 664                 (setq colname-string (uffi:convert-from-foreign-string
 665                                       (uffi:deref-pointer colname '(* :unsigned-char))
 666                                       :length (uffi:deref-pointer colnamelen :unsigned-long))))
 667               (push (make-cd :name colname-string
 668                              :sizeof sizeof
 669                              :buffer buffer
 670                              :oci-data-type dtype
 671                              :retcodes retcodes
 672                              :indicators indicators
 673                              :result-type (cond
 674                                            ((consp result-types)
 675                                             (nth icolumn result-types))
 676                                            ((null result-types)
 677                                             :string)
 678                                            (t
 679                                             result-types)))
 680                     cds-as-reversed-list)
 681               (oci-define-by-pos (deref-vp stmthp)
 682                                  defnp
 683                                  (deref-vp errhp)
 684                                  (1+ icolumn) ; OCI 1-based indexing again
 685                                  (foreign-resource-buffer buffer)
 686                                  sizeof
 687                                  dtype
 688                                  (foreign-resource-buffer indicators)
 689                                  +unsigned-short-null-pointer+
 690                                  (foreign-resource-buffer retcodes)
 691                                  +oci-default+))))))))
 692
 693 ;; Release the resources associated with a QUERY-CURSOR.
 694
 695 (defun close-query (qc)
 696   (oci-handle-free (deref-vp (qc-stmthp qc)) +oci-htype-stmt+)
 697   (let ((cds (qc-cds qc)))
 698     (dotimes (i (length cds))
 699       (release-cd-resources (aref cds i))))
 700   (values))
 701
 702
 703 ;; Release the resources associated with a column description.
 704
 705 (defun release-cd-resources (cd)
 706   (free-foreign-resource (cd-buffer cd))
 707   (free-foreign-resource (cd-retcodes cd))
 708   (free-foreign-resource (cd-indicators cd))
 709   (values))
 710
 711
 712 (defmethod database-name-from-spec (connection-spec (database-type (eql :oracle)))
 713   (check-connection-spec connection-spec database-type (dsn user password))
 714   (destructuring-bind (dsn user password) connection-spec
 715     (declare (ignore password))
 716     (concatenate 'string  dsn "/" user)))
 717
 718
 719 (defmethod database-connect (connection-spec (database-type (eql :oracle)))
 720   (check-connection-spec connection-spec database-type (dsn user password))
 721   (destructuring-bind (data-source-name user password)
 722       connection-spec
 723     (let ((envhp (uffi:allocate-foreign-object :pointer-void))
 724           (errhp (uffi:allocate-foreign-object :pointer-void))
 725           (svchp (uffi:allocate-foreign-object :pointer-void))
 726           (srvhp (uffi:allocate-foreign-object :pointer-void)))
 727       ;; Requests to allocate environments and handles should never
 728       ;; fail in normal operation, and they're done too early to
 729       ;; handle errors very gracefully (since they're part of the
 730       ;; error-handling mechanism themselves) so we just assert they
 731       ;; work.
 732       (setf (deref-vp envhp) +null-void-pointer+)
 733       #+oci-8-1-5
 734       (progn
 735         (oci-env-create envhp +oci-default+  +null-void-pointer+
 736                         +null-void-pointer+  +null-void-pointer+
 737                         +null-void-pointer+ 0 +null-void-pointer-pointer+)
 738         (oci-handle-alloc envhp
 739                           (deref-vp errhp)
 740                           +oci-htype-error+ 0
 741                           +null-void-pointer-pointer+))
 742       #-oci-8-1-5
 743       (progn
 744         (oci-initialize +oci-object+ +null-void-pointer+ +null-void-pointer+
 745                         +null-void-pointer+ +null-void-pointer-pointer+)
 746         (ignore-errors (oci-handle-alloc +null-void-pointer+ envhp
 747                                          +oci-htype-env+ 0
 748                                          +null-void-pointer-pointer+)) ;no testing return
 749         (oci-env-init envhp +oci-default+ 0 +null-void-pointer-pointer+)
 750         (oci-handle-alloc (deref-vp envhp) errhp
 751                           +oci-htype-error+ 0 +null-void-pointer-pointer+)
 752         (oci-handle-alloc (deref-vp envhp) srvhp
 753                           +oci-htype-server+ 0 +null-void-pointer-pointer+)
 754         (uffi:with-cstring (dblink nil)
 755           (oci-server-attach (deref-vp srvhp)
 756                              (deref-vp errhp)
 757                              dblink
 758                              0 +oci-default+))
 759         (oci-handle-alloc (deref-vp envhp) svchp
 760                           +oci-htype-svcctx+ 0 +null-void-pointer-pointer+)
 761         (oci-attr-set (deref-vp svchp)
 762                       +oci-htype-svcctx+
 763                       (deref-vp srvhp) 0 +oci-attr-server+
 764                       (deref-vp errhp))
 765         ;; oci-handle-alloc((dvoid *)encvhp, (dvoid **)&stmthp, OCI_HTYPE_STMT, 0, 0);
 766         ;;#+nil
 767         )
 768       ;; Actually, oci-server-version returns the client version, not the server versions
 769       ;; will use "SELECT VERSION FROM V$INSTANCE" to get actual server version.
 770       (let (db server-version client-version)
 771         (declare (ignorable server-version))
 772         (uffi:with-foreign-object (buf '(:array :unsigned-char #.+errbuf-len+))
 773           (oci-server-version (deref-vp svchp)
 774                               (deref-vp errhp)
 775                               (uffi:char-array-to-pointer buf)
 776                               +errbuf-len+ +oci-htype-svcctx+)
 777           (setf client-version (uffi:convert-from-foreign-string buf))
 778           ;; This returns the client version, not the server version, so diable it
 779           #+ignore
 780           (oci-server-version (deref-vp srvhp)
 781                               (deref-vp errhp)
 782                               (uffi:char-array-to-pointer buf)
 783                               +errbuf-len+ +oci-htype-server+)
 784           #+ignore
 785           (setf server-version (uffi:convert-from-foreign-string buf)))
 786         (setq db (make-instance 'oracle-database
 787                                 :name (database-name-from-spec connection-spec
 788                                                                database-type)
 789                                 :connection-spec connection-spec
 790                                 :envhp envhp
 791                                 :errhp errhp
 792                                 :database-type :oracle
 793                                 :svchp svchp
 794                                 :dsn data-source-name
 795                                 :user user
 796                                 :client-version client-version
 797                                 :server-version server-version
 798                                 :major-client-version (major-client-version-from-string
 799                                                        client-version)
 800                                 :major-server-version (major-client-version-from-string
 801                                                        server-version)))
 802         (oci-logon (deref-vp envhp)
 803                    (deref-vp errhp)
 804                    svchp
 805                    (uffi:convert-to-cstring user) (length user)
 806                    (uffi:convert-to-cstring password) (length password)
 807                    (uffi:convert-to-cstring data-source-name) (length data-source-name)
 808                    :database db)
 809         ;; :date-format-length (1+ (length date-format)))))
 810         (setf (slot-value db 'clsql-sys::state) :open)
 811         (database-execute-command
 812          (format nil "ALTER SESSION SET NLS_DATE_FORMAT='~A'" (date-format db)) db)
 813         (let ((server-version
 814                (caar (database-query
 815                       "SELECT BANNER FROM V$VERSION WHERE BANNER LIKE '%Oracle%'" db nil nil))))
 816           (setf (slot-value db 'server-version) server-version
 817                 (slot-value db 'major-server-version) (major-client-version-from-string
 818                                                        server-version)))
 819         db))))
 820
 821
 822 (defun major-client-version-from-string (str)
 823   (cond
 824     ((search " 10g " str)
 825      10)
 826     ((search "Oracle9i " str)
 827      9)
 828     ((search "Oracle8" str)
 829      8)))
 830
 831 (defun major-server-version-from-string (str)
 832   (when (> (length str) 2)
 833     (cond
 834       ((string= "10." (subseq str 0 3))
 835        10)
 836       ((string= "9." (subseq str 0 2))
 837        9)
 838       ((string= "8." (subseq str 0 2))
 839        8))))
 840
 841
 842 ;; Close a database connection.
 843
 844 (defmethod database-disconnect ((database oracle-database))
 845   (osucc (oci-logoff (deref-vp (svchp database))
 846                      (deref-vp (errhp database))))
 847   (osucc (oci-handle-free (deref-vp (envhp database)) +oci-htype-env+))
 848   ;; Note: It's neither required nor allowed to explicitly deallocate the
 849   ;; ERRHP handle here, since it's owned by the ENVHP deallocated above,
 850   ;; and was therefore automatically deallocated at the same time.
 851   t)
 852
 853 ;;; Do the database operation described in SQL-STMT-STRING on database
 854 ;;; DB and, if the command is a SELECT, return a representation of the
 855 ;;; resulting table. The representation of the table is controlled by the
 856 ;;; QUERY argument:
 857 ;;;   * If QUERY is NIL, the table is returned as a list of rows, with
 858 ;;;     each row represented by a list.
 859 ;;;   * If QUERY is non-NIL, the result is returned as a QUERY-CURSOR
 860 ;;;     suitable for FETCH-ROW and CLOSE-QUERY
 861 ;;; The TYPES argument controls the type conversion method used
 862 ;;; to construct the table. The Allegro version supports several possible
 863 ;;; values for this argument, but we only support :AUTO.
 864
 865 (defmethod database-query (query-expression (database oracle-database) result-types field-names)
 866   (let ((cursor (sql-stmt-exec query-expression database result-types field-names)))
 867     ;; (declare (type (or query-cursor null) cursor))
 868     (if (null cursor) ; No table was returned.
 869         (values)
 870       (do ((reversed-result nil))
 871           (nil)
 872         (let* ((eof-value :eof)
 873                (row (fetch-row cursor nil eof-value)))
 874           (when (eq row eof-value)
 875             (close-query cursor)
 876             (if field-names
 877                 (return (values (nreverse reversed-result)
 878                                 (loop for cd across (qc-cds cursor)
 879                                     collect (cd-name cd))))
 880               (return (nreverse reversed-result))))
 881           (push row reversed-result))))))
 882
 883
 884 (defmethod database-create-sequence (sequence-name (database oracle-database))
 885   (execute-command
 886    (concatenate 'string "CREATE SEQUENCE " (sql-escape sequence-name))
 887    :database database))
 888
 889 (defmethod database-drop-sequence (sequence-name (database oracle-database))
 890   (execute-command
 891    (concatenate 'string "DROP SEQUENCE " (sql-escape sequence-name))
 892    :database database))
 893
 894 (defmethod database-sequence-next (sequence-name (database oracle-database))
 895   (caar
 896    (database-query
 897     (concatenate 'string "SELECT "
 898                  (sql-escape sequence-name)
 899                  ".NEXTVAL FROM dual"
 900                  )
 901     database :auto nil)))
 902
 903 (defmethod database-set-sequence-position (name position (database oracle-database))
 904   (without-interrupts
 905    (let* ((next (database-sequence-next name database))
 906           (incr (- position next)))
 907      (database-execute-command
 908       (format nil "ALTER SEQUENCE ~A INCREMENT BY ~D" name incr)
 909       database)
 910      (database-sequence-next name database)
 911      (database-execute-command
 912       (format nil "ALTER SEQUENCE ~A INCREMENT BY 1" name)
 913       database))))
 914
 915 (defmethod database-list-sequences ((database oracle-database) &key owner)
 916   (let ((query
 917          (if owner
 918              (format nil
 919                      "select user_sequences.sequence_name from user_sequences,all_sequences where user_sequences.sequence_name=all_sequences.sequence_name and all_sequences.sequence_owner='~:@(~A~)'"
 920                      owner)
 921              "select sequence_name from user_sequences")))
 922     (mapcar #'car (database-query query database nil nil))))
 923
 924 (defmethod database-execute-command (sql-expression (database oracle-database))
 925   (database-query sql-expression database nil nil)
 926   (when (database-autocommit database)
 927     (oracle-commit database))
 928   t)
 929
 930
 931 (defstruct (cd (:constructor make-cd)
 932                (:print-function print-cd))
 933   "a column descriptor: metadata about the data in a table"
 934
 935   ;; name of this column
 936   (name (error "missing NAME") :type simple-string :read-only t)
 937   ;; the size in bytes of a single element
 938   (sizeof (error "missing SIZE") :type fixnum :read-only t)
 939   ;; an array of +N-BUF-ROWS+ elements in C representation
 940   (buffer (error "Missing BUFFER")
 941           :type foreign-resource
 942           :read-only t)
 943   ;; an array of +N-BUF-ROWS+ OCI return codes in C representation.
 944   ;; (There must be one return code for every element of every
 945   ;; row in order to be able to represent nullness.)
 946   (retcodes (error "Missing RETCODES")
 947             :type foreign-resource
 948             :read-only t)
 949   (indicators (error "Missing INDICATORS")
 950               :type foreign-resource
 951               :read-only t)
 952   ;; the OCI code for the data type of a single element
 953   (oci-data-type (error "missing OCI-DATA-TYPE")
 954                  :type fixnum
 955                  :read-only t)
 956   (result-type (error "missing RESULT-TYPE")
 957                :read-only t))
 958
 959
 960 (defun print-cd (cd stream depth)
 961   (declare (ignore depth))
 962   (print-unreadable-object (cd stream :type t)
 963     (format stream
 964             ":NAME ~S :OCI-DATA-TYPE ~S :OCI-DATA-SIZE ~S"
 965             (cd-name cd)
 966             (cd-oci-data-type cd)
 967             (cd-sizeof cd))))
 968
 969 (defun print-query-cursor (qc stream depth)
 970   (declare (ignore depth))
 971   (print-unreadable-object (qc stream :type t :identity t)
 972     (prin1 (qc-db qc) stream)))
 973
 974
 975 (defmethod database-query-result-set ((query-expression string)
 976                                       (database oracle-database)
 977                                       &key full-set result-types)
 978   (let ((cursor (sql-stmt-exec query-expression database result-types nil)))
 979     (if full-set
 980         (values cursor (length (qc-cds cursor)) nil)
 981         (values cursor (length (qc-cds cursor))))))
 982
 983
 984 (defmethod database-dump-result-set (result-set (database oracle-database))
 985   (close-query result-set))
 986
 987 (defmethod database-store-next-row (result-set (database oracle-database) list)
 988   (let* ((eof-value :eof)
 989          (row (fetch-row result-set nil eof-value)))
 990     (unless (eq eof-value row)
 991       (loop for i from 0 below (length row)
 992           do (setf (nth i list) (nth i row)))
 993       list)))
 994
 995 (defmethod database-start-transaction ((database oracle-database))
 996   (call-next-method)
 997   ;; Not needed with simple transaction
 998   #+ignore
 999   (with-slots (svchp errhp) database
1000     (oci-trans-start (deref-vp svchp)
1001                      (deref-vp errhp)
1002                      60
1003                      +oci-trans-new+))
1004   t)
1005
1006
1007 (defun oracle-commit (database)
1008   (with-slots (svchp errhp) database
1009     (osucc (oci-trans-commit (deref-vp svchp)
1010                              (deref-vp errhp)
1011                              0))))
1012
1013 (defmethod database-commit-transaction ((database oracle-database))
1014   (call-next-method)
1015   (oracle-commit database)
1016   t)
1017
1018 (defmethod database-abort-transaction ((database oracle-database))
1019   (call-next-method)
1020   (osucc (oci-trans-rollback (deref-vp (svchp database))
1021                              (deref-vp (errhp database))
1022                              0))
1023   t)
1024
1025 ;; Specifications
1026
1027 (defmethod db-type-has-bigint? ((type (eql :oracle)))
1028   nil)
1029
1030 (defmethod db-type-has-fancy-math? ((db-type (eql :oracle)))
1031   t)
1032
1033 (defmethod db-type-has-boolean-where? ((db-type (eql :oracle)))
1034   nil)
1035
1036 (when (clsql-sys:database-type-library-loaded :oracle)
1037   (clsql-sys:initialize-database-type :database-type :oracle))