/ 
BioPerl-DB-1.006900
River stage zero No dependents
/ Bio::DB::BioSQL::Oracle::BasePersistenceAdaptorDriver

NAME

Bio::DB::BioSQL::Oracle::BasePersistenceAdaptorDriver - DESCRIPTION of Object

SYNOPSIS

Give standard usage here

DESCRIPTION

Describe the object here

FEEDBACK

Mailing Lists

User feedback is an integral part of the evolution of this and other Bioperl modules. Send your comments and suggestions preferably to the Bioperl mailing list. Your participation is much appreciated.

bioperl-l@bioperl.org                  - General discussion
http://bioperl.org/wiki/Mailing_lists  - About the mailing lists

Support

Please direct usage questions or support issues to the mailing list:

bioperl-l@bioperl.org

rather than to the module maintainer directly. Many experienced and reponsive experts will be able look at the problem and quickly address it. Please include a thorough description of the problem with code and data examples if at all possible.

Reporting Bugs

Report bugs to the Bioperl bug tracking system to help us keep track of the bugs and their resolution. Bug reports can be submitted via email or the web:

bioperl-bugs@bioperl.org
http://redmine.open-bio.org/projects/bioperl/

AUTHOR - Hilmar Lapp

Email hlapp at gmx.net

CONTRIBUTORS

Additional contributors names and emails here

APPENDIX

The rest of the documentation details each of the object methods. Internal methods are usually preceded with a _

new

Title   : new
Usage   : my $obj = Bio::DB::BioSQL::Oracle::BasePersistenceAdaptorDriver->new();
Function: Builds a new Bio::DB::BioSQL::Oracle::BasePersistenceAdaptorDriver object 
Returns : an instance of Bio::DB::BioSQL::Oracle::BasePersistenceAdaptorDriver
Args    :

primary_key_name

Title   : primary_key_name
Usage   :
Function: Obtain the name of the primary key attribute for the given
          table in the relational schema.

          For the oracle implementation, this is always oid (with two
          exceptions that have a virtual primary key).

Example :
Returns : The name of the primary key (a string)
Args    : The name of the table (a string)

_build_foreign_key_name

Title   : _build_foreign_key_name
Usage   :
Function: Build the column name for a foreign key to the given table.

          We override this here to obtain the acronym for the table
          and then append '_oid' to it. Other than that we reuse how
          the default foreign_key_name() determines the table name.

Example :
Returns : The name of the foreign key column as a string
Args    : The table name as a string

sequence_name

Title   : sequence_name
Usage   :
Function: Returns the name of the primary key generator (SQL sequence)
          for the given table.

Example :
Returns : the name of the sequence (a string)
Args    : The name of the table.

acronym_map

Title   : acronym_map
Usage   : $obj->acronym_map($newval)
Function: Get/set the map of table names to acronyms (which the oracle
          build consistently uses across the panel).
Example : 
Returns : value of acronym_map (a hash ref)
Args    : on set, new value (a hash ref or undef, optional)