Darren Duncan > Muldis-DB-0.4.0 > Muldis::DB::Engine::Example

Download:
Muldis-DB-0.4.0.tar.gz

Dependencies

Annotate this POD

View/Report Bugs
Module Version: 0.004   Source  

NAME ^

Muldis::DB::Engine::Example - Self-contained reference implementation of a Muldis DB Engine

VERSION ^

This document describes Muldis::DB::Engine::Example version 0.4.0 for Perl 5.

It also describes the same-number versions for Perl 5 of Muldis::DB::Engine::Example::Public::DBMS, Muldis::DB::Engine::Example::Public::Var, Muldis::DB::Engine::Example::Public::FuncBinding, and Muldis::DB::Engine::Example::Public::ProcBinding.

SYNOPSIS ^

This documentation is pending.

DESCRIPTION ^

Muldis::DB::Engine::Example, aka the Muldis DB Example Engine, aka Example, is the self-contained and pure-Perl reference implementation of Muldis DB. It is included in the Muldis DB core distribution to allow the core to be completely testable on its own.

Example is coded intentionally in a simple fashion so that it is easy to maintain and and easy for developers to study. As a result, while it performs correctly and reliably, it also performs quite slowly; you should only use Example for testing, development, and study; you should not use it in production. (See the Muldis::DB::SeeAlso file for a list of other Engines that are more suitable for production.)

This Muldis::DB::Engine::Example file is the main file of the Example Engine, and it is what applications quasi-directly invoke; its Muldis::DB::Engine::Example::Public::\w+ classes directly do/subclass the roles/classes in Muldis::DB::Interface. The other Muldis::DB::Engine::Example::\w+ files are used internally by this file, comprising the rest of the Example Engine, and are not intended to be used directly in user code.

This documentation is pending.

INTERFACE ^

This documentation is pending; this section may also be split into several.

DIAGNOSTICS ^

This documentation is pending.

CONFIGURATION AND ENVIRONMENT ^

This documentation is pending.

DEPENDENCIES ^

This file requires any version of Perl 5.x.y that is at least 5.8.1.

It also requires these Perl 5 classes that are in the current distribution: Muldis::DB::Interface-0.4.0.

It also requires these Perl 5 classes that are in the current distribution: Muldis::DB::Engine::Example::PhysType-0.4.0, Muldis::DB::Engine::Example::Operators-0.4.0.

INCOMPATIBILITIES ^

None reported.

SEE ALSO ^

Go to Muldis::DB for the majority of distribution-internal references, and Muldis::DB::SeeAlso for the majority of distribution-external references.

BUGS AND LIMITATIONS ^

This documentation is pending.

AUTHOR ^

Darren Duncan (perl@DarrenDuncan.net)

LICENSE AND COPYRIGHT ^

This file is part of the Muldis DB framework.

Muldis DB is Copyright © 2002-2007, Darren Duncan.

See the LICENSE AND COPYRIGHT of Muldis::DB for details.

ACKNOWLEDGEMENTS ^

The ACKNOWLEDGEMENTS in Muldis::DB apply to this file too.

syntax highlighting: