Difference: DBCacheContrib (1 vs. 4)

Revision 4
30 Oct 2013 - Main.AdminUser
Line: 1 to 1
 

DBCacheContrib

Reusable code that caches Foswiki topics, and provides fast
Revision 3
30 Oct 2013 - Main.AdminUser
Line: 1 to 1
 

DBCacheContrib

Reusable code that caches Foswiki topics, and provides fast
Revision 2
30 Oct 2013 - Main.AdminUser
Line: 1 to 1
 

DBCacheContrib

Reusable code that caches Foswiki topics, and provides fast
Line: 42 to 42
  by reading the metadata from the topic (see MetaData)
  • name - name of the topic
  • parent - name of parent topic
Changed:
<
<
  • _up - reference to the Map of the parent topic, if it exists
  • attachments - array of Maps, each of which contains:
    • _up - reference to the Map for the topic
>
>
  • attachments - array of maps, each of which contains:
 
    • name - attachment name
    • attr - e.g hidden
    • comment - attachment comment
Line: 52 to 50
 
    • size - size in Kb
    • user - who uploaded the attachment
    • version - e.g. 1.3
Changed:
<
<
  • info - Map containing:
    • _up - reference to the Map for the topic
>
>
  • info - map containing:
 
    • author - most recent author
    • date - date of last change
    • format - topic format version
    • version - topic version number
Changed:
<
<
  • moved - Map containing:
    • _up - reference to the Map for the topic
>
>
  • moved - map containing:
 
    • by - who moved it
    • date - when they moved it
    • from - where they moved it from
    • to - where they moved it to
Added:
>
>
  • preferences - array of maps, each of which contains:
    • name - preference name
    • type - either Set or Local
    • value - the value of the named preference
 
  • form - form type
  • form name - e.g. if a "MyForm" is attached, this will be
Changed:
<
<
MyForm. This is a reference to a Map containing a key for each
>
>
MyForm. This is a reference to a map containing a key for each
  field in the form. Each key maps to the value in the form data for
Changed:
<
<
that key. The Map will also have an _up reference to the Map for the topic.
>
>
that key.
 
  • text - raw text of the topic)
Deleted:
<
<
The sub-maps created for info, form name, moved, and each row in attachments also have a reference back to the topic Map, called _up.
  Other fields may be added by subclasses. Refer to the documentation for the plugin that is using the DBCache for more details.
Line: 112 to 108
  To achieve best perfomance the plugin caches the data read from topics in a database. The database is stored in the work area for the DBCacheContrib (see {WorkAreaDir} in configure). If any topic changes in the web, this
Changed:
<
<
cache is automatically rebuilt (subject to configuration options). The cache can be deleted at any point with no ill effects.
>
>
cache is automatically updated.
 

Detailed Documentation

Clients use the DBCache by defining a subclass of the
Line: 132 to 127
 

Contrib Info

Changed:
<
<
Author: Foswiki:Main/CrawfordCurrie http://c-dot.co.uk
Copyright ©: This code is based on an original development of Motorola Inc. and is protected by the following copyrights:
Copyright @copy 2002-2003 Motorola Inc. All Rights Reserved.
Portions copyright © 2004. Crawford Currie http://www.c-dot.co.uk
>
>
Author: Foswiki:Main/CrawfordCurrie http://c-dot.co.uk, Foswiki:Main/MichaelDaum http://michaeldaumconsulting.com
Copyright ©: This code is based on an original development of Motorola Inc. and is protected by the following copyrights:
Copyright @copy 2002-2003 Motorola Inc. All Rights Reserved.
Portions copyright © 2004 Crawford Currie http://www.c-dot.co.uk.
Portions copyright © 2013 Michael Daum http://michaeldaumconsulting.com
 
License: GPL
Changed:
<
<
Release: 17 Nov 2009
Version: 5538 (2009-11-17)
>
>
Release: 30 Jun 2013
Version: v3.0.0
 
Change History:  
Changed:
<
<
17 Nov 2009 Foswikitask:Item8327: series of robustness fixes (MD)
>
>
10 Jul 2013 Foswikitask:Item12542: cache non-standard %META data and make it searchable
28 Mar 2013 Foswikitask:Item12458: fix op_ref in search queries
14 Mar 2013 Foswikitask:Item12425: make preferences searchable by caching them into a map instead of an array
25 Jan 2013 Foswikitask:Item12369: fixed loading cache from disk on a change
07 Jan 2013 Foswikitask:Item8195: extract and cache preference settings; Foswikitask:Item12333: implement an archivist caching a web in segments;
01 Oct 2012 Foswiktask:Item11752: don't fail to build the cache for formfield names with dots in it
10 Jan 2012 Foswikitask:Item11406: remove redundant reference to archivist from all stored values
25 Aug 2011 Foswikitask:Item11070: working around odd defaults of normalizeWebTopicName
28 Mar 2011 Foswikitask:Item9375: disabling {AlwaysUpdateCache} by default and making an expert option with appropriate warnings
17 Nov 2009 Foswikitask:Item8327: series of robustness fixes (Foswiki:Main.MichaelDaum)
 
30 Jun 2009 Foswikitask:Item8153: make dirs for path to cache; Foswikitask:Item8194: incoporated patch from Foswiki:Main.MichaelDaum Foswikitask:Item8195: extract and cache permissions settings
18 Jun 2009 Foswikitask:Item8183: fixed problem with Scalar::Util::weaken that was causing DBCachePlugin problems
6 Jun 2009 Foswikitask:Item1691: changes to support Foswiki:Extensions.QueryAcceleratorPlugin
Line: 150 to 157
  the normal grep-based SEARCH does. Foswiki:Main.MichaelDaum |
15868 fixed WITHIN_DAYS and EARLIER_THAN. Foswiki:Main.MichaelDaum
15583 made query parser pluggable so that other plugins can implement their own predicates. Foswiki:Main.MichaelDaum
Changed:
<
<
15019 added {DBCache}{AlwaysUpdateCache} to remove the updateCache from every operation. Foswiki:Main.SvenDowideit
>
>
15019 added {DBCacheContrib}{AlwaysUpdateCache} to remove the updateCache from every operation. Foswiki:Main.SvenDowideit
 
13562 Bugs:Item3985 - fixed failures with hierarchical webs
13527 Moved the cache into the extensions work areas, instead of the web directory
12943 Bugs:Item3659: added automatic conversion of integers to dates
Line: 182 to 189
 
5005 Poddified documentation
5003 Initial version
8 Jul 2004 Initial version, split out from FormQueryPlugin
Changed:
<
<
Dependencies:
NameVersionDescription
Time::ParseDate>=2003.0211Required. Available from CPAN.
Storable>=2.07Required. available from CPAN
BerkeleyDB>=0Recommended for sites with many topics. Available from CPAN
Perl Version: 5.0
>
>
Dependencies:
NameVersionDescription
Time::ParseDate>=2003.0211Required.
Storable>=2.07Required.
BerkeleyDB>=0Optional, still experimental.
 
Home: http://foswiki.org/Extensions/DBCacheContrib
Support: http://foswiki.org/Support/DBCacheContrib
 
This site is powered by FoswikiCopyright © by the contributing authors. All material on this site is the property of the contributing authors.
Ideas, requests, problems regarding Foswiki? Send feedback