alzabo::config(3pm) [debian man page]

Alzabo::Config(3pm)					User Contributed Perl Documentation				       Alzabo::Config(3pm)

NAME

       Alzabo::Config - Alzabo configuration information

SYNOPSIS

	 use Alzabo::Config

	 print Alzabo::Config::schema_dir;

DESCRIPTION

       This module contains functions related to Alzabo configuration information.

FUNCTIONS

       root_dir ($root)

       If a value is passed to this method then the root is temporarily changed.  This change lasts as long as your application remains in memory.
       However, since changes are not written to disk it will have to be changed again.

       Returns the root directory for your Alzabo installation.

       schema_dir

       If no root_dir is defined, this function throws an exception.

       Returns the directory under which Alzabo schema objects are stored in serialized form.

       available_schemas

       If no root_dir is defined, this function throws an exception.

       Returns a list containing the names of the available schemas.  There will be one directory for each schema under the directory returned.
       Directories which cannot be read will not be included in the list.

       Throws: "Alzabo::Exception::System"

perl v5.8.8							    2007-12-23						       Alzabo::Config(3pm)

Alzabo::Schema(3pm)					User Contributed Perl Documentation				       Alzabo::Schema(3pm)

NAME

       Alzabo::Schema - Schema objects

SYNOPSIS

	 use base qw(Alzabo::Schema);

DESCRIPTION

       This is the base class for schema objects..

METHODS

       name

       Returns a string containing the name of the schema.

       table ($name)

       Returns an "Alzabo::Table" object representing the specified table.

       An "Alzabo::Exception::Params" exception is throws if the schema does not contain the table.

       tables (@optional_list)

       If no arguments are given, this method returns a list of all "Alzabo::Table" objects in the schema, or in a scalar context the number of
       such tables.  If one or more arguments are given, returns a list of table objects with those names, in the same order given (or the number
       of such tables in a scalar context, but this isn't terribly useful).

       An "Alzabo::Exception::Params" exception is throws if the schema does not contain one or more of the specified tables.

       has_table ($name)

       Returns a boolean value indicating whether the table exists in the schema.

       begin_work

       Starts a transaction.  Calls to this function may be nested and it will be handled properly.

       rollback

       Rollback a transaction.

       commit

       Finishes a transaction with a commit.  If you make multiple calls to "begin_work()", make sure to call this method the same number of
       times.

       run_in_transaction ( sub { code... } )

       This method takes a subroutine reference and wraps it in a transaction.

       It will preserve the context of the caller and returns whatever the wrapped code would have returned.

       driver

       Returns the "Alzabo::Driver" object for the schema.

       rules

       Returns the "Alzabo::RDBMSRules" object for the schema.

       sqlmaker

       Returns the "Alzabo::SQLMaker" object for the schema.

AUTHOR

       Dave Rolsky, <autarch@urth.org>

perl v5.8.8							    2007-12-23						       Alzabo::Schema(3pm)