Oryx::DBI - DBI Storage interface for Oryx


Oryx documentation  | view source Contained in the Oryx distribution.

Index


NAME

Top

Oryx::DBI - DBI Storage interface for Oryx

SYNOPSIS

Top

 my $storage = Oryx::DBI->new;

 $storage->connect([ 'dbi:Pg:dbname=mydb', $usname, $passwd]);
 $storage->connect([ 'dbi:Pg:dbname=mydb', $usname, $passwd], $schema);

 $storage->dbh;
 $storage->db_name;
 $storage->ping;
 $storage->schema;
 $storage->util;
 $storage->set_util;
 $storage->deploy_class;
 $storage->deploy_schema;

DESCRIPTION

Top

DBI Storage interface for Oryx. You should not need to instantiate this directly, use Oryx->connect() instead.

METHODS

Top

new

Simple constructor

connect( \@conn, [$schema] )

Called by Oryx->connect(). You shouldn't need to be doing this.

dbh

returns the cached DBI handle object

db_name

Shortcut for "db_".$self->schema->name used for passing a name to Ima::DBI's set_db method.

ping

ping the database

schema

returns the schema if called with no arguments, otherwise sets if called with a Oryx::Schema instance.

util

simple mutator for accessing the oryx::dbi::util::x instance

set_util

determines which Oryx::DBI::Util class to instantiate by looking at the dsn passed to connect and sets it

deploy_schema( $schema )

Takes a Oryx::Schema instance and deploys all classes seen by that schema instance to the database building all tables needed for storing your persistent objects.

deploy_class( $class )

does the work of deploying a given class' tables and link tables to the database; called by deploy_schema

SEE ALSO

Top

Oryx, Oryx::Class, Oryx::DBI::Util

AUTHOR

Top

Copyright (C) 2005 Richard Hundt <richard NO SPAM AT protea-systems.com>

LICENSE

Top

This library is free software and may be used under the same terms as Perl itself.


Oryx documentation  | view source Contained in the Oryx distribution.