← Back to branch summary

~drizzle-trunk/drizzle/development

« back to all changes in this revision

Viewing changes to drizzled/plugin/query_rewrite.h

Reverted 1103

Show diffs side-by-side

added added

removed removed

Lines of Context:
drizzled/plugin/query_rewrite.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 Padraig O'Sullivan
5
 
 *
6
 
 *  Authors:
7
 
 *
8
 
 *    Padraig O'Sullivan <posullivan@akibainc.com>
9
 
 *
10
 
 *  This program is free software; you can redistribute it and/or modify
11
 
 *  it under the terms of the GNU General Public License as published by
12
 
 *  the Free Software Foundation; version 2 of the License.
13
 
 *
14
 
 *  This program is distributed in the hope that it will be useful,
15
 
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
16
 
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17
 
 *  GNU General Public License for more details.
18
 
 *
19
 
 *  You should have received a copy of the GNU General Public License
20
 
 *  along with this program; if not, write to the Free Software
21
 
 *  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
22
 
 */
23
 
 
24
 
#ifndef DRIZZLED_PLUGIN_QUERY_REWRITE_H
25
 
#define DRIZZLED_PLUGIN_QUERY_REWRITE_H
26
 
 
27
 
#include "drizzled/atomics.h"
28
 
#include "drizzled/plugin/plugin.h"
29
 
 
30
 
#include "drizzled/visibility.h"
31
 
 
32
 
/**
33
 
 * @file Defines the API for a QueryRewriter.  
34
 
 */
35
 
 
36
 
namespace drizzled
37
 
{
38
 
 
39
 
namespace plugin
40
 
{
41
 
 
42
 
/**
43
 
 * Class which rewrites queries
44
 
 */
45
 
class DRIZZLED_API QueryRewriter : public Plugin
46
 
{
47
 
 
48
 
public:
49
 
 
50
 
  explicit QueryRewriter(std::string name_arg)
51
 
    : 
52
 
      Plugin(name_arg, "QueryRewriter")
53
 
  {}
54
 
 
55
 
  virtual ~QueryRewriter() {}
56
 
 
57
 
  /**
58
 
   * Rewrite a query in the form of a std::string
59
 
   *
60
 
   * @param[in] schema the schema the current session is in
61
 
   * @param[out] to_rewrite string representing the query to rewrite
62
 
   */
63
 
  virtual void rewrite(const std::string &schema, std::string &to_rewrite)= 0; 
64
 
 
65
 
  static bool addPlugin(QueryRewriter *in_rewriter);
66
 
  static void removePlugin(QueryRewriter *in_rewriter);
67
 
 
68
 
  /**
69
 
   * Take a query to be rewritten and go through all the rewriters that are registered as plugins
70
 
   * and let the enabled ones rewrite they query.
71
 
   * TODO: does it make sense to have multiple rewriters?
72
 
   *
73
 
   * @param[in] schema the schema the current session is
74
 
   * @param[out] to_rewrite the query to rewrite
75
 
   */
76
 
  static void rewriteQuery(const std::string &schema, std::string &to_rewrite);
77
 
 
78
 
private:
79
 
 
80
 
  QueryRewriter();
81
 
  QueryRewriter(const QueryRewriter&);
82
 
  QueryRewriter& operator=(const QueryRewriter&);
83
 
 
84
 
 
85
 
};
86
 
 
87
 
} /* namespace plugin */
88
 
 
89
 
} /* namespace drizzled */
90
 
 
91
 
#endif /* DRIZZLED_PLUGIN_QUERY_REWRITE_H */