X-Git-Url: http://git.kpe.io/?a=blobdiff_plain;ds=sidebyside;f=doc%2Fref-oodml.xml;h=8a3423557fed74a5162c78cc8cdbccd7db1d6d41;hb=91eb9f3d1335fed9ee9e4644eacca2b97db30836;hp=094db326e23ce83d2140144294fd81326f03b30f;hpb=d0695ffb828519fade3aa5166236812e6144975b;p=clsql.git
diff --git a/doc/ref-oodml.xml b/doc/ref-oodml.xml
index 094db32..8a34235 100644
--- a/doc/ref-oodml.xml
+++ b/doc/ref-oodml.xml
@@ -124,6 +124,57 @@
+
+
+ *DEFAULT-CACHING*
+ Controls the default caching behavior.
+ Variable
+
+
+ Value Type
+
+ Boolean
+
+
+
+ Initial Value
+ &t;
+
+
+ Description
+
+ This variable stores the default value of the
+ CACHING keyword for the select.
+
+
+
+ Examples
+
+ (let ((*default-caching* nil)))
+ (select 'foo))
+
+ ;; is equivalent to
+
+ (select 'foo :caching nil)
+
+
+
+ Affected By
+ None.
+
+
+ See Also
+
+ select
+
+
+
+ NotesThis is a CLSQL extension to the
+ &commonsql; API. &commonsql; has caching on at all times.
+
+
+
*DEFAULT-UPDATE-OBJECTS-MAX-LEN*
@@ -231,7 +282,7 @@
(slot-value (car *) 'email)
=> "lenin@soviet.org"
(select 'employee :where [= [slot-value 'employee 'emplid] 1] :flatp t :refresh t)
-Details for Vladamir Lenin have been updated from the database.
+Details for Vladimir Lenin have been updated from the database.
=> (#<EMPLOYEE {48149995}>)
(slot-value (car *) 'email)
=> "v.lenin@soviet.org"
@@ -921,9 +972,11 @@ Details for Vladamir Lenin have been updated from the database.
slots
-
- A list of slot names in object or &t;.
-
+ * :immediate (default) - refresh join slots with :retrieval :immediate
+ * :deferred - refresh join slots created with :retrieval :deferred
+ * :all,t - refresh all join slots regardless of :retrieval
+ * list of symbols - which explicit slots to refresh
+ * a single symobl - what slot to refresh
@@ -949,6 +1002,9 @@ Details for Vladamir Lenin have been updated from the database.
A non-negative integer or &nil; defaulting to
*default-update-objects-max-len*.
+ When non-nil this is essentially a batch size for the max number of objects
+ to query from the database at a time. If we need more than max-len
+ we loop till we have all the objects
@@ -956,25 +1012,15 @@ Details for Vladamir Lenin have been updated from the database.
Description
- Updates from the records of the appropriate database
- tables the join slots specified by slots
- in the supplied list of View
- Class instances
- objects. slots
- when &t; means that all join slots with
- :retrieval:immediate are
- updated. class-name is used to specify
- the View Class of
- all instance in objects, when &nil; then
- the class of the first instance in
- objects is
- used. force-p when &t; means that all
- join slots are updated whereas a value of &nil; means that only
- unbound join slots are updated. max-len
- when non-nil specifies that
- update-object-joins may issue multiple
- database queries with a maximum of
- max-len instances updated in each query.
+
+ Updates from the records of the appropriate database tables the join slots
+ specified by SLOTS in the supplied list of
+ View Class instances OBJECTS.
+
+ A simpler method of causing a join-slot to be requeried is to set it to
+ unbound, then request it again. This function has efficiency gains where
+ join-objects are shared among the `objects` (querying all join-objects,
+ then attaching them appropriately to each of the `objects`)