r9123: test & capability updates
[clsql.git] / base / 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 base (low-level) SQL interface
7 ;;;; Programmers:   Kevin M. Rosenberg based on
8 ;;;;                Original code by Pierre R. Mai 
9 ;;;; Date Started:  Feb 2002
10 ;;;;
11 ;;;; $Id$
12 ;;;;
13 ;;;; This file, part of CLSQL, is Copyright (c) 2002-2004 by Kevin M. Rosenberg
14 ;;;; and Copyright (c) 1999-2001 by Pierre R. Mai
15 ;;;;
16 ;;;; CLSQL users are granted the rights to distribute and use this software
17 ;;;; as governed by the terms of the Lisp Lesser GNU Public License
18 ;;;; (http://opensource.franz.com/preamble.html), also known as the LLGPL.
19 ;;;; *************************************************************************
20
21 (in-package #:cl-user)
22
23 ;;;; This file makes the required package definitions for CLSQL's
24 ;;;; core packages.
25
26 (eval-when (:compile-toplevel :load-toplevel :execute)
27 (defpackage #:clsql-base-sys
28   (:use #:cl)
29   (:export
30      ;; "Private" exports for use by interface packages
31      #:check-connection-spec
32      #:database-type-load-foreign
33      #:database-type-library-loaded ;; KMR - Tests if foreign library okay
34      #:database-initialize-database-type
35      #:database-connect
36      #:database-disconnect
37      #:database-reconnect
38      #:database-query
39      #:database-execute-command
40      #:database-query-result-set
41      #:database-dump-result-set
42      #:database-store-next-row
43      #:database-create
44      #:database-destroy
45      #:database-probe
46      #:database-list
47      #:database-describe-table
48      #:database-underlying-type
49
50      #:database-list-tables
51      #:database-list-attributes
52      #:database-attribute-type
53      #:database-create-sequence 
54      #:database-drop-sequence
55      #:database-sequence-next
56      #:sql-escape
57      #:database-sequence-last
58      #:database-set-sequence-position
59      #:database-list-attributes
60      #:database-list-sequences
61      #:database-list-indexes
62      #:database-list-table-indexes
63      #:database-list-views
64      
65      
66      ;; Large objects (Marc B)
67      #:database-create-large-object
68      #:database-write-large-object
69      #:database-read-large-object
70      #:database-delete-large-object
71
72      #:command-output
73      #:make-process-lock
74      #:with-process-lock
75      #:connection-spec
76      #:ensure-keyword
77
78      ;; utils.lisp
79      #:without-interrupts
80      #:make-process-lock
81      #:with-process-lock
82      #:command-output
83
84      ;; Shared exports for re-export by CLSQL-BASE
85      .
86      #1=(#:clsql-condition
87          #:clsql-error
88          #:clsql-simple-error
89          #:clsql-warning
90          #:clsql-simple-warning
91          #:clsql-invalid-spec-error
92          #:clsql-invalid-spec-error-connection-spec
93          #:clsql-invalid-spec-error-database-type
94          #:clsql-invalid-spec-error-template
95          #:clsql-access-error
96          #:clsql-access-error-database-type
97          #:clsql-access-error-connection-spec
98          #:clsql-access-error-error
99          #:clsql-connect-error
100          #:clsql-connect-error-errno
101          #:clsql-sql-error
102          #:clsql-sql-error-database
103          #:clsql-sql-error-expression
104          #:clsql-sql-error-errno
105          #:clsql-sql-error-error
106          #:clsql-database-warning
107          #:clsql-database-warning-database
108          #:clsql-database-warning-message
109          #:clsql-exists-condition
110          #:clsql-exists-condition-new-db
111          #:clsql-exists-condition-old-db
112          #:clsql-exists-warning
113          #:clsql-exists-error
114          #:clsql-closed-error
115          #:clsql-closed-error-database
116          #:clsql-sql-syntax-error
117          #:clsql-type-error
118          #:clsql-odbc-error
119          #:clsql-odbc-error-message
120          
121          #:*loaded-database-types*
122          #:reload-database-types
123          #:*default-database-type*
124          #:*initialized-database-types*
125          #:initialize-database-type
126          #:*connect-if-exists*
127          #:*default-database*
128          #:connected-databases
129          #:database
130          #:database-name
131          #:find-database
132          #:database-name-from-spec
133          #:is-database-open
134
135          ;; accessors for database class
136          #:name
137          #:connection-spec
138          #:transaction
139          #:transaction-level
140          #:conn-pool
141          #:command-recording-stream
142          #:result-recording-stream
143          #:query-recording-stream
144          #:view-classes
145          #:database-type
146          #:database-state
147
148          ;; utils.lisp
149          #:number-to-sql-string
150          #:float-to-sql-string
151          #:sql-escape-quotes
152          
153          ;; time.lisp
154          #:bad-component
155          #:current-day
156          #:current-month
157          #:current-year
158          #:day-duration
159          #:db-timestring
160          #:decode-duration
161          #:decode-time
162          #:duration
163          #:duration+
164          #:duration<
165          #:duration<=
166          #:duration=
167          #:duration>
168          #:duration>=
169          #:duration-day
170          #:duration-hour
171          #:duration-minute
172          #:duration-month
173          #:duration-second
174          #:duration-year
175          #:duration-reduce 
176          #:duration-timestring
177          #:extract-roman 
178          #:format-duration
179          #:format-time
180          #:get-time
181          #:utime->time
182          #:interval-clear
183          #:interval-contained
184          #:interval-data
185          #:interval-edit
186          #:interval-end
187          #:interval-match
188          #:interval-push
189          #:interval-relation
190          #:interval-start
191          #:interval-type
192          #:make-duration
193          #:make-interval
194          #:make-time
195          #:merged-time
196          #:midnight
197          #:month-name
198          #:parse-date-time
199          #:parse-timestring
200          #:parse-yearstring
201          #:print-date
202          #:roll
203          #:roll-to
204          #:time
205          #:time+
206          #:time-
207          #:time-by-adding-duration
208          #:time-compare
209          #:time-difference
210          #:time-dow
211          #:time-element
212          #:time-max
213          #:time-min
214          #:time-mjd
215          #:time-msec
216          #:time-p
217          #:time-sec
218          #:time-well-formed
219          #:time-ymd
220          #:time<
221          #:time<=
222          #:time=
223          #:time>
224          #:time>=
225          #:timezone
226          #:universal-time
227          #:wall-time
228          #:wall-timestring
229          #:week-containing
230          #:gregorian-to-mjd
231          #:mjd-to-gregorian
232          x
233          ;; recording.lisp -- SQL I/O Recording 
234          #:record-sql-action
235          #:add-sql-stream                 ; recording  xx
236          #:delete-sql-stream              ; recording  xx
237          #:list-sql-streams               ; recording  xx
238          #:sql-recording-p                ; recording  xx
239          #:sql-stream                     ; recording  xx
240          #:start-sql-recording            ; recording  xx
241          #:stop-sql-recording             ; recording  xx
242
243          ;; database.lisp -- Connection
244          #:*default-database-type*                ; clsql-base xx
245          #:*default-database*             ; classes    xx
246          #:connect                                ; database   xx
247          #:*connect-if-exists*            ; database   xx
248          #:connected-databases            ; database   xx
249          #:database                       ; database   xx
250          #:database-name                     ; database   xx
251          #:disconnect                     ; database   xx
252          #:reconnect                         ; database
253          #:find-database                     ; database   xx
254          #:status                            ; database   xx
255          #:with-database
256          #:with-default-database
257          #:disconnect-pooled
258          #:create-database
259          #:destroy-database
260          #:probe-database
261          #:list-databases
262
263          ;; basic-sql.lisp
264          #:query
265          #:execute-command
266          #:write-large-object
267          #:read-large-object
268          #:delete-large-object
269          #:do-query
270          #:map-query
271          #:describe-table
272
273          ;; Transactions
274          #:with-transaction
275          #:commit-transaction
276          #:rollback-transaction
277          #:add-transaction-commit-hook
278          #:add-transaction-rollback-hook
279          #:commit                            ; transact   xx
280          #:rollback                       ; transact   xx
281          #:with-transaction               ; transact   xx               .
282          #:start-transaction                 ; transact   xx
283          #:in-transaction-p                  ; transact   xx
284          #:database-start-transaction
285          #:database-abort-transaction
286          #:database-commit-transaction
287          #:transaction-level
288          #:transaction
289
290          ;; Database features specialized by backend
291          #:db-type-use-column-on-drop-index?
292          #:db-type-has-views?
293          #:db-type-has-subqueries?
294          #:db-type-has-boolean-where?
295          #:db-type-has-fancy-math?
296          #:db-backend-has-create/destroy-db?
297          #:db-type-transaction-capable?
298          ))
299     (:documentation "This is the INTERNAL SQL-Interface package of CLSQL-BASE."))
300
301 (defpackage #:clsql-base
302     (:import-from #:clsql-base-sys . #1#)
303     (:export . #1#)
304     (:documentation "This is the SQL-Interface package of CLSQL-BASE."))
305 );eval-when
306
307