internal package Foswiki::PageCache::DBI

See PublishedAPI for packages intended to be used by Plugin and Contrib authors, or browse all packages.
See also Developing plugins, Developer's Bible, Technical Overview

Perl Module:

Child packagesChild packages

• Foswiki::PageCache::DBI::Generic - Generic DBI backend. Use this one when there's no implementation specificly tailord towards your database.
• Foswiki::PageCache::DBI::MySQL - Implements a Foswiki::PageCache::DBI using mysql
• Foswiki::PageCache::DBI::PostgreSQL - Implements a Foswiki::PageCache::DBI using postgresql
• Foswiki::PageCache::DBI::SQLite - Implements a Foswiki::PageCache::DBI using sqlite

internal package Foswiki::PageCache::DBI

Implements a Foswiki::PageCache using a DBI compatible backend.

ClassMethod new( ) → $object

Construct a new page cache and makes sure the database is ready

ObjectMethod init()

Initializes and connects to the database

ObjectMethod setPageVariation($web, $topici, $variationKey, $variation)

stores a page and its meta data

ObjectMethod getPageVariation($web, $topic, $variationKey)

retrievs a cache entry; returns undef if there is none.

ObjectMethod deleteAll()

drops all data and rebuilts the database

ObjectMethod deletePage($web, $topic, $variation)

See Foswiki::PageCache::deletePage() for more information.

ObjectMethod deleteDependencies($web, $topic, $variation)

Remove a dependency from the graph

ObjectMethod setDependencies($web, $topic, $variation, @topics)

See Foswiki::PageCache::setDependencies() for more information

ObjectMethod getDependencies($web, $topic, $variation)

Returns the list of topics being used to render the given web.topic. This method is mainly used for testing and debugging purposes.

ObjectMethod fireDependency($web, $topic)

Deletes all cache entries that point here.

See Foswiki::PageCache::fireDependency() for more.

ObjectMethod connect()

connects to the database

ObjectMethod createTables()

creates the database tables if not existing yet

ObjectMethod _rebuild()

drops all tables and creates new ones.

ObjectMethod finish()

cleans up the mess we left behind