X-Git-Url: http://git.kpe.io/?a=blobdiff_plain;f=doc%2Fref-syntax.xml;h=dd0dd0ef4f6d732328695eca2472ad5d72fdf060;hb=f9a851a5e3d042c618a991542baca8c0c5baffc8;hp=787b4a3b08b28d1c09672447ad171a28e7286984;hpb=4413405fd38eaba7ba6d6d8b844fef118e326c9a;p=clsql.git
diff --git a/doc/ref-syntax.xml b/doc/ref-syntax.xml
index 787b4a3..dd0dd0e 100644
--- a/doc/ref-syntax.xml
+++ b/doc/ref-syntax.xml
@@ -409,6 +409,80 @@
+
+
+ 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