PersistenceManagerFAQ

Persistence Manager (PM) FAQ

What is a Persistence Manager (PM)?

The PM is an *internal* Jackrabbit component that handle the persistent storage of content nodes and properties. Each workspace of a Jackrabbit content repository uses a separate persistence manager to store the content in that workspace. Also the Jackrabbit version handler uses a separate persistence manager.

The persistence manager implementations to use are configured using the PersistenceManager configuration element within the Workspace configuration template (and the instantiated workspace configuration files) and the Versioning configuration element. The layout of a PersistenceManager configuration element is shown below. 

<PersistenceManager class="..."> 
    <param name="...">...</param>
    ...
</PersistenceManager>

The class attribute of the PersistenceManager element contains the fully qualified class name of the persistence manager implementation class. The class must implement the org.apache.jackrabbit.core.persistence.PersistenceManager interface and have an empty default constructor. String properties can be assigned using the param elements according to the JavaBean conventions.

See also [WWW] http://jackrabbit.apache.org/api/1.4/org/apache/jackrabbit/core/persistence/PersistenceManager.html

The PM sits at the very bottom layer in jackrabbits system architecture. Reliability, integrity and performance of the PM are *crucial* to the overall stability & performance of the repository. If e.g. the data that a PM is based upon is allowed to change through external means the integrity of the repository would be at risk (think of referential integrity / node references e.g.).

Which Persistence Manager is the fastest?

The bundle persistence managers are usually the fastest. Bundle persistence managers store each node together with all the properties as one unit. Large binary properties are stored to the BLOBStore by default (or DataStore if configured). Setting the minimum blob size for bundle persistence managers very high decreases the performance.

Storing the data in the file system does not require a database. Depending on the file system and database, database persistence managers are sometimes slower and sometimes faster than the BundleFsPersistenceManager. When using a database, please note that embedded Java databases do not have network overhead.

Consistency / Atomicy

The database persistence managers are atomic if the database is atomic.

The current file based persistence managers are not always atomic. They do support transactions in Jackrabbit, the exception is after a crash: When the process is stopped while a transaction is being written to disk (power failure, process killed, Runtime.halt() called, VM crash), some data of a transaction may be committed and some not. Theoretically, some nodes may be corrupt (depending how and when the system crashed). The algorithms used are minimizing this risk, for example the parent node is written last so in most cases there is no problem even after a crash.

What's the PM responsibility?

The PM interface was never intended as being a general SPI that you could implement in order to integrate external datasources with proprietary formats (e.g. a customers database). the reason why we abstracted the PM interface was to leave room for future performance optimizations that would not affect the rest of the implementation (e.g. by storing the raw data in a b-tree based database instead of individual file).

How smart should be a PM?

A PM should not be 'intelligent', it should not 'interpret' the data. The only thing it should care about is to efficiently, consistently and reliably store and read the data encapsulated in the passed nodeState & propertyState objects. Though it might be feasible to write a custom persistence manager to represent existing legacy data in a level-1 (read-only) repository, I don't think the same is possible for a level-2 repository and i certainly would not recommend it.

File System (FS)

Jackrabbit uses the org.apache.jackrabbit.core.fs.FileSystem interface as a file system abstraction. Although this interface does not cover all direct file system use of Jackrabbit, it still allows for flexibility in selecting where and how to store various parts of the repository. For example it might make sense to store the search indexes on a fast disk and the archived node versions on a slower disk. It is possible to configure separate file systems for the global repository state, workspaces, search indexes, and versioning.

What combination of FS and PM is the best choice?

It depends on your priorities. If you want to store your data in a RDBMS, use BundleDbPersistenceManager + either LocalFileSystem or DbFileSystem. If you want to store your data in an accessible format (just in case ;), you might want to try XMLPersistenceManager + LocalFileSystem.

Which are the current options? What are the status, pros and cons of each implementation?

Bundle Database PM

Bundle File-System PM

In-Memory PM

Simple Database PM

ObjectPersistenceManager

XMLPersistenceManager

ORMPersistenceManager

LocalFileSystem:

DbFileSystem:

last edited 2008-05-14 09:30:34 by stefan