/*
 * ServerDatabase.hpp
 *
 * Copyright (C) 2022 by Posit Software, PBC
 *
 * Unless you have received this program directly from Posit Software pursuant
 * to the terms of a commercial license agreement with Posit Software, then
 * this program is licensed to you under the terms of version 3 of the
 * GNU Affero General Public License. This program is distributed WITHOUT
 * ANY EXPRESS OR IMPLIED WARRANTY, INCLUDING THOSE OF NON-INFRINGEMENT,
 * MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Please refer to the
 * AGPL (http://www.gnu.org/licenses/agpl-3.0.txt) for more details.
 *
 */

#ifndef SERVER_CORE_SERVER_DATABASE_HPP
#define SERVER_CORE_SERVER_DATABASE_HPP

#include <string_view>
#include <boost/optional.hpp>

#include <core/Database.hpp>

#include <server_core/DatabaseConstants.hpp>

#include <shared_core/Error.hpp>
#include <shared_core/system/User.hpp>

namespace rstudio {
namespace server_core {
namespace database {

// get the configured driver
core::database::Driver getConfiguredDriver(const core::database::ConnectionOptions& options);

// get the configured driver
// this method can be called before initialization to peak to see
// which type of database would be used after initialization
core::database::Driver getConfiguredDriver(const std::string& databaseConfigFile = std::string());

// Get the configured options
// this method can be called after initialization to 
// see the configured database connection options
// returns boost::none if accessed before initialization
boost::optional<core::database::ConnectionOptions> getConnectionOptions();

core::Error readOptions(const std::string& databaseConfigFile,
                  const boost::optional<core::system::User>& databaseFileUser,
                  core::database::ConnectionOptions* pOptions,
                  std::string_view forceDatabaseProvider = "");

// initialize server database, optionally performing migration
// to the latest database schema version
core::Error initialize(const std::string& databaseConfigFile = std::string(),
                       bool updateSchema = false,
                       const boost::optional<core::system::User>& databaseFileUser = boost::none);

// Execute the database command using the underlying configuration
core::Error execute(const std::string& databaseConfigFile,
                    const boost::optional<core::system::User>& databaseFileUser,
                    std::string_view command);

boost::shared_ptr<core::database::IConnection> getConnection();
bool getConnection(const boost::posix_time::time_duration& waitTime,
                   boost::shared_ptr<core::database::IConnection>* pConnection);

} // namespace database
} // namespace server_core
} // namespace rstudio


#endif // SERVER_CORE_SERVER_DATABASE_HPP