Sleepycat::DbXml.3pm

Langue: en

Version: 2008-10-21 (fedora - 05/07/09)

Section: 3 (Bibliothèques de fonctions)

NAME

Sleepycat::DbXml - A Perl interface to the Sleepycat DbXml library

SYNOPSIS

     use Sleepycat::DbXml;
 
     eval {
         my $mgr = new XmlManager();
 
         ...
     };
     if (my $e = catch XmlException)
     {
     }
 
 

DESCRIPTION

This module provides a Perl interface to the Sleepycat library, DbXml. The majority of the DbXml C++ interface is available via this Perl module and in general the Perl interface closely mirrors the underlying C++ API. Wherever the Perl interface differs from the C++ interface, it will be clearly noted in the documentation. Notable exceptions are:
1.
The following parts of the Sleepycat DbXml API are not supported at present by this module:
     XmlResolver
 
 
2.
Use of Dbt and XmlData objects is not needed, so they are not supported. Anywhere in the C++ API where a Dbt of an XmlData object is required, the Perl user can use a plain-vanilla Perl scalar.
3.
Anwhere where a DbXml method expects an XmlValue as a parameter, it is possible to use either an XmlValue object or a simple Perl Scalar. When a Perl scalar is used an XmlValue of type STRING will be created behind the scenes.
4.
Whenever the C++ API uses a std::string, the Perl interface uses a scalar.
5.
A number of the DbXml methods take a XmlTransaction object as their first parameter. To make life easier for users who aren't using transactions, this first parameter can be made optional. This is done
     use Sleepycat::DbXml 'simple';
 
 

Note that this doesn't outlaw the use of the XmlTransaction parameters, it just makes their use optional.

6.
The C++ interface makes heavy use of exceptions to report errors back to the user code. This module uses the Perl equivalent.

That means that a typical

     eval
     {
         
     };
     if (my $e = catch XmlException)
     {
     }
 
 

The documentation for each of the individual classes in DbXml are each stored in individual files.

XmlValue
XmlContainer

NOTES

EXAMPLES

The example below ...

SEE ALSO

The Sleepycat site, http://www.sleepycat.com

AUTHOR

Paul Marquess

POD ERRORS

Hey! The above document had some coding errors, which are explained below:
Around line 49:
You have '=item 3' instead of the expected '=item 4'
Around line 53:
You have '=item 4' instead of the expected '=item 5'
Around line 65:
You have '=item 5' instead of the expected '=item 6'