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 ;;;; KLUDGE: The original prototype of this code was implemented using
23 ;;;; lots of special variables holding MAKE-ALIEN values. When I was
24 ;;;; first converting it to use WITH-ALIEN variables, I was confused
25 ;;;; about the behavior of MAKE-ALIEN and WITH-ALIEN; I thought that
26 ;;;; (MAKE-ALIEN TYPEFOO) returned the same type of object as is bound
27 ;;;; to the name BAR by (WITH-ALIEN ((BAR TYPEFOO)) ..). In fact the
28 ;;;; value returned by MAKE-ALIEN has an extra level of indirection
29 ;;;; relative to the value bound by WITH-ALIEN, i.e. (DEREF
30 ;;;; (MAKE-ALIEN TYPEFOO)) has the same type as the value bound to the
31 ;;;; name BAR by (WITH-ALIEN ((BAR TYPEFOO)) ..). Laboring under my
32 ;;;; misunderstanding, I was unable to use ordinary scalars bound by
33 ;;;; WITH-ALIEN, and I ended up giving up and deciding to work around
34 ;;;; this apparent bug in CMUCL by using 1-element arrays instead.
35 ;;;; This "workaround" for my misunderstanding is obviously unnecessary
36 ;;;; and confusing, but still remains in the code. -- WHN 20000106
39 ;;;; arbitrary parameters, tunable for performance or other reasons
41 (uffi:def-foreign-type void-pointer (* :void))
43 (eval-when (:compile-toplevel :load-toplevel :execute)
44 (defconstant +errbuf-len+ 512
45 "the number of characters that we allocate for an error message buffer")
46 (defconstant +n-buf-rows+ 200
47 "the number of table rows that we buffer at once when reading a table.
48 CMUCL has a compiled-in limit on how much C data can be allocated
49 (through malloc() and friends) at any given time, typically 8 Mb.
50 Setting this constant to a moderate value should make it less
51 likely that we'll have to worry about the CMUCL limit."))
54 ;;; utilities for mucking around with C-level stuff
56 ;; Return the address of ALIEN-OBJECT (like the C operator "&").
58 ;; The INDICES argument is useful to give the ALIEN-OBJECT the
59 ;; expected number of zero indices, especially when we have a bunch of
60 ;; 1-element arrays running around due to the workaround for the CMUCL
61 ;; 18b WITH-ALIEN scalar bug.
63 (defmacro c-& (alien-object type)
64 `(uffi:pointer-address (uffi:deref-pointer ,alien-object ,type)))
66 ;; constants - from OCI?
68 (defconstant +var-not-in-list+ 1007)
69 (defconstant +no-data-found+ 1403)
70 (defconstant +null-value-returned+ 1405)
71 (defconstant +field-truncated+ 1406)
73 (eval-when (:compile-toplevel :load-toplevel :execute)
74 (defconstant SQLT-INT 3)
75 (defconstant SQLT-STR 5)
76 (defconstant SQLT-FLT 4)
77 (defconstant SQLT-DATE 12))
79 ;;; Note that despite the suggestive class name (and the way that the
80 ;;; *DEFAULT-DATABASE* variable holds an object of this class), a DB
81 ;;; object is not actually a database but is instead a connection to a
82 ;;; database. Thus, there's no obstacle to having any number of DB
83 ;;; objects referring to the same database.
85 (uffi:def-type pointer-pointer-void '(* (* :void)))
87 (defclass oracle-database (database) ; was struct db
91 :type pointer-pointer-void
93 "OCI environment handle")
97 :type pointer-pointer-void
103 :type pointer-pointer-void
105 "OCI service context handle")
110 "optional data source name (used only for debugging/printing)")
116 "the \"user\" value given when data source connection was made")
118 :initarg :date-format
120 :initform "YYYY-MM-DD HH24:MI:SS\"+00\"")
124 "Each database connection can be configured with its own date
125 output format. In order to extract date strings from output buffers
126 holding multiple date strings in fixed-width fields, we need to know
127 the length of that format.")))
130 ;;; Handle the messy case of return code=+oci-error+, querying the
131 ;;; system for subcodes and reporting them as appropriate. ERRHP and
132 ;;; NULLS-OK are as in the OERR function.
134 (defun handle-oci-error (&key database nulls-ok)
138 (uffi:with-foreign-objects ((errbuf (:array :unsigned-char #.+errbuf-len+))
140 (setf (uffi:deref-array errbuf '(:array :unsigned-char) 0) (code-char 0)) ; i.e. init to empty string
141 (setf (uffi:deref-pointer errcode :long) 0)
142 (oci-error-get (uffi:deref-pointer errhp '(* :void)) 1 "" (c-& errcode :unsigned-char)
143 (c-& errbuf :unsigned-char) +errbuf-len+ +oci-htype-error+)
144 (let ((subcode (uffi:deref-pointer errcode :long)))
145 (unless (and nulls-ok (= subcode +null-value-returned+))
146 (error 'clsql-sql-error
149 :error (uffi:convert-from-foreign-string errbuf)))))))
151 (error 'clsql-sql-error
153 :error "can't handle NULLS-OK without ERRHP"))
155 (error 'clsql-sql-error
157 :error "OCI Error (and no ERRHP available to find subcode)"))))
159 ;;; Require an OCI success code.
161 ;;; (The ordinary OCI error reporting mechanisms uses a fair amount of
162 ;;; machinery (environments and other handles). In order to get to
163 ;;; where we can use these mechanisms, we have to be able to allocate
164 ;;; the machinery. The functions for allocating the machinery can
165 ;;; return errors (e.g. out of memory) but shouldn't. Wrapping this function
166 ;;; around function calls to such have-to-succeed functions enforces
170 (declare (type fixnum code))
171 (unless (= code +oci-success+)
173 :format-control "unexpected OCI failure, code=~S"
174 :format-arguments (list code))))
177 ;;; Enabling this can be handy for low-level debugging.
180 (trace oci-initialize #+oci-8-1-5 oci-env-create oci-handle-alloc oci-logon
181 oci-error-get oci-stmt-prepare oci-stmt-execute
182 oci-param-get oci-logon oci-attr-get oci-define-by-pos oci-stmt-fetch)
183 (setf debug::*debug-print-length* nil))
186 ;;;; the OCI library, part V: converting from OCI representations to Lisp
189 ;; Return the INDEXth string of the OCI array, represented as Lisp
190 ;; SIMPLE-STRING. SIZE is the size of the fixed-width fields used by
191 ;; Oracle to store strings within the array.
193 ;; In the wild world of databases, trailing spaces aren't generally
194 ;; significant, since e.g. "LARRY " and "LARRY " are the same string
195 ;; stored in different fixed-width fields. OCI drops trailing spaces
196 ;; for us in some cases but apparently not for fields of fixed
197 ;; character width, e.g.
199 ;; (dbi:sql "create table employees (name char(15), job char(15), city
200 ;; char(15), rate float)" :db orcl :types :auto)
201 ;; In order to map the "same string" property above onto Lisp equality,
202 ;; we drop trailing spaces in all cases:
204 (uffi:def-type string-pointer (* :unsigned-char))
206 (defun deref-oci-string (arrayptr string-index size)
207 (declare (type string-pointer arrayptr))
208 (declare (type (mod #.+n-buf-rows+) string-index))
209 (declare (type (and unsigned-byte fixnum) size))
210 (let* ((raw (uffi:convert-from-foreign-string
211 (uffi:pointer-address (uffi:deref-array arrayptr '(:array :unsigned-char) (* string-index size)))))
212 (trimmed (string-trim " " raw)))
213 (if (equal trimmed "NULL") nil trimmed)))
215 ;; the OCI library, part Z: no-longer used logic to convert from
216 ;; Oracle's binary date representation to Common Lisp's native date
220 (defvar +oci-date-bytes+ 7)
222 ;;; Return the INDEXth date in the OCI array, represented as
223 ;;; a Common Lisp "universal time" (i.e. seconds since 1900).
226 (defun deref-oci-date (arrayptr index)
227 (oci-date->universal-time (uffi:pointer-address (uffi:deref-array arrayptr '(:array :unsigned-char)
228 (* index +oci-date-bytes+)))))
230 (defun oci-date->universal-time (oci-date)
231 (declare (type (alien (* :unsigned-char)) oci-date))
232 (flet (;; a character from OCI-DATE, interpreted as an unsigned byte
234 (declare (type (mod #.+oci-date-bytes+) i))
235 (mod (uffi:deref-array oci-date string-pointer i) 256)))
236 (let* ((century (* (- (ub 0) 100) 100))
237 (year (+ century (- (ub 1) 100)))
242 (second (1- (ub 6))))
243 (encode-universal-time second minute hour day month year))))
245 ;; Return (VALUES ALL-TABLES COLUMN-NAMES), where ALL-TABLES is a
246 ;; table containing one row for each table available in DB, and
247 ;; COLUMN-NAMES is a list of header names for the columns in
250 ;; The Allegro version also accepted a HSTMT argument.
252 ;(defmethod database-list-tables ((db oracle-database))
253 ; (sql:query "select '',OWNER,TABLE_NAME,TABLE_TYPE,'' from all_catalog"))
256 (defmethod list-all-user-database-tables ((db oracle-database))
258 (setf db clsql:*default-database*))
259 (values (database-query "select TABLE_NAME from all_catalog
260 where owner <> 'PUBLIC' and owner <> 'SYSTEM' and owner <> 'SYS'"
264 (defmethod database-list-tables ((database oracle-database)
265 &key (system-tables nil) owner)
267 (database-query "select table_name from all_catalog" database nil nil)
268 (database-query "select table_name from all_catalog where owner <> 'PUBLIC' and owner <> 'SYSTEM' and owner <> 'SYS'"
271 ;; Return a list of all columns in TABLE.
273 ;; The Allegro version of this also returned a second value.
275 (defmethod list-all-table-columns (table (db oracle-database))
276 (declare (type string table))
278 (setf db clsql:*default-database*))
279 (let* ((sql-stmt (concatenate
285 "user_tab_columns.COLUMN_NAME,"
286 "user_tab_columns.DATA_TYPE from user_tab_columns,"
287 "all_tables where all_tables.table_name = '" table "'"
288 " and user_tab_columns.table_name = '" table "'"))
289 (preresult (sql sql-stmt :db db :types :auto)))
290 ;; PRERESULT is like RESULT except that it has a name instead of
291 ;; type codes in the fifth column of each row. To fix this, we
292 ;; destructively modify PRERESULT.
293 (dolist (preresult-row preresult)
294 (setf (fifth preresult-row)
295 (if (find (fifth preresult-row)
302 (defmethod database-list-attributes (table (database oracle-database) &key owner)
303 (let* ((relname (etypecase table
304 (clsql-sys::sql-ident
306 (symbol-name (slot-value table 'clsql-sys::name))))
311 "select user_tab_columns,column_name from user_tab_columns where user_tab_columns.table_name=~A"
317 ;; Return one row of the table referred to by QC, represented as a
318 ;; list; or if there are no more rows, signal an error if EOF-ERRORP,
319 ;; or return EOF-VALUE otherwise.
321 ;; KLUDGE: This CASE statement is a strong sign that the code would be
322 ;; cleaner if CD were made into an abstract class, we made variant
323 ;; classes for CD-for-column-of-strings, CD-for-column-of-floats,
324 ;; etc., and defined virtual functions to handle operations like
325 ;; get-an-element-from-column. (For a small special purpose module
326 ;; like this, would arguably be overkill, so I'm not going to do it
327 ;; now, but if this code ends up getting more complicated in
328 ;; maintenance, it would become a really good idea.)
330 ;; Arguably this would be a good place to signal END-OF-FILE, but
331 ;; since the ANSI spec specifically says that END-OF-FILE means a
332 ;; STREAM which has no more data, and QC is not a STREAM, we signal
333 ;; DBI-ERROR instead.
335 (uffi:def-type short-pointer '(* :short))
336 (uffi:def-type double-pointer '(* :double))
338 (defun fetch-row (qc &optional (eof-errorp t) eof-value)
339 (declare (optimize (speed 3)))
340 (cond ((zerop (qc-n-from-oci qc))
342 (error 'clsql-error :message
343 (format nil "no more rows available in ~S" qc))
345 ((>= (qc-n-to-dbi qc)
347 (refill-qc-buffers qc)
348 (fetch-row qc nil eof-value))
350 (let ((cds (qc-cds qc))
351 (reversed-result nil)
352 (irow (qc-n-to-dbi qc)))
353 (dotimes (icd (length cds))
354 (let* ((cd (aref cds icd))
355 (b (foreign-resource-buffer (cd-buffer cd)))
357 (let ((arb (foreign-resource-buffer (cd-indicators cd))))
358 (declare (type short-pointer arb))
359 (unless (= (uffi:deref-array arb :int irow) -1)
360 (ecase (cd-oci-data-type cd)
361 (#.SQLT-STR (deref-oci-string b irow (cd-sizeof cd)))
362 (#.SQLT-FLT (uffi:deref-array b '(:array :double) irow))
363 (#.SQLT-INT (uffi:deref-array b '(:array :int) irow))
364 (#.SQLT-DATE (deref-oci-string b irow (cd-sizeof cd))))))))
365 (push value reversed-result)))
366 (incf (qc-n-to-dbi qc))
367 (nreverse reversed-result)))))
369 (defun refill-qc-buffers (qc)
372 (setf (qc-n-to-dbi qc) 0)
373 (cond ((qc-oci-end-seen-p qc)
374 (setf (qc-n-from-oci qc) 0))
376 (let ((oci-code (%oci-stmt-fetch (uffi:deref-pointer (qc-stmthp qc) void-pointer)
377 (uffi:deref-pointer errhp void-pointer)
379 +oci-fetch-next+ +oci-default+)))
381 (#.+oci-success+ (values))
382 (#.+oci-no-data+ (setf (qc-oci-end-seen-p qc) t)
384 (#.+oci-error+ (handle-oci-error :database (qc-db qc)
386 (uffi:with-foreign-object (rowcount :long)
387 (oci-attr-get (uffi:deref-pointer (qc-stmthp qc) void-pointer) +oci-htype-stmt+
388 (c-& rowcount :long) nil +oci-attr-row-count+
389 (uffi:deref-pointer errhp void-pointer))
390 (setf (qc-n-from-oci qc)
391 (- (uffi:deref-pointer rowcount :long) (qc-total-n-from-oci qc)))
392 (when (< (qc-n-from-oci qc) +n-buf-rows+)
393 (setf (qc-oci-end-seen-p qc) t))
394 (setf (qc-total-n-from-oci qc)
395 (uffi:deref-pointer rowcount :long)))))
398 ;; the guts of the SQL function
400 ;; (like the SQL function, but with the QUERY argument hardwired to T, so
401 ;; that the return value is always a cursor instead of a list)
403 ;; Is this a SELECT statement? SELECT statements are handled
404 ;; specially by OCIStmtExecute(). (Non-SELECT statements absolutely
405 ;; require a nonzero iteration count, while the ordinary choice for a
406 ;; SELECT statement is a zero iteration count.
408 ;; SELECT statements are the only statements which return tables. We
409 ;; don't free STMTHP in this case, but instead give it to the new
410 ;; QUERY-CURSOR, and the new QUERY-CURSOR becomes responsible for
411 ;; freeing the STMTHP when it is no longer needed.
413 (defun sql-stmt-exec (sql-stmt-string db &key types)
414 (with-slots (envhp svchp errhp)
416 (let ((stmthp (uffi:allocate-foreign-object (* :void))))
417 (uffi:with-foreign-object (stmttype :unsigned-short)
419 (oci-handle-alloc (uffi:deref-pointer envhp void-pointer) (c-& stmthp void-pointer) +oci-htype-stmt+ 0 nil)
420 (oci-stmt-prepare (uffi:deref-pointer stmthp void-pointer) (uffi:deref-pointer errhp void-pointer)
421 sql-stmt-string (length sql-stmt-string)
422 +oci-ntv-syntax+ +oci-default+ :database db)
423 (oci-attr-get (uffi:deref-pointer stmthp void-pointer) +oci-htype-stmt+
424 (c-& stmttype :unsigned-short) nil +oci-attr-stmt-type+
425 (uffi:deref-pointer errhp void-pointer) :database db)
426 (let* ((select-p (= (uffi:deref-pointer stmttype :unsigned-short) 1))
427 (iters (if select-p 0 1)))
429 (oci-stmt-execute (uffi:deref-pointer svchp void-pointer) (uffi:deref-pointer stmthp void-pointer)
430 (uffi:deref-pointer errhp void-pointer)
431 iters 0 nil nil +oci-default+ :database db)
433 (make-query-cursor db stmthp types))
435 (oci-handle-free (uffi:deref-pointer stmthp void-pointer) +oci-htype-stmt+)
439 ;; Return a QUERY-CURSOR representing the table returned from the OCI
440 ;; operation done through STMTHP. TYPES is the argument of the same
441 ;; name from the external SQL function, controlling type conversion
442 ;; of the returned arguments.
444 (defun make-query-cursor (db stmthp types)
445 (let ((qc (%make-query-cursor :db db
447 :cds (make-query-cursor-cds db stmthp types))))
448 (refill-qc-buffers qc)
452 ;; the hairy part of MAKE-QUERY-CURSOR: Ask OCI for information
453 ;; about table columns, translate the information into a Lisp
454 ;; vector of column descriptors, and return it.
456 ;; Allegro defines several flavors of type conversion, but this
457 ;; implementation only supports the :AUTO flavor.
459 ;; A note of explanation: OCI's internal number format uses 21
460 ;; bytes (42 decimal digits). 2 separate (?) one-byte fields,
461 ;; scale and precision, are used to deduce the nature of these
462 ;; 21 bytes. See pp. 3-10, 3-26, and 6-13 of OCI documentation
465 ;; When calling OCI C code to handle the conversion, we have
466 ;; only two numeric types available to pass the return value:
467 ;; double-float and signed-long. It would be possible to
468 ;; bypass the OCI conversion functions and write Lisp code
469 ;; which reads the 21-byte field directly and decodes
470 ;; it. However this is left as an exercise for the reader. :-)
472 ;; The following table describes the mapping, based on the implicit
473 ;; assumption that C's "signed long" type is a 32-bit integer.
475 ;; Internal Values SQL Type C Return Type
476 ;; =============== ======== =============
477 ;; Precision > 0 SCALE = -127 FLOAT --> double-float
478 ;; Precision > 0 && <=9 SCALE = 0 INTEGER --> signed-long
479 ;; Precision = 0 || > 9 SCALE = 0 BIG INTEGER --> double-float
480 ;; Precision > 0 SCALE > 0 DECIMAL --> double-float
482 ;; (OCI uses 1-based indexing here.)
484 ;; KLUDGE: This should work for all other data types except those
485 ;; which don't actually fit in their fixed-width field (BLOBs and the
486 ;; like). As Winton says, we (Cadabra) don't need to worry much about
487 ;; those, since we can't reason with them, so we don't use them. But
488 ;; for a more general application it'd be good to have a more
489 ;; selective and rigorously correct test here for whether we can
490 ;; actually handle the given DEREF-DTYPE value. -- WHN 20000106
492 ;; Note: The OCI documentation doesn't seem to say whether the COLNAME
493 ;; value returned here is a newly-allocated copy which we're
494 ;; responsible for freeing, or a pointer into some system copy which
495 ;; will be freed when the system itself is shut down. But judging
496 ;; from the way that the result is used in the cdemodsa.c example
497 ;; program, it looks like the latter: we should make our own copy of
498 ;; the value, but not try to free it.
500 ;; WORKAROUND: OCI seems to return ub2 values for the
501 ;; +oci-attr-data-size+ attribute even though its documentation claims
502 ;; that it returns a ub4, and even though the associated "sizep" value
503 ;; is 4, not 2. In order to make the code here work reliably, without
504 ;; having to patch it later if OCI is ever fixed to match its
505 ;; documentation, we pre-zero COLSIZE before making the call into OCI.
507 ;; To exercise the weird OCI behavior (thereby blowing up the code
508 ;; below, beware!) try setting this value into COLSIZE, calling OCI,
509 ;; then looking at the value in COLSIZE. (setf colsize #x12345678)
513 (defun make-query-cursor-cds (database stmthp types)
514 (declare (optimize (speed 3))
515 (type oracle-database database)
516 (type pointer-pointer-void stmthp))
519 (unless (eq types :auto)
520 (error "unsupported TYPES value"))
521 (uffi:with-foreign-objects ((dtype :unsigned-short)
525 (colname (* :unsigned-char))
526 (colnamelen :unsigned-long)
527 (colsize :unsigned-long)
528 (colsizesize :unsigned-long)
532 (do ((icolumn 0 (1+ icolumn))
533 (cds-as-reversed-list nil))
534 ((not (eql (oci-param-get (uffi:deref-pointer stmthp void-pointer) +oci-htype-stmt+
535 (uffi:deref-pointer errhp void-pointer)
536 (uffi:pointer-address parmdp)
537 (1+ icolumn) :database database)
539 (coerce (reverse cds-as-reversed-list) 'simple-vector))
540 ;; Decode type of ICOLUMNth column into a type we're prepared to
542 (oci-attr-get parmdp +oci-dtype-param+ (uffi:pointer-address dtype)
543 nil +oci-attr-data-type+ (uffi:deref-pointer errhp void-pointer))
546 (setf buffer (acquire-foreign-resource char (* 32 +n-buf-rows+)))
547 (setf sizeof 32 dtype #.SQLT-STR))
549 ;;(oci-attr-get parmdp +oci-dtype-param+
550 ;;(addr precision) nil +oci-attr-precision+
551 ;;(uffi:deref-pointer errhp))
552 (oci-attr-get parmdp +oci-dtype-param+
553 (uffi:pointer-address scale) nil +oci-attr-scale+
554 (uffi:deref-pointer errhp void-pointer))
557 (setf buffer (acquire-foreign-resource signed +n-buf-rows+)
558 sizeof 4 ;; sizeof(int)
561 (setf buffer (acquire-foreign-resource double-float +n-buf-rows+)
562 sizeof 8 ;; sizeof(double)
564 (t ; Default to SQL-STR
567 (oci-attr-get parmdp +oci-dtype-param+ (uffi:pointer-address colsize)
568 (uffi:pointer-address colsizesize) +oci-attr-data-size+
569 (uffi:deref-pointer errhp void-pointer))
570 (let ((colsize-including-null (1+ colsize)))
571 (setf buffer (acquire-foreign-resource char (* +n-buf-rows+ colsize-including-null)))
572 (setf sizeof colsize-including-null))))
573 (let ((retcodes (acquire-foreign-resource short +n-buf-rows+))
574 (indicators (acquire-foreign-resource short +n-buf-rows+)))
575 (push (make-cd :name "col" ;(subseq colname 0 colnamelen)
580 :indicators indicators)
581 cds-as-reversed-list)
582 (oci-define-by-pos (uffi:deref-pointer stmthp void-pointer)
583 (uffi:pointer-address defnp)
584 (uffi:deref-pointer errhp void-pointer)
585 (1+ icolumn) ; OCI 1-based indexing again
586 (foreign-resource-buffer buffer)
589 (foreign-resource-buffer indicators)
591 (foreign-resource-buffer retcodes)
594 ;; Release the resources associated with a QUERY-CURSOR.
596 (defun close-query (qc)
597 (oci-handle-free (uffi:deref-pointer (qc-stmthp qc) void-pointer) +oci-htype-stmt+)
598 (let ((cds (qc-cds qc)))
599 (dotimes (i (length cds))
600 (release-cd-resources (aref cds i))))
604 ;; Release the resources associated with a column description.
606 (defun release-cd-resources (cd)
607 (free-foreign-resource (cd-buffer cd))
608 (free-foreign-resource (cd-retcodes cd))
609 (free-foreign-resource (cd-indicators cd))
613 (defmethod print-object ((db oracle-database) stream)
614 (print-unreadable-object (db stream :type t :identity t)
615 (format stream "\"/~a/~a\""
616 (slot-value db 'data-source-name)
617 (slot-value db 'user))))
620 (defmethod database-name-from-spec (connection-spec (database-type (eql :oracle)))
621 (check-connection-spec connection-spec database-type (user password dsn))
622 (destructuring-bind (user password dsn)
624 (declare (ignore password))
625 (concatenate 'string "/" dsn "/" user)))
628 (defmethod database-connect (connection-spec (database-type (eql :oracle)))
629 (check-connection-spec connection-spec database-type (user password dsn))
630 (destructuring-bind (user password data-source-name)
632 (let ((envhp (uffi:allocate-foreign-object (* :void)))
633 (errhp (uffi:allocate-foreign-object (* :void)))
634 (svchp (uffi:allocate-foreign-object (* :void)))
635 (srvhp (uffi:allocate-foreign-object (* :void))))
636 ;; Requests to allocate environments and handles should never
637 ;; fail in normal operation, and they're done too early to
638 ;; handle errors very gracefully (since they're part of the
639 ;; error-handling mechanism themselves) so we just assert they
641 (setf (uffi:deref-pointer envhp void-pointer) nil)
644 (oci-env-create (c-& envhp void-pointer) +oci-default+ nil nil nil nil 0 nil)
645 (oci-handle-alloc (uffi:deref-pointer envhp void-pointer)
646 (c-& errhp void-pointer) +oci-htype-error+ 0 nil))
649 (oci-initialize +oci-object+ nil nil nil nil)
650 (ignore-errors (oci-handle-alloc nil (c-& envhp void-pointer) +oci-htype-env+ 0 nil)) ;no testing return
651 (oci-env-init (c-& envhp void-pointer) +oci-default+ 0 nil)
652 (oci-handle-alloc (uffi:deref-pointer envhp void-pointer) (c-& errhp void-pointer) +oci-htype-error+ 0 nil)
653 (oci-handle-alloc (uffi:deref-pointer envhp void-pointer) (c-& srvhp void-pointer) +oci-htype-server+ 0 nil)
654 ;;(osucc (oci-server-attach srvhp errhp nil 0 +oci-default+))
655 (oci-handle-alloc (uffi:deref-pointer envhp void-pointer) (c-& svchp void-pointer) +oci-htype-svcctx+ 0 nil)
656 ;; oci-handle-alloc((dvoid *)encvhp, (dvoid **)&stmthp, OCI_HTYPE_STMT, 0, 0);
658 (oci-attr-set (uffi:deref-pointer svchp void-pointer) +oci-htype-svcctx+
659 (uffi:deref-pointer srvhp void-pointer) 0 +oci-attr-server+ errhp)
663 (format t "Logging in as user '~A' to database ~A~%"
664 user password data-source-name)
665 (oci-logon (uffi:deref-pointer envhp void-pointer) (uffi:deref-pointer errhp void-pointer) (c-& svchp void-pointer)
667 password (length password)
668 data-source-name (length data-source-name))
669 (let ((db (make-instance 'oracle-database
670 :name (database-name-from-spec connection-spec
676 :dsn data-source-name
678 ;; :date-format-length (1+ (length date-format)))))
679 (clsql:execute-command
680 (format nil "alter session set NLS_DATE_FORMAT='~A'"
681 (date-format db)) :database db)
685 ;; Close a database connection.
687 (defmethod database-disconnect ((database oracle-database))
688 (osucc (oci-logoff (uffi:deref-pointer (svchp database) void-pointer)
689 (uffi:deref-pointer (errhp database) void-pointer)))
690 (osucc (oci-handle-free (uffi:deref-pointer (envhp database) void-pointer)
692 ;; Note: It's neither required nor allowed to explicitly deallocate the
693 ;; ERRHP handle here, since it's owned by the ENVHP deallocated above,
694 ;; and was therefore automatically deallocated at the same time.
697 ;;; Do the database operation described in SQL-STMT-STRING on database
698 ;;; DB and, if the command is a SELECT, return a representation of the
699 ;;; resulting table. The representation of the table is controlled by the
701 ;;; * If QUERY is NIL, the table is returned as a list of rows, with
702 ;;; each row represented by a list.
703 ;;; * If QUERY is non-NIL, the result is returned as a QUERY-CURSOR
704 ;;; suitable for FETCH-ROW and CLOSE-QUERY
705 ;;; The TYPES argument controls the type conversion method used
706 ;;; to construct the table. The Allegro version supports several possible
707 ;;; values for this argument, but we only support :AUTO.
709 (defmethod database-query (query-expression (database oracle-database) result-types field-names)
710 (let ((cursor (sql-stmt-exec query-expression database :types :auto)))
711 (declare (type (or query-cursor null) cursor))
712 (if (null cursor) ; No table was returned.
714 (do ((reversed-result nil))
716 (let* ((eof-value :eof)
717 (row (fetch-row cursor nil eof-value)))
718 (when (eq row eof-value)
720 (return (nreverse reversed-result)))
721 (push row reversed-result))))))
724 (defmethod database-create-sequence
725 (sequence-name (database oracle-database))
727 (concatenate 'string "CREATE SEQUENCE "
728 (sql-escape sequence-name))
731 (defmethod database-drop-sequence
732 (sequence-name (database oracle-database))
734 (concatenate 'string "DROP SEQUENCE "
735 (sql-escape sequence-name))
738 (defmethod database-sequence-next (sequence-name (database oracle-database))
741 (concatenate 'string "SELECT "
742 (sql-escape sequence-name)
744 ) :database database)))
747 (defmethod database-execute-command
748 (sql-expression (database oracle-database))
749 (database-query sql-expression database nil nil)
751 (database-query "commit" database nil nil)
755 ;;; a column descriptor: metadata about the data in a table
756 (defstruct (cd (:constructor make-cd)
757 (:print-function print-cd))
758 ;; name of this column
759 (name (error "missing NAME") :type simple-string :read-only t)
760 ;; the size in bytes of a single element
761 (sizeof (error "missing SIZE") :type fixnum :read-only t)
762 ;; an array of +N-BUF-ROWS+ elements in C representation
763 (buffer (error "Missing BUFFER")
764 :type foreign-resource
766 ;; an array of +N-BUF-ROWS+ OCI return codes in C representation.
767 ;; (There must be one return code for every element of every
768 ;; row in order to be able to represent nullness.)
769 (retcodes (error "Missing RETCODES")
770 :type foreign-resource
772 (indicators (error "Missing INDICATORS")
773 :type foreign-resource
775 ;; the OCI code for the data type of a single element
776 (oci-data-type (error "missing OCI-DATA-TYPE")
781 (defun print-cd (cd stream depth)
782 (declare (ignore depth))
783 (print-unreadable-object (cd stream :type t)
785 ":NAME ~S :OCI-DATA-TYPE ~S :OCI-DATA-SIZE ~S"
787 (cd-oci-data-type cd)
790 ;;; the result of a database query: a cursor through a table
791 (defstruct (oracle-result-set (:print-function print-query-cursor)
793 (:constructor %make-query-cursor))
794 (db (error "missing DB") ; db conn. this table is associated with
797 (stmthp (error "missing STMTHP") ; the statement handle used to create
798 ;; :type alien ; this table. owned by the QUERY-CURSOR
799 :read-only t) ; object, deallocated on CLOSE-QUERY
800 (cds) ; (error "missing CDS") ; column descriptors
801 ; :type (simple-array cd 1)
803 (n-from-oci 0 ; buffered rows: number of rows recv'd
804 :type (integer 0 #.+n-buf-rows+)) ; from the database on the last read
805 (n-to-dbi 0 ; number of buffered rows returned, i.e.
806 :type (integer 0 #.+n-buf-rows+)) ; the index, within the buffered rows,
807 ; of the next row which hasn't already
809 (total-n-from-oci 0 ; total number of bytes recv'd from OCI
810 :type unsigned-byte) ; in all reads
811 (oci-end-seen-p nil)) ; Have we seen the end of OCI
812 ; data, i.e. OCI returning
813 ; less data than we requested?
814 ; OCI doesn't seem to like us
815 ; to try to read more data
816 ; from it after that..
818 (defun print-query-cursor (qc stream depth)
819 (declare (ignore depth))
820 (print-unreadable-object (qc stream :type t :identity t)
821 (prin1 (qc-db qc) stream)))
824 (defmethod database-query-result-set ((query-expression string)
825 (database oracle-database)
826 &key full-set result-types)
829 (defmethod database-dump-result-set (result-set (database oracle-database))
832 (defmethod database-store-next-row (result-set (database oracle-database) list)
835 (defmethod clsql-sys::database-start-transaction ((database oracle-database))
838 ;;(with-slots (svchp errhp) database
839 ;; (osucc (oci-trans-start (uffi:deref-pointer svchp)
840 ;; (uffi:deref-pointer errhp)
842 ;; +oci-trans-new+)))
846 (defmethod clsql-sys::database-commit-transaction ((database oracle-database))
848 (with-slots (svchp errhp) database
849 (osucc (oci-trans-commit (uffi:deref-pointer svchp void-pointer)
850 (uffi:deref-pointer errhp void-pointer)
854 (defmethod clsql-sys::database-abort-transaction ((database oracle-database))
856 (osucc (oci-trans-rollback (uffi:deref-pointer (svchp database) void-pointer)
857 (uffi:deref-pointer (errhp database) void-pointer)
861 (defparameter *constraint-types*
862 '(("NOT-NULL" . "NOT NULL")))
864 (defmethod database-output-sql ((str string) (database oracle-database))
865 (if (and (null (position #\' str))
866 (null (position #\\ str)))
867 (format nil "'~A'" str)
868 (let* ((l (length str))
869 (buf (make-string (+ l 3))))
870 (setf (aref buf 0) #\')
873 ((= i l) (setf (aref buf j) #\'))
874 (if (= j (- (length buf) 1))
875 (setf buf (adjust-array buf (+ (length buf) 1))))
876 (cond ((eql (aref str i) #\')
877 (setf (aref buf j) #\')
879 (setf (aref buf j) (aref str i)))