2 * Copyright (c) 2009 Teodor Sigaev <teodor@sigaev.ru>
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
13 * 3. Neither the name of the author nor the names of any co-contributors
14 * may be used to endorse or promote products derived from this software
15 * without specific prior written permission.
17 * THIS SOFTWARE IS PROVIDED BY CONTRIBUTORS ``AS IS'' AND ANY EXPRESS
18 * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
19 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED. IN NO EVENT SHALL CONTRIBUTORS BE LIABLE FOR ANY
21 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
23 * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
24 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
25 * IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
26 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
27 * IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33 #include <access/heapam.h>
34 #include <catalog/namespace.h>
35 #include <catalog/pg_class.h>
36 #include <nodes/pg_list.h>
37 #include <optimizer/plancat.h>
38 #include <storage/bufmgr.h>
39 #include <utils/builtins.h>
40 #include <utils/guc.h>
41 #include <utils/lsyscache.h>
42 #include <utils/rel.h>
46 static int nDisabledIndexes = 0;
47 static Oid *disabledIndexes = NULL;
48 static char *disableIndexesOutStr = "";
50 static int nEnabledIndexes = 0;
51 static Oid *enabledIndexes = NULL;
52 static char *enableIndexesOutStr = "";
54 get_relation_info_hook_type prevHook = NULL;
55 static bool fix_empty_table = false;
59 indexesAssign(const char * newval, bool doit, GucSource source, bool isDisable)
68 rawname = pstrdup(newval);
70 if (!SplitIdentifierString(rawname, ',', &namelist))
75 nOids = list_length(namelist);
76 newOids = malloc(sizeof(Oid) * (nOids+1));
78 elog(ERROR,"could not allocate %d bytes", (int)(sizeof(Oid) * (nOids+1)));
83 char *curname = (char *) lfirst(l);
84 Oid indexOid = RangeVarGetRelid(makeRangeVarFromNameList(stringToQualifiedNameList(curname)),
85 #if PG_VERSION_NUM >= 90200
90 if (indexOid == InvalidOid)
92 #if PG_VERSION_NUM >= 90100
95 elog(WARNING,"'%s' does not exist", curname);
98 else if ( get_rel_relkind(indexOid) != RELKIND_INDEX )
100 #if PG_VERSION_NUM >= 90100
103 elog(WARNING,"'%s' is not an index", curname);
108 newOids[i++] = indexOid;
116 nDisabledIndexes = nOids;
117 disabledIndexes = newOids;
121 nEnabledIndexes = nOids;
122 enabledIndexes = newOids;
140 assignDisabledIndexes(const char * newval, bool doit, GucSource source)
142 return indexesAssign(newval, doit, source, true);
146 assignEnabledIndexes(const char * newval, bool doit, GucSource source)
148 return indexesAssign(newval, doit, source, false);
151 #if PG_VERSION_NUM >= 90100
154 checkDisabledIndexes(char **newval, void **extra, GucSource source)
158 val = (char*)indexesAssign(*newval, false, source, true);
170 checkEnabledIndexes(char **newval, void **extra, GucSource source)
174 val = (char*)indexesAssign(*newval, false, source, false);
186 assignDisabledIndexesNew(const char *newval, void *extra)
188 assignDisabledIndexes(newval, true, PGC_S_USER /* doesn't matter */);
192 assignEnabledIndexesNew(const char *newval, void *extra)
194 assignEnabledIndexes(newval, true, PGC_S_USER /* doesn't matter */);
200 indexFilter(PlannerInfo *root, Oid relationObjectId, bool inhparent, RelOptInfo *rel) {
203 for(i=0;i<nDisabledIndexes;i++)
207 foreach(l, rel->indexlist)
209 IndexOptInfo *info = (IndexOptInfo*)lfirst(l);
211 if (disabledIndexes[i] == info->indexoid)
215 for(j=0; j<nEnabledIndexes; j++)
216 if (enabledIndexes[j] == info->indexoid)
219 if (j >= nEnabledIndexes)
220 rel->indexlist = list_delete_ptr(rel->indexlist, info);
227 if (fix_empty_table && rel)
236 execPlantuner(PlannerInfo *root, Oid relationObjectId, bool inhparent, RelOptInfo *rel) {
239 relation = heap_open(relationObjectId, NoLock);
240 if (relation->rd_rel->relkind == RELKIND_RELATION)
242 if (fix_empty_table && RelationGetNumberOfBlocks(relation) == 0)
245 * estimate_rel_size() could be too pessimistic for particular
252 indexFilter(root, relationObjectId, inhparent, rel);
254 heap_close(relation, NoLock);
257 * Call next hook if it exists
260 prevHook(root, relationObjectId, inhparent, rel);
264 IndexFilterShow(Oid* indexes, int nIndexes)
270 len = 1 /* \0 */ + nIndexes * (2 * NAMEDATALEN + 2 /* ', ' */ + 1 /* . */);
271 ptr = val = palloc(len);
274 for(i=0; i<nIndexes; i++)
276 char *relname = get_rel_name(indexes[i]);
277 Oid nspOid = get_rel_namespace(indexes[i]);
278 char *nspname = get_namespace_name(nspOid);
280 if ( relname == NULL || nspOid == InvalidOid || nspname == NULL )
283 ptr += snprintf(ptr, len - (ptr - val), "%s%s.%s",
293 disabledIndexFilterShow()
295 return IndexFilterShow(disabledIndexes, nDisabledIndexes);
299 enabledIndexFilterShow()
301 return IndexFilterShow(enabledIndexes, nEnabledIndexes);
308 DefineCustomStringVariable(
309 "plantuner.forbid_index",
310 "List of forbidden indexes (deprecated)",
311 "Listed indexes will not be used in queries (deprecated, use plantuner.disable_index)",
312 &disableIndexesOutStr,
316 #if PG_VERSION_NUM >= 90100
317 checkDisabledIndexes,
318 assignDisabledIndexesNew,
320 assignDisabledIndexes,
322 disabledIndexFilterShow
325 DefineCustomStringVariable(
326 "plantuner.disable_index",
327 "List of disabled indexes",
328 "Listed indexes will not be used in queries",
329 &disableIndexesOutStr,
333 #if PG_VERSION_NUM >= 90100
334 checkDisabledIndexes,
335 assignDisabledIndexesNew,
337 assignDisabledIndexes,
339 disabledIndexFilterShow
342 DefineCustomStringVariable(
343 "plantuner.enable_index",
344 "List of enabled indexes (overload plantuner.disable_index)",
345 "Listed indexes which could be used in queries even they are listed in plantuner.disable_index",
346 &enableIndexesOutStr,
350 #if PG_VERSION_NUM >= 90100
352 assignEnabledIndexesNew,
354 assignEnabledIndexes,
356 enabledIndexFilterShow
359 DefineCustomBoolVariable(
360 "plantuner.fix_empty_table",
361 "Sets to zero estimations for empty tables",
362 "Sets to zero estimations for empty or newly created tables",
364 #if PG_VERSION_NUM >= 80400
368 #if PG_VERSION_NUM >= 80400
370 #if PG_VERSION_NUM >= 90100
378 if (get_relation_info_hook != execPlantuner )
380 prevHook = get_relation_info_hook;
381 get_relation_info_hook = execPlantuner;