Project

General

Profile

1 2094 aaronmk
--
2
-- PostgreSQL database dump
3
--
4
5
SET statement_timeout = 0;
6 11667 aaronmk
SET lock_timeout = 0;
7 2094 aaronmk
SET client_encoding = 'UTF8';
8 6213 aaronmk
SET standard_conforming_strings = on;
9 2094 aaronmk
SET check_function_bodies = false;
10
SET client_min_messages = warning;
11
12
--
13 8183 aaronmk
-- Name: util; Type: SCHEMA; Schema: -; Owner: -
14 2094 aaronmk
--
15
16 8183 aaronmk
CREATE SCHEMA util;
17 2094 aaronmk
18
19 4982 aaronmk
--
20 8183 aaronmk
-- Name: SCHEMA util; Type: COMMENT; Schema: -; Owner: -
21 4982 aaronmk
--
22
23 12235 aaronmk
COMMENT ON SCHEMA util IS '
24
IMPORTANT: Functions must always return NULL in place of '''' (the empty string). This ensures that empty strings do not find their way into VegBIEN.
25 4982 aaronmk
26 12447 aaronmk
NOTE: SQL-language functions should never be declared STRICT, because this prevents them from being inlined. inlining can create a significant speed improvement (7x+), by avoiding function calls and enabling additional constant folding. avoiding use of STRICT also makes functions *much* easier to troubleshoot, because they won''t mysteriously do nothing if called with only NULL arguments, even when you have added debug-print statements.
27 12235 aaronmk
';
28 4982 aaronmk
29 10378 aaronmk
30 8183 aaronmk
SET search_path = util, pg_catalog;
31 2107 aaronmk
32 2094 aaronmk
--
33 8183 aaronmk
-- Name: col_cast; Type: TYPE; Schema: util; Owner: -
34 8107 aaronmk
--
35
36
CREATE TYPE col_cast AS (
37
	col_name text,
38
	type regtype
39
);
40
41
42
--
43 8183 aaronmk
-- Name: col_ref; Type: TYPE; Schema: util; Owner: -
44 8106 aaronmk
--
45
46
CREATE TYPE col_ref AS (
47
	table_ regclass,
48
	name text
49
);
50
51
52
--
53 8183 aaronmk
-- Name: compass_dir; Type: TYPE; Schema: util; Owner: -
54 7673 aaronmk
--
55
56
CREATE TYPE compass_dir AS ENUM (
57
    'N',
58
    'E',
59
    'S',
60
    'W'
61
);
62
63
64
--
65 8183 aaronmk
-- Name: datatype; Type: TYPE; Schema: util; Owner: -
66 2610 aaronmk
--
67
68
CREATE TYPE datatype AS ENUM (
69
    'str',
70
    'float'
71
);
72
73
74
--
75 12423 aaronmk
-- Name: %==(anyelement, anyelement); Type: FUNCTION; Schema: util; Owner: -
76
--
77
78
CREATE FUNCTION "%=="(left_ anyelement, right_ anyelement) RETURNS boolean
79 12443 aaronmk
    LANGUAGE sql STABLE
80 12423 aaronmk
    AS $_$
81 12436 aaronmk
SELECT keys($1) = keys($2)
82 12423 aaronmk
$_$;
83
84
85
--
86 12443 aaronmk
-- Name: FUNCTION "%=="(left_ anyelement, right_ anyelement); Type: COMMENT; Schema: util; Owner: -
87
--
88
89
COMMENT ON FUNCTION "%=="(left_ anyelement, right_ anyelement) IS '
90
needs to be declared STABLE instead of IMMUTABLE because it depends on the search_path (as described at http://vegpath.org/links/#PostgreSQL:%20Documentation:%209.3:%20Function%20Volatility%20Categories%20**)
91
';
92
93
94
--
95 8183 aaronmk
-- Name: _alt(anyelement, anyelement, anyelement, anyelement, anyelement, anyelement, anyelement, anyelement, anyelement, anyelement, anyelement, anyelement, anyelement); Type: FUNCTION; Schema: util; Owner: -
96 2596 aaronmk
--
97
98 4501 aaronmk
CREATE FUNCTION _alt("0" anyelement DEFAULT NULL::unknown, "1" anyelement DEFAULT NULL::unknown, "2" anyelement DEFAULT NULL::unknown, "3" anyelement DEFAULT NULL::unknown, "4" anyelement DEFAULT NULL::unknown, "5" anyelement DEFAULT NULL::unknown, "6" anyelement DEFAULT NULL::unknown, "7" anyelement DEFAULT NULL::unknown, "8" anyelement DEFAULT NULL::unknown, "9" anyelement DEFAULT NULL::unknown, "10" anyelement DEFAULT NULL::unknown, "11" anyelement DEFAULT NULL::unknown, "12" anyelement DEFAULT NULL::unknown) RETURNS anyelement
99 3422 aaronmk
    LANGUAGE sql IMMUTABLE
100
    AS $_$
101 4501 aaronmk
SELECT coalesce($1, $2, $3, $4, $5, $6, $7, $8, $9, $10, $11, $12, $13)
102 3422 aaronmk
$_$;
103
104
105
--
106 8183 aaronmk
-- Name: _and(boolean, boolean, boolean, boolean, boolean); Type: FUNCTION; Schema: util; Owner: -
107 5937 aaronmk
--
108
109 5956 aaronmk
CREATE FUNCTION _and("0" boolean DEFAULT NULL::boolean, "1" boolean DEFAULT NULL::boolean, "2" boolean DEFAULT NULL::boolean, "3" boolean DEFAULT NULL::boolean, "4" boolean DEFAULT NULL::boolean) RETURNS boolean
110 5937 aaronmk
    LANGUAGE sql IMMUTABLE
111
    AS $_$
112
SELECT bool_and(value)
113
FROM
114
(VALUES
115
      ($1)
116
    , ($2)
117 5956 aaronmk
    , ($3)
118
    , ($4)
119
    , ($5)
120 5937 aaronmk
)
121
AS v (value)
122
$_$;
123
124
125
--
126 8183 aaronmk
-- Name: FUNCTION _and("0" boolean, "1" boolean, "2" boolean, "3" boolean, "4" boolean); Type: COMMENT; Schema: util; Owner: -
127 5937 aaronmk
--
128
129 12235 aaronmk
COMMENT ON FUNCTION _and("0" boolean, "1" boolean, "2" boolean, "3" boolean, "4" boolean) IS '
130
_and() ignores NULL values, while AND combines them with the other values to potentially convert true to NULL. AND should be used with required fields, and _and() with optional fields.
131
';
132 5937 aaronmk
133
134
--
135 8183 aaronmk
-- Name: _avg(double precision, double precision, double precision, double precision, double precision); Type: FUNCTION; Schema: util; Owner: -
136 7704 aaronmk
--
137
138
CREATE FUNCTION _avg("0" double precision DEFAULT NULL::double precision, "1" double precision DEFAULT NULL::double precision, "2" double precision DEFAULT NULL::double precision, "3" double precision DEFAULT NULL::double precision, "4" double precision DEFAULT NULL::double precision) RETURNS double precision
139
    LANGUAGE sql IMMUTABLE
140
    AS $_$
141
SELECT avg(value)
142
FROM
143
(VALUES
144
      ($1)
145
    , ($2)
146
    , ($3)
147
    , ($4)
148
    , ($5)
149
)
150
AS v (value)
151
$_$;
152
153
154
--
155 8183 aaronmk
-- Name: _dms_to_dd(text); Type: FUNCTION; Schema: util; Owner: -
156 7679 aaronmk
--
157
158
CREATE FUNCTION _dms_to_dd(value text DEFAULT NULL::text) RETURNS double precision
159 12441 aaronmk
    LANGUAGE sql IMMUTABLE
160 7679 aaronmk
    AS $_$
161 8183 aaronmk
SELECT (g[1]||'1')::integer*util._dms_to_dd(deg := g[2]::double precision, min := g[3]::double precision, sec := g[4]::double precision, dir := g[5]::util.compass_dir)
162 7698 aaronmk
FROM
163
(
164
    SELECT regexp_matches($1, '^ *(-?)(\d{1,3}(?:\.\d*)?)(?:(?:deg|[°º])(?: *([\d.]+)(?:min|[''’]))?(?: *([\d.]+)(?:sec|["”]))?)? *([NESW])? *$')
165
    UNION ALL
166 7702 aaronmk
    SELECT ARRAY[g[1], g[2], g[3]||'.'||g[4], NULL, g[5]]
167
    FROM regexp_matches($1, '^ *(-?)(\d{2,3})(\d{2})(\d{3}) *([NESW])? *$') matches (g) -- [D]DDMMmmm, where MMmmm = MM.mmm
168 7698 aaronmk
)
169
matches (g)
170 7679 aaronmk
$_$;
171
172
173
--
174 8183 aaronmk
-- Name: _dms_to_dd(double precision, double precision, double precision, compass_dir); Type: FUNCTION; Schema: util; Owner: -
175 7672 aaronmk
--
176
177 7674 aaronmk
CREATE FUNCTION _dms_to_dd(deg double precision DEFAULT NULL::double precision, min double precision DEFAULT NULL::double precision, sec double precision DEFAULT NULL::double precision, dir compass_dir DEFAULT NULL::compass_dir) RETURNS double precision
178 7672 aaronmk
    LANGUAGE sql IMMUTABLE
179
    AS $_$
180 8183 aaronmk
SELECT sum(value)*COALESCE(util._map('N=>1,E=>1,S=>-1,W=>-1', $4::text)::integer, 1)
181 7672 aaronmk
FROM
182
(VALUES
183 7677 aaronmk
      ($1)
184 7672 aaronmk
    , ($2/60)
185
    , ($3/60/60)
186
)
187
AS v (value)
188
$_$;
189
190
191
--
192 8183 aaronmk
-- Name: _dms_to_dd(text, text, text, text); Type: FUNCTION; Schema: util; Owner: -
193 7723 aaronmk
--
194
195
CREATE FUNCTION _dms_to_dd(deg text DEFAULT NULL::text, min text DEFAULT NULL::text, sec text DEFAULT NULL::text, dir text DEFAULT NULL::text) RETURNS double precision
196
    LANGUAGE sql IMMUTABLE
197
    AS $_$
198 8183 aaronmk
SELECT util._dms_to_dd($1::double precision, $2::double precision, $3::double precision, $4::util.compass_dir)
199 7723 aaronmk
$_$;
200
201
202
--
203 8183 aaronmk
-- Name: _eq(anyelement, anyelement); Type: FUNCTION; Schema: util; Owner: -
204 4142 aaronmk
--
205
206
CREATE FUNCTION _eq("left" anyelement DEFAULT NULL::unknown, "right" anyelement DEFAULT NULL::unknown) RETURNS boolean
207
    LANGUAGE sql IMMUTABLE
208
    AS $_$
209
SELECT $1 = $2
210
$_$;
211
212
213
--
214 8183 aaronmk
-- Name: _fix_date(date, date); Type: FUNCTION; Schema: util; Owner: -
215 7396 aaronmk
--
216
217
CREATE FUNCTION _fix_date(value date DEFAULT NULL::date, threshold date DEFAULT NULL::date) RETURNS date
218
    LANGUAGE sql IMMUTABLE
219
    AS $_$
220
-- Fix dates after threshold date
221
-- This fixes e.g. 2-digit years before 1970 misinterpreted as 20xx
222
SELECT (CASE WHEN $1 > COALESCE($2, now()) THEN ($1 - '100 years'::interval)::date ELSE $1 END)
223
$_$;
224
225
226
--
227 8183 aaronmk
-- Name: _if(boolean, anyelement, anyelement); Type: FUNCTION; Schema: util; Owner: -
228 4147 aaronmk
--
229
230
CREATE FUNCTION _if(cond boolean DEFAULT NULL::boolean, "then" anyelement DEFAULT NULL::unknown, "else" anyelement DEFAULT NULL::unknown) RETURNS anyelement
231
    LANGUAGE sql IMMUTABLE
232
    AS $_$
233
SELECT (CASE WHEN $1 THEN $2 ELSE $3 END)
234
$_$;
235
236
237
--
238 8183 aaronmk
-- Name: _if(text, anyelement, anyelement); Type: FUNCTION; Schema: util; Owner: -
239 4147 aaronmk
--
240
241
CREATE FUNCTION _if(cond text DEFAULT NULL::text, "then" anyelement DEFAULT NULL::unknown, "else" anyelement DEFAULT NULL::unknown) RETURNS anyelement
242
    LANGUAGE sql IMMUTABLE
243
    AS $_$
244 8183 aaronmk
SELECT util._if($1 != '', $2, $3)
245 4147 aaronmk
$_$;
246
247
248
--
249 10699 aaronmk
-- Name: _join(text, text, text, text, text, text, text, text, text, text); Type: FUNCTION; Schema: util; Owner: -
250 4325 aaronmk
--
251
252 10699 aaronmk
CREATE FUNCTION _join("0" text DEFAULT NULL::text, "1" text DEFAULT NULL::text, "2" text DEFAULT NULL::text, "3" text DEFAULT NULL::text, "4" text DEFAULT NULL::text, "5" text DEFAULT NULL::text, "6" text DEFAULT NULL::text, "7" text DEFAULT NULL::text, "8" text DEFAULT NULL::text, "9" text DEFAULT NULL::text) RETURNS text
253 4325 aaronmk
    LANGUAGE sql IMMUTABLE
254
    AS $_$
255 7848 aaronmk
SELECT NULLIF(concat_ws('; ', $1, $2, $3, $4, $5, $6, $7, $8, $9, $10), '')
256 4325 aaronmk
$_$;
257
258
259
--
260 10699 aaronmk
-- Name: _join_words(text, text, text, text, text, text, text, text, text, text); Type: FUNCTION; Schema: util; Owner: -
261 5009 aaronmk
--
262
263 10699 aaronmk
CREATE FUNCTION _join_words("0" text DEFAULT NULL::text, "1" text DEFAULT NULL::text, "2" text DEFAULT NULL::text, "3" text DEFAULT NULL::text, "4" text DEFAULT NULL::text, "5" text DEFAULT NULL::text, "6" text DEFAULT NULL::text, "7" text DEFAULT NULL::text, "8" text DEFAULT NULL::text, "9" text DEFAULT NULL::text) RETURNS text
264 5009 aaronmk
    LANGUAGE sql IMMUTABLE
265
    AS $_$
266 7848 aaronmk
SELECT NULLIF(concat_ws(' ', $1, $2, $3, $4, $5, $6, $7, $8, $9, $10), '')
267 5009 aaronmk
$_$;
268
269
270
--
271 10699 aaronmk
-- Name: _label(text, text); Type: FUNCTION; Schema: util; Owner: -
272 3422 aaronmk
--
273
274 10699 aaronmk
CREATE FUNCTION _label(label text, value text) RETURNS text
275 4682 aaronmk
    LANGUAGE sql IMMUTABLE
276
    AS $_$
277
SELECT coalesce($1 || ': ', '') || $2
278
$_$;
279 2596 aaronmk
280
281
--
282 8825 aaronmk
-- Name: _lowercase(text); Type: FUNCTION; Schema: util; Owner: -
283
--
284
285
CREATE FUNCTION _lowercase(value text) RETURNS text
286 10388 aaronmk
    LANGUAGE sql IMMUTABLE
287 8825 aaronmk
    AS $_$
288
SELECT lower($1)
289
$_$;
290
291
292
--
293 11667 aaronmk
-- Name: _map(hstore, anyelement); Type: FUNCTION; Schema: util; Owner: -
294
--
295
296
CREATE FUNCTION _map(map hstore, value anyelement) RETURNS anyelement
297
    LANGUAGE plpgsql IMMUTABLE STRICT
298
    AS $$
299
DECLARE
300
    result value%TYPE := util._map(map, value::text)::unknown;
301
BEGIN
302
    RETURN result;
303
END;
304
$$;
305
306
307
--
308 8183 aaronmk
-- Name: _map(hstore, text); Type: FUNCTION; Schema: util; Owner: -
309 6222 aaronmk
--
310
311
CREATE FUNCTION _map(map hstore, value text) RETURNS text
312 7820 aaronmk
    LANGUAGE plpgsql IMMUTABLE STRICT
313 6222 aaronmk
    AS $$
314
DECLARE
315 6271 aaronmk
    match text := map -> value;
316 6222 aaronmk
BEGIN
317 6271 aaronmk
    IF match IS NULL AND NOT map ? value THEN -- no match rather than NULL match
318
        match := map -> '*'; -- use default entry
319
        IF match IS NULL AND NOT map ? '*' THEN match := '!'; -- no default
320
        END IF;
321
    END IF;
322
323
    -- Interpret result
324 6243 aaronmk
    IF match = '!' THEN RAISE 'Value not in map: %', value USING ERRCODE = 'data_exception';
325
    ELSIF match = '*' THEN RETURN value;
326
    ELSE RETURN match;
327 6222 aaronmk
    END IF;
328
END;
329
$$;
330
331
332
--
333 8183 aaronmk
-- Name: _max(anyelement, anyelement, anyelement, anyelement, anyelement, anyelement, anyelement, anyelement, anyelement, anyelement); Type: FUNCTION; Schema: util; Owner: -
334 5408 aaronmk
--
335
336
CREATE FUNCTION _max("0" anyelement DEFAULT NULL::unknown, "1" anyelement DEFAULT NULL::unknown, "2" anyelement DEFAULT NULL::unknown, "3" anyelement DEFAULT NULL::unknown, "4" anyelement DEFAULT NULL::unknown, "5" anyelement DEFAULT NULL::unknown, "6" anyelement DEFAULT NULL::unknown, "7" anyelement DEFAULT NULL::unknown, "8" anyelement DEFAULT NULL::unknown, "9" anyelement DEFAULT NULL::unknown) RETURNS anyelement
337
    LANGUAGE sql IMMUTABLE
338
    AS $_$
339 7289 aaronmk
SELECT GREATEST($1, $2, $3, $4, $5, $6, $7, $8, $9, $10)
340 5408 aaronmk
$_$;
341
342
343
--
344 8183 aaronmk
-- Name: _merge(anyelement, anyelement, anyelement, anyelement, anyelement, anyelement, anyelement, anyelement, anyelement, anyelement); Type: FUNCTION; Schema: util; Owner: -
345 2940 aaronmk
--
346
347 4150 aaronmk
CREATE FUNCTION _merge("0" anyelement DEFAULT NULL::unknown, "1" anyelement DEFAULT NULL::unknown, "2" anyelement DEFAULT NULL::unknown, "3" anyelement DEFAULT NULL::unknown, "4" anyelement DEFAULT NULL::unknown, "5" anyelement DEFAULT NULL::unknown, "6" anyelement DEFAULT NULL::unknown, "7" anyelement DEFAULT NULL::unknown, "8" anyelement DEFAULT NULL::unknown, "9" anyelement DEFAULT NULL::unknown) RETURNS anyelement
348 2940 aaronmk
    LANGUAGE sql IMMUTABLE
349
    AS $_$
350 8183 aaronmk
SELECT util.join_strs(value, '; ')
351 2940 aaronmk
FROM
352
(
353
    SELECT *
354
    FROM
355
    (
356
        SELECT
357
        DISTINCT ON (value)
358
        *
359
        FROM
360
        (VALUES
361 4012 aaronmk
              (1, $1)
362
            , (2, $2)
363
            , (3, $3)
364
            , (4, $4)
365
            , (5, $5)
366
            , (6, $6)
367
            , (7, $7)
368
            , (8, $8)
369
            , (9, $9)
370
            , (10, $10)
371 2940 aaronmk
        )
372
        AS v (sort_order, value)
373 4011 aaronmk
        WHERE value IS NOT NULL
374 2940 aaronmk
    )
375
    AS v
376
    ORDER BY sort_order
377
)
378
AS v
379
$_$;
380
381
382
--
383 8183 aaronmk
-- Name: _merge_prefix(text, text); Type: FUNCTION; Schema: util; Owner: -
384 7140 aaronmk
--
385
386
CREATE FUNCTION _merge_prefix(prefix text DEFAULT NULL::text, value text DEFAULT NULL::text) RETURNS text
387
    LANGUAGE sql IMMUTABLE
388
    AS $_$
389
SELECT _join_words((CASE WHEN $2 ~ ('^'||$1||E'\\y') THEN NULL ELSE $1 END), $2)
390
$_$;
391
392
393
--
394 8183 aaronmk
-- Name: _merge_words(anyelement, anyelement, anyelement, anyelement, anyelement, anyelement, anyelement, anyelement, anyelement, anyelement); Type: FUNCTION; Schema: util; Owner: -
395 6354 aaronmk
--
396
397
CREATE FUNCTION _merge_words("0" anyelement DEFAULT NULL::unknown, "1" anyelement DEFAULT NULL::unknown, "2" anyelement DEFAULT NULL::unknown, "3" anyelement DEFAULT NULL::unknown, "4" anyelement DEFAULT NULL::unknown, "5" anyelement DEFAULT NULL::unknown, "6" anyelement DEFAULT NULL::unknown, "7" anyelement DEFAULT NULL::unknown, "8" anyelement DEFAULT NULL::unknown, "9" anyelement DEFAULT NULL::unknown) RETURNS anyelement
398
    LANGUAGE sql IMMUTABLE
399
    AS $_$
400 8183 aaronmk
SELECT util.join_strs(value, ' ')
401 6354 aaronmk
FROM
402
(
403
    SELECT *
404
    FROM
405
    (
406
        SELECT
407
        DISTINCT ON (value)
408
        *
409
        FROM
410
        (VALUES
411
              (1, $1)
412
            , (2, $2)
413
            , (3, $3)
414
            , (4, $4)
415
            , (5, $5)
416
            , (6, $6)
417
            , (7, $7)
418
            , (8, $8)
419
            , (9, $9)
420
            , (10, $10)
421
        )
422
        AS v (sort_order, value)
423
        WHERE value IS NOT NULL
424
    )
425
    AS v
426
    ORDER BY sort_order
427
)
428
AS v
429
$_$;
430
431
432
--
433 8183 aaronmk
-- Name: _min(anyelement, anyelement, anyelement, anyelement, anyelement, anyelement, anyelement, anyelement, anyelement, anyelement); Type: FUNCTION; Schema: util; Owner: -
434 5408 aaronmk
--
435
436
CREATE FUNCTION _min("0" anyelement DEFAULT NULL::unknown, "1" anyelement DEFAULT NULL::unknown, "2" anyelement DEFAULT NULL::unknown, "3" anyelement DEFAULT NULL::unknown, "4" anyelement DEFAULT NULL::unknown, "5" anyelement DEFAULT NULL::unknown, "6" anyelement DEFAULT NULL::unknown, "7" anyelement DEFAULT NULL::unknown, "8" anyelement DEFAULT NULL::unknown, "9" anyelement DEFAULT NULL::unknown) RETURNS anyelement
437
    LANGUAGE sql IMMUTABLE
438
    AS $_$
439 7289 aaronmk
SELECT LEAST($1, $2, $3, $4, $5, $6, $7, $8, $9, $10)
440 5408 aaronmk
$_$;
441
442
443
--
444 8183 aaronmk
-- Name: _not(boolean); Type: FUNCTION; Schema: util; Owner: -
445 6316 aaronmk
--
446
447
CREATE FUNCTION _not(value boolean) RETURNS boolean
448 10388 aaronmk
    LANGUAGE sql IMMUTABLE
449 6316 aaronmk
    AS $_$
450
SELECT NOT $1
451
$_$;
452
453
454
--
455 8183 aaronmk
-- Name: _now(); Type: FUNCTION; Schema: util; Owner: -
456 7104 aaronmk
--
457
458
CREATE FUNCTION _now() RETURNS timestamp with time zone
459
    LANGUAGE sql STABLE
460
    AS $$
461
SELECT now()
462
$$;
463
464
465
--
466 11667 aaronmk
-- Name: _nullIf(anyelement, text, text); Type: FUNCTION; Schema: util; Owner: -
467
--
468
469
CREATE FUNCTION "_nullIf"(value anyelement, "null" text, type text) RETURNS anyelement
470
    LANGUAGE sql IMMUTABLE
471
    AS $_$
472
SELECT util."_nullIf"($1, $2, $3::util.datatype)
473
$_$;
474
475
476
--
477 8183 aaronmk
-- Name: _nullIf(anyelement, text, datatype); Type: FUNCTION; Schema: util; Owner: -
478 2949 aaronmk
--
479
480 4475 aaronmk
CREATE FUNCTION "_nullIf"(value anyelement, "null" text, type datatype DEFAULT 'str'::datatype) RETURNS anyelement
481 2949 aaronmk
    LANGUAGE plpgsql IMMUTABLE
482
    AS $$
483
DECLARE
484 8183 aaronmk
    type util.datatype NOT NULL := type; -- add NOT NULL
485 2949 aaronmk
BEGIN
486 4475 aaronmk
    IF type = 'str' THEN RETURN nullif(value::text, "null");
487 2722 aaronmk
    -- Invalid value is ignored, but invalid null value generates error
488 2949 aaronmk
    ELSIF type = 'float' THEN
489 2722 aaronmk
        DECLARE
490
            -- Outside the try block so that invalid null value generates error
491 2949 aaronmk
            "null" double precision := "null"::double precision;
492 2722 aaronmk
        BEGIN
493 2949 aaronmk
            RETURN nullif(value::double precision, "null");
494 2722 aaronmk
        EXCEPTION
495 2949 aaronmk
            WHEN data_exception THEN RETURN value; -- ignore invalid value
496 2722 aaronmk
        END;
497 2610 aaronmk
    END IF;
498
END;
499
$$;
500
501
502
--
503 8183 aaronmk
-- Name: _or(boolean, boolean, boolean, boolean, boolean); Type: FUNCTION; Schema: util; Owner: -
504 6355 aaronmk
--
505
506
CREATE FUNCTION _or("0" boolean DEFAULT NULL::boolean, "1" boolean DEFAULT NULL::boolean, "2" boolean DEFAULT NULL::boolean, "3" boolean DEFAULT NULL::boolean, "4" boolean DEFAULT NULL::boolean) RETURNS boolean
507
    LANGUAGE sql IMMUTABLE
508
    AS $_$
509
SELECT bool_or(value)
510
FROM
511
(VALUES
512
      ($1)
513
    , ($2)
514
    , ($3)
515
    , ($4)
516
    , ($5)
517
)
518
AS v (value)
519
$_$;
520
521
522
--
523 8183 aaronmk
-- Name: FUNCTION _or("0" boolean, "1" boolean, "2" boolean, "3" boolean, "4" boolean); Type: COMMENT; Schema: util; Owner: -
524 6437 aaronmk
--
525
526 12235 aaronmk
COMMENT ON FUNCTION _or("0" boolean, "1" boolean, "2" boolean, "3" boolean, "4" boolean) IS '
527
_or() ignores NULL values, while OR combines them with the other values to potentially convert false to NULL. OR should be used with required fields, and _or() with optional fields.
528
';
529 6437 aaronmk
530
531
--
532 8183 aaronmk
-- Name: _range(double precision, double precision); Type: FUNCTION; Schema: util; Owner: -
533 7706 aaronmk
--
534
535
CREATE FUNCTION _range("from" double precision DEFAULT NULL::double precision, "to" double precision DEFAULT NULL::double precision) RETURNS double precision
536
    LANGUAGE sql IMMUTABLE
537
    AS $_$
538
SELECT $2 - $1
539
$_$;
540
541
542
--
543 8183 aaronmk
-- Name: _split(text, text); Type: FUNCTION; Schema: util; Owner: -
544 6793 aaronmk
--
545
546
CREATE FUNCTION _split(value text DEFAULT NULL::text, separator text DEFAULT '; '::text) RETURNS SETOF text
547 10388 aaronmk
    LANGUAGE sql IMMUTABLE
548 6793 aaronmk
    AS $_$
549
SELECT regexp_split_to_table($1, $2)
550
$_$;
551
552
553
--
554 10594 aaronmk
-- Name: added_cols(regclass, regclass); Type: FUNCTION; Schema: util; Owner: -
555
--
556
557
CREATE FUNCTION added_cols(table_ regclass, names regclass) RETURNS SETOF text
558 12446 aaronmk
    LANGUAGE sql STABLE
559 10594 aaronmk
    AS $_$
560
SELECT util.derived_cols($1, $2)
561
UNION
562
SELECT util.eval2set($$
563
SELECT col
564
FROM util.col_names($$||quote_nullable($1)||$$::regclass) f (col)
565
JOIN $$||$2||$$ ON "to" = col
566
WHERE "from" LIKE ':%'
567
$$, NULL::text)
568
$_$;
569
570
571
--
572
-- Name: FUNCTION added_cols(table_ regclass, names regclass); Type: COMMENT; Schema: util; Owner: -
573
--
574
575 12235 aaronmk
COMMENT ON FUNCTION added_cols(table_ regclass, names regclass) IS '
576
gets table_''s added columns (all the columns not in the original data)
577
';
578 10594 aaronmk
579
580
--
581 9959 aaronmk
-- Name: all_same_final(anyarray); Type: FUNCTION; Schema: util; Owner: -
582
--
583
584
CREATE FUNCTION all_same_final(state anyarray) RETURNS boolean
585
    LANGUAGE sql IMMUTABLE
586
    AS $_$
587
SELECT $1 IS NULL/*no rows*/ OR util.not_empty($1)/*not no_match_sentinel*/
588
$_$;
589
590
591
--
592
-- Name: all_same_transform(anyarray, anyelement); Type: FUNCTION; Schema: util; Owner: -
593
--
594
595
CREATE FUNCTION all_same_transform(state anyarray, value anyelement) RETURNS anyarray
596
    LANGUAGE plpgsql IMMUTABLE
597
    AS $$
598
DECLARE
599
	value_cmp         state%TYPE = ARRAY[value];
600
	state             state%TYPE = COALESCE(state, value_cmp);
601
	no_match_sentinel state%TYPE = value_cmp[1:0]/*=ARRAY[]::state%TYPE*/;
602
BEGIN
603
	RETURN (CASE WHEN value_cmp IS NOT DISTINCT FROM state THEN state ELSE no_match_sentinel END);
604
END;
605
$$;
606
607
608
--
609 12320 aaronmk
-- Name: analyze_(regclass); Type: FUNCTION; Schema: util; Owner: -
610
--
611
612
CREATE FUNCTION analyze_(table_ regclass) RETURNS void
613
    LANGUAGE sql
614
    AS $_$
615
SELECT util.eval($$ANALYZE VERBOSE $$||$1)
616
$_$;
617
618
619
--
620 12369 aaronmk
-- Name: append_comment(regclass, text); Type: FUNCTION; Schema: util; Owner: -
621
--
622
623
CREATE FUNCTION append_comment(table_ regclass, comment text) RETURNS void
624 12446 aaronmk
    LANGUAGE sql
625 12369 aaronmk
    AS $_$
626
SELECT util.set_comment($1, concat(util.comment($1), $2))
627
$_$;
628
629
630
--
631
-- Name: FUNCTION append_comment(table_ regclass, comment text); Type: COMMENT; Schema: util; Owner: -
632
--
633
634
COMMENT ON FUNCTION append_comment(table_ regclass, comment text) IS '
635
comment: must start and end with a newline
636
';
637
638
639
--
640 10305 aaronmk
-- Name: array_fill(anyelement, integer); Type: FUNCTION; Schema: util; Owner: -
641
--
642
643
CREATE FUNCTION array_fill(value anyelement, length integer) RETURNS anyarray
644
    LANGUAGE sql IMMUTABLE
645
    AS $_$
646
SELECT pg_catalog.array_fill($1, ARRAY[$2])
647
$_$;
648
649
650
--
651 10303 aaronmk
-- Name: array_length(anyarray); Type: FUNCTION; Schema: util; Owner: -
652
--
653
654
CREATE FUNCTION array_length("array" anyarray) RETURNS integer
655 10354 aaronmk
    LANGUAGE sql IMMUTABLE
656 10303 aaronmk
    AS $_$
657 10321 aaronmk
SELECT util.array_length($1, 1)
658 10303 aaronmk
$_$;
659
660
661
--
662 10304 aaronmk
-- Name: array_length(anyarray, integer); Type: FUNCTION; Schema: util; Owner: -
663
--
664
665
CREATE FUNCTION array_length("array" anyarray, dimension integer) RETURNS integer
666 10354 aaronmk
    LANGUAGE sql IMMUTABLE
667 10304 aaronmk
    AS $_$
668 10354 aaronmk
SELECT CASE WHEN $1 IS NULL THEN NULL ELSE COALESCE(pg_catalog.array_length($1, $2), 0) END
669 10304 aaronmk
$_$;
670
671
672
--
673
-- Name: FUNCTION array_length("array" anyarray, dimension integer); Type: COMMENT; Schema: util; Owner: -
674
--
675
676 12235 aaronmk
COMMENT ON FUNCTION array_length("array" anyarray, dimension integer) IS '
677
returns 0 instead of NULL for empty arrays
678
';
679 10304 aaronmk
680
681
--
682 8183 aaronmk
-- Name: cluster_index(regclass); Type: FUNCTION; Schema: util; Owner: -
683 8104 aaronmk
--
684
685
CREATE FUNCTION cluster_index(table_ regclass) RETURNS regclass
686 12446 aaronmk
    LANGUAGE sql STABLE
687 8104 aaronmk
    AS $_$
688
SELECT indexrelid FROM pg_index WHERE indrelid = $1 AND indisclustered
689
$_$;
690
691
692
--
693 8183 aaronmk
-- Name: cluster_once(regclass, regclass); Type: FUNCTION; Schema: util; Owner: -
694 8105 aaronmk
--
695
696
CREATE FUNCTION cluster_once(table_ regclass, index regclass) RETURNS void
697
    LANGUAGE plpgsql STRICT
698
    AS $_$
699
BEGIN
700
    -- not yet clustered (ARRAY[] compares NULLs literally)
701 8183 aaronmk
    IF ARRAY[util.cluster_index(table_)] != ARRAY[index] THEN
702 8105 aaronmk
        EXECUTE $$CLUSTER $$||table_||$$ USING $$||index;
703
    END IF;
704
END;
705
$_$;
706
707
708
--
709 8183 aaronmk
-- Name: FUNCTION cluster_once(table_ regclass, index regclass); Type: COMMENT; Schema: util; Owner: -
710 8105 aaronmk
--
711
712 12235 aaronmk
COMMENT ON FUNCTION cluster_once(table_ regclass, index regclass) IS '
713
idempotent
714
';
715 8105 aaronmk
716
717
--
718 10986 aaronmk
-- Name: col__min(col_ref); Type: FUNCTION; Schema: util; Owner: -
719
--
720
721
CREATE FUNCTION col__min(col col_ref) RETURNS integer
722
    LANGUAGE sql STABLE
723
    AS $_$
724
SELECT util.eval2val($$
725
SELECT $$||quote_ident($1.name)||$$
726
FROM $$||$1.table_||$$
727
ORDER BY $$||quote_ident($1.name)||$$ ASC
728
LIMIT 1
729
$$, NULL::integer)
730
$_$;
731
732
733
--
734 10136 aaronmk
-- Name: col_comment(col_ref); Type: FUNCTION; Schema: util; Owner: -
735
--
736
737
CREATE FUNCTION col_comment(col col_ref) RETURNS text
738
    LANGUAGE plpgsql STABLE STRICT
739
    AS $$
740
DECLARE
741
	comment text;
742
BEGIN
743
	SELECT description
744
	FROM pg_attribute
745
	LEFT JOIN pg_description ON objoid = attrelid
746
		AND classoid = 'pg_class'::regclass AND objsubid = attnum
747
	WHERE attrelid = col.table_ AND attname = col.name
748
	INTO STRICT comment
749
	;
750
	RETURN comment;
751
EXCEPTION
752
	WHEN no_data_found THEN PERFORM util.raise_undefined_column(col);
753
END;
754
$$;
755
756
757
--
758 10130 aaronmk
-- Name: col_default_sql(col_ref); Type: FUNCTION; Schema: util; Owner: -
759
--
760
761
CREATE FUNCTION col_default_sql(col col_ref) RETURNS text
762
    LANGUAGE plpgsql STABLE STRICT
763
    AS $$
764
DECLARE
765
	default_sql text;
766
BEGIN
767
	SELECT adsrc
768
	FROM pg_attribute
769
	LEFT JOIN pg_attrdef ON adrelid = attrelid AND adnum = attnum
770
	WHERE attrelid = col.table_ AND attname = col.name
771
	INTO STRICT default_sql
772
	;
773
	RETURN default_sql;
774
EXCEPTION
775
	WHEN no_data_found THEN PERFORM util.raise_undefined_column(col);
776
END;
777
$$;
778
779
780
--
781 10134 aaronmk
-- Name: col_default_value(col_ref, anyelement); Type: FUNCTION; Schema: util; Owner: -
782
--
783
784
CREATE FUNCTION col_default_value(col col_ref, ret_type_null anyelement DEFAULT NULL::text) RETURNS anyelement
785
    LANGUAGE sql STABLE
786
    AS $_$
787
SELECT util.eval_expr_passthru(util.col_default_sql($1), $2)
788
$_$;
789
790
791
--
792
-- Name: FUNCTION col_default_value(col col_ref, ret_type_null anyelement); Type: COMMENT; Schema: util; Owner: -
793
--
794
795 12235 aaronmk
COMMENT ON FUNCTION col_default_value(col col_ref, ret_type_null anyelement) IS '
796
ret_type_null: NULL::ret_type
797
';
798 10134 aaronmk
799
800
--
801 8183 aaronmk
-- Name: col_exists(col_ref); Type: FUNCTION; Schema: util; Owner: -
802 8180 aaronmk
--
803
804
CREATE FUNCTION col_exists(col col_ref) RETURNS boolean
805
    LANGUAGE plpgsql STRICT
806
    AS $$
807
BEGIN
808 8183 aaronmk
    PERFORM util.col_type(col);
809 8180 aaronmk
    RETURN true;
810
EXCEPTION
811
    WHEN undefined_column THEN RETURN false;
812
END;
813
$$;
814
815
816
--
817 8183 aaronmk
-- Name: col_global_names(regtype); Type: FUNCTION; Schema: util; Owner: -
818 8084 aaronmk
--
819
820
CREATE FUNCTION col_global_names(type regtype, OUT name text, OUT global_name text) RETURNS SETOF record
821 8097 aaronmk
    LANGUAGE plpgsql STABLE STRICT
822 8084 aaronmk
    AS $$
823
DECLARE
824 8183 aaronmk
    prefix text := util.name(type)||'.';
825 8084 aaronmk
BEGIN
826
    RETURN QUERY
827 8183 aaronmk
        SELECT name_, (CASE WHEN util.contains(search_for:='.', in_str:=name_) THEN '' ELSE prefix END)||name_
828
        FROM util.col_names(type) f (name_);
829 8084 aaronmk
END;
830
$$;
831
832
833
--
834 8183 aaronmk
-- Name: col_names(regclass); Type: FUNCTION; Schema: util; Owner: -
835 8151 aaronmk
--
836
837
CREATE FUNCTION col_names(table_ regclass) RETURNS SETOF text
838 12446 aaronmk
    LANGUAGE sql STABLE
839 8151 aaronmk
    AS $_$
840
SELECT attname::text
841
FROM pg_attribute
842 10158 aaronmk
WHERE attrelid = $1 AND attnum >= 1 AND NOT attisdropped
843 8151 aaronmk
ORDER BY attnum
844
$_$;
845
846
847
--
848 11667 aaronmk
-- Name: col_names(regtype); Type: FUNCTION; Schema: util; Owner: -
849
--
850
851
CREATE FUNCTION col_names(type regtype) RETURNS SETOF text
852
    LANGUAGE plpgsql STABLE STRICT
853
    AS $_$
854
BEGIN
855
    RETURN QUERY EXECUTE $$SELECT skeys(hstore(NULL::$$||type||$$))$$;
856
END;
857
$_$;
858
859
860
--
861 8183 aaronmk
-- Name: col_type(col_ref); Type: FUNCTION; Schema: util; Owner: -
862 8106 aaronmk
--
863
864
CREATE FUNCTION col_type(col col_ref) RETURNS regtype
865 8169 aaronmk
    LANGUAGE plpgsql STABLE STRICT
866
    AS $$
867
DECLARE
868
    type regtype;
869
BEGIN
870
    SELECT atttypid FROM pg_attribute
871
    WHERE attrelid = col.table_ AND attname = col.name
872
    INTO STRICT type
873
    ;
874
    RETURN type;
875
EXCEPTION
876 8171 aaronmk
    WHEN no_data_found THEN
877 8181 aaronmk
        RAISE undefined_column USING MESSAGE =
878
            concat('undefined column: ', col.name);
879 8169 aaronmk
END;
880
$$;
881 8106 aaronmk
882
883
--
884 12368 aaronmk
-- Name: comment(oid); Type: FUNCTION; Schema: util; Owner: -
885
--
886
887
CREATE FUNCTION comment(element oid) RETURNS text
888 12446 aaronmk
    LANGUAGE sql STABLE
889 12368 aaronmk
    AS $_$
890
SELECT description FROM pg_description WHERE objoid = $1
891
$_$;
892
893
894
--
895 11005 aaronmk
-- Name: concat_esc(text, text); Type: FUNCTION; Schema: util; Owner: -
896
--
897
898
CREATE FUNCTION concat_esc("left" text, "right" text) RETURNS text
899
    LANGUAGE sql IMMUTABLE
900
    AS $_$
901
SELECT util.esc_name__append($2, $1)
902
$_$;
903
904
905
--
906 8183 aaronmk
-- Name: contains(text, text); Type: FUNCTION; Schema: util; Owner: -
907 8095 aaronmk
--
908
909
CREATE FUNCTION contains(search_for text, in_str text) RETURNS boolean
910 10388 aaronmk
    LANGUAGE sql IMMUTABLE
911 8095 aaronmk
    AS $_$
912
SELECT position($1 in $2) > 0 /*1-based offset*/
913
$_$;
914
915
916
--
917 12288 aaronmk
-- Name: copy_struct(regclass, text); Type: FUNCTION; Schema: util; Owner: -
918
--
919
920
CREATE FUNCTION copy_struct(from_ regclass, to_ text) RETURNS void
921
    LANGUAGE sql
922
    AS $_$
923
SELECT util.eval($$CREATE TABLE $$||$2||$$ (LIKE $$||$1||$$ INCLUDING ALL)$$)
924
$_$;
925
926
927
--
928 8183 aaronmk
-- Name: create_if_not_exists(text); Type: FUNCTION; Schema: util; Owner: -
929 8094 aaronmk
--
930
931
CREATE FUNCTION create_if_not_exists(sql text) RETURNS void
932
    LANGUAGE plpgsql STRICT
933
    AS $$
934
BEGIN
935 10146 aaronmk
    PERFORM util.eval(sql);
936 8094 aaronmk
EXCEPTION
937 8103 aaronmk
    WHEN duplicate_table  THEN NULL;
938 10181 aaronmk
    WHEN duplicate_object THEN NULL; -- e.g. constraint
939 8103 aaronmk
    WHEN duplicate_column THEN NULL;
940 10244 aaronmk
    WHEN invalid_table_definition THEN
941
        IF SQLERRM LIKE 'multiple primary keys for table % are not allowed' THEN NULL;
942 12568 aaronmk
        ELSE RAISE;
943 10244 aaronmk
        END IF;
944 8094 aaronmk
END;
945
$$;
946
947
948
--
949 8183 aaronmk
-- Name: FUNCTION create_if_not_exists(sql text); Type: COMMENT; Schema: util; Owner: -
950 8094 aaronmk
--
951
952 12235 aaronmk
COMMENT ON FUNCTION create_if_not_exists(sql text) IS '
953
idempotent
954
';
955 8094 aaronmk
956
957
--
958 12378 aaronmk
-- Name: curr_func(text, anyelement); Type: FUNCTION; Schema: util; Owner: -
959
--
960
961
CREATE FUNCTION curr_func(func text, schema_anchor anyelement) RETURNS text
962
    LANGUAGE sql IMMUTABLE
963
    AS $$
964
SELECT util.schema_esc(schema_anchor)||'.'||quote_ident(func)
965
$$;
966
967
968
--
969 12433 aaronmk
-- Name: debug_print_return_value(anyelement, boolean); Type: FUNCTION; Schema: util; Owner: -
970 12430 aaronmk
--
971
972 12433 aaronmk
CREATE FUNCTION debug_print_return_value(value anyelement, encode boolean DEFAULT false) RETURNS anyelement
973 12430 aaronmk
    LANGUAGE sql IMMUTABLE
974
    AS $_$
975 12534 aaronmk
SELECT util.raise('NOTICE', 'returns: '
976 12433 aaronmk
||(CASE WHEN $2 THEN util.quote_typed($1) ELSE $1::text END));
977 12430 aaronmk
SELECT $1;
978
$_$;
979
980
981
--
982 12250 aaronmk
-- Name: debug_print_sql(text); Type: FUNCTION; Schema: util; Owner: -
983
--
984
985
CREATE FUNCTION debug_print_sql(sql text) RETURNS void
986
    LANGUAGE sql IMMUTABLE
987
    AS $_$
988
/* newline before so the query starts at the beginning of the line.
989
newline after to visually separate queries from one another. */
990 12534 aaronmk
SELECT util.raise('NOTICE', $$
991 12474 aaronmk
$$||util.runnable_sql($1)||$$
992 12464 aaronmk
$$||COALESCE(util.explain2notice_msg_if_can($1), ''))
993 12250 aaronmk
$_$;
994
995
996
--
997 10364 aaronmk
-- Name: derived_cols(regclass, regclass); Type: FUNCTION; Schema: util; Owner: -
998
--
999
1000
CREATE FUNCTION derived_cols(table_ regclass, names regclass) RETURNS SETOF text
1001 12446 aaronmk
    LANGUAGE sql STABLE
1002 10364 aaronmk
    AS $_$
1003
SELECT util.eval2set($$
1004
SELECT col
1005
FROM util.col_names($$||quote_nullable($1)||$$::regclass) f (col)
1006
LEFT JOIN $$||$2||$$ ON "to" = col
1007
WHERE "from" IS NULL
1008
$$, NULL::text)
1009
$_$;
1010
1011
1012
--
1013
-- Name: FUNCTION derived_cols(table_ regclass, names regclass); Type: COMMENT; Schema: util; Owner: -
1014
--
1015
1016 12235 aaronmk
COMMENT ON FUNCTION derived_cols(table_ regclass, names regclass) IS '
1017
gets table_''s derived columns (all the columns not in the names table)
1018
';
1019 10364 aaronmk
1020
1021
--
1022 12298 aaronmk
-- Name: diff(regclass, regclass, anyelement); Type: FUNCTION; Schema: util; Owner: -
1023 12044 aaronmk
--
1024
1025 12298 aaronmk
CREATE FUNCTION diff(left_table regclass, right_table regclass, col_type_null anyelement, OUT left_ anyelement, OUT right_ anyelement) RETURNS SETOF record
1026 12427 aaronmk
    LANGUAGE sql
1027 12044 aaronmk
    AS $_$
1028 12300 aaronmk
SELECT * FROM util.diff($1::text, $2::text, $3,
1029 12491 aaronmk
	single_row := util.has_single_row($1) AND util.has_single_row($2))
1030 12298 aaronmk
$_$;
1031
1032
1033
--
1034
-- Name: FUNCTION diff(left_table regclass, right_table regclass, col_type_null anyelement, OUT left_ anyelement, OUT right_ anyelement); Type: COMMENT; Schema: util; Owner: -
1035
--
1036
1037
COMMENT ON FUNCTION diff(left_table regclass, right_table regclass, col_type_null anyelement, OUT left_ anyelement, OUT right_ anyelement) IS '
1038
col_type_null (*required*): NULL::shared_base_type
1039
usage:
1040
SELECT * FROM util.diff(''"left_table"''::regclass, ''"right_table"''::regclass, NULL::shared_base_type)
1041
';
1042
1043
1044
--
1045 12491 aaronmk
-- Name: diff(text, text, anyelement, boolean); Type: FUNCTION; Schema: util; Owner: -
1046 12298 aaronmk
--
1047
1048 12491 aaronmk
CREATE FUNCTION diff(left__ text, right__ text, col_type_null anyelement, single_row boolean DEFAULT false, OUT left_ anyelement, OUT right_ anyelement) RETURNS SETOF record
1049 12429 aaronmk
    LANGUAGE plpgsql
1050
    SET search_path TO pg_temp
1051 12298 aaronmk
    AS $_$
1052 12429 aaronmk
/* must use LANGUAGE plpgsql because LANGUAGE sql does not support runtime
1053
changes of search_path (schema elements are bound at inline time rather than
1054
runtime) */
1055
/* function option search_path is needed to limit the effects of
1056 12492 aaronmk
`SET LOCAL search_path` to the current function */
1057 12429 aaronmk
BEGIN
1058 12491 aaronmk
	PERFORM util.use_schema($3); -- includes util.%== as default/fallback
1059 12429 aaronmk
1060 12565 aaronmk
	PERFORM util.mk_keys_func(pg_typeof($3));
1061 12429 aaronmk
	RETURN QUERY
1062 12554 aaronmk
		SELECT * FROM util.eval2col_pair(util.mk_diff_query($1, $2,
1063 12479 aaronmk
$$/* need to explicitly cast each side to the return type because this does not
1064 12284 aaronmk
happen automatically even when an implicit cast is available */
1065 12479 aaronmk
  left_::$$||util.typeof($3)||$$
1066
, right_::$$||util.typeof($3)
1067 12496 aaronmk
/* when using the util.%==(anyelement, anyelement) operator, you must cast to
1068
the *same* base type, *even though* this is optional when using a custom %== */
1069 12553 aaronmk
, util._if($4, $$true/*= CROSS JOIN*/$$,
1070
$$ left_::$$||util.typeof($3)||$$
1071 12496 aaronmk
%== right_::$$||util.typeof($3)||$$
1072
	-- refer to EXPLAIN output for expansion of %==$$
1073 12553 aaronmk
)), $3)
1074 12429 aaronmk
	;
1075
END;
1076 12044 aaronmk
$_$;
1077
1078
1079
--
1080 12491 aaronmk
-- Name: FUNCTION diff(left__ text, right__ text, col_type_null anyelement, single_row boolean, OUT left_ anyelement, OUT right_ anyelement); Type: COMMENT; Schema: util; Owner: -
1081 12280 aaronmk
--
1082
1083 12491 aaronmk
COMMENT ON FUNCTION diff(left__ text, right__ text, col_type_null anyelement, single_row boolean, OUT left_ anyelement, OUT right_ anyelement) IS '
1084 12280 aaronmk
col_type_null (*required*): NULL::col_type
1085 12299 aaronmk
single_row: whether the tables consist of a single row, which should be
1086
	displayed side-by-side
1087 12282 aaronmk
1088 12498 aaronmk
to match up rows using a subset of the columns, create a custom keys() function
1089
which returns this subset as a record:
1090
-- note that OUT parameters for the returned fields are *not* needed
1091
CREATE OR REPLACE FUNCTION [schema].keys(value [schema].[base_type])
1092
  RETURNS record AS
1093
$BODY$
1094
SELECT ($1.key_field_0, $1.key_field_1)
1095
$BODY$
1096
  LANGUAGE sql IMMUTABLE
1097
  COST 100;
1098
1099
1100 12282 aaronmk
to run EXPLAIN on the FULL JOIN query:
1101
# run this function
1102
# look for a NOTICE containing the expanded query that it ran
1103
# run EXPLAIN on this expanded query
1104 12280 aaronmk
';
1105
1106
1107
--
1108 8200 aaronmk
-- Name: do_optionally_ignore(text, boolean); Type: FUNCTION; Schema: util; Owner: -
1109
--
1110
1111
CREATE FUNCTION do_optionally_ignore(sql text, ignore boolean) RETURNS void
1112 12446 aaronmk
    LANGUAGE sql
1113 8200 aaronmk
    AS $_$
1114
SELECT CASE WHEN $2 THEN util.try_create($1) ELSE util.create_if_not_exists($1) END
1115
$_$;
1116
1117
1118
--
1119
-- Name: FUNCTION do_optionally_ignore(sql text, ignore boolean); Type: COMMENT; Schema: util; Owner: -
1120
--
1121
1122 12235 aaronmk
COMMENT ON FUNCTION do_optionally_ignore(sql text, ignore boolean) IS '
1123
idempotent
1124
';
1125 8200 aaronmk
1126
1127
--
1128 12292 aaronmk
-- Name: drop_column(col_ref, boolean); Type: FUNCTION; Schema: util; Owner: -
1129 10362 aaronmk
--
1130
1131 12292 aaronmk
CREATE FUNCTION drop_column(col col_ref, force boolean DEFAULT false) RETURNS void
1132 12446 aaronmk
    LANGUAGE sql
1133 10362 aaronmk
    AS $_$
1134
SELECT util.eval($$ALTER TABLE $$||$1.table_||$$ DROP COLUMN IF EXISTS $$||
1135 12292 aaronmk
quote_ident($1.name)||util._if($2, $$ CASCADE$$, ''::text))
1136 10362 aaronmk
$_$;
1137
1138
1139
--
1140 12292 aaronmk
-- Name: FUNCTION drop_column(col col_ref, force boolean); Type: COMMENT; Schema: util; Owner: -
1141 10362 aaronmk
--
1142
1143 12292 aaronmk
COMMENT ON FUNCTION drop_column(col col_ref, force boolean) IS '
1144 12235 aaronmk
idempotent
1145
';
1146 10362 aaronmk
1147
1148
--
1149 12331 aaronmk
-- Name: drop_relation(regclass, boolean); Type: FUNCTION; Schema: util; Owner: -
1150
--
1151
1152
CREATE FUNCTION drop_relation(relation regclass, force boolean DEFAULT false) RETURNS void
1153
    LANGUAGE sql
1154
    AS $_$
1155 12353 aaronmk
/* use util.qual_name() instead of ::text so that the schema qualifier is always
1156
included in the debug SQL */
1157
SELECT util.drop_relation(util.relation_type($1), util.qual_name($1), $2)
1158 12331 aaronmk
$_$;
1159
1160
1161
--
1162 12343 aaronmk
-- Name: drop_relation(text, text, boolean); Type: FUNCTION; Schema: util; Owner: -
1163
--
1164
1165 12364 aaronmk
CREATE FUNCTION drop_relation(type text, relation_esc text, force boolean DEFAULT false) RETURNS void
1166 12343 aaronmk
    LANGUAGE sql
1167
    AS $_$
1168 12347 aaronmk
SELECT util.eval($$DROP $$||$1||$$ IF EXISTS $$||$2
1169 12343 aaronmk
||util._if($3, $$ CASCADE$$, ''::text))
1170
$_$;
1171
1172
1173
--
1174 12364 aaronmk
-- Name: FUNCTION drop_relation(type text, relation_esc text, force boolean); Type: COMMENT; Schema: util; Owner: -
1175 12343 aaronmk
--
1176
1177 12364 aaronmk
COMMENT ON FUNCTION drop_relation(type text, relation_esc text, force boolean) IS '
1178 12343 aaronmk
idempotent
1179
';
1180
1181
1182
--
1183 12413 aaronmk
-- Name: drop_relations_like(text, anyelement, boolean); Type: FUNCTION; Schema: util; Owner: -
1184
--
1185
1186
CREATE FUNCTION drop_relations_like(name_regexp text, schema_anchor anyelement, force boolean DEFAULT false) RETURNS void
1187
    LANGUAGE sql
1188
    AS $_$
1189 12502 aaronmk
SELECT util.drop_relations_like($1, util.schema_regexp($2), $3)
1190 12413 aaronmk
$_$;
1191
1192
1193
--
1194
-- Name: drop_relations_like(text, text, boolean); Type: FUNCTION; Schema: util; Owner: -
1195
--
1196
1197
CREATE FUNCTION drop_relations_like(name_regexp text, schema_regexp text DEFAULT ''::text, force boolean DEFAULT false) RETURNS void
1198
    LANGUAGE sql
1199
    AS $_$
1200
SELECT util.drop_relation(relation, $3)
1201
FROM util.show_relations_like($1, $2) relation
1202
;
1203
SELECT NULL::void; -- don't fold away functions called in previous query
1204
$_$;
1205
1206
1207
--
1208 12292 aaronmk
-- Name: drop_table(text, boolean); Type: FUNCTION; Schema: util; Owner: -
1209 10150 aaronmk
--
1210
1211 12292 aaronmk
CREATE FUNCTION drop_table(table_ text, force boolean DEFAULT false) RETURNS void
1212 12446 aaronmk
    LANGUAGE sql
1213 10150 aaronmk
    AS $_$
1214 12347 aaronmk
SELECT util.drop_relation('TABLE', $1, $2)
1215 10150 aaronmk
$_$;
1216
1217
1218
--
1219 12292 aaronmk
-- Name: FUNCTION drop_table(table_ text, force boolean); Type: COMMENT; Schema: util; Owner: -
1220 10150 aaronmk
--
1221
1222 12292 aaronmk
COMMENT ON FUNCTION drop_table(table_ text, force boolean) IS '
1223 12235 aaronmk
idempotent
1224
';
1225 10150 aaronmk
1226
1227
--
1228 12292 aaronmk
-- Name: drop_view(text, boolean); Type: FUNCTION; Schema: util; Owner: -
1229 12229 aaronmk
--
1230
1231 12292 aaronmk
CREATE FUNCTION drop_view(view_ text, force boolean DEFAULT false) RETURNS void
1232 12446 aaronmk
    LANGUAGE sql
1233 12229 aaronmk
    AS $_$
1234 12347 aaronmk
SELECT util.drop_relation('VIEW', $1, $2)
1235 12229 aaronmk
$_$;
1236
1237
1238
--
1239 12292 aaronmk
-- Name: FUNCTION drop_view(view_ text, force boolean); Type: COMMENT; Schema: util; Owner: -
1240 12229 aaronmk
--
1241
1242 12292 aaronmk
COMMENT ON FUNCTION drop_view(view_ text, force boolean) IS '
1243 12235 aaronmk
idempotent
1244
';
1245 12229 aaronmk
1246
1247
--
1248 10322 aaronmk
-- Name: empty_array(anyelement); Type: FUNCTION; Schema: util; Owner: -
1249
--
1250
1251
CREATE FUNCTION empty_array(elem_type_null anyelement DEFAULT NULL::text) RETURNS anyarray
1252
    LANGUAGE sql IMMUTABLE
1253
    AS $_$
1254
SELECT util.array_fill($1, 0)
1255
$_$;
1256
1257
1258
--
1259
-- Name: FUNCTION empty_array(elem_type_null anyelement); Type: COMMENT; Schema: util; Owner: -
1260
--
1261
1262 12235 aaronmk
COMMENT ON FUNCTION empty_array(elem_type_null anyelement) IS '
1263
constructs proper empty 1-dimensional array whose dimensions are not NULL ( ''{}''::text[] does not do this)
1264
';
1265 10322 aaronmk
1266
1267
--
1268 8183 aaronmk
-- Name: ensure_prefix(text, text); Type: FUNCTION; Schema: util; Owner: -
1269 8086 aaronmk
--
1270
1271
CREATE FUNCTION ensure_prefix(prefix text, str text) RETURNS text
1272 10388 aaronmk
    LANGUAGE sql IMMUTABLE
1273 8086 aaronmk
    AS $_$
1274 8183 aaronmk
SELECT (CASE WHEN util.has_prefix($1, $2) THEN $2 ELSE $1||$2 END)
1275 8086 aaronmk
$_$;
1276
1277
1278
--
1279 10987 aaronmk
-- Name: esc_name__append(text, text); Type: FUNCTION; Schema: util; Owner: -
1280
--
1281
1282
CREATE FUNCTION esc_name__append(suffix text, esc_name text) RETURNS text
1283
    LANGUAGE sql IMMUTABLE
1284
    AS $_$
1285
SELECT regexp_replace($2, '("?)$', $1||'\1')
1286
$_$;
1287
1288
1289
--
1290 12531 aaronmk
-- Name: eval(text, boolean); Type: FUNCTION; Schema: util; Owner: -
1291 9824 aaronmk
--
1292
1293 12531 aaronmk
CREATE FUNCTION eval(sql text, verbose_ boolean DEFAULT true) RETURNS void
1294 12558 aaronmk
    LANGUAGE plpgsql
1295 9824 aaronmk
    AS $$
1296
BEGIN
1297 12531 aaronmk
	IF verbose_ THEN PERFORM util.debug_print_sql(sql); END IF;
1298 12251 aaronmk
	EXECUTE sql;
1299 9824 aaronmk
END;
1300
$$;
1301
1302
1303
--
1304 12181 aaronmk
-- Name: eval2col_pair(text, anyelement); Type: FUNCTION; Schema: util; Owner: -
1305
--
1306
1307
CREATE FUNCTION eval2col_pair(sql text, col_type_null anyelement, OUT left_ anyelement, OUT right_ anyelement) RETURNS SETOF record
1308
    LANGUAGE plpgsql
1309
    AS $$
1310
BEGIN
1311 12251 aaronmk
	PERFORM util.debug_print_sql(sql);
1312 12181 aaronmk
	RETURN QUERY EXECUTE sql;
1313
END;
1314
$$;
1315
1316
1317
--
1318
-- Name: FUNCTION eval2col_pair(sql text, col_type_null anyelement, OUT left_ anyelement, OUT right_ anyelement); Type: COMMENT; Schema: util; Owner: -
1319
--
1320
1321 12235 aaronmk
COMMENT ON FUNCTION eval2col_pair(sql text, col_type_null anyelement, OUT left_ anyelement, OUT right_ anyelement) IS '
1322
col_type_null (*required*): NULL::col_type
1323
';
1324 12181 aaronmk
1325
1326
--
1327 12301 aaronmk
-- Name: eval2records(text); Type: FUNCTION; Schema: util; Owner: -
1328
--
1329
1330
CREATE FUNCTION eval2records(sql text) RETURNS SETOF record
1331
    LANGUAGE plpgsql
1332
    AS $$
1333
BEGIN
1334
	PERFORM util.debug_print_sql(sql);
1335
	RETURN QUERY EXECUTE sql;
1336
END;
1337
$$;
1338
1339
1340
--
1341 12458 aaronmk
-- Name: eval2set(text, anyelement, boolean); Type: FUNCTION; Schema: util; Owner: -
1342 10363 aaronmk
--
1343
1344 12458 aaronmk
CREATE FUNCTION eval2set(sql text, ret_type_null anyelement DEFAULT NULL::text, verbose_ boolean DEFAULT true) RETURNS SETOF anyelement
1345 10363 aaronmk
    LANGUAGE plpgsql
1346
    AS $$
1347
BEGIN
1348 12458 aaronmk
	IF verbose_ THEN PERFORM util.debug_print_sql(sql); END IF;
1349 10363 aaronmk
	RETURN QUERY EXECUTE sql;
1350
END;
1351
$$;
1352
1353
1354
--
1355 10129 aaronmk
-- Name: eval2val(text, anyelement); Type: FUNCTION; Schema: util; Owner: -
1356 10128 aaronmk
--
1357
1358 10129 aaronmk
CREATE FUNCTION eval2val(sql text, ret_type_null anyelement DEFAULT NULL::text) RETURNS anyelement
1359 12514 aaronmk
    LANGUAGE plpgsql STABLE
1360 10128 aaronmk
    AS $$
1361
DECLARE
1362
	ret_val ret_type_null%TYPE;
1363
BEGIN
1364 12251 aaronmk
	PERFORM util.debug_print_sql(sql);
1365 10128 aaronmk
	EXECUTE sql INTO STRICT ret_val;
1366
	RETURN ret_val;
1367
END;
1368
$$;
1369
1370
1371
--
1372 10129 aaronmk
-- Name: FUNCTION eval2val(sql text, ret_type_null anyelement); Type: COMMENT; Schema: util; Owner: -
1373 10128 aaronmk
--
1374
1375 12235 aaronmk
COMMENT ON FUNCTION eval2val(sql text, ret_type_null anyelement) IS '
1376
ret_type_null: NULL::ret_type
1377
';
1378 10128 aaronmk
1379
1380
--
1381 10131 aaronmk
-- Name: eval_expr(text, anyelement); Type: FUNCTION; Schema: util; Owner: -
1382
--
1383
1384
CREATE FUNCTION eval_expr(sql text, ret_type_null anyelement DEFAULT NULL::text) RETURNS anyelement
1385
    LANGUAGE sql
1386
    AS $_$
1387 10132 aaronmk
SELECT util.eval2val($$SELECT $$||$1, $2)
1388 10131 aaronmk
$_$;
1389
1390
1391
--
1392
-- Name: FUNCTION eval_expr(sql text, ret_type_null anyelement); Type: COMMENT; Schema: util; Owner: -
1393
--
1394
1395 12235 aaronmk
COMMENT ON FUNCTION eval_expr(sql text, ret_type_null anyelement) IS '
1396
ret_type_null: NULL::ret_type
1397
';
1398 10131 aaronmk
1399
1400
--
1401 10133 aaronmk
-- Name: eval_expr_passthru(text, anyelement); Type: FUNCTION; Schema: util; Owner: -
1402
--
1403
1404
CREATE FUNCTION eval_expr_passthru(sql text, ret_type_null anyelement DEFAULT NULL::text) RETURNS anyelement
1405
    LANGUAGE sql
1406
    AS $_$
1407
SELECT CASE WHEN $1 IS NULL THEN NULL ELSE util.eval_expr($1, $2) END
1408
$_$;
1409
1410
1411
--
1412
-- Name: FUNCTION eval_expr_passthru(sql text, ret_type_null anyelement); Type: COMMENT; Schema: util; Owner: -
1413
--
1414
1415 12235 aaronmk
COMMENT ON FUNCTION eval_expr_passthru(sql text, ret_type_null anyelement) IS '
1416
sql: can be NULL, which will be passed through
1417
ret_type_null: NULL::ret_type
1418
';
1419 10133 aaronmk
1420
1421
--
1422 8183 aaronmk
-- Name: existing_cols(regclass, text[]); Type: FUNCTION; Schema: util; Owner: -
1423 8182 aaronmk
--
1424
1425
CREATE FUNCTION existing_cols(table_ regclass, VARIADIC col_names text[]) RETURNS SETOF text
1426 12446 aaronmk
    LANGUAGE sql STABLE
1427 8182 aaronmk
    AS $_$
1428
SELECT col_name
1429
FROM unnest($2) s (col_name)
1430 8183 aaronmk
WHERE util.col_exists(($1, col_name))
1431 8182 aaronmk
$_$;
1432
1433
1434
--
1435 11830 aaronmk
-- Name: explain(text); Type: FUNCTION; Schema: util; Owner: -
1436
--
1437
1438
CREATE FUNCTION explain(sql text) RETURNS SETOF text
1439
    LANGUAGE sql
1440
    AS $_$
1441 12459 aaronmk
SELECT util.eval2set($$EXPLAIN $$||$1, verbose_ := false)
1442 11830 aaronmk
$_$;
1443
1444
1445
--
1446 11833 aaronmk
-- Name: explain2notice(text); Type: FUNCTION; Schema: util; Owner: -
1447
--
1448
1449
CREATE FUNCTION explain2notice(sql text) RETURNS void
1450 12449 aaronmk
    LANGUAGE sql
1451
    AS $_$
1452 12534 aaronmk
SELECT util.raise('NOTICE', util.explain2notice_msg($1))
1453 12449 aaronmk
$_$;
1454 12448 aaronmk
1455
1456
--
1457
-- Name: explain2notice_msg(text); Type: FUNCTION; Schema: util; Owner: -
1458
--
1459
1460
CREATE FUNCTION explain2notice_msg(sql text) RETURNS text
1461
    LANGUAGE sql
1462
    AS $_$
1463 12464 aaronmk
-- newline before and after to visually separate it from other debug info
1464
SELECT $$
1465
EXPLAIN:
1466
$$||util.explain2str($1)||$$
1467
$$
1468 11833 aaronmk
$_$;
1469
1470
1471
--
1472 12452 aaronmk
-- Name: explain2notice_msg_if_can(text); Type: FUNCTION; Schema: util; Owner: -
1473
--
1474
1475
CREATE FUNCTION explain2notice_msg_if_can(sql text) RETURNS text
1476
    LANGUAGE sql
1477
    AS $_$
1478
SELECT (CASE WHEN util.is_explainable($1) THEN util.explain2notice_msg($1) END)
1479
$_$;
1480
1481
1482
--
1483 11832 aaronmk
-- Name: explain2str(text); Type: FUNCTION; Schema: util; Owner: -
1484
--
1485
1486
CREATE FUNCTION explain2str(sql text) RETURNS text
1487
    LANGUAGE sql
1488
    AS $_$
1489
SELECT util.join_strs(explain, $$
1490
$$) FROM util.explain($1)
1491
$_$;
1492
1493
1494 11835 aaronmk
SET default_tablespace = '';
1495
1496
SET default_with_oids = false;
1497
1498 11832 aaronmk
--
1499 11835 aaronmk
-- Name: explain; Type: TABLE; Schema: util; Owner: -; Tablespace:
1500 11831 aaronmk
--
1501
1502 11835 aaronmk
CREATE TABLE explain (
1503
    line text NOT NULL
1504
);
1505
1506
1507
--
1508
-- Name: explain2table(text, regclass); Type: FUNCTION; Schema: util; Owner: -
1509
--
1510
1511
CREATE FUNCTION explain2table(sql text, table_ regclass DEFAULT 'explain'::regclass) RETURNS void
1512 11831 aaronmk
    LANGUAGE sql
1513
    AS $_$
1514 11835 aaronmk
SELECT util.eval($$INSERT INTO $$||$2||$$ SELECT util.explain(
1515
$$||quote_nullable($1)||$$
1516 11831 aaronmk
)$$)
1517
$_$;
1518
1519
1520
--
1521 11836 aaronmk
-- Name: FUNCTION explain2table(sql text, table_ regclass); Type: COMMENT; Schema: util; Owner: -
1522
--
1523
1524 12235 aaronmk
COMMENT ON FUNCTION explain2table(sql text, table_ regclass) IS '
1525
usage:
1526 11836 aaronmk
PERFORM util.explain2table($$
1527
query
1528 12235 aaronmk
$$);
1529
';
1530 11836 aaronmk
1531
1532
--
1533 12450 aaronmk
-- Name: first_word(text); Type: FUNCTION; Schema: util; Owner: -
1534
--
1535
1536
CREATE FUNCTION first_word(str text) RETURNS text
1537
    LANGUAGE sql IMMUTABLE
1538
    AS $_$
1539 12461 aaronmk
SELECT match[1] FROM regexp_matches(util.ltrim_nl($1), '^(\S*)') match
1540 12450 aaronmk
$_$;
1541
1542
1543
--
1544 10323 aaronmk
-- Name: fix_array(anyarray); Type: FUNCTION; Schema: util; Owner: -
1545
--
1546
1547
CREATE FUNCTION fix_array("array" anyarray) RETURNS anyarray
1548 10355 aaronmk
    LANGUAGE sql IMMUTABLE
1549 10323 aaronmk
    AS $_$
1550 10355 aaronmk
SELECT CASE WHEN $1 IS NULL THEN NULL ELSE (
1551
	CASE WHEN pg_catalog.array_ndims($1) IS NULL THEN util.empty_array($1[1]) ELSE $1 END
1552
) END
1553 10323 aaronmk
$_$;
1554
1555
1556
--
1557
-- Name: FUNCTION fix_array("array" anyarray); Type: COMMENT; Schema: util; Owner: -
1558
--
1559
1560 12235 aaronmk
COMMENT ON FUNCTION fix_array("array" anyarray) IS '
1561
ensures that an array will always have proper non-NULL dimensions
1562
';
1563 10323 aaronmk
1564
1565
--
1566 11695 aaronmk
-- Name: force_recreate(text, text[]); Type: FUNCTION; Schema: util; Owner: -
1567
--
1568
1569
CREATE FUNCTION force_recreate(cmd text, users text[] DEFAULT NULL::text[]) RETURNS void
1570
    LANGUAGE plpgsql
1571
    AS $_$
1572
DECLARE
1573
	PG_EXCEPTION_DETAIL text;
1574
	recreate_users_cmd text = util.save_drop_views(users);
1575
BEGIN
1576
	PERFORM util.eval(cmd);
1577
	PERFORM util.eval(recreate_users_cmd);
1578
EXCEPTION
1579
WHEN dependent_objects_still_exist THEN
1580
	IF users IS NOT NULL THEN RAISE; END IF; -- save_drop_views() didn't fix it
1581
	GET STACKED DIAGNOSTICS PG_EXCEPTION_DETAIL = PG_EXCEPTION_DETAIL;
1582
	users = array(SELECT * FROM util.regexp_matches_group(
1583
		PG_EXCEPTION_DETAIL, '(?m)^view (.*) depends on table .*$'));
1584
	IF util.is_empty(users) THEN RAISE; END IF;
1585
	PERFORM util.force_recreate(cmd, users);
1586
END;
1587
$_$;
1588
1589
1590
--
1591
-- Name: FUNCTION force_recreate(cmd text, users text[]); Type: COMMENT; Schema: util; Owner: -
1592
--
1593
1594 12235 aaronmk
COMMENT ON FUNCTION force_recreate(cmd text, users text[]) IS '
1595
idempotent
1596 11695 aaronmk
1597 12235 aaronmk
users: not necessary to provide this because it will be autopopulated
1598
';
1599 11695 aaronmk
1600
1601
--
1602 8321 aaronmk
-- Name: force_update_view(text, text); Type: FUNCTION; Schema: util; Owner: -
1603
--
1604
1605
CREATE FUNCTION force_update_view(view_ text, query text) RETURNS void
1606
    LANGUAGE plpgsql STRICT
1607
    AS $_$
1608
DECLARE
1609
	mk_view text = $$CREATE OR REPLACE VIEW $$||view_||$$ AS
1610
$$||query;
1611
BEGIN
1612
	EXECUTE mk_view;
1613
EXCEPTION
1614
WHEN invalid_table_definition THEN
1615 8323 aaronmk
	IF SQLERRM = 'cannot drop columns from view'
1616
	OR SQLERRM LIKE 'cannot change name of view column "%" to "%"'
1617
	THEN
1618 8321 aaronmk
		EXECUTE $$DROP VIEW $$||view_||$$ CASCADE$$;
1619
		EXECUTE mk_view;
1620
	ELSE RAISE USING ERRCODE = SQLSTATE, MESSAGE = SQLERRM;
1621
	END IF;
1622
END;
1623
$_$;
1624
1625
1626
--
1627
-- Name: FUNCTION force_update_view(view_ text, query text); Type: COMMENT; Schema: util; Owner: -
1628
--
1629
1630 12235 aaronmk
COMMENT ON FUNCTION force_update_view(view_ text, query text) IS '
1631
idempotent
1632
';
1633 8321 aaronmk
1634
1635
--
1636 11655 aaronmk
-- Name: grants_users(); Type: FUNCTION; Schema: util; Owner: -
1637
--
1638
1639
CREATE FUNCTION grants_users() RETURNS SETOF text
1640
    LANGUAGE sql IMMUTABLE
1641
    AS $$
1642
VALUES ('bien_read'), ('public_')
1643
$$;
1644
1645
1646
--
1647 8183 aaronmk
-- Name: has_prefix(text, text); Type: FUNCTION; Schema: util; Owner: -
1648 8085 aaronmk
--
1649
1650
CREATE FUNCTION has_prefix(prefix text, str text) RETURNS boolean
1651 10388 aaronmk
    LANGUAGE sql IMMUTABLE
1652 8085 aaronmk
    AS $_$
1653
SELECT substring($2 for length($1)) = $1
1654
$_$;
1655
1656
1657
--
1658 12296 aaronmk
-- Name: has_single_row(regclass); Type: FUNCTION; Schema: util; Owner: -
1659
--
1660
1661
CREATE FUNCTION has_single_row(table_ regclass) RETURNS boolean
1662
    LANGUAGE sql STABLE
1663
    AS $_$
1664
SELECT util.eval2val($$SELECT COUNT(*) = 1 FROM $$||$1, NULL::boolean)
1665
$_$;
1666
1667
1668
--
1669 10307 aaronmk
-- Name: hstore(text[], text); Type: FUNCTION; Schema: util; Owner: -
1670
--
1671
1672
CREATE FUNCTION hstore(keys text[], value text) RETURNS hstore
1673
    LANGUAGE sql IMMUTABLE
1674
    AS $_$
1675 10324 aaronmk
SELECT hstore(util.fix_array($1), util.array_fill($2, util.array_length($1)))
1676 10307 aaronmk
$_$;
1677
1678
1679
--
1680
-- Name: FUNCTION hstore(keys text[], value text); Type: COMMENT; Schema: util; Owner: -
1681
--
1682
1683 12235 aaronmk
COMMENT ON FUNCTION hstore(keys text[], value text) IS '
1684
avoids repeating the same value for each key
1685
';
1686 10307 aaronmk
1687
1688
--
1689 12218 aaronmk
-- Name: ifnull(anyelement, anyelement); Type: FUNCTION; Schema: util; Owner: -
1690
--
1691
1692
CREATE FUNCTION ifnull(value anyelement, null_ anyelement) RETURNS anyelement
1693
    LANGUAGE sql IMMUTABLE
1694
    AS $_$
1695 12222 aaronmk
SELECT COALESCE($1, $2)
1696 12218 aaronmk
$_$;
1697
1698
1699
--
1700
-- Name: FUNCTION ifnull(value anyelement, null_ anyelement); Type: COMMENT; Schema: util; Owner: -
1701
--
1702
1703 12235 aaronmk
COMMENT ON FUNCTION ifnull(value anyelement, null_ anyelement) IS '
1704
equivalent to MySQL''s IFNULL() (Postgres auto-lowercases the name)
1705
';
1706 12218 aaronmk
1707
1708
--
1709 12285 aaronmk
-- Name: inherit(regclass, regclass); Type: FUNCTION; Schema: util; Owner: -
1710
--
1711
1712
CREATE FUNCTION inherit(derived regclass, base regclass) RETURNS void
1713
    LANGUAGE sql
1714
    AS $_$
1715
SELECT util.eval($$ALTER TABLE $$||$1||$$ INHERIT $$||$2)
1716
$_$;
1717
1718
1719
--
1720 10137 aaronmk
-- Name: is_constant(col_ref); Type: FUNCTION; Schema: util; Owner: -
1721
--
1722
1723
CREATE FUNCTION is_constant(col col_ref) RETURNS boolean
1724 12446 aaronmk
    LANGUAGE sql STABLE
1725 10137 aaronmk
    AS $_$
1726
SELECT COALESCE(util.col_comment($1) LIKE 'constant%', false)
1727
$_$;
1728
1729
1730
--
1731 11659 aaronmk
-- Name: is_empty(anyarray); Type: FUNCTION; Schema: util; Owner: -
1732
--
1733
1734
CREATE FUNCTION is_empty("array" anyarray) RETURNS boolean
1735
    LANGUAGE sql IMMUTABLE
1736
    AS $_$
1737
SELECT util.array_length($1) = 0
1738
$_$;
1739
1740
1741
--
1742 12457 aaronmk
-- Name: is_explain(text); Type: FUNCTION; Schema: util; Owner: -
1743
--
1744
1745
CREATE FUNCTION is_explain(sql text) RETURNS boolean
1746
    LANGUAGE sql IMMUTABLE
1747
    AS $_$
1748
SELECT upper(util.first_word($1)) = 'EXPLAIN'
1749
$_$;
1750
1751
1752
--
1753 12451 aaronmk
-- Name: is_explainable(text); Type: FUNCTION; Schema: util; Owner: -
1754
--
1755
1756
CREATE FUNCTION is_explainable(sql text) RETURNS boolean
1757
    LANGUAGE sql IMMUTABLE
1758
    AS $_$
1759
SELECT upper(util.first_word($1)) = ANY(
1760
'{SELECT,INSERT,UPDATE,DELETE,VALUES,EXECUTE,DECLARE}'::text[]
1761
/*from http://www.postgresql.org/docs/9.3/static/sql-explain.html#AEN77691*/
1762
)
1763
$_$;
1764
1765
1766
--
1767 10391 aaronmk
-- Name: is_more_complete_than(anyelement, anyelement); Type: FUNCTION; Schema: util; Owner: -
1768
--
1769
1770
CREATE FUNCTION is_more_complete_than("left" anyelement, "right" anyelement) RETURNS boolean
1771
    LANGUAGE sql IMMUTABLE
1772
    AS $_$
1773
SELECT $1 IS NOT DISTINCT FROM $2 OR ($1 IS NOT NULL AND $2 IS NULL)
1774
$_$;
1775
1776
1777
--
1778 10613 aaronmk
-- Name: is_populated_more_often_than(anyelement, anyelement); Type: FUNCTION; Schema: util; Owner: -
1779
--
1780
1781
CREATE FUNCTION is_populated_more_often_than("left" anyelement, "right" anyelement) RETURNS boolean
1782
    LANGUAGE sql IMMUTABLE
1783
    AS $_$
1784
SELECT $1 IS NOT NULL >= $2 IS NOT NULL -- true > false
1785
$_$;
1786
1787
1788
--
1789 12480 aaronmk
-- Name: is_set_stmt(text); Type: FUNCTION; Schema: util; Owner: -
1790
--
1791
1792
CREATE FUNCTION is_set_stmt(sql text) RETURNS boolean
1793
    LANGUAGE sql IMMUTABLE
1794
    AS $_$
1795
SELECT upper(util.first_word($1)) = 'SET'
1796
$_$;
1797
1798
1799
--
1800 12330 aaronmk
-- Name: is_table(regclass); Type: FUNCTION; Schema: util; Owner: -
1801
--
1802
1803
CREATE FUNCTION is_table(relation regclass) RETURNS boolean
1804 12332 aaronmk
    LANGUAGE sql STABLE
1805 12330 aaronmk
    AS $_$
1806
SELECT relkind = 'r' FROM pg_class WHERE oid = $1
1807
$_$;
1808
1809
1810
--
1811 12329 aaronmk
-- Name: is_view(regclass); Type: FUNCTION; Schema: util; Owner: -
1812
--
1813
1814
CREATE FUNCTION is_view(relation regclass) RETURNS boolean
1815 12332 aaronmk
    LANGUAGE sql STABLE
1816 12329 aaronmk
    AS $_$
1817
SELECT relkind = 'v' FROM pg_class WHERE oid = $1
1818
$_$;
1819
1820
1821
--
1822 8183 aaronmk
-- Name: join_strs_transform(text, text, text); Type: FUNCTION; Schema: util; Owner: -
1823 4009 aaronmk
--
1824
1825 4053 aaronmk
CREATE FUNCTION join_strs_transform(state text, value text, delim text) RETURNS text
1826 12444 aaronmk
    LANGUAGE sql IMMUTABLE STRICT
1827 4009 aaronmk
    AS $_$
1828 4054 aaronmk
SELECT $1 || $3 || $2
1829 2595 aaronmk
$_$;
1830
1831
1832
--
1833 12444 aaronmk
-- Name: FUNCTION join_strs_transform(state text, value text, delim text); Type: COMMENT; Schema: util; Owner: -
1834
--
1835
1836
COMMENT ON FUNCTION join_strs_transform(state text, value text, delim text) IS '
1837
must be declared STRICT to use the special handling of STRICT aggregating functions
1838
';
1839
1840
1841
--
1842 12436 aaronmk
-- Name: keys(anyelement); Type: FUNCTION; Schema: util; Owner: -
1843
--
1844
1845
CREATE FUNCTION keys(value anyelement) RETURNS anyelement
1846
    LANGUAGE sql IMMUTABLE
1847
    AS $_$
1848
SELECT $1 -- compare on the entire value
1849
$_$;
1850
1851
1852
--
1853 10989 aaronmk
-- Name: limit2row_num(integer, integer, integer); Type: FUNCTION; Schema: util; Owner: -
1854 10985 aaronmk
--
1855
1856 10989 aaronmk
CREATE FUNCTION limit2row_num(limit_ integer, offset_ integer DEFAULT NULL::integer, min_row_num integer DEFAULT 1) RETURNS integer
1857 10985 aaronmk
    LANGUAGE sql IMMUTABLE
1858
    AS $_$
1859 10989 aaronmk
SELECT COALESCE(util.offset2row_num($2, $3) + $1 - 1, 2147483647)
1860 10985 aaronmk
$_$;
1861
1862
1863
--
1864 12275 aaronmk
-- Name: ltrim_nl(text); Type: FUNCTION; Schema: util; Owner: -
1865
--
1866
1867
CREATE FUNCTION ltrim_nl(str text) RETURNS text
1868
    LANGUAGE sql IMMUTABLE
1869
    AS $_$
1870
SELECT ltrim($1, $$
1871
$$)
1872
$_$;
1873
1874
1875
--
1876 10110 aaronmk
-- Name: map_filter_insert(); Type: FUNCTION; Schema: util; Owner: -
1877
--
1878
1879
CREATE FUNCTION map_filter_insert() RETURNS trigger
1880
    LANGUAGE plpgsql
1881
    AS $$
1882
BEGIN
1883
	IF new."from" LIKE ':%' THEN RETURN NULL; END IF; -- exclude metadata values
1884
	RETURN new;
1885
END;
1886
$$;
1887
1888
1889
--
1890 8183 aaronmk
-- Name: map_get(regclass, text); Type: FUNCTION; Schema: util; Owner: -
1891 8146 aaronmk
--
1892
1893
CREATE FUNCTION map_get(map regclass, key text) RETURNS text
1894
    LANGUAGE plpgsql STABLE STRICT
1895
    AS $_$
1896
DECLARE
1897
    value text;
1898
BEGIN
1899
    EXECUTE $$SELECT "to" FROM $$||map||$$ WHERE "from" = $1$$
1900 8149 aaronmk
        INTO value USING key;
1901 8146 aaronmk
    RETURN value;
1902
END;
1903
$_$;
1904
1905
1906
--
1907 10358 aaronmk
-- Name: map_nulls(text[], anyelement); Type: FUNCTION; Schema: util; Owner: -
1908 10325 aaronmk
--
1909
1910 10358 aaronmk
CREATE FUNCTION map_nulls(nulls text[], value anyelement) RETURNS anyelement
1911 10353 aaronmk
    LANGUAGE sql IMMUTABLE
1912 10325 aaronmk
    AS $_$
1913 10374 aaronmk
SELECT util._map(util.nulls_map($1), $2)
1914 10325 aaronmk
$_$;
1915
1916
1917
--
1918 10359 aaronmk
-- Name: FUNCTION map_nulls(nulls text[], value anyelement); Type: COMMENT; Schema: util; Owner: -
1919
--
1920
1921 12235 aaronmk
COMMENT ON FUNCTION map_nulls(nulls text[], value anyelement) IS '
1922
due to dynamic inlining[1], this is just as fast as util._map() which it wraps[2].
1923 10359 aaronmk
1924
[1] inlining of function calls, which is different from constant folding
1925
[2] _map()''s profiling query
1926
SELECT util._map(''"1"=>NULL, "2"=>NULL, "3"=>NULL, *=>*'', v) FROM unnest(array_fill(1, array[100000])) f (v)
1927
and map_nulls()''s profiling query
1928
SELECT util.map_nulls(array[1, 2, 3]::text[], v) FROM unnest(array_fill(1, array[100000])) f (v)
1929 10375 aaronmk
both take ~920 ms.
1930 12235 aaronmk
also, /inputs/REMIB/Specimen/postprocess.sql > country takes the same amount of time (56000 ms) to build with map_nulls() as with a literal hstore.
1931
';
1932 10359 aaronmk
1933
1934
--
1935 8183 aaronmk
-- Name: map_values(regclass); Type: FUNCTION; Schema: util; Owner: -
1936 8150 aaronmk
--
1937
1938
CREATE FUNCTION map_values(map regclass) RETURNS SETOF text
1939
    LANGUAGE plpgsql STABLE STRICT
1940
    AS $_$
1941
BEGIN
1942
    RETURN QUERY EXECUTE $$SELECT "to" FROM $$||map;
1943
END;
1944
$_$;
1945
1946
1947
--
1948 12228 aaronmk
-- Name: materialize_query(text, text); Type: FUNCTION; Schema: util; Owner: -
1949
--
1950
1951 12262 aaronmk
CREATE FUNCTION materialize_query(table_esc text, sql text) RETURNS void
1952 12228 aaronmk
    LANGUAGE sql
1953
    AS $_$
1954 12262 aaronmk
SELECT util.create_if_not_exists($$CREATE TABLE $$||$1||$$ AS
1955 12321 aaronmk
$$||util.ltrim_nl($2));
1956
-- make sure the created table has the correct estimated row count
1957
SELECT util.analyze_($1);
1958 12470 aaronmk
1959
SELECT util.append_comment($1, '
1960
contents generated from:
1961
'||util.ltrim_nl($2)||';
1962
');
1963 12228 aaronmk
$_$;
1964
1965
1966
--
1967 12262 aaronmk
-- Name: FUNCTION materialize_query(table_esc text, sql text); Type: COMMENT; Schema: util; Owner: -
1968 12228 aaronmk
--
1969
1970 12262 aaronmk
COMMENT ON FUNCTION materialize_query(table_esc text, sql text) IS '
1971 12235 aaronmk
idempotent
1972
';
1973 12228 aaronmk
1974
1975
--
1976 12234 aaronmk
-- Name: materialize_view(text, regclass); Type: FUNCTION; Schema: util; Owner: -
1977
--
1978
1979 12262 aaronmk
CREATE FUNCTION materialize_view(table_esc text, view_ regclass) RETURNS void
1980 12234 aaronmk
    LANGUAGE sql
1981
    AS $_$
1982
SELECT util.materialize_query($1, $$SELECT * FROM $$||$2)
1983
$_$;
1984
1985
1986
--
1987 12262 aaronmk
-- Name: FUNCTION materialize_view(table_esc text, view_ regclass); Type: COMMENT; Schema: util; Owner: -
1988 12234 aaronmk
--
1989
1990 12262 aaronmk
COMMENT ON FUNCTION materialize_view(table_esc text, view_ regclass) IS '
1991 12235 aaronmk
idempotent
1992
';
1993 12234 aaronmk
1994
1995
--
1996 8190 aaronmk
-- Name: mk_const_col(col_ref, anyelement); Type: FUNCTION; Schema: util; Owner: -
1997
--
1998
1999
CREATE FUNCTION mk_const_col(col col_ref, value anyelement) RETURNS void
2000 12446 aaronmk
    LANGUAGE sql
2001 8190 aaronmk
    AS $_$
2002 10135 aaronmk
SELECT util.create_if_not_exists($$
2003
ALTER TABLE $$||$1.table_||$$ ADD COLUMN $$
2004 8190 aaronmk
||quote_ident($1.name)||$$ $$||pg_typeof($2)||util.type_qual($2)||$$ DEFAULT $$
2005 10135 aaronmk
||quote_literal($2)||$$;
2006 12235 aaronmk
COMMENT ON COLUMN $$||$1.table_||$$.$$||quote_ident($1.name)||$$ IS '
2007
constant
2008
';
2009 10135 aaronmk
$$)
2010 8190 aaronmk
$_$;
2011
2012
2013
--
2014
-- Name: FUNCTION mk_const_col(col col_ref, value anyelement); Type: COMMENT; Schema: util; Owner: -
2015
--
2016
2017 12235 aaronmk
COMMENT ON FUNCTION mk_const_col(col col_ref, value anyelement) IS '
2018
idempotent
2019
';
2020 8190 aaronmk
2021
2022
--
2023 10296 aaronmk
-- Name: mk_derived_col(col_ref, text, boolean); Type: FUNCTION; Schema: util; Owner: -
2024 8187 aaronmk
--
2025
2026 10296 aaronmk
CREATE FUNCTION mk_derived_col(col col_ref, expr text, overwrite boolean DEFAULT false) RETURNS void
2027 8187 aaronmk
    LANGUAGE plpgsql STRICT
2028
    AS $_$
2029
DECLARE
2030
    type regtype = util.typeof(expr, col.table_::text::regtype);
2031
    col_name_sql text = quote_ident(col.name);
2032
BEGIN
2033 10296 aaronmk
    PERFORM util.create_if_not_exists((CASE WHEN overwrite THEN '' ELSE $$
2034
ALTER TABLE $$||col.table_||$$ ADD   COLUMN $$||col_name_sql||$$      $$||type||$$;$$ END)||$$
2035 8187 aaronmk
ALTER TABLE $$||col.table_||$$ ALTER COLUMN $$||col_name_sql||$$ TYPE $$||type||$$ USING
2036
$$||expr||$$;
2037
$$);
2038
END;
2039
$_$;
2040
2041
2042
--
2043 10296 aaronmk
-- Name: FUNCTION mk_derived_col(col col_ref, expr text, overwrite boolean); Type: COMMENT; Schema: util; Owner: -
2044 8188 aaronmk
--
2045
2046 12235 aaronmk
COMMENT ON FUNCTION mk_derived_col(col col_ref, expr text, overwrite boolean) IS '
2047
idempotent
2048
';
2049 8188 aaronmk
2050
2051
--
2052 12554 aaronmk
-- Name: mk_diff_query(text, text, text, text, text); Type: FUNCTION; Schema: util; Owner: -
2053 12475 aaronmk
--
2054
2055 12554 aaronmk
CREATE FUNCTION mk_diff_query(left_ text, right_ text, cols text DEFAULT 'left_, right_'::text, join_cond text DEFAULT 'left_ %== right_ -- refer to EXPLAIN output for expansion of %=='::text, filter text DEFAULT 'left_ IS DISTINCT FROM right_'::text) RETURNS text
2056 12475 aaronmk
    LANGUAGE sql IMMUTABLE
2057
    AS $_$
2058
SELECT
2059 12478 aaronmk
$$SELECT
2060 12554 aaronmk
$$||$3||$$
2061 12555 aaronmk
FROM      $$||$1||$$ left_
2062 12554 aaronmk
FULL JOIN $$||$2||$$ right_
2063
ON $$||$4||$$
2064
WHERE $$||$5||$$
2065 12475 aaronmk
ORDER BY left_, right_
2066
$$
2067
$_$;
2068
2069
2070
--
2071 12564 aaronmk
-- Name: mk_keys_func(regtype); Type: FUNCTION; Schema: util; Owner: -
2072
--
2073
2074
CREATE FUNCTION mk_keys_func(type regtype) RETURNS void
2075
    LANGUAGE sql IMMUTABLE
2076
    AS $_$
2077 12570 aaronmk
-- keys()
2078 12564 aaronmk
SELECT util.mk_keys_func($1, ARRAY(
2079
SELECT col FROM util.typed_cols($1) col
2080
WHERE (col).type != ANY('{bigint}'::regtype[]) -- not a count col
2081 12570 aaronmk
));
2082
2083 12571 aaronmk
-- values_()
2084 12570 aaronmk
SELECT util.mk_keys_func($1, COALESCE(
2085
	NULLIF(ARRAY(
2086
	SELECT col FROM util.typed_cols($1) col
2087
	WHERE (col).type = ANY('{bigint}'::regtype[]) -- is a count col
2088
	), ARRAY[]::util.col_cast[])
2089
, ARRAY(SELECT util.typed_cols($1))) -- no count cols, so use all cols
2090 12571 aaronmk
, 'values_');
2091 12564 aaronmk
$_$;
2092
2093
2094
--
2095 12569 aaronmk
-- Name: mk_keys_func(regtype, col_cast[], text); Type: FUNCTION; Schema: util; Owner: -
2096 12561 aaronmk
--
2097
2098 12569 aaronmk
CREATE FUNCTION mk_keys_func(type regtype, cols col_cast[], name text DEFAULT 'keys'::text) RETURNS void
2099 12561 aaronmk
    LANGUAGE sql IMMUTABLE
2100
    AS $_$
2101 12567 aaronmk
SELECT util.create_if_not_exists($$
2102 12569 aaronmk
CREATE OR REPLACE FUNCTION $$||util.schema($1)||$$.$$||$3||$$(value $$
2103 12561 aaronmk
||util.qual_name($1)||util.mk_out_params($2)||$$)
2104 12563 aaronmk
  RETURNS $$||util._if(util.array_length($2) = 1, $2[1].type::text, $$record$$)
2105
||$$ AS
2106 12561 aaronmk
$BODY1$
2107 12563 aaronmk
SELECT $$|| util._if(util.array_length($2) = 1, ''::text, $$ROW$$) ||$$($$||
2108 12561 aaronmk
(SELECT COALESCE(string_agg($$$1.$$||(unnest).col_name, ', '), '')
2109
FROM unnest($2)) ||$$)
2110
$BODY1$
2111
  LANGUAGE sql IMMUTABLE
2112
  COST 100;
2113
$$)
2114
$_$;
2115
2116
2117
--
2118 8183 aaronmk
-- Name: mk_map_table(text); Type: FUNCTION; Schema: util; Owner: -
2119 8139 aaronmk
--
2120
2121
CREATE FUNCTION mk_map_table(table_ text) RETURNS void
2122 12446 aaronmk
    LANGUAGE sql
2123 8139 aaronmk
    AS $_$
2124 8183 aaronmk
SELECT util.create_if_not_exists($$
2125 8141 aaronmk
CREATE TABLE $$||$1||$$
2126 8139 aaronmk
(
2127 8183 aaronmk
    LIKE util.map INCLUDING ALL
2128 10110 aaronmk
);
2129
2130
CREATE TRIGGER map_filter_insert
2131
  BEFORE INSERT
2132
  ON $$||$1||$$
2133
  FOR EACH ROW
2134
  EXECUTE PROCEDURE util.map_filter_insert();
2135 8141 aaronmk
$$)
2136 8139 aaronmk
$_$;
2137
2138
2139
--
2140 12556 aaronmk
-- Name: mk_out_params(col_cast[]); Type: FUNCTION; Schema: util; Owner: -
2141
--
2142
2143
CREATE FUNCTION mk_out_params(cols col_cast[]) RETURNS text
2144
    LANGUAGE sql IMMUTABLE
2145
    AS $_$
2146 12559 aaronmk
SELECT COALESCE(string_agg($$, OUT $$||(unnest).col_name||$$ $$||
2147
util.qual_name((unnest).type), ''), '')
2148 12556 aaronmk
FROM unnest($1)
2149
$_$;
2150
2151
2152
--
2153 12236 aaronmk
-- Name: mk_search_path(text[]); Type: FUNCTION; Schema: util; Owner: -
2154
--
2155
2156
CREATE FUNCTION mk_search_path(VARIADIC schemas text[]) RETURNS text
2157
    LANGUAGE sql IMMUTABLE
2158
    AS $_$
2159 12486 aaronmk
SELECT string_agg(quote_ident(unnest), ', ') FROM unnest($1||'util'::text)
2160 12236 aaronmk
$_$;
2161
2162
2163
--
2164 12486 aaronmk
-- Name: FUNCTION mk_search_path(VARIADIC schemas text[]); Type: COMMENT; Schema: util; Owner: -
2165
--
2166
2167
COMMENT ON FUNCTION mk_search_path(VARIADIC schemas text[]) IS '
2168
auto-appends util to the search_path to enable use of util operators
2169
';
2170
2171
2172
--
2173 12467 aaronmk
-- Name: mk_set_search_path(boolean); Type: FUNCTION; Schema: util; Owner: -
2174
--
2175
2176
CREATE FUNCTION mk_set_search_path(for_printing boolean DEFAULT false) RETURNS text
2177
    LANGUAGE sql IMMUTABLE
2178
    AS $_$
2179
SELECT util.mk_set_search_path(current_setting('search_path'), $1)
2180
$_$;
2181
2182
2183
--
2184 12466 aaronmk
-- Name: mk_set_search_path(text, boolean); Type: FUNCTION; Schema: util; Owner: -
2185 12270 aaronmk
--
2186
2187 12466 aaronmk
CREATE FUNCTION mk_set_search_path(search_path text, for_printing boolean DEFAULT false) RETURNS text
2188 12270 aaronmk
    LANGUAGE sql IMMUTABLE
2189
    AS $_$
2190 12432 aaronmk
/* debug_print_return_value() needed because this function is used with EXECUTE
2191
rather than util.eval() (in order to affect the calling function), so the
2192
search_path would not otherwise be printed */
2193 12487 aaronmk
SELECT $$SET$$||util._if($2, $$ /*LOCAL*/$$::text, $$ LOCAL$$)
2194
||$$ search_path TO $$||$1
2195 12270 aaronmk
$_$;
2196
2197
2198
--
2199 10113 aaronmk
-- Name: mk_source_col(regclass); Type: FUNCTION; Schema: util; Owner: -
2200
--
2201
2202
CREATE FUNCTION mk_source_col(table_ regclass) RETURNS void
2203 12446 aaronmk
    LANGUAGE sql
2204 10113 aaronmk
    AS $_$
2205 12240 aaronmk
SELECT util.mk_const_col(($1, 'source'), util.schema($1))
2206 10113 aaronmk
$_$;
2207
2208
2209
--
2210
-- Name: FUNCTION mk_source_col(table_ regclass); Type: COMMENT; Schema: util; Owner: -
2211
--
2212
2213 12235 aaronmk
COMMENT ON FUNCTION mk_source_col(table_ regclass) IS '
2214
idempotent
2215
';
2216 10113 aaronmk
2217
2218
--
2219 11011 aaronmk
-- Name: mk_subset_by_row_num_func(regclass); Type: FUNCTION; Schema: util; Owner: -
2220
--
2221
2222
CREATE FUNCTION mk_subset_by_row_num_func(view_ regclass) RETURNS void
2223
    LANGUAGE plpgsql STRICT
2224
    AS $_$
2225
DECLARE
2226
	view_qual_name text = util.qual_name(view_);
2227
BEGIN
2228
	EXECUTE $$
2229
CREATE OR REPLACE FUNCTION $$||view_||$$(limit_ integer DEFAULT NULL::integer, offset_ integer DEFAULT NULL)
2230
  RETURNS SETOF $$||view_||$$ AS
2231
$BODY1$
2232
SELECT * FROM $$||view_qual_name||$$
2233
ORDER BY sort_col
2234
LIMIT $1 OFFSET $2
2235
$BODY1$
2236
  LANGUAGE sql STABLE
2237
  COST 100
2238
  ROWS 1000
2239
$$;
2240
2241
	PERFORM util.mk_subset_by_row_num_no_sort_func(view_);
2242
END;
2243
$_$;
2244
2245
2246
--
2247 8325 aaronmk
-- Name: mk_subset_by_row_num_func(regclass, text); Type: FUNCTION; Schema: util; Owner: -
2248
--
2249
2250
CREATE FUNCTION mk_subset_by_row_num_func(view_ regclass, row_num_col text) RETURNS void
2251
    LANGUAGE plpgsql STRICT
2252
    AS $_$
2253 10990 aaronmk
DECLARE
2254
	view_qual_name text = util.qual_name(view_);
2255
	row_num__min__fn text = util.esc_name__append('__row_num__min', view_qual_name);
2256 8325 aaronmk
BEGIN
2257
	EXECUTE $$
2258 10990 aaronmk
CREATE OR REPLACE FUNCTION $$||row_num__min__fn||$$()
2259
  RETURNS integer AS
2260
$BODY1$
2261
SELECT $$||quote_ident(row_num_col)||$$
2262
FROM $$||view_qual_name||$$
2263
ORDER BY $$||quote_ident(row_num_col)||$$ ASC
2264
LIMIT 1
2265
$BODY1$
2266
  LANGUAGE sql STABLE
2267
  COST 100;
2268
$$;
2269
2270
	EXECUTE $$
2271 8325 aaronmk
CREATE OR REPLACE FUNCTION $$||view_||$$(limit_ integer DEFAULT NULL::integer, offset_ integer DEFAULT NULL)
2272
  RETURNS SETOF $$||view_||$$ AS
2273
$BODY1$
2274 10990 aaronmk
SELECT * FROM $$||view_qual_name||$$
2275
WHERE $$||quote_ident(row_num_col)||$$ BETWEEN
2276
	util.offset2row_num(    $2, $$||row_num__min__fn||$$())
2277
AND util.limit2row_num ($1, $2, $$||row_num__min__fn||$$())
2278 10991 aaronmk
ORDER BY $$||quote_ident(row_num_col)||$$
2279 8325 aaronmk
$BODY1$
2280
  LANGUAGE sql STABLE
2281
  COST 100
2282
  ROWS 1000
2283
$$;
2284 11010 aaronmk
2285
	PERFORM util.mk_subset_by_row_num_no_sort_func(view_);
2286
END;
2287
$_$;
2288
2289
2290
--
2291
-- Name: mk_subset_by_row_num_no_sort_func(regclass); Type: FUNCTION; Schema: util; Owner: -
2292
--
2293
2294
CREATE FUNCTION mk_subset_by_row_num_no_sort_func(view_ regclass) RETURNS void
2295
    LANGUAGE plpgsql STRICT
2296
    AS $_$
2297
DECLARE
2298
	view_qual_name text = util.qual_name(view_);
2299
BEGIN
2300 8326 aaronmk
	EXECUTE $$
2301
CREATE OR REPLACE FUNCTION $$||view_||$$(no_sort boolean, limit_ integer DEFAULT NULL::integer, offset_ integer DEFAULT NULL)
2302
  RETURNS SETOF $$||view_||$$
2303
  SET enable_sort TO 'off'
2304
  AS
2305
$BODY1$
2306 10990 aaronmk
SELECT * FROM $$||view_qual_name||$$($2, $3)
2307 8326 aaronmk
$BODY1$
2308
  LANGUAGE sql STABLE
2309
  COST 100
2310
  ROWS 1000
2311
;
2312
COMMENT ON FUNCTION $$||view_||$$(no_sort boolean, limit_ integer, offset_ integer) IS '
2313
Use this for limit values greater than ~100,000 to avoid unwanted slow sorts.
2314
If you want to run EXPLAIN and get expanded output, use the regular subset
2315
function instead. (When a config param is set on a function, EXPLAIN produces
2316
just a function scan.)
2317
';
2318
$$;
2319 8325 aaronmk
END;
2320
$_$;
2321
2322
2323
--
2324 11010 aaronmk
-- Name: FUNCTION mk_subset_by_row_num_no_sort_func(view_ regclass); Type: COMMENT; Schema: util; Owner: -
2325
--
2326
2327 12235 aaronmk
COMMENT ON FUNCTION mk_subset_by_row_num_no_sort_func(view_ regclass) IS '
2328
creates subset function which turns off enable_sort
2329
';
2330 11010 aaronmk
2331
2332
--
2333 12242 aaronmk
-- Name: name(regclass); Type: FUNCTION; Schema: util; Owner: -
2334
--
2335
2336
CREATE FUNCTION name(table_ regclass) RETURNS text
2337
    LANGUAGE sql STABLE
2338
    AS $_$
2339
SELECT relname::text FROM pg_class WHERE oid = $1
2340
$_$;
2341
2342
2343
--
2344 8183 aaronmk
-- Name: name(regtype); Type: FUNCTION; Schema: util; Owner: -
2345 8083 aaronmk
--
2346
2347
CREATE FUNCTION name(type regtype) RETURNS text
2348 12446 aaronmk
    LANGUAGE sql STABLE
2349 8083 aaronmk
    AS $_$
2350
SELECT typname::text FROM pg_type WHERE oid = $1
2351
$_$;
2352
2353
2354
--
2355 12360 aaronmk
-- Name: name_was_truncated(text, integer); Type: FUNCTION; Schema: util; Owner: -
2356 12355 aaronmk
--
2357
2358 12360 aaronmk
CREATE FUNCTION name_was_truncated(name_ text, max_prefix_len integer DEFAULT 0) RETURNS boolean
2359 12355 aaronmk
    LANGUAGE sql IMMUTABLE
2360
    AS $_$
2361 12360 aaronmk
SELECT octet_length($1) >= util.namedatalen() - $2
2362 12355 aaronmk
$_$;
2363
2364
2365
--
2366 12354 aaronmk
-- Name: namedatalen(); Type: FUNCTION; Schema: util; Owner: -
2367
--
2368
2369
CREATE FUNCTION namedatalen() RETURNS integer
2370
    LANGUAGE sql IMMUTABLE
2371
    AS $$
2372
SELECT octet_length(repeat('_', 1024/*>63*/)::name::text)
2373
$$;
2374
2375
2376
--
2377 9958 aaronmk
-- Name: not_empty(anyarray); Type: FUNCTION; Schema: util; Owner: -
2378
--
2379
2380
CREATE FUNCTION not_empty(value anyarray) RETURNS boolean
2381
    LANGUAGE sql IMMUTABLE
2382
    AS $_$
2383 10329 aaronmk
SELECT $1 IS NOT NULL AND util.array_length($1) > 0
2384 9958 aaronmk
$_$;
2385
2386
2387
--
2388 9956 aaronmk
-- Name: not_null(anyelement); Type: FUNCTION; Schema: util; Owner: -
2389
--
2390
2391
CREATE FUNCTION not_null(value anyelement) RETURNS boolean
2392 9957 aaronmk
    LANGUAGE sql IMMUTABLE
2393 9956 aaronmk
    AS $_$
2394
SELECT $1 IS NOT NULL
2395
$_$;
2396
2397
2398
--
2399 10373 aaronmk
-- Name: nulls_map(text[]); Type: FUNCTION; Schema: util; Owner: -
2400
--
2401
2402
CREATE FUNCTION nulls_map(nulls text[]) RETURNS hstore
2403
    LANGUAGE sql IMMUTABLE
2404
    AS $_$
2405
SELECT util.hstore($1, NULL) || '*=>*'
2406
$_$;
2407
2408
2409
--
2410
-- Name: FUNCTION nulls_map(nulls text[]); Type: COMMENT; Schema: util; Owner: -
2411
--
2412
2413 12235 aaronmk
COMMENT ON FUNCTION nulls_map(nulls text[]) IS '
2414
for use with _map()
2415
';
2416 10373 aaronmk
2417
2418
--
2419 10989 aaronmk
-- Name: offset2row_num(integer, integer); Type: FUNCTION; Schema: util; Owner: -
2420 10984 aaronmk
--
2421
2422 10989 aaronmk
CREATE FUNCTION offset2row_num(offset_ integer, min_row_num integer DEFAULT 1) RETURNS integer
2423 10984 aaronmk
    LANGUAGE sql IMMUTABLE
2424
    AS $_$
2425 10989 aaronmk
SELECT $2 + COALESCE($1, 0)
2426 10984 aaronmk
$_$;
2427
2428
2429
--
2430 12494 aaronmk
-- Name: prepend_comment(regclass, text); Type: FUNCTION; Schema: util; Owner: -
2431
--
2432
2433
CREATE FUNCTION prepend_comment(table_ regclass, comment text) RETURNS void
2434
    LANGUAGE sql
2435
    AS $_$
2436
SELECT util.set_comment($1, concat($2, util.comment($1)))
2437
$_$;
2438
2439
2440
--
2441
-- Name: FUNCTION prepend_comment(table_ regclass, comment text); Type: COMMENT; Schema: util; Owner: -
2442
--
2443
2444
COMMENT ON FUNCTION prepend_comment(table_ regclass, comment text) IS '
2445
comment: must start and end with a newline
2446
';
2447
2448
2449
--
2450 12260 aaronmk
-- Name: qual_name(text[]); Type: FUNCTION; Schema: util; Owner: -
2451
--
2452
2453
CREATE FUNCTION qual_name(VARIADIC elems text[]) RETURNS text
2454
    LANGUAGE sql IMMUTABLE
2455
    AS $_$
2456
SELECT string_agg(quote_ident(unnest), '.') FROM unnest($1)
2457
$_$;
2458
2459
2460
--
2461 10988 aaronmk
-- Name: qual_name(regclass); Type: FUNCTION; Schema: util; Owner: -
2462
--
2463
2464
CREATE FUNCTION qual_name(table_ regclass) RETURNS text
2465 12446 aaronmk
    LANGUAGE sql STABLE
2466 12267 aaronmk
    SET search_path TO pg_temp
2467 10988 aaronmk
    AS $_$
2468 12267 aaronmk
SELECT $1::text
2469 10988 aaronmk
$_$;
2470
2471
2472
--
2473 12267 aaronmk
-- Name: qual_name(regtype); Type: FUNCTION; Schema: util; Owner: -
2474
--
2475
2476
CREATE FUNCTION qual_name(type regtype) RETURNS text
2477 12446 aaronmk
    LANGUAGE sql STABLE
2478 12267 aaronmk
    SET search_path TO pg_temp
2479
    AS $_$
2480
SELECT $1::text
2481
$_$;
2482
2483
2484
--
2485
-- Name: FUNCTION qual_name(type regtype); Type: COMMENT; Schema: util; Owner: -
2486
--
2487
2488
COMMENT ON FUNCTION qual_name(type regtype) IS '
2489
a type''s schema-qualified name
2490
';
2491
2492
2493
--
2494 12268 aaronmk
-- Name: qual_name(unknown); Type: FUNCTION; Schema: util; Owner: -
2495
--
2496
2497
CREATE FUNCTION qual_name(type unknown) RETURNS text
2498 12446 aaronmk
    LANGUAGE sql STABLE
2499 12268 aaronmk
    AS $_$
2500
SELECT util.qual_name($1::text::regtype)
2501
$_$;
2502
2503
2504
--
2505 12376 aaronmk
-- Name: quote_func_call(regprocedure, text[]); Type: FUNCTION; Schema: util; Owner: -
2506
--
2507
2508
CREATE FUNCTION quote_func_call(func regprocedure, VARIADIC args_esc text[]) RETURNS text
2509
    LANGUAGE sql IMMUTABLE
2510
    AS $_$
2511
SELECT util.quote_func_call($1::regproc::text, VARIADIC $2)
2512
$_$;
2513
2514
2515
--
2516
-- Name: quote_func_call(text, text[]); Type: FUNCTION; Schema: util; Owner: -
2517
--
2518
2519
CREATE FUNCTION quote_func_call(func_esc text, VARIADIC args_esc text[]) RETURNS text
2520
    LANGUAGE sql IMMUTABLE
2521
    AS $_$
2522
SELECT $1||'('||concat_ws(', ', VARIADIC $2)||')'
2523
$_$;
2524
2525
2526
--
2527 12371 aaronmk
-- Name: quote_typed(anyelement); Type: FUNCTION; Schema: util; Owner: -
2528
--
2529
2530
CREATE FUNCTION quote_typed(value anyelement) RETURNS text
2531
    LANGUAGE sql IMMUTABLE
2532
    AS $_$
2533 12437 aaronmk
SELECT quote_nullable($1)||$$::$$||util.qual_name(pg_typeof($1))
2534 12371 aaronmk
$_$;
2535
2536
2537
--
2538 12530 aaronmk
-- Name: raise(text, text); Type: FUNCTION; Schema: util; Owner: -
2539
--
2540
2541
CREATE FUNCTION raise(type text, msg text) RETURNS void
2542
    LANGUAGE sql IMMUTABLE
2543 12560 aaronmk
    AS $_X$
2544 12530 aaronmk
SELECT util.eval($$
2545
CREATE OR REPLACE FUNCTION pg_temp.__raise()
2546
  RETURNS void AS
2547 12560 aaronmk
-- $__BODY1$ in case msg contains $BODY1$ (in SQL)
2548
$__BODY1$
2549 12530 aaronmk
BEGIN
2550
	RAISE $$||$1||$$ USING MESSAGE = $$||quote_nullable($2)||$$;
2551
END;
2552 12560 aaronmk
$__BODY1$
2553 12530 aaronmk
  LANGUAGE plpgsql IMMUTABLE
2554
  COST 100;
2555 12532 aaronmk
$$, verbose_ := false);
2556 12530 aaronmk
2557 12532 aaronmk
SELECT util.eval($$SELECT pg_temp.__raise()$$, verbose_ := false);
2558 12560 aaronmk
$_X$;
2559 12530 aaronmk
2560
2561
--
2562 12533 aaronmk
-- Name: FUNCTION raise(type text, msg text); Type: COMMENT; Schema: util; Owner: -
2563
--
2564
2565
COMMENT ON FUNCTION raise(type text, msg text) IS '
2566
type: a log level from
2567
http://www.postgresql.org/docs/9.3/static/plpgsql-errors-and-messages.html
2568
or a condition name from
2569
http://www.postgresql.org/docs/9.3/static/errcodes-appendix.html
2570
';
2571
2572
2573
--
2574 12536 aaronmk
-- Name: raise_error_warning(text); Type: FUNCTION; Schema: util; Owner: -
2575 12311 aaronmk
--
2576
2577 12536 aaronmk
CREATE FUNCTION raise_error_warning(msg text) RETURNS void
2578 12441 aaronmk
    LANGUAGE sql IMMUTABLE
2579 12311 aaronmk
    AS $_$
2580 12536 aaronmk
SELECT util.raise('WARNING', 'ERROR:  '||$1)
2581 12311 aaronmk
$_$;
2582
2583
2584
--
2585 10116 aaronmk
-- Name: raise_undefined_column(col_ref); Type: FUNCTION; Schema: util; Owner: -
2586
--
2587
2588
CREATE FUNCTION raise_undefined_column(col col_ref) RETURNS text
2589
    LANGUAGE plpgsql IMMUTABLE STRICT
2590
    AS $$
2591
BEGIN
2592
	RAISE undefined_column USING MESSAGE = concat('undefined column: ', col.name);
2593
END;
2594
$$;
2595
2596
2597
--
2598 11657 aaronmk
-- Name: regexp_matches_group(text, text, integer); Type: FUNCTION; Schema: util; Owner: -
2599
--
2600
2601
CREATE FUNCTION regexp_matches_group(str text, re text, group_ integer DEFAULT 1) RETURNS SETOF text
2602
    LANGUAGE sql IMMUTABLE
2603
    AS $_$
2604
SELECT regexp_matches[$3] FROM regexp_matches($1, $2, 'g')
2605
$_$;
2606
2607
2608
--
2609 12333 aaronmk
-- Name: regexp_quote(text); Type: FUNCTION; Schema: util; Owner: -
2610
--
2611
2612
CREATE FUNCTION regexp_quote(str text) RETURNS text
2613
    LANGUAGE sql IMMUTABLE
2614
    AS $_$
2615
SELECT regexp_replace($1, '\W', /*\char*/'\\\&', 'g')
2616
$_$;
2617
2618
2619
--
2620 12375 aaronmk
-- Name: regprocedure(text); Type: FUNCTION; Schema: util; Owner: -
2621
--
2622
2623
CREATE FUNCTION regprocedure(func text) RETURNS regprocedure
2624
    LANGUAGE sql IMMUTABLE
2625
    AS $_$
2626
SELECT (CASE WHEN right($1, 1) = ')'
2627 12377 aaronmk
THEN $1::regprocedure ELSE $1::regproc::regprocedure END)
2628 12375 aaronmk
$_$;
2629
2630
2631
--
2632 12344 aaronmk
-- Name: relation_type(regclass); Type: FUNCTION; Schema: util; Owner: -
2633
--
2634
2635
CREATE FUNCTION relation_type(relation regclass) RETURNS text
2636
    LANGUAGE sql STABLE
2637
    AS $_$
2638
SELECT util.relation_type(util.relation_type_char($1))
2639
$_$;
2640
2641
2642
--
2643 12340 aaronmk
-- Name: relation_type("char"); Type: FUNCTION; Schema: util; Owner: -
2644 12339 aaronmk
--
2645
2646 12340 aaronmk
CREATE FUNCTION relation_type(relation_type_char "char") RETURNS text
2647 12339 aaronmk
    LANGUAGE sql IMMUTABLE
2648
    AS $_$
2649
SELECT 'r=>TABLE, v=>VIEW'::hstore -> $1
2650
$_$;
2651
2652
2653
--
2654 12341 aaronmk
-- Name: relation_type_char(regclass); Type: FUNCTION; Schema: util; Owner: -
2655
--
2656
2657
CREATE FUNCTION relation_type_char(relation regclass) RETURNS "char"
2658
    LANGUAGE sql STABLE
2659
    AS $_$
2660
SELECT relkind FROM pg_class WHERE oid = $1
2661
$_$;
2662
2663
2664
--
2665 12293 aaronmk
-- Name: remake_diff_table(text, regclass, regclass, text); Type: FUNCTION; Schema: util; Owner: -
2666
--
2667
2668
CREATE FUNCTION remake_diff_table(diff_table text, left_table regclass, right_table regclass, type_table text) RETURNS void
2669
    LANGUAGE sql
2670
    AS $_$
2671
/* can't have in_table/out_table inherit from *each other*, because inheritance
2672
also causes the rows of the parent table to be included in the child table.
2673
instead, they need to inherit from a common, empty table. */
2674 12382 aaronmk
SELECT util.create_if_not_exists($$SELECT $$||util.quote_func_call(
2675
'util.copy_struct', util.quote_typed($2), util.quote_typed($4)));
2676 12293 aaronmk
SELECT util.inherit($2, $4);
2677
SELECT util.inherit($3, $4);
2678
2679
SELECT util.rematerialize_query($1, $$
2680
SELECT * FROM util.diff(
2681 12419 aaronmk
  $$||util.quote_typed($2)||$$
2682
, $$||util.quote_typed($3)||$$
2683 12293 aaronmk
, NULL::$$||$4||$$)
2684
$$);
2685 12303 aaronmk
2686
/* the table unfortunately cannot be *materialized* in human-readable form,
2687
because this would create column name collisions between the two sides */
2688 12495 aaronmk
SELECT util.prepend_comment($1, '
2689 12303 aaronmk
to view this table in human-readable form (with each side''s tuple column
2690
expanded to its component fields):
2691 12572 aaronmk
SELECT (left_).*, ('||util.schema($4::regclass)||'.values_(right_)).* FROM '||$1||';
2692 12303 aaronmk
');
2693 12293 aaronmk
$_$;
2694
2695
2696
--
2697
-- Name: FUNCTION remake_diff_table(diff_table text, left_table regclass, right_table regclass, type_table text); Type: COMMENT; Schema: util; Owner: -
2698
--
2699
2700
COMMENT ON FUNCTION remake_diff_table(diff_table text, left_table regclass, right_table regclass, type_table text) IS '
2701
type_table (*required*): table to create as the shared base type
2702
';
2703
2704
2705
--
2706 12265 aaronmk
-- Name: rematerialize_query(text, text); Type: FUNCTION; Schema: util; Owner: -
2707
--
2708
2709
CREATE FUNCTION rematerialize_query(table_esc text, sql text) RETURNS void
2710
    LANGUAGE sql
2711
    AS $_$
2712
SELECT util.drop_table($1);
2713
SELECT util.materialize_query($1, $2);
2714
$_$;
2715
2716
2717
--
2718
-- Name: FUNCTION rematerialize_query(table_esc text, sql text); Type: COMMENT; Schema: util; Owner: -
2719
--
2720
2721
COMMENT ON FUNCTION rematerialize_query(table_esc text, sql text) IS '
2722
idempotent, but repeats action each time
2723
';
2724
2725
2726
--
2727 12247 aaronmk
-- Name: rematerialize_view(text, regclass); Type: FUNCTION; Schema: util; Owner: -
2728
--
2729
2730 12262 aaronmk
CREATE FUNCTION rematerialize_view(table_esc text, view_ regclass) RETURNS void
2731 12247 aaronmk
    LANGUAGE sql
2732
    AS $_$
2733
SELECT util.drop_table($1);
2734
SELECT util.materialize_view($1, $2);
2735
$_$;
2736
2737
2738
--
2739 12262 aaronmk
-- Name: FUNCTION rematerialize_view(table_esc text, view_ regclass); Type: COMMENT; Schema: util; Owner: -
2740 12247 aaronmk
--
2741
2742 12262 aaronmk
COMMENT ON FUNCTION rematerialize_view(table_esc text, view_ regclass) IS '
2743 12247 aaronmk
idempotent, but repeats action each time
2744
';
2745
2746
2747
--
2748 8183 aaronmk
-- Name: rename_cols(regclass, anyelement); Type: FUNCTION; Schema: util; Owner: -
2749 8137 aaronmk
--
2750
2751 8148 aaronmk
CREATE FUNCTION rename_cols(table_ regclass, renames anyelement) RETURNS void
2752 12446 aaronmk
    LANGUAGE sql
2753 8137 aaronmk
    AS $_$
2754 8212 aaronmk
SELECT util.try_create($$ALTER TABLE $$||$1||$$ RENAME $$
2755 8137 aaronmk
||quote_ident(name)||$$ TO $$||quote_ident($2 -> name))
2756 10309 aaronmk
FROM util.col_names($1::text::regtype) f (name);
2757
SELECT NULL::void; -- don't fold away functions called in previous query
2758 8137 aaronmk
$_$;
2759
2760
2761
--
2762 8183 aaronmk
-- Name: FUNCTION rename_cols(table_ regclass, renames anyelement); Type: COMMENT; Schema: util; Owner: -
2763 8137 aaronmk
--
2764
2765 12235 aaronmk
COMMENT ON FUNCTION rename_cols(table_ regclass, renames anyelement) IS '
2766
idempotent
2767
';
2768 8137 aaronmk
2769
2770
--
2771 12349 aaronmk
-- Name: rename_relation(regclass, text); Type: FUNCTION; Schema: util; Owner: -
2772
--
2773
2774
CREATE FUNCTION rename_relation(from_ regclass, to_ text) RETURNS void
2775
    LANGUAGE sql
2776
    AS $_$
2777 12353 aaronmk
/* use util.qual_name() instead of ::text so that the schema qualifier is always
2778
included in the debug SQL */
2779
SELECT util.rename_relation(util.qual_name($1), $2)
2780 12349 aaronmk
$_$;
2781
2782
2783
--
2784
-- Name: rename_relation(text, text); Type: FUNCTION; Schema: util; Owner: -
2785
--
2786
2787 12364 aaronmk
CREATE FUNCTION rename_relation(from_esc text, to_name text) RETURNS void
2788 12349 aaronmk
    LANGUAGE sql
2789
    AS $_$
2790
/* 'ALTER TABLE can be used with views too'
2791
(http://www.postgresql.org/docs/9.3/static/sql-alterview.html) */
2792 12363 aaronmk
SELECT util.eval($$ALTER TABLE IF EXISTS $$||$1||$$ RENAME TO $$
2793
||quote_ident($2))
2794 12349 aaronmk
$_$;
2795
2796
2797
--
2798 12364 aaronmk
-- Name: FUNCTION rename_relation(from_esc text, to_name text); Type: COMMENT; Schema: util; Owner: -
2799 12349 aaronmk
--
2800
2801 12364 aaronmk
COMMENT ON FUNCTION rename_relation(from_esc text, to_name text) IS '
2802 12349 aaronmk
idempotent
2803
';
2804
2805
2806
--
2807 12358 aaronmk
-- Name: replace_suffix(text, text, text, integer); Type: FUNCTION; Schema: util; Owner: -
2808 12350 aaronmk
--
2809
2810 12358 aaronmk
CREATE FUNCTION replace_suffix(str text, old_suffix text, new_suffix text, max_prefix_len integer DEFAULT 0) RETURNS text
2811 12350 aaronmk
    LANGUAGE sql IMMUTABLE
2812
    AS $_$
2813 12358 aaronmk
SELECT regexp_replace($1, util.truncated_prefixed_name_regexp($2, $4), '\1'||$3)
2814 12350 aaronmk
$_$;
2815
2816
2817
--
2818 12358 aaronmk
-- Name: FUNCTION replace_suffix(str text, old_suffix text, new_suffix text, max_prefix_len integer); Type: COMMENT; Schema: util; Owner: -
2819
--
2820
2821
COMMENT ON FUNCTION replace_suffix(str text, old_suffix text, new_suffix text, max_prefix_len integer) IS '
2822
max_prefix_len: when str may have been truncated (eg. as a table name) due to the prepending of a prefix, support prefixes up to this length
2823
';
2824
2825
2826
--
2827 10297 aaronmk
-- Name: reset_col_names(regclass, regclass); Type: FUNCTION; Schema: util; Owner: -
2828
--
2829
2830
CREATE FUNCTION reset_col_names(table_ regclass, names regclass) RETURNS void
2831 12446 aaronmk
    LANGUAGE sql
2832 10297 aaronmk
    AS $_$
2833 10596 aaronmk
SELECT util.eval($$DELETE FROM $$||$2||$$ WHERE "from" LIKE ':%'$$);
2834
SELECT util.mk_derived_col(($2, 'to'), $$"from"$$, overwrite := true);
2835 10297 aaronmk
SELECT util.set_col_names($1, $2);
2836
$_$;
2837
2838
2839
--
2840
-- Name: FUNCTION reset_col_names(table_ regclass, names regclass); Type: COMMENT; Schema: util; Owner: -
2841
--
2842
2843 12235 aaronmk
COMMENT ON FUNCTION reset_col_names(table_ regclass, names regclass) IS '
2844
idempotent.
2845
alters the names table, so it will need to be repopulated after running this function.
2846
';
2847 10297 aaronmk
2848
2849
--
2850 8183 aaronmk
-- Name: reset_map_table(text); Type: FUNCTION; Schema: util; Owner: -
2851 8143 aaronmk
--
2852
2853
CREATE FUNCTION reset_map_table(table_ text) RETURNS void
2854 12446 aaronmk
    LANGUAGE sql
2855 8143 aaronmk
    AS $_$
2856 10152 aaronmk
SELECT util.drop_table($1);
2857 8183 aaronmk
SELECT util.mk_map_table($1);
2858 8143 aaronmk
$_$;
2859
2860
2861
--
2862 12356 aaronmk
-- Name: rtrim_n(text, integer); Type: FUNCTION; Schema: util; Owner: -
2863
--
2864
2865
CREATE FUNCTION rtrim_n(str text, count integer) RETURNS text
2866
    LANGUAGE sql IMMUTABLE
2867
    AS $_$
2868
SELECT (CASE WHEN $2 <= 0 THEN $1 ELSE left($1, -$2) END)
2869
$_$;
2870
2871
2872
--
2873 12473 aaronmk
-- Name: runnable_sql(text); Type: FUNCTION; Schema: util; Owner: -
2874
--
2875
2876
CREATE FUNCTION runnable_sql(sql text) RETURNS text
2877
    LANGUAGE sql IMMUTABLE
2878
    AS $_$
2879 12481 aaronmk
SELECT (CASE WHEN util.is_set_stmt($1) THEN ''
2880
ELSE util.mk_set_search_path(for_printing := true)||$$;
2881
$$ END)||$1
2882 12473 aaronmk
$_$;
2883
2884
2885
--
2886 11652 aaronmk
-- Name: save_drop_view(text); Type: FUNCTION; Schema: util; Owner: -
2887
--
2888
2889
CREATE FUNCTION save_drop_view(view_ text) RETURNS text
2890
    LANGUAGE plpgsql STRICT
2891
    AS $_$
2892
DECLARE
2893
	result text = NULL;
2894
BEGIN
2895
	BEGIN
2896
		result = util.show_create_view(view_);
2897
		PERFORM util.eval($$DROP VIEW $$||view_);
2898
	EXCEPTION
2899
		WHEN undefined_table THEN NULL;
2900
	END;
2901
	RETURN result;
2902
END;
2903
$_$;
2904
2905
2906
--
2907 11660 aaronmk
-- Name: save_drop_views(text[]); Type: FUNCTION; Schema: util; Owner: -
2908
--
2909
2910
CREATE FUNCTION save_drop_views(views text[]) RETURNS text
2911
    LANGUAGE sql
2912
    AS $_$
2913 12269 aaronmk
SELECT string_agg(util.save_drop_view(unnest), '') FROM unnest($1)
2914 11660 aaronmk
$_$;
2915
2916
2917
--
2918 12244 aaronmk
-- Name: schema(oid); Type: FUNCTION; Schema: util; Owner: -
2919
--
2920
2921
CREATE FUNCTION schema(pg_namespace_oid oid) RETURNS text
2922
    LANGUAGE sql STABLE
2923
    AS $_$
2924
SELECT nspname::text FROM pg_namespace WHERE pg_namespace.oid = $1
2925
$_$;
2926
2927
2928
--
2929 12242 aaronmk
-- Name: schema(regclass); Type: FUNCTION; Schema: util; Owner: -
2930
--
2931
2932
CREATE FUNCTION schema(table_ regclass) RETURNS text
2933
    LANGUAGE sql STABLE
2934
    AS $_$
2935 12245 aaronmk
SELECT util.schema(relnamespace) FROM pg_class WHERE oid = $1
2936 12242 aaronmk
$_$;
2937
2938
2939
--
2940 10794 aaronmk
-- Name: schema(regtype); Type: FUNCTION; Schema: util; Owner: -
2941
--
2942
2943
CREATE FUNCTION schema(type regtype) RETURNS text
2944
    LANGUAGE sql STABLE
2945
    AS $_$
2946 12245 aaronmk
SELECT util.schema(typnamespace) FROM pg_type WHERE oid = $1
2947 10794 aaronmk
$_$;
2948
2949
2950
--
2951
-- Name: schema(anyelement); Type: FUNCTION; Schema: util; Owner: -
2952
--
2953
2954
CREATE FUNCTION schema(type_null anyelement) RETURNS text
2955
    LANGUAGE sql STABLE
2956
    AS $_$
2957
SELECT util.schema(pg_typeof($1))
2958
$_$;
2959
2960
2961
--
2962 12134 aaronmk
-- Name: schema_bundle_get_schemas(text); Type: FUNCTION; Schema: util; Owner: -
2963
--
2964
2965
CREATE FUNCTION schema_bundle_get_schemas(schema_bundle text) RETURNS SETOF text
2966
    LANGUAGE sql STABLE
2967
    AS $_$
2968
SELECT nspname::text FROM pg_namespace WHERE nspname ~ ('^'||$1||'(?=\y|_)')
2969
$_$;
2970
2971
2972
--
2973 12135 aaronmk
-- Name: FUNCTION schema_bundle_get_schemas(schema_bundle text); Type: COMMENT; Schema: util; Owner: -
2974
--
2975
2976 12235 aaronmk
COMMENT ON FUNCTION schema_bundle_get_schemas(schema_bundle text) IS '
2977
a schema bundle is a group of schemas with a common prefix
2978
';
2979 12135 aaronmk
2980
2981
--
2982
-- Name: schema_bundle_rename(text, text); Type: FUNCTION; Schema: util; Owner: -
2983
--
2984
2985
CREATE FUNCTION schema_bundle_rename(old text, new text) RETURNS void
2986
    LANGUAGE sql
2987
    AS $_$
2988
SELECT util.schema_rename(old_schema,
2989
	overlay(old_schema placing new from 1 for length(old))) -- replace prefix
2990
FROM util.schema_bundle_get_schemas($1) f (old_schema);
2991
SELECT NULL::void; -- don't fold away functions called in previous query
2992
$_$;
2993
2994
2995
--
2996
-- Name: schema_bundle_replace(text, text); Type: FUNCTION; Schema: util; Owner: -
2997
--
2998
2999
CREATE FUNCTION schema_bundle_replace(replace text, with_ text) RETURNS void
3000
    LANGUAGE plpgsql
3001
    AS $$
3002
BEGIN
3003
	-- don't schema_bundle_rm() the schema_bundle to keep!
3004
	IF replace = with_ THEN RETURN; END IF;
3005
3006
	PERFORM util.schema_bundle_rm(replace);
3007
	PERFORM util.schema_bundle_rename(with_, replace);
3008
END;
3009
$$;
3010
3011
3012
--
3013
-- Name: schema_bundle_rm(text); Type: FUNCTION; Schema: util; Owner: -
3014
--
3015
3016
CREATE FUNCTION schema_bundle_rm(schema_bundle text) RETURNS void
3017
    LANGUAGE sql
3018
    AS $_$
3019
SELECT util.schema_rm(schema)
3020
FROM util.schema_bundle_get_schemas($1) f (schema);
3021
SELECT NULL::void; -- don't fold away functions called in previous query
3022
$_$;
3023
3024
3025
--
3026 12238 aaronmk
-- Name: schema_esc(anyelement); Type: FUNCTION; Schema: util; Owner: -
3027 10795 aaronmk
--
3028
3029 12238 aaronmk
CREATE FUNCTION schema_esc(type_null anyelement) RETURNS text
3030 10795 aaronmk
    LANGUAGE sql STABLE
3031
    AS $_$
3032
SELECT quote_ident(util.schema($1))
3033
$_$;
3034
3035
3036
--
3037 12324 aaronmk
-- Name: schema_matches(text, text); Type: FUNCTION; Schema: util; Owner: -
3038
--
3039
3040
CREATE FUNCTION schema_matches(schema text, schema_regexp text) RETURNS boolean
3041 12334 aaronmk
    LANGUAGE sql IMMUTABLE
3042 12324 aaronmk
    AS $_$
3043
SELECT $1 ~ $2 AND /*in userspace*/$1 !~ '^(?:information_schema|pg_.*)$'
3044
$_$;
3045
3046
3047
--
3048 12304 aaronmk
-- Name: schema_oid(text); Type: FUNCTION; Schema: util; Owner: -
3049
--
3050
3051
CREATE FUNCTION schema_oid(schema text) RETURNS oid
3052
    LANGUAGE sql STABLE
3053
    AS $_$
3054
SELECT oid FROM pg_namespace WHERE nspname = $1
3055
$_$;
3056
3057
3058
--
3059 12504 aaronmk
-- Name: schema_regexp(regclass); Type: FUNCTION; Schema: util; Owner: -
3060
--
3061
3062
CREATE FUNCTION schema_regexp(relation regclass) RETURNS text
3063
    LANGUAGE sql IMMUTABLE
3064
    AS $_$
3065
SELECT util.schema_regexp(schema_anchor := $1)
3066
$_$;
3067
3068
3069
--
3070 12501 aaronmk
-- Name: schema_regexp(anyelement); Type: FUNCTION; Schema: util; Owner: -
3071
--
3072
3073
CREATE FUNCTION schema_regexp(schema_anchor anyelement) RETURNS text
3074
    LANGUAGE sql IMMUTABLE
3075
    AS $_$
3076
SELECT util.str_equality_regexp(util.schema($1))
3077
$_$;
3078
3079
3080
--
3081 12132 aaronmk
-- Name: schema_rename(text, text); Type: FUNCTION; Schema: util; Owner: -
3082
--
3083
3084
CREATE FUNCTION schema_rename(old text, new text) RETURNS void
3085
    LANGUAGE sql
3086
    AS $_$
3087
SELECT util.eval($$ALTER SCHEMA $$||quote_ident($1)||$$ RENAME TO $$||quote_ident($2));
3088
$_$;
3089
3090
3091
--
3092 12133 aaronmk
-- Name: schema_replace(text, text); Type: FUNCTION; Schema: util; Owner: -
3093
--
3094
3095
CREATE FUNCTION schema_replace(replace text, with_ text) RETURNS void
3096
    LANGUAGE plpgsql
3097
    AS $$
3098
BEGIN
3099
	-- don't schema_rm() the schema to keep!
3100
	IF replace = with_ THEN RETURN; END IF;
3101
3102
	PERFORM util.schema_rm(replace);
3103
	PERFORM util.schema_rename(with_, replace);
3104
END;
3105
$$;
3106
3107
3108
--
3109 12132 aaronmk
-- Name: schema_rm(text); Type: FUNCTION; Schema: util; Owner: -
3110
--
3111
3112
CREATE FUNCTION schema_rm(schema text) RETURNS void
3113
    LANGUAGE sql
3114
    AS $_$
3115
SELECT util.eval($$DROP SCHEMA IF EXISTS $$||quote_ident($1)||$$ CASCADE$$);
3116
$_$;
3117
3118
3119
--
3120 9825 aaronmk
-- Name: search_path_append(text); Type: FUNCTION; Schema: util; Owner: -
3121
--
3122
3123
CREATE FUNCTION search_path_append(schemas text) RETURNS void
3124 12446 aaronmk
    LANGUAGE sql
3125 9825 aaronmk
    AS $_$
3126
SELECT util.eval(
3127
$$SET search_path TO $$||current_setting('search_path')||$$, $$||$1);
3128
$_$;
3129
3130
3131
--
3132 8183 aaronmk
-- Name: set_col_names(regclass, regclass); Type: FUNCTION; Schema: util; Owner: -
3133 8153 aaronmk
--
3134
3135
CREATE FUNCTION set_col_names(table_ regclass, names regclass) RETURNS void
3136
    LANGUAGE plpgsql STRICT
3137
    AS $_$
3138
DECLARE
3139 8183 aaronmk
    old text[] = ARRAY(SELECT util.col_names(table_));
3140
    new text[] = ARRAY(SELECT util.map_values(names));
3141 8153 aaronmk
BEGIN
3142
    old = old[1:array_length(new, 1)]; -- truncate to same length
3143 10345 aaronmk
    PERFORM util.eval($$ALTER TABLE $$||$1||$$ RENAME $$||quote_ident(key)
3144
||$$ TO $$||quote_ident(value))
3145 10149 aaronmk
    FROM each(hstore(old, new))
3146
    WHERE value != key -- not same name
3147
    ;
3148 8153 aaronmk
END;
3149
$_$;
3150
3151
3152
--
3153 8183 aaronmk
-- Name: FUNCTION set_col_names(table_ regclass, names regclass); Type: COMMENT; Schema: util; Owner: -
3154 8153 aaronmk
--
3155
3156 12235 aaronmk
COMMENT ON FUNCTION set_col_names(table_ regclass, names regclass) IS '
3157
idempotent
3158
';
3159 8153 aaronmk
3160
3161
--
3162 10145 aaronmk
-- Name: set_col_names_with_metadata(regclass, regclass); Type: FUNCTION; Schema: util; Owner: -
3163
--
3164
3165
CREATE FUNCTION set_col_names_with_metadata(table_ regclass, names regclass) RETURNS void
3166
    LANGUAGE plpgsql STRICT
3167
    AS $_$
3168
DECLARE
3169
	row_ util.map;
3170
BEGIN
3171 10715 aaronmk
	-- rename any metadata cols rather than re-adding them with new names
3172
	BEGIN
3173
		PERFORM util.set_col_names(table_, names);
3174
	EXCEPTION
3175
		WHEN array_subscript_error THEN -- selective suppress
3176
			IF SQLERRM LIKE 'arrays must have same bounds' THEN NULL;
3177
				-- metadata cols not yet added
3178 12568 aaronmk
			ELSE RAISE;
3179 10715 aaronmk
			END IF;
3180
	END;
3181
3182 10157 aaronmk
	FOR row_ IN EXECUTE $$SELECT * FROM $$||names||$$ WHERE "from" LIKE ':%'$$
3183 10145 aaronmk
	LOOP
3184 10147 aaronmk
		PERFORM util.mk_const_col((table_, row_."to"),
3185
			substring(row_."from" from 2));
3186 10145 aaronmk
	END LOOP;
3187
3188
	PERFORM util.set_col_names(table_, names);
3189
END;
3190
$_$;
3191
3192
3193
--
3194
-- Name: FUNCTION set_col_names_with_metadata(table_ regclass, names regclass); Type: COMMENT; Schema: util; Owner: -
3195
--
3196
3197 12235 aaronmk
COMMENT ON FUNCTION set_col_names_with_metadata(table_ regclass, names regclass) IS '
3198
idempotent.
3199
the metadata mappings must be *last* in the names table.
3200
';
3201 10145 aaronmk
3202
3203
--
3204 8183 aaronmk
-- Name: set_col_types(regclass, col_cast[]); Type: FUNCTION; Schema: util; Owner: -
3205 8107 aaronmk
--
3206
3207
CREATE FUNCTION set_col_types(table_ regclass, col_casts col_cast[]) RETURNS void
3208
    LANGUAGE plpgsql STRICT
3209
    AS $_$
3210
DECLARE
3211
    sql text = $$ALTER TABLE $$||table_||$$
3212
$$||NULLIF(array_to_string(ARRAY(
3213
    SELECT
3214
    $$ALTER COLUMN $$||col_name_sql||$$ TYPE $$||target_type
3215
    ||$$ USING $$||col_name_sql||$$::$$||target_type
3216
    FROM
3217
    (
3218
        SELECT
3219
          quote_ident(col_name) AS col_name_sql
3220 8183 aaronmk
        , util.col_type((table_, col_name)) AS curr_type
3221 8107 aaronmk
        , type AS target_type
3222
        FROM unnest(col_casts)
3223
    ) s
3224
    WHERE curr_type != target_type
3225
), '
3226
, '), '');
3227
BEGIN
3228 12251 aaronmk
    PERFORM util.debug_print_sql(sql);
3229 8107 aaronmk
    EXECUTE COALESCE(sql, '');
3230
END;
3231
$_$;
3232
3233
3234
--
3235 8183 aaronmk
-- Name: FUNCTION set_col_types(table_ regclass, col_casts col_cast[]); Type: COMMENT; Schema: util; Owner: -
3236 8107 aaronmk
--
3237
3238 12235 aaronmk
COMMENT ON FUNCTION set_col_types(table_ regclass, col_casts col_cast[]) IS '
3239
idempotent
3240
';
3241 8107 aaronmk
3242
3243
--
3244 12302 aaronmk
-- Name: set_comment(regclass, text); Type: FUNCTION; Schema: util; Owner: -
3245
--
3246
3247
CREATE FUNCTION set_comment(table_ regclass, comment text) RETURNS void
3248 12446 aaronmk
    LANGUAGE sql
3249 12302 aaronmk
    AS $_$
3250
SELECT util.eval($$COMMENT ON TABLE $$||$1||$$ IS $$||quote_nullable($2))
3251
$_$;
3252
3253
3254
--
3255 12482 aaronmk
-- Name: set_search_path(text, boolean); Type: FUNCTION; Schema: util; Owner: -
3256
--
3257
3258
CREATE FUNCTION set_search_path(search_path text, for_session boolean DEFAULT false) RETURNS void
3259
    LANGUAGE sql
3260
    AS $_$
3261
SELECT util.eval(util.mk_set_search_path($1, $2))
3262
$_$;
3263
3264
3265
--
3266 11651 aaronmk
-- Name: show_create_view(regclass); Type: FUNCTION; Schema: util; Owner: -
3267
--
3268
3269
CREATE FUNCTION show_create_view(view_ regclass) RETURNS text
3270
    LANGUAGE sql STABLE
3271
    AS $_$
3272 11656 aaronmk
SELECT $$CREATE OR REPLACE VIEW $$||$1||$$ AS $$||pg_get_viewdef($1)||$$;
3273
$$||util.show_grants_for($1)
3274 11651 aaronmk
$_$;
3275
3276
3277
--
3278 11655 aaronmk
-- Name: show_grants_for(regclass); Type: FUNCTION; Schema: util; Owner: -
3279
--
3280
3281
CREATE FUNCTION show_grants_for(table_ regclass) RETURNS text
3282
    LANGUAGE sql STABLE
3283
    AS $_$
3284 12269 aaronmk
SELECT string_agg(cmd, '')
3285 11655 aaronmk
FROM
3286
(
3287
	SELECT (CASE WHEN has_table_privilege(user_, $1, 'SELECT') THEN
3288
$$GRANT SELECT ON TABLE $$||$1||$$ TO $$||quote_ident(user_)||$$;
3289
$$ ELSE '' END) AS cmd
3290
	FROM util.grants_users() f (user_)
3291
) s
3292
$_$;
3293
3294
3295
--
3296 12325 aaronmk
-- Name: show_relations_like(text, text, character[]); Type: FUNCTION; Schema: util; Owner: -
3297
--
3298
3299
CREATE FUNCTION show_relations_like(name_regexp text, schema_regexp text DEFAULT ''::text, types character[] DEFAULT ARRAY['r'::text, 'v'::text]) RETURNS SETOF regclass
3300
    LANGUAGE sql STABLE
3301
    AS $_$
3302
SELECT oid FROM pg_class
3303
WHERE relkind = ANY($3) AND relname ~ $1
3304
AND util.schema_matches(util.schema(relnamespace), $2)
3305
ORDER BY relname
3306
$_$;
3307
3308
3309
--
3310 12305 aaronmk
-- Name: show_views_like(text, text); Type: FUNCTION; Schema: util; Owner: -
3311
--
3312
3313 12385 aaronmk
CREATE FUNCTION show_views_like(name_regexp text, schema_regexp text DEFAULT ''::text) RETURNS SETOF regclass
3314 12305 aaronmk
    LANGUAGE sql STABLE
3315
    AS $_$
3316 12385 aaronmk
SELECT * FROM util.show_relations_like($1, $2, ARRAY['v'])
3317 12305 aaronmk
$_$;
3318
3319
3320
--
3321 12384 aaronmk
-- Name: str_equality_regexp(text); Type: FUNCTION; Schema: util; Owner: -
3322
--
3323
3324
CREATE FUNCTION str_equality_regexp(literal text) RETURNS text
3325
    LANGUAGE sql IMMUTABLE
3326
    AS $_$
3327
SELECT '^'||util.regexp_quote($1)||'$'
3328
$_$;
3329
3330
3331
--
3332 8183 aaronmk
-- Name: table2hstore(regclass); Type: FUNCTION; Schema: util; Owner: -
3333 8144 aaronmk
--
3334
3335
CREATE FUNCTION table2hstore(table_ regclass) RETURNS hstore
3336 8145 aaronmk
    LANGUAGE plpgsql STABLE STRICT
3337 8144 aaronmk
    AS $_$
3338
DECLARE
3339
    hstore hstore;
3340
BEGIN
3341
    EXECUTE $$SELECT hstore(ARRAY(SELECT unnest(ARRAY["from", "to"]) FROM $$||
3342
        table_||$$))$$ INTO STRICT hstore;
3343
    RETURN hstore;
3344
END;
3345
$_$;
3346
3347
3348
--
3349 10184 aaronmk
-- Name: table_flag__get(regclass, text); Type: FUNCTION; Schema: util; Owner: -
3350
--
3351
3352
CREATE FUNCTION table_flag__get(table_ regclass, flag text) RETURNS boolean
3353 12446 aaronmk
    LANGUAGE sql STABLE
3354 10184 aaronmk
    AS $_$
3355
SELECT COUNT(*) > 0 FROM pg_constraint
3356
WHERE conrelid = $1 AND contype = 'c' AND conname = $2
3357
$_$;
3358
3359
3360
--
3361
-- Name: FUNCTION table_flag__get(table_ regclass, flag text); Type: COMMENT; Schema: util; Owner: -
3362
--
3363
3364 12235 aaronmk
COMMENT ON FUNCTION table_flag__get(table_ regclass, flag text) IS '
3365
gets whether a status flag is set by the presence of a table constraint
3366
';
3367 10184 aaronmk
3368
3369
--
3370 10182 aaronmk
-- Name: table_flag__set(regclass, text); Type: FUNCTION; Schema: util; Owner: -
3371
--
3372
3373
CREATE FUNCTION table_flag__set(table_ regclass, flag text) RETURNS void
3374 12446 aaronmk
    LANGUAGE sql
3375 10182 aaronmk
    AS $_$
3376
SELECT util.create_if_not_exists($$ALTER TABLE $$||$1||$$ ADD CONSTRAINT $$
3377
||quote_ident($2)||$$ CHECK (true)$$)
3378
$_$;
3379
3380
3381
--
3382
-- Name: FUNCTION table_flag__set(table_ regclass, flag text); Type: COMMENT; Schema: util; Owner: -
3383
--
3384
3385 12235 aaronmk
COMMENT ON FUNCTION table_flag__set(table_ regclass, flag text) IS '
3386
stores a status flag by the presence of a table constraint.
3387
idempotent.
3388
';
3389 10182 aaronmk
3390
3391
--
3392 10185 aaronmk
-- Name: table_nulls_mapped__get(regclass); Type: FUNCTION; Schema: util; Owner: -
3393
--
3394
3395
CREATE FUNCTION table_nulls_mapped__get(table_ regclass) RETURNS boolean
3396 12446 aaronmk
    LANGUAGE sql STABLE
3397 10185 aaronmk
    AS $_$
3398
SELECT util.table_flag__get($1, 'nulls_mapped')
3399
$_$;
3400
3401
3402
--
3403
-- Name: FUNCTION table_nulls_mapped__get(table_ regclass); Type: COMMENT; Schema: util; Owner: -
3404
--
3405
3406 12235 aaronmk
COMMENT ON FUNCTION table_nulls_mapped__get(table_ regclass) IS '
3407
gets whether a table''s NULL-equivalent strings have been replaced with NULL
3408
';
3409 10185 aaronmk
3410
3411
--
3412 10183 aaronmk
-- Name: table_nulls_mapped__set(regclass); Type: FUNCTION; Schema: util; Owner: -
3413
--
3414
3415
CREATE FUNCTION table_nulls_mapped__set(table_ regclass) RETURNS void
3416 12446 aaronmk
    LANGUAGE sql
3417 10183 aaronmk
    AS $_$
3418
SELECT util.table_flag__set($1, 'nulls_mapped')
3419
$_$;
3420
3421
3422
--
3423
-- Name: FUNCTION table_nulls_mapped__set(table_ regclass); Type: COMMENT; Schema: util; Owner: -
3424
--
3425
3426 12235 aaronmk
COMMENT ON FUNCTION table_nulls_mapped__set(table_ regclass) IS '
3427
sets that a table''s NULL-equivalent strings have been replaced with NULL.
3428
idempotent.
3429
';
3430 10183 aaronmk
3431
3432
--
3433 8183 aaronmk
-- Name: to_global_col_names(regclass); Type: FUNCTION; Schema: util; Owner: -
3434 8088 aaronmk
--
3435
3436
CREATE FUNCTION to_global_col_names(table_ regclass) RETURNS void
3437
    LANGUAGE plpgsql STRICT
3438
    AS $_$
3439
DECLARE
3440
    row record;
3441
BEGIN
3442 8183 aaronmk
    FOR row IN SELECT * FROM util.col_global_names(table_::text::regtype)
3443 8088 aaronmk
    LOOP
3444
        IF row.global_name != row.name THEN
3445
            EXECUTE $$ALTER TABLE $$||table_||$$ RENAME $$
3446
                ||quote_ident(row.name)||$$ TO $$||quote_ident(row.global_name);
3447
        END IF;
3448
    END LOOP;
3449
END;
3450
$_$;
3451
3452
3453
--
3454 8183 aaronmk
-- Name: FUNCTION to_global_col_names(table_ regclass); Type: COMMENT; Schema: util; Owner: -
3455 8088 aaronmk
--
3456
3457 12235 aaronmk
COMMENT ON FUNCTION to_global_col_names(table_ regclass) IS '
3458
idempotent
3459
';
3460 8088 aaronmk
3461
3462
--
3463 10365 aaronmk
-- Name: trim(regclass, regclass); Type: FUNCTION; Schema: util; Owner: -
3464
--
3465
3466
CREATE FUNCTION "trim"(table_ regclass, names regclass) RETURNS void
3467 12446 aaronmk
    LANGUAGE sql
3468 10365 aaronmk
    AS $_$
3469 10595 aaronmk
SELECT util.drop_column(($1, col)) FROM util.added_cols($1, $2) f (col);
3470 10365 aaronmk
SELECT NULL::void; -- don't fold away functions called in previous query
3471
$_$;
3472
3473
3474
--
3475
-- Name: FUNCTION "trim"(table_ regclass, names regclass); Type: COMMENT; Schema: util; Owner: -
3476
--
3477
3478 12235 aaronmk
COMMENT ON FUNCTION "trim"(table_ regclass, names regclass) IS '
3479
trims table_ to include only columns in the original data.
3480
idempotent.
3481
';
3482 10365 aaronmk
3483
3484
--
3485 8183 aaronmk
-- Name: truncate(regclass); Type: FUNCTION; Schema: util; Owner: -
3486 8142 aaronmk
--
3487
3488
CREATE FUNCTION truncate(table_ regclass) RETURNS void
3489
    LANGUAGE plpgsql STRICT
3490
    AS $_$
3491
BEGIN
3492
    EXECUTE $$TRUNCATE $$||table_||$$ CASCADE$$;
3493
END;
3494
$_$;
3495
3496
3497
--
3498 8183 aaronmk
-- Name: FUNCTION truncate(table_ regclass); Type: COMMENT; Schema: util; Owner: -
3499 8142 aaronmk
--
3500
3501 12235 aaronmk
COMMENT ON FUNCTION truncate(table_ regclass) IS '
3502
idempotent
3503
';
3504 8142 aaronmk
3505
3506
--
3507 12357 aaronmk
-- Name: truncated_prefixed_name_regexp(text, integer); Type: FUNCTION; Schema: util; Owner: -
3508
--
3509
3510
CREATE FUNCTION truncated_prefixed_name_regexp(name text, max_prefix_len integer) RETURNS text
3511
    LANGUAGE sql IMMUTABLE
3512
    AS $_$
3513 12361 aaronmk
SELECT '^(.*)'||util._if(util.name_was_truncated($1, $2),
3514 12362 aaronmk
util.regexp_quote(util.rtrim_n($1, $2))||'.*', util.regexp_quote($1)) ||'$'
3515 12357 aaronmk
$_$;
3516
3517
3518
--
3519 8199 aaronmk
-- Name: try_create(text); Type: FUNCTION; Schema: util; Owner: -
3520
--
3521
3522
CREATE FUNCTION try_create(sql text) RETURNS void
3523
    LANGUAGE plpgsql STRICT
3524
    AS $$
3525
BEGIN
3526 10146 aaronmk
    PERFORM util.eval(sql);
3527 8199 aaronmk
EXCEPTION
3528 10071 aaronmk
    WHEN wrong_object_type THEN NULL; -- trying to alter a view's columns
3529 8199 aaronmk
    WHEN undefined_column THEN NULL;
3530
    WHEN duplicate_column THEN NULL;
3531
END;
3532
$$;
3533
3534
3535
--
3536
-- Name: FUNCTION try_create(sql text); Type: COMMENT; Schema: util; Owner: -
3537
--
3538
3539 12235 aaronmk
COMMENT ON FUNCTION try_create(sql text) IS '
3540
idempotent
3541
';
3542 8199 aaronmk
3543
3544
--
3545 8209 aaronmk
-- Name: try_mk_derived_col(col_ref, text); Type: FUNCTION; Schema: util; Owner: -
3546
--
3547
3548
CREATE FUNCTION try_mk_derived_col(col col_ref, expr text) RETURNS void
3549 12446 aaronmk
    LANGUAGE sql
3550 8209 aaronmk
    AS $_$
3551
SELECT util.try_create($$SELECT util.mk_derived_col($$||quote_literal($1)||$$, $$||quote_literal($2)||$$)$$)
3552
$_$;
3553
3554
3555
--
3556
-- Name: FUNCTION try_mk_derived_col(col col_ref, expr text); Type: COMMENT; Schema: util; Owner: -
3557
--
3558
3559 12235 aaronmk
COMMENT ON FUNCTION try_mk_derived_col(col col_ref, expr text) IS '
3560
idempotent
3561
';
3562 8209 aaronmk
3563
3564
--
3565 8189 aaronmk
-- Name: type_qual(anyelement); Type: FUNCTION; Schema: util; Owner: -
3566
--
3567
3568
CREATE FUNCTION type_qual(value anyelement) RETURNS text
3569
    LANGUAGE sql IMMUTABLE
3570
    AS $_$
3571
SELECT CASE WHEN $1 IS NULL THEN '' ELSE $$ NOT NULL$$ END
3572
$_$;
3573
3574
3575
--
3576 10161 aaronmk
-- Name: FUNCTION type_qual(value anyelement); Type: COMMENT; Schema: util; Owner: -
3577
--
3578
3579 12235 aaronmk
COMMENT ON FUNCTION type_qual(value anyelement) IS '
3580
a type''s NOT NULL qualifier
3581
';
3582 10161 aaronmk
3583
3584
--
3585 12562 aaronmk
-- Name: typed_cols(regtype); Type: FUNCTION; Schema: util; Owner: -
3586
--
3587
3588
CREATE FUNCTION typed_cols(type regtype) RETURNS SETOF col_cast
3589
    LANGUAGE sql IMMUTABLE
3590
    AS $_$
3591
SELECT (attname::text, atttypid)::util.col_cast
3592
FROM pg_attribute
3593
WHERE attrelid = $1::text::regclass AND attnum >= 1 AND NOT attisdropped
3594
ORDER BY attnum
3595
$_$;
3596
3597
3598
--
3599 12438 aaronmk
-- Name: typeof(anyelement); Type: FUNCTION; Schema: util; Owner: -
3600
--
3601
3602
CREATE FUNCTION typeof(value anyelement) RETURNS text
3603
    LANGUAGE sql IMMUTABLE
3604
    AS $_$
3605
SELECT util.qual_name(pg_typeof($1))
3606
$_$;
3607
3608
3609
--
3610 8185 aaronmk
-- Name: typeof(text, regtype); Type: FUNCTION; Schema: util; Owner: -
3611
--
3612
3613 10160 aaronmk
CREATE FUNCTION typeof(expr text, table_ regtype DEFAULT NULL::regtype) RETURNS regtype
3614
    LANGUAGE plpgsql STABLE
3615 8185 aaronmk
    AS $_$
3616
DECLARE
3617
    type regtype;
3618
BEGIN
3619 10160 aaronmk
    EXECUTE $$SELECT pg_typeof($$||expr||$$)$$||
3620
COALESCE($$ FROM (SELECT (NULL::$$||table_||$$).*) _s$$, '') INTO STRICT type;
3621 8185 aaronmk
    RETURN type;
3622
END;
3623
$_$;
3624
3625
3626
--
3627 12490 aaronmk
-- Name: use_schema(anyelement); Type: FUNCTION; Schema: util; Owner: -
3628 12483 aaronmk
--
3629
3630 12490 aaronmk
CREATE FUNCTION use_schema(schema_anchor anyelement) RETURNS void
3631 12483 aaronmk
    LANGUAGE sql
3632
    AS $_$
3633 12488 aaronmk
SELECT util.set_search_path(util.mk_search_path(util.schema($1)))
3634 12483 aaronmk
$_$;
3635
3636
3637
--
3638 12490 aaronmk
-- Name: FUNCTION use_schema(schema_anchor anyelement); Type: COMMENT; Schema: util; Owner: -
3639 12488 aaronmk
--
3640
3641 12490 aaronmk
COMMENT ON FUNCTION use_schema(schema_anchor anyelement) IS '
3642 12488 aaronmk
auto-appends util to the search_path to enable use of util operators
3643
';
3644
3645
3646
--
3647 9959 aaronmk
-- Name: all_same(anyelement); Type: AGGREGATE; Schema: util; Owner: -
3648
--
3649
3650
CREATE AGGREGATE all_same(anyelement) (
3651
    SFUNC = all_same_transform,
3652
    STYPE = anyarray,
3653
    FINALFUNC = all_same_final
3654
);
3655
3656
3657
--
3658
-- Name: AGGREGATE all_same(anyelement); Type: COMMENT; Schema: util; Owner: -
3659
--
3660
3661 12235 aaronmk
COMMENT ON AGGREGATE all_same(anyelement) IS '
3662
includes NULLs in comparison
3663
';
3664 9959 aaronmk
3665
3666
--
3667 8183 aaronmk
-- Name: join_strs(text, text); Type: AGGREGATE; Schema: util; Owner: -
3668 2595 aaronmk
--
3669
3670
CREATE AGGREGATE join_strs(text, text) (
3671 4052 aaronmk
    SFUNC = join_strs_transform,
3672 4010 aaronmk
    STYPE = text
3673 2595 aaronmk
);
3674
3675
3676 8147 aaronmk
--
3677 12423 aaronmk
-- Name: %==; Type: OPERATOR; Schema: util; Owner: -
3678
--
3679
3680
CREATE OPERATOR %== (
3681
    PROCEDURE = "%==",
3682
    LEFTARG = anyelement,
3683
    RIGHTARG = anyelement
3684
);
3685
3686
3687
--
3688
-- Name: OPERATOR %== (anyelement, anyelement); Type: COMMENT; Schema: util; Owner: -
3689
--
3690
3691
COMMENT ON OPERATOR %== (anyelement, anyelement) IS '
3692
returns whether the map-keys of the compared values are the same
3693
(mnemonic: % is the Perl symbol for a hash map)
3694
3695
should be overridden for types that store both keys and values
3696
3697
used in a FULL JOIN to select which columns to join on
3698
';
3699
3700
3701
--
3702 8183 aaronmk
-- Name: ->; Type: OPERATOR; Schema: util; Owner: -
3703 8147 aaronmk
--
3704
3705
CREATE OPERATOR -> (
3706
    PROCEDURE = map_get,
3707
    LEFTARG = regclass,
3708
    RIGHTARG = text
3709
);
3710
3711
3712 10308 aaronmk
--
3713
-- Name: =>; Type: OPERATOR; Schema: util; Owner: -
3714
--
3715
3716
CREATE OPERATOR => (
3717
    PROCEDURE = hstore,
3718 10357 aaronmk
    LEFTARG = text[],
3719 10608 aaronmk
    RIGHTARG = text
3720 10308 aaronmk
);
3721
3722
3723
--
3724 10608 aaronmk
-- Name: OPERATOR => (text[], text); Type: COMMENT; Schema: util; Owner: -
3725 10308 aaronmk
--
3726
3727 12235 aaronmk
COMMENT ON OPERATOR => (text[], text) IS '
3728
usage: array[''key1'', ...]::text[] => ''value''
3729
';
3730 10308 aaronmk
3731
3732 10391 aaronmk
--
3733 10613 aaronmk
-- Name: ?*>=; Type: OPERATOR; Schema: util; Owner: -
3734
--
3735
3736
CREATE OPERATOR ?*>= (
3737
    PROCEDURE = is_populated_more_often_than,
3738
    LEFTARG = anyelement,
3739
    RIGHTARG = anyelement
3740
);
3741
3742
3743
--
3744 10391 aaronmk
-- Name: ?>=; Type: OPERATOR; Schema: util; Owner: -
3745
--
3746
3747
CREATE OPERATOR ?>= (
3748
    PROCEDURE = is_more_complete_than,
3749
    LEFTARG = anyelement,
3750
    RIGHTARG = anyelement
3751
);
3752
3753
3754 11005 aaronmk
--
3755
-- Name: ||%; Type: OPERATOR; Schema: util; Owner: -
3756
--
3757
3758
CREATE OPERATOR ||% (
3759
    PROCEDURE = concat_esc,
3760
    LEFTARG = text,
3761
    RIGHTARG = text
3762
);
3763
3764
3765
--
3766
-- Name: OPERATOR ||% (text, text); Type: COMMENT; Schema: util; Owner: -
3767
--
3768
3769 12235 aaronmk
COMMENT ON OPERATOR ||% (text, text) IS '
3770
% indicates an identifier, as in Perl hashes and one of the x86 assembler syntaxes for registers
3771
';
3772 11005 aaronmk
3773
3774 2107 aaronmk
--
3775 8183 aaronmk
-- Name: map; Type: TABLE; Schema: util; Owner: -; Tablespace:
3776 8140 aaronmk
--
3777
3778
CREATE TABLE map (
3779
    "from" text NOT NULL,
3780 8158 aaronmk
    "to" text,
3781
    filter text,
3782
    notes text
3783 8140 aaronmk
);
3784
3785
3786
--
3787 11834 aaronmk
-- Data for Name: explain; Type: TABLE DATA; Schema: util; Owner: -
3788
--
3789
3790
3791
3792
--
3793 8183 aaronmk
-- Data for Name: map; Type: TABLE DATA; Schema: util; Owner: -
3794 8140 aaronmk
--
3795
3796
3797
3798
--
3799 10342 aaronmk
-- Name: map__unique__from; Type: CONSTRAINT; Schema: util; Owner: -; Tablespace:
3800 8140 aaronmk
--
3801
3802
ALTER TABLE ONLY map
3803 10342 aaronmk
    ADD CONSTRAINT map__unique__from UNIQUE ("from");
3804 8140 aaronmk
3805
3806
--
3807 10343 aaronmk
-- Name: map__unique__to; Type: CONSTRAINT; Schema: util; Owner: -; Tablespace:
3808
--
3809
3810
ALTER TABLE ONLY map
3811
    ADD CONSTRAINT map__unique__to UNIQUE ("to");
3812
3813
3814
--
3815 10110 aaronmk
-- Name: map_filter_insert; Type: TRIGGER; Schema: util; Owner: -
3816
--
3817
3818
CREATE TRIGGER map_filter_insert BEFORE INSERT ON map FOR EACH ROW EXECUTE PROCEDURE map_filter_insert();
3819
3820
3821
--
3822 2136 aaronmk
-- PostgreSQL database dump complete
3823
--