TableMutator.h

Go to the documentation of this file.

/* -*- c++ -*-
 * Copyright (C) 2007-2015 Hypertable, Inc.
 *
 * This file is part of Hypertable.
 *
 * Hypertable is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; version 3 of the
 * License, or any later version.
 *
 * Hypertable 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 Street, Fifth Floor, Boston, MA
 * 02110-1301, USA.
 */

#ifndef Hypertable_Lib_TableMutator_h
#define Hypertable_Lib_TableMutator_h

#include "Cells.h"
#include "ClientObject.h"
#include "KeySpec.h"
#include "Table.h"
#include "TableMutatorAsync.h"
#include "TableMutatorQueue.h"
#include "TableCallback.h"
#include "RangeLocator.h"
#include "Schema.h"
#include "TableIdentifier.h"

#include <AsyncComm/ConnectionManager.h>

#include <Common/Properties.h>
#include <Common/StringExt.h>
#include <Common/Timer.h>

#include <condition_variable>
#include <iostream>
#include <mutex>

namespace Hypertable {

  class TableMutator : public ClientObject {

  public:
    enum {
      FLAG_NO_LOG_SYNC = Table::MUTATOR_FLAG_NO_LOG_SYNC,
      FLAG_NO_LOG      = Table::MUTATOR_FLAG_NO_LOG
    };

    TableMutator(PropertiesPtr &props, Comm *comm, Table *table,
                     RangeLocatorPtr &range_locator, uint32_t timeout_ms,
                     uint32_t flags = 0);

    virtual ~TableMutator();

    virtual void set(const KeySpec &key, const void *value, uint32_t value_len);

    void set(const KeySpec &key, const char *value) {
      if (value)
        set(key, value, strlen(value));
      else
        set(key, 0, 0);
    }

    void set(const KeySpec &key, const std::string &value) {
      set(key, value.data(), value.length());
    }

    virtual void set_delete(const KeySpec &key);

    virtual void set_cells(const Cells &cells) {
      set_cells(cells.begin(), cells.end());
    }

    virtual void flush();

    virtual bool retry(uint32_t timeout_ms=0);

    virtual bool need_retry() {
      std::lock_guard<std::mutex> lock(m_mutex);
      return (m_failed_mutations.size() > 0);
    }

    virtual uint64_t memory_used() { return m_mutator->memory_used(); }

    uint64_t get_resend_count() { return m_mutator->get_resend_count(); }

    virtual void get_failed(FailedMutations &failed_mutations) {
      std::lock_guard<std::mutex> lock(m_mutex);
      failed_mutations = m_failed_mutations;
    }

    std::ostream &show_failed(const Exception &, std::ostream & = std::cout);

    void update_ok();
    void update_error(int error, FailedMutations &failures);

    int32_t get_last_error() {
      std::lock_guard<std::mutex> lock(m_mutex);
      return m_last_error;
    }

  private:

    void auto_flush();

    friend class TableMutatorAsync;
    void wait_for_flush_completion(TableMutatorAsync *mutator);

    void set_last_error(int32_t error) {
      std::lock_guard<std::mutex> lock(m_mutex);
      m_last_error = error;
    }

    enum Operation {
      SET = 1,
      SET_CELLS,
      SET_DELETE,
      FLUSH
    };

    void save_last(const KeySpec &key, const void *value, size_t value_len) {
      m_last_key = key;
      m_last_value = value;
      m_last_value_len = value_len;
    }

    void save_last(Cells::const_iterator it, Cells::const_iterator end) {
      m_last_cells_it = it;
      m_last_cells_end = end;
    }

    void set_cells(Cells::const_iterator start, Cells::const_iterator end);

    void handle_exceptions();

    void retry_flush();

    std::mutex m_mutex;
    std::mutex m_queue_mutex;
    std::condition_variable m_cond;
    PropertiesPtr m_props;
    Comm                *m_comm;
    TablePtr             m_table;
    SchemaPtr            m_schema;
    RangeLocatorPtr      m_range_locator;
    TableIdentifierManaged m_table_identifier;
    uint64_t             m_memory_used;
    uint64_t             m_max_memory;
    TableCallback m_callback;
    TableMutatorQueuePtr m_queue;
    TableMutatorAsyncPtr m_mutator;
    uint32_t             m_timeout_ms;
    uint32_t             m_flags;
    uint32_t             m_flush_delay;
    int32_t     m_last_error;
    int         m_last_op;
    KeySpec     m_last_key;
    const void *m_last_value;
    uint32_t    m_last_value_len;
    Cells::const_iterator m_last_cells_it;
    Cells::const_iterator m_last_cells_end;
    const static uint32_t ms_max_sync_retries = 5;
    bool       m_refresh_schema;
    bool       m_unflushed_updates;
    FailedMutations m_failed_mutations;
    CellsBuilderPtr m_failed_cells;
  };

  typedef std::shared_ptr<TableMutator> TableMutatorPtr;

}

#endif // Hypertable_Lib_TableMutator_h