X-Git-Url: http://git.kpe.io/?a=blobdiff_plain;ds=inline;f=doc%2Fref-fdml.xml;h=c4e4c338151472d002f1d5082f08a6d326c549f9;hb=3fccd56cc028be2aa6d535eba0f66fa1bf93ab6e;hp=ca725bdd492e25973f4169adadabcb56f9f57bd1;hpb=4413405fd38eaba7ba6d6d8b844fef118e326c9a;p=clsql.git
diff --git a/doc/ref-fdml.xml b/doc/ref-fdml.xml
index ca725bd..c4e4c33 100644
--- a/doc/ref-fdml.xml
+++ b/doc/ref-fdml.xml
@@ -96,10 +96,126 @@
CACHE-TABLE-QUERIESControl the caching of table attribute types.
+ FunctionSyntax
+
+ cache-table-queriestable &key actiondatabase =>
+
+
+ Arguments and Values
+
+
+ table
+
+
+ A string representing a database table, &t; or
+ :default.
+
+
+
+
+ action
+
+
+ &t;, &nil; or :flush.
+
+
+
+
+ database
+
+ A
+ database
+ object. This will default to the value
+ of *default-database*.
+
+
+
+
+
+ Description
+ Controls the caching of attribute type information on the
+ table specified by table in
+ database which defaults to
+ *default-database*. action
+ specifies the caching behaviour to adopt. If its value is &t;
+ then attribute type information is cached whereas if its value
+ is &nil; then attribute type information is not cached. If
+ action is :flush then
+ all existing type information in the cache for
+ table is removed, but caching is still
+ enabled. table may be a string
+ representing a table for which the caching action is to be taken
+ while the caching action is applied to all tables if
+ table is &t;. Alternatively, when
+ table is :default, the
+ default caching action specified by
+ *cache-table-queries-default* is applied to all
+ tables for which a caching action has not been explicitly set.
+
+
+
+ Examples
+
+(setf *cache-table-queries-default* t)
+=> T
+(create-table [foo]
+ '(([id] integer)
+ ([height] float)
+ ([name] (string 24))
+ ([comments] varchar)))
+=>
+(cache-table-queries "foo")
+=>
+(list-attribute-types "foo")
+=> (("id" :INT4 4 NIL 1) ("height" :FLOAT8 8 NIL 1) ("name" :BPCHAR 24 NIL 1)
+ ("comments" :VARCHAR 255 NIL 1))
+(drop-table "foo")
+=>
+(create-table [foo]
+ '(([id] integer)
+ ([height] float)
+ ([name] (string 36))
+ ([comments] (string 100))))
+=>
+(cache-table-queries "foo" :action :flush)
+=>
+(list-attribute-types "foo")
+=> (("id" :INT4 4 NIL 1) ("height" :FLOAT8 8 NIL 1) ("name" :BPCHAR 36 NIL 1)
+ ("comments" :BPCHAR 100 NIL 1))
+
+
+
+ Side Effects
+
+ The internal attribute cache for
+ database is modified.
+
+
+
+ Affected by
+
+ *cache-table-queries-default*
+
+
+
+ Exceptional Situations
+
+ None.
+
+
+
+ See Also
+
+ *cache-table-queries-default*
+
+
+
+ Notes
+ None.