1
1
/* -*- mode: c++; c-basic-offset: 2; indent-tabs-mode: nil; -*-
2
2
* vim:expandtab:shiftwidth=2:tabstop=2:smarttab:
4
* Definitions required for Query Cache plugin
4
6
* Copyright (C) 2008 Sun Microsystems, Toru Maesaka
5
* Copyright (C) 2010 Djellel Eddine Difallah
7
8
* This program is free software; you can redistribute it and/or modify
8
9
* it under the terms of the GNU General Public License as published by
21
22
#ifndef DRIZZLED_PLUGIN_QUERY_CACHE_H
22
23
#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>
25
#include "drizzled/plugin/plugin.h"
39
35
This is the API that a qcache plugin must implement.
36
it should implement each of these function pointers.
37
if a function pointer is NULL (not loaded), that's ok.
42
class DRIZZLED_API QueryCache : public Plugin
43
class QueryCache : public Plugin
47
46
QueryCache(const QueryCache &);
48
47
QueryCache& operator=(const QueryCache &);
52
49
explicit QueryCache(std::string name_arg)
53
50
: Plugin(name_arg, "QueryCache")
56
53
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;
54
/* Lookup the cache and transmit the data back to the client */
55
virtual bool tryFetchAndSend(Session *session,
56
bool is_transactional)= 0;
58
virtual bool set(Session *session, bool is_transactional)= 0;
59
virtual bool invalidateTable(Session *session, bool is_transactional)= 0;
60
virtual bool invalidateDb(Session *session, const char *db_name,
61
bool transactional)= 0;
62
virtual bool flush(Session *session)= 0;
71
64
static bool addPlugin(QueryCache *handler);
72
65
static void removePlugin(QueryCache *handler);
74
67
/* 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);
68
static bool tryFetchAndSendDo(Session *session, bool transactional);
69
static bool setDo(Session *session, bool transactional);
70
static bool invalidateTableDo(Session *session, bool transactional);
71
static bool invalidateDbDo(Session *session, const char *db_name,
73
static bool flushDo(Session *session);
82
76
} /* namespace plugin */