X-Git-Url: http://git.kpe.io/?a=blobdiff_plain;ds=inline;f=doc%2Fref-fdml.xml;h=5eb4f070052f9a113c11814b9b6df6c92b2cdf37;hb=fb67cd1a74d840b354f810d8e64e2184b3d459fa;hp=e86dd36219fd90043c2930893b0776ac45f5115b;hpb=5edc92aee527621ed13245b5b7892e40c2cd443f;p=clsql.git
diff --git a/doc/ref-fdml.xml b/doc/ref-fdml.xml
index e86dd36..5eb4f07 100644
--- a/doc/ref-fdml.xml
+++ b/doc/ref-fdml.xml
@@ -96,7 +96,128 @@
CACHE-TABLE-QUERIESControl the caching of table attribute types.
+ Function
+
+ Syntax
+
+ 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.
+
+
@@ -1012,7 +1133,7 @@ ID FORENAME SURNAME EMAIL
Syntax
- select &rest identifiers &key alldistinctfromgroup-byhavingorder-byset-operationwhereresult-typesfield-namesflatprefreshdatabase => result
+ select &rest identifiers &key alldistinctfromgroup-byhavingorder-byset-operationwhereresult-typesfield-namesflatprefreshcachingdatabase => resultArguments and Values
@@ -1159,6 +1280,35 @@ ID FORENAME SURNAME EMAIL
+
+ refresh
+
+
+ This value is only considered when CLOS objects are being
+ selected. A boolean with a default value of &nil;. When
+ the value of the caching keyword is
+ &t;, a second equivalent select call
+ will return the same view class instance objects. When
+ refresh is &t;, then slots of the
+ existing instances are updated as necessary. In such
+ cases, you may wish to override the hook
+ instance-refresh.
+
+
+
+
+ caching
+
+
+ This value is only considered when CLOS objects are being
+ selected. A boolean with a default value of
+ *default-caching*. &clsql; caches
+ objects in accordance with the &commonsql; interface: a
+ second equivalent select call will
+ return the same view class instance objects.
+
+
+ result
@@ -1320,10 +1470,8 @@ ID FORENAME SURNAME EMAIL
Side Effects
- Whatever effects the execution of the SQL query has on
the underlying database, if any.
- Affected by