handler_db_object_table.h

Go to the documentation of this file.

/*
  Copyright (c) 2021, 2025, Oracle and/or its affiliates.
 
  This program is free software; you can redistribute it and/or modify
  it under the terms of the GNU General Public License, version 2.0,
  as published by the Free Software Foundation.
 
  This program is designed to work with certain software (including
  but not limited to OpenSSL) that is licensed under separate terms,
  as designated in a particular file or component or in included license
  documentation.  The authors of MySQL hereby grant you an additional
  permission to link the program and your derivative works with the
  separately licensed software that they have either included with
  the program or referenced in the documentation.
 
  This program is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.
 
  You should have received a copy of the GNU General Public License
  along with this program; if not, write to the Free Software
  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
*/
 
#ifndef ROUTER_SRC_REST_MRS_SRC_MRS_ENDPOINT_HANDLER_HANDLER_DB_OBJECT_TABLE_H_
#define ROUTER_SRC_REST_MRS_SRC_MRS_ENDPOINT_HANDLER_HANDLER_DB_OBJECT_TABLE_H_
 
#include <memory>
#include <optional>
#include <string>
#include <vector>
 
#include "collector/mysql_cache_manager.h"
#include "mrs/database/entry/db_object.h"
#include "mrs/database/entry/db_schema.h"
#include "mrs/database/entry/db_service.h"
#include "mrs/database/helper/object_row_ownership.h"
#include "mrs/database/slow_query_monitor.h"
#include "mrs/endpoint/db_object_endpoint.h"
#include "mrs/gtid_manager.h"
#include "mrs/rest/handler.h"
#include "mrs/rest/response_cache.h"
 
namespace mrs {
namespace endpoint {
namespace handler {
 
class HandlerDbObjectTable : public mrs::rest::Handler {
 public:
  using DbObject = mrs::database::entry::DbObject;
  using DbSchema = mrs::database::entry::DbSchema;
  using DbService = mrs::database::entry::DbService;
  using DbObjectPtr = std::shared_ptr<DbObject>;
  using DbSchemaPtr = std::shared_ptr<DbSchema>;
  using DbServicePtr = std::shared_ptr<DbService>;
  using DbObjectEndpoint = mrs::endpoint::DbObjectEndpoint;
  using EndpointResponseCachePtr =
      std::shared_ptr<mrs::ItemEndpointResponseCache>;
  using CachedSession = collector::MysqlCacheManager::CachedObject;
 
 public:
  HandlerDbObjectTable(std::weak_ptr<DbObjectEndpoint> endpoint,
                       mrs::interface::AuthorizeManager *auth_manager,
                       mrs::GtidManager *gtid_manager = nullptr,
                       collector::MysqlCacheManager *cache = nullptr,
                       mrs::ResponseCache *response_cache = nullptr,
                       mrs::database::SlowQueryMonitor *slow_monitor = nullptr);
 
  Authorization requires_authentication() const override;
  UniversalId get_service_id() const override;
  UniversalId get_db_object_id() const override;
  UniversalId get_schema_id() const override;
  const std::string &get_service_path() const override;
  const std::string &get_db_object_path() const override;
  const std::string &get_schema_path() const override;
 
  void authorization(rest::RequestContext *ctxt) override;
 
  HttpResult handle_get(rest::RequestContext *ctxt) override;
  HttpResult handle_post(rest::RequestContext *ctxt,
                         const std::vector<uint8_t> &document) override;
  HttpResult handle_delete(rest::RequestContext *ctxt) override;
  HttpResult handle_put(rest::RequestContext *ctxt) override;
 
  uint32_t get_access_rights() const override;
 
 protected:
  CachedSession get_session(
      rest::RequestContext *ctxt,
      collector::MySQLConnection type =
          collector::MySQLConnection::kMySQLConnectionUserdataRO);
 
  uint64_t get_items_on_page() const;
  mrs::database::ObjectRowOwnership row_ownership_info(
      rest::RequestContext *ctxt,
      std::shared_ptr<database::entry::Object> object) const;
 
  uint64_t slow_query_timeout() const;
 
  mrs::GtidManager *gtid_manager_;
  collector::MysqlCacheManager *cache_;
  std::weak_ptr<DbObjectEndpoint> endpoint_;
  DbObjectPtr entry_;
  DbSchemaPtr schema_entry_;
  DbServicePtr service_entry_;
  mrs::database::entry::RowUserOwnership ownership_;
  EndpointResponseCachePtr response_cache_;
  mrs::database::SlowQueryMonitor *slow_monitor_;
  bool passthrough_db_user_{false};
};
 
}  // namespace handler
}  // namespace endpoint
}  // namespace mrs
 
#endif  // ROUTER_SRC_REST_MRS_SRC_MRS_ENDPOINT_HANDLER_HANDLER_DB_OBJECT_TABLE_H_