db-mysql/mysql-sql.lisp

   1 ;;;; -*- Mode: LISP; Syntax: ANSI-Common-Lisp; Base: 10 -*-
   2 ;;;; *************************************************************************
   3 ;;;; FILE IDENTIFICATION
   4 ;;;;
   5 ;;;; Name:          mysql-sql.lisp
   6 ;;;; Purpose:       High-level MySQL interface using UFFI
   7 ;;;; Date Started:  Feb 2002
   8 ;;;;
   9 ;;;; This file, part of CLSQL, is Copyright (c) 2002-2010 by Kevin M. Rosenberg
  10 ;;;;
  11 ;;;; CLSQL users are granted the rights to distribute and use this software
  12 ;;;; as governed by the terms of the Lisp Lesser GNU Public License
  13 ;;;; (http://opensource.franz.com/preamble.html), also known as the LLGPL.
  14 ;;;; *************************************************************************
  15
  16 (defpackage #:clsql-mysql
  17     (:use #:common-lisp #:clsql-sys #:mysql #:clsql-uffi)
  18     (:export #:mysql-database)
  19     (:import-from :clsql-sys
  20      :escaped :unescaped :combine-database-identifiers
  21      :escaped-database-identifier :unescaped-database-identifier :database-identifier
  22      :%sequence-name-to-table :%table-name-to-sequence-name)
  23     (:documentation "This is the CLSQL interface to MySQL."))
  24
  25 (in-package #:clsql-mysql)
  26
  27 ;;; Field conversion functions
  28
  29 (defun result-field-names (res-ptr)
  30   (let ((names '()))
  31     (mysql-field-seek res-ptr 0)
  32     (loop
  33        (let ((field (mysql-fetch-field res-ptr)))
  34          (when (uffi:null-pointer-p field) (return))
  35          (push (uffi:convert-from-cstring (clsql-mysql-field-name field)) names)))
  36     (nreverse names)))
  37
  38 (defun make-type-list-for-auto (res-ptr)
  39   (let ((new-types '()))
  40     (mysql-field-seek res-ptr 0)
  41     (loop
  42        (let ((field (mysql-fetch-field res-ptr)))
  43          (when (uffi:null-pointer-p field) (return))
  44          (let* ((flags (clsql-mysql-field-flags field))
  45                 (unsigned (plusp (logand flags 32)))
  46                 (type (clsql-mysql-field-type field)))
  47            (push
  48             (case type
  49               ((#.mysql-field-types#tiny
  50                 #.mysql-field-types#short
  51                 #.mysql-field-types#int24)
  52                (if unsigned
  53                    :uint32
  54                    :int32))
  55               (#.mysql-field-types#long
  56                (if unsigned
  57                    :uint
  58                    :int))
  59               (#.mysql-field-types#longlong
  60                (if unsigned
  61                    :uint64
  62                    :int64))
  63               ((#.mysql-field-types#double
  64                 #.mysql-field-types#float
  65                 #.mysql-field-types#decimal)
  66                :double)
  67               (otherwise
  68                t))
  69             new-types))))
  70     (nreverse new-types)))
  71
  72 (defun canonicalize-types (types res-ptr)
  73   (when types
  74     (let ((auto-list (make-type-list-for-auto res-ptr)))
  75       (cond
  76         ((listp types)
  77          (canonicalize-type-list types auto-list))
  78         ((eq types :auto)
  79          auto-list)
  80         (t
  81          nil)))))
  82
  83 (defmethod database-initialize-database-type ((database-type (eql :mysql)))
  84   t)
  85
  86 ;;(uffi:def-type mysql-mysql-ptr-def (* mysql-mysql))
  87 ;;(uffi:def-type mysql-mysql-res-ptr-def (* mysql-mysql-res))
  88 (uffi:def-type mysql-mysql-ptr-def mysql-mysql)
  89 (uffi:def-type mysql-mysql-res-ptr-def mysql-mysql-res)
  90 (uffi:def-type mysql-row-def mysql-row)
  91
  92 (defclass mysql-database (database)
  93   ((mysql-ptr :accessor database-mysql-ptr :initarg :mysql-ptr
  94               :type mysql-mysql-ptr-def)
  95    (server-info :accessor database-server-info :initarg :server-info
  96               :type string)))
  97
  98 (defmethod database-type ((database mysql-database))
  99   :mysql)
 100
 101 (defmethod database-name-from-spec (connection-spec (database-type (eql :mysql)))
 102   (check-connection-spec connection-spec database-type
 103                          (host db user password &optional port options))
 104   (destructuring-bind (host db user password &optional port options) connection-spec
 105     (declare (ignore password options))
 106     (concatenate 'string
 107                  (etypecase host
 108                    (null "localhost")
 109                    (pathname (namestring host))
 110                    (string host))
 111                  (if port
 112                      (concatenate 'string
 113                                   ":"
 114                                   (etypecase port
 115                                     (integer (write-to-string port))
 116                                     (string port)))
 117                      "")
 118                  "/" db "/" user)))
 119
 120 (defun lookup-option-code (option)
 121   (if (assoc option +mysql-option-parameter-map+)
 122       (symbol-value (intern
 123                      (concatenate 'string (symbol-name-default-case "mysql-option#")
 124                                   (symbol-name option))
 125                      (symbol-name '#:mysql)))
 126       (progn
 127         (warn "Unknown mysql option name ~A - ignoring.~%" option)
 128         nil)))
 129
 130 (defun set-mysql-options (mysql-ptr options)
 131   (flet ((lookup-option-type (option)
 132            (cdr (assoc option +mysql-option-parameter-map+))))
 133     (dolist (option options)
 134       (if (atom option)
 135           (let ((option-code (lookup-option-code option)))
 136             (when option-code
 137               (mysql-options mysql-ptr option-code uffi:+null-cstring-pointer+)))
 138           (destructuring-bind (name . value) option
 139             (let ((option-code (lookup-option-code name)))
 140               (when option-code
 141                 (case (lookup-option-type name)
 142                   (:none
 143                    (mysql-options mysql-ptr option-code uffi:+null-cstring-pointer+))
 144                   (:char-ptr
 145                    (if (stringp value)
 146                        (uffi:with-foreign-string (fs value)
 147                            (mysql-options mysql-ptr option-code fs))
 148                        (warn "Expecting string argument for mysql option ~A, got ~A ~
 149 - ignoring.~%"
 150                              name value)))
 151                   (:uint-ptr
 152                    (if (integerp value)
 153                        (uffi:with-foreign-object (fo :unsigned-int)
 154                          (setf (uffi:deref-pointer fo :unsigned-int) value)
 155                          (mysql-options mysql-ptr option-code fo))
 156                        (warn "Expecting integer argument for mysql option ~A, got ~A ~
 157 - ignoring.~%"
 158                              name value)))
 159                   (:boolean-ptr
 160                    (uffi:with-foreign-object (fo :byte)
 161                      (setf (uffi:deref-pointer fo :byte)
 162                            (case value
 163                              ((nil 0) 0)
 164                              (t 1)))
 165                      (mysql-options mysql-ptr option-code fo)))))))))))
 166
 167 (defmethod database-connect (connection-spec (database-type (eql :mysql)))
 168   (check-connection-spec connection-spec database-type
 169                          (host db user password &optional port options))
 170   (destructuring-bind (host db user password &optional port options) connection-spec
 171     (let ((mysql-ptr (mysql-init (uffi:make-null-pointer 'mysql-mysql)))
 172           (socket nil))
 173       (if (uffi:null-pointer-p mysql-ptr)
 174           (error 'sql-connection-error
 175                  :database-type database-type
 176                  :connection-spec connection-spec
 177                  :error-id (mysql-errno mysql-ptr)
 178                  :message (mysql-error-string mysql-ptr))
 179         (uffi:with-cstrings ((host-native host)
 180                             (user-native user)
 181                             (password-native password)
 182                             (db-native db)
 183                             (socket-native socket))
 184           (when options
 185             (set-mysql-options mysql-ptr options))
 186           (let ((error-occurred nil))
 187             (unwind-protect
 188                 (if (uffi:null-pointer-p
 189                      (mysql-real-connect
 190                       mysql-ptr host-native user-native password-native
 191                       db-native
 192                       (etypecase port
 193                         (null 0)
 194                         (integer port)
 195                         (string (parse-integer port)))
 196                       socket-native 0))
 197                     (progn
 198                       (setq error-occurred t)
 199                       (error 'sql-connection-error
 200                              :database-type database-type
 201                              :connection-spec connection-spec
 202                              :error-id (mysql-errno mysql-ptr)
 203                              :message (mysql-error-string mysql-ptr)))
 204                     (let* ((db
 205                             (make-instance 'mysql-database
 206                                            :name (database-name-from-spec connection-spec
 207                                                                           database-type)
 208                                            :database-type :mysql
 209                                            :connection-spec connection-spec
 210                                            :server-info (uffi:convert-from-cstring
 211                                                          (mysql:mysql-get-server-info mysql-ptr))
 212                                            :mysql-ptr mysql-ptr))
 213                            (cmd "SET SESSION sql_mode='ANSI'"))
 214                       (uffi:with-cstring (cmd-cs cmd)
 215                         (if (zerop (mysql-real-query mysql-ptr cmd-cs (uffi:foreign-encoded-octet-count
 216                                                                        cmd :encoding (encoding db))))
 217                             db
 218                             (progn
 219                               (warn "Error setting ANSI mode for MySQL.")
 220                               db)))))
 221               (when error-occurred (mysql-close mysql-ptr)))))))))
 222
 223
 224 (defmethod database-disconnect ((database mysql-database))
 225   (mysql-close (database-mysql-ptr database))
 226   (setf (database-mysql-ptr database) nil)
 227   t)
 228
 229 (defmethod database-execute-command (sql-expression (database mysql-database))
 230   (uffi:with-cstring (sql-native sql-expression)
 231     (let ((mysql-ptr (database-mysql-ptr database)))
 232       (declare (type mysql-mysql-ptr-def mysql-ptr))
 233       (if (zerop (mysql-real-query mysql-ptr sql-native
 234                                    (uffi:foreign-encoded-octet-count
 235                                     sql-expression :encoding (encoding database))))
 236           t
 237         (error 'sql-database-data-error
 238                :database database
 239                :expression sql-expression
 240                :error-id (mysql-errno mysql-ptr)
 241                :message (mysql-error-string mysql-ptr))))))
 242
 243
 244 (defmethod database-query (query-expression (database mysql-database)
 245                            result-types field-names)
 246   (declare (optimize (speed 3)))
 247   (let ((mysql-ptr (database-mysql-ptr database))
 248         (results nil)     ;; all the results and column-names in reverse-order
 249         res-ptr (num-fields 0))
 250     (declare (type mysql-mysql-ptr-def mysql-ptr res-ptr)
 251              (fixnum num-fields))
 252     (when (database-execute-command query-expression database)
 253       (labels
 254           ((get-row (row lengths)
 255              "Pull a single row value from the results"
 256              (loop for i from 0 below num-fields
 257                    collect
 258                       (convert-raw-field
 259                        (uffi:deref-array row '(:array (* :unsigned-char))
 260                                          (the fixnum i))
 261                        (nth i result-types)
 262                        :length
 263                        (uffi:deref-array lengths '(:array :unsigned-long)
 264                                          (the fixnum i))
 265                        :encoding (encoding database))))
 266            (get-result-rows ()
 267              "get all the rows out of the now valid results set"
 268              (loop for row = (mysql-fetch-row res-ptr)
 269                    for lengths = (mysql-fetch-lengths res-ptr)
 270                    until (uffi:null-pointer-p row)
 271                    collect (get-row row lengths)))
 272            (do-result-set ()
 273              "for a mysql-ptr, grab and return a results set"
 274              (setf res-ptr (mysql-use-result mysql-ptr))
 275              (cond
 276                ((or (null res-ptr) (uffi:null-pointer-p res-ptr))
 277                 (unless (zerop (mysql-errno mysql-ptr))
 278                   ;;from http://dev.mysql.com/doc/refman/5.0/en/mysql-field-count.html
 279                   ;; if mysql_use_result or mysql_store_result return a null ptr,
 280                   ;; we use a mysql_errno check to see if it had a problem or just
 281                   ;; was a query without a result. If no error, just return nil.
 282                   (error 'sql-database-data-error
 283                          :database database
 284                          :expression query-expression
 285                          :error-id (mysql-errno mysql-ptr)
 286                          :message (mysql-error-string mysql-ptr))))
 287                (t
 288                 (unwind-protect
 289                      (progn (setf num-fields (mysql-num-fields res-ptr)
 290                                   result-types (canonicalize-types
 291                                                 result-types res-ptr))
 292                             (push (get-result-rows) results)
 293                             (push (when field-names
 294                                     (result-field-names res-ptr))
 295                                   results))
 296                   (mysql-free-result res-ptr))))))
 297
 298         (loop
 299           do (do-result-set)
 300           while (let ((next (mysql-next-result mysql-ptr)))
 301                   (case next
 302                     (0 t)            ;Successful and there are more results
 303                     (-1 nil)         ;Successful and there are no more results
 304                     (t nil)          ;errors
 305                     )))
 306         (values-list (nreverse results))))))
 307
 308
 309 (defstruct mysql-result-set
 310   (res-ptr (uffi:make-null-pointer 'mysql-mysql-res) :type mysql-mysql-res-ptr-def)
 311   (types nil :type list)
 312   (num-fields 0 :type fixnum)
 313   (full-set nil :type boolean))
 314
 315
 316 (defmethod database-query-result-set ((query-expression string)
 317                                       (database mysql-database)
 318                                       &key full-set result-types)
 319   ;; TODO: REFACTOR THIS IN TERMS OF database-query or vice-versa
 320   ;; This doesnt seem to free database results reliably, dont think
 321   ;; that we should allow that particularly, OTOH, dont know how
 322   ;; we support cursoring without it
 323   (let ((mysql-ptr (database-mysql-ptr database)))
 324     (declare (type mysql-mysql-ptr-def mysql-ptr))
 325     (when (database-execute-command query-expression database)
 326       (let ((res-ptr (if full-set
 327                          (mysql-store-result mysql-ptr)
 328                          (mysql-use-result mysql-ptr))))
 329         (declare (type mysql-mysql-res-ptr-def res-ptr))
 330         (if (not (uffi:null-pointer-p res-ptr))
 331             (let* ((num-fields (mysql-num-fields res-ptr))
 332                    (result-set (make-mysql-result-set
 333                                 :res-ptr res-ptr
 334                                 :num-fields num-fields
 335                                 :full-set full-set
 336                                 :types
 337                                 (canonicalize-types
 338                                  result-types res-ptr))))
 339               (if full-set
 340                   (values result-set
 341                           num-fields
 342                           (mysql-num-rows res-ptr))
 343                   (values result-set
 344                           num-fields)))
 345             (error 'sql-database-data-error
 346                    :database database
 347                    :expression query-expression
 348                    :error-id (mysql-errno mysql-ptr)
 349                    :message (mysql-error-string mysql-ptr))))
 350       )))
 351
 352 (defmethod database-dump-result-set (result-set (database mysql-database))
 353   (mysql-free-result (mysql-result-set-res-ptr result-set))
 354   t)
 355
 356
 357 (defmethod database-store-next-row (result-set (database mysql-database) list)
 358   (let* ((res-ptr (mysql-result-set-res-ptr result-set))
 359          (row (mysql-fetch-row res-ptr))
 360          (lengths (mysql-fetch-lengths res-ptr))
 361          (types (mysql-result-set-types result-set)))
 362     (declare (type mysql-mysql-res-ptr-def res-ptr)
 363              (type mysql-row-def row))
 364     (unless (uffi:null-pointer-p row)
 365       (loop for i from 0 below (mysql-result-set-num-fields result-set)
 366             for rest on list
 367             do
 368             (setf (car rest)
 369                   (convert-raw-field
 370                    (uffi:deref-array row '(:array (* :unsigned-char)) i)
 371                    (nth i types)
 372                    :length
 373                    (uffi:deref-array lengths '(:array :unsigned-long) i)
 374                    :encoding (encoding database))))
 375       list)))
 376
 377
 378 ;; Table and attribute introspection
 379
 380 (defmethod database-list-tables ((database mysql-database) &key (owner nil))
 381   (declare (ignore owner))
 382   (cond
 383    ((eql #\5 (char (database-server-info database) 0))
 384     (loop for (name type) in (database-query "SHOW FULL TABLES" database nil nil)
 385           when (and (string-equal type "base table")
 386                     (not (and (>= (length name) 11)
 387                               (string-equal (subseq name 0 11) "_CLSQL_SEQ_"))))
 388           collect name))
 389    (t
 390     (remove-if #'(lambda (s)
 391                    (and (>= (length s) 11)
 392                         (string-equal (subseq s 0 11) "_CLSQL_SEQ_")))
 393                (mapcar #'car (database-query "SHOW TABLES" database nil nil))))))
 394
 395 (defmethod database-list-views ((database mysql-database)
 396                                 &key (owner nil))
 397   (declare (ignore owner))
 398   (cond
 399    ((eql #\5 (char (database-server-info database) 0))
 400     (loop for (name type) in (database-query "SHOW FULL TABLES" database nil nil)
 401           when (string-equal type "view")
 402           collect name))
 403      (t
 404       nil)))
 405
 406 (defmethod database-list-indexes ((database mysql-database)
 407                                   &key (owner nil))
 408   (let ((result '()))
 409     (dolist (table (database-list-tables database :owner owner) result)
 410       (setq result
 411         (append (database-list-table-indexes table database :owner owner)
 412                 result)))))
 413
 414 (defmethod database-list-table-indexes (table (database mysql-database)
 415                                         &key (owner nil))
 416   (declare (ignore owner))
 417   (do ((results nil)
 418        (rows (database-query
 419               (format nil "SHOW INDEX FROM ~A" (escaped-database-identifier
 420                                                 table database))
 421               database nil nil)
 422              (cdr rows)))
 423       ((null rows) (nreverse results))
 424     (let ((col (nth 2 (car rows))))
 425       (unless (find col results :test #'string-equal)
 426         (push col results)))))
 427
 428 (defmethod database-list-attributes ((table clsql-sys::%database-identifier)
 429                                      (database mysql-database)
 430                                      &key (owner nil)
 431                                      &aux (table (unescaped-database-identifier table)))
 432   (declare (ignore owner))
 433   (mapcar #'car
 434           (database-query
 435            (format nil "SHOW COLUMNS FROM ~A" (escaped-database-identifier
 436                                                 table database))
 437            database nil nil)))
 438
 439 (defmethod database-attribute-type ((attribute clsql-sys::%database-identifier)
 440                                     (table clsql-sys::%database-identifier)
 441                                     (database mysql-database)
 442                                     &key (owner nil)
 443                                     &aux (table (unescaped-database-identifier table))
 444                                     (attribute (unescaped-database-identifier attribute)))
 445   (declare (ignore owner))
 446   (let ((row (car (database-query
 447                    (format nil
 448                            "SHOW COLUMNS FROM ~A LIKE '~A'"
 449                            (escaped-database-identifier
 450                             table database)
 451                            (unescaped-database-identifier
 452                             attribute database))
 453                    database nil nil))))
 454     (let* ((raw-type (second row))
 455            (null (third row))
 456            (start-length (position #\( raw-type))
 457            (type (if start-length
 458                      (subseq raw-type 0 start-length)
 459                      raw-type))
 460            (length (when start-length
 461                      (parse-integer (subseq raw-type (1+ start-length))
 462                                     :junk-allowed t))))
 463       (when type
 464         (values (ensure-keyword type) length nil (if (string-equal null "YES") 1 0))))))
 465
 466 ;;; Sequence functions
 467
 468 (defmethod database-create-sequence (sequence-name
 469                                      (database mysql-database))
 470   (let ((table-name (%sequence-name-to-table sequence-name database)))
 471     (database-execute-command
 472      (concatenate 'string "CREATE TABLE " table-name
 473                   " (id int NOT NULL PRIMARY KEY AUTO_INCREMENT)")
 474      database)
 475     (database-execute-command
 476      (concatenate 'string "INSERT INTO " table-name
 477                   " VALUES (-1)")
 478      database)))
 479
 480 (defmethod database-drop-sequence (sequence-name
 481                                    (database mysql-database))
 482   (database-execute-command
 483    (concatenate 'string "DROP TABLE "
 484                 (%sequence-name-to-table sequence-name database))
 485    database))
 486
 487 (defmethod database-list-sequences ((database mysql-database)
 488                                     &key (owner nil))
 489   (declare (ignore owner))
 490   (mapcan #'(lambda (s)
 491               (let ((sn (%table-name-to-sequence-name (car s))))
 492                 (and sn (list (car s) sn))))
 493           (database-query "SHOW TABLES" database nil nil)))
 494
 495 (defmethod database-set-sequence-position (sequence-name
 496                                            (position integer)
 497                                            (database mysql-database))
 498   (database-execute-command
 499    (format nil "UPDATE ~A SET id=~A" (%sequence-name-to-table sequence-name database)
 500            position)
 501    database)
 502   (mysql:mysql-insert-id (clsql-mysql::database-mysql-ptr database)))
 503
 504 (defmethod database-sequence-next (sequence-name (database mysql-database))
 505   (without-interrupts
 506    (database-execute-command
 507     (concatenate 'string "UPDATE " (%sequence-name-to-table sequence-name database)
 508                  " SET id=LAST_INSERT_ID(id+1)")
 509     database)
 510    (mysql:mysql-insert-id (clsql-mysql::database-mysql-ptr database))))
 511
 512 (defmethod database-sequence-last (sequence-name (database mysql-database))
 513   (without-interrupts
 514     (caar (database-query
 515            (concatenate 'string "SELECT id from "
 516                         (%sequence-name-to-table sequence-name database))
 517            database :auto nil))))
 518
 519 (defmethod database-last-auto-increment-id ((database mysql-database) table column)
 520   (declare (ignore table column))
 521   (car (query "SELECT LAST_INSERT_ID();"
 522              :flatp t :field-names nil
 523              :database database)))
 524
 525 (defmethod database-create (connection-spec (type (eql :mysql)))
 526   (destructuring-bind (host name user password) connection-spec
 527     (let ((database (database-connect (list host "" user password)
 528                                       type)))
 529       (setf (slot-value database 'clsql-sys::state) :open)
 530       (unwind-protect
 531            (database-execute-command (format nil "create database ~A" name) database)
 532         (database-disconnect database)))))
 533
 534 (defmethod database-destroy (connection-spec (type (eql :mysql)))
 535   (destructuring-bind (host name user password) connection-spec
 536     (let ((database (database-connect (list host "" user password)
 537                                       type)))
 538       (setf (slot-value database 'clsql-sys::state) :open)
 539       (unwind-protect
 540           (database-execute-command (format nil "drop database ~A" name) database)
 541         (database-disconnect database)))))
 542
 543 (defmethod database-probe (connection-spec (type (eql :mysql)))
 544   (when (find (second connection-spec) (database-list connection-spec type)
 545               :test #'string-equal)
 546     t))
 547
 548 (defmethod database-list (connection-spec (type (eql :mysql)))
 549   (destructuring-bind (host name user password &optional port options) connection-spec
 550     (declare (ignore options))
 551     (let ((database (database-connect (list host (or name "mysql")
 552                                             user password port) type)))
 553       (unwind-protect
 554            (progn
 555              (setf (slot-value database 'clsql-sys::state) :open)
 556              (mapcar #'car (database-query "show databases" database :auto nil)))
 557         (progn
 558           (database-disconnect database)
 559           (setf (slot-value database 'clsql-sys::state) :closed))))))
 560
 561
 562 ;;; Prepared statements
 563
 564 (defclass mysql-stmt ()
 565   ((database :initarg :database :reader database)
 566    (stmt :initarg :stmt :accessor stmt)
 567    (input-bind :initarg :input-bind :reader input-bind)
 568    (output-bind :initarg :output-bind :reader output-bind)
 569    (types :initarg :types :reader types)
 570    (result-set :initarg :result-set :reader result-set)
 571    (num-fields :initarg :num-fields :reader num-fields)
 572    (field-names :initarg :field-names :accessor stmt-field-names)
 573    (length-ptr :initarg :length-ptr :reader length-ptr)
 574    (is-null-ptr :initarg :is-null-ptr :reader is-null-ptr)
 575    (result-types :initarg :result-types :reader result-types)))
 576
 577 (defun clsql-type->mysql-type (type)
 578   (cond
 579     ((in type :null) mysql-field-types#null)
 580     ((in type :int :integer) mysql-field-types#long)
 581     ((in type :short) mysql-field-types#short)
 582     ((in type :bigint) mysql-field-types#longlong)
 583     ((in type :float :double :number) mysql-field-types#double)
 584     ((and (consp type) (in (car type) :char :string :varchar)) mysql-field-types#var-string)
 585     ((or (eq type :blob) (and (consp type) (in (car type) :blob))) mysql-field-types#var-string)
 586     (t
 587        (error 'sql-user-error
 588               :message
 589               (format nil "Unknown clsql type ~A." type)))))
 590
 591 #+mysql-client-v4.1
 592 (defmethod database-prepare (sql-stmt types (database mysql-database) result-types field-names)
 593   (let* ((mysql-ptr (database-mysql-ptr database))
 594          (stmt (mysql-stmt-init mysql-ptr)))
 595     (when (uffi:null-pointer-p stmt)
 596       (error 'sql-database-error
 597              :error-id (mysql-errno mysql-ptr)
 598              :message (mysql-error-string mysql-ptr)))
 599
 600     (uffi:with-cstring (native-query sql-stmt)
 601       (unless (zerop (mysql-stmt-prepare stmt native-query (uffi:foreign-encoded-octet-count
 602                                                             sql-stmt :encoding (encoding database))))
 603         (mysql-stmt-close stmt)
 604         (error 'sql-database-error
 605                :error-id (mysql-errno mysql-ptr)
 606                :message (mysql-error-string mysql-ptr))))
 607
 608     (unless (= (mysql-stmt-param-count stmt) (length types))
 609       (mysql-stmt-close stmt)
 610       (error 'sql-database-error
 611              :message
 612              (format nil "Mysql param count (~D) does not match number of types (~D)"
 613                      (mysql-stmt-param-count stmt) (length types))))
 614
 615     (let ((rs (mysql-stmt-result-metadata stmt)))
 616       (when (uffi:null-pointer-p rs)
 617         (warn "mysql_stmt_result_metadata returned NULL")
 618         #+nil
 619         (mysql-stmt-close stmt)
 620         #+nil
 621         (error 'sql-database-error
 622                :message "mysql_stmt_result_metadata returned NULL"))
 623
 624       (let ((input-bind (uffi:allocate-foreign-object 'mysql-bind (length types)))
 625             (mysql-types (mapcar 'clsql-type->mysql-type types))
 626             field-vec num-fields is-null-ptr output-bind length-ptr)
 627
 628         (print 'a)
 629         (dotimes (i (length types))
 630           (let* ((binding (uffi:deref-array input-bind '(:array mysql-bind) i)))
 631             (setf (uffi:get-slot-value binding 'mysql-bind 'mysql::buffer-type)
 632               (nth i mysql-types))
 633             (setf (uffi:get-slot-value binding 'mysql-bind 'mysql::buffer-length) 0)))
 634
 635         (print 'b)
 636         (unless (uffi:null-pointer-p rs)
 637           (setq field-vec (mysql-fetch-fields rs)
 638                 num-fields (mysql-num-fields rs)
 639                 is-null-ptr (uffi:allocate-foreign-object :byte num-fields)
 640                 output-bind (uffi:allocate-foreign-object 'mysql-bind num-fields)
 641                 length-ptr (uffi:allocate-foreign-object :unsigned-long num-fields))
 642           (dotimes (i num-fields)
 643             (declare (fixnum i))
 644             (let* ((field (uffi:deref-array field-vec '(:array mysql-field) i))
 645                    (type (uffi:get-slot-value field 'mysql-field 'type))
 646                    (binding (uffi:deref-array output-bind '(:array mysql-bind) i)))
 647               (setf (uffi:get-slot-value binding 'mysql-bind 'mysql::buffer-type) type)
 648
 649               (setf (uffi:get-slot-value binding 'mysql-bind 'mysql::buffer-length) 0)
 650               #+need-to-allocate-foreign-object-for-this
 651               (setf (uffi:get-slot-value binding 'mysql-bind 'mysql::is-null)
 652                 (+ i (uffi:pointer-address is-null-ptr)))
 653               #+need-to-allocate-foreign-object-for-this
 654               (setf (uffi:get-slot-value binding 'mysql-bind 'length)
 655                 (+ (* i 8) (uffi:pointer-address length-ptr)))
 656
 657               (case type
 658                 ((#.mysql-field-types#var-string #.mysql-field-types#string
 659                   #.mysql-field-types#tiny-blob #.mysql-field-types#blob
 660                   #.mysql-field-types#medium-blob #.mysql-field-types#long-blob)
 661                  (setf (uffi:get-slot-value binding 'mysql-bind 'mysql::buffer-length) 1024)
 662                  (setf (uffi:get-slot-value binding 'mysql-bind 'mysql::buffer)
 663                    (uffi:allocate-foreign-object :unsigned-char 1024)))
 664                 (#.mysql-field-types#tiny
 665                  (setf (uffi:get-slot-value binding 'mysql-bind 'mysql::buffer)
 666                    (uffi:allocate-foreign-object :byte)))
 667                 (#.mysql-field-types#short
 668                  (setf (uffi:get-slot-value binding 'mysql-bind 'mysql::buffer)
 669                    (uffi:allocate-foreign-object :short)))
 670                 (#.mysql-field-types#long
 671                  (setf (uffi:get-slot-value binding 'mysql-bind 'mysql::buffer)
 672                    ;; segfaults if supply :int on amd64
 673                    (uffi:allocate-foreign-object :long)))
 674                 #+64bit
 675                 (#.mysql-field-types#longlong
 676                  (setf (uffi:get-slot-value binding 'mysql-bind 'mysql::buffer)
 677                    (uffi:allocate-foreign-object :long)))
 678                 (#.mysql-field-types#float
 679                  (setf (uffi:get-slot-value binding 'mysql-bind 'mysql::buffer)
 680                    (uffi:allocate-foreign-object :float)))
 681                 (#.mysql-field-types#double
 682                  (setf (uffi:get-slot-value binding 'mysql-bind 'mysql::buffer)
 683                    (uffi:allocate-foreign-object :double)))
 684                 ((#.mysql-field-types#time #.mysql-field-types#date
 685                   #.mysql-field-types#datetime #.mysql-field-types#timestamp)
 686                  (uffi:allocate-foreign-object 'mysql-time))
 687                 (t
 688                  (error "mysql type ~D not supported." type)))))
 689
 690           (unless (zerop (mysql-stmt-bind-result stmt output-bind))
 691             (mysql-stmt-close stmt)
 692             (error 'sql-database-error
 693                    :error-id (mysql-stmt-errno stmt)
 694                    :message  (uffi:convert-from-cstring
 695                               (mysql-stmt-error stmt)))))
 696
 697         (make-instance 'mysql-stmt
 698           :database database
 699           :stmt stmt
 700           :num-fields num-fields
 701           :input-bind input-bind
 702           :output-bind output-bind
 703           :result-set rs
 704           :result-types result-types
 705           :length-ptr length-ptr
 706           :is-null-ptr is-null-ptr
 707           :types mysql-types
 708           :field-names field-names)))))
 709
 710 #+mysql-client-v4.1
 711 (defmethod database-bind-parameter ((stmt mysql-stmt) position value)
 712   ;; FIXME: will need to allocate bind structure. This should probably be
 713   ;; done in C since the API is not mature and may change
 714   (let ((binding (uffi:deref-array (input-bind stmt) '(:array mysql-bind) (1- position)))
 715         (type (nth (1- position) (types stmt))))
 716     (setf (uffi:get-slot-value binding 'mysql-bind 'length) 0)
 717     (cond
 718      ((null value)
 719       (when (is-null-ptr stmt)
 720         (setf (uffi:deref-array (is-null-ptr stmt) '(:array :byte) (1- position)) 1)))
 721      (t
 722       (when (is-null-ptr stmt)
 723         (setf (uffi:deref-array (is-null-ptr stmt) '(:array :byte) (1- position)) 0))
 724       (case type
 725         (#.mysql-field-types#long
 726          (setf (uffi:get-slot-value binding 'mysql-bind 'mysql::buffer) value))
 727         (t
 728          (warn "Unknown input bind type ~D." type))
 729         )))))
 730
 731 #+mysql-client-v4.1
 732 (defmethod database-run-prepared ((stmt mysql-stmt))
 733   (print 'a1)
 734   (when (input-bind stmt)
 735     (unless (zerop (mysql-stmt-bind-param (stmt stmt) (input-bind stmt)))
 736       (error 'sql-database-error
 737              :error-id (mysql-stmt-errno (stmt stmt))
 738              :message  (uffi:convert-from-cstring
 739                         (mysql-stmt-error (stmt stmt))))))
 740   (print 'a2)
 741   (unless (zerop (mysql-stmt-execute (stmt stmt)))
 742     (error 'sql-database-error
 743            :error-id (mysql-stmt-errno (stmt stmt))
 744            :message  (uffi:convert-from-cstring
 745                       (mysql-stmt-error (stmt stmt)))))
 746   (print 'a3)
 747   (unless (zerop (mysql-stmt-store-result (stmt stmt)))
 748     (error 'sql-database-error
 749            :error-id (mysql-stmt-errno (stmt stmt))
 750            :message  (uffi:convert-from-cstring
 751                       (mysql-stmt-error (stmt stmt)))))
 752   (database-fetch-prepared-rows stmt))
 753
 754 #+mysql-client-v4.1
 755 (defun database-fetch-prepared-rows (stmt)
 756   (do ((rc (mysql-stmt-fetch (stmt stmt)) (mysql-stmt-fetch (stmt stmt)))
 757        (num-fields (num-fields stmt))
 758        (rows '()))
 759       ((not (zerop rc)) (nreverse rows))
 760     (push
 761      (loop for i from 0 below num-fields
 762            collect
 763            (let ((is-null
 764                   (not (zerop (uffi:ensure-char-integer
 765                                (uffi:deref-array (is-null-ptr stmt) '(:array :byte) i))))))
 766              (unless is-null
 767                (let* ((bind (uffi:deref-array (output-bind stmt) '(:array mysql-bind) i))
 768                       (type (uffi:get-slot-value bind 'mysql-bind 'mysql::buffer-type))
 769                       (buffer (uffi:get-slot-value bind 'mysql-bind 'mysql::buffer)))
 770                  (case type
 771                    ((#.mysql-field-types#var-string #.mysql-field-types#string
 772                      #.mysql-field-types#tiny-blob #.mysql-field-types#blob
 773                      #.mysql-field-types#medium-blob #.mysql-field-types#long-blob)
 774                     (uffi:convert-from-foreign-string buffer :encoding (encoding (database stmt))))
 775                    (#.mysql-field-types#tiny
 776                     (uffi:ensure-char-integer
 777                      (uffi:deref-pointer buffer :byte)))
 778                    (#.mysql-field-types#short
 779                     (uffi:deref-pointer buffer :short))
 780                    (#.mysql-field-types#long
 781                     (uffi:deref-pointer buffer :int))
 782                    #+64bit
 783                    (#.mysql-field-types#longlong
 784                      (uffi:deref-pointer buffer :long))
 785                    (#.mysql-field-types#float
 786                     (uffi:deref-pointer buffer :float))
 787                    (#.mysql-field-types#double
 788                     (uffi:deref-pointer buffer :double))
 789                    ((#.mysql-field-types#time #.mysql-field-types#date
 790                                               #.mysql-field-types#datetime #.mysql-field-types#timestamp)
 791                     (let ((year (uffi:get-slot-value buffer 'mysql-time 'mysql::year))
 792                           (month (uffi:get-slot-value buffer 'mysql-time 'mysql::month))
 793                           (day (uffi:get-slot-value buffer 'mysql-time 'mysql::day))
 794                           (hour (uffi:get-slot-value buffer 'mysql-time 'mysql::hour))
 795                           (minute (uffi:get-slot-value buffer 'mysql-time 'mysql::minute))
 796                           (second (uffi:get-slot-value buffer 'mysql-time 'mysql::second)))
 797                       (db-timestring
 798                        (make-time :year year :month month :day day :hour hour
 799                                   :minute minute :second second))))
 800                    (t
 801                     (list type)))))))
 802      rows)))
 803
 804
 805
 806
 807 #+mysql-client-v4.1
 808 (defmethod database-free-prepared ((stmt mysql-stmt))
 809   (with-slots (stmt) stmt
 810     (mysql-stmt-close stmt))
 811   )
 812
 813
 814 ;;; Database capabilities
 815
 816 (defmethod db-type-use-column-on-drop-index? ((db-type (eql :mysql)))
 817   t)
 818
 819 (defmethod db-type-has-views? ((db-type (eql :mysql)))
 820   #+mysql-client-v5 t
 821   #-mysql-client-v5 nil)
 822
 823 (defmethod db-type-has-subqueries? ((db-type (eql :mysql)))
 824   #+(or mysql-client-v4.1 mysql-client-v5) t
 825   #-(or mysql-client-v4.1 mysql-client-v5) nil)
 826
 827 (defmethod db-type-has-boolean-where? ((db-type (eql :mysql)))
 828   #+(or mysql-client-v4.1 mysql-client-v5) t
 829   #-(or mysql-client-v4.1 mysql-client-v5) nil)
 830
 831 (defmethod db-type-has-union? ((db-type (eql :mysql)))
 832   (not (eql (schar mysql::*mysql-client-info* 0) #\3)))
 833
 834 (defmethod db-type-transaction-capable? ((db-type (eql :mysql)) database)
 835   (let ((tuple (car (database-query "SHOW VARIABLES LIKE 'HAVE_INNODB'" database :auto nil))))
 836     (and tuple (string-equal "YES" (second tuple)))))
 837
 838 (defmethod db-type-has-prepared-stmt? ((db-type (eql :mysql)))
 839   #+(or mysql-client-v4.1 mysql-client-v5) t
 840   #-(or mysql-client-v4.1 mysql-client-v5) nil)
 841
 842 (defmethod db-type-has-auto-increment? ((db-type (eql :mysql)))
 843   t)
 844
 845 (when (clsql-sys:database-type-library-loaded :mysql)
 846   (clsql-sys:initialize-database-type :database-type :mysql))