Drizzled Public API Documentation

foreign_keys.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 ForeignKeysTool : public drizzled::plugin::TableFunction
00024 {
00025 public:
00026 
00027   ForeignKeysTool();
00028 
00029   ForeignKeysTool(const char *schema_arg, const char *table_arg) :
00030     drizzled::plugin::TableFunction(schema_arg, table_arg)
00031   { }
00032 
00033   ForeignKeysTool(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     drizzled::message::Table::ForeignKeyConstraint fkey;
00042     int keyPos;
00043     bool firstFill;
00044 
00045     virtual void fill();
00046 
00047   public:
00048     Generator(drizzled::Field **arg);
00049     
00050     bool nextTable();
00051     bool fillFkey();
00052 
00053     const std::string &table_name()
00054     {
00055       return table_message.name();
00056     }
00057 
00058     const drizzled::message::Table& getTableProto()
00059     {
00060       return table_message;
00061     }
00062 
00063     const drizzled::message::Table& getTableMessage()
00064     {
00065       return table_message;
00066     }
00067 
00068     bool isTablesPrimed()
00069     {
00070       return true;
00071     }
00072 
00073     bool populate();
00074 
00075   };
00076 
00077   Generator *generator(drizzled::Field **arg)
00078   {
00079     return new Generator(arg);
00080   }
00081 };
00082