SqliteConnector Class Reference

#include <SqliteConnector.h>

Collaboration diagram for SqliteConnector:

Classes
struct	NullableResult

Public Types
enum	BindType { BindType::TEXT = 1, BindType::BLOB, BindType::NULL_TYPE }

Public Member Functions
	SqliteConnector (const std::string &dbName, const std::string &dir=".")
	SqliteConnector (sqlite3 *db)
	SqliteConnector ()
virtual	~SqliteConnector ()
void	reset (const std::string &path)
virtual void	query (const std::string &queryString)
virtual void	query_with_text_params (std::string const &query_only)
template<typename STRING_CONTAINER >
void	query_with_text_params (STRING_CONTAINER const &query_and_text_params)
virtual void	query_with_text_params (const std::string &queryString, const std::vector< std::string > &text_param)
virtual void	query_with_text_params (const std::string &queryString, const std::vector< std::string > &text_params, const std::vector< BindType > &bind_types)
virtual void	query_with_text_param (const std::string &queryString, const std::string &text_param)
virtual void	batch_insert (const std::string &table_name, std::vector< std::vector< std::string >> &insert_vals)
virtual size_t	getNumRows () const
virtual size_t	getNumCols () const
template<typename T >
T	getData (const int row, const int col)
bool	isNull (const int row, const int col) const
auto	getSqlitePtr () const

Public Attributes
std::vector< std::string >	columnNames
std::vector< int >	columnTypes

Private Member Functions
void	throwError ()

Private Attributes
sqlite3 *	db_
std::string	dbName_
bool	atFirstResult_
std::vector< std::vector < NullableResult > >	results_
size_t	numCols_
size_t	numRows_

Detailed Description

Definition at line 33 of file SqliteConnector.h.

Member Enumeration Documentation

enum SqliteConnector::BindType

strong

Enumerator
TEXT
BLOB
NULL_TYPE

Definition at line 60 of file SqliteConnector.h.

{ TEXT = 1, BLOB, NULL_TYPE };

Constructor & Destructor Documentation

SqliteConnector::SqliteConnector	(	const std::string &	dbName,
		const std::string &	dir = "."
	)

SqliteConnector::SqliteConnector

(

sqlite3 *

db

)

Definition at line 47 of file SqliteConnector.cpp.

: db_(db) {}

SqliteConnector::SqliteConnector ( )

inline

Definition at line 37 of file SqliteConnector.h.

{}

SqliteConnector::~SqliteConnector ( )

virtual

Definition at line 49 of file SqliteConnector.cpp.

References db_, and dbName_.

                                  {
  if (!dbName_.empty()) {
    sqlite3_close(db_);
  }
}

Member Function Documentation

void SqliteConnector::batch_insert ( const std::string &  table_name, std::vector< std::vector< std::string >> &  insert_vals  )

virtual

Definition at line 153 of file SqliteConnector.cpp.

References db_, query(), and throwError().

                                                                                 {
  const size_t num_rows = insert_vals.size();
  if (!num_rows) {
    return;
  }
  const size_t num_cols(insert_vals[0].size());
  if (!num_cols) {
    return;
  }
  std::string paramertized_query = "INSERT INTO " + table_name + " VALUES(";
  for (size_t col_idx = 0; col_idx < num_cols - 1; ++col_idx) {
    paramertized_query += "?, ";
  }
  paramertized_query += "?)";

  query("BEGIN TRANSACTION");

  sqlite3_stmt* stmt;
  int returnCode =
      sqlite3_prepare_v2(db_, paramertized_query.c_str(), -1, &stmt, nullptr);
  if (returnCode != SQLITE_OK) {
    throwError();
  }

  for (size_t r = 0; r < num_rows; ++r) {
    const auto& row_insert_vals = insert_vals[r];
    int num_params = 1;
    for (const auto& insert_field : row_insert_vals) {
      returnCode = sqlite3_bind_text(stmt,
                                     num_params++,
                                     insert_field.c_str(),
                                     insert_field.size(),
                                     SQLITE_TRANSIENT);
      if (returnCode != SQLITE_OK) {
        throwError();
      }
    }
    returnCode = sqlite3_step(stmt);
    if (returnCode != SQLITE_DONE) {
      throwError();
    }
    sqlite3_reset(stmt);
  }
  sqlite3_finalize(stmt);
  query("END TRANSACTION");
}

Here is the call graph for this function:

template<typename T >

T SqliteConnector::getData ( const int  row, const int  col  )

inline

Definition at line 75 of file SqliteConnector.h.

References numCols_, numRows_, results_, and heavydb.dtypes::T.

Referenced by Catalog_Namespace::Catalog::buildDictionaryMapUnlocked(), Catalog_Namespace::Catalog::createDashboardSystemRoles(), migrations::MigrationMgr::migrateDateInDaysMetadata(), Catalog_Namespace::Catalog::recordOwnershipOfObjectsInObjectPermissions(), SqliteMemDatabase::runSelect(), Catalog_Namespace::Catalog::updateDefaultColumnValues(), Catalog_Namespace::Catalog::updateDeletedColumnIndicator(), Catalog_Namespace::Catalog::updateDictionaryNames(), Catalog_Namespace::Catalog::updateDictionarySchema(), Catalog_Namespace::Catalog::updateFrontendViewSchema(), Catalog_Namespace::Catalog::updateLinkSchema(), Catalog_Namespace::Catalog::updatePageSize(), and Catalog_Namespace::Catalog::updateTableDescriptorSchema().

                                          {
    assert(row < static_cast<int>(numRows_));
    assert(col < static_cast<int>(numCols_));
    return boost::lexical_cast<T>(results_[col][row].result);
  }

Here is the caller graph for this function:

virtual size_t SqliteConnector::getNumCols ( ) const

inlinevirtual

Definition at line 72 of file SqliteConnector.h.

References numCols_.

Referenced by SqliteMemDatabase::runSelect().

{ return numCols_; }

Here is the caller graph for this function:

virtual size_t SqliteConnector::getNumRows ( ) const

inlinevirtual

Definition at line 71 of file SqliteConnector.h.

References numRows_.

Referenced by Catalog_Namespace::Catalog::buildDictionaryMapUnlocked(), Catalog_Namespace::Catalog::createDashboardSystemRoles(), migrations::MigrationMgr::migrateDateInDaysMetadata(), Catalog_Namespace::Catalog::recordOwnershipOfObjectsInObjectPermissions(), Catalog_Namespace::Catalog::renameLegacyDataWrappers(), SqliteMemDatabase::runSelect(), Catalog_Namespace::Catalog::updateDefaultColumnValues(), Catalog_Namespace::Catalog::updateDeletedColumnIndicator(), Catalog_Namespace::Catalog::updateDictionaryNames(), Catalog_Namespace::Catalog::updateDictionarySchema(), Catalog_Namespace::Catalog::updateFixlenArrayColumns(), Catalog_Namespace::Catalog::updateFrontendViewAndLinkUsers(), Catalog_Namespace::Catalog::updateFrontendViewSchema(), Catalog_Namespace::Catalog::updateFrontendViewsToDashboards(), Catalog_Namespace::Catalog::updateGeoColumns(), Catalog_Namespace::Catalog::updateLinkSchema(), Catalog_Namespace::Catalog::updatePageSize(), and Catalog_Namespace::Catalog::updateTableDescriptorSchema().

{ return numRows_; }

Here is the caller graph for this function:

auto SqliteConnector::getSqlitePtr ( ) const

inline

Definition at line 90 of file SqliteConnector.h.

References db_.

{ return db_; }

bool SqliteConnector::isNull ( const int  row, const int  col  ) const

inline

Definition at line 81 of file SqliteConnector.h.

References numCols_, numRows_, and results_.

Referenced by SqliteMemDatabase::runSelect().

                                                  {
    assert(row < static_cast<int>(numRows_));
    assert(col < static_cast<int>(numCols_));
    return results_[col][row].is_null;
  }

Here is the caller graph for this function:

void SqliteConnector::query ( const std::string &  queryString )

virtual

Definition at line 149 of file SqliteConnector.cpp.

References query_with_text_params().

Referenced by batch_insert(), Catalog_Namespace::Catalog::buildDictionaryMapUnlocked(), Catalog_Namespace::Catalog::createDashboardSystemRoles(), migrations::MigrationMgr::migrateDateInDaysMetadata(), query_with_text_params(), Catalog_Namespace::Catalog::recordOwnershipOfObjectsInObjectPermissions(), Catalog_Namespace::Catalog::renameLegacyDataWrappers(), SqliteMemDatabase::runSelect(), Catalog_Namespace::Catalog::updateCustomExpressionsSchema(), Catalog_Namespace::Catalog::updateDefaultColumnValues(), Catalog_Namespace::Catalog::updateDeletedColumnIndicator(), Catalog_Namespace::Catalog::updateDictionaryNames(), Catalog_Namespace::Catalog::updateDictionarySchema(), Catalog_Namespace::Catalog::updateFixlenArrayColumns(), Catalog_Namespace::Catalog::updateFrontendViewAndLinkUsers(), Catalog_Namespace::Catalog::updateFrontendViewSchema(), Catalog_Namespace::Catalog::updateFrontendViewsToDashboards(), Catalog_Namespace::Catalog::updateFsiSchemas(), Catalog_Namespace::Catalog::updateGeoColumns(), Catalog_Namespace::Catalog::updateLinkSchema(), Catalog_Namespace::Catalog::updateLogicalToPhysicalTableLinkSchema(), Catalog_Namespace::Catalog::updateLogicalToPhysicalTableMap(), Catalog_Namespace::Catalog::updatePageSize(), and Catalog_Namespace::Catalog::updateTableDescriptorSchema().

                                                        {
  query_with_text_params(queryString, std::vector<std::string>{});
}

Here is the call graph for this function:

Here is the caller graph for this function:

void SqliteConnector::query_with_text_param ( const std::string &  queryString, const std::string &  text_param  )

virtual

Definition at line 144 of file SqliteConnector.cpp.

References query_with_text_params().

                                                                         {
  query_with_text_params(queryString, std::vector<std::string>{text_param});
}

Here is the call graph for this function:

virtual void SqliteConnector::query_with_text_params ( std::string const &  query_only )

inlinevirtual

Definition at line 47 of file SqliteConnector.h.

References query().

Referenced by Catalog_Namespace::Catalog::createDashboardSystemRoles(), migrations::MigrationMgr::migrateDateInDaysMetadata(), query(), query_with_text_param(), query_with_text_params(), Catalog_Namespace::Catalog::recordOwnershipOfObjectsInObjectPermissions(), Catalog_Namespace::Catalog::renameLegacyDataWrappers(), Catalog_Namespace::Catalog::updateFixlenArrayColumns(), Catalog_Namespace::Catalog::updateGeoColumns(), and Catalog_Namespace::Catalog::updateLogicalToPhysicalTableMap().

                                                                   {
    query(query_only);
  }

Here is the call graph for this function:

Here is the caller graph for this function:

template<typename STRING_CONTAINER >

void SqliteConnector::query_with_text_params ( STRING_CONTAINER const &  query_and_text_params )

inline

Definition at line 51 of file SqliteConnector.h.

References query_with_text_params().

                                                                             {
    query_with_text_params(
        *query_and_text_params.begin(),
        std::vector<std::string>{std::next(query_and_text_params.begin()),
                                 query_and_text_params.end()});
  }

Here is the call graph for this function:

void SqliteConnector::query_with_text_params ( const std::string &  queryString, const std::vector< std::string > &  text_param  )

virtual

Definition at line 138 of file SqliteConnector.cpp.

References query_with_text_params().

                                             {
  query_with_text_params(queryString, text_params, {});
}

Here is the call graph for this function:

void SqliteConnector::query_with_text_params ( const std::string &  queryString, const std::vector< std::string > &  text_params, const std::vector< BindType > &  bind_types  )

virtual

Definition at line 71 of file SqliteConnector.cpp.

References atFirstResult_, BLOB, CHECK, CHECK_EQ, columnNames, columnTypes, db_, get_column_datum(), is_null(), NULL_TYPE, numCols_, numRows_, results_, and throwError().

                                                                                    {
  if (!bind_types.empty()) {
    CHECK_EQ(text_params.size(), bind_types.size());
  }

  atFirstResult_ = true;
  numRows_ = 0;
  numCols_ = 0;
  columnNames.clear();
  columnTypes.clear();
  results_.clear();
  sqlite3_stmt* stmt;
  int returnCode = sqlite3_prepare_v2(db_, queryString.c_str(), -1, &stmt, nullptr);
  if (returnCode != SQLITE_OK) {
    throwError();
  }

  int num_params = 1;
  for (auto text_param : text_params) {
    if (!bind_types.empty() && bind_types[num_params - 1] == BindType::BLOB) {
      returnCode = sqlite3_bind_blob(
          stmt, num_params++, text_param.c_str(), text_param.size(), SQLITE_TRANSIENT);
    } else if (!bind_types.empty() && bind_types[num_params - 1] == BindType::NULL_TYPE) {
      returnCode = sqlite3_bind_null(stmt, num_params++);
    } else {
      returnCode = sqlite3_bind_text(
          stmt, num_params++, text_param.c_str(), text_param.size(), SQLITE_TRANSIENT);
    }
    if (returnCode != SQLITE_OK) {
      throwError();
    }
  }

  do {
    returnCode = sqlite3_step(stmt);
    if (returnCode != SQLITE_ROW && returnCode != SQLITE_DONE) {
      throwError();
    }
    if (returnCode == SQLITE_DONE) {
      break;
    }
    if (atFirstResult_) {
      numCols_ = sqlite3_column_count(stmt);
      for (size_t c = 0; c < numCols_; ++c) {
        columnNames.emplace_back(sqlite3_column_name(stmt, c));
        columnTypes.push_back(sqlite3_column_type(stmt, c));
      }
      results_.resize(numCols_);
      atFirstResult_ = false;
    }
    numRows_++;
    for (size_t c = 0; c < numCols_; ++c) {
      auto column_type = sqlite3_column_type(stmt, c);
      bool is_null = (column_type == SQLITE_NULL);
      auto col_text = get_column_datum(column_type, stmt, c);
      if (is_null) {
        CHECK(col_text.empty());
      }
      results_[c].emplace_back(NullableResult{col_text, is_null});
    }
  } while (1 == 1);  // Loop control in break statement above

  sqlite3_finalize(stmt);
}

Here is the call graph for this function:

void SqliteConnector::reset ( const std::string &  path )

inline

Definition at line 40 of file SqliteConnector.h.

References db_.

                                    {
    sqlite3_close(db_);
    sqlite3_open(path.c_str(), &db_);
  }

void SqliteConnector::throwError ( )

private

Definition at line 55 of file SqliteConnector.cpp.

References db_.

Referenced by batch_insert(), and query_with_text_params().

                                 {
  string errorMsg(sqlite3_errmsg(db_));
  throw runtime_error("Sqlite3 Error: " + errorMsg);
}

Here is the caller graph for this function:

Member Data Documentation

bool SqliteConnector::atFirstResult_

private

Definition at line 102 of file SqliteConnector.h.

Referenced by query_with_text_params().

std::vector<std::string> SqliteConnector::columnNames

Definition at line 87 of file SqliteConnector.h.

Referenced by query_with_text_params().

std::vector<int> SqliteConnector::columnTypes

Definition at line 88 of file SqliteConnector.h.

Referenced by query_with_text_params(), and SqliteMemDatabase::runSelect().

sqlite3* SqliteConnector::db_

private

Definition at line 100 of file SqliteConnector.h.

Referenced by batch_insert(), getSqlitePtr(), query_with_text_params(), reset(), throwError(), and ~SqliteConnector().

std::string SqliteConnector::dbName_

private

Definition at line 101 of file SqliteConnector.h.

Referenced by ~SqliteConnector().

size_t SqliteConnector::numCols_

private

Definition at line 104 of file SqliteConnector.h.

Referenced by getData(), getNumCols(), isNull(), and query_with_text_params().

size_t SqliteConnector::numRows_

private

Definition at line 105 of file SqliteConnector.h.

Referenced by getData(), getNumRows(), isNull(), and query_with_text_params().

std::vector<std::vector<NullableResult> > SqliteConnector::results_

private

Definition at line 103 of file SqliteConnector.h.

Referenced by getData(), isNull(), and query_with_text_params().

---

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

• /home/jenkins-slave/workspace/core-os-doxygen/SqliteConnector/SqliteConnector.h
• /home/jenkins-slave/workspace/core-os-doxygen/SqliteConnector/SqliteConnector.cpp