;;;; FILE IDENTIFICATION
;;;;
;;;; Name: odbc-sql.cl
-;;;; Purpose: Low-level interface for CLSQL ODBC backend
+;;;; Purpose: Medium-level interface for CLSQL ODBC backend
;;;; Programmer: Kevin M. Rosenberg
;;;; Date Started: Feb 2002
;;;;
-;;;; $Id: odbc-sql.lisp 8983 2004-04-12 21:16:48Z kevin $
-;;;;
;;;; This file, part of CLSQL, is Copyright (c) 2002 by Kevin M. Rosenberg
;;;;
;;;; CLSQL users are granted the rights to distribute and use this software
;;;; *************************************************************************
(defpackage #:clsql-odbc
- (:use #:common-lisp #:clsql-base-sys)
+ (:use #:common-lisp #:clsql-sys)
(:export #:odbc-database)
(:documentation "This is the CLSQL interface to ODBC."))
;; ODBC interface
-(defclass odbc-database (database)
- ((odbc-conn :accessor database-odbc-conn :initarg :odbc-conn)))
+(defclass odbc-database (generic-odbc-database)
+ ())
+
+(defclass odbc-postgresql-database (generic-odbc-database
+ generic-postgresql-database)
+ ())
(defmethod database-name-from-spec (connection-spec
- (database-type (eql :odbc)))
- (check-connection-spec connection-spec database-type (dsn user password))
- (destructuring-bind (dsn user password) connection-spec
- (declare (ignore password))
+ (database-type (eql :odbc)))
+ (check-connection-spec connection-spec database-type
+ (dsn user password &key connection-string completion window-handle))
+ (destructuring-bind (dsn user password &key connection-string completion window-handle) connection-spec
+ (declare (ignore password connection-string completion window-handle))
(concatenate 'string dsn "/" user)))
(defmethod database-connect (connection-spec (database-type (eql :odbc)))
- (check-connection-spec connection-spec database-type (dsn user password))
- (destructuring-bind (dsn user password) connection-spec
+ (check-connection-spec connection-spec database-type
+ (dsn user password &key connection-string completion window-handle))
+ (destructuring-bind (dsn user password &key connection-string (completion :no-prompt) window-handle) connection-spec
(handler-case
- (make-instance 'odbc-database
- :name (database-name-from-spec connection-spec :odbc)
- :odbc-conn
- (odbc-dbi:connect :user user
- :password password
- :data-source-name dsn))
- (error () ;; Init or Connect failed
- (error 'clsql-connect-error
- :database-type database-type
- :connection-spec connection-spec
- :errno nil
- :error "Connection failed")))))
-
-#+nil
+ (let ((db (make-instance 'odbc-database
+ :name (database-name-from-spec connection-spec :odbc)
+ :database-type :odbc
+ :connection-spec connection-spec
+ :dbi-package (find-package '#:odbc-dbi)
+ :odbc-conn
+ (odbc-dbi:connect :user user
+ :password password
+ :data-source-name dsn
+ :connection-string connection-string
+ :completion completion
+ :window-handle window-handle))))
+ (store-type-of-connected-database db)
+ ;; Ensure this database type is initialized so can check capabilities of
+ ;; underlying database
+ (initialize-database-type :database-type database-type)
+ (if (eql :postgresql (database-underlying-type db))
+ (make-instance 'odbc-postgresql-database
+ :name (database-name-from-spec connection-spec :odbc)
+ :database-type :odbc
+ :connection-spec connection-spec
+ :dbi-package (find-package '#:odbc-dbi)
+ :odbc-db-type :postgresql
+ :odbc-conn (clsql-sys::odbc-conn db))
+ db))
+ #+ignore
+ (error () ;; Init or Connect failed
+ (error 'sql-connection-error
+ :database-type database-type
+ :connection-spec connection-spec
+ :message "Connection failed")))))
+
+(defmethod database-underlying-type ((database generic-odbc-database))
+ (clsql-sys::database-odbc-db-type database))
+
(defun store-type-of-connected-database (db)
- (let* ((odbc-db (odbc-db db))
- (server-name (get-odbc-info odbc-db odbc::$SQL_SERVER_NAME))
- (dbms-name (get-odbc-info odbc-db odbc::$SQL_DBMS_NAME))
- (type
- ;; need SERVER-NAME and DBMS-NAME because many drivers mix this up
- (cond
- ((or (search "postgresql" server-name :test #'char-equal)
- (search "postgresql" dbms-name :test #'char-equal))
- :postgresql)
- ((or (search "mysql" server-name :test #'char-equal)
- (search "mysql" dbms-name :test #'char-equal))
- :mysql)
- ((or (search "oracle" server-name :test #'char-equal)
- (search "oracle" dbms-name :test #'char-equal))
- :oracle))))
- (setf (database-type db) type)))
-
-
-(defmethod database-disconnect ((database odbc-database))
- (odbc-dbi:disconnect (database-odbc-conn database))
- (setf (database-odbc-conn database) nil)
- t)
+ (let* ((odbc-conn (clsql-sys::odbc-conn db))
+ (server-name (odbc-dbi::get-odbc-info odbc-conn odbc::$SQL_SERVER_NAME))
+ (dbms-name (odbc-dbi::get-odbc-info odbc-conn odbc::$SQL_DBMS_NAME))
+ (type
+ ;; need SERVER-NAME and DBMS-NAME because many drivers mix this up
+ (cond
+ ((or (search "postgresql" server-name :test #'char-equal)
+ (search "postgresql" dbms-name :test #'char-equal))
+ (unless (find-package 'clsql-postgresql)
+ (ignore-errors (asdf:operate 'asdf:load-op 'clsql-postgresql-socket)))
+ :postgresql)
+ ((or (search "Microsoft SQL Server" server-name :test #'char-equal)
+ (search "Microsoft SQL Server" dbms-name :test #'char-equal))
+ :mssql)
+ ((or (search "mysql" server-name :test #'char-equal)
+ (search "mysql" dbms-name :test #'char-equal))
+ (unless (find-package 'clsql-mysql)
+ ;; ignore errors on platforms where the shared libraries are not available
+ (ignore-errors (asdf:operate 'asdf:load-op 'clsql-mysql)))
+ :mysql)
+ ((or (search "oracle" server-name :test #'char-equal)
+ (search "oracle" dbms-name :test #'char-equal))
+ :oracle))))
+ (setf (clsql-sys::database-odbc-db-type db) type)))
-(defmethod database-query (query-expression (database odbc-database)
- result-types)
- (handler-case
- (odbc-dbi:sql query-expression :db (database-odbc-conn database)
- :query t :result-types result-types)
- (error ()
- (error 'clsql-sql-error
- :database database
- :expression query-expression
- :errno nil
- :error "Query failed"))))
-
-(defmethod database-execute-command (sql-expression
- (database odbc-database))
- (handler-case
- (odbc-dbi:sql sql-expression (database-odbc-conn database))
- (error ()
- (error 'clsql-sql-error
- :database database
- :expression sql-expression
- :errno nil
- :error "Execute command failed"))))
-
-(defstruct odbc-result-set
- (query nil)
- (types nil :type cons)
- (full-set nil :type boolean))
-
-(defmethod database-query-result-set ((query-expression string)
- (database odbc-database)
- &key full-set result-types)
- (handler-case
- (multiple-value-bind (query column-names)
- (odbc-dbi:sql query-expression
- :db (database-odbc-conn database)
- :row-count nil
- :column-names t
- :query t
- :result-types result-types
- )
- (values
- (make-odbc-result-set :query query :full-set full-set
- :types result-types)
- (length column-names)
- nil ;; not able to return number of rows with odbc
- ))
- (error ()
- (error 'clsql-sql-error
- :database database
- :expression query-expression
- :errno nil
- :error "Query result set failed"))))
-
-(defmethod database-dump-result-set (result-set (database odbc-database))
- (odbc-dbi:close-query (odbc-result-set-query result-set))
- t)
-(defmethod database-store-next-row (result-set
- (database odbc-database)
- list)
- (let ((row (odbc-dbi:fetch-row (odbc-result-set-query result-set) nil 'eof)))
- (if (eq row 'eof)
- nil
- (progn
- (loop for elem in row
- for rest on list
- do
- (setf (car rest) elem))
- list))))
-
-;;; Sequence functions
-
-(defun %sequence-name-to-table (sequence-name)
- (concatenate 'string "_clsql_seq_" (sql-escape sequence-name)))
-
-(defun %table-name-to-sequence-name (table-name)
- (and (>= (length table-name) 11)
- (string= (subseq table-name 0 11) "_clsql_seq_")
- (subseq table-name 11)))
-
-(defmethod database-create-sequence (sequence-name
- (database odbc-database))
- (let ((table-name (%sequence-name-to-table sequence-name)))
- (database-execute-command
- (concatenate 'string "CREATE TABLE " table-name
- " (id int NOT NULL PRIMARY KEY AUTO_INCREMENT)")
- database)
- (database-execute-command
- (concatenate 'string "INSERT INTO " table-name
- " VALUES (0)")
- database)))
-
-(defmethod database-drop-sequence (sequence-name
- (database odbc-database))
- (database-execute-command
- (concatenate 'string "DROP TABLE " (%sequence-name-to-table sequence-name))
- database))
-
-(defmethod database-list-sequences ((database odbc-database)
- &key (owner nil))
- (declare (ignore owner))
- (mapcar #'(lambda (s) (%table-name-to-sequence-name (car s)))
- (database-query "SHOW TABLES LIKE '%clsql_seq%'"
- database nil)))
-
-(defmethod database-set-sequence-position (sequence-name
- (position integer)
- (database odbc-database))
- (database-execute-command
- (format nil "UPDATE ~A SET id=~A" (%sequence-name-to-table sequence-name)
- position)
- database)
- position)
-
-(defmethod database-sequence-next (sequence-name (database odbc-database))
- (warn "Not implemented."))
-
-(defmethod database-sequence-last (sequence-name (database odbc-database))
- (declare (ignore sequence-name)))
(defmethod database-create (connection-spec (type (eql :odbc)))
+ (declare (ignore connection-spec))
(warn "Not implemented."))
(defmethod database-destroy (connection-spec (type (eql :odbc)))
+ (declare (ignore connection-spec))
(warn "Not implemented."))
(defmethod database-probe (connection-spec (type (eql :odbc)))
- (warn "Not implemented."))
+ (when (find (car connection-spec) (database-list connection-spec type)
+ :test #'string-equal)
+ t))
+
+(defmethod database-list (connection-spec (type (eql :odbc)))
+ (declare (ignore connection-spec))
+ (odbc-dbi:list-all-data-sources))
+
+(defmethod database-list-indexes ((database odbc-database)
+ &key (owner nil))
+ (let ((result '()))
+ (dolist (table (database-list-tables database :owner owner) result)
+ (setq result
+ (append (database-list-table-indexes table database :owner owner)
+ result)))))
+
+(defmethod database-list-table-indexes (table (database odbc-database)
+ &key (owner nil))
+ (declare (ignore owner))
+ (multiple-value-bind (rows col-names)
+ (odbc-dbi:list-table-indexes
+ table
+ :db (clsql-sys::odbc-conn database))
+ (declare (ignore col-names))
+ ;; INDEX_NAME is hard-coded in sixth position by ODBC driver
+ ;; FIXME: ??? is hard-coded in the fourth position
+ (do ((results nil)
+ (loop-rows rows (cdr loop-rows)))
+ ((null loop-rows) (nreverse results))
+ (let* ((row (car loop-rows))
+ (col (nth 5 row)))
+ (unless (or (null col) (find col results :test #'string-equal))
+ (push col results))))))
+
+;;; Database capabilities
+
+(defmethod db-backend-has-create/destroy-db? ((db-type (eql :odbc)))
+ nil)
+
+
+(defmethod database-initialize-database-type ((database-type (eql :odbc)))
+ ;; nothing to do
+ t)
-#+ignore
-(when (clsql-base-sys:database-type-library-loaded :odbc)
- (clsql-base-sys:initialize-database-type :database-type :odbc))
+(when (clsql-sys:database-type-library-loaded :odbc)
+ (clsql-sys:initialize-database-type :database-type :odbc))