key_field.h

/* -*- mode: c++; c-basic-offset: 2; indent-tabs-mode: nil; -*-
 *  vim:expandtab:shiftwidth=2:tabstop=2:smarttab:
 *
 *  Copyright (C) 2009 Sun Microsystems, Inc.
 *
 *  This program 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 2 of the License.
 *
 *  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
 */

#pragma once

#include <drizzled/sql_select.h>
#include <vector>

namespace drizzled {
namespace optimizer {

class KeyField
{
public:

  KeyField()
    :
      field(NULL),
      val(NULL),
      level(0),
      optimize(0),
      eq_func(false),
      null_rejecting(false),
      cond_guard(NULL)
  {}

  KeyField(Field *in_field,
           Item *in_val,
           uint32_t in_level,
           uint32_t in_optimize,
           bool in_eq_func,
           bool in_null_rejecting,
           bool *in_cond_guard)
    :
      field(in_field),
      val(in_val),
      level(in_level),
      optimize(in_optimize),
      eq_func(in_eq_func),
      null_rejecting(in_null_rejecting),
      cond_guard(in_cond_guard)
  {}

  Field *getField()
  {
    return field;
  }

  void setField(Field *in_field)
  {
    field= in_field;
  }

  Item *getValue()
  {
    return val;
  }

  void setValue(Item *in_val)
  {
    val= in_val;
  }

  uint32_t getLevel() const
  {
    return level;
  }

  void setLevel(uint32_t in_level)
  {
    level= in_level;
  }

  uint32_t getOptimizeFlags() const
  {
    return optimize;
  }

  void setOptimizeFlags(uint32_t in_opt)
  {
    optimize= in_opt;
  }

  bool isEqualityCondition() const
  {
    return eq_func;
  }

  void setEqualityConditionUsed(bool in_val)
  {
    eq_func= in_val;
  }

  bool rejectNullValues() const
  {
    return null_rejecting;
  }

  void setRejectNullValues(bool in_val)
  {
    null_rejecting= in_val;
  }

  bool *getConditionalGuard()
  {
    return cond_guard;
  }

  void setConditionalGuard(bool *in_cond_guard)
  {
    cond_guard= in_cond_guard;
  }

private:

  Field *field;
  Item *val; 
  uint32_t level;
  uint32_t optimize; 
  bool eq_func;
  bool null_rejecting;
  bool *cond_guard; 
};

void add_key_fields(Join *join, 
                    KeyField **key_fields,
                    uint32_t *and_level,
                    COND *cond,
                    table_map usable_tables,
                    std::vector<SargableParam> &sargables);

void add_key_part(DYNAMIC_ARRAY *keyuse_array, KeyField *key_field);

void add_key_fields_for_nj(Join *join,
                           TableList *nested_join_table,
                           KeyField **end,
                           uint32_t *and_level,
                           std::vector<SargableParam> &sargables);

KeyField *merge_key_fields(KeyField *start,
                            KeyField *new_fields,
                            KeyField *end, 
                            uint32_t and_level);

void add_key_field(KeyField **key_fields,
                   uint32_t and_level,
                   Item_func *cond,
                   Field *field,
                   bool eq_func,
                   Item **value,
                   uint32_t num_values,
                   table_map usable_tables,
                   std::vector<SargableParam> &sargables);

void add_key_equal_fields(KeyField **key_fields,
                          uint32_t and_level,
                          Item_func *cond,
                          Item_field *field_item,
                          bool eq_func,
                          Item **val,
                          uint32_t num_values,
                          table_map usable_tables,
                          std::vector<SargableParam> &sargables);

} /* end namespace optimizer */

} /* end namespace drizzled */