|
| 1 | +create or replace function index_advisor( |
| 2 | + query text |
| 3 | +) |
| 4 | + returns table ( |
| 5 | + startup_cost_before jsonb, |
| 6 | + startup_cost_after jsonb, |
| 7 | + total_cost_before jsonb, |
| 8 | + total_cost_after jsonb, |
| 9 | + index_statements text[], |
| 10 | + errors text[] |
| 11 | + ) |
| 12 | + volatile |
| 13 | + language plpgsql |
| 14 | + as $$ |
| 15 | +declare |
| 16 | + n_args int; |
| 17 | + prepared_statement_name text = 'index_advisor_working_statement'; |
| 18 | + hypopg_schema_name text = (select extnamespace::regnamespace::text from pg_extension where extname = 'hypopg'); |
| 19 | + explain_plan_statement text; |
| 20 | + rec record; |
| 21 | + plan_initial jsonb; |
| 22 | + plan_final jsonb; |
| 23 | + statements text[] = '{}'; |
| 24 | +begin |
| 25 | + |
| 26 | + -- Remove comment lines (its common that they contain semicolons) |
| 27 | + query := trim( |
| 28 | + regexp_replace( |
| 29 | + regexp_replace( |
| 30 | + regexp_replace(query,'\/\*.+\*\/', '', 'g'), |
| 31 | + '--[^\r\n]*', ' ', 'g'), |
| 32 | + '\s+', ' ', 'g') |
| 33 | + ); |
| 34 | + |
| 35 | + -- Remove trailing semicolon |
| 36 | + query := regexp_replace(query, ';\s*$', ''); |
| 37 | + |
| 38 | + -- Disallow multiple statements |
| 39 | + if query ilike '%;%' then |
| 40 | + return query values ( |
| 41 | + null::jsonb, |
| 42 | + null::jsonb, |
| 43 | + null::jsonb, |
| 44 | + null::jsonb, |
| 45 | + array[]::text[], |
| 46 | + array['Query must not contain a semicolon']::text[] |
| 47 | + ); |
| 48 | + else |
| 49 | + -- Hack to support PostgREST because the prepared statement for args incorrectly defaults to text |
| 50 | + query := replace(query, 'WITH pgrst_payload AS (SELECT $1 AS json_data)', 'WITH pgrst_payload AS (SELECT $1::json AS json_data)'); |
| 51 | + |
| 52 | + -- Create a prepared statement for the given query |
| 53 | + deallocate all; |
| 54 | + execute format('prepare %I as %s', prepared_statement_name, query); |
| 55 | + |
| 56 | + -- Detect how many arguments are present in the prepared statement |
| 57 | + n_args = ( |
| 58 | + select |
| 59 | + coalesce(array_length(parameter_types, 1), 0) |
| 60 | + from |
| 61 | + pg_prepared_statements |
| 62 | + where |
| 63 | + name = prepared_statement_name |
| 64 | + limit |
| 65 | + 1 |
| 66 | + ); |
| 67 | + |
| 68 | + -- Create a SQL statement that can be executed to collect the explain plan |
| 69 | + explain_plan_statement = format( |
| 70 | + 'set local plan_cache_mode = force_generic_plan; explain (format json) execute %I%s', |
| 71 | + --'explain (format json) execute %I%s', |
| 72 | + prepared_statement_name, |
| 73 | + case |
| 74 | + when n_args = 0 then '' |
| 75 | + else format( |
| 76 | + '(%s)', array_to_string(array_fill('null'::text, array[n_args]), ',') |
| 77 | + ) |
| 78 | + end |
| 79 | + ); |
| 80 | + |
| 81 | + -- Store the query plan before any new indexes |
| 82 | + execute explain_plan_statement into plan_initial; |
| 83 | + |
| 84 | + -- Create possible indexes |
| 85 | + for rec in ( |
| 86 | + with extension_regclass as ( |
| 87 | + select |
| 88 | + distinct objid as oid |
| 89 | + from |
| 90 | + pg_depend |
| 91 | + where |
| 92 | + deptype = 'e' |
| 93 | + ) |
| 94 | + select |
| 95 | + pc.relnamespace::regnamespace::text as schema_name, |
| 96 | + pc.relname as table_name, |
| 97 | + pa.attname as column_name, |
| 98 | + format( |
| 99 | + 'select %I.hypopg_create_index($i$create index on %I.%I(%I)$i$)', |
| 100 | + hypopg_schema_name, |
| 101 | + pc.relnamespace::regnamespace::text, |
| 102 | + pc.relname, |
| 103 | + pa.attname |
| 104 | + ) hypopg_statement |
| 105 | + from |
| 106 | + pg_catalog.pg_class pc |
| 107 | + join pg_catalog.pg_attribute pa |
| 108 | + on pc.oid = pa.attrelid |
| 109 | + left join extension_regclass er |
| 110 | + on pc.oid = er.oid |
| 111 | + left join pg_index pi |
| 112 | + on pc.oid = pi.indrelid |
| 113 | + and (select array_agg(x) from unnest(pi.indkey) v(x)) = array[pa.attnum] |
| 114 | + and pi.indexprs is null -- ignore expression indexes |
| 115 | + and pi.indpred is null -- ignore partial indexes |
| 116 | + where |
| 117 | + pc.relnamespace::regnamespace::text not in ( -- ignore schema list |
| 118 | + 'pg_catalog', 'pg_toast', 'information_schema' |
| 119 | + ) |
| 120 | + and er.oid is null -- ignore entities owned by extensions |
| 121 | + and pc.relkind in ('r', 'm') -- regular tables, and materialized views |
| 122 | + and pc.relpersistence = 'p' -- permanent tables (not unlogged or temporary) |
| 123 | + and pa.attnum > 0 |
| 124 | + and not pa.attisdropped |
| 125 | + and pi.indrelid is null |
| 126 | + and pa.atttypid in (20,16,1082,1184,1114,701,23,21,700,1083,2950,1700,25,18,1042,1043) |
| 127 | + ) |
| 128 | + loop |
| 129 | + -- Create the hypothetical index |
| 130 | + execute rec.hypopg_statement; |
| 131 | + end loop; |
| 132 | + |
| 133 | + /* |
| 134 | + for rec in select * from hypopg() |
| 135 | + loop |
| 136 | + raise notice '%', rec; |
| 137 | + end loop; |
| 138 | + */ |
| 139 | + |
| 140 | + -- Create a prepared statement for the given query |
| 141 | + -- The original prepared statement MUST be dropped because its plan is cached |
| 142 | + execute format('deallocate %I', prepared_statement_name); |
| 143 | + execute format('prepare %I as %s', prepared_statement_name, query); |
| 144 | + |
| 145 | + -- Store the query plan after new indexes |
| 146 | + execute explain_plan_statement into plan_final; |
| 147 | + |
| 148 | + --raise notice '%', plan_final; |
| 149 | + |
| 150 | + -- Idenfity referenced indexes in new plan |
| 151 | + execute format( |
| 152 | + 'select |
| 153 | + coalesce(array_agg(hypopg_get_indexdef(indexrelid) order by indrelid, indkey::text), $i${}$i$::text[]) |
| 154 | + from |
| 155 | + %I.hypopg() |
| 156 | + where |
| 157 | + %s ilike ($i$%%$i$ || indexname || $i$%%$i$) |
| 158 | + ', |
| 159 | + hypopg_schema_name, |
| 160 | + quote_literal(plan_final)::text |
| 161 | + ) into statements; |
| 162 | + |
| 163 | + -- Reset all hypothetical indexes |
| 164 | + perform hypopg_reset(); |
| 165 | + |
| 166 | + -- Reset prepared statements |
| 167 | + deallocate all; |
| 168 | + |
| 169 | + return query values ( |
| 170 | + (plan_initial -> 0 -> 'Plan' -> 'Startup Cost'), |
| 171 | + (plan_final -> 0 -> 'Plan' -> 'Startup Cost'), |
| 172 | + (plan_initial -> 0 -> 'Plan' -> 'Total Cost'), |
| 173 | + (plan_final -> 0 -> 'Plan' -> 'Total Cost'), |
| 174 | + statements::text[], |
| 175 | + array[]::text[] |
| 176 | + ); |
| 177 | + |
| 178 | + end if; |
| 179 | + |
| 180 | +end; |
| 181 | +$$; |
0 commit comments