sql/package.lisp

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