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+)
163 :format-control "unexpected OCI failure, code=~S"
164 :format-arguments (list code))))
167 ;;; Enabling this can be handy for low-level debugging.
170 (trace oci-initialize #+oci-8-1-5 oci-env-create oci-handle-alloc oci-logon
171 oci-error-get oci-stmt-prepare oci-stmt-execute
172 oci-param-get oci-logon oci-attr-get oci-define-by-pos oci-stmt-fetch)
173 (setf debug::*debug-print-length* nil))
176 ;;;; the OCI library, part V: converting from OCI representations to Lisp
179 ;; Return the INDEXth string of the OCI array, represented as Lisp
180 ;; SIMPLE-STRING. SIZE is the size of the fixed-width fields used by
181 ;; Oracle to store strings within the array.
183 ;; In the wild world of databases, trailing spaces aren't generally
184 ;; significant, since e.g. "LARRY " and "LARRY " are the same string
185 ;; stored in different fixed-width fields. OCI drops trailing spaces
186 ;; for us in some cases but apparently not for fields of fixed
187 ;; character width, e.g.
189 ;; (dbi:sql "create table employees (name char(15), job char(15), city
190 ;; char(15), rate float)" :db orcl :types :auto)
191 ;; In order to map the "same string" property above onto Lisp equality,
192 ;; we drop trailing spaces in all cases:
194 (uffi:def-type string-array (:array :unsigned-char))
196 (defun deref-oci-string (arrayptr string-index size)
197 (declare (type string-array arrayptr))
198 (declare (type (mod #.+n-buf-rows+) string-index))
199 (declare (type (and unsigned-byte fixnum) size))
200 (let* ((raw (uffi:convert-from-foreign-string
202 (+ (uffi:pointer-address arrayptr) (* string-index size))
204 (trimmed (string-trim " " raw)))
205 (if (equal trimmed "NULL") nil trimmed)))
207 ;; the OCI library, part Z: no-longer used logic to convert from
208 ;; Oracle's binary date representation to Common Lisp's native date
212 (defvar +oci-date-bytes+ 7)
214 ;;; Return the INDEXth date in the OCI array, represented as
215 ;;; a Common Lisp "universal time" (i.e. seconds since 1900).
218 (defun deref-oci-date (arrayptr index)
219 (oci-date->universal-time (uffi:pointer-address
220 (uffi:deref-array arrayptr
221 '(:array :unsigned-char)
222 (* index +oci-date-bytes+)))))
224 (defun oci-date->universal-time (oci-date)
225 (declare (type (alien (* :unsigned-char)) oci-date))
226 (flet (;; a character from OCI-DATE, interpreted as an unsigned byte
228 (declare (type (mod #.+oci-date-bytes+) i))
229 (mod (uffi:deref-array oci-date string-array i) 256)))
230 (let* ((century (* (- (ub 0) 100) 100))
231 (year (+ century (- (ub 1) 100)))
236 (second (1- (ub 6))))
237 (encode-universal-time second minute hour day month year))))
239 (defmethod database-list-tables ((database oracle-database) &key owner)
241 (database-query "select table_name from user_tables"
244 (values (database-query "select TABLE_NAME from all_catalog
245 where owner not in ('PUBLIC','SYSTEM','SYS','WMSYS','EXFSYS','CTXSYS','WKSYS','WK_TEST','MDSYS','DMSYS','OLAPSYS','ORDSYS','XDB')"
249 (defmethod database-list-views ((database oracle-database)
251 ;; (database-query "select table_name from all_catalog" database nil nil)
253 (database-query "select view_name from user_views" database nil nil)))
256 (defmethod database-list-indexes ((database oracle-database)
259 (database-query "select index_name from user_indexes" database nil nil)))
261 (defmethod list-all-table-columns (table (db oracle-database))
262 (declare (string table))
263 (let* ((sql-stmt (concatenate
269 "user_tab_columns.COLUMN_NAME,"
270 "user_tab_columns.DATA_TYPE from user_tab_columns,"
271 "all_tables where all_tables.table_name = '" table "'"
272 " and user_tab_columns.table_name = '" table "'"))
273 (preresult (database-query sql-stmt db :auto nil)))
274 ;; PRERESULT is like RESULT except that it has a name instead of
275 ;; type codes in the fifth column of each row. To fix this, we
276 ;; destructively modify PRERESULT.
277 (dolist (preresult-row preresult)
278 (setf (fifth preresult-row)
279 (if (find (fifth preresult-row)
287 (defmethod database-list-attributes (table (database oracle-database) &key owner)
291 "select column_name from user_tab_columns where table_name='~A'"
295 (defmethod database-attribute-type (attribute (table string)
296 (database oracle-database)
301 "select data_type,data_length,data_precision,data_scale,nullable from user_tab_columns where table_name='~A' and column_name='~A'"
303 database :auto nil)))
304 (destructuring-bind (type length precision scale nullable) (car rows)
305 (values (ensure-keyword type) length precision scale
306 (if (char-equal #\Y (schar nullable 0)) 1 0)))))
308 ;; Return one row of the table referred to by QC, represented as a
309 ;; list; or if there are no more rows, signal an error if EOF-ERRORP,
310 ;; or return EOF-VALUE otherwise.
312 ;; KLUDGE: This CASE statement is a strong sign that the code would be
313 ;; cleaner if CD were made into an abstract class, we made variant
314 ;; classes for CD-for-column-of-strings, CD-for-column-of-floats,
315 ;; etc., and defined virtual functions to handle operations like
316 ;; get-an-element-from-column. (For a small special purpose module
317 ;; like this, would arguably be overkill, so I'm not going to do it
318 ;; now, but if this code ends up getting more complicated in
319 ;; maintenance, it would become a really good idea.)
321 ;; Arguably this would be a good place to signal END-OF-FILE, but
322 ;; since the ANSI spec specifically says that END-OF-FILE means a
323 ;; STREAM which has no more data, and QC is not a STREAM, we signal
324 ;; DBI-ERROR instead.
326 (uffi:def-type short-array '(:array :short))
327 (uffi:def-type int-pointer '(* :int))
328 (uffi:def-type double-pointer '(* :double))
330 ;;; the result of a database query: a cursor through a table
331 (defstruct (oracle-result-set (:print-function print-query-cursor)
333 (:constructor %make-query-cursor))
334 (db (error "missing DB") ; db conn. this table is associated with
335 :type oracle-database
337 (stmthp (error "missing STMTHP") ; the statement handle used to create
338 ;; :type alien ; this table. owned by the QUERY-CURSOR
339 :read-only t) ; object, deallocated on CLOSE-QUERY
340 (cds) ; (error "missing CDS") ; column descriptors
341 ; :type (simple-array cd 1)
344 0 ; buffered rows: number of rows recv'd
345 :type (integer 0 #.+n-buf-rows+)) ; from the database on the last read
347 0 ; number of buffered rows returned, i.e.
348 :type (integer 0 #.+n-buf-rows+)) ; the index, within the buffered rows,
349 ; of the next row which hasn't already
352 0 ; total number of bytes recv'd from OCI
353 :type unsigned-byte) ; in all reads
354 (oci-end-seen-p nil)) ; Have we seen the end of OCI
355 ; data, i.e. OCI returning
356 ; less data than we requested?
357 ; OCI doesn't seem to like us
358 ; to try to read more data
359 ; from it after that..
362 (defun fetch-row (qc &optional (eof-errorp t) eof-value)
363 ;;(declare (optimize (speed 3)))
364 (cond ((zerop (qc-n-from-oci qc))
366 (error 'clsql-error :message
367 (format nil "no more rows available in ~S" qc))
369 ((>= (qc-n-to-dbi qc)
371 (refill-qc-buffers qc)
372 (fetch-row qc nil eof-value))
374 (let ((cds (qc-cds qc))
375 (reversed-result nil)
376 (irow (qc-n-to-dbi qc)))
377 (dotimes (icd (length cds))
378 (let* ((cd (aref cds icd))
379 (b (foreign-resource-buffer (cd-buffer cd)))
381 (let* ((arb (foreign-resource-buffer (cd-indicators cd)))
382 (indicator (uffi:deref-array arb '(:array :short) irow)))
383 (declare (type short-array arb))
384 (unless (= indicator -1)
385 (ecase (cd-oci-data-type cd)
387 (deref-oci-string b irow (cd-sizeof cd)))
389 (uffi:deref-array b '(:array :double) irow))
391 (uffi:deref-array b '(:array :int) irow))
393 (deref-oci-string b irow (cd-sizeof cd))))))))
394 (when (and (eq :string (cd-result-type cd))
396 (not (stringp value)))
397 (setq value (write-to-string value)))
398 (push value reversed-result)))
399 (incf (qc-n-to-dbi qc))
400 (nreverse reversed-result)))))
402 (defun refill-qc-buffers (qc)
403 (with-slots (errhp) (qc-db qc)
404 (setf (qc-n-to-dbi qc) 0)
405 (cond ((qc-oci-end-seen-p qc)
406 (setf (qc-n-from-oci qc) 0))
408 (let ((oci-code (%oci-stmt-fetch
409 (deref-vp (qc-stmthp qc))
412 +oci-fetch-next+ +oci-default+)))
414 (#.+oci-success+ (values))
415 (#.+oci-no-data+ (setf (qc-oci-end-seen-p qc) t)
417 (#.+oci-error+ (handle-oci-error :database (qc-db qc)
419 (uffi:with-foreign-object (rowcount :long)
420 (oci-attr-get (deref-vp (qc-stmthp qc))
423 (uffi:make-null-pointer :unsigned-long)
426 (setf (qc-n-from-oci qc)
427 (- (uffi:deref-pointer rowcount :long)
428 (qc-total-n-from-oci qc)))
429 (when (< (qc-n-from-oci qc) +n-buf-rows+)
430 (setf (qc-oci-end-seen-p qc) t))
431 (setf (qc-total-n-from-oci qc)
432 (uffi:deref-pointer rowcount :long)))))
435 ;; the guts of the SQL function
437 ;; (like the SQL function, but with the QUERY argument hardwired to T, so
438 ;; that the return value is always a cursor instead of a list)
440 ;; Is this a SELECT statement? SELECT statements are handled
441 ;; specially by OCIStmtExecute(). (Non-SELECT statements absolutely
442 ;; require a nonzero iteration count, while the ordinary choice for a
443 ;; SELECT statement is a zero iteration count.
445 ;; SELECT statements are the only statements which return tables. We
446 ;; don't free STMTHP in this case, but instead give it to the new
447 ;; QUERY-CURSOR, and the new QUERY-CURSOR becomes responsible for
448 ;; freeing the STMTHP when it is no longer needed.
450 (defun sql-stmt-exec (sql-stmt-string db result-types field-names)
451 (with-slots (envhp svchp errhp)
453 (let ((stmthp (uffi:allocate-foreign-object :pointer-void)))
454 (uffi:with-foreign-object (stmttype :unsigned-short)
456 (oci-handle-alloc (deref-vp envhp)
458 +oci-htype-stmt+ 0 +null-void-pointer-pointer+)
459 (oci-stmt-prepare (deref-vp stmthp)
461 (uffi:convert-to-cstring sql-stmt-string)
462 (length sql-stmt-string)
463 +oci-ntv-syntax+ +oci-default+ :database db)
464 (oci-attr-get (deref-vp stmthp)
467 (uffi:make-null-pointer :unsigned-int)
471 (let* ((select-p (= (uffi:deref-pointer stmttype :unsigned-short) 1))
472 (iters (if select-p 0 1)))
474 (oci-stmt-execute (deref-vp svchp)
477 iters 0 +null-void-pointer+ +null-void-pointer+ +oci-default+
480 (make-query-cursor db stmthp result-types field-names))
482 (oci-handle-free (deref-vp stmthp) +oci-htype-stmt+)
486 ;; Return a QUERY-CURSOR representing the table returned from the OCI
487 ;; operation done through STMTHP. TYPES is the argument of the same
488 ;; name from the external SQL function, controlling type conversion
489 ;; of the returned arguments.
491 (defun make-query-cursor (db stmthp result-types field-names)
492 (let ((qc (%make-query-cursor :db db
494 :cds (make-query-cursor-cds db stmthp
497 (refill-qc-buffers qc)
501 ;; the hairy part of MAKE-QUERY-CURSOR: Ask OCI for information
502 ;; about table columns, translate the information into a Lisp
503 ;; vector of column descriptors, and return it.
505 ;; Allegro defines several flavors of type conversion, but this
506 ;; implementation only supports the :AUTO flavor.
508 ;; A note of explanation: OCI's internal number format uses 21
509 ;; bytes (42 decimal digits). 2 separate (?) one-byte fields,
510 ;; scale and precision, are used to deduce the nature of these
511 ;; 21 bytes. See pp. 3-10, 3-26, and 6-13 of OCI documentation
514 ;; When calling OCI C code to handle the conversion, we have
515 ;; only two numeric types available to pass the return value:
516 ;; double-float and signed-long. It would be possible to
517 ;; bypass the OCI conversion functions and write Lisp code
518 ;; which reads the 21-byte field directly and decodes
519 ;; it. However this is left as an exercise for the reader. :-)
521 ;; The following table describes the mapping, based on the implicit
522 ;; assumption that C's "signed long" type is a 32-bit integer.
524 ;; Internal Values SQL Type C Return Type
525 ;; =============== ======== =============
526 ;; Precision > 0 SCALE = -127 FLOAT --> double-float
527 ;; Precision > 0 && <=9 SCALE = 0 INTEGER --> signed-long
528 ;; Precision = 0 || > 9 SCALE = 0 BIG INTEGER --> double-float
529 ;; Precision > 0 SCALE > 0 DECIMAL --> double-float
531 ;; (OCI uses 1-based indexing here.)
533 ;; KLUDGE: This should work for all other data types except those
534 ;; which don't actually fit in their fixed-width field (BLOBs and the
535 ;; like). As Winton says, we (Cadabra) don't need to worry much about
536 ;; those, since we can't reason with them, so we don't use them. But
537 ;; for a more general application it'd be good to have a more
538 ;; selective and rigorously correct test here for whether we can
539 ;; actually handle the given DEREF-DTYPE value. -- WHN 20000106
541 ;; Note: The OCI documentation doesn't seem to say whether the COLNAME
542 ;; value returned here is a newly-allocated copy which we're
543 ;; responsible for freeing, or a pointer into some system copy which
544 ;; will be freed when the system itself is shut down. But judging
545 ;; from the way that the result is used in the cdemodsa.c example
546 ;; program, it looks like the latter: we should make our own copy of
547 ;; the value, but not try to free it.
549 ;; WORKAROUND: OCI seems to return ub2 values for the
550 ;; +oci-attr-data-size+ attribute even though its documentation claims
551 ;; that it returns a ub4, and even though the associated "sizep" value
552 ;; is 4, not 2. In order to make the code here work reliably, without
553 ;; having to patch it later if OCI is ever fixed to match its
554 ;; documentation, we pre-zero COLSIZE before making the call into OCI.
556 ;; To exercise the weird OCI behavior (thereby blowing up the code
557 ;; below, beware!) try setting this value into COLSIZE, calling OCI,
558 ;; then looking at the value in COLSIZE. (setf colsize #x12345678)
562 (defun make-query-cursor-cds (database stmthp result-types field-names)
563 (declare (optimize (safety 3) #+nil (speed 3))
564 (type oracle-database database)
565 (type pointer-pointer-void stmthp))
566 (with-slots (errhp) database
567 (uffi:with-foreign-objects ((dtype-foreign :unsigned-short)
568 (parmdp ':pointer-void)
571 (colname '(* :unsigned-char))
572 (colnamelen :unsigned-long)
573 (colsize :unsigned-long)
574 (colsizesize :unsigned-long)
575 (defnp ':pointer-void))
578 (do ((icolumn 0 (1+ icolumn))
579 (cds-as-reversed-list nil))
580 ((not (eql (oci-param-get (deref-vp stmthp)
584 (1+ icolumn) :database database)
586 (coerce (reverse cds-as-reversed-list) 'simple-vector))
587 ;; Decode type of ICOLUMNth column into a type we're prepared to
589 (oci-attr-get (deref-vp parmdp)
592 (uffi:make-null-pointer :unsigned-int)
595 (let ((dtype (uffi:deref-pointer dtype-foreign :unsigned-short)))
598 (setf buffer (acquire-foreign-resource :unsigned-char
599 (* 32 +n-buf-rows+)))
600 (setf sizeof 32 dtype #.SQLT-STR))
602 (oci-attr-get (deref-vp parmdp)
605 (uffi:make-null-pointer :unsigned-int)
608 (oci-attr-get (deref-vp parmdp)
611 (uffi:make-null-pointer :unsigned-int)
614 (let ((*scale (uffi:deref-pointer scale :byte))
615 (*precision (uffi:deref-pointer precision :byte)))
616 ;;(format t "scale=~d, precision=~d~%" *scale *precision)
619 (and (minusp *scale) (< *precision 10)))
620 (setf buffer (acquire-foreign-resource :int +n-buf-rows+)
621 sizeof 4 ;; sizeof(int)
624 (setf buffer (acquire-foreign-resource :double +n-buf-rows+)
625 sizeof 8 ;; sizeof(double)
626 dtype #.SQLT-FLT)))) )
627 ;; Default to SQL-STR
629 (setf (uffi:deref-pointer colsize :unsigned-long) 0
631 (oci-attr-get (deref-vp parmdp)
634 (uffi:make-null-pointer :unsigned-int) ;; (uffi:pointer-address colsizesize)
637 (let ((colsize-including-null (1+ (uffi:deref-pointer colsize :unsigned-long))))
638 (setf buffer (acquire-foreign-resource
639 :unsigned-char (* +n-buf-rows+ colsize-including-null)))
640 (setf sizeof colsize-including-null))))
641 (let ((retcodes (acquire-foreign-resource :unsigned-short +n-buf-rows+))
642 (indicators (acquire-foreign-resource :short +n-buf-rows+))
645 (oci-attr-get (deref-vp parmdp)
651 (setq colname-string (uffi:convert-from-foreign-string
652 (uffi:deref-pointer colname '(* :unsigned-char))
653 :length (uffi:deref-pointer colnamelen :unsigned-long))))
654 (push (make-cd :name colname-string
659 :indicators indicators
661 ((consp result-types)
662 (nth icolumn result-types))
667 cds-as-reversed-list)
668 (oci-define-by-pos (deref-vp stmthp)
671 (1+ icolumn) ; OCI 1-based indexing again
672 (uffi:with-cast-pointer (vp (foreign-resource-buffer buffer) :void)
676 (uffi:with-cast-pointer (vp (foreign-resource-buffer indicators) :void)
678 (uffi:make-null-pointer :unsigned-short)
679 (uffi:with-cast-pointer (vp (foreign-resource-buffer retcodes) :unsigned-short)
681 +oci-default+))))))))
683 ;; Release the resources associated with a QUERY-CURSOR.
685 (defun close-query (qc)
686 (oci-handle-free (deref-vp (qc-stmthp qc)) +oci-htype-stmt+)
687 (let ((cds (qc-cds qc)))
688 (dotimes (i (length cds))
689 (release-cd-resources (aref cds i))))
693 ;; Release the resources associated with a column description.
695 (defun release-cd-resources (cd)
696 (free-foreign-resource (cd-buffer cd))
697 (free-foreign-resource (cd-retcodes cd))
698 (free-foreign-resource (cd-indicators cd))
702 (defmethod database-name-from-spec (connection-spec (database-type (eql :oracle)))
703 (check-connection-spec connection-spec database-type (dsn user password))
704 (destructuring-bind (dsn user password) connection-spec
705 (declare (ignore password))
706 (concatenate 'string dsn "/" user)))
709 (defmethod database-connect (connection-spec (database-type (eql :oracle)))
710 (check-connection-spec connection-spec database-type (dsn user password))
711 (destructuring-bind (data-source-name user password)
713 (let ((envhp (uffi:allocate-foreign-object :pointer-void))
714 (errhp (uffi:allocate-foreign-object :pointer-void))
715 (svchp (uffi:allocate-foreign-object :pointer-void))
716 (srvhp (uffi:allocate-foreign-object :pointer-void)))
717 ;; Requests to allocate environments and handles should never
718 ;; fail in normal operation, and they're done too early to
719 ;; handle errors very gracefully (since they're part of the
720 ;; error-handling mechanism themselves) so we just assert they
722 (setf (deref-vp envhp) +null-void-pointer+)
725 (oci-env-create envhp +oci-default+ +null-void-pointer+
726 +null-void-pointer+ +null-void-pointer+
727 +null-void-pointer+ 0 +null-void-pointer-pointer+)
728 (oci-handle-alloc envhp
731 +null-void-pointer-pointer+))
734 (oci-initialize +oci-object+ +null-void-pointer+ +null-void-pointer+
735 +null-void-pointer+ +null-void-pointer-pointer+)
736 (ignore-errors (oci-handle-alloc +null-void-pointer+ envhp
738 +null-void-pointer-pointer+)) ;no testing return
739 (oci-env-init envhp +oci-default+ 0 +null-void-pointer-pointer+)
740 (oci-handle-alloc (deref-vp envhp) errhp
741 +oci-htype-error+ 0 +null-void-pointer-pointer+)
742 (oci-handle-alloc (deref-vp envhp) srvhp
743 +oci-htype-server+ 0 +null-void-pointer-pointer+)
744 (uffi:with-cstring (dblink nil)
745 (oci-server-attach (deref-vp srvhp)
749 (oci-handle-alloc (deref-vp envhp) svchp
750 +oci-htype-svcctx+ 0 +null-void-pointer-pointer+)
751 (oci-attr-set (deref-vp svchp)
753 (deref-vp srvhp) 0 +oci-attr-server+
755 ;; oci-handle-alloc((dvoid *)encvhp, (dvoid **)&stmthp, OCI_HTYPE_STMT, 0, 0);
758 (let (db server-version)
759 (uffi:with-foreign-object (buf '(:array :unsigned-char #.+errbuf-len+))
760 (oci-server-version (deref-vp svchp)
762 (uffi:char-array-to-pointer buf)
763 +errbuf-len+ +oci-htype-svcctx+)
764 (setf server-version (uffi:convert-from-foreign-string buf)))
765 (setq db (make-instance 'oracle-database
766 :name (database-name-from-spec connection-spec
770 :database-type :oracle
772 :dsn data-source-name
774 :server-version server-version
775 :major-version-number (major-version-from-string
778 (oci-logon (deref-vp envhp)
781 (uffi:convert-to-cstring user) (length user)
782 (uffi:convert-to-cstring password) (length password)
783 (uffi:convert-to-cstring data-source-name) (length data-source-name)
785 ;; :date-format-length (1+ (length date-format)))))
786 (setf (slot-value db 'clsql-sys::state) :open)
787 (database-execute-command
788 (format nil "alter session set NLS_DATE_FORMAT='~A'" (date-format db)) db)
792 (defun major-version-from-string (str)
794 ((search " 10g " str)
800 ;; Close a database connection.
802 (defmethod database-disconnect ((database oracle-database))
803 (osucc (oci-logoff (deref-vp (svchp database))
804 (deref-vp (errhp database))))
805 (osucc (oci-handle-free (deref-vp (envhp database)) +oci-htype-env+))
806 ;; Note: It's neither required nor allowed to explicitly deallocate the
807 ;; ERRHP handle here, since it's owned by the ENVHP deallocated above,
808 ;; and was therefore automatically deallocated at the same time.
811 ;;; Do the database operation described in SQL-STMT-STRING on database
812 ;;; DB and, if the command is a SELECT, return a representation of the
813 ;;; resulting table. The representation of the table is controlled by the
815 ;;; * If QUERY is NIL, the table is returned as a list of rows, with
816 ;;; each row represented by a list.
817 ;;; * If QUERY is non-NIL, the result is returned as a QUERY-CURSOR
818 ;;; suitable for FETCH-ROW and CLOSE-QUERY
819 ;;; The TYPES argument controls the type conversion method used
820 ;;; to construct the table. The Allegro version supports several possible
821 ;;; values for this argument, but we only support :AUTO.
823 (defmethod database-query (query-expression (database oracle-database) result-types field-names)
824 (let ((cursor (sql-stmt-exec query-expression database result-types field-names)))
825 ;; (declare (type (or query-cursor null) cursor))
826 (if (null cursor) ; No table was returned.
828 (do ((reversed-result nil))
830 (let* ((eof-value :eof)
831 (row (fetch-row cursor nil eof-value)))
832 (when (eq row eof-value)
835 (return (values (nreverse reversed-result)
836 (loop for cd across (qc-cds cursor)
837 collect (cd-name cd))))
838 (return (nreverse reversed-result))))
839 (push row reversed-result))))))
842 (defmethod database-create-sequence
843 (sequence-name (database oracle-database))
845 (concatenate 'string "CREATE SEQUENCE "
846 (sql-escape sequence-name))
849 (defmethod database-drop-sequence
850 (sequence-name (database oracle-database))
852 (concatenate 'string "DROP SEQUENCE "
853 (sql-escape sequence-name))
856 (defmethod database-sequence-next (sequence-name (database oracle-database))
859 (concatenate 'string "SELECT "
860 (sql-escape sequence-name)
862 ) :database database)))
864 (defmethod database-list-sequences ((database oracle-database) &key owner)
865 (mapcar #'car (database-query "select sequence_name from user_sequences"
868 (defmethod database-execute-command (sql-expression (database oracle-database))
869 (database-query sql-expression database nil nil)
871 (database-query "commit" database nil nil)
875 (defstruct (cd (:constructor make-cd)
876 (:print-function print-cd))
877 "a column descriptor: metadata about the data in a table"
879 ;; name of this column
880 (name (error "missing NAME") :type simple-string :read-only t)
881 ;; the size in bytes of a single element
882 (sizeof (error "missing SIZE") :type fixnum :read-only t)
883 ;; an array of +N-BUF-ROWS+ elements in C representation
884 (buffer (error "Missing BUFFER")
885 :type foreign-resource
887 ;; an array of +N-BUF-ROWS+ OCI return codes in C representation.
888 ;; (There must be one return code for every element of every
889 ;; row in order to be able to represent nullness.)
890 (retcodes (error "Missing RETCODES")
891 :type foreign-resource
893 (indicators (error "Missing INDICATORS")
894 :type foreign-resource
896 ;; the OCI code for the data type of a single element
897 (oci-data-type (error "missing OCI-DATA-TYPE")
900 (result-type (error "missing RESULT-TYPE")
904 (defun print-cd (cd stream depth)
905 (declare (ignore depth))
906 (print-unreadable-object (cd stream :type t)
908 ":NAME ~S :OCI-DATA-TYPE ~S :OCI-DATA-SIZE ~S"
910 (cd-oci-data-type cd)
913 (defun print-query-cursor (qc stream depth)
914 (declare (ignore depth))
915 (print-unreadable-object (qc stream :type t :identity t)
916 (prin1 (qc-db qc) stream)))
919 (defmethod database-query-result-set ((query-expression string)
920 (database oracle-database)
921 &key full-set result-types)
922 (let ((cursor (sql-stmt-exec query-expression database result-types nil)))
924 (values cursor (length (qc-cds cursor)) nil)
925 (values cursor (length (qc-cds cursor))))))
928 (defmethod database-dump-result-set (result-set (database oracle-database))
929 (close-query result-set))
931 (defmethod database-store-next-row (result-set (database oracle-database) list)
932 (let* ((eof-value :eof)
933 (row (fetch-row result-set nil eof-value)))
934 (unless (eq eof-value row)
935 (loop for i from 0 below (length row)
936 do (setf (nth i list) (nth i row)))
939 (defmethod clsql-sys:database-start-transaction ((database oracle-database))
942 ;;(with-slots (svchp errhp) database
943 ;; (osucc (oci-trans-start (uffi:deref-pointer svchp)
944 ;; (uffi:deref-pointer errhp)
946 ;; +oci-trans-new+)))
950 (defmethod clsql-sys:database-commit-transaction ((database oracle-database))
952 (with-slots (svchp errhp) database
953 (osucc (oci-trans-commit (deref-vp svchp)
958 (defmethod clsql-sys:database-abort-transaction ((database oracle-database))
960 (osucc (oci-trans-rollback (deref-vp (svchp database))
961 (deref-vp (errhp database))
965 (defparameter *constraint-types*
966 '(("NOT-NULL" . "NOT NULL")))
968 (defmethod database-output-sql ((str string) (database oracle-database))
969 (if (and (null (position #\' str))
970 (null (position #\\ str)))
971 (format nil "'~A'" str)
972 (let* ((l (length str))
973 (buf (make-string (+ l 3))))
974 (setf (aref buf 0) #\')
977 ((= i l) (setf (aref buf j) #\'))
978 (if (= j (- (length buf) 1))
979 (setf buf (adjust-array buf (+ (length buf) 1))))
980 (cond ((eql (aref str i) #\')
981 (setf (aref buf j) #\')
983 (setf (aref buf j) (aref str i)))
989 (defmethod db-type-has-bigint? ((type (eql :oracle)))
992 (defmethod db-type-has-fancy-math? ((db-type (eql :oracle)))
995 (defmethod db-type-has-boolean-where? ((db-type (eql :oracle)))
998 (when (clsql-sys:database-type-library-loaded :oracle)
999 (clsql-sys:initialize-database-type :database-type :oracle))