Location of a persisted Persistable instance in a database. More...

#include <DbStorageLocation.h>

Inheritance diagram for lsst::daf::persistence::DbStorageLocation:

Public Types
typedef boost::shared_ptr < DbStorageLocation >	Ptr

Public Types inherited from lsst::daf::base::Citizen
enum	{ magicSentinel = 0xdeadbeef }

typedef unsigned long	memId
	Type of the block's ID. More...

typedef memId(*	memNewCallback )(const memId cid)
	A function used to register a callback. More...

typedef memId(*	memCallback )(const Citizen *ptr)

Public Member Functions
	DbStorageLocation (void)

	DbStorageLocation (std::string const &url)

virtual	~DbStorageLocation (void)

virtual std::string	toString (void) const

virtual std::string	getConnString (void) const

virtual std::string const &	getDbType (void) const

virtual std::string const &	getHostname (void) const

virtual std::string const &	getPort (void) const

virtual std::string const &	getUsername (void) const

virtual std::string const &	getPassword (void) const

virtual std::string const &	getDbName (void) const

Public Member Functions inherited from lsst::daf::base::Citizen
	Citizen (const std::type_info &)

	Citizen (Citizen const &)

	~Citizen ()

Citizen &	operator= (Citizen const &)

std::string	repr () const
	Return a string representation of a Citizen. More...

void	markPersistent (void)
	Mark a Citizen as persistent and not destroyed until process end. More...

memId	getId () const
	Return the Citizen's ID. More...

Private Attributes
std::string	_dbType
	Database type (e.g. "mysql"). More...

std::string	_hostname

std::string	_port

std::string	_username

std::string	_password

std::string	_dbName
	Database (not server) name. More...

Additional Inherited Members
Static Public Member Functions inherited from lsst::daf::base::Citizen
static bool	hasBeenCorrupted ()
	Check all allocated blocks for corruption. More...

static memId	getNextMemId ()
	Return the memId of the next object to be allocated. More...

static int	init ()
	Called once when the memory system is being initialised. More...

static int	census (int, memId startingMemId=0)
	How many active Citizens are there? More...

static void	census (std::ostream &stream, memId startingMemId=0)
	Print a list of all active Citizens to stream, sorted by ID. More...

static const std::vector < const Citizen * > *	census ()
	Return a (newly allocated) std::vector of active Citizens sorted by ID. More...

static memId	setNewCallbackId (memId id)
	Call the NewCallback when block is allocated. More...

static memId	setDeleteCallbackId (memId id)
	Call the current DeleteCallback when block is deleted. More...

static memNewCallback	setNewCallback (memNewCallback func)
	Set the NewCallback function. More...

static memCallback	setDeleteCallback (memCallback func)
	Set the DeleteCallback function. More...

static memCallback	setCorruptionCallback (memCallback func)
	Set the CorruptionCallback function. More...

Detailed Description

Location of a persisted Persistable instance in a database.

Provides database connection information for DbStorage. Can be initialized with either an all-in-one URL containing username and password information or a CORAL-style connection string URL with separate username and password.

Definition at line 58 of file DbStorageLocation.h.

Member Typedef Documentation

typedef boost::shared_ptr<DbStorageLocation> lsst::daf::persistence::DbStorageLocation::Ptr

Definition at line 60 of file DbStorageLocation.h.

Constructor & Destructor Documentation

lsst::daf::persistence::DbStorageLocation::DbStorageLocation ( void )

Default constructor.

Definition at line 55 of file DbStorageLocation.cc.

                                          :
     lsst::daf::base::Citizen(typeid(*this)),
     _dbType(), _hostname(), _port(), _username(), _password(), _dbName() {
 }

lsst::daf::persistence::DbStorageLocation::DbStorageLocation ( std::string const & url )

Constructor from CORAL-style URL.

Parameters

[in] url CORAL-style connection string (database type, hostname, port, database name)

Definition at line 64 of file DbStorageLocation.cc.

                                                          :
     lsst::daf::base::Citizen(typeid(*this)) {
     boost::smatch what;
     boost::regex
         expression("(\\w+)://(\\S+):(\\d+)/(\\S+)");
     if (boost::regex_match(url, what, expression)) {
         _dbType = what[1];
         _hostname = what[2];
         _port = what[3];
         _dbName = what[4];
         _username = DbAuth::username(_hostname, _port);
         _password = DbAuth::password(_hostname, _port);
     }
     else {
         throw LSST_EXCEPT(lsst::pex::exceptions::InvalidParameterError,
             "Unparseable connection string passed to DbStorageLocation: " +
             url);
     }
 }

lsst::daf::persistence::DbStorageLocation::~DbStorageLocation ( void )

virtual

Destructor.

Definition at line 86 of file DbStorageLocation.cc.

86 {

87 }

Member Function Documentation

std::string lsst::daf::persistence::DbStorageLocation::getConnString ( void ) const

virtual

Produce a CORAL-style connection string representation of the DbStorageLocation.

Returns: String suitable for passing to CORAL functions

Definition at line 101 of file DbStorageLocation.cc.

                                                      {
     return _dbType + "://" + _hostname + ":" + _port + "/" + _dbName;
 }

std::string const & lsst::daf::persistence::DbStorageLocation::getDbName ( void ) const

virtual

Accessor for database name.

Returns: Reference to database name string.

Definition at line 143 of file DbStorageLocation.cc.

                                                         {
     return _dbName;
 }

std::string const & lsst::daf::persistence::DbStorageLocation::getDbType ( void ) const

virtual

Accessor for database type.

Returns: Reference to database type string.

Definition at line 108 of file DbStorageLocation.cc.

                                                         {
     return _dbType;
 }

std::string const & lsst::daf::persistence::DbStorageLocation::getHostname ( void ) const

virtual

Accessor for database hostname.

Returns: Reference to database hostname string.

Definition at line 115 of file DbStorageLocation.cc.

                                                           {
     return _hostname;
 }

std::string const & lsst::daf::persistence::DbStorageLocation::getPassword ( void ) const

virtual

Accessor for password.

Returns: Reference to password string.

Definition at line 136 of file DbStorageLocation.cc.

                                                           {
     return _password;
 }

std::string const & lsst::daf::persistence::DbStorageLocation::getPort ( void ) const

virtual

Accessor for database port number.

Returns: Reference to database port number string.

Definition at line 122 of file DbStorageLocation.cc.

                                                       {
     return _port;
 }

std::string const & lsst::daf::persistence::DbStorageLocation::getUsername ( void ) const

virtual

Accessor for username.

Returns: Reference to username string.

Definition at line 129 of file DbStorageLocation.cc.

                                                           {
     return _username;
 }

std::string lsst::daf::persistence::DbStorageLocation::toString ( void ) const

virtual

Produce a string (URL) representation of the DbStorageLocation.

Returns: String suitable for constructing another DbStorageLocation

Definition at line 92 of file DbStorageLocation.cc.

                                                 {
     return _dbType + "://" + _username + ":" + _password + "@" +
         _hostname + ":" + _port + "/" + _dbName;
 }

Member Data Documentation

std::string lsst::daf::persistence::DbStorageLocation::_dbName

private

Database (not server) name.

Definition at line 81 of file DbStorageLocation.h.

std::string lsst::daf::persistence::DbStorageLocation::_dbType

private

Database type (e.g. "mysql").

Definition at line 76 of file DbStorageLocation.h.

std::string lsst::daf::persistence::DbStorageLocation::_hostname

private

Definition at line 77 of file DbStorageLocation.h.

std::string lsst::daf::persistence::DbStorageLocation::_password

private

Definition at line 80 of file DbStorageLocation.h.

std::string lsst::daf::persistence::DbStorageLocation::_port

private

Definition at line 78 of file DbStorageLocation.h.

std::string lsst::daf::persistence::DbStorageLocation::_username

private

Definition at line 79 of file DbStorageLocation.h.

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

/home/lsstsw/stack/Linux64/daf_persistence/11.0-1-g7418c06/include/lsst/daf/persistence/DbStorageLocation.h
/home/lsstsw/stack/Linux64/daf_persistence/11.0-1-g7418c06/src/DbStorageLocation.cc

Public Types

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation