bps::installer::Installer Class Reference

The Installer class serves to install or update a BPS datastore. More...

Public Member Functions
	Installer (Datastore aDatastore)
	The constructor. More...
void	latestLevel ()
void	setup (String aSchema, Number aPin, String aTsData, String aTsIndex)
	Execute the basic setup for a new datastore. More...
void	setVerbose (Number aVerbosity)
	Set amount of information to log. More...
void	update (Number aMaxLevel)
	Update an existing datastore to the latest level. More...
Number	verbose ()

Detailed Description

The Installer class serves to install or update a BPS datastore.

It will normally be called by the scripts createdb.js and updatedb.js.

Constructor & Destructor Documentation

Installer()

bps::installer::Installer::Installer

(

Datastore

aDatastore

)

The constructor.

Depending on the task to perform, the database connection needs to be made different:

When creating a new datastore with setup(), initial connection should be as DBA (Oracle) or Superuser (PostgreSQL). During setup() the datastore will reconnect as the BPS owner of the new datastore.

When updating the datastore with update(), the initial connection should be as BPS owner of the datastore.

Parameters

aDatastore

Datastore object in connected state.

Member Function Documentation

latestLevel()

void bps::installer::Installer::latestLevel

(

)

Returns

The latest database level.

setup()

void bps::installer::Installer::setup	(	String	aSchema,
		Number	aPin,
		String	aTsData,
		String	aTsIndex
	)

Execute the basic setup for a new datastore.

Parameters

aSchema	Name of the new schema and BPS owner.
aPin	PIN of the new BPS owner.
aTsData	Tablespace name to store data.
aTsIndex	Tablespace name to store indexes. May be the same as aTsData.

setVerbose()

void bps::installer::Installer::setVerbose

(

Number

aVerbosity

)

Set amount of information to log.

Parameters

aVerbosity

0=No loggin, 1=Actions only, 2=Actions and SQL statements.

update()

void bps::installer::Installer::update

(

Number

aMaxLevel

)

Update an existing datastore to the latest level.

Parameters

aMaxLevel

The maximum level to update to.

See also

latestLevel()

verbose()

Number bps::installer::Installer::verbose

(

)

Returns

Amount of information to log.

---

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

• bps.installer.js