X-Git-Url: http://git.kpe.io/?a=blobdiff_plain;f=doc%2Fref-syntax.xml;h=dd0dd0ef4f6d732328695eca2472ad5d72fdf060;hb=a6131d02d6b3c41ccb0ae411f8132857b39aa2f4;hp=c83cab344d41ad08852dfb922f4db23adba092a7;hpb=f7a356bb4c11d062eeeb5d4aaf4e187a3cb15a27;p=clsql.git
diff --git a/doc/ref-syntax.xml b/doc/ref-syntax.xml
index c83cab3..dd0dd0e 100644
--- a/doc/ref-syntax.xml
+++ b/doc/ref-syntax.xml
@@ -23,7 +23,7 @@
ENABLE-SQL-READER-SYNTAX
- Macro ENABLE-SQL-READER-SYNTAX
+ ENABLE-SQL-READER-SYNTAX
Globally enable square bracket reader syntax.
Macro
@@ -97,7 +97,7 @@
DISABLE-SQL-READER-SYNTAX
- Macro DISABLE-SQL-READER-SYNTAX
+ DISABLE-SQL-READER-SYNTAX
Globally disable square bracket reader syntax.
Macro
@@ -171,7 +171,7 @@
LOCALLY-ENABLE-SQL-READER-SYNTAX
- Macro LOCALLY-ENABLE-SQL-READER-SYNTAX
+ LOCALLY-ENABLE-SQL-READER-SYNTAX
Globally enable square bracket reader syntax.
Macro
@@ -249,7 +249,7 @@
LOCALLY-DISABLE-SQL-READER-SYNTAX
- Macro LOCALLY-DISABLE-SQL-READER-SYNTAX
+ LOCALLY-DISABLE-SQL-READER-SYNTAX
Locally disable square bracket reader syntax.
Macro
@@ -330,7 +330,7 @@
RESTORE-SQL-READER-SYNTAX-STATE
- Macro RESTORE-SQL-READER-SYNTAX-STATE
+ RESTORE-SQL-READER-SYNTAX-STATE
Restore square bracket reader syntax to its previous state.
@@ -409,12 +409,86 @@
+
+
+ FILE-ENABLE-SQL-READER-SYNTAX
+
+
+ FILE-ENABLE-SQL-READER-SYNTAX
+
+ Enable the square bracket reader syntax for the duration of the file.
+
+ Macro
+
+
+ Syntax
+
+ file-enable-sql-reader-syntax =>
+
+
+ Arguments and Values
+ None.
+
+
+ Description
+ Uncoditionally enables the SQL reader syntax. Unlike
+ enable-sql-reader-syntax and
+ disable-sql-reader-syntax which try to keep track of whether
+ the syntax has been enabled or disabled and keep track of the old read-table for restoration this function just enables it unconditionally.
+
+ Once enabled this way there is no corresponding disable function but instead relies on being used in a file context. The spec for load and compile-file states that the *readtable* will be restored after processing the file.
+
+
+ Examples
+ Intended to be used at the top of a file that contains sql reader syntax.
+
+ (in-package :my-package)
+ (clsql:file-enable-sql-reader-syntax)
+ ...
+ ;;functions that use the square bracket syntax.
+
+
+
+ Side Effects
+
+ Modifies the readtable.
+
+
+
+ Affected by
+ None.
+
+
+ Exceptional Situations
+
+ None.
+
+
+
+ See Also
+
+ enable-sql-reader-syntax
+ disable-sql-reader-syntax
+ locally-enable-sql-reader-syntax
+ locally-disable-sql-reader-syntax
+
+
+
+ Notes
+
+ Unique to &clsql;, not present in &commonsql;.
+
+
+
+
SQL
- Function SQL
+ SQL
Construct an SQL string from supplied expressions.
Function
@@ -513,7 +587,7 @@
SQL-EXPRESSION
- Function SQL-EXPRESSION
+ SQL-EXPRESSION
Constructs an SQL expression from supplied keyword arguments.
Function
@@ -671,7 +745,7 @@
SQL-OPERATION
- Function SQL-OPERATION
+ SQL-OPERATION
Constructs an SQL expression from a supplied operator and arguments.
Function
@@ -775,7 +849,7 @@
SQL-OPERATOR
- Function SQL-OPERATOR
+ SQL-OPERATOR
Returns the symbol for the supplied SQL operator.
Function
@@ -847,80 +921,73 @@
- any
- ,
- some
- ,
- all
- ,
- not
- ,
- union
- ,
- intersect
- ,
- minus
- ,
+ any
+ some
+ all
+ not
+ union
+ intersect
+ minus
except
- ,
+
order-by
- ,
+
null
- ,
+
*
- ,
+
+
- ,
+
/
- ,
+
-
- ,
+
like
- ,
+
and
- ,
+
or
- ,
+
in
- ,
+
substr
- ,
+
||
- ,
+
=
- ,
+
<
- ,
+
>
- ,
+
>=
- ,
+
<=
- ,
+
<>
- ,
+
count
- ,
+
max
- ,
+
min
- ,
+
avg
- ,
+
sum
- ,
+
function
- ,
+
between
- ,
+
distinct
- ,
+
nvl
- ,
+
slot-value
- ,
+
userenv
- ,
+
as well as the pseudo-operator function.
@@ -930,30 +997,30 @@
concat
- ,
+
substring
- ,
+
limit
- ,
+
group-by
- ,
+
having
- ,
+
not-null
- ,
+
exists
- ,
+
uplike
- ,
+
is
- ,
+
==
- ,
+
the
- ,
+
coalesce
- ,
- view-class.
+
+ view-class