Drizzled Public API Documentation

tables.h
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 #pragma once
22 
24 {
25 public:
26 
27  TablesTool();
28 
29  TablesTool(const char *schema_arg, const char *table_arg) :
30  drizzled::plugin::TableFunction(schema_arg, table_arg)
31  { }
32 
33  TablesTool(const char *table_arg) :
34  drizzled::plugin::TableFunction("DATA_DICTIONARY", table_arg)
35  { }
36 
38  {
39  drizzled::generator::AllTables all_tables_generator;
40  drizzled::message::Table table_message;
41 
42  virtual void fill();
43 
44  public:
46 
47  bool nextTable();
48 
49  const std::string &table_name()
50  {
51  return table_message.name();
52  }
53 
54  const drizzled::message::Table& getTableProto()
55  {
56  return table_message;
57  }
58 
59  const drizzled::message::Table& getTableMessage()
60  {
61  return table_message;
62  }
63 
64  bool isTablesPrimed()
65  {
66  return true;
67  }
68 
69  bool populate();
70  };
71 
72  Generator *generator(drizzled::Field **arg)
73  {
74  return new Generator(arg);
75  }
76 
77 };
78 
virtual void fill()
Definition: tables.cc:96