#include <DatabaseSessionManager.hh>

Inheritance diagram for utility::sql_database::session:

Public Member Functions
	session ()

	~session () override

void	set_db_mode (DatabaseMode::e const db_mode)

DatabaseMode::e	get_db_mode () const

void	set_transaction_mode (TransactionMode::e const transaction_mode)

TransactionMode::e	get_transaction_mode () const

void	set_chunk_size (platform::Size const chunk_size)

platform::Size	get_chunk_size ()

void	set_db_name (std::string const &db_name)

std::string const &	get_db_name () const

void	set_pq_schema (std::string const &pq_schema)

std::string const &	get_pq_schema () const

platform::SSize	get_db_partition ()

void	set_db_partition (platform::SSize db_partition)

bool	is_db_partitioned ()

void	begin_transaction ()
	indicate that a transaction block has begun. More...

void	commit_transaction ()
	indicate that a transaction block has completed. NOTE: When in chunk transaction mode, this may not actually write to the database. More...

void	force_commit_transaction ()
	force a transaction to be committed. This should only be used when writing data that is required by other processes, such as protocol and batch ids. More...

void	open_sqlite3_session (bool read_only=false)
	Convenience function to open an sqlite3 session. More...

void	open_mysql_session (std::string const &host, std::string const &user, std::string const &password, platform::Size port)
	Convenience function to open a mysql session. More...

void	open_postgres_session (std::string const &host, std::string const &user, std::string const &password, platform::Size port)
	Convenience function to open a postgres session. More...

Public Member Functions inherited from utility::VirtualBase
	VirtualBase ()=default
	Default constructor. More...

virtual	~VirtualBase ()=default
	The virtual destructor is one of the main reasons for the VirtualBase class. More...

	VirtualBase (VirtualBase const &)=default

	VirtualBase (VirtualBase &&)=default

VirtualBase &	operator= (VirtualBase const &)=default

VirtualBase &	operator= (VirtualBase &&)=default

Private Attributes
DatabaseMode::e	db_mode_

std::string	db_name_

std::string	pq_schema_

platform::SSize	db_partition_

transactionOP	cur_transaction_

TransactionMode::e	transaction_mode_

platform::Size	chunk_size_

platform::Size	transaction_counter_

Constructor & Destructor Documentation

◆ session()

utility::sql_database::session::session ( )

inline

◆ ~session()

utility::sql_database::session::~session ( )

override

References force_commit_transaction().

Member Function Documentation

◆ begin_transaction()

void utility::sql_database::session::begin_transaction ( )

indicate that a transaction block has begun.

References utility::sql_database::TransactionMode::chunk, cur_transaction_, enumerate_junctions::default, utility::sql_database::name_from_transaction_mode(), utility::sql_database::TransactionMode::none, utility::sql_database::TransactionMode::standard, transaction_mode_, and utility_exit_with_message.

◆ commit_transaction()

void utility::sql_database::session::commit_transaction ( )

indicate that a transaction block has completed. NOTE: When in chunk transaction mode, this may not actually write to the database.

References utility::sql_database::TransactionMode::chunk, chunk_size_, cur_transaction_, enumerate_junctions::default, utility::sql_database::name_from_transaction_mode(), utility::sql_database::TransactionMode::none, utility::sql_database::TransactionMode::standard, transaction_counter_, transaction_mode_, and utility_exit_with_message.

◆ force_commit_transaction()

void utility::sql_database::session::force_commit_transaction ( )

force a transaction to be committed. This should only be used when writing data that is required by other processes, such as protocol and batch ids.

References utility::sql_database::TransactionMode::chunk, cur_transaction_, enumerate_junctions::default, utility::sql_database::name_from_transaction_mode(), utility::sql_database::TransactionMode::none, utility::sql_database::TransactionMode::standard, transaction_mode_, and utility_exit_with_message.

Referenced by ~session().

◆ get_chunk_size()

platform::Size utility::sql_database::session::get_chunk_size ( )

inline

References chunk_size_.

◆ get_db_mode()

DatabaseMode::e utility::sql_database::session::get_db_mode ( ) const

inline

References db_mode_.

◆ get_db_name()

std::string const& utility::sql_database::session::get_db_name ( ) const

inline

References db_name_.

Referenced by open_mysql_session(), open_postgres_session(), and open_sqlite3_session().

◆ get_db_partition()

platform::SSize utility::sql_database::session::get_db_partition ( )

inline

References db_partition_.

Referenced by open_sqlite3_session().

◆ get_pq_schema()

std::string const& utility::sql_database::session::get_pq_schema ( ) const

inline

References pq_schema_.

Referenced by open_postgres_session().

◆ get_transaction_mode()

TransactionMode::e utility::sql_database::session::get_transaction_mode ( ) const

inline

References transaction_mode_.

◆ is_db_partitioned()

bool utility::sql_database::session::is_db_partitioned ( )

inline

References db_partition_.

Referenced by open_sqlite3_session().

◆ open_mysql_session()

void utility::sql_database::session::open_mysql_session	(	std::string const &	host,
		std::string const &	user,
		std::string const &	password,
		platform::Size	port
	)

Convenience function to open a mysql session.

References test.T009_Exceptions::e, get_db_name(), basic::options::OptionKeys::cloud::host, basic::database::open(), basic::options::OptionKeys::inout::dbms::password, basic::options::OptionKeys::cloud::port, basic::options::OptionKeys::inout::dbms::user, and utility_exit_with_message.

◆ open_postgres_session()

void utility::sql_database::session::open_postgres_session	(	std::string const &	host,
		std::string const &	user,
		std::string const &	password,
		platform::Size	port
	)

Convenience function to open a postgres session.

References test.T009_Exceptions::e, get_db_name(), get_pq_schema(), basic::options::OptionKeys::cloud::host, basic::database::open(), basic::options::OptionKeys::inout::dbms::password, basic::options::OptionKeys::cloud::port, basic::options::OptionKeys::inout::dbms::user, and utility_exit_with_message.

◆ open_sqlite3_session()

void utility::sql_database::session::open_sqlite3_session ( bool read_only = false )

Convenience function to open an sqlite3 session.

References test.T009_Exceptions::e, get_db_name(), get_db_partition(), is_db_partitioned(), utility::file::FileName::name(), basic::database::open(), and utility_exit_with_message.

◆ set_chunk_size()

void utility::sql_database::session::set_chunk_size ( platform::Size const chunk_size )

inline

References chunk_size_.

◆ set_db_mode()

void utility::sql_database::session::set_db_mode ( DatabaseMode::e const db_mode )

inline

References db_mode_.

◆ set_db_name()

void utility::sql_database::session::set_db_name ( std::string const & db_name )

inline

References db_name_.

◆ set_db_partition()

void utility::sql_database::session::set_db_partition ( platform::SSize db_partition )

inline

References db_partition_.

◆ set_pq_schema()

void utility::sql_database::session::set_pq_schema ( std::string const & pq_schema )

inline

References basic::options::OptionKeys::inout::dbms::pq_schema, and pq_schema_.

◆ set_transaction_mode()

void utility::sql_database::session::set_transaction_mode ( TransactionMode::e const transaction_mode )

inline

References transaction_mode_.

Member Data Documentation

◆ chunk_size_

platform::Size utility::sql_database::session::chunk_size_

private

Referenced by commit_transaction(), get_chunk_size(), and set_chunk_size().

◆ cur_transaction_

transactionOP utility::sql_database::session::cur_transaction_

private

Referenced by begin_transaction(), commit_transaction(), and force_commit_transaction().

◆ db_mode_

DatabaseMode::e utility::sql_database::session::db_mode_

private

Referenced by get_db_mode(), and set_db_mode().

◆ db_name_

std::string utility::sql_database::session::db_name_

private

Referenced by get_db_name(), and set_db_name().

◆ db_partition_

platform::SSize utility::sql_database::session::db_partition_

private

Referenced by get_db_partition(), is_db_partitioned(), and set_db_partition().

◆ pq_schema_

std::string utility::sql_database::session::pq_schema_

private

Referenced by get_pq_schema(), and set_pq_schema().

◆ transaction_counter_

platform::Size utility::sql_database::session::transaction_counter_

private

Referenced by commit_transaction().

◆ transaction_mode_

TransactionMode::e utility::sql_database::session::transaction_mode_

private

Referenced by begin_transaction(), commit_transaction(), force_commit_transaction(), get_transaction_mode(), and set_transaction_mode().

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

src/utility/sql_database/DatabaseSessionManager.hh
src/utility/sql_database/DatabaseSessionManager.cc

Public Member Functions

Private Attributes

Constructor & Destructor Documentation

◆ session()

◆ ~session()

Member Function Documentation

◆ begin_transaction()

◆ commit_transaction()

◆ force_commit_transaction()

◆ get_chunk_size()

◆ get_db_mode()

◆ get_db_name()

◆ get_db_partition()

◆ get_pq_schema()

◆ get_transaction_mode()

◆ is_db_partitioned()

◆ open_mysql_session()

◆ open_postgres_session()

◆ open_sqlite3_session()

◆ set_chunk_size()

◆ set_db_mode()

◆ set_db_name()

◆ set_db_partition()

◆ set_pq_schema()

◆ set_transaction_mode()

Member Data Documentation

◆ chunk_size_

◆ cur_transaction_

◆ db_mode_

◆ db_name_

◆ db_partition_

◆ pq_schema_

◆ transaction_counter_

◆ transaction_mode_