art::SQLite3Wrapper Class Reference

#include "SQLite3Wrapper.h"

Public Types
typedef int(*	callback_t) (void *, int, char **, char **)

Public Member Functions
	SQLite3Wrapper (SQLite3Wrapper const &)=delete
SQLite3Wrapper &	operator= (SQLite3Wrapper const &)=delete
	SQLite3Wrapper ()
	SQLite3Wrapper (std::string const &key, int flags=SQLITE_OPEN_READONLY)
	SQLite3Wrapper (TFile *tfile, std::string const &key, int flags=SQLITE_OPEN_READWRITE)
std::string const &	key () const
	operator sqlite3 * ()
void	reset ()
void	reset (std::string const &key, int flags=SQLITE_OPEN_READONLY)
void	reset (TFile *tfile, std::string const &key, int flags=SQLITE_OPEN_READWRITE|SQLITE_OPEN_TRANSIENT_DB)
	~SQLite3Wrapper ()
void	swap (SQLite3Wrapper &other)

Static Public Member Functions
static bool	wantTracing ()

Private Member Functions
void	initDB (int flags, TFile *tfile=0)
void	maybeTrace () const

Private Attributes
sqlite3 *	db_
std::string	key_

Detailed Description

Definition at line 17 of file SQLite3Wrapper.h.

Member Typedef Documentation

typedef int(* art::SQLite3Wrapper::callback_t) (void *, int, char **, char **)

Definition at line 22 of file SQLite3Wrapper.h.

Constructor & Destructor Documentation

art::SQLite3Wrapper::SQLite3Wrapper ( SQLite3Wrapper const &  )

delete

art::SQLite3Wrapper::SQLite3Wrapper

(

)

Definition at line 49 of file SQLite3Wrapper.cc.

: db_(0), key_() {}

art::SQLite3Wrapper::SQLite3Wrapper ( std::string const &  key, int  flags = SQLITE_OPEN_READONLY  )

explicit

Definition at line 51 of file SQLite3Wrapper.cc.

References initDB().

  : db_(0), key_(key)
{
  initDB(flags);
}

art::SQLite3Wrapper::SQLite3Wrapper	(	TFile *	tfile,
		std::string const &	key,
		int	flags = SQLITE_OPEN_READWRITE
	)

Definition at line 57 of file SQLite3Wrapper.cc.

References initDB().

  : db_(0), key_(key)
{
  initDB(flags, tfile);
}

art::SQLite3Wrapper::~SQLite3Wrapper

(

)

Definition at line 93 of file SQLite3Wrapper.cc.

References db_.

Referenced by operator sqlite3 *().

{
  if (db_) {
    sqlite3_close(db_);
  }
}

Member Function Documentation

void art::SQLite3Wrapper::initDB ( int  flags, TFile *  tfile = 0  )

private

Definition at line 109 of file SQLite3Wrapper.cc.

References db_, art::errors::FileOpenError, key_, maybeTrace(), and tkeyvfs_open_v2().

Referenced by operator sqlite3 *(), and SQLite3Wrapper().

{
  int err = 0;
  DBTYPE type = tfile ? SQLITE3_TKEYDB :
                        key_.size() ?
                        (key_ == ":memory:" ? SQLITE3_MEMDB : SQLITE3_FILEDB) :
                        SQLITE3_TMPDB;
  switch (type) {
    case SQLITE3_TKEYDB:
      if (!key_.size()) {
        throw Exception{errors::FileOpenError}
          << "Failed to open TKEYVFS DB due to empty key spec.\n";
      }
      err = tkeyvfs_open_v2(key_.c_str(), &db_, flags, tfile);
      break;
    case SQLITE3_MEMDB:
      err = sqlite3_open(key_.c_str(), &db_);
      break;
    case SQLITE3_FILEDB:
      err = sqlite3_open_v2(key_.c_str(), &db_, flags, nullptr);
      break;
    case SQLITE3_TMPDB:
      err = sqlite3_open(key_.c_str(), &db_);
      break;
  }
  if (err) {
    throw Exception{errors::FileOpenError}
      << "Failed to open requested DB, \"" << key_ << "\" of type, \""
      << dbTypeAsString(type) << "\" -- " << sqlite3_errmsg(db_) << "\n";
  }
  maybeTrace();
}

std::string const& art::SQLite3Wrapper::key ( ) const

inline

Definition at line 36 of file SQLite3Wrapper.h.

References key_.

Referenced by operator sqlite3 *(), and reset().

  {
    return key_;
  }

void art::SQLite3Wrapper::maybeTrace ( ) const

private

Definition at line 143 of file SQLite3Wrapper.cc.

References db_, key_, and wantTracing().

Referenced by initDB(), and operator sqlite3 *().

{
  if (wantTracing()) {
    // Cast away constness for C interface.
    sqlite3_trace(db_, traceit, const_cast<std::string*>(&key_));
  }
}

art::SQLite3Wrapper::operator sqlite3 * ( )

inline

Definition at line 41 of file SQLite3Wrapper.h.

References db_, initDB(), key(), maybeTrace(), fhicl::other, reset(), swap(), wantTracing(), and ~SQLite3Wrapper().

{ return db_; }

SQLite3Wrapper& art::SQLite3Wrapper::operator= ( SQLite3Wrapper const &  )

delete

void art::SQLite3Wrapper::reset

(

void

)

Definition at line 73 of file SQLite3Wrapper.cc.

References swap(), and tmp.

Referenced by operator sqlite3 *().

{
  SQLite3Wrapper tmp;
  swap(tmp);
}

void art::SQLite3Wrapper::reset	(	std::string const &	key,
		int	flags = SQLITE_OPEN_READONLY
	)

Definition at line 80 of file SQLite3Wrapper.cc.

References key(), swap(), and tmp.

{
  SQLite3Wrapper tmp{key, flags};
  swap(tmp);
}

void art::SQLite3Wrapper::reset	(	TFile *	tfile,
		std::string const &	key,
		int	flags = SQLITE_OPEN_READWRITE | SQLITE_OPEN_TRANSIENT_DB
	)

Definition at line 87 of file SQLite3Wrapper.cc.

References key(), swap(), and tmp.

{
  SQLite3Wrapper tmp{tfile, key, flags};
  swap(tmp);
}

void art::SQLite3Wrapper::swap

(

SQLite3Wrapper &

other

)

Definition at line 101 of file SQLite3Wrapper.cc.

References db_, and key_.

Referenced by operator sqlite3 *(), and reset().

{
  using std::swap;
  swap(db_, other.db_);
  swap(key_, other.key_);
}

bool art::SQLite3Wrapper::wantTracing ( )

static

Definition at line 66 of file SQLite3Wrapper.cc.

Referenced by maybeTrace(), and operator sqlite3 *().

{
  static char const* s_debug = getenv("ART_DEBUG_SQL");
  return s_debug;
}

Member Data Documentation

sqlite3* art::SQLite3Wrapper::db_

private

Definition at line 64 of file SQLite3Wrapper.h.

Referenced by initDB(), maybeTrace(), operator sqlite3 *(), swap(), and ~SQLite3Wrapper().

std::string art::SQLite3Wrapper::key_

private

Definition at line 65 of file SQLite3Wrapper.h.

Referenced by initDB(), key(), maybeTrace(), and swap().

---

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

• art/Framework/IO/Root/RootDB/SQLite3Wrapper.h
• art/Framework/IO/Root/RootDB/SQLite3Wrapper.cc