r9113: intial changes for list-table-indexes
[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      
49      #:database-list-tables
50      #:database-list-attributes
51      #:database-attribute-type
52      #:database-create-sequence 
53      #:database-drop-sequence
54      #:database-sequence-next
55      #:sql-escape
56      #:database-sequence-last
57      #:database-set-sequence-position
58      #:database-list-attributes
59      #:database-list-sequences
60      #:database-list-indexes
61      #:database-list-table-indexes
62      #:database-list-views
63      
64      
65      ;; Large objects (Marc B)
66      #:database-create-large-object
67      #:database-write-large-object
68      #:database-read-large-object
69      #:database-delete-large-object
70
71      #:command-output
72      #:make-process-lock
73      #:with-process-lock
74      #:connection-spec
75      #:ensure-keyword
76
77      ;; utils.lisp
78      #:without-interrupts
79      #:make-process-lock
80      #:with-process-lock
81      #:command-output
82
83      ;; Shared exports for re-export by CLSQL-BASE
84      .
85      #1=(#:clsql-condition
86          #:clsql-error
87          #:clsql-simple-error
88          #:clsql-warning
89          #:clsql-simple-warning
90          #:clsql-invalid-spec-error
91          #:clsql-invalid-spec-error-connection-spec
92          #:clsql-invalid-spec-error-database-type
93          #:clsql-invalid-spec-error-template
94          #:clsql-access-error
95          #:clsql-access-error-database-type
96          #:clsql-access-error-connection-spec
97          #:clsql-access-error-error
98          #:clsql-connect-error
99          #:clsql-connect-error-errno
100          #:clsql-sql-error
101          #:clsql-sql-error-database
102          #:clsql-sql-error-expression
103          #:clsql-sql-error-errno
104          #:clsql-sql-error-error
105          #:clsql-database-warning
106          #:clsql-database-warning-database
107          #:clsql-database-warning-message
108          #:clsql-exists-condition
109          #:clsql-exists-condition-new-db
110          #:clsql-exists-condition-old-db
111          #:clsql-exists-warning
112          #:clsql-exists-error
113          #:clsql-closed-error
114          #:clsql-closed-error-database
115          #:clsql-sql-syntax-error
116          #:clsql-type-error
117          #:clsql-odbc-error
118          #:clsql-odbc-error-message
119          
120          #:*loaded-database-types*
121          #:reload-database-types
122          #:*default-database-type*
123          #:*initialized-database-types*
124          #:initialize-database-type
125          #:*connect-if-exists*
126          #:*default-database*
127          #:connected-databases
128          #:database
129          #:database-name
130          #:find-database
131          #:database-name-from-spec
132          #:is-database-open
133
134          ;; accessors for database class
135          #:name
136          #:connection-spec
137          #:transaction
138          #:transaction-level
139          #:conn-pool
140          #:command-recording-stream
141          #:result-recording-stream
142          #:query-recording-stream
143          #:view-classes
144          #:database-type
145          #:database-state
146
147          ;; utils.lisp
148          #:number-to-sql-string
149          #:float-to-sql-string
150          #:sql-escape-quotes
151          
152          ;; time.lisp
153          #:bad-component
154          #:current-day
155          #:current-month
156          #:current-year
157          #:day-duration
158          #:db-timestring
159          #:decode-duration
160          #:decode-time
161          #:duration
162          #:duration+
163          #:duration<
164          #:duration<=
165          #:duration=
166          #:duration>
167          #:duration>=
168          #:duration-day
169          #:duration-hour
170          #:duration-minute
171          #:duration-month
172          #:duration-second
173          #:duration-year
174          #:duration-reduce 
175          #:duration-timestring
176          #:extract-roman 
177          #:format-duration
178          #:format-time
179          #:get-time
180          #:interval-clear
181          #:interval-contained
182          #:interval-data
183          #:interval-edit
184          #:interval-end
185          #:interval-match
186          #:interval-push
187          #:interval-relation
188          #:interval-start
189          #:interval-type
190          #:make-duration
191          #:make-interval
192          #:make-time
193          #:merged-time
194          #:midnight
195          #:month-name
196          #:parse-date-time
197          #:parse-timestring
198          #:parse-yearstring
199          #:print-date
200          #:roll
201          #:roll-to
202          #:time
203          #:time+
204          #:time-
205          #:time-by-adding-duration
206          #:time-compare
207          #:time-difference
208          #:time-dow
209          #:time-element
210          #:time-max
211          #:time-min
212          #:time-mjd
213          #:time-msec
214          #:time-p
215          #:time-sec
216          #:time-well-formed
217          #:time-ymd
218          #:time<
219          #:time<=
220          #:time=
221          #:time>
222          #:time>=
223          #:timezone
224          #:universal-time
225          #:wall-time
226          #:wall-timestring
227          #:week-containing
228          #:gregorian-to-mjd
229          #:mjd-to-gregorian
230          x
231          ;; recording.lisp -- SQL I/O Recording 
232          #:record-sql-action
233          #:add-sql-stream                 ; recording  xx
234          #:delete-sql-stream              ; recording  xx
235          #:list-sql-streams               ; recording  xx
236          #:sql-recording-p                ; recording  xx
237          #:sql-stream                     ; recording  xx
238          #:start-sql-recording            ; recording  xx
239          #:stop-sql-recording             ; recording  xx
240
241          ;; database.lisp -- Connection
242          #:*default-database-type*                ; clsql-base xx
243          #:*default-database*             ; classes    xx
244          #:connect                                ; database   xx
245          #:*connect-if-exists*            ; database   xx
246          #:connected-databases            ; database   xx
247          #:database                       ; database   xx
248          #:database-name                     ; database   xx
249          #:disconnect                     ; database   xx
250          #:reconnect                         ; database
251          #:find-database                     ; database   xx
252          #:status                            ; database   xx
253          #:with-database
254          #:with-default-database
255          #:disconnect-pooled
256          #:create-database
257          #:destroy-database
258          #:probe-database
259          #:list-databases
260
261          ;; basic-sql.lisp
262          #:query
263          #:execute-command
264          #:write-large-object
265          #:read-large-object
266          #:delete-large-object
267          #:do-query
268          #:map-query
269          #:describe-table
270
271          ;; Transactions
272          #:with-transaction
273          #:commit-transaction
274          #:rollback-transaction
275          #:add-transaction-commit-hook
276          #:add-transaction-rollback-hook
277          #:commit                            ; transact   xx
278          #:rollback                       ; transact   xx
279          #:with-transaction               ; transact   xx               .
280          #:start-transaction                 ; transact   xx
281          #:in-transaction-p                  ; transact   xx
282          #:database-start-transaction
283          #:database-abort-transaction
284          #:database-commit-transaction
285          #:transaction-level
286          #:transaction
287
288          ))
289     (:documentation "This is the INTERNAL SQL-Interface package of CLSQL-BASE."))
290
291 (defpackage #:clsql-base
292     (:import-from #:clsql-base-sys . #1#)
293     (:export . #1#)
294     (:documentation "This is the SQL-Interface package of CLSQL-BASE."))
295 );eval-when
296
297