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