DBCapsulator Class Reference

Inheritance diagram for DBCapsulator:

List of all members.

Public Member Functions
Public Object Methods
retval	dbcfg (scalar dbcfg)
retval	search (scalar filter)
retval	getnext ()
retval	add (scalar record)
retval	delete (scalar record)
retval	update (scalar record)
hash	getnext_locallysorted (SearchFilter filter)
	Returns the next record from a search.
void	clear_sortcache (scalar size)
	Clears and setup the cache used by getnext_locallysorted().
retval	schema (scalar name)
Public Functions
retval	config (scalar cfg)
retval	schemadir (scalar dir)
retval	error (scalar msg)
retval	database (scalar this, scalar db)
retval	connect (scalar this, scalar dbcfg)
retval	close ()
Classes
class	DBI
class	DBI_CSV
class	Null
class	SearchFilter
	Search Filter encapsulation. More...

---

Member Function Documentation

retval DBCapsulator::add (  scalar  record  )

Reimplemented in DBCapsulator::DBI, and DBCapsulator::Null.

void DBCapsulator::clear_sortcache (  scalar  size  )

Clears and setup the cache used by getnext_locallysorted(). It is good style to clear the cache before you first use getnext_locallysorted() on a started search. Parameters: size  The size of the sort cache. See also: getnext_locallysorted

retval DBCapsulator::close (   )

Reimplemented in DBCapsulator::DBI, and DBCapsulator::Null.

retval DBCapsulator::config (  scalar  cfg  )

retval DBCapsulator::connect (  scalar  this, scalar  dbcfg )

Reimplemented in DBCapsulator::DBI.

retval DBCapsulator::database (  scalar  this, scalar  db )

retval DBCapsulator::dbcfg (  scalar  dbcfg  )

retval DBCapsulator::delete (  scalar  record  )

Reimplemented in DBCapsulator::DBI, and DBCapsulator::Null.

retval DBCapsulator::error (  scalar  msg  )

retval DBCapsulator::getnext (   )

Reimplemented in DBCapsulator::DBI, and DBCapsulator::Null.

hash DBCapsulator::getnext_locallysorted (  SearchFilter  filter  )

Returns the next record from a search. However, records are first read into a local cache of the given size, then sorted within this cache and retrieved only after that. Records that are out of order after this local sort are silently dropped. Parameters: filter  the filter (only the order set in the filter is obeyed) Returns: the next record See also: clear_sortcache() Todo: implement this :-)

retval DBCapsulator::schema (  scalar  name  )

retval DBCapsulator::schemadir (  scalar  dir  )

retval DBCapsulator::search (  scalar  filter  )

Reimplemented in DBCapsulator::DBI, DBCapsulator::DBI, and DBCapsulator::Null.

retval DBCapsulator::update (  scalar  record  )

Reimplemented in DBCapsulator::DBI, and DBCapsulator::Null.

---

The documentation for this class was generated from the following file:

• modules/dbstore/bin/DBCapsulator.pm

---