1 ;;;; -*- Mode: LISP; Syntax: ANSI-Common-Lisp; Base: 10 -*-
2 ;;;; *************************************************************************
3 ;;;; FILE IDENTIFICATION
5 ;;;; Name: oracle-sql.lisp
9 ;;;; This file is part of CLSQL.
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 ;;;; *************************************************************************
16 (in-package #:clsql-oracle)
18 (defmethod database-initialize-database-type
19 ((database-type (eql :oracle)))
22 ;;;; arbitrary parameters, tunable for performance or other reasons
24 (eval-when (:compile-toplevel :load-toplevel :execute)
25 (defconstant +errbuf-len+ 512
26 "the number of characters that we allocate for an error message buffer")
27 (defconstant +n-buf-rows+ 200
28 "the number of table rows that we buffer at once when reading a table.
29 CMUCL has a compiled-in limit on how much C data can be allocated
30 (through malloc() and friends) at any given time, typically 8 Mb.
31 Setting this constant to a moderate value should make it less
32 likely that we'll have to worry about the CMUCL limit."))
35 (defmacro deref-vp (foreign-object)
36 `(uffi:deref-pointer ,foreign-object :pointer-void))
38 ;; constants - from OCI?
40 (defconstant +var-not-in-list+ 1007)
41 (defconstant +no-data-found+ 1403)
42 (defconstant +null-value-returned+ 1405)
43 (defconstant +field-truncated+ 1406)
45 (eval-when (:compile-toplevel :load-toplevel :execute)
46 (defconstant SQLT-NUMBER 2)
47 (defconstant SQLT-INT 3)
48 (defconstant SQLT-STR 5)
49 (defconstant SQLT-FLT 4)
50 (defconstant SQLT-DATE 12))
52 ;;; Note that despite the suggestive class name (and the way that the
53 ;;; *DEFAULT-DATABASE* variable holds an object of this class), a DB
54 ;;; object is not actually a database but is instead a connection to a
55 ;;; database. Thus, there's no obstacle to having any number of DB
56 ;;; objects referring to the same database.
58 (uffi:def-type pointer-pointer-void '(* :pointer-void))
60 (defclass oracle-database (database) ; was struct db
64 :type pointer-pointer-void
66 "OCI environment handle")
70 :type pointer-pointer-void
76 :type pointer-pointer-void
78 "OCI service context handle")
83 "optional data source name (used only for debugging/printing)")
89 "the \"user\" value given when data source connection was made")
93 :initform "YYYY-MM-DD HH24:MI:SS\"+00\"")
97 "Each database connection can be configured with its own date
98 output format. In order to extract date strings from output buffers
99 holding multiple date strings in fixed-width fields, we need to know
100 the length of that format.")
103 :initarg :server-version
104 :reader server-version
106 "Version string of Oracle server.")
107 (major-version-number
108 :type (or null fixnum)
109 :initarg :major-version-number
110 :reader major-version-number
112 "The major version number of Oracle, should be 8, 9, or 10")))
115 ;;; Handle the messy case of return code=+oci-error+, querying the
116 ;;; system for subcodes and reporting them as appropriate. ERRHP and
117 ;;; NULLS-OK are as in the OERR function.
119 (defun handle-oci-error (&key database nulls-ok)
123 (uffi:with-foreign-objects ((errbuf '(:array :unsigned-char
126 ;; ensure errbuf empty string
127 (setf (uffi:deref-array errbuf '(:array :unsigned-char) 0)
128 (uffi:ensure-char-storable (code-char 0)))
130 (setf (uffi:deref-pointer errcode :long) 0)
131 (oci-error-get (deref-vp errhp) 1
132 (uffi:make-null-pointer :unsigned-char)
133 errcode errbuf +errbuf-len+ +oci-htype-error+)
134 (let ((subcode (uffi:deref-pointer errcode :long)))
135 (unless (and nulls-ok (= subcode +null-value-returned+))
136 (error 'sql-database-error
139 :message (uffi:convert-from-foreign-string errbuf)))))))
141 (error 'sql-database-error
143 :message "can't handle NULLS-OK without ERRHP"))
145 (error 'sql-database-error
147 :message "OCI Error (and no ERRHP available to find subcode)"))))
149 ;;; Require an OCI success code.
151 ;;; (The ordinary OCI error reporting mechanisms uses a fair amount of
152 ;;; machinery (environments and other handles). In order to get to
153 ;;; where we can use these mechanisms, we have to be able to allocate
154 ;;; the machinery. The functions for allocating the machinery can
155 ;;; return errors (e.g. out of memory) but shouldn't. Wrapping this function
156 ;;; around function calls to such have-to-succeed functions enforces
160 (declare (type fixnum code))
161 (unless (= code +oci-success+)
162 (error 'sql-database-error
163 :message (format nil "unexpected OCI failure, code=~S" code))))
166 ;;; Enabling this can be handy for low-level debugging.
169 (trace oci-initialize #+oci-8-1-5 oci-env-create oci-handle-alloc oci-logon
170 oci-error-get oci-stmt-prepare oci-stmt-execute
171 oci-param-get oci-logon oci-attr-get oci-define-by-pos oci-stmt-fetch)
172 (setf debug::*debug-print-length* nil))
175 ;;;; the OCI library, part V: converting from OCI representations to Lisp
178 ;; Return the INDEXth string of the OCI array, represented as Lisp
179 ;; SIMPLE-STRING. SIZE is the size of the fixed-width fields used by
180 ;; Oracle to store strings within the array.
182 ;; In the wild world of databases, trailing spaces aren't generally
183 ;; significant, since e.g. "LARRY " and "LARRY " are the same string
184 ;; stored in different fixed-width fields. OCI drops trailing spaces
185 ;; for us in some cases but apparently not for fields of fixed
186 ;; character width, e.g.
188 ;; (dbi:sql "create table employees (name char(15), job char(15), city
189 ;; char(15), rate float)" :db orcl :types :auto)
190 ;; In order to map the "same string" property above onto Lisp equality,
191 ;; we drop trailing spaces in all cases:
193 (uffi:def-type string-array (:array :unsigned-char))
195 (defun deref-oci-string (arrayptr string-index size)
196 (declare (type string-array arrayptr))
197 (declare (type (mod #.+n-buf-rows+) string-index))
198 (declare (type (and unsigned-byte fixnum) size))
199 (let* ((raw (uffi:convert-from-foreign-string
201 (+ (uffi:pointer-address arrayptr) (* string-index size))
203 (trimmed (string-trim " " raw)))
204 (if (equal trimmed "NULL") nil trimmed)))
206 ;; the OCI library, part Z: no-longer used logic to convert from
207 ;; Oracle's binary date representation to Common Lisp's native date
211 (defvar +oci-date-bytes+ 7)
213 ;;; Return the INDEXth date in the OCI array, represented as
214 ;;; a Common Lisp "universal time" (i.e. seconds since 1900).
217 (defun deref-oci-date (arrayptr index)
218 (oci-date->universal-time (uffi:pointer-address
219 (uffi:deref-array arrayptr
220 '(:array :unsigned-char)
221 (* index +oci-date-bytes+)))))
223 (defun oci-date->universal-time (oci-date)
224 (declare (type (alien (* :unsigned-char)) oci-date))
225 (flet (;; a character from OCI-DATE, interpreted as an unsigned byte
227 (declare (type (mod #.+oci-date-bytes+) i))
228 (mod (uffi:deref-array oci-date string-array i) 256)))
229 (let* ((century (* (- (ub 0) 100) 100))
230 (year (+ century (- (ub 1) 100)))
235 (second (1- (ub 6))))
236 (encode-universal-time second minute hour day month year))))
238 (defun owner-phrase (owner)
240 (format nil " WHERE OWNER='~A'" owner)
243 (defmethod database-list-tables ((database oracle-database) &key owner)
246 (concatenate 'string "select table_name from user_tables"
247 (owner-phrase owner))
250 (values (database-query "select TABLE_NAME from all_catalog
251 where owner not in ('PUBLIC','SYSTEM','SYS','WMSYS','EXFSYS','CTXSYS','WKSYS','WK_TEST','MDSYS','DMSYS','OLAPSYS','ORDSYS','XDB')"
255 (defmethod database-list-views ((database oracle-database)
259 (concatenate 'string "select view_name from user_views"
260 (owner-phrase owner))
264 (defmethod database-list-indexes ((database oracle-database)
268 (concatenate 'string "select index_name from user_indexes"
269 (owner-phrase owner))
272 (defmethod list-all-table-columns (table (db oracle-database))
273 (declare (string table))
274 (let* ((sql-stmt (concatenate
280 "user_tab_columns.COLUMN_NAME,"
281 "user_tab_columns.DATA_TYPE from user_tab_columns,"
282 "all_tables where all_tables.table_name = '" table "'"
283 " and user_tab_columns.table_name = '" table "'"))
284 (preresult (database-query sql-stmt db :auto nil)))
285 ;; PRERESULT is like RESULT except that it has a name instead of
286 ;; type codes in the fifth column of each row. To fix this, we
287 ;; destructively modify PRERESULT.
288 (dolist (preresult-row preresult)
289 (setf (fifth preresult-row)
290 (if (find (fifth preresult-row)
298 (defmethod database-list-attributes (table (database oracle-database) &key owner)
302 "select column_name from user_tab_columns where table_name='~A'~A"
305 (format nil " AND OWNER='~A'" owner)
309 (defmethod database-attribute-type (attribute (table string)
310 (database oracle-database)
315 "select data_type,data_length,data_precision,data_scale,nullable from user_tab_columns where table_name='~A' and column_name='~A'~A"
318 (format nil " AND OWNER='~A'" owner)
320 database :auto nil)))
321 (destructuring-bind (type length precision scale nullable) (car rows)
322 (values (ensure-keyword type) length precision scale
323 (if (char-equal #\Y (schar nullable 0)) 1 0)))))
325 ;; Return one row of the table referred to by QC, represented as a
326 ;; list; or if there are no more rows, signal an error if EOF-ERRORP,
327 ;; or return EOF-VALUE otherwise.
329 ;; KLUDGE: This CASE statement is a strong sign that the code would be
330 ;; cleaner if CD were made into an abstract class, we made variant
331 ;; classes for CD-for-column-of-strings, CD-for-column-of-floats,
332 ;; etc., and defined virtual functions to handle operations like
333 ;; get-an-element-from-column. (For a small special purpose module
334 ;; like this, would arguably be overkill, so I'm not going to do it
335 ;; now, but if this code ends up getting more complicated in
336 ;; maintenance, it would become a really good idea.)
338 ;; Arguably this would be a good place to signal END-OF-FILE, but
339 ;; since the ANSI spec specifically says that END-OF-FILE means a
340 ;; STREAM which has no more data, and QC is not a STREAM, we signal
341 ;; DBI-ERROR instead.
343 (uffi:def-type short-array '(:array :short))
344 (uffi:def-type int-pointer '(* :int))
345 (uffi:def-type double-pointer '(* :double))
347 ;;; the result of a database query: a cursor through a table
348 (defstruct (oracle-result-set (:print-function print-query-cursor)
350 (:constructor %make-query-cursor))
351 (db (error "missing DB") ; db conn. this table is associated with
352 :type oracle-database
354 (stmthp (error "missing STMTHP") ; the statement handle used to create
355 ;; :type alien ; this table. owned by the QUERY-CURSOR
356 :read-only t) ; object, deallocated on CLOSE-QUERY
357 (cds) ; (error "missing CDS") ; column descriptors
358 ; :type (simple-array cd 1)
361 0 ; buffered rows: number of rows recv'd
362 :type (integer 0 #.+n-buf-rows+)) ; from the database on the last read
364 0 ; number of buffered rows returned, i.e.
365 :type (integer 0 #.+n-buf-rows+)) ; the index, within the buffered rows,
366 ; of the next row which hasn't already
369 0 ; total number of bytes recv'd from OCI
370 :type unsigned-byte) ; in all reads
371 (oci-end-seen-p nil)) ; Have we seen the end of OCI
372 ; data, i.e. OCI returning
373 ; less data than we requested?
374 ; OCI doesn't seem to like us
375 ; to try to read more data
376 ; from it after that..
379 (defun fetch-row (qc &optional (eof-errorp t) eof-value)
380 ;;(declare (optimize (speed 3)))
381 (cond ((zerop (qc-n-from-oci qc))
383 (error 'sql-database-error :message
384 (format nil "no more rows available in ~S" qc))
386 ((>= (qc-n-to-dbi qc)
388 (refill-qc-buffers qc)
389 (fetch-row qc nil eof-value))
391 (let ((cds (qc-cds qc))
392 (reversed-result nil)
393 (irow (qc-n-to-dbi qc)))
394 (dotimes (icd (length cds))
395 (let* ((cd (aref cds icd))
396 (b (foreign-resource-buffer (cd-buffer cd)))
398 (let* ((arb (foreign-resource-buffer (cd-indicators cd)))
399 (indicator (uffi:deref-array arb '(:array :short) irow)))
400 (declare (type short-array arb))
401 (unless (= indicator -1)
402 (ecase (cd-oci-data-type cd)
404 (deref-oci-string b irow (cd-sizeof cd)))
406 (uffi:deref-array b '(:array :double) irow))
408 (uffi:deref-array b '(:array :int) irow))
410 (deref-oci-string b irow (cd-sizeof cd))))))))
411 (when (and (eq :string (cd-result-type cd))
413 (not (stringp value)))
414 (setq value (write-to-string value)))
415 (push value reversed-result)))
416 (incf (qc-n-to-dbi qc))
417 (nreverse reversed-result)))))
419 (defun refill-qc-buffers (qc)
420 (with-slots (errhp) (qc-db qc)
421 (setf (qc-n-to-dbi qc) 0)
422 (cond ((qc-oci-end-seen-p qc)
423 (setf (qc-n-from-oci qc) 0))
425 (let ((oci-code (%oci-stmt-fetch
426 (deref-vp (qc-stmthp qc))
429 +oci-fetch-next+ +oci-default+)))
431 (#.+oci-success+ (values))
432 (#.+oci-no-data+ (setf (qc-oci-end-seen-p qc) t)
434 (#.+oci-error+ (handle-oci-error :database (qc-db qc)
436 (uffi:with-foreign-object (rowcount :long)
437 (oci-attr-get (deref-vp (qc-stmthp qc))
440 (uffi:make-null-pointer :unsigned-long)
443 (setf (qc-n-from-oci qc)
444 (- (uffi:deref-pointer rowcount :long)
445 (qc-total-n-from-oci qc)))
446 (when (< (qc-n-from-oci qc) +n-buf-rows+)
447 (setf (qc-oci-end-seen-p qc) t))
448 (setf (qc-total-n-from-oci qc)
449 (uffi:deref-pointer rowcount :long)))))
452 ;; the guts of the SQL function
454 ;; (like the SQL function, but with the QUERY argument hardwired to T, so
455 ;; that the return value is always a cursor instead of a list)
457 ;; Is this a SELECT statement? SELECT statements are handled
458 ;; specially by OCIStmtExecute(). (Non-SELECT statements absolutely
459 ;; require a nonzero iteration count, while the ordinary choice for a
460 ;; SELECT statement is a zero iteration count.
462 ;; SELECT statements are the only statements which return tables. We
463 ;; don't free STMTHP in this case, but instead give it to the new
464 ;; QUERY-CURSOR, and the new QUERY-CURSOR becomes responsible for
465 ;; freeing the STMTHP when it is no longer needed.
467 (defun sql-stmt-exec (sql-stmt-string db result-types field-names)
468 (with-slots (envhp svchp errhp)
470 (let ((stmthp (uffi:allocate-foreign-object :pointer-void)))
471 (uffi:with-foreign-object (stmttype :unsigned-short)
473 (oci-handle-alloc (deref-vp envhp)
475 +oci-htype-stmt+ 0 +null-void-pointer-pointer+)
476 (oci-stmt-prepare (deref-vp stmthp)
478 (uffi:convert-to-cstring sql-stmt-string)
479 (length sql-stmt-string)
480 +oci-ntv-syntax+ +oci-default+ :database db)
481 (oci-attr-get (deref-vp stmthp)
484 (uffi:make-null-pointer :unsigned-int)
488 (let* ((select-p (= (uffi:deref-pointer stmttype :unsigned-short) 1))
489 (iters (if select-p 0 1)))
491 (oci-stmt-execute (deref-vp svchp)
494 iters 0 +null-void-pointer+ +null-void-pointer+ +oci-default+
497 (make-query-cursor db stmthp result-types field-names))
499 (oci-handle-free (deref-vp stmthp) +oci-htype-stmt+)
503 ;; Return a QUERY-CURSOR representing the table returned from the OCI
504 ;; operation done through STMTHP. TYPES is the argument of the same
505 ;; name from the external SQL function, controlling type conversion
506 ;; of the returned arguments.
508 (defun make-query-cursor (db stmthp result-types field-names)
509 (let ((qc (%make-query-cursor :db db
511 :cds (make-query-cursor-cds db stmthp
514 (refill-qc-buffers qc)
518 ;; the hairy part of MAKE-QUERY-CURSOR: Ask OCI for information
519 ;; about table columns, translate the information into a Lisp
520 ;; vector of column descriptors, and return it.
522 ;; Allegro defines several flavors of type conversion, but this
523 ;; implementation only supports the :AUTO flavor.
525 ;; A note of explanation: OCI's internal number format uses 21
526 ;; bytes (42 decimal digits). 2 separate (?) one-byte fields,
527 ;; scale and precision, are used to deduce the nature of these
528 ;; 21 bytes. See pp. 3-10, 3-26, and 6-13 of OCI documentation
531 ;; When calling OCI C code to handle the conversion, we have
532 ;; only two numeric types available to pass the return value:
533 ;; double-float and signed-long. It would be possible to
534 ;; bypass the OCI conversion functions and write Lisp code
535 ;; which reads the 21-byte field directly and decodes
536 ;; it. However this is left as an exercise for the reader. :-)
538 ;; The following table describes the mapping, based on the implicit
539 ;; assumption that C's "signed long" type is a 32-bit integer.
541 ;; Internal Values SQL Type C Return Type
542 ;; =============== ======== =============
543 ;; Precision > 0 SCALE = -127 FLOAT --> double-float
544 ;; Precision > 0 && <=9 SCALE = 0 INTEGER --> signed-long
545 ;; Precision = 0 || > 9 SCALE = 0 BIG INTEGER --> double-float
546 ;; Precision > 0 SCALE > 0 DECIMAL --> double-float
548 ;; (OCI uses 1-based indexing here.)
550 ;; KLUDGE: This should work for all other data types except those
551 ;; which don't actually fit in their fixed-width field (BLOBs and the
552 ;; like). As Winton says, we (Cadabra) don't need to worry much about
553 ;; those, since we can't reason with them, so we don't use them. But
554 ;; for a more general application it'd be good to have a more
555 ;; selective and rigorously correct test here for whether we can
556 ;; actually handle the given DEREF-DTYPE value. -- WHN 20000106
558 ;; Note: The OCI documentation doesn't seem to say whether the COLNAME
559 ;; value returned here is a newly-allocated copy which we're
560 ;; responsible for freeing, or a pointer into some system copy which
561 ;; will be freed when the system itself is shut down. But judging
562 ;; from the way that the result is used in the cdemodsa.c example
563 ;; program, it looks like the latter: we should make our own copy of
564 ;; the value, but not try to free it.
566 ;; WORKAROUND: OCI seems to return ub2 values for the
567 ;; +oci-attr-data-size+ attribute even though its documentation claims
568 ;; that it returns a ub4, and even though the associated "sizep" value
569 ;; is 4, not 2. In order to make the code here work reliably, without
570 ;; having to patch it later if OCI is ever fixed to match its
571 ;; documentation, we pre-zero COLSIZE before making the call into OCI.
573 ;; To exercise the weird OCI behavior (thereby blowing up the code
574 ;; below, beware!) try setting this value into COLSIZE, calling OCI,
575 ;; then looking at the value in COLSIZE. (setf colsize #x12345678)
579 (defun make-query-cursor-cds (database stmthp result-types field-names)
580 (declare (optimize (safety 3) #+nil (speed 3))
581 (type oracle-database database)
582 (type pointer-pointer-void stmthp))
583 (with-slots (errhp) database
584 (uffi:with-foreign-objects ((dtype-foreign :unsigned-short)
585 (parmdp ':pointer-void)
588 (colname '(* :unsigned-char))
589 (colnamelen :unsigned-long)
590 (colsize :unsigned-long)
591 (colsizesize :unsigned-long)
592 (defnp ':pointer-void))
595 (do ((icolumn 0 (1+ icolumn))
596 (cds-as-reversed-list nil))
597 ((not (eql (oci-param-get (deref-vp stmthp)
601 (1+ icolumn) :database database)
603 (coerce (reverse cds-as-reversed-list) 'simple-vector))
604 ;; Decode type of ICOLUMNth column into a type we're prepared to
606 (oci-attr-get (deref-vp parmdp)
609 (uffi:make-null-pointer :unsigned-int)
612 (let ((dtype (uffi:deref-pointer dtype-foreign :unsigned-short)))
615 (setf buffer (acquire-foreign-resource :unsigned-char
616 (* 32 +n-buf-rows+)))
617 (setf sizeof 32 dtype #.SQLT-STR))
619 (oci-attr-get (deref-vp parmdp)
622 (uffi:make-null-pointer :unsigned-int)
625 (oci-attr-get (deref-vp parmdp)
628 (uffi:make-null-pointer :unsigned-int)
631 (let ((*scale (uffi:deref-pointer scale :byte))
632 (*precision (uffi:deref-pointer precision :byte)))
633 ;;(format t "scale=~d, precision=~d~%" *scale *precision)
636 (and (minusp *scale) (< *precision 10)))
637 (setf buffer (acquire-foreign-resource :int +n-buf-rows+)
638 sizeof 4 ;; sizeof(int)
641 (setf buffer (acquire-foreign-resource :double +n-buf-rows+)
642 sizeof 8 ;; sizeof(double)
643 dtype #.SQLT-FLT)))) )
644 ;; Default to SQL-STR
646 (setf (uffi:deref-pointer colsize :unsigned-long) 0
648 (oci-attr-get (deref-vp parmdp)
651 (uffi:make-null-pointer :unsigned-int) ;; (uffi:pointer-address colsizesize)
654 (let ((colsize-including-null (1+ (uffi:deref-pointer colsize :unsigned-long))))
655 (setf buffer (acquire-foreign-resource
656 :unsigned-char (* +n-buf-rows+ colsize-including-null)))
657 (setf sizeof colsize-including-null))))
658 (let ((retcodes (acquire-foreign-resource :unsigned-short +n-buf-rows+))
659 (indicators (acquire-foreign-resource :short +n-buf-rows+))
662 (oci-attr-get (deref-vp parmdp)
668 (setq colname-string (uffi:convert-from-foreign-string
669 (uffi:deref-pointer colname '(* :unsigned-char))
670 :length (uffi:deref-pointer colnamelen :unsigned-long))))
671 (push (make-cd :name colname-string
676 :indicators indicators
678 ((consp result-types)
679 (nth icolumn result-types))
684 cds-as-reversed-list)
685 (oci-define-by-pos (deref-vp stmthp)
688 (1+ icolumn) ; OCI 1-based indexing again
689 (uffi:with-cast-pointer (vp (foreign-resource-buffer buffer) :void)
693 (uffi:with-cast-pointer (vp (foreign-resource-buffer indicators) :void)
695 (uffi:make-null-pointer :unsigned-short)
696 (uffi:with-cast-pointer (vp (foreign-resource-buffer retcodes) :unsigned-short)
698 +oci-default+))))))))
700 ;; Release the resources associated with a QUERY-CURSOR.
702 (defun close-query (qc)
703 (oci-handle-free (deref-vp (qc-stmthp qc)) +oci-htype-stmt+)
704 (let ((cds (qc-cds qc)))
705 (dotimes (i (length cds))
706 (release-cd-resources (aref cds i))))
710 ;; Release the resources associated with a column description.
712 (defun release-cd-resources (cd)
713 (free-foreign-resource (cd-buffer cd))
714 (free-foreign-resource (cd-retcodes cd))
715 (free-foreign-resource (cd-indicators cd))
719 (defmethod database-name-from-spec (connection-spec (database-type (eql :oracle)))
720 (check-connection-spec connection-spec database-type (dsn user password))
721 (destructuring-bind (dsn user password) connection-spec
722 (declare (ignore password))
723 (concatenate 'string dsn "/" user)))
726 (defmethod database-connect (connection-spec (database-type (eql :oracle)))
727 (check-connection-spec connection-spec database-type (dsn user password))
728 (destructuring-bind (data-source-name user password)
730 (let ((envhp (uffi:allocate-foreign-object :pointer-void))
731 (errhp (uffi:allocate-foreign-object :pointer-void))
732 (svchp (uffi:allocate-foreign-object :pointer-void))
733 (srvhp (uffi:allocate-foreign-object :pointer-void)))
734 ;; Requests to allocate environments and handles should never
735 ;; fail in normal operation, and they're done too early to
736 ;; handle errors very gracefully (since they're part of the
737 ;; error-handling mechanism themselves) so we just assert they
739 (setf (deref-vp envhp) +null-void-pointer+)
742 (oci-env-create envhp +oci-default+ +null-void-pointer+
743 +null-void-pointer+ +null-void-pointer+
744 +null-void-pointer+ 0 +null-void-pointer-pointer+)
745 (oci-handle-alloc envhp
748 +null-void-pointer-pointer+))
751 (oci-initialize +oci-object+ +null-void-pointer+ +null-void-pointer+
752 +null-void-pointer+ +null-void-pointer-pointer+)
753 (ignore-errors (oci-handle-alloc +null-void-pointer+ envhp
755 +null-void-pointer-pointer+)) ;no testing return
756 (oci-env-init envhp +oci-default+ 0 +null-void-pointer-pointer+)
757 (oci-handle-alloc (deref-vp envhp) errhp
758 +oci-htype-error+ 0 +null-void-pointer-pointer+)
759 (oci-handle-alloc (deref-vp envhp) srvhp
760 +oci-htype-server+ 0 +null-void-pointer-pointer+)
761 (uffi:with-cstring (dblink nil)
762 (oci-server-attach (deref-vp srvhp)
766 (oci-handle-alloc (deref-vp envhp) svchp
767 +oci-htype-svcctx+ 0 +null-void-pointer-pointer+)
768 (oci-attr-set (deref-vp svchp)
770 (deref-vp srvhp) 0 +oci-attr-server+
772 ;; oci-handle-alloc((dvoid *)encvhp, (dvoid **)&stmthp, OCI_HTYPE_STMT, 0, 0);
775 (let (db server-version)
776 (uffi:with-foreign-object (buf '(:array :unsigned-char #.+errbuf-len+))
777 (oci-server-version (deref-vp svchp)
779 (uffi:char-array-to-pointer buf)
780 +errbuf-len+ +oci-htype-svcctx+)
781 (setf server-version (uffi:convert-from-foreign-string buf)))
782 (setq db (make-instance 'oracle-database
783 :name (database-name-from-spec connection-spec
787 :database-type :oracle
789 :dsn data-source-name
791 :server-version server-version
792 :major-version-number (major-version-from-string
795 (oci-logon (deref-vp envhp)
798 (uffi:convert-to-cstring user) (length user)
799 (uffi:convert-to-cstring password) (length password)
800 (uffi:convert-to-cstring data-source-name) (length data-source-name)
802 ;; :date-format-length (1+ (length date-format)))))
803 (setf (slot-value db 'clsql-sys::state) :open)
804 (database-execute-command
805 (format nil "alter session set NLS_DATE_FORMAT='~A'" (date-format db)) db)
809 (defun major-version-from-string (str)
811 ((search " 10g " str)
813 ((search "Oracle9i " str)
817 ;; Close a database connection.
819 (defmethod database-disconnect ((database oracle-database))
820 (osucc (oci-logoff (deref-vp (svchp database))
821 (deref-vp (errhp database))))
822 (osucc (oci-handle-free (deref-vp (envhp database)) +oci-htype-env+))
823 ;; Note: It's neither required nor allowed to explicitly deallocate the
824 ;; ERRHP handle here, since it's owned by the ENVHP deallocated above,
825 ;; and was therefore automatically deallocated at the same time.
828 ;;; Do the database operation described in SQL-STMT-STRING on database
829 ;;; DB and, if the command is a SELECT, return a representation of the
830 ;;; resulting table. The representation of the table is controlled by the
832 ;;; * If QUERY is NIL, the table is returned as a list of rows, with
833 ;;; each row represented by a list.
834 ;;; * If QUERY is non-NIL, the result is returned as a QUERY-CURSOR
835 ;;; suitable for FETCH-ROW and CLOSE-QUERY
836 ;;; The TYPES argument controls the type conversion method used
837 ;;; to construct the table. The Allegro version supports several possible
838 ;;; values for this argument, but we only support :AUTO.
840 (defmethod database-query (query-expression (database oracle-database) result-types field-names)
841 (let ((cursor (sql-stmt-exec query-expression database result-types field-names)))
842 ;; (declare (type (or query-cursor null) cursor))
843 (if (null cursor) ; No table was returned.
845 (do ((reversed-result nil))
847 (let* ((eof-value :eof)
848 (row (fetch-row cursor nil eof-value)))
849 (when (eq row eof-value)
852 (return (values (nreverse reversed-result)
853 (loop for cd across (qc-cds cursor)
854 collect (cd-name cd))))
855 (return (nreverse reversed-result))))
856 (push row reversed-result))))))
859 (defmethod database-create-sequence
860 (sequence-name (database oracle-database))
862 (concatenate 'string "CREATE SEQUENCE "
863 (sql-escape sequence-name))
866 (defmethod database-drop-sequence
867 (sequence-name (database oracle-database))
869 (concatenate 'string "DROP SEQUENCE "
870 (sql-escape sequence-name))
873 (defmethod database-sequence-next (sequence-name (database oracle-database))
876 (concatenate 'string "SELECT "
877 (sql-escape sequence-name)
879 ) :database database)))
881 (defmethod database-list-sequences ((database oracle-database) &key owner)
882 (mapcar #'car (database-query
883 (concatenate 'string "select sequence_name from user_sequences"
884 (owner-phrase owner))
887 (defmethod database-execute-command (sql-expression (database oracle-database))
888 (database-query sql-expression database nil nil)
890 (database-query "commit" database nil nil)
894 (defstruct (cd (:constructor make-cd)
895 (:print-function print-cd))
896 "a column descriptor: metadata about the data in a table"
898 ;; name of this column
899 (name (error "missing NAME") :type simple-string :read-only t)
900 ;; the size in bytes of a single element
901 (sizeof (error "missing SIZE") :type fixnum :read-only t)
902 ;; an array of +N-BUF-ROWS+ elements in C representation
903 (buffer (error "Missing BUFFER")
904 :type foreign-resource
906 ;; an array of +N-BUF-ROWS+ OCI return codes in C representation.
907 ;; (There must be one return code for every element of every
908 ;; row in order to be able to represent nullness.)
909 (retcodes (error "Missing RETCODES")
910 :type foreign-resource
912 (indicators (error "Missing INDICATORS")
913 :type foreign-resource
915 ;; the OCI code for the data type of a single element
916 (oci-data-type (error "missing OCI-DATA-TYPE")
919 (result-type (error "missing RESULT-TYPE")
923 (defun print-cd (cd stream depth)
924 (declare (ignore depth))
925 (print-unreadable-object (cd stream :type t)
927 ":NAME ~S :OCI-DATA-TYPE ~S :OCI-DATA-SIZE ~S"
929 (cd-oci-data-type cd)
932 (defun print-query-cursor (qc stream depth)
933 (declare (ignore depth))
934 (print-unreadable-object (qc stream :type t :identity t)
935 (prin1 (qc-db qc) stream)))
938 (defmethod database-query-result-set ((query-expression string)
939 (database oracle-database)
940 &key full-set result-types)
941 (let ((cursor (sql-stmt-exec query-expression database result-types nil)))
943 (values cursor (length (qc-cds cursor)) nil)
944 (values cursor (length (qc-cds cursor))))))
947 (defmethod database-dump-result-set (result-set (database oracle-database))
948 (close-query result-set))
950 (defmethod database-store-next-row (result-set (database oracle-database) list)
951 (let* ((eof-value :eof)
952 (row (fetch-row result-set nil eof-value)))
953 (unless (eq eof-value row)
954 (loop for i from 0 below (length row)
955 do (setf (nth i list) (nth i row)))
958 (defmethod clsql-sys:database-start-transaction ((database oracle-database))
961 ;;(with-slots (svchp errhp) database
962 ;; (osucc (oci-trans-start (uffi:deref-pointer svchp)
963 ;; (uffi:deref-pointer errhp)
965 ;; +oci-trans-new+)))
969 (defmethod clsql-sys:database-commit-transaction ((database oracle-database))
971 (with-slots (svchp errhp) database
972 (osucc (oci-trans-commit (deref-vp svchp)
977 (defmethod clsql-sys:database-abort-transaction ((database oracle-database))
979 (osucc (oci-trans-rollback (deref-vp (svchp database))
980 (deref-vp (errhp database))
984 (defparameter *constraint-types*
985 '(("NOT-NULL" . "NOT NULL")))
987 (defmethod database-output-sql ((str string) (database oracle-database))
988 (if (and (null (position #\' str))
989 (null (position #\\ str)))
990 (format nil "'~A'" str)
991 (let* ((l (length str))
992 (buf (make-string (+ l 3))))
993 (setf (aref buf 0) #\')
996 ((= i l) (setf (aref buf j) #\'))
997 (if (= j (- (length buf) 1))
998 (setf buf (adjust-array buf (+ (length buf) 1))))
999 (cond ((eql (aref str i) #\')
1000 (setf (aref buf j) #\')
1002 (setf (aref buf j) (aref str i)))
1008 (defmethod db-type-has-bigint? ((type (eql :oracle)))
1011 (defmethod db-type-has-fancy-math? ((db-type (eql :oracle)))
1014 (defmethod db-type-has-boolean-where? ((db-type (eql :oracle)))
1017 (when (clsql-sys:database-type-library-loaded :oracle)
1018 (clsql-sys:initialize-database-type :database-type :oracle))