table_replication_applier_status.h

Go to the documentation of this file.

/*
   Copyright (c) 2013, 2024, 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, version 2.0, 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 TABLE_REPLICATION_APPLIER_STATUS_H
#define TABLE_REPLICATION_APPLIER_STATUS_H
 
/**
  @file storage/perfschema/table_replication_applier_status.h
  Table replication_applier_status (declarations).
*/
 
#include <sys/types.h>
 
#include "my_base.h"
#include "sql/rpl_info.h" /*CHANNEL_NAME_LENGTH*/
#include "storage/perfschema/pfs_engine_table.h"
#include "storage/perfschema/table_helper.h"
 
class Field;
class Master_info;
class Plugin_table;
struct TABLE;
struct THR_LOCK;
 
/**
  @addtogroup performance_schema_tables
  @{
*/
 
#ifndef ENUM_RPL_YES_NO
#define ENUM_RPL_YES_NO
/** enum values for Service_State field*/
enum enum_rpl_yes_no { PS_RPL_YES = 1, PS_RPL_NO };
#endif
 
/** A row in the table. */
struct st_row_applier_status {
  char channel_name[CHANNEL_NAME_LENGTH];
  uint channel_name_length;
  enum_rpl_yes_no service_state;
  uint remaining_delay;
  bool remaining_delay_is_set;
  ulong count_transactions_retries;
};
 
class PFS_index_rpl_applier_status : public PFS_engine_index {
 public:
  PFS_index_rpl_applier_status()
      : PFS_engine_index(&m_key), m_key("CHANNEL_NAME") {}
 
  ~PFS_index_rpl_applier_status() override = default;
 
  virtual bool match(Master_info *mi);
 
 private:
  PFS_key_name m_key;
};
 
/** Table PERFORMANCE_SCHEMA.replication_applier_status */
class table_replication_applier_status : public PFS_engine_table {
  typedef PFS_simple_index pos_t;
 
 private:
  int make_row(Master_info *mi);
 
  /** Table share lock. */
  static THR_LOCK m_table_lock;
  /** Table definition. */
  static Plugin_table m_table_def;
 
  /** Current row */
  st_row_applier_status m_row;
  /** Current position. */
  pos_t m_pos;
  /** Next position. */
  pos_t m_next_pos;
 
 protected:
  /**
    Read the current row values.
    @param table            Table handle
    @param buf              row buffer
    @param fields           Table fields
    @param read_all         true if all columns are read.
  */
 
  int read_row_values(TABLE *table, unsigned char *buf, Field **fields,
                      bool read_all) override;
 
  table_replication_applier_status();
 
 public:
  ~table_replication_applier_status() override;
 
  /** Table share. */
  static PFS_engine_table_share m_share;
  static PFS_engine_table *create(PFS_engine_table_share *);
  static ha_rows get_row_count();
 
  void reset_position() override;
 
  int rnd_next() override;
  int rnd_pos(const void *pos) override;
 
  int index_init(uint idx, bool sorted) override;
  int index_next() override;
 
 private:
  PFS_index_rpl_applier_status *m_opened_index;
};
 
/** @} */
#endif