ScanSpec.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_ScanSpec_h
#define Hypertable_Lib_ScanSpec_h

#include <Hypertable/Lib/CellInterval.h>
#include <Hypertable/Lib/ColumnPredicate.h>
#include <Hypertable/Lib/Key.h>
#include <Hypertable/Lib/RowInterval.h>
#include <Hypertable/Lib/TableParts.h>

#include <Common/PageArenaAllocator.h>
#include <Common/Serializable.h>

#include <boost/noncopyable.hpp>

#include <vector>

namespace Hypertable {
namespace Lib {

  using namespace std;

  typedef PageArenaAllocator<RowInterval> RowIntervalAlloc;
  typedef vector<RowInterval, RowIntervalAlloc> RowIntervals;

  typedef PageArenaAllocator<CellInterval> CellIntervalAlloc;
  typedef vector<CellInterval, CellIntervalAlloc> CellIntervals;

  typedef PageArenaAllocator<const char *> CstrAlloc;
  typedef vector<const char *, CstrAlloc> CstrColumns;

  typedef PageArenaAllocator<ColumnPredicate> ColumnPredicateAlloc;
  typedef vector<ColumnPredicate, ColumnPredicateAlloc> ColumnPredicates;

  class ScanSpec : public Serializable {
  public:
    ScanSpec() : time_interval(TIMESTAMP_MIN, TIMESTAMP_MAX) { }
    ScanSpec(CharArena &arena)
      : columns(CstrAlloc(arena)),
        row_intervals(RowIntervalAlloc(arena)),
        cell_intervals(CellIntervalAlloc(arena)),
        column_predicates(ColumnPredicateAlloc(arena)),
        time_interval(TIMESTAMP_MIN, TIMESTAMP_MAX) { }
    ScanSpec(CharArena &arena, const ScanSpec &);
    ScanSpec(const uint8_t **bufp, size_t *remainp) { decode(bufp, remainp); }

    const string render_hql(const string &table) const;

    void clear() {
      row_limit = 0;
      cell_limit = 0;
      cell_limit_per_family = 0;
      row_offset = 0;
      cell_offset = 0;
      max_versions = 0;
      columns.clear();
      row_intervals.clear();
      cell_intervals.clear();
      column_predicates.clear();
      time_interval.first = TIMESTAMP_MIN;
      time_interval.second = TIMESTAMP_MAX;
      rebuild_indices.clear();
      keys_only = false;
      return_deletes = false;
      row_regexp = 0;
      value_regexp = 0;
      scan_and_filter_rows = false;
      do_not_cache = false;
      and_column_predicates = false;
    }

    void base_copy(ScanSpec &other) const {
      other.row_limit = row_limit;
      other.cell_limit = cell_limit;
      other.cell_limit_per_family = cell_limit_per_family;
      other.row_offset = row_offset;
      other.cell_offset = cell_offset;
      other.max_versions = max_versions;
      other.columns = columns;
      other.time_interval = time_interval;
      other.keys_only = keys_only;
      other.return_deletes = return_deletes;
      other.row_intervals.clear();
      other.cell_intervals.clear();
      other.column_predicates.clear();
      other.row_regexp = row_regexp;
      other.value_regexp = value_regexp;
      other.scan_and_filter_rows = scan_and_filter_rows;
      other.do_not_cache = do_not_cache;
      other.column_predicates = column_predicates;
      other.and_column_predicates = and_column_predicates;
      other.rebuild_indices = rebuild_indices;
    }

    bool cacheable() const {
      if (do_not_cache || rebuild_indices)
        return false;
      else if (row_intervals.size() == 1) {
        HT_ASSERT(row_intervals[0].start && row_intervals[0].end);
        if (!strcmp(row_intervals[0].start, row_intervals[0].end))
          return true;
      }
      else if (cell_intervals.size() == 1) {
        HT_ASSERT(cell_intervals[0].start_row && cell_intervals[0].end_row);
        if (!strcmp(cell_intervals[0].start_row, cell_intervals[0].end_row))
          return true;
      }
      return false;
    }

    const char *cache_key() const {
      if (!row_intervals.empty())
        return row_intervals[0].start;
      else if (!cell_intervals.empty())
        return cell_intervals[0].start_row;
      HT_ASSERT(!"cache key not found");
      return 0;
    }

    void add_column(CharArena &arena, const string &str) {
      columns.push_back(arena.dup(str));
    }

    static void parse_column(const char *column_str, string &family, 
                             const char **qualifier, size_t *qualifier_len,
                             bool *has_qualifier, bool *is_regexp,
                             bool *is_prefix);

    void add_row(CharArena &arena, const string &str) {
      if (cell_intervals.size())
        HT_THROW(Error::BAD_SCAN_SPEC, "cell spec excludes rows");

      RowInterval ri;
      ri.start = ri.end = arena.dup(str);
      ri.start_inclusive = ri.end_inclusive = true;
      row_intervals.push_back(ri);
    }

    void set_row_regexp(CharArena &arena, const char *regexp) {
      if (row_regexp != 0)
        HT_THROWF(Error::BAD_SCAN_SPEC, "row_regexp already set to '%s'", row_regexp);
      row_regexp = arena.dup(regexp);
    }

    void set_value_regexp(CharArena &arena, const char *regexp) {
      if (value_regexp != 0)
        HT_THROWF(Error::BAD_SCAN_SPEC, "value_regexp already set to '%s'", value_regexp);
      value_regexp = arena.dup(regexp);
    }

    void add_row_interval(CharArena &arena,
                          const string &start, bool start_inclusive,
                          const string &end, bool end_inclusive) {
      if (cell_intervals.size())
        HT_THROW(Error::BAD_SCAN_SPEC, "cell spec excludes rows");

      RowInterval ri;
      ri.start = arena.dup(start);
      ri.start_inclusive = start_inclusive;
      ri.end = !end.empty() ? arena.dup(end) : Key::END_ROW_MARKER;
      ri.end_inclusive = end_inclusive;
      row_intervals.push_back(ri);
    }

    void add_cell(CharArena &arena, const string &row, const string &column) {
      if (row_intervals.size())
        HT_THROW(Error::BAD_SCAN_SPEC, "row spec excludes cells");

      CellInterval ci;
      ci.start_row = ci.end_row = arena.dup(row);
      ci.start_column = ci.end_column = arena.dup(column);
      ci.start_inclusive = ci.end_inclusive = true;
      cell_intervals.push_back(ci);
    }

    void add_cell_interval(CharArena &arena,
                           const string &start_row, const string &start_column,
                           bool start_inclusive, const string &end_row,
                           const string &end_column, bool end_inclusive) {
      if (row_intervals.size())
        HT_THROW(Error::BAD_SCAN_SPEC, "row spec excludes cells");

      CellInterval ci;
      ci.start_row = arena.dup(start_row);
      ci.start_column = arena.dup(start_column);
      ci.start_inclusive = start_inclusive;
      ci.end_row = !end_row.empty() ? arena.dup(end_row) : Key::END_ROW_MARKER;
      ci.end_column = arena.dup(end_column);
      ci.end_inclusive = end_inclusive;
      cell_intervals.push_back(ci);
    }

    void add_column_predicate(CharArena &arena, const string &column_family,
                              const char *column_qualifier, uint32_t operation,
                              const char *value, uint32_t value_len = 0) {

      // As soon as we're building with C++11 and can replace the bitset<32> in
      // the CellPredicate class with bitset<64>, then we should change the
      // following expression to check for size of 64
      if (column_predicates.size() == 32)
        HT_THROW(Error::FAILED_EXPECTATION, "Column predicate limit of 32 has been exceeded!");

      ColumnPredicate cp;
      cp.column_family = arena.dup(column_family);
      cp.column_qualifier = arena.dup(column_qualifier);
      cp.column_qualifier_len = column_qualifier ? strlen(column_qualifier) : 0;
      cp.operation = operation;
      if (value) {
        // if value_len have not been specified assume zero terminating string
        cp.value_len = value_len ? value_len : strlen(value);
        cp.value = arena.dup(value, value_len ? value_len : cp.value_len + 1);
      }
      column_predicates.push_back(cp);
    }

    void set_time_interval(int64_t start, int64_t end) {
      time_interval.first = start;
      time_interval.second = end;
    }

    void set_start_time(int64_t start) {
      time_interval.first = start;
    }

    void set_end_time(int64_t end) {
      time_interval.second = end;
    }

    int32_t row_limit {};
    int32_t cell_limit {};
    int32_t cell_limit_per_family {};
    int32_t row_offset {};
    int32_t cell_offset {};
    uint32_t max_versions {};
    CstrColumns columns;
    RowIntervals row_intervals;
    CellIntervals cell_intervals;
    ColumnPredicates column_predicates;
    pair<int64_t,int64_t> time_interval;
    const char *row_regexp {};
    const char *value_regexp {};
    bool return_deletes {};
    bool keys_only {};
    bool scan_and_filter_rows {};
    bool do_not_cache {};
    bool and_column_predicates {};
    TableParts rebuild_indices;

  private:

    uint8_t encoding_version() const override;

    size_t encoded_length_internal() const override;

    void encode_internal(uint8_t **bufp) const override;

    void decode_internal(uint8_t version, const uint8_t **bufp,
                         size_t *remainp) override;

  };

  class ScanSpecBuilder : boost::noncopyable {
  public:

    ScanSpecBuilder(size_t page_size=8192) :
      m_arena(page_size), m_scan_spec(m_arena) { }

    ScanSpecBuilder(const ScanSpec &ss, size_t page_size=8192) :
      m_arena(page_size), m_scan_spec(m_arena, ss) {}

    ScanSpecBuilder &operator=(const ScanSpec &ss) {
      m_scan_spec = ScanSpec(m_arena, ss);
      return *this;
    }

    void set_row_limit(int32_t n) { m_scan_spec.row_limit = n; }

    void set_cell_limit(int32_t n) { m_scan_spec.cell_limit = n; }

    void set_cell_limit_per_family(int32_t n) { m_scan_spec.cell_limit_per_family = n; }

    void set_row_offset(int32_t n) { 
      if (n && m_scan_spec.cell_offset)
        HT_THROW(Error::BAD_SCAN_SPEC, "predicate row_offset not allowed in "
                 "combination with cell_offset");
      m_scan_spec.row_offset = n; 
    }

    void set_cell_offset(int32_t n) { 
      if (n && m_scan_spec.row_offset)
        HT_THROW(Error::BAD_SCAN_SPEC, "predicate cell_offset not allowed in "
                 "combination with row_offset");
      m_scan_spec.cell_offset = n; 
    }

    void set_max_versions(uint32_t n) { m_scan_spec.max_versions = n; }

    void set_row_regexp(const char* regexp) { m_scan_spec.set_row_regexp(m_arena, regexp); }

    void set_value_regexp(const char* regexp) { m_scan_spec.set_value_regexp(m_arena, regexp); }

    void add_column(const string &str) {
      m_scan_spec.add_column(m_arena, str);
    }

    void reserve_columns(size_t s) { m_scan_spec.columns.reserve(s); }

    void
    add_column_predicate(const string &column_family, const char *column_qualifier,
                         uint32_t operation,  const char *value,
                         uint32_t value_len = 0) {
      m_scan_spec.add_column_predicate(m_arena, column_family, column_qualifier,
                                       operation, value, value_len);
    }

    void reserve_column_predicates(size_t s) { m_scan_spec.column_predicates.reserve(s); }


    void add_row(const string &str) {
      m_scan_spec.add_row(m_arena, str);
    }

    void reserve_rows(size_t s) { m_scan_spec.row_intervals.reserve(s); }

    void add_row_interval(const string &start, bool start_inclusive,
                          const string &end, bool end_inclusive) {
      m_scan_spec.add_row_interval(m_arena, start, start_inclusive,
                                   end, end_inclusive);
    }

    void add_cell(const string &row, const string &column) {
      m_scan_spec.add_cell(m_arena, row, column);
    }

    void reserve_cells(size_t s) { m_scan_spec.cell_intervals.reserve(s); }

    void add_cell_interval(const string &start_row, const string &start_column,
                           bool start_inclusive, const string &end_row,
                           const string &end_column, bool end_inclusive) {
      m_scan_spec.add_cell_interval(m_arena, start_row, start_column,
                                    start_inclusive, end_row, end_column, end_inclusive);
    }

    void set_time_interval(int64_t start, int64_t end) {
      m_scan_spec.set_time_interval(start, end);
    }

    void set_start_time(int64_t start) {
      m_scan_spec.time_interval.first = start;
    }

    void set_end_time(int64_t end) {
      m_scan_spec.time_interval.second = end;
    }

    void set_keys_only(bool val) {
      m_scan_spec.keys_only = val;
    }

    void set_return_deletes(bool val) {
      m_scan_spec.return_deletes = val;
    }

    void set_scan_and_filter_rows(bool val) {
      m_scan_spec.scan_and_filter_rows = val;
    }

    void set_do_not_cache(bool val) {
      m_scan_spec.do_not_cache = val;
    }

    void set_rebuild_indices(TableParts parts) {
      m_scan_spec.rebuild_indices = parts;
    }

    void set_and_column_predicates(bool val) {
      m_scan_spec.and_column_predicates = val;
    }

    void clear() {
      m_scan_spec.clear();
      // Don't call m_arena.free() here, as for stl containers (vector etc.),
      // clear() assumes underlying storage is still intact!
    }

    ScanSpec &get() { return m_scan_spec; }

  private:
    CharArena m_arena;
    ScanSpec m_scan_spec;
  };

  ostream &operator<<(ostream &os, const ScanSpec &scan_spec);

}}

#endif // Hypertable_Lib_ScanSpec_h