sql_utils.hh

Go to the documentation of this file.

// -*- mode:c++;tab-width:2;indent-tabs-mode:t;show-trailing-whitespace:t;rm-trailing-spaces:t -*-
// vi: set ts=2 noet:
//
// (c) Copyright Rosetta Commons Member Institutions.
// (c) This file is part of the Rosetta software suite and is made available under license.
// (c) The Rosetta software is developed by the contributing members of the Rosetta Commons.
// (c) For more information, see http://www.rosettacommons.org. Questions about this can be
// (c) addressed to University of Washington UW TechTransfer, email: license@u.washington.edu.

/// @file   src/basic/database/sql_utils.hh
/// @author Sam DeLuca

#ifndef INCLUDED_basic_database_sql_utils_HH
#define INCLUDED_basic_database_sql_utils_HH

#include <utility/sql_database/DatabaseSessionManager.hh>
#include <utility/sql_database/types.hh>
#include <utility/tag/Tag.fwd.hh>
#include <platform/types.hh>

#include <iosfwd>
#include <vector>
#include <cppdb/frontend.h>

namespace basic {
namespace database {

/// @brief Aquire a database session using the command line options
/// transaction type is set to standard
utility::sql_database::sessionOP
get_db_session();

/// @brief Aquire a database session using the command line parameters
/// For postgres databases, the pq_schema acts like a namespace in the
/// database. Transaction type set to standard
utility::sql_database::sessionOP
get_db_session(
  std::string const & db_name,
  std::string const & pq_schema="");

/// @brief Aquire a database session using the command line parameters
/// For postgres databases, the pq_schema acts like a namespace in the
/// database
utility::sql_database::sessionOP
get_db_session(
  std::string const & db_name,
  utility::sql_database::TransactionMode::e transaction_mode,
  platform::Size chunk_size,
  std::string const & pq_schema="");

utility::sql_database::sessionOP
get_db_session(
  utility::sql_database::DatabaseMode::e db_mode,
  std::string const & db_name,
  std::string const & pq_schema="");

/// @brief Aquire a database session using the command line parameters
/// For postgres databases, the pq_schema acts like a namespace in the
/// database
utility::sql_database::sessionOP
get_db_session(
  utility::sql_database::DatabaseMode::e db_mode,
  utility::sql_database::TransactionMode::e transaction_mode,
  platform::Size chunk_size,
  std::string const & db_name,
  std::string const & pq_schema="");

/// @brief Returns partition identifer if in partitioned database mode, otherwise -1.
//  Determines partition mode from user options 'inout::dbms::separate_db_per_mpi_process'
//  and 'inout::dbms::db_partition'.
platform::SSize db_partition_from_options(
  utility::sql_database::DatabaseMode::e db_mode);

/// @brief Returns partition identifer from mpi rank if in partitioned database mode, or valid manual partition, otherwise -1.
platform::SSize resolve_db_partition(
  bool partition_by_mpi_process,
  platform::SSize manual_partition = -1);

cppdb::statement
safely_prepare_statement(
  std::string const & statement_string,
  utility::sql_database::sessionOP db_session);

void
safely_write_to_database(
  cppdb::statement & statement);

cppdb::result
safely_read_from_database(
  cppdb::statement & statement);

void
insert_or_ignore(
  std::string table_name,
  std::vector<std::string> column_names,
  std::vector<std::string> values,
  utility::sql_database::sessionOP db_session);

void
check_statement_sanity(std::string sql);

bool
table_exists(
  utility::sql_database::sessionOP db_session,
  std::string const & table_name);

/// @brief set the number of 1kb pages to use for cache
void
set_cache_size(
  utility::sql_database::sessionOP db_session,
  platform::Size cache_size);

void write_schema_to_database(
  std::string schema,
  utility::sql_database::sessionOP db_session);

std::string make_compound_statement(
  std::string const & table_name,
  std::vector<std::string> const & column_names,
  platform::Size const & row_count);

utility::sql_database::sessionOP
parse_database_connection(
  utility::tag::TagCOP tag);
}

}

#endif /* INCLUDED_basic_database_sql_utils_HH */