sql/package.lisp

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