X-Git-Url: http://git.kpe.io/?a=blobdiff_plain;ds=sidebyside;f=doc%2Fref-syntax.xml;h=787b4a3b08b28d1c09672447ad171a28e7286984;hb=36fe49cb03eb6ed2364334e5ce4e51df536a2b61;hp=b13dd32ff0cd7c279673e28e464efe1592244ffe;hpb=aee3ea30595ebee301ccb1532062053c3c580e19;p=clsql.git
diff --git a/doc/ref-syntax.xml b/doc/ref-syntax.xml
index b13dd32..787b4a3 100644
--- a/doc/ref-syntax.xml
+++ b/doc/ref-syntax.xml
@@ -23,7 +23,7 @@
ENABLE-SQL-READER-SYNTAX
- MacroENABLE-SQL-READER-SYNTAX
+ ENABLE-SQL-READER-SYNTAXGlobally enable square bracket reader syntax.Macro
@@ -84,6 +84,11 @@
The symbolic SQL syntax is disabled by default.
+
+ &clsql; differs from &commonsql; in that
+ enable-sql-reader-syntax is defined as a
+ macro rather than a function.
+
@@ -92,7 +97,7 @@
DISABLE-SQL-READER-SYNTAX
- MacroDISABLE-SQL-READER-SYNTAX
+ DISABLE-SQL-READER-SYNTAXGlobally disable square bracket reader syntax.Macro
@@ -153,6 +158,11 @@
The symbolic SQL syntax is disabled by default.
+
+ &clsql; differs from &commonsql; in that
+ disable-sql-reader-syntax is defined as a
+ macro rather than a function.
+
@@ -161,7 +171,7 @@
LOCALLY-ENABLE-SQL-READER-SYNTAX
- MacroLOCALLY-ENABLE-SQL-READER-SYNTAX
+ LOCALLY-ENABLE-SQL-READER-SYNTAXGlobally enable square bracket reader syntax.Macro
@@ -225,6 +235,11 @@
The symbolic SQL syntax is disabled by default.
+
+ &clsql; differs from &commonsql; in that
+ locally-enable-sql-reader-syntax is
+ defined as a macro rather than a function.
+
@@ -234,7 +249,7 @@
LOCALLY-DISABLE-SQL-READER-SYNTAX
- MacroLOCALLY-DISABLE-SQL-READER-SYNTAX
+ LOCALLY-DISABLE-SQL-READER-SYNTAXLocally disable square bracket reader syntax.Macro
@@ -302,6 +317,11 @@
The symbolic SQL syntax is disabled by default.
+
+ &clsql; differs from &commonsql; in that
+ locally-disable-sql-reader-syntax is
+ defined as a macro rather than a function.
+
@@ -310,7 +330,7 @@
RESTORE-SQL-READER-SYNTAX-STATE
- MacroRESTORE-SQL-READER-SYNTAX-STATE
+ RESTORE-SQL-READER-SYNTAX-STATE
Restore square bracket reader syntax to its previous state.
@@ -381,6 +401,11 @@
The symbolic SQL syntax is disabled by default.
+
+ &clsql; differs from &commonsql; in that
+ restore-sql-reader-syntax-state is
+ defined as a macro rather than a function.
+
@@ -389,7 +414,7 @@
SQL
- FunctionSQL
+ SQLConstruct an SQL string from supplied expressions.Function
@@ -488,7 +513,7 @@
SQL-EXPRESSION
- FunctionSQL-EXPRESSION
+ SQL-EXPRESSIONConstructs an SQL expression from supplied keyword arguments.Function
@@ -646,14 +671,14 @@
SQL-OPERATION
- FunctionSQL-OPERATION
+ SQL-OPERATIONConstructs an SQL expression from a supplied operator and arguments.FunctionSyntax
- sql-operationoperation&restargs => result
+ sql-operationoperator&restargs => resultsql-operation 'function func&restargs => result
@@ -661,7 +686,7 @@
Arguments and Values
- operation
+ operatorA symbol denoting an SQL operator.
@@ -689,9 +714,9 @@
DescriptionReturns an SQL expression constructed from the supplied
- SQL operator or function operation and
+ SQL operator or function operator and
its arguments args. If
- operation is passed the symbol 'function
+ operator is passed the symbol 'function
then the first value in args is taken to
be a valid SQL function and the remaining values in
args its arguments.
@@ -728,7 +753,7 @@
Exceptional SituationsAn error of type sql-user-error
- is signalled if operation is not a symbol
+ is signalled if operator is not a symbol
representing a supported SQL operator.
@@ -750,20 +775,20 @@
SQL-OPERATOR
- FunctionSQL-OPERATOR
+ SQL-OPERATORReturns the symbol for the supplied SQL operator.FunctionSyntax
- sql-operatoroperation => result
+ sql-operatoroperator => resultArguments and Values
- operation
+ operatorA symbol denoting an SQL operator.
@@ -779,9 +804,9 @@
Description
- Returns the Lisp symbol corresponding to the SQL operation
- represented by the symbol operation. If
- operation does not represent a supported
+ Returns the Lisp symbol corresponding to the SQL operator
+ represented by the symbol operator. If
+ operator does not represent a supported
SQL operator or is not a symbol, nil is returned.
@@ -816,117 +841,120 @@
Notes
- &clsql;'s symbolic SQL syntax currently has support for
- the following SQL operators:
+
+ &clsql;'s symbolic SQL syntax currently has support for the
+ following &commonsql; compatible SQL operators:
- any
- ,
- some
- ,
- all
- ,
- not
- ,
- union
- ,
- intersect
- ,
- minus
- ,
+ any
+ some
+ all
+ not
+ union
+ intersect
+ minusexcept
- ,
+
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.
+
+ The following operators are provided as &clsql; extensions to
+ the &commonsql; API.
+
- ,
concat
- ,
+
substring
- ,
+
limit
- ,
+
group-by
- ,
+
having
- ,
+
not-null
- ,
+
exists
- ,
+
uplike
- ,
+
is
- ,
+
==
- ,
+
the
- ,
+
coalesce
- ,
+
view-class
-
- as well as the pseudo-operator
- function. Note that some of these operators
- are not supported by all of the RDBMS supported by
- &clsql;.
+
+
+
+ Note that some of these operators are not supported by all of
+ the RDBMS supported by &clsql; (see the Appendix for details).
+