← Back to branch summary

~drizzle-trunk/drizzle/development

« back to all changes in this revision

Viewing changes to drizzled/plugin/query_rewrite.h

  • Committer: Daniel Nichter
  • Date: 2011-10-23 16:01:37 UTC
  • mto: This revision was merged to the branch mainline in revision 2448.
  • Revision ID: daniel@percona.com-20111023160137-7ac3blgz8z4tf8za
Add Administration Getting Started and Logging.  Capitalize SQL clause keywords.

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
#pragma once
 
25
 
 
26
#include <drizzled/atomics.h>
 
27
#include <drizzled/plugin/plugin.h>
 
28
 
 
29
#include <drizzled/visibility.h>
 
30
 
 
31
/**
 
32
 * @file Defines the API for a QueryRewriter.  
 
33
 */
 
34
 
 
35
namespace drizzled
 
36
{
 
37
 
 
38
namespace plugin
 
39
{
 
40
 
 
41
/**
 
42
 * Class which rewrites queries
 
43
 */
 
44
class DRIZZLED_API QueryRewriter : public Plugin
 
45
{
 
46
public:
 
47
  explicit QueryRewriter(std::string name_arg)
 
48
    : 
 
49
      Plugin(name_arg, "QueryRewriter")
 
50
  {}
 
51
 
 
52
  /**
 
53
   * Rewrite a query in the form of a std::string
 
54
   *
 
55
   * @param[in] schema the schema the current session is in
 
56
   * @param[out] to_rewrite string representing the query to rewrite
 
57
   */
 
58
  virtual void rewrite(const std::string &schema, std::string &to_rewrite)= 0; 
 
59
 
 
60
  static bool addPlugin(QueryRewriter *in_rewriter);
 
61
  static void removePlugin(QueryRewriter *in_rewriter);
 
62
 
 
63
  /**
 
64
   * Take a query to be rewritten and go through all the rewriters that are registered as plugins
 
65
   * and let the enabled ones rewrite they query.
 
66
   * TODO: does it make sense to have multiple rewriters?
 
67
   *
 
68
   * @param[in] schema the schema the current session is
 
69
   * @param[out] to_rewrite the query to rewrite
 
70
   */
 
71
  static void rewriteQuery(const std::string &schema, std::string &to_rewrite);
 
72
};
 
73
 
 
74
} /* namespace plugin */
 
75
} /* namespace drizzled */
 
76