PyPedal::pyp_db Namespace Reference


Functions

def connectToDatabase
def createPedigreeTable
def deleteTable
def populatePedigreeTable
def doesTableExist
def tableCountRows
def tableDropRows


Function Documentation

def PyPedal::pyp_db::connectToDatabase (   pedobj  ) 

connectToDatabase() opens a connection to a user-specified database.

Parameters:
pedobj A PyPedal pedigree object.
Returns:
An ADOdb connection on success, False otherwise. object
connectToDatabase() opens a connection to a user-specified database.

Definition at line 37 of file pyp_db.py.

def PyPedal::pyp_db::createPedigreeTable (   pedobj,
  conn = False,
  drop = False 
)

createPedigreeDatabase() creates a new pedigree table in adatabase.

Parameters:
pedobj A PyPedal pedigree object.
conn An existing ADOdb connection or False to create one
drop Boolean indicating if the data should be dropped from an existing table with the same name
Returns:
True on success, False otherwise. Boolean
createPedigreeTable() creates a new pedigree table in a database.

Definition at line 88 of file pyp_db.py.

def PyPedal::pyp_db::deleteTable (   pedobj,
  tablename = False,
  conn = False 
)

deleteTable() drops a table from a database

Parameters:
pedobj A PyPedal pedigree object.
tablename The name of the table to delete.
conn An existing ADOdb connection or False to create one
Returns:
True on success, False otherwise. Boolean
deleteTable() drops a table from a database

Definition at line 167 of file pyp_db.py.

def PyPedal::pyp_db::doesTableExist (   pedobj,
  tablename = False,
  conn = False 
)

doesTableExist() queries the database to determine whether or not a table exists.

Parameters:
pedobj A PyPedal pedigree object.
tablename The name of the table to delete.
conn An existing ADOdb connection or False to create one
Returns:
True on success, False otherwise. Boolean
doesTableExist() queries the database to determine whether or not a table exists.

Definition at line 264 of file pyp_db.py.

def PyPedal::pyp_db::populatePedigreeTable (   pedobj,
  conn = False 
)

populatePedigreeTable() takes a PyPedal pedigree object and loads the animal records in that pedigree into a database table.

Parameters:
pedobj A PyPedal pedigree object.
conn An existing ADOdb connection or False to create one
Returns:
True on success, False otherwise. Boolean
populatePedigreeTable() takes a PyPedal pedigree object and loads
the animal records in that pedigree into a database table.

Definition at line 206 of file pyp_db.py.

def PyPedal::pyp_db::tableCountRows (   pedobj,
  conn = False 
)

tableCountRows() returns the number of rows in a table.

Parameters:
pedobj A PyPedal pedigree object.
conn An existing ADOdb connection or False to create one
Returns:
An integer on success, 0 otherwise integer
tableCountRows() returns the number of rows in a table.

Definition at line 304 of file pyp_db.py.

def PyPedal::pyp_db::tableDropRows (   pedobj,
  tablename = False,
  conn = False 
)

tableDropRows() deletes the rows from an existing table

Parameters:
pedobj A PyPedal pedigree object.
tablename The name of the table to delete.
conn An existing ADOdb connection or False to create one
Returns:
True on success, False otherwise. Boolean
tableDropRows() deletes the rows from an existing table

Definition at line 345 of file pyp_db.py.


Generated on Fri Mar 28 14:34:59 2008 for PyPedal by  doxygen 1.5.3