r2059: cleanup sql-escape* functions
[clsql.git] / sql / usql.cl
1 ;;;; -*- Mode: LISP; Syntax: ANSI-Common-Lisp; Base: 10 -*-
2 ;;;; *************************************************************************
3 ;;;; FILE IDENTIFICATION
4 ;;;;
5 ;;;; Name:          usql.cl
6 ;;;; Purpose:       High-level interface to SQL driver routines needed for
7 ;;;;                UncommonSQL
8 ;;;; Programmers:   Kevin M. Rosenberg and onShore Development Inc
9 ;;;; Date Started:  Mar 2002
10 ;;;;
11 ;;;; $Id: usql.cl,v 1.7 2002/05/19 16:05:23 kevin Exp $
12 ;;;;
13 ;;;; This file, part of CLSQL, is Copyright (c) 2002 by Kevin M. Rosenberg
14 ;;;; and onShore Development Inc
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
22 ;;; Minimal high-level routines to enable low-level interface for USQL
23
24 (declaim (optimize (debug 3) (speed 3) (safety 1) (compilation-speed 0)))
25 (in-package :clsql-sys)
26
27 (defun list-tables (&key (database *default-database*)
28                          (system-tables nil))
29   "List all tables in *default-database*, or if the :database keyword arg
30 is given, the specified database.  If the keyword arg :system-tables
31 is true, then it will not filter out non-user tables.  Table names are
32 given back as a list of strings."
33   (database-list-tables database :system-tables system-tables))
34
35
36 (defun list-attributes (table &key (database *default-database*))
37   "List the attributes of TABLE in *default-database, or if the
38 :database keyword is given, the specified database.  Attributes are
39 returned as a list of strings."
40   (database-list-attributes table database))
41
42 (defun attribute-type (attribute table &key (database *default-database*))
43   "Return the field type of the ATTRIBUTE in TABLE.  The optional
44 keyword argument :database specifies the database to query, defaulting
45 to *default-database*."
46   (database-attribute-type attribute table database))
47
48 (defun add-attribute (table attribute &key (database *default-database*))
49   "Add the ATTRIBUTE to TABLE.  The ATTRIBUTE sepcification must
50 include a type argument.  The optional keyword argument :database
51 specifies the database to operation on, defaulting to
52 *default-database*."
53   (database-add-attribute table attribute database))
54
55 (defun rename-attribute (table oldatt newname
56                                &key (database *default-database*))
57   (error "(rename-attribute ~a ~a ~a ~a) is not implemented" table oldatt newname database))
58
59
60 (defclass %sql-expression ()
61     ())
62
63 ;; For SQL Identifiers of generic type
64 (defclass sql-ident (%sql-expression)
65   ((name
66     :initarg :name
67     :initform "NULL"))
68   (:documentation "An SQL identifer."))
69
70 (defmethod make-load-form ((sql sql-ident) &optional environment)
71   (declare (ignore environment))
72   (with-slots (name)
73     sql
74     `(make-instance 'sql-ident :name ',name)))
75
76
77 (defun create-sequence (name &key (database *default-database*))
78   (database-create-sequence name database))
79
80 (defun drop-sequence (name &key (database *default-database*))
81   (database-drop-sequence name database))
82
83 (defun sequence-next (name &key (database *default-database*))
84   (database-sequence-next name database))
85
86 (defclass sql-value-exp (%sql-expression)
87   ((modifier
88     :initarg :modifier
89     :initform nil)
90    (components
91     :initarg :components
92     :initform nil))
93   (:documentation
94    "An SQL value expression.")
95   )
96
97 (defclass sql-typecast-exp (sql-value-exp)
98   ()
99   (:documentation
100    "An SQL typecast expression.")
101   )
102 (defvar +null-string+ "NULL")
103
104 (defvar *sql-stream* nil
105   "stream which accumulates SQL output")
106
107 (defmethod output-sql ((expr %sql-expression) &optional
108                        (database *default-database*))
109   (declare (ignore database))
110   (write-string +null-string+ *sql-stream*))
111
112 (defmethod print-object ((self %sql-expression) stream)
113   (print-unreadable-object
114    (self stream :type t)
115    (write-string (sql-output self) stream)))
116
117
118 ;; Methods for translating high-level table classes to low-level functions
119
120 (defmethod database-list-attributes ((table sql-ident) database)
121   (database-list-attributes (string-downcase
122                              (symbol-name (slot-value table 'name)))
123                             database)
124   )
125
126 (defmethod database-attribute-type (attribute (table sql-ident) database)
127   (database-attribute-type attribute (string-downcase
128                                       (symbol-name (slot-value table 'name)))
129                            database))