Changed type declarations in mysql-sql/database-query
[clsql.git] / 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 nil)
250         (num-fields 0))
251     (declare (type mysql-mysql-ptr-def mysql-ptr)
252              (type (or null mysql-mysql-res-ptr-def) res-ptr)
253              (fixnum num-fields))
254     (when (database-execute-command query-expression database)
255       (labels
256           ((get-row (row lengths)
257              "Pull a single row value from the results"
258              (loop for i from 0 below num-fields
259                    collect
260                       (convert-raw-field
261                        (uffi:deref-array row '(:array (* :unsigned-char))
262                                          (the fixnum i))
263                        (nth i result-types)
264                        :length
265                        (uffi:deref-array lengths '(:array :unsigned-long)
266                                          (the fixnum i))
267                        :encoding (encoding database))))
268            (get-result-rows ()
269              "get all the rows out of the now valid results set"
270              (loop for row = (mysql-fetch-row res-ptr)
271                    for lengths = (mysql-fetch-lengths res-ptr)
272                    until (uffi:null-pointer-p row)
273                    collect (get-row row lengths)))
274            (do-result-set ()
275              "for a mysql-ptr, grab and return a results set"
276              (setf res-ptr (mysql-use-result mysql-ptr))
277              (cond
278                ((or (null res-ptr) (uffi:null-pointer-p res-ptr))
279                 (unless (zerop (mysql-errno mysql-ptr))
280                   ;;from http://dev.mysql.com/doc/refman/5.0/en/mysql-field-count.html
281                   ;; if mysql_use_result or mysql_store_result return a null ptr,
282                   ;; we use a mysql_errno check to see if it had a problem or just
283                   ;; was a query without a result. If no error, just return nil.
284                   (error 'sql-database-data-error
285                          :database database
286                          :expression query-expression
287                          :error-id (mysql-errno mysql-ptr)
288                          :message (mysql-error-string mysql-ptr))))
289                (t 
290                 (unwind-protect                           
291                      (progn (setf num-fields (mysql-num-fields res-ptr)
292                                   result-types (canonicalize-types
293                                                 result-types res-ptr)) 
294                             (push (get-result-rows) results)
295                             (push (when field-names
296                                     (result-field-names res-ptr))
297                                   results))
298                   (mysql-free-result res-ptr))))))
299         
300         (loop
301           do (do-result-set)
302           while (let ((next (mysql-next-result mysql-ptr)))
303                   (case next
304                     (0 t)            ;Successful and there are more results
305                     (-1 nil)         ;Successful and there are no more results
306                     (t nil)          ;errors
307                     )))
308         (values-list (nreverse results))))))
309
310
311 (defstruct mysql-result-set
312   (res-ptr (uffi:make-null-pointer 'mysql-mysql-res) :type mysql-mysql-res-ptr-def)
313   (types nil :type list)
314   (num-fields 0 :type fixnum)
315   (full-set nil :type boolean))
316
317
318 (defmethod database-query-result-set ((query-expression string)
319                                       (database mysql-database)
320                                       &key full-set result-types)
321   ;; TODO: REFACTOR THIS IN TERMS OF database-query or vice-versa
322   ;; This doesnt seem to free database results reliably, dont think
323   ;; that we should allow that particularly, OTOH, dont know how
324   ;; we support cursoring without it
325   (let ((mysql-ptr (database-mysql-ptr database)))
326     (declare (type mysql-mysql-ptr-def mysql-ptr))
327     (when (database-execute-command query-expression database)
328       (let ((res-ptr (if full-set
329                          (mysql-store-result mysql-ptr)
330                          (mysql-use-result mysql-ptr))))
331         (declare (type mysql-mysql-res-ptr-def res-ptr))
332         (if (not (uffi:null-pointer-p res-ptr))
333             (let* ((num-fields (mysql-num-fields res-ptr))
334                    (result-set (make-mysql-result-set
335                                 :res-ptr res-ptr
336                                 :num-fields num-fields
337                                 :full-set full-set
338                                 :types
339                                 (canonicalize-types
340                                  result-types res-ptr))))
341               (if full-set
342                   (values result-set
343                           num-fields
344                           (mysql-num-rows res-ptr))
345                   (values result-set
346                           num-fields)))
347             (error 'sql-database-data-error
348                    :database database
349                    :expression query-expression
350                    :error-id (mysql-errno mysql-ptr)
351                    :message (mysql-error-string mysql-ptr))))
352       )))
353
354 (defmethod database-dump-result-set (result-set (database mysql-database))
355   (mysql-free-result (mysql-result-set-res-ptr result-set))
356   t)
357
358
359 (defmethod database-store-next-row (result-set (database mysql-database) list)
360   (let* ((res-ptr (mysql-result-set-res-ptr result-set))
361          (row (mysql-fetch-row res-ptr))
362          (lengths (mysql-fetch-lengths res-ptr))
363          (types (mysql-result-set-types result-set)))
364     (declare (type mysql-mysql-res-ptr-def res-ptr)
365              (type mysql-row-def row))
366     (unless (uffi:null-pointer-p row)
367       (loop for i from 0 below (mysql-result-set-num-fields result-set)
368             for rest on list
369             do
370             (setf (car rest)
371                   (convert-raw-field
372                    (uffi:deref-array row '(:array (* :unsigned-char)) i)
373                    (nth i types)
374                    :length
375                    (uffi:deref-array lengths '(:array :unsigned-long) i)
376                    :encoding (encoding database))))
377       list)))
378
379
380 ;; Table and attribute introspection
381
382 (defmethod database-list-tables ((database mysql-database) &key (owner nil))
383   (declare (ignore owner))
384   (cond
385    ((eql #\5 (char (database-server-info database) 0))
386     (loop for (name type) in (database-query "SHOW FULL TABLES" database nil nil)
387           when (and (string-equal type "base table")
388                     (not (and (>= (length name) 11)
389                               (string-equal (subseq name 0 11) "_CLSQL_SEQ_"))))
390           collect name))
391    (t
392     (remove-if #'(lambda (s)
393                    (and (>= (length s) 11)
394                         (string-equal (subseq s 0 11) "_CLSQL_SEQ_")))
395                (mapcar #'car (database-query "SHOW TABLES" database nil nil))))))
396
397 (defmethod database-list-views ((database mysql-database)
398                                 &key (owner nil))
399   (declare (ignore owner))
400   (cond
401    ((eql #\5 (char (database-server-info database) 0))
402     (loop for (name type) in (database-query "SHOW FULL TABLES" database nil nil)
403           when (string-equal type "view")
404           collect name))
405      (t
406       nil)))
407
408 (defmethod database-list-indexes ((database mysql-database)
409                                   &key (owner nil))
410   (let ((result '()))
411     (dolist (table (database-list-tables database :owner owner) result)
412       (setq result
413         (append (database-list-table-indexes table database :owner owner)
414                 result)))))
415
416 (defmethod database-list-table-indexes (table (database mysql-database)
417                                         &key (owner nil))
418   (declare (ignore owner))
419   (do ((results nil)
420        (rows (database-query
421               (format nil "SHOW INDEX FROM ~A" (escaped-database-identifier
422                                                 table database))
423               database nil nil)
424              (cdr rows)))
425       ((null rows) (nreverse results))
426     (let ((col (nth 2 (car rows))))
427       (unless (find col results :test #'string-equal)
428         (push col results)))))
429
430 (defmethod database-list-attributes ((table clsql-sys::%database-identifier)
431                                      (database mysql-database)
432                                      &key (owner nil)
433                                      &aux (table (unescaped-database-identifier table)))
434   (declare (ignore owner))
435   (mapcar #'car
436           (database-query
437            (format nil "SHOW COLUMNS FROM ~A" (escaped-database-identifier
438                                                 table database))
439            database nil nil)))
440
441 (defmethod database-attribute-type ((attribute clsql-sys::%database-identifier)
442                                     (table clsql-sys::%database-identifier)
443                                     (database mysql-database)
444                                     &key (owner nil)
445                                     &aux (table (unescaped-database-identifier table))
446                                     (attribute (unescaped-database-identifier attribute)))
447   (declare (ignore owner))
448   (let ((row (car (database-query
449                    (format nil
450                            "SHOW COLUMNS FROM ~A LIKE '~A'"
451                            (escaped-database-identifier
452                             table database)
453                            (unescaped-database-identifier
454                             attribute database))
455                    database nil nil))))
456     (let* ((raw-type (second row))
457            (null (third row))
458            (start-length (position #\( raw-type))
459            (type (if start-length
460                      (subseq raw-type 0 start-length)
461                      raw-type))
462            (length (when start-length
463                      (parse-integer (subseq raw-type (1+ start-length))
464                                     :junk-allowed t))))
465       (when type
466         (values (ensure-keyword type) length nil (if (string-equal null "YES") 1 0))))))
467
468 ;;; Sequence functions
469
470 (defmethod database-create-sequence (sequence-name
471                                      (database mysql-database))
472   (let ((table-name (%sequence-name-to-table sequence-name database)))
473     (database-execute-command
474      (concatenate 'string "CREATE TABLE " table-name
475                   " (id int NOT NULL PRIMARY KEY AUTO_INCREMENT)")
476      database)
477     (database-execute-command
478      (concatenate 'string "INSERT INTO " table-name
479                   " VALUES (-1)")
480      database)))
481
482 (defmethod database-drop-sequence (sequence-name
483                                    (database mysql-database))
484   (database-execute-command
485    (concatenate 'string "DROP TABLE "
486                 (%sequence-name-to-table sequence-name database))
487    database))
488
489 (defmethod database-list-sequences ((database mysql-database)
490                                     &key (owner nil))
491   (declare (ignore owner))
492   (mapcan #'(lambda (s)
493               (let ((sn (%table-name-to-sequence-name (car s))))
494                 (and sn (list (car s) sn))))
495           (database-query "SHOW TABLES" database nil nil)))
496
497 (defmethod database-set-sequence-position (sequence-name
498                                            (position integer)
499                                            (database mysql-database))
500   (database-execute-command
501    (format nil "UPDATE ~A SET id=~A" (%sequence-name-to-table sequence-name database)
502            position)
503    database)
504   (mysql:mysql-insert-id (clsql-mysql::database-mysql-ptr database)))
505
506 (defmethod database-sequence-next (sequence-name (database mysql-database))
507   (without-interrupts
508    (database-execute-command
509     (concatenate 'string "UPDATE " (%sequence-name-to-table sequence-name database)
510                  " SET id=LAST_INSERT_ID(id+1)")
511     database)
512    (mysql:mysql-insert-id (clsql-mysql::database-mysql-ptr database))))
513
514 (defmethod database-sequence-last (sequence-name (database mysql-database))
515   (without-interrupts
516     (caar (database-query
517            (concatenate 'string "SELECT id from "
518                         (%sequence-name-to-table sequence-name database))
519            database :auto nil))))
520
521 (defmethod database-last-auto-increment-id ((database mysql-database) table column)
522   (declare (ignore table column))
523   (car (query "SELECT LAST_INSERT_ID();"
524              :flatp t :field-names nil
525              :database database)))
526
527 (defmethod database-create (connection-spec (type (eql :mysql)))
528   (destructuring-bind (host name user password) connection-spec
529     (let ((database (database-connect (list host "" user password)
530                                       type)))
531       (setf (slot-value database 'clsql-sys::state) :open)
532       (unwind-protect
533            (database-execute-command (format nil "create database ~A" name) database)
534         (database-disconnect database)))))
535
536 (defmethod database-destroy (connection-spec (type (eql :mysql)))
537   (destructuring-bind (host name user password) connection-spec
538     (let ((database (database-connect (list host "" user password)
539                                       type)))
540       (setf (slot-value database 'clsql-sys::state) :open)
541       (unwind-protect
542           (database-execute-command (format nil "drop database ~A" name) database)
543         (database-disconnect database)))))
544
545 (defmethod database-probe (connection-spec (type (eql :mysql)))
546   (when (find (second connection-spec) (database-list connection-spec type)
547               :test #'string-equal)
548     t))
549
550 (defmethod database-list (connection-spec (type (eql :mysql)))
551   (destructuring-bind (host name user password &optional port options) connection-spec
552     (declare (ignore options))
553     (let ((database (database-connect (list host (or name "mysql")
554                                             user password port) type)))
555       (unwind-protect
556            (progn
557              (setf (slot-value database 'clsql-sys::state) :open)
558              (mapcar #'car (database-query "show databases" database :auto nil)))
559         (progn
560           (database-disconnect database)
561           (setf (slot-value database 'clsql-sys::state) :closed))))))
562
563
564 ;;; Prepared statements
565
566 (defclass mysql-stmt ()
567   ((database :initarg :database :reader database)
568    (stmt :initarg :stmt :accessor stmt)
569    (input-bind :initarg :input-bind :reader input-bind)
570    (output-bind :initarg :output-bind :reader output-bind)
571    (types :initarg :types :reader types)
572    (result-set :initarg :result-set :reader result-set)
573    (num-fields :initarg :num-fields :reader num-fields)
574    (field-names :initarg :field-names :accessor stmt-field-names)
575    (length-ptr :initarg :length-ptr :reader length-ptr)
576    (is-null-ptr :initarg :is-null-ptr :reader is-null-ptr)
577    (result-types :initarg :result-types :reader result-types)))
578
579 (defun clsql-type->mysql-type (type)
580   (cond
581     ((in type :null) mysql-field-types#null)
582     ((in type :int :integer) mysql-field-types#long)
583     ((in type :short) mysql-field-types#short)
584     ((in type :bigint) mysql-field-types#longlong)
585     ((in type :float :double :number) mysql-field-types#double)
586     ((and (consp type) (in (car type) :char :string :varchar)) mysql-field-types#var-string)
587     ((or (eq type :blob) (and (consp type) (in (car type) :blob))) mysql-field-types#var-string)
588     (t
589        (error 'sql-user-error
590               :message
591               (format nil "Unknown clsql type ~A." type)))))
592
593 #+mysql-client-v4.1
594 (defmethod database-prepare (sql-stmt types (database mysql-database) result-types field-names)
595   (let* ((mysql-ptr (database-mysql-ptr database))
596          (stmt (mysql-stmt-init mysql-ptr)))
597     (when (uffi:null-pointer-p stmt)
598       (error 'sql-database-error
599              :error-id (mysql-errno mysql-ptr)
600              :message (mysql-error-string mysql-ptr)))
601
602     (uffi:with-cstring (native-query sql-stmt)
603       (unless (zerop (mysql-stmt-prepare stmt native-query (uffi:foreign-encoded-octet-count
604                                                             sql-stmt :encoding (encoding database))))
605         (mysql-stmt-close stmt)
606         (error 'sql-database-error
607                :error-id (mysql-errno mysql-ptr)
608                :message (mysql-error-string mysql-ptr))))
609
610     (unless (= (mysql-stmt-param-count stmt) (length types))
611       (mysql-stmt-close stmt)
612       (error 'sql-database-error
613              :message
614              (format nil "Mysql param count (~D) does not match number of types (~D)"
615                      (mysql-stmt-param-count stmt) (length types))))
616
617     (let ((rs (mysql-stmt-result-metadata stmt)))
618       (when (uffi:null-pointer-p rs)
619         (warn "mysql_stmt_result_metadata returned NULL")
620         #+nil
621         (mysql-stmt-close stmt)
622         #+nil
623         (error 'sql-database-error
624                :message "mysql_stmt_result_metadata returned NULL"))
625
626       (let ((input-bind (uffi:allocate-foreign-object 'mysql-bind (length types)))
627             (mysql-types (mapcar 'clsql-type->mysql-type types))
628             field-vec num-fields is-null-ptr output-bind length-ptr)
629
630         (print 'a)
631         (dotimes (i (length types))
632           (let* ((binding (uffi:deref-array input-bind '(:array mysql-bind) i)))
633             (setf (uffi:get-slot-value binding 'mysql-bind 'mysql::buffer-type)
634               (nth i mysql-types))
635             (setf (uffi:get-slot-value binding 'mysql-bind 'mysql::buffer-length) 0)))
636
637         (print 'b)
638         (unless (uffi:null-pointer-p rs)
639           (setq field-vec (mysql-fetch-fields rs)
640                 num-fields (mysql-num-fields rs)
641                 is-null-ptr (uffi:allocate-foreign-object :byte num-fields)
642                 output-bind (uffi:allocate-foreign-object 'mysql-bind num-fields)
643                 length-ptr (uffi:allocate-foreign-object :unsigned-long num-fields))
644           (dotimes (i num-fields)
645             (declare (fixnum i))
646             (let* ((field (uffi:deref-array field-vec '(:array mysql-field) i))
647                    (type (uffi:get-slot-value field 'mysql-field 'type))
648                    (binding (uffi:deref-array output-bind '(:array mysql-bind) i)))
649               (setf (uffi:get-slot-value binding 'mysql-bind 'mysql::buffer-type) type)
650
651               (setf (uffi:get-slot-value binding 'mysql-bind 'mysql::buffer-length) 0)
652               #+need-to-allocate-foreign-object-for-this
653               (setf (uffi:get-slot-value binding 'mysql-bind 'mysql::is-null)
654                 (+ i (uffi:pointer-address is-null-ptr)))
655               #+need-to-allocate-foreign-object-for-this
656               (setf (uffi:get-slot-value binding 'mysql-bind 'length)
657                 (+ (* i 8) (uffi:pointer-address length-ptr)))
658
659               (case type
660                 ((#.mysql-field-types#var-string #.mysql-field-types#string
661                   #.mysql-field-types#tiny-blob #.mysql-field-types#blob
662                   #.mysql-field-types#medium-blob #.mysql-field-types#long-blob)
663                  (setf (uffi:get-slot-value binding 'mysql-bind 'mysql::buffer-length) 1024)
664                  (setf (uffi:get-slot-value binding 'mysql-bind 'mysql::buffer)
665                    (uffi:allocate-foreign-object :unsigned-char 1024)))
666                 (#.mysql-field-types#tiny
667                  (setf (uffi:get-slot-value binding 'mysql-bind 'mysql::buffer)
668                    (uffi:allocate-foreign-object :byte)))
669                 (#.mysql-field-types#short
670                  (setf (uffi:get-slot-value binding 'mysql-bind 'mysql::buffer)
671                    (uffi:allocate-foreign-object :short)))
672                 (#.mysql-field-types#long
673                  (setf (uffi:get-slot-value binding 'mysql-bind 'mysql::buffer)
674                    ;; segfaults if supply :int on amd64
675                    (uffi:allocate-foreign-object :long)))
676                 #+64bit
677                 (#.mysql-field-types#longlong
678                  (setf (uffi:get-slot-value binding 'mysql-bind 'mysql::buffer)
679                    (uffi:allocate-foreign-object :long)))
680                 (#.mysql-field-types#float
681                  (setf (uffi:get-slot-value binding 'mysql-bind 'mysql::buffer)
682                    (uffi:allocate-foreign-object :float)))
683                 (#.mysql-field-types#double
684                  (setf (uffi:get-slot-value binding 'mysql-bind 'mysql::buffer)
685                    (uffi:allocate-foreign-object :double)))
686                 ((#.mysql-field-types#time #.mysql-field-types#date
687                   #.mysql-field-types#datetime #.mysql-field-types#timestamp)
688                  (uffi:allocate-foreign-object 'mysql-time))
689                 (t
690                  (error "mysql type ~D not supported." type)))))
691
692           (unless (zerop (mysql-stmt-bind-result stmt output-bind))
693             (mysql-stmt-close stmt)
694             (error 'sql-database-error
695                    :error-id (mysql-stmt-errno stmt)
696                    :message  (uffi:convert-from-cstring
697                               (mysql-stmt-error stmt)))))
698
699         (make-instance 'mysql-stmt
700           :database database
701           :stmt stmt
702           :num-fields num-fields
703           :input-bind input-bind
704           :output-bind output-bind
705           :result-set rs
706           :result-types result-types
707           :length-ptr length-ptr
708           :is-null-ptr is-null-ptr
709           :types mysql-types
710           :field-names field-names)))))
711
712 #+mysql-client-v4.1
713 (defmethod database-bind-parameter ((stmt mysql-stmt) position value)
714   ;; FIXME: will need to allocate bind structure. This should probably be
715   ;; done in C since the API is not mature and may change
716   (let ((binding (uffi:deref-array (input-bind stmt) '(:array mysql-bind) (1- position)))
717         (type (nth (1- position) (types stmt))))
718     (setf (uffi:get-slot-value binding 'mysql-bind 'length) 0)
719     (cond
720      ((null value)
721       (when (is-null-ptr stmt)
722         (setf (uffi:deref-array (is-null-ptr stmt) '(:array :byte) (1- position)) 1)))
723      (t
724       (when (is-null-ptr stmt)
725         (setf (uffi:deref-array (is-null-ptr stmt) '(:array :byte) (1- position)) 0))
726       (case type
727         (#.mysql-field-types#long
728          (setf (uffi:get-slot-value binding 'mysql-bind 'mysql::buffer) value))
729         (t
730          (warn "Unknown input bind type ~D." type))
731         )))))
732
733 #+mysql-client-v4.1
734 (defmethod database-run-prepared ((stmt mysql-stmt))
735   (print 'a1)
736   (when (input-bind stmt)
737     (unless (zerop (mysql-stmt-bind-param (stmt stmt) (input-bind stmt)))
738       (error 'sql-database-error
739              :error-id (mysql-stmt-errno (stmt stmt))
740              :message  (uffi:convert-from-cstring
741                         (mysql-stmt-error (stmt stmt))))))
742   (print 'a2)
743   (unless (zerop (mysql-stmt-execute (stmt stmt)))
744     (error 'sql-database-error
745            :error-id (mysql-stmt-errno (stmt stmt))
746            :message  (uffi:convert-from-cstring
747                       (mysql-stmt-error (stmt stmt)))))
748   (print 'a3)
749   (unless (zerop (mysql-stmt-store-result (stmt stmt)))
750     (error 'sql-database-error
751            :error-id (mysql-stmt-errno (stmt stmt))
752            :message  (uffi:convert-from-cstring
753                       (mysql-stmt-error (stmt stmt)))))
754   (database-fetch-prepared-rows stmt))
755
756 #+mysql-client-v4.1
757 (defun database-fetch-prepared-rows (stmt)
758   (do ((rc (mysql-stmt-fetch (stmt stmt)) (mysql-stmt-fetch (stmt stmt)))
759        (num-fields (num-fields stmt))
760        (rows '()))
761       ((not (zerop rc)) (nreverse rows))
762     (push
763      (loop for i from 0 below num-fields
764            collect
765            (let ((is-null
766                   (not (zerop (uffi:ensure-char-integer
767                                (uffi:deref-array (is-null-ptr stmt) '(:array :byte) i))))))
768              (unless is-null
769                (let* ((bind (uffi:deref-array (output-bind stmt) '(:array mysql-bind) i))
770                       (type (uffi:get-slot-value bind 'mysql-bind 'mysql::buffer-type))
771                       (buffer (uffi:get-slot-value bind 'mysql-bind 'mysql::buffer)))
772                  (case type
773                    ((#.mysql-field-types#var-string #.mysql-field-types#string
774                      #.mysql-field-types#tiny-blob #.mysql-field-types#blob
775                      #.mysql-field-types#medium-blob #.mysql-field-types#long-blob)
776                     (uffi:convert-from-foreign-string buffer :encoding (encoding (database stmt))))
777                    (#.mysql-field-types#tiny
778                     (uffi:ensure-char-integer
779                      (uffi:deref-pointer buffer :byte)))
780                    (#.mysql-field-types#short
781                     (uffi:deref-pointer buffer :short))
782                    (#.mysql-field-types#long
783                     (uffi:deref-pointer buffer :int))
784                    #+64bit
785                    (#.mysql-field-types#longlong
786                      (uffi:deref-pointer buffer :long))
787                    (#.mysql-field-types#float
788                     (uffi:deref-pointer buffer :float))
789                    (#.mysql-field-types#double
790                     (uffi:deref-pointer buffer :double))
791                    ((#.mysql-field-types#time #.mysql-field-types#date
792                                               #.mysql-field-types#datetime #.mysql-field-types#timestamp)
793                     (let ((year (uffi:get-slot-value buffer 'mysql-time 'mysql::year))
794                           (month (uffi:get-slot-value buffer 'mysql-time 'mysql::month))
795                           (day (uffi:get-slot-value buffer 'mysql-time 'mysql::day))
796                           (hour (uffi:get-slot-value buffer 'mysql-time 'mysql::hour))
797                           (minute (uffi:get-slot-value buffer 'mysql-time 'mysql::minute))
798                           (second (uffi:get-slot-value buffer 'mysql-time 'mysql::second)))
799                       (db-timestring
800                        (make-time :year year :month month :day day :hour hour
801                                   :minute minute :second second))))
802                    (t
803                     (list type)))))))
804      rows)))
805
806
807
808
809 #+mysql-client-v4.1
810 (defmethod database-free-prepared ((stmt mysql-stmt))
811   (with-slots (stmt) stmt
812     (mysql-stmt-close stmt))
813   )
814
815
816 ;;; Database capabilities
817
818 (defmethod db-type-use-column-on-drop-index? ((db-type (eql :mysql)))
819   t)
820
821 (defmethod db-type-has-views? ((db-type (eql :mysql)))
822   #+mysql-client-v5 t
823   #-mysql-client-v5 nil)
824
825 (defmethod db-type-has-subqueries? ((db-type (eql :mysql)))
826   #+(or mysql-client-v4.1 mysql-client-v5) t
827   #-(or mysql-client-v4.1 mysql-client-v5) nil)
828
829 (defmethod db-type-has-boolean-where? ((db-type (eql :mysql)))
830   #+(or mysql-client-v4.1 mysql-client-v5) t
831   #-(or mysql-client-v4.1 mysql-client-v5) nil)
832
833 (defmethod db-type-has-union? ((db-type (eql :mysql)))
834   (not (eql (schar mysql::*mysql-client-info* 0) #\3)))
835
836 (defmethod db-type-transaction-capable? ((db-type (eql :mysql)) database)
837   (let ((tuple (car (database-query "SHOW VARIABLES LIKE 'HAVE_INNODB'" database :auto nil))))
838     (and tuple (string-equal "YES" (second tuple)))))
839
840 (defmethod db-type-has-prepared-stmt? ((db-type (eql :mysql)))
841   #+(or mysql-client-v4.1 mysql-client-v5) t
842   #-(or mysql-client-v4.1 mysql-client-v5) nil)
843
844 (defmethod db-type-has-auto-increment? ((db-type (eql :mysql)))
845   t)
846
847 (when (clsql-sys:database-type-library-loaded :mysql)
848   (clsql-sys:initialize-database-type :database-type :mysql))