← Back to branch summary

~drizzle-trunk/drizzle/development

« back to all changes in this revision

Viewing changes to drizzled/index_hint.h

  • Committer: Brian Aker
  • Date: 2009-12-29 01:38:38 UTC
  • mfrom: (1251.1.1 drizzle)
  • Revision ID: brian@gaz-20091229013838-03kb2z5xbqw03ddt
Merge of Diego fix.

Show diffs side-by-side

added added

removed removed

Lines of Context:
drizzled/index_hint.h
 
1
/* - mode: c; c-basic-offset: 2; indent-tabs-mode: nil; -*-
 
2
 *  vim:expandtab:shiftwidth=2:tabstop=2:smarttab:
 
3
 *
 
4
 *  Copyright (C) 2008-2009 Sun Microsystems
 
5
 *
 
6
 *  This program is free software; you can redistribute it and/or modify
 
7
 *  it under the terms of the GNU General Public License as published by
 
8
 *  the Free Software Foundation; either version 2 of the License, or
 
9
 *  (at your option) any later version.
 
10
 *
 
11
 *  This program is distributed in the hope that it will be useful,
 
12
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 
13
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
14
 *  GNU General Public License for more details.
 
15
 *
 
16
 *  You should have received a copy of the GNU General Public License
 
17
 *  along with this program; if not, write to the Free Software
 
18
 *  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 
19
 */
 
20
 
 
21
/**
 
22
 * @file
 
23
 *
 
24
 * Defines the API for index hints
 
25
 */
 
26
 
 
27
#ifndef DRIZZLED_INDEX_HINT_H
 
28
#define DRIZZLED_INDEX_HINT_H
 
29
 
 
30
/*
 
31
  String names used to print a statement with index hints.
 
32
  Keep in sync with index_hint_type.
 
33
*/
 
34
extern const char * index_hint_type_name[];
 
35
typedef unsigned char index_clause_map;
 
36
 
 
37
enum index_hint_type
 
38
{
 
39
  INDEX_HINT_IGNORE,
 
40
  INDEX_HINT_USE,
 
41
  INDEX_HINT_FORCE
 
42
};
 
43
 
 
44
/*
 
45
  Bits in index_clause_map : one for each possible FOR clause in
 
46
  USE/FORCE/IGNORE INDEX index hint specification
 
47
*/
 
48
#define INDEX_HINT_MASK_JOIN  (1)
 
49
#define INDEX_HINT_MASK_GROUP (1 << 1)
 
50
#define INDEX_HINT_MASK_ORDER (1 << 2)
 
51
 
 
52
#define INDEX_HINT_MASK_ALL (INDEX_HINT_MASK_JOIN | INDEX_HINT_MASK_GROUP | \
 
53
                             INDEX_HINT_MASK_ORDER)
 
54
 
 
55
/* Single element of an USE/FORCE/IGNORE INDEX list specified as a SQL hint  */
 
56
class Index_hint : public drizzled::memory::SqlAlloc
 
57
{
 
58
public:
 
59
  /* The type of the hint : USE/FORCE/IGNORE */
 
60
  enum index_hint_type type;
 
61
  /* Where the hit applies to. A bitmask of INDEX_HINT_MASK_<place> values */
 
62
  index_clause_map clause;
 
63
  /*
 
64
    The index name. Empty (str=NULL) name represents an empty list
 
65
    USE INDEX () clause
 
66
  */
 
67
  LEX_STRING key_name;
 
68
 
 
69
  Index_hint (enum index_hint_type type_arg, index_clause_map clause_arg,
 
70
              char *str, uint32_t length) :
 
71
    type(type_arg), clause(clause_arg)
 
72
  {
 
73
    key_name.str= str;
 
74
    key_name.length= length;
 
75
  }
 
76
 
 
77
  void print(Session *session, String *str);
 
78
};
 
79
 
 
80
#endif /* DRIZZLED_INDEX_HINT_H */