Drizzled Public API Documentation

tables.h
00001 /* - mode: c; c-basic-offset: 2; indent-tabs-mode: nil; -*-
00002  *  vim:expandtab:shiftwidth=2:tabstop=2:smarttab:
00003  *
00004  *  Copyright (C) 2010 Sun Microsystems, Inc.
00005  *
00006  *  This program is free software; you can redistribute it and/or modify
00007  *  it under the terms of the GNU General Public License as published by
00008  *  the Free Software Foundation; either version 2 of the License, or
00009  *  (at your option) any later version.
00010  *
00011  *  This program is distributed in the hope that it will be useful,
00012  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
00013  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00014  *  GNU General Public License for more details.
00015  *
00016  *  You should have received a copy of the GNU General Public License
00017  *  along with this program; if not, write to the Free Software
00018  *  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
00019  */
00020 
00021 #pragma once
00022 
00023 class TablesTool : public drizzled::plugin::TableFunction
00024 {
00025 public:
00026 
00027   TablesTool();
00028 
00029   TablesTool(const char *schema_arg, const char *table_arg) :
00030     drizzled::plugin::TableFunction(schema_arg, table_arg)
00031   { }
00032 
00033   TablesTool(const char *table_arg) :
00034     drizzled::plugin::TableFunction("DATA_DICTIONARY", table_arg)
00035   { }
00036 
00037   class Generator : public drizzled::plugin::TableFunction::Generator 
00038   {
00039     drizzled::generator::AllTables all_tables_generator;
00040     drizzled::message::Table table_message;
00041 
00042     virtual void fill();
00043 
00044   public:
00045     Generator(drizzled::Field **arg);
00046 
00047     bool nextTable();
00048 
00049     const std::string &table_name()
00050     {
00051       return table_message.name();
00052     }
00053 
00054     const drizzled::message::Table& getTableProto()
00055     {
00056       return table_message;
00057     }
00058 
00059     const drizzled::message::Table& getTableMessage()
00060     {
00061       return table_message;
00062     }
00063 
00064     bool isTablesPrimed()
00065     {
00066       return true;
00067     }
00068 
00069     bool populate();
00070   };
00071 
00072   Generator *generator(drizzled::Field **arg)
00073   {
00074     return new Generator(arg);
00075   }
00076 
00077 };
00078