2 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
3 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
4 <!ENTITY % myents SYSTEM "entities.inc">
8 <!-- Symbolic SQL Syntax -->
9 <reference id="ref-syntax">
10 <title>The Symbolic SQL Syntax</title>
17 <refentry id="disable-sql-reader-syntax">
19 <refname>DISABLE-SQL-READER-SYNTAX</refname>
20 <refpurpose><!-- purpose --></refpurpose>
21 <refclass>Function</refclass>
26 <function> (DISABLE-SQL-READER-SYNTAX) [macro]</function> => <returnvalue><!-- result --></returnvalue></synopsis>
29 <title>Arguments and Values</title>
31 <!-- arguments and values -->
35 <title>Description</title>
36 <para>Turns off the SQL reader syntax setting the
37 syntax state such that if the syntax is subsequently
38 enabled, RESTORE-SQL-READER-SYNTAX-STATE will disable
43 <title>Examples</title>
49 <title>Side Effects</title>
55 <title>Affected by</title>
63 <title>Exceptional Situations</title>
65 <!-- execeptional situations -->
69 <title>See Also</title>
84 <refentry id="enable-sql-reader-syntax">
86 <refname>ENABLE-SQL-READER-SYNTAX</refname>
87 <refpurpose><!-- purpose --></refpurpose>
88 <refclass>Function</refclass>
93 <function> (ENABLE-SQL-READER-SYNTAX) [macro]</function> => <returnvalue><!-- result --></returnvalue></synopsis>
96 <title>Arguments and Values</title>
98 <!-- arguments and values -->
102 <title>Description</title>
103 <para>Turns on the SQL reader syntax setting the
104 syntax state such that if the syntax is subsequently
105 disabled, RESTORE-SQL-READER-SYNTAX-STATE will enable
110 <title>Examples</title>
116 <title>Side Effects</title>
118 <!-- side effects -->
122 <title>Affected by</title>
130 <title>Exceptional Situations</title>
132 <!-- execeptional situations -->
136 <title>See Also</title>
151 <refentry id="locally-disable-sql-reader-syntax">
153 <refname>LOCALLY-DISABLE-SQL-READER-SYNTAX</refname>
154 <refpurpose><!-- purpose --></refpurpose>
155 <refclass>Function</refclass>
158 <title>Syntax</title>
160 <function> (LOCALLY-DISABLE-SQL-READER-SYNTAX) [macro]</function> => <returnvalue><!-- result --></returnvalue></synopsis>
163 <title>Arguments and Values</title>
165 <!-- arguments and values -->
169 <title>Description</title>
170 <para>Turns off the SQL reader syntax without
171 changing the syntax state such that
172 RESTORE-SQL-READER-SYNTAX-STATE will re-establish the
173 current syntax state.
177 <title>Examples</title>
183 <title>Side Effects</title>
185 <!-- side effects -->
189 <title>Affected by</title>
197 <title>Exceptional Situations</title>
199 <!-- execeptional situations -->
203 <title>See Also</title>
218 <refentry id="locally-enable-sql-reader-syntax">
220 <refname>LOCALLY-ENABLE-SQL-READER-SYNTAX</refname>
221 <refpurpose><!-- purpose --></refpurpose>
222 <refclass>Function</refclass>
225 <title>Syntax</title>
227 <function> (LOCALLY-ENABLE-SQL-READER-SYNTAX) [macro]</function> => <returnvalue><!-- result --></returnvalue></synopsis>
230 <title>Arguments and Values</title>
232 <!-- arguments and values -->
236 <title>Description</title>
237 <para>Turns on the SQL reader syntax without
238 changing the syntax state such that
239 RESTORE-SQL-READER-SYNTAX-STATE will re-establish the
240 current syntax state.
244 <title>Examples</title>
250 <title>Side Effects</title>
252 <!-- side effects -->
256 <title>Affected by</title>
264 <title>Exceptional Situations</title>
266 <!-- execeptional situations -->
270 <title>See Also</title>
285 <refentry id="restore-sql-reader-syntax-state">
287 <refname>RESTORE-SQL-READER-SYNTAX-STATE</refname>
288 <refpurpose><!-- purpose --></refpurpose>
289 <refclass>Function</refclass>
292 <title>Syntax</title>
294 <function> (RESTORE-SQL-READER-SYNTAX-STATE) [macro]</function> => <returnvalue><!-- result --></returnvalue></synopsis>
297 <title>Arguments and Values</title>
299 <!-- arguments and values -->
303 <title>Description</title>
304 <para>Enables the SQL reader syntax if
305 ENABLE-SQL-READER-SYNTAX has been called more recently
306 than DISABLE-SQL-READER-SYNTAX and otherwise disables
307 the SQL reader syntax. By default, the SQL reader
312 <title>Examples</title>
318 <title>Side Effects</title>
320 <!-- side effects -->
324 <title>Affected by</title>
332 <title>Exceptional Situations</title>
334 <!-- execeptional situations -->
338 <title>See Also</title>
355 <refname>SQL</refname>
356 <refpurpose><!-- purpose --></refpurpose>
357 <refclass>Function</refclass>
360 <title>Syntax</title>
362 <function> (SQL &REST ARGS) [function]</function> => <returnvalue><!-- result --></returnvalue></synopsis>
365 <title>Arguments and Values</title>
367 <!-- arguments and values -->
371 <title>Description</title>
372 <para>Returns an SQL string generated from the SQL expressions
373 ARGS. The expressions are translated into SQL strings and then
374 concatenated with a single space delimiting each expression.
378 <title>Examples</title>
384 <title>Side Effects</title>
386 <!-- side effects -->
390 <title>Affected by</title>
398 <title>Exceptional Situations</title>
400 <!-- execeptional situations -->
404 <title>See Also</title>
420 <refentry id="sql-expression">
422 <refname>SQL-EXPRESSION</refname>
423 <refpurpose><!-- purpose --></refpurpose>
424 <refclass>Function</refclass>
427 <title>Syntax</title>
429 <function> (SQL-EXPRESSION &KEY STRING TABLE ALIAS ATTRIBUTE TYPE) [function]</function> => <returnvalue><!-- result --></returnvalue></synopsis>
432 <title>Arguments and Values</title>
434 <!-- arguments and values -->
438 <title>Description</title>
439 <para>Returns an SQL expression constructed from
440 the supplied arguments which may be combined as
441 follows: ATTRIBUTE and TYPE; ATTRIBUTE; ALIAS or TABLE
442 and ATTRIBUTE and TYPE; ALIAS or TABLE and ATTRIBUTE;
443 TABLE, ATTRIBUTE and TYPE; TABLE and ATTRIBUTE; TABLE
444 and ALIAS; TABLE; and STRING.
448 <title>Examples</title>
454 <title>Side Effects</title>
456 <!-- side effects -->
460 <title>Affected by</title>
468 <title>Exceptional Situations</title>
470 <!-- execeptional situations -->
474 <title>See Also</title>
489 <refentry id="sql-operation">
491 <refname>SQL-OPERATION</refname>
492 <refpurpose><!-- purpose --></refpurpose>
493 <refclass>Function</refclass>
496 <title>Syntax</title>
498 <function> (SQL-OPERATION OPERATION &REST REST) [function]</function> => <returnvalue><!-- result --></returnvalue></synopsis>
501 <title>Arguments and Values</title>
503 <!-- arguments and values -->
507 <title>Description</title>
508 <para>Returns an SQL expression constructed from
509 the supplied SQL operator or function OPERATION and
510 its arguments REST. If OPERATION is passed the symbol
511 FUNCTION then the first value in REST is taken to be a
512 valid SQL function and the remaining values in REST
517 <title>Examples</title>
523 <title>Side Effects</title>
525 <!-- side effects -->
529 <title>Affected by</title>
537 <title>Exceptional Situations</title>
539 <!-- execeptional situations -->
543 <title>See Also</title>
558 <refentry id="sql-operator">
560 <refname>SQL-OPERATOR</refname>
561 <refpurpose><!-- purpose --></refpurpose>
562 <refclass>Function</refclass>
565 <title>Syntax</title>
567 <function> (SQL-OPERATOR OPERATION) [function]</function> => <returnvalue><!-- result --></returnvalue></synopsis>
570 <title>Arguments and Values</title>
572 <!-- arguments and values -->
576 <title>Description</title>
577 <para>Returns the Lisp symbol corresponding to the
578 SQL operation represented by the symbol
583 <title>Examples</title>
589 <title>Side Effects</title>
591 <!-- side effects -->
595 <title>Affected by</title>
603 <title>Exceptional Situations</title>
605 <!-- execeptional situations -->
609 <title>See Also</title>