Drizzled Public API Documentation

indexes.cc
1 /* - mode: c; c-basic-offset: 2; indent-tabs-mode: nil; -*-
2  * vim:expandtab:shiftwidth=2:tabstop=2:smarttab:
3  *
4  * Copyright (C) 2010 Sun Microsystems, Inc.
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 #include <config.h>
22 #include <plugin/schema_dictionary/dictionary.h>
23 
24 using namespace std;
25 using namespace drizzled;
26 
27 IndexesTool::IndexesTool() :
28  TablesTool("INDEXES")
29 {
30  add_field("TABLE_SCHEMA", plugin::TableFunction::STRING, MAXIMUM_IDENTIFIER_LENGTH, false);
31  add_field("TABLE_NAME", plugin::TableFunction::STRING, MAXIMUM_IDENTIFIER_LENGTH, false);
32  add_field("INDEX_NAME", plugin::TableFunction::STRING, MAXIMUM_IDENTIFIER_LENGTH, false);
33  add_field("IS_USED_IN_PRIMARY", plugin::TableFunction::BOOLEAN, 0, false);
34  add_field("IS_UNIQUE", plugin::TableFunction::BOOLEAN, 0, false);
35  add_field("IS_NULLABLE", plugin::TableFunction::BOOLEAN, 0, false);
36  add_field("KEY_LENGTH", plugin::TableFunction::NUMBER, 0, false);
37  add_field("INDEX_TYPE");
38  add_field("INDEX_COMMENT", plugin::TableFunction::STRING, 1024, true);
39 }
40 
41 IndexesTool::Generator::Generator(Field **arg) :
42  TablesTool::Generator(arg),
43  index_iterator(0),
44  is_index_primed(false)
45 {
46 }
47 
48 bool IndexesTool::Generator::nextIndexCore()
49 {
50  if (isIndexesPrimed())
51  {
52  index_iterator++;
53  }
54  else
55  {
56  if (not isTablesPrimed())
57  return false;
58 
59  index_iterator= 0;
60  is_index_primed= true;
61  }
62 
63  if (index_iterator >= getTableProto().indexes_size())
64  return false;
65 
66  index= getTableProto().indexes(index_iterator);
67 
68  return true;
69 }
70 
71 bool IndexesTool::Generator::nextIndex()
72 {
73  while (not nextIndexCore())
74  {
75  if (not nextTable())
76  return false;
77  is_index_primed= false;
78  }
79 
80  return true;
81 }
82 
83 bool IndexesTool::Generator::populate()
84 {
85  if (not nextIndex())
86  return false;
87 
88  fill();
89 
90  return true;
91 }
92 
93 void IndexesTool::Generator::fill()
94 {
95  /* TABLE_SCHEMA */
96  push(getTableProto().schema());
97 
98  /* TABLE_NAME */
99  push(getTableProto().name());
100 
101  /* INDEX_NAME */
102  push(index.name());
103 
104  /* IS_USED_IN_PRIMARY */
105  push(index.is_primary());
106 
107  /* IS_UNIQUE */
108  push(index.is_unique());
109 
110  /* IS_NULLABLE */
111  push(index.options().null_part_key());
112 
113  /* KEY_LENGTH */
114  push(static_cast<uint64_t>(index.key_length()));
115 
116  /* INDEX_TYPE */
117  push(message::type(index.type()));
118 
119  /* "INDEX_COMMENT" */
120  if (index.has_comment())
121  {
122  push(index.comment());
123  }
124  else
125  {
126  push();
127  }
128 }