sql/package.lisp

   1 ;;;; -*- Mode: LISP; Syntax: ANSI-Common-Lisp; Base: 10 -*-
   2 ;;;; *************************************************************************
   3 ;;;; FILE IDENTIFICATION
   4 ;;;;
   5 ;;;; Name:          package.lisp
   6 ;;;; Purpose:       Package definition for SQL interface
   7 ;;;;
   8 ;;;; This file is part of CLSQL.
   9 ;;;;
  10 ;;;; CLSQL users are granted the rights to distribute and use this software
  11 ;;;; as governed by the terms of the Lisp Lesser GNU Public License
  12 ;;;; (http://opensource.franz.com/preamble.html), also known as the LLGPL.
  13 ;;;; *************************************************************************
  14
  15 (in-package #:cl-user)
  16
  17 ;;;; This file makes the required package definitions for CLSQL's
  18 ;;;; core packages.
  19
  20 (eval-when (:compile-toplevel :load-toplevel :execute)
  21   #+sbcl
  22   (if (find-package 'sb-mop)
  23       (pushnew :clsql-sbcl-mop cl:*features*)
  24       (pushnew :clsql-sbcl-pcl cl:*features*))
  25
  26   #+cmu
  27   (if (eq (symbol-package 'pcl:find-class)
  28           (find-package 'common-lisp))
  29       (pushnew :clsql-cmucl-mop cl:*features*)
  30       (pushnew :clsql-cmucl-pcl cl:*features*)))
  31
  32
  33 (eval-when (:compile-toplevel :load-toplevel :execute)
  34   (defpackage #:clsql-sys
  35     (:use #:common-lisp
  36           #+clsql-sbcl-mop #:sb-mop
  37           #+clsql-cmucl-mop #:mop
  38           #+allegro #:mop
  39           #+lispworks #:clos
  40           #+scl #:clos
  41           #+openmcl #:openmcl-mop)
  42
  43     #+allegro
  44     (:shadowing-import-from
  45      #:excl)
  46     #+lispworks
  47     (:shadowing-import-from
  48      #:clos)
  49     #+clsql-sbcl-mop
  50     (:shadowing-import-from
  51      #:sb-pcl
  52      #:generic-function-lambda-list)
  53     #+clsql-sbcl-pcl
  54     (:shadowing-import-from
  55      #:sb-pcl
  56      #:name
  57      #:class-direct-slots
  58      #:class-of #:class-name #:class-slots #:find-class
  59      #:slot-boundp
  60      #:standard-class
  61      #:slot-definition-name #:finalize-inheritance
  62      #:standard-direct-slot-definition
  63      #:standard-effective-slot-definition #:validate-superclass
  64      #:direct-slot-definition-class #:compute-effective-slot-definition
  65      #:effective-slot-definition-class
  66      #:slot-value-using-class
  67      #:class-prototype #:generic-function-method-class #:intern-eql-specializer
  68      #:make-method-lambda #:generic-function-lambda-list
  69      #:class-precedence-list #:slot-definition-type
  70      #:class-direct-superclasses
  71      #:compute-class-precedence-list)
  72     #+clsql-cmucl-mop
  73     (:shadowing-import-from
  74      #:pcl
  75      #:generic-function-lambda-list)
  76     #+clsql-cmucl-pcl
  77     (:shadowing-import-from
  78      #:pcl
  79      #:class-direct-slots
  80      #:name
  81      #:class-of  #:class-name #:class-slots #:find-class #:standard-class
  82      #:slot-boundp
  83      #:slot-definition-name #:finalize-inheritance
  84      #:standard-direct-slot-definition #:standard-effective-slot-definition
  85      #:validate-superclass #:direct-slot-definition-class
  86      #:effective-slot-definition-class
  87      #:compute-effective-slot-definition
  88      #:slot-value-using-class
  89      #:class-prototype #:generic-function-method-class #:intern-eql-specializer
  90      #:make-method-lambda #:generic-function-lambda-list
  91      #:class-precedence-list #:slot-definition-type
  92      #:class-direct-superclasses
  93      #:compute-class-precedence-list)
  94     #+scl
  95     (:shadowing-import-from
  96      #:clos
  97      #:class-prototype  ;; note: make-method-lambda is not fbound
  98      )
  99
 100     (:export
 101      ;; "Private" exports for use by interface packages
 102      #:check-connection-spec
 103      #:database-initialize-database-type
 104      #:database-type-load-foreign
 105      #:database-name-from-spec
 106      #:database-connect
 107      #:database-disconnect
 108      #:database-query
 109      #:database-execute-command
 110      #:database-create-sequence
 111      #:database-drop-sequence
 112      #:database-sequence-next
 113      #:database-set-sequence-position
 114      #:database-query-result-set
 115      #:database-dump-result-set
 116      #:database-store-next-row
 117      #:database-get-type-specifier
 118      #:database-list-tables
 119      #:database-table-exists-p
 120      #:database-list-views
 121      #:database-view-exists-p
 122      #:database-list-indexes
 123      #:database-list-table-indexes
 124      #:database-index-exists-p
 125      #:database-list-sequences
 126      #:database-sequence-last
 127      #:database-sequence-exists-p
 128      #:database-list-attributes
 129      #:database-attribute-type
 130      #:database-describe-table
 131      #:database-type-library-loaded
 132      #:database-create
 133      #:database-destroy
 134      #:database-probe
 135      #:database-list
 136
 137      #:db-backend-has-create/destroy-db?
 138      #:db-type-has-views?
 139      #:db-type-has-bigint?
 140      #:db-type-has-union?
 141      #:db-type-has-subqueries?
 142      #:db-type-has-boolean-where?
 143      #:db-type-transaction-capable?
 144      #:db-type-has-fancy-math?
 145      #:db-type-default-case
 146      #:db-type-use-column-on-drop-index?
 147      #:database-underlying-type
 148
 149      ;; Large objects
 150      #:database-create-large-object
 151      #:database-write-large-object
 152      #:database-read-large-object
 153      #:database-delete-large-object
 154      #:create-large-object
 155      #:write-large-object
 156      #:read-large-object
 157      #:delete-large-object
 158
 159      ;; accessors for database class
 160      #:name
 161      #:connection-spec
 162      #:transaction
 163      #:transaction-level
 164      #:conn-pool
 165      #:command-recording-stream
 166      #:result-recording-stream
 167      #:record-caches
 168      #:view-classes
 169      #:database-type
 170      #:database-state
 171      #:attribute-cache
 172
 173
 174      ;; utils.lisp
 175      #:without-interrupts
 176      #:make-process-lock
 177      #:with-process-lock
 178      #:command-output
 179      #:symbol-name-default-case
 180      #:convert-to-db-default-case
 181      #:ensure-keyword
 182
 183
 184      #:clsql-invalid-spec-error
 185      #:clsql-invalid-spec-error-connection-spec
 186      #:clsql-invalid-spec-error-database-type
 187      #:clsql-invalid-spec-error-template
 188      #:clsql-access-error
 189      #:clsql-access-error-database-type
 190      #:clsql-access-error-connection-spec
 191      #:clsql-access-error-error
 192      #:clsql-connect-error
 193      #:clsql-connect-error-errno
 194      #:clsql-sql-error
 195      #:clsql-sql-error-database
 196      #:clsql-sql-error-expression
 197      #:clsql-sql-error-errno
 198      #:clsql-sql-error-error
 199      #:clsql-database-warning
 200      #:clsql-database-warning-database
 201      #:clsql-database-warning-message
 202      #:clsql-exists-condition
 203      #:clsql-exists-condition-new-db
 204      #:clsql-exists-condition-old-db
 205      #:clsql-exists-warning
 206      #:clsql-exists-error
 207      #:clsql-closed-error
 208      #:clsql-closed-error-database
 209      #:clsql-sql-syntax-error
 210      #:clsql-type-error
 211      #:clsql-odbc-error
 212      #:clsql-odbc-error-message
 213
 214      #:*loaded-database-types*
 215      #:reload-database-types
 216      #:*initialized-database-types*
 217      #:initialize-database-type
 218      #:*connect-if-exists*
 219      #:*default-database*
 220      #:connected-databases
 221      #:database
 222      #:find-database
 223      #:is-database-open
 224      #:database-type                     ; database   x
 225
 226      ;; utils.lisp
 227      #:number-to-sql-string
 228      #:float-to-sql-string
 229      #:sql-escape-quotes
 230      #:in
 231
 232      .
 233      ;; Shared exports for re-export by CLSQL package.
 234      ;; I = Implemented, D = Documented
 235      ;;  name                                 file       ID
 236      ;;====================================================
 237      #1=(;;------------------------------------------------
 238          ;; CommonSQL API
 239          ;;------------------------------------------------
 240          ;;FDML
 241        #:select                            ; objects    xx
 242        #:cache-table-queries               ;
 243        #:*cache-table-queries-default*     ;
 244        #:delete-records                    ; sql        xx
 245        #:insert-records                    ; sql        xx
 246        #:update-records                    ; sql        xx
 247        #:execute-command                   ; sql        xx
 248        #:query                             ; sql        xx
 249        #:print-query                       ; sql        xx
 250        #:do-query                          ; sql        xx
 251        #:map-query                         ; sql        xx
 252        #:for-each-row
 253        #:loop
 254
 255        ;;FDDL
 256        #:create-table                      ; table      xx
 257        #:drop-table                        ; table      xx
 258        #:list-tables                       ; table      xx
 259        #:table-exists-p                    ; table      xx
 260        #:list-attributes                   ; table      xx
 261        #:attribute-type                    ; table      xx
 262        #:list-attribute-types              ; table      xx
 263        #:*cache-table-queries-default*
 264        #:create-view                       ; table      xx
 265        #:drop-view                         ; table      xx
 266        #:create-index                      ; table      xx
 267        #:drop-index                        ; table      xx
 268        #:truncate-database
 269        ;;OODDL
 270        #:standard-db-object                ; objects    xx
 271        #:def-view-class                    ; objects    xx
 272        #:create-view-from-class            ; objects    xx
 273        #:drop-view-from-class              ; objects    xx
 274        ;;OODML
 275        #:instance-refreshed                ; objects    xx
 276        #:update-object-joins               ;
 277        #:*default-update-objects-max-len*  ;
 278        #:update-slot-from-record           ; objects    xx
 279        #:update-instance-from-records      ; objects    xx
 280        #:update-records-from-instance      ; objects    xx
 281        #:update-record-from-slot           ; objects    xx
 282        #:update-record-from-slots          ; objects    xx
 283        #:list-classes                      ; objects    xx
 284        #:delete-instance-records           ; objects    xx
 285        ;;Symbolic SQL Syntax
 286        #:sql                               ; syntax     xx
 287        #:sql-expression                    ; syntax     xx
 288        #:sql-operation                     ; syntax     xx
 289        #:sql-operator                      ; syntax     xx
 290        #:disable-sql-reader-syntax         ; syntax     xx
 291        #:enable-sql-reader-syntax          ; syntax     xx
 292        #:locally-disable-sql-reader-syntax ; syntax     xx
 293        #:locally-enable-sql-reader-syntax  ; syntax     xx
 294        #:restore-sql-reader-syntax-state   ; syntax     xx
 295
 296        ;;FDDL
 297        #:list-views                        ; table      xx
 298        #:view-exists-p                     ; table      xx
 299        #:list-indexes                      ; table      xx
 300        #:list-table-indexes                ; table      xx
 301        #:index-exists-p                    ; table      xx
 302        #:create-sequence                   ; table      xx
 303        #:drop-sequence                     ; table      xx
 304        #:list-sequences                    ; table      xx
 305        #:sequence-exists-p                 ; table      xx
 306        #:sequence-next                     ; table      xx
 307        #:sequence-last                     ; table      xx
 308        #:set-sequence-position             ; table      xx
 309        ;;OODDL
 310        #:view-table                        ; metaclass  x
 311        #:universal-time                    ; objects    xx
 312        #:bigint
 313        ;;OODML
 314        #:*db-auto-sync*                    ; objects    xx
 315        #:add-to-relation                   ; objects    x
 316        #:remove-from-relation              ; objects    x
 317        #:read-sql-value                    ; objects    x
 318        #:database-output-sql-as-type       ; objects    x
 319        #:database-get-type-specifier       ; objects    x
 320        #:database-output-sql               ; sql/class  xx
 321
 322        ;; conditions
 323        #:clsql-condition
 324        #:clsql-error
 325        #:clsql-simple-error
 326        #:clsql-warning
 327        #:clsql-simple-warning
 328
 329        ;;-----------------------------------------------
 330        ;; Symbolic Sql Syntax
 331        ;;-----------------------------------------------
 332        #:sql-and-qualifier
 333        #:sql-escape
 334        #:sql-query
 335        #:sql-object-query
 336        #:sql-any
 337        #:sql-all
 338        #:sql-not
 339        #:sql-union
 340        #:sql-intersection
 341        #:sql-minus
 342        #:sql-group-by
 343        #:sql-having
 344        #:sql-null
 345        #:sql-not-null
 346        #:sql-exists
 347        #:sql-*
 348        #:sql-+
 349        #:sql-/
 350        #:sql-like
 351        #:sql-uplike
 352        #:sql-and
 353        #:sql-or
 354        #:sql-in
 355        #:sql-||
 356        #:sql-is
 357        #:sql-=
 358        #:sql-==
 359        #:sql-<
 360        #:sql->
 361        #:sql->=
 362        #:sql-<=
 363        #:sql-count
 364        #:sql-max
 365        #:sql-min
 366        #:sql-avg
 367        #:sql-sum
 368        #:sql-view-class
 369        #:sql_slot-value
 370
 371
 372
 373        ;; time.lisp
 374        #:bad-component
 375        #:current-day
 376      #:current-month
 377      #:current-year
 378      #:day-duration
 379      #:db-timestring
 380      #:decode-duration
 381      #:decode-time
 382      #:duration
 383      #:duration+
 384      #:duration<
 385      #:duration<=
 386      #:duration=
 387      #:duration>
 388      #:duration>=
 389      #:duration-day
 390      #:duration-hour
 391      #:duration-minute
 392      #:duration-month
 393      #:duration-second
 394      #:duration-year
 395      #:duration-reduce
 396      #:duration-timestring
 397      #:extract-roman
 398      #:format-duration
 399      #:format-time
 400      #:get-time
 401      #:utime->time
 402      #:interval-clear
 403      #:interval-contained
 404      #:interval-data
 405      #:interval-edit
 406      #:interval-end
 407      #:interval-match
 408      #:interval-push
 409      #:interval-relation
 410      #:interval-start
 411      #:interval-type
 412      #:make-duration
 413      #:make-interval
 414      #:make-time
 415      #:merged-time
 416      #:midnight
 417      #:month-name
 418      #:parse-date-time
 419      #:parse-timestring
 420      #:parse-yearstring
 421      #:print-date
 422      #:roll
 423      #:roll-to
 424      #:time
 425      #:time+
 426      #:time-
 427      #:time-by-adding-duration
 428      #:time-compare
 429      #:time-difference
 430      #:time-dow
 431      #:time-element
 432      #:time-max
 433      #:time-min
 434      #:time-mjd
 435      #:time-msec
 436      #:time-p
 437      #:time-sec
 438      #:time-well-formed
 439      #:time-ymd
 440      #:time<
 441      #:time<=
 442      #:time=
 443      #:time>
 444      #:time>=
 445      #:timezone
 446      #:universal-time
 447      #:wall-time
 448      #:wall-timestring
 449      #:week-containing
 450      #:gregorian-to-mjd
 451      #:mjd-to-gregorian
 452
 453      ;; recording.lisp -- SQL I/O Recording
 454      #:record-sql-command
 455      #:record-sql-result
 456      #:add-sql-stream                 ; recording  xx
 457      #:delete-sql-stream                  ; recording  xx
 458      #:list-sql-streams           ; recording  xx
 459      #:sql-recording-p            ; recording  xx
 460      #:sql-stream                         ; recording  xx
 461      #:start-sql-recording                ; recording  xx
 462      #:stop-sql-recording                 ; recording  xx
 463
 464      ;; database.lisp -- Connection
 465      #:*default-database-type*            ; clsql-base xx
 466      #:*default-database*                 ; classes    xx
 467      #:connect                            ; database   xx
 468      #:*connect-if-exists*                ; database   xx
 469      #:connected-databases                ; database   xx
 470      #:database                   ; database   xx
 471      #:database-name                     ; database   xx
 472      #:disconnect                         ; database   xx
 473      #:reconnect                         ; database
 474      #:find-database                     ; database   xx
 475      #:status                            ; database   xx
 476      #:with-database
 477      #:with-default-database
 478      #:disconnect-pooled
 479      #:create-database
 480      #:destroy-database
 481      #:probe-database
 482      #:list-databases
 483
 484      #:describe-table
 485      #:*backend-warning-behavior*
 486
 487      ;; Transactions
 488      #:with-transaction
 489      #:commit-transaction
 490      #:rollback-transaction
 491      #:add-transaction-commit-hook
 492      #:add-transaction-rollback-hook
 493      #:commit                            ; transact   xx
 494      #:rollback                   ; transact   xx
 495      #:with-transaction           ; transact   xx               .
 496      #:start-transaction                 ; transact   xx
 497      #:in-transaction-p                  ; transact   xx
 498      #:database-start-transaction
 499      #:database-abort-transaction
 500      #:database-commit-transaction
 501      #:transaction-level
 502      #:transaction
 503        ))
 504   (:documentation "This is the INTERNAL SQL-Interface package of CLSQL."))
 505
 506
 507 (defpackage #:clsql
 508   (:use #:common-lisp)
 509   (:import-from #:clsql-sys . #1#)
 510   (:export . #1#)
 511   (:documentation "This is the user package with CLSQL symbols."))
 512
 513 (defpackage #:clsql-user
 514   (:use #:common-lisp)
 515   (:import-from #:clsql-sys . #1#)
 516   (:export . #1#)
 517   (:documentation "This is the user package with CLSQL symbols."))
 518
 519   ;; This is from USQL's pcl-patch
 520   #+(or clsql-sbcl-pcl clsql-cmucl-pcl)
 521   (progn
 522     ;; Note that this will no longer required for cmucl as of version 19a.
 523     (in-package #+cmu :pcl #+sbcl :sb-pcl)
 524     (defmacro pv-binding1 ((pv calls pv-table-symbol pv-parameters slot-vars)
 525                            &body body)
 526       `(pv-env (,pv ,calls ,pv-table-symbol ,pv-parameters)
 527         (let (,@(mapcar #'(lambda (slot-var p) `(,slot-var (get-slots-or-nil ,p)))
 528                         slot-vars pv-parameters))
 529           ,@(mapcar #'(lambda (slot-var) `(declare (ignorable ,slot-var))) slot-vars)
 530           ,@body))))
 531
 532 ;; see http://thread.gmane.org/gmane.lisp.lispworks.general/681
 533 #+lispworks
 534 (setf *packages-for-warn-on-redefinition*
 535       (delete "SQL" *packages-for-warn-on-redefinition* :test 'string=))
 536
 537   #+sbcl
 538   (if (find-package 'sb-mop)
 539       (setq cl:*features* (delete :clsql-sbcl-mop cl:*features*))
 540       (setq cl:*features* (delete :clsql-sbcl-pcl cl:*features*)))
 541
 542   #+cmu
 543   (if (find-package 'mop)
 544       (setq cl:*features* (delete :clsql-cmucl-mop cl:*features*))
 545       (setq cl:*features* (delete :clsql-cmucl-pcl cl:*features*)))
 546
 547 ) ;eval-when
 548