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>
43 #if PG_VERSION_NUM >= 100000
44 #include <utils/regproc.h>
45 #include <utils/varlena.h>
50 static int nDisabledIndexes = 0;
51 static Oid *disabledIndexes = NULL;
52 static char *disableIndexesOutStr = "";
54 static int nEnabledIndexes = 0;
55 static Oid *enabledIndexes = NULL;
56 static char *enableIndexesOutStr = "";
58 get_relation_info_hook_type prevHook = NULL;
59 static bool fix_empty_table = false;
63 indexesAssign(const char * newval, bool doit, GucSource source, bool isDisable)
72 rawname = pstrdup(newval);
74 if (!SplitIdentifierString(rawname, ',', &namelist))
79 nOids = list_length(namelist);
80 newOids = malloc(sizeof(Oid) * (nOids+1));
82 elog(ERROR,"could not allocate %d bytes",
83 (int)(sizeof(Oid) * (nOids+1)));
88 char *curname = (char *) lfirst(l);
89 #if PG_VERSION_NUM >= 90200
90 Oid indexOid = RangeVarGetRelid(
91 makeRangeVarFromNameList(stringToQualifiedNameList(curname)),
94 Oid indexOid = RangeVarGetRelid(
95 makeRangeVarFromNameList(stringToQualifiedNameList(curname)),
99 if (indexOid == InvalidOid)
101 #if PG_VERSION_NUM >= 90100
104 elog(WARNING,"'%s' does not exist", curname);
107 else if ( get_rel_relkind(indexOid) != RELKIND_INDEX )
109 #if PG_VERSION_NUM >= 90100
112 elog(WARNING,"'%s' is not an index", curname);
117 newOids[i++] = indexOid;
125 nDisabledIndexes = nOids;
126 disabledIndexes = newOids;
130 nEnabledIndexes = nOids;
131 enabledIndexes = newOids;
149 assignDisabledIndexes(const char * newval, bool doit, GucSource source)
151 return indexesAssign(newval, doit, source, true);
155 assignEnabledIndexes(const char * newval, bool doit, GucSource source)
157 return indexesAssign(newval, doit, source, false);
160 #if PG_VERSION_NUM >= 90100
163 checkDisabledIndexes(char **newval, void **extra, GucSource source)
167 val = (char*)indexesAssign(*newval, false, source, true);
179 checkEnabledIndexes(char **newval, void **extra, GucSource source)
183 val = (char*)indexesAssign(*newval, false, source, false);
195 assignDisabledIndexesNew(const char *newval, void *extra)
197 assignDisabledIndexes(newval, true, PGC_S_USER /* doesn't matter */);
201 assignEnabledIndexesNew(const char *newval, void *extra)
203 assignEnabledIndexes(newval, true, PGC_S_USER /* doesn't matter */);
209 indexFilter(PlannerInfo *root, Oid relationObjectId, bool inhparent,
214 for(i=0;i<nDisabledIndexes;i++)
218 foreach(l, rel->indexlist)
220 IndexOptInfo *info = (IndexOptInfo*)lfirst(l);
222 if (disabledIndexes[i] == info->indexoid)
226 for(j=0; j<nEnabledIndexes; j++)
227 if (enabledIndexes[j] == info->indexoid)
230 if (j >= nEnabledIndexes)
231 rel->indexlist = list_delete_ptr(rel->indexlist, info);
240 execPlantuner(PlannerInfo *root, Oid relationObjectId, bool inhparent,
245 relation = heap_open(relationObjectId, NoLock);
246 if (relation->rd_rel->relkind == RELKIND_RELATION)
248 if (fix_empty_table && RelationGetNumberOfBlocks(relation) == 0)
251 * estimate_rel_size() could be too pessimistic for particular
258 indexFilter(root, relationObjectId, inhparent, rel);
260 heap_close(relation, NoLock);
263 * Call next hook if it exists
266 prevHook(root, relationObjectId, inhparent, rel);
270 IndexFilterShow(Oid* indexes, int nIndexes)
276 len = 1 /* \0 */ + nIndexes * (2 * NAMEDATALEN + 2 /* ', ' */ + 1 /* . */);
277 ptr = val = palloc(len);
280 for(i=0; i<nIndexes; i++)
282 char *relname = get_rel_name(indexes[i]);
283 Oid nspOid = get_rel_namespace(indexes[i]);
284 char *nspname = get_namespace_name(nspOid);
286 if ( relname == NULL || nspOid == InvalidOid || nspname == NULL )
289 ptr += snprintf(ptr, len - (ptr - val), "%s%s.%s",
299 disabledIndexFilterShow(void)
301 return IndexFilterShow(disabledIndexes, nDisabledIndexes);
305 enabledIndexFilterShow(void)
307 return IndexFilterShow(enabledIndexes, nEnabledIndexes);
314 DefineCustomStringVariable(
315 "plantuner.forbid_index",
316 "List of forbidden indexes (deprecated)",
317 "Listed indexes will not be used in queries (deprecated, use plantuner.disable_index)",
318 &disableIndexesOutStr,
322 #if PG_VERSION_NUM >= 90100
323 checkDisabledIndexes,
324 assignDisabledIndexesNew,
326 assignDisabledIndexes,
328 disabledIndexFilterShow
331 DefineCustomStringVariable(
332 "plantuner.disable_index",
333 "List of disabled indexes",
334 "Listed indexes will not be used in queries",
335 &disableIndexesOutStr,
339 #if PG_VERSION_NUM >= 90100
340 checkDisabledIndexes,
341 assignDisabledIndexesNew,
343 assignDisabledIndexes,
345 disabledIndexFilterShow
348 DefineCustomStringVariable(
349 "plantuner.enable_index",
350 "List of enabled indexes (overload plantuner.disable_index)",
351 "Listed indexes which could be used in queries even they are listed in plantuner.disable_index",
352 &enableIndexesOutStr,
356 #if PG_VERSION_NUM >= 90100
358 assignEnabledIndexesNew,
360 assignEnabledIndexes,
362 enabledIndexFilterShow
365 DefineCustomBoolVariable(
366 "plantuner.fix_empty_table",
367 "Sets to zero estimations for empty tables",
368 "Sets to zero estimations for empty or newly created tables",
370 #if PG_VERSION_NUM >= 80400
374 #if PG_VERSION_NUM >= 80400
376 #if PG_VERSION_NUM >= 90100
384 if (get_relation_info_hook != execPlantuner )
386 prevHook = get_relation_info_hook;
387 get_relation_info_hook = execPlantuner;