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