Drizzled Public API Documentation

index_hint.cc
Go to the documentation of this file.
1 /* - mode: c; c-basic-offset: 2; indent-tabs-mode: nil; -*-
2  * vim:expandtab:shiftwidth=2:tabstop=2:smarttab:
3  *
4  * Copyright (C) 2008 Sun Microsystems, Inc.
5  *
6  * Authors:
7  *
8  * Jay Pipes <jay.pipes@sun.com>
9  *
10  * This program is free software; you can redistribute it and/or modify
11  * it under the terms of the GNU General Public License as published by
12  * the Free Software Foundation; either version 2 of the License, or
13  * (at your option) any later version.
14  *
15  * This program is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18  * GNU General Public License for more details.
19  *
20  * You should have received a copy of the GNU General Public License
21  * along with this program; if not, write to the Free Software
22  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
23  */
24 
30 #include <config.h>
31 #include <drizzled/sql_string.h>
32 #include <drizzled/session.h>
33 #include <drizzled/index_hint.h>
34 #include <drizzled/sql_table.h>
35 
36 namespace drizzled {
37 
38 /*
39  * Names of the index hints (for error messages). Keep in sync with
40  * index_hint_type
41  */
42 const char *index_hint_type_name[] =
43 {
44  "IGNORE INDEX"
45 , "USE INDEX"
46 , "FORCE INDEX"
47 };
48 
57 void Index_hint::print(String& str) const
58 {
59  str.append(STRING_WITH_LEN(index_hint_type_name[type]));
60  str.append(STRING_WITH_LEN(" ("));
61  if (*key_name)
62  {
63  if (is_primary_key(key_name))
64  {
65  str.append(str_ref(key_name));
66  }
67  else
68  {
69  str.append_identifier(str_ref(key_name));
70  }
71  }
72  str.append(')');
73 }
74 
75 } /* namespace drizzled */