mariadb.h

Go to the documentation of this file.

// Copyright (C) 2013-2020 iFunFactory Inc. All Rights Reserved.
//
// This work is confidential and proprietary to iFunFactory Inc. and
// must not be used, disclosed, copied, or distributed without the prior
// consent of iFunFactory Inc.
//

#ifndef INCLUDE_FUNAPI_DATABASE_MARIADB_H_
#define INCLUDE_FUNAPI_DATABASE_MARIADB_H_

#include <boost/bind.hpp>
#include <boost/enable_shared_from_this.hpp>

#include <errmsg.h>

#include <funapi/types.h>
#include <funapi/time/wall_clock.h>


#include <mysql.h>
#include <mysqld_error.h>


namespace fun {

class FUNAPI_DLL_VISIBILITY ResultSets {
 public:
  class Impl;

  DECLARE_CLASS_PTR(ResultSets);

  explicit ResultSets(const Ptr<Impl> &impl);

  size_t GetResultSetCount() const;

  bool SeekNextResultSet();

  size_t GetCountOfAffectedRows() const;

  const std::vector<size_t> &GetCountsOfAffectedRows() const;

  size_t GetColumnCount() const;

  string GetColumnName(const size_t &column_index) const;

  enum_field_types GetColumnType(const size_t &column_index) const;

  size_t GetRowCount() const;

  bool SeekNextRow();

  bool IsNull(size_t column_index) const;

  bool GetBool(size_t column_index, bool regard_null_as = false) const;

  int64_t GetInt(size_t column_index, int64_t regard_null_as = 0) const;
  int8_t GetInt8(size_t column_index, int8_t regard_null_as = 0) const;
  int16_t GetInt16(size_t column_index, int16_t regard_null_as = 0) const;
  int32_t GetInt32(size_t column_index, int32_t regard_null_as = 0) const;
  int64_t GetInt64(size_t column_index, int64_t regard_null_as = 0) const;

  uint64_t GetUint(size_t column_index, uint64_t regard_null_as = 0) const;
  uint8_t GetUint8(size_t column_index, uint8_t regard_null_as = 0) const;
  uint16_t GetUint16(size_t column_index, uint16_t regard_null_as = 0) const;
  uint32_t GetUint32(size_t column_index, uint32_t regard_null_as = 0) const;
  uint64_t GetUint64(size_t column_index, uint64_t regard_null_as = 0) const;

  float GetFloat(size_t column_index, float regard_null_as = 0.0) const;

  double GetDouble(size_t column_index, double regard_null_as = 0.0) const;

  const char *GetString(size_t column_index) const;

  const char *GetBinary(size_t column_index) const;

  uint64_t GetFieldLength(size_t column_index) const;

  WallClock::Value GetDateTime(
      size_t column_index,
      const WallClock::Value &regard_null_as = WallClock::kEpochClock) const;

  const string GetDateTimeString(
      size_t column_index,
      const string &regard_null_as = "") const;

  WallClock::Duration GetTime(
      size_t column_index,
      const WallClock::Duration &regard_null_as =
          WallClock::kEmptyDuration) const;

  bool GetBool(const string &column_name, bool regard_null_as = false) const;

  int64_t GetInt(const string &column_name, int64_t regard_null_as = 0) const;

  uint64_t GetUint(const string &column_name, uint64_t regard_null_as = 0) const;

  float GetFloat(const string &column_name, float regard_null_as = 0.0) const;

  double GetDouble(const string &column_name, double regard_null_as = 0.0) const;

  const char *GetString(const string &column_name) const;

  const char *GetBinary(const string &column_name) const;

  uint64_t GetFieldLength(const string &column_name) const;

  WallClock::Value GetDateTime(
      const string &column_name,
      const WallClock::Value &regard_null_as = WallClock::kEpochClock) const;

  WallClock::Duration GetTime(
      const string &column_name,
      const WallClock::Duration &regard_null_as =
          WallClock::kEmptyDuration) const;

 private:
  Ptr<Impl> impl_;
};


class MariadbConnection;


class FUNAPI_DLL_VISIBILITY Mariadb {
 public:
  class Impl;

  // Contains mysql errors excluding connection errors.
  // see files below for details.
  //   - /usr/include/mariadb/errmsg.h
  //   - /usr/include/mariadb/mysqld_error.h
  struct FUNAPI_DLL_VISIBILITY Error {
    Error();

    int code;
    string desc;
    string sqlstate;
  };

  typedef function<
      void(const Ptr<ResultSets> &/*result_sets*/,
           const Error &/*error*/)> QueryExecuteHandler;
  typedef function<
      void(size_t /*total*/, size_t /*connected*/,
           const WallClock::Value &/*failure_time*/)> ConnectionFailureHandler;

  static const string kDefaultConnectionCharset;      // ""
  static const bool kDefaultAutoRetryOnDeadlock;      // false
  static const unsigned long kDefaultClientFlags;     // 0
  static const int64_t kDefaultSlowQueryLoggingTime;  // 5000
  static const ConnectionFailureHandler kDefaultConnectionFailureHandler;

  static Ptr<Mariadb> Create(
      const string &address, const string &id, const string &password,
      const string &database, size_t connection_count,
      const string &connection_charset = kDefaultConnectionCharset,
      bool auto_retry_on_deadlock = kDefaultAutoRetryOnDeadlock,
      unsigned long client_flags = kDefaultClientFlags,
      int64_t slow_query_logging_time_in_ms = kDefaultSlowQueryLoggingTime,
      const ConnectionFailureHandler &connection_failure_handler =
          kDefaultConnectionFailureHandler);

  void Initialize();
  void Finalize();

  void ExecuteQuery(const string &query, const QueryExecuteHandler &handler);
  Ptr<ResultSets> ExecuteQuerySync(const string &query, Error *error = NULL);

  Ptr<MariadbConnection> GetExclusiveConnection();

  const string &address() const;
  const string &id() const;
  const string &database() const;

  size_t connection_count() const;
  size_t idle_connection_count() const;
  size_t query_queue_size() const;

 private:
  Mariadb(const string &address, const string &id, const string &password,
          const string &database, size_t connection_count,
          const string &connection_charset, bool auto_retry_on_deadlock,
          unsigned long client_flags, int64_t slow_query_logging_time_in_ms,
          const ConnectionFailureHandler &connection_failure_handler);

  Ptr<Impl> impl_;
};


class FUNAPI_DLL_VISIBILITY MariadbConnection
    : public boost::enable_shared_from_this<MariadbConnection> {
 public:
  DECLARE_CLASS_PTR(MariadbConnection);

  typedef Mariadb::QueryExecuteHandler QueryExecuteHandler;
  typedef Mariadb::Error Error;

  void ExecuteQuery(const string &query, const QueryExecuteHandler &handler);
  Ptr<ResultSets> ExecuteQuerySync(const string &query, Error *error = NULL);

  void Release();

 private:
  class Impl;

  friend class Mariadb::Impl;

  MariadbConnection(const Ptr<Mariadb::Impl> &origin, size_t connection_index);
  Ptr<Impl> GetImpl();

  Ptr<Impl> impl_;
};


FUNAPI_DLL_VISIBILITY
std::ostream &operator<<(std::ostream &stream, const Mariadb::Error &error);

}  // namespace fun

#endif  // INCLUDE_FUNAPI_DATABASE_MARIADB_H_