1
/* -*- mode: c++; c-basic-offset: 2; indent-tabs-mode: nil; -*-
2
-*- mode: c++; c-basic-offset: 2; indent-tabs-mode: nil; -*-
2
3
* vim:expandtab:shiftwidth=2:tabstop=2:smarttab:
4
* Copyright (C) 2008 Sun Microsystems, Toru Maesaka
5
* Copyright (C) 2010 Djellel Eddine Difallah
5
* Definitions required for Query Cache plugin
7
* Copyright (C) 2008 Mark Atwood, Toru Maesaka
7
9
* This program is free software; you can redistribute it and/or modify
8
10
* it under the terms of the GNU General Public License as published by
18
20
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
21
#ifndef DRIZZLED_PLUGIN_QUERY_CACHE_H
22
#define DRIZZLED_PLUGIN_QUERY_CACHE_H
24
#include "drizzled/plugin.h"
25
#include "drizzled/plugin/plugin.h"
26
#include <drizzled/sql_list.h>
28
#include "drizzled/visibility.h"
23
#ifndef DRIZZLED_PLUGIN_QCACHE_H
24
#define DRIZZLED_PLUGIN_QCACHE_H
39
27
This is the API that a qcache plugin must implement.
28
it should implement each of these function pointers.
29
if a function pointer is NULL (not loaded), that's ok.
42
class DRIZZLED_API QueryCache : public Plugin
35
typedef struct qcache_st
47
QueryCache(const QueryCache &);
48
QueryCache& operator=(const QueryCache &);
52
explicit QueryCache(std::string name_arg)
53
: Plugin(name_arg, "QueryCache")
56
virtual ~QueryCache() {}
58
/* these are the Query Cache interface functions */
60
/* Lookup the cache and transmit the data back to the client */
61
virtual bool doIsCached(Session* session)= 0;
62
/* Lookup the cache and transmit the data back to the client */
63
virtual bool doSendCachedResultset(Session *session)= 0;
64
/* Send the current Resultset to the cache */
65
virtual bool doSetResultset(Session *session)= 0;
66
/* initiate a new Resultset (header) */
67
virtual bool doPrepareResultset(Session *session)= 0;
68
/* push a record to the current Resultset */
69
virtual bool doInsertRecord(Session *session, List<Item> &item)= 0;
71
static bool addPlugin(QueryCache *handler);
72
static void removePlugin(QueryCache *handler);
74
/* These are the functions called by the rest of the Drizzle server */
75
static bool isCached(Session *session);
76
static bool sendCachedResultset(Session *session);
77
static bool prepareResultset(Session *session);
78
static bool setResultset(Session *session);
79
static bool insertRecord(Session *session, List<Item> &item);
82
} /* namespace plugin */
83
} /* namespace drizzled */
85
#endif /* DRIZZLED_PLUGIN_QUERY_CACHE_H */
37
/* Lookup the cache and transmit the data back to the client */
38
bool (*qcache_try_fetch_and_send)(Session *session, bool transactional);
40
bool (*qcache_set)(Session *session, bool transactional);
41
bool (*qcache_invalidate_table)(Session *session, bool transactional);
42
bool (*qcache_invalidate_db)(Session *session, const char *db_name,
44
bool (*qcache_flush)(Session *session);
47
#endif /* DRIZZLED_PLUGIN_QCACHE_H */