Drizzled Public API Documentation

engine.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 Brian Aker
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 
23 #include <drizzled/catalog/engine.h>
24 #include <drizzled/catalog/local.h>
25 
26 namespace plugin {
27 namespace catalog {
28 
30 {
31 public:
32  bool create(const drizzled::identifier::Catalog &identifier, drizzled::message::catalog::shared_ptr &);
33  bool drop(const drizzled::identifier::Catalog &identifier);
34 
35  bool exist(const drizzled::identifier::Catalog &identifier)
36  {
37  return drizzled::catalog::local_identifier() == identifier;
38  }
39 
40  void getIdentifiers(drizzled::identifier::catalog::vector &identifiers)
41  {
42  identifiers.push_back(drizzled::catalog::local_identifier());
43  }
44 
45  drizzled::message::catalog::shared_ptr getMessage(const drizzled::identifier::Catalog& identifier);
46 
47  void getMessages(drizzled::message::catalog::vector &messages);
48 
49 private:
50  drizzled::message::catalog::shared_ptr readFile(const drizzled::identifier::Catalog& identifier);
51  bool writeFile(const drizzled::identifier::Catalog &identifier, drizzled::message::catalog::shared_ptr &message);
52  void prime(drizzled::message::catalog::vector &messages);
53 
54 };
55 
56 } /* namespace catalog */
57 } /* namespace plugin */
58