Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help 
Oryx::DBI(3)	      User Contributed Perl Documentation	  Oryx::DBI(3)

NAME
       Oryx::DBI - DBI Storage interface for Oryx

SYNOPSIS
	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
       DBI Storage interface for Oryx. You should not need to instantiate this
       directly, use "Oryx->connect()" instead.

METHODS
       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
       Oryx, Oryx::Class, Oryx::DBI::Util

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

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

POD ERRORS
       Hey! The	above document had some	coding errors, which are explained
       below:

       Around line 271:
	   You forgot a	'=back'	before '=head1'

perl v5.32.1			  2006-06-16			  Oryx::DBI(3)
NAME | SYNOPSIS | DESCRIPTION | METHODS | SEE ALSO | AUTHOR | LICENSE | POD ERRORS

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=Oryx::DBI&sektion=3&manpath=FreeBSD+13.0-RELEASE+and+Ports>

home | help