Class for database storage. More...

#include <DbStorage.h>

Inheritance diagram for lsst::daf::persistence::DbStorage:

Public Types
typedef boost::shared_ptr < DbStorage >	Ptr

Public Types inherited from lsst::daf::persistence::Storage
typedef boost::shared_ptr < Storage >	Ptr

typedef std::vector< Ptr >	List

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
	DbStorage (void)

	~DbStorage (void)

virtual void	setPolicy (lsst::pex::policy::Policy::Ptr policy)

virtual void	setPersistLocation (LogicalLocation const &location)

virtual void	setRetrieveLocation (LogicalLocation const &location)

virtual void	startTransaction (void)

virtual void	endTransaction (void)

virtual void	createTableFromTemplate (std::string const &tableName, std::string const &templateName, bool mayAlreadyExist=false)

virtual void	dropTable (std::string const &tableName)

virtual void	truncateTable (std::string const &tableName)

virtual void	executeSql (std::string const &sqlStatement)

virtual void	setTableForInsert (std::string const &tableName)

template<typename T >
void	setColumn (std::string const &columnName, T const &value)

virtual void	setColumnToNull (std::string const &columnName)

virtual void	insertRow (void)

virtual void	setTableForQuery (std::string const &tableName, bool isExpr=false)

virtual void	setTableListForQuery (std::vector< std::string > const &tableNameList)

virtual void	outColumn (std::string const &columnName, bool isExpr=false)

template<typename T >
void	outParam (std::string const &columnName, T *location, bool isExpr=false)

template<typename T >
void	condParam (std::string const &paramName, T const &value)

virtual void	orderBy (std::string const &expression)

virtual void	groupBy (std::string const &expression)

virtual void	setQueryWhere (std::string const &whereClause)

virtual void	query (void)

virtual bool	next (void)

template<typename T >
T const &	getColumnByPos (int pos)

bool	columnIsNull (int pos)

virtual void	finishQuery (void)

Public Member Functions inherited from lsst::daf::persistence::Storage
virtual	~Storage (void)

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...

Protected Member Functions
	DbStorage (std::type_info const &type)

Protected Member Functions inherited from lsst::daf::persistence::Storage
	Storage (std::type_info const &type)

void	verifyPathName (std::string const &pathName)

Private Attributes
boost::scoped_ptr< DbStorageImpl >	_impl
	Implementation class for isolation. More...

Additional Inherited Members
Static Public Member Functions inherited from lsst::daf::persistence::Storage
static Ptr	createInstance (std::string const &name, LogicalLocation const &location, bool persist, lsst::pex::policy::Policy::Ptr policy)

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

Class for database storage.

Persists data to a database. Provides methods for writing rows to a table and retrieving rows from a query.

Definition at line 63 of file DbStorage.h.

Member Typedef Documentation

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

Definition at line 65 of file DbStorage.h.

Constructor & Destructor Documentation

lsst::daf::persistence::DbStorage::DbStorage ( void )

Constructor.

Definition at line 57 of file DbStorage.cc.

57 : Storage(typeid(*this)), _impl(new DbStorageImpl) {

58 }

lsst::daf::persistence::DbStorage::_impl

boost::scoped_ptr< DbStorageImpl > _impl

Implementation class for isolation.

Definition: DbStorage.h:113

lsst::daf::persistence::Storage::Storage

Storage(std::type_info const &type)

Definition: Storage.cc:60

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

Minimal destructor.

Definition at line 69 of file DbStorage.cc.

69 {

70 }

lsst::daf::persistence::DbStorage::DbStorage ( std::type_info const & type )

explicitprotected

Constructor with subclass type.

Parameters

[in] type typeid() of subclass

Definition at line 63 of file DbStorage.cc.

                                              :
     Storage(type), _impl(new DbStorageImpl) {
 }

Member Function Documentation

bool lsst::daf::persistence::DbStorage::columnIsNull ( int pos )

Determine if the value of a column is NULL.

Parameters

[in] pos Position of the column (starts at 0)

Definition at line 270 of file DbStorage.cc.

                                     {
     return _impl->columnIsNull(pos);
 }

template<typename T >

void lsst::daf::persistence::DbStorage::condParam	(	std::string const &	paramName,
		T const &	value
	)

Bind a value to a WHERE condition parameter.

Parameters

[in]	paramName	Name of the parameter (prefixed by ":" in the WHERE clause)
[in]	value	Value to be bound to the parameter.

Definition at line 218 of file DbStorage.cc.

                                                                     {
     _impl->condParam(paramName, value);
 }

void lsst::daf::persistence::DbStorage::createTableFromTemplate	(	std::string const &	tableName,
		std::string const &	templateName,
		bool	mayAlreadyExist = `false`
	)

virtual

Create a new table from an existing template table.

Parameters

[in]	tableName	Name of the new table
[in]	templateName	Name of the existing template table
[in]	mayAlreadyExist	False (default) if the table must not be present

Note: currently works with MySQL only.

Reimplemented in lsst::daf::persistence::DbTsvStorage.

Definition at line 112 of file DbStorage.cc.

                                                               {
     _impl->createTableFromTemplate(tableName, templateName, mayAlreadyExist);
 }

void lsst::daf::persistence::DbStorage::dropTable ( std::string const & tableName )

virtual

Drop a table.

Parameters

[in] tableName Name of the table to drop

Reimplemented in lsst::daf::persistence::DbTsvStorage.

Definition at line 121 of file DbStorage.cc.

                                                     {
     _impl->dropTable(tableName);
 }

void lsst::daf::persistence::DbStorage::endTransaction ( void )

virtual

End a transaction.

Implements lsst::daf::persistence::Storage.

Reimplemented in lsst::daf::persistence::DbTsvStorage.

Definition at line 101 of file DbStorage.cc.

                                    {
     _impl->endTransaction();
 }

void lsst::daf::persistence::DbStorage::executeSql ( std::string const & sqlStatement )

virtual

Execute an arbitrary SQL statement. Use primarily to perform server-side computations or complex DDL.

Parameters

[in] sqlStatement SQL statement to be executed. Must not end in ";".

Definition at line 136 of file DbStorage.cc.

                                                         {
     _impl->executeSql(sqlStatement);
 }

void lsst::daf::persistence::DbStorage::finishQuery ( void )

virtual

Indicate that query processing is finished. Must be called after next() returns false; no getColumnByPos() or columnIsNull() calls may be made after this method is called.

Definition at line 278 of file DbStorage.cc.

                                 {
     _impl->finishQuery();
 }

template<typename T >

T const & lsst::daf::persistence::DbStorage::getColumnByPos ( int pos )

Get the value of a column of the query result row by position.

Parameters

[in] pos Position of the column (starts at 0)

Definition at line 263 of file DbStorage.cc.

                                           {
     return _impl->getColumnByPos<T>(pos);
 }

void lsst::daf::persistence::DbStorage::groupBy ( std::string const & expression )

virtual

Request that the query output be grouped by an expression.

Parameters

[in] expression Text of the SQL expression

Definition at line 233 of file DbStorage.cc.

                                                    {
     _impl->groupBy(expression);
 }

void lsst::daf::persistence::DbStorage::insertRow ( void )

virtual

Insert the row. Row values must have been set with setColumn() calls.

Reimplemented in lsst::daf::persistence::DbTsvStorage.

Definition at line 166 of file DbStorage.cc.

                               {
     _impl->insertRow();
 }

bool lsst::daf::persistence::DbStorage::next ( void )

virtual

Move to the next (first) row of the query result.

Returns: false if no more rows

Definition at line 255 of file DbStorage.cc.

                          {
     return _impl->next();
 }

void lsst::daf::persistence::DbStorage::orderBy ( std::string const & expression )

virtual

Request that the query output be sorted by an expression. Multiple expressions may be specified, in order.

Parameters

[in] expression Text of the SQL expression

Definition at line 226 of file DbStorage.cc.

                                                    {
     _impl->orderBy(expression);
 }

void lsst::daf::persistence::DbStorage::outColumn	(	std::string const &	columnName,
		bool	isExpr = `false`
	)

virtual

Request a column in the query output.

Parameters

[in]	columnName	Name of the column
[in]	isExpr	True if the name is actually an expression

The order of outColumn() calls is the order of appearance in the output row. Use either outColumn() or outParam() but not both.

Definition at line 194 of file DbStorage.cc.

                                                                   {
     _impl->outColumn(columnName, isExpr);
 }

template<typename T >

void lsst::daf::persistence::DbStorage::outParam	(	std::string const &	columnName,
		T *	location,
		bool	isExpr = `false`
	)

Request a column in the query output and bind a destination location.

Parameters

[in]	columnName	Name of the column
[in]	location	Pointer to the destination
[in]	isExpr	True if the name is actually an expression

The order of outParam() calls is the order of appearance in the output row. Use either outColumn() or outParam() but not both.

Definition at line 207 of file DbStorage.cc.

                                       {
     _impl->outParam(columnName, location, isExpr);
 }

void lsst::daf::persistence::DbStorage::query ( void )

virtual

Execute the query.

Definition at line 248 of file DbStorage.cc.

                           {
     _impl->query();
 }

template<typename T >

void lsst::daf::persistence::DbStorage::setColumn	(	std::string const &	columnName,
		T const &	value
	)

Set the value to insert in a given column.

Parameters

[in]	columnName	Name of the column
[in]	value	Value to set in the column

Definition at line 152 of file DbStorage.cc.

                                                                      {
     _impl->setColumn(columnName, value);
 }

void lsst::daf::persistence::DbStorage::setColumnToNull ( std::string const & columnName )

virtual

Set a given column to NULL.

Parameters

[in] columnName Name of the column

Reimplemented in lsst::daf::persistence::DbTsvStorage.

Definition at line 159 of file DbStorage.cc.

                                                            {
     _impl->setColumnToNull(columnName);
 }

void lsst::daf::persistence::DbStorage::setPersistLocation ( LogicalLocation const & location )

virtual

Set the database location to persist to.

Parameters

[in] location Database connection string to insert to.

Implements lsst::daf::persistence::Storage.

Reimplemented in lsst::daf::persistence::DbTsvStorage.

Definition at line 82 of file DbStorage.cc.

                                                                   {
     _impl->setPersistLocation(location);
 }

void lsst::daf::persistence::DbStorage::setPolicy ( lsst::pex::policy::Policy::Ptr policy )

virtual

Allow a policy to be used to configure the DbStorage.

Parameters

[in] policy

Implements lsst::daf::persistence::Storage.

Reimplemented in lsst::daf::persistence::DbTsvStorage.

Definition at line 75 of file DbStorage.cc.

                                                        {
     _impl->setPolicy(policy);
 }

void lsst::daf::persistence::DbStorage::setQueryWhere ( std::string const & whereClause )

virtual

Set the condition for the WHERE clause of the query.

Parameters

[in] whereClause SQL text of the WHERE clause

May include join conditions.

Definition at line 242 of file DbStorage.cc.

                                                           {
     _impl->setQueryWhere(whereClause);
 }

void lsst::daf::persistence::DbStorage::setRetrieveLocation ( LogicalLocation const & location )

virtual

Set the database location to retrieve from.

Parameters

[in] location Database connection string to query.

Implements lsst::daf::persistence::Storage.

Reimplemented in lsst::daf::persistence::DbTsvStorage.

Definition at line 89 of file DbStorage.cc.

                                                                    {
     _impl->setRetrieveLocation(location);
 }

void lsst::daf::persistence::DbStorage::setTableForInsert ( std::string const & tableName )

virtual

Set the table to insert rows into.

Parameters

[in] tableName Name of the table

Reimplemented in lsst::daf::persistence::DbTsvStorage.

Definition at line 143 of file DbStorage.cc.

                                                             {
     _impl->setTableForInsert(tableName);
 }

void lsst::daf::persistence::DbStorage::setTableForQuery	(	std::string const &	tableName,
		bool	isExpr = `false`
	)

virtual

Set the table to query (single-table queries only).

Parameters

[in]	tableName	Name of the table
[in]	isExpr	True if the name is actually a table expression

Definition at line 175 of file DbStorage.cc.

                                                                         {
     _impl->setTableForQuery(tableName, isExpr);
 }

void lsst::daf::persistence::DbStorage::setTableListForQuery ( std::vector< std::string > const & tableNameList )

virtual

Set a list of tables to query (multiple-table queries).

Parameters

[in] tableNameList Vector of names of tables

Definition at line 182 of file DbStorage.cc.

                                                {
     _impl->setTableListForQuery(tableNameList);
 }

void lsst::daf::persistence::DbStorage::startTransaction ( void )

virtual

Start a transaction.

Implements lsst::daf::persistence::Storage.

Reimplemented in lsst::daf::persistence::DbTsvStorage.

Definition at line 95 of file DbStorage.cc.

                                      {
     _impl->startTransaction();
 }

void lsst::daf::persistence::DbStorage::truncateTable ( std::string const & tableName )

virtual

Truncate a table.

Parameters

[in] tableName Name of the table to truncate

Reimplemented in lsst::daf::persistence::DbTsvStorage.

Definition at line 128 of file DbStorage.cc.

                                                         {
     _impl->truncateTable(tableName);
 }

Member Data Documentation

boost::scoped_ptr<DbStorageImpl> lsst::daf::persistence::DbStorage::_impl

private

Implementation class for isolation.

Definition at line 113 of file DbStorage.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/DbStorage.h
/home/lsstsw/stack/Linux64/daf_persistence/11.0-1-g7418c06/src/DbStorage.cc

Public Types

Public Member Functions

Protected Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation